add:internal order notes for employees
Runner Test / test (push) Successful in 16s
Runner Test / test (pull_request) Successful in 17s

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Abdulaziz Salim Said AL-Gharbi
2026-09-24 20:24:10 +04:00
co-authored by Claude Opus 5.5
parent 79b485db56
commit bfe60631a5
11 changed files with 146 additions and 3 deletions
+6
View File
@@ -90,6 +90,7 @@ export function initializeDatabase(sqlite: Database) {
customer_id TEXT NOT NULL REFERENCES users(id), customer_id TEXT NOT NULL REFERENCES users(id),
shipping_address_id TEXT NOT NULL REFERENCES addresses(id), shipping_address_id TEXT NOT NULL REFERENCES addresses(id),
status TEXT NOT NULL, status TEXT NOT NULL,
notes TEXT,
created_at TEXT NOT NULL, created_at TEXT NOT NULL,
updated_at TEXT NOT NULL updated_at TEXT NOT NULL
); );
@@ -119,4 +120,9 @@ export function initializeDatabase(sqlite: Database) {
created_at TEXT NOT NULL created_at TEXT NOT NULL
); );
`); `);
// Databases created before internal order notes existed keep their orders table, so add the column in place.
if (!columnExists(sqlite, "orders", "notes")) {
sqlite.exec("ALTER TABLE orders ADD COLUMN notes TEXT;");
}
} }
+1
View File
@@ -9,6 +9,7 @@ export const orders = sqliteTable("orders", {
customerId: text("customer_id").notNull().references(() => users.id), customerId: text("customer_id").notNull().references(() => users.id),
shippingAddressId: text("shipping_address_id").notNull().references(() => addresses.id), shippingAddressId: text("shipping_address_id").notNull().references(() => addresses.id),
status: text("status").notNull(), status: text("status").notNull(),
notes: text("notes"),
createdAt: text("created_at").notNull(), createdAt: text("created_at").notNull(),
updatedAt: text("updated_at").notNull() updatedAt: text("updated_at").notNull()
}); });
+6 -1
View File
@@ -104,7 +104,8 @@ export async function findOrderDetail(context: DatabaseContext, orderId: string)
email: header.customer.email email: header.customer.email
}, },
shippingAddress: toAddress(header.address), shippingAddress: toAddress(header.address),
items: itemRows.map(toOrderItemDetail) items: itemRows.map(toOrderItemDetail),
notes: header.order.notes
} satisfies OrderDetail; } satisfies OrderDetail;
} }
@@ -131,6 +132,10 @@ export async function updateOrderStatus(context: DatabaseContext, orderId: strin
await context.db.update(orders).set({ status, updatedAt }).where(eq(orders.id, orderId)); await context.db.update(orders).set({ status, updatedAt }).where(eq(orders.id, orderId));
} }
export async function updateOrderNotes(context: DatabaseContext, orderId: string, notes: string, updatedAt: string) {
await context.db.update(orders).set({ notes, updatedAt }).where(eq(orders.id, orderId));
}
export async function updateOrderAddress(context: DatabaseContext, orderId: string, address: Address) { export async function updateOrderAddress(context: DatabaseContext, orderId: string, address: Address) {
const [row] = await context.db.select({ shippingAddressId: orders.shippingAddressId }).from(orders).where(eq(orders.id, orderId)); const [row] = await context.db.select({ shippingAddressId: orders.shippingAddressId }).from(orders).where(eq(orders.id, orderId));
+30
View File
@@ -7,6 +7,7 @@ import { getOrder } from "./get-order";
import { listAuditEvents } from "./list-audit-events"; import { listAuditEvents } from "./list-audit-events";
import { listOrders } from "./list-orders"; import { listOrders } from "./list-orders";
import { changeOrderItemQuantity } from "./update-order-item"; import { changeOrderItemQuantity } from "./update-order-item";
import { changeOrderNotes } from "./update-order-notes";
import { changeShippingAddress } from "./update-shipping-address"; import { changeShippingAddress } from "./update-shipping-address";
interface OrderRouteOptions { interface OrderRouteOptions {
@@ -33,6 +34,10 @@ interface CancelBody {
reason?: string; reason?: string;
} }
interface NotesBody {
notes: string;
}
type AuthenticatedRequest = FastifyRequest & { currentUser: AuthUser }; type AuthenticatedRequest = FastifyRequest & { currentUser: AuthUser };
export const registerOrderRoutes: FastifyPluginAsync<OrderRouteOptions> = async (app, options) => { export const registerOrderRoutes: FastifyPluginAsync<OrderRouteOptions> = async (app, options) => {
@@ -134,6 +139,31 @@ export const registerOrderRoutes: FastifyPluginAsync<OrderRouteOptions> = async
return result.order; return result.order;
}); });
app.post<{ Params: IdParams; Body: NotesBody }>("/orders/:orderId/notes", {
schema: {
body: {
type: "object",
required: ["notes"],
properties: {
notes: { type: "string" }
}
}
}
}, async (request, reply) => {
const currentUser = (request as AuthenticatedRequest).currentUser;
const result = await changeOrderNotes(options.db, {
orderId: request.params.orderId,
notes: request.body.notes,
actor: currentUser.username
});
if (result.statusCode !== 200) {
return reply.code(result.statusCode).send({ message: result.message });
}
return result.order;
});
app.post<{ Params: IdParams; Body: CancelBody }>("/orders/:orderId/cancel", { app.post<{ Params: IdParams; Body: CancelBody }>("/orders/:orderId/cancel", {
schema: { schema: {
body: { body: {
+43
View File
@@ -0,0 +1,43 @@
import { maxOrderNotesLength } from "@orderops/shared";
import type { DatabaseContext } from "../db/database";
import { appendAuditEvent, findOrderDetail, updateOrderNotes } from "./order-repository";
export async function changeOrderNotes(
context: DatabaseContext,
input: {
orderId: string;
notes: string;
actor: string;
}
) {
const notes = input.notes.trim();
if (!notes) {
return { statusCode: 400, message: "Notes cannot be empty." } as const;
}
if (notes.length > maxOrderNotesLength) {
return { statusCode: 400, message: `Notes cannot be longer than ${maxOrderNotesLength} characters.` } as const;
}
const order = await findOrderDetail(context, input.orderId);
if (!order) {
return { statusCode: 404, message: "Order not found." } as const;
}
const updatedAt = new Date().toISOString();
await updateOrderNotes(context, input.orderId, notes, updatedAt);
await appendAuditEvent(context, {
orderId: input.orderId,
actor: input.actor,
type: "order.notes_updated",
message: "Updated internal notes.",
createdAt: updatedAt
});
return {
statusCode: 200,
order: await findOrderDetail(context, input.orderId)
} as const;
}
File diff suppressed because one or more lines are too long
+7
View File
@@ -28,6 +28,13 @@ export function updateShippingAddress(orderId: string, address: Address) {
}); });
} }
export function updateOrderNotes(orderId: string, notes: string) {
return apiRequest<OrderDetail>(`/api/orders/${orderId}/notes`, {
method: "POST",
body: JSON.stringify({ notes })
});
}
export function cancelOrder(orderId: string, reason?: string) { export function cancelOrder(orderId: string, reason?: string) {
return apiRequest<OrderDetail>(`/api/orders/${orderId}/cancel`, { return apiRequest<OrderDetail>(`/api/orders/${orderId}/cancel`, {
method: "POST", method: "POST",
@@ -1,6 +1,7 @@
import type { Address, AuditEvent, OrderDetail } from "@orderops/shared"; import type { Address, AuditEvent, OrderDetail } from "@orderops/shared";
import { AuditTimeline } from "./audit-timeline"; import { AuditTimeline } from "./audit-timeline";
import { OrderItemsPanel } from "./order-items-panel"; import { OrderItemsPanel } from "./order-items-panel";
import { OrderNotesPanel } from "./order-notes-panel";
import { OrderSummaryPanel } from "./order-summary"; import { OrderSummaryPanel } from "./order-summary";
import { ShippingAddressForm } from "./shipping-address-form"; import { ShippingAddressForm } from "./shipping-address-form";
@@ -9,6 +10,7 @@ interface OrderDetailPageProps {
auditEvents: AuditEvent[]; auditEvents: AuditEvent[];
onUpdateQuantity: (itemId: string, quantity: number) => Promise<void>; onUpdateQuantity: (itemId: string, quantity: number) => Promise<void>;
onSaveAddress: (address: Address) => Promise<void>; onSaveAddress: (address: Address) => Promise<void>;
onSaveNotes: (notes: string) => Promise<void>;
onCancel: () => Promise<void>; onCancel: () => Promise<void>;
} }
@@ -17,6 +19,7 @@ export function OrderDetailPage({
auditEvents, auditEvents,
onUpdateQuantity, onUpdateQuantity,
onSaveAddress, onSaveAddress,
onSaveNotes,
onCancel onCancel
}: OrderDetailPageProps) { }: OrderDetailPageProps) {
return ( return (
@@ -30,6 +33,7 @@ export function OrderDetailPage({
<OrderItemsPanel order={order} onUpdateQuantity={onUpdateQuantity} /> <OrderItemsPanel order={order} onUpdateQuantity={onUpdateQuantity} />
<ShippingAddressForm order={order} onSave={onSaveAddress} /> <ShippingAddressForm order={order} onSave={onSaveAddress} />
<AuditTimeline events={auditEvents} /> <AuditTimeline events={auditEvents} />
<OrderNotesPanel order={order} onSave={onSaveNotes} />
</div> </div>
); );
} }
+42
View File
@@ -0,0 +1,42 @@
import { useState } from "react";
import { maxOrderNotesLength, type OrderDetail } from "@orderops/shared";
interface OrderNotesPanelProps {
order: OrderDetail;
onSave: (notes: string) => Promise<void>;
}
export function OrderNotesPanel({ order, onSave }: OrderNotesPanelProps) {
const [notes, setNotes] = useState(order.notes ?? "");
return (
<section className="rounded-xl border border-slate-200 bg-white p-4 shadow-sm">
<h3 className="mb-3 text-sm font-semibold text-slate-700">Internal notes</h3>
<form
className="space-y-3"
onSubmit={async (event) => {
event.preventDefault();
await onSave(notes);
}}
>
<label className="block text-sm text-slate-700">
<span className="mb-1 block">Notes for the OrderOps team</span>
<textarea
className="w-full rounded-lg border border-slate-300 px-3 py-2"
maxLength={maxOrderNotesLength}
rows={4}
value={notes}
onChange={(event) => setNotes(event.target.value)}
/>
</label>
<button
className="rounded-md bg-slate-900 px-4 py-2 text-sm font-medium text-white disabled:opacity-50"
disabled={!notes.trim()}
type="submit"
>
Save notes
</button>
</form>
</section>
);
}
+2 -1
View File
@@ -2,7 +2,7 @@ import { useEffect, useState } from "react";
import type { Address, AuditEvent, OrderDetail } from "@orderops/shared"; import type { Address, AuditEvent, OrderDetail } from "@orderops/shared";
import { Link, useParams } from "react-router-dom"; import { Link, useParams } from "react-router-dom";
import { Toast } from "../ui/toast"; import { Toast } from "../ui/toast";
import { cancelOrder, getOrder, listAuditEvents, updateOrderItemQuantity, updateShippingAddress } from "./order-api"; import { cancelOrder, getOrder, listAuditEvents, updateOrderItemQuantity, updateOrderNotes, updateShippingAddress } from "./order-api";
import { OrderDetailPage } from "./order-detail-page"; import { OrderDetailPage } from "./order-detail-page";
interface ToastState { interface ToastState {
@@ -86,6 +86,7 @@ export function OrderPage() {
auditEvents={auditEvents} auditEvents={auditEvents}
onUpdateQuantity={(itemId, quantity) => runAction(() => updateOrderItemQuantity(order.id, itemId, quantity), "Quantity saved.")} onUpdateQuantity={(itemId, quantity) => runAction(() => updateOrderItemQuantity(order.id, itemId, quantity), "Quantity saved.")}
onSaveAddress={(address: Address) => runAction(() => updateShippingAddress(order.id, address), "Shipping address saved.")} onSaveAddress={(address: Address) => runAction(() => updateShippingAddress(order.id, address), "Shipping address saved.")}
onSaveNotes={(notes: string) => runAction(() => updateOrderNotes(order.id, notes), "Notes saved.")}
onCancel={() => runAction(() => cancelOrder(order.id), "Order cancelled.")} onCancel={() => runAction(() => cancelOrder(order.id), "Order cancelled.")}
/> />
) : null} ) : null}
+4
View File
@@ -3,6 +3,9 @@ import type { CustomerSummary } from "./customer";
import type { Money } from "./money"; import type { Money } from "./money";
import type { OrderStatus } from "./order-status"; import type { OrderStatus } from "./order-status";
// Internal order notes are capped so they stay a short follow-up context, not a document.
export const maxOrderNotesLength = 1000;
export interface OrderItemDetail { export interface OrderItemDetail {
id: string; id: string;
productId: string; productId: string;
@@ -22,4 +25,5 @@ export interface OrderDetail {
customer: CustomerSummary; customer: CustomerSummary;
shippingAddress: Address; shippingAddress: Address;
items: OrderItemDetail[]; items: OrderItemDetail[];
notes: string | null;
} }