Feat added internal notes

apps/api/src/db/init-db.ts

@@ -90,7 +90,7 @@ export function initializeDatabase(sqlite: Database) {
       customer_id TEXT NOT NULL REFERENCES users(id),
       shipping_address_id TEXT NOT NULL REFERENCES addresses(id),
       status TEXT NOT NULL,
-      notes TEXT NOT NULL DEFAULT '',
+      notes TEXT,
       created_at TEXT NOT NULL,
       updated_at TEXT NOT NULL
     );
@@ -120,9 +120,7 @@ export function initializeDatabase(sqlite: Database) {
       created_at TEXT NOT NULL
     );
   `);
-
-  // Existing local databases predate internal notes, so add the column in place.
   if (!columnExists(sqlite, "orders", "notes")) {
-    sqlite.exec(`ALTER TABLE orders ADD COLUMN notes TEXT NOT NULL DEFAULT ''`);
+    sqlite.exec("ALTER TABLE orders ADD COLUMN notes TEXT");
   }
 }

apps/api/src/db/schema/orders.ts

@@ -9,7 +9,7 @@ export const orders = sqliteTable("orders", {
   customerId: text("customer_id").notNull().references(() => users.id),
   shippingAddressId: text("shipping_address_id").notNull().references(() => addresses.id),
   status: text("status").notNull(),
-  notes: text("notes").notNull().default(""),
+  notes: text("notes"),
   createdAt: text("created_at").notNull(),
   updatedAt: text("updated_at").notNull()
 });

apps/api/src/orders/order-repository.ts

@@ -96,6 +96,7 @@ export async function findOrderDetail(context: DatabaseContext, orderId: string)
     id: header.order.id,
     orderNumber: header.order.orderNumber,
     status: header.order.status as OrderDetail["status"],
+    notes: header.order.notes,
     createdAt: header.order.createdAt,
     updatedAt: header.order.updatedAt,
     customer: {
@@ -104,8 +105,7 @@ export async function findOrderDetail(context: DatabaseContext, orderId: string)
       email: header.customer.email
     },
     shippingAddress: toAddress(header.address),
-    items: itemRows.map(toOrderItemDetail),
-    notes: header.order.notes
+    items: itemRows.map(toOrderItemDetail)
   } satisfies OrderDetail;
 }
 
@@ -128,6 +128,10 @@ export async function updateOrderTimestamp(context: DatabaseContext, orderId: st
   await context.db.update(orders).set({ 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 updateOrderStatus(context: DatabaseContext, orderId: string, status: OrderDetail["status"], updatedAt: string) {
   await context.db.update(orders).set({ status, updatedAt }).where(eq(orders.id, orderId));
 }
@@ -175,10 +179,6 @@ export async function appendAuditEvent(
   });
 }
 
-export async function updateOrderNotes(context: DatabaseContext, orderId: string, notes: string) {
-  await context.db.update(orders).set({ notes }).where(eq(orders.id, orderId));
-}
-
 async function findCustomerSummaryByOrderId(context: DatabaseContext, orderId: string) {
   const [row] = await context.db
     .select({ customer: users })

apps/api/src/orders/order-routes.ts

@@ -7,7 +7,7 @@ import { getOrder } from "./get-order";
 import { listAuditEvents } from "./list-audit-events";
 import { listOrders } from "./list-orders";
 import { changeOrderItemQuantity } from "./update-order-item";
-import { saveOrderNotes } from "./update-order-notes";
+import { changeOrderNotes } from "./update-order-notes";
 import { changeShippingAddress } from "./update-shipping-address";
 
 interface OrderRouteOptions {
@@ -34,10 +34,6 @@ interface CancelBody {
   reason?: string;
 }
 
-interface NotesBody {
-  notes: string;
-}
-
 type AuthenticatedRequest = FastifyRequest & { currentUser: AuthUser };
 
 export const registerOrderRoutes: FastifyPluginAsync<OrderRouteOptions> = async (app, options) => {
@@ -74,6 +70,29 @@ export const registerOrderRoutes: FastifyPluginAsync<OrderRouteOptions> = async
 
   app.get<{ Params: IdParams }>("/orders/:orderId/audit-events", async (request) => listAuditEvents(options.db, request.params.orderId));
 
+  app.post<{ Params: IdParams; Body: { notes: string } }>("/orders/:orderId/notes", {
+    schema: {
+      body: {
+        type: "object",
+        required: ["notes"],
+        properties: {
+          notes: { type: "string", minLength: 1, maxLength: 1000 }
+        }
+      }
+    }
+  }, async (request, reply) => {
+    const result = await changeOrderNotes(options.db, {
+      orderId: request.params.orderId,
+      notes: request.body.notes
+    });
+
+    if (result.statusCode !== 200) {
+      return reply.code(result.statusCode).send({ message: result.message });
+    }
+
+    return result.order;
+  });
+
   app.post<{ Params: OrderItemParams; Body: QuantityBody }>("/orders/:orderId/items/:itemId/quantity", {
     schema: {
       body: {
@@ -162,28 +181,4 @@ export const registerOrderRoutes: FastifyPluginAsync<OrderRouteOptions> = async
 
     return result.order;
   });
-
-  app.post<{ Params: IdParams; Body: NotesBody }>("/orders/:orderId/notes", {
-    schema: {
-      body: {
-        type: "object",
-        required: ["notes"],
-        properties: {
-          // Empty and length rules are measured on the trimmed notes in saveOrderNotes.
-          notes: { type: "string" }
-        }
-      }
-    }
-  }, async (request, reply) => {
-    const result = await saveOrderNotes(options.db, {
-      orderId: request.params.orderId,
-      notes: request.body.notes
-    });
-
-    if (result.statusCode !== 200) {
-      return reply.code(result.statusCode).send({ message: result.message });
-    }
-
-    return result.order;
-  });
 };

apps/api/src/orders/update-order-notes.ts

@@ -1,38 +1,19 @@
-import { orderNotesMaxLength } from "@orderops/shared";
 import type { DatabaseContext } from "../db/database";
-import { findOrderDetail, updateOrderNotes, updateOrderTimestamp } from "./order-repository";
+import { findOrderDetail, updateOrderNotes } from "./order-repository";
 
-// Notes are allowed for every order status: follow-up work often happens
-// after an order has shipped, been cancelled, or been refunded.
-export async function saveOrderNotes(
-  context: DatabaseContext,
-  input: {
-    orderId: string;
-    notes: string;
+export async function changeOrderNotes(context: DatabaseContext, input: { orderId: string; notes: string }) {
+  const notes = input.notes.trim();
+
+  if (!notes || Array.from(input.notes).length > 1000) {
+    return { statusCode: 400, message: "Internal notes must contain between 1 and 1000 characters." } as const;
   }
-) {
-  const order = await findOrderDetail(context, input.orderId);
 
+  const order = await findOrderDetail(context, input.orderId);
   if (!order) {
     return { statusCode: 404, message: "Order not found." } as const;
   }
 
-  const notes = input.notes.trim();
+  await updateOrderNotes(context, input.orderId, notes, new Date().toISOString());
 
-  if (!notes) {
-    return { statusCode: 400, message: "Notes cannot be empty." } as const;
-  }
-
-  if (notes.length > orderNotesMaxLength) {
-    return { statusCode: 400, message: `Notes must be ${orderNotesMaxLength} characters or fewer.` } as const;
-  }
-
-  const updatedAt = new Date().toISOString();
-  await updateOrderNotes(context, input.orderId, notes);
-  await updateOrderTimestamp(context, input.orderId, updatedAt);
-
-  return {
-    statusCode: 200,
-    order: await findOrderDetail(context, input.orderId)
-  } as const;
+  return { statusCode: 200, order: await findOrderDetail(context, input.orderId) } as const;
 }

apps/web/src/orders/order-api.ts

@@ -35,7 +35,7 @@ export function cancelOrder(orderId: string, reason?: string) {
   });
 }
 
-export function saveOrderNotes(orderId: string, notes: string) {
+export function updateOrderNotes(orderId: string, notes: string) {
   return apiRequest<OrderDetail>(`/api/orders/${orderId}/notes`, {
     method: "POST",
     body: JSON.stringify({ notes })

apps/web/src/orders/order-detail-page.tsx

@@ -1,7 +1,7 @@
 import type { Address, AuditEvent, OrderDetail } from "@orderops/shared";
 import { AuditTimeline } from "./audit-timeline";
 import { OrderItemsPanel } from "./order-items-panel";
-import { OrderNotesPanel } from "./order-notes-panel";
+import { OrderNotesForm } from "./order-notes-form";
 import { OrderSummaryPanel } from "./order-summary";
 import { ShippingAddressForm } from "./shipping-address-form";
 
@@ -10,8 +10,8 @@ interface OrderDetailPageProps {
   auditEvents: AuditEvent[];
   onUpdateQuantity: (itemId: string, quantity: number) => Promise<void>;
   onSaveAddress: (address: Address) => Promise<void>;
-  onSaveNotes: (notes: string) => Promise<void>;
   onCancel: () => Promise<void>;
+  onSaveNotes: (notes: string) => Promise<boolean>;
 }
 
 export function OrderDetailPage({
@@ -19,21 +19,28 @@ export function OrderDetailPage({
   auditEvents,
   onUpdateQuantity,
   onSaveAddress,
-  onSaveNotes,
-  onCancel
+  onCancel,
+  onSaveNotes
 }: OrderDetailPageProps) {
   return (
     <div className="space-y-4">
       <OrderSummaryPanel order={order} />
-      <div className="flex justify-end">
+      <div className="flex justify-end gap-3">
+        <button className="rounded-md bg-blue-600 px-4 py-2 text-sm font-medium text-white" type="button" onClick={() => {
+          const input = document.getElementById("internal-order-notes");
+          input?.scrollIntoView({ block: "center" });
+          input?.focus({ preventScroll: true });
+        }}>
+          {order.notes ? "Edit internal notes" : "Add internal note"}
+        </button>
         <button className="rounded-md bg-red-600 px-4 py-2 text-sm font-medium text-white" onClick={() => void onCancel()} type="button">
           Cancel order
         </button>
       </div>
       <OrderItemsPanel order={order} onUpdateQuantity={onUpdateQuantity} />
       <ShippingAddressForm order={order} onSave={onSaveAddress} />
-      <OrderNotesPanel notes={order.notes} onSaveNotes={onSaveNotes} />
       <AuditTimeline events={auditEvents} />
+      <OrderNotesForm key={order.id} notes={order.notes} onSave={onSaveNotes} />
     </div>
   );
 }

apps/web/src/orders/order-notes-form.tsx

@@ -0,0 +1,58 @@
+import { useState } from "react";
+
+interface OrderNotesFormProps {
+  notes: string | null;
+  onSave: (notes: string) => Promise<boolean>;
+}
+
+export function OrderNotesForm({ notes, onSave }: OrderNotesFormProps) {
+  const [draft, setDraft] = useState(notes ?? "");
+  const [isSaving, setIsSaving] = useState(false);
+  const length = Array.from(draft).length;
+
+  return (
+    <section className="rounded-xl border border-slate-200 bg-white p-4 shadow-sm">
+      <div className="mb-3 flex items-center gap-3">
+        <h3 className="text-sm font-semibold text-slate-700">Internal notes</h3>
+        <span className="rounded-full bg-slate-100 px-3 py-1 text-xs text-slate-600">Employees only</span>
+      </div>
+      {notes ? <p className="mb-3 whitespace-pre-wrap break-words rounded-lg border border-slate-200 p-3 text-sm text-slate-700">{notes}</p> : null}
+      <form onSubmit={async (event) => {
+        event.preventDefault();
+        if (isSaving || !draft.trim() || length > 1000) return;
+        setIsSaving(true);
+        try {
+          if (await onSave(draft)) setDraft(draft.trim());
+        } finally {
+          setIsSaving(false);
+        }
+      }}>
+        <label className="mb-1 block text-sm text-slate-700" htmlFor="internal-order-notes">
+          {notes ? "Edit internal notes" : "Add a note for your teammates"}
+        </label>
+        <textarea
+          id="internal-order-notes"
+          className="w-full rounded-lg border border-slate-300 px-3 py-2 text-sm"
+          aria-describedby="internal-order-notes-help"
+          placeholder="Add a note for your teammates..."
+          rows={3}
+          value={draft}
+          disabled={isSaving}
+          onChange={(event) => setDraft(event.target.value)}
+        />
+        <div className="mt-2 flex items-center justify-between gap-3">
+          <p id="internal-order-notes-help" className="text-xs text-slate-600">
+            {length}/1000 characters. Saving replaces the current notes.
+          </p>
+          <button
+            className="rounded-md bg-blue-600 px-4 py-2 text-sm font-medium text-white disabled:opacity-50"
+            type="submit"
+            disabled={isSaving || !draft.trim() || length > 1000}
+          >
+            {isSaving ? "Saving..." : notes ? "Save notes" : "Add note"}
+          </button>
+        </div>
+      </form>
+    </section>
+  );
+}

apps/web/src/orders/order-notes-panel.tsx

@@ -1,56 +0,0 @@
-import { useEffect, useState } from "react";
-
-interface OrderNotesPanelProps {
-  notes: string;
-  onSaveNotes: (notes: string) => Promise<void>;
-}
-
-export function OrderNotesPanel({ notes, onSaveNotes }: OrderNotesPanelProps) {
-  const [draft, setDraft] = useState(notes);
-  const [isSaving, setIsSaving] = useState(false);
-  const canSubmit = draft.trim().length > 0 && draft !== notes && !isSaving;
-
-  // Show the stored notes again whenever the order is reloaded.
-  useEffect(() => {
-    setDraft(notes);
-  }, [notes]);
-
-  return (
-    <section className="rounded-xl border border-slate-200 bg-white p-4 shadow-sm">
-      <h3 className="text-sm font-semibold text-slate-700">Internal notes</h3>
-      <p className="mb-3 text-xs text-slate-500">Visible to OrderOps employees only.</p>
-      <form
-        className="space-y-2"
-        onSubmit={async (event) => {
-          event.preventDefault();
-
-          if (!canSubmit) {
-            return;
-          }
-
-          setIsSaving(true);
-          await onSaveNotes(draft);
-          setIsSaving(false);
-        }}
-      >
-        <label className="block text-sm text-slate-700">
-          <span className="mb-1 block">Notes</span>
-          <textarea
-            className="w-full rounded-lg border border-slate-300 px-3 py-2"
-            placeholder="Add context for teammates following up on this order"
-            rows={4}
-            value={draft}
-            onChange={(event) => setDraft(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={!canSubmit}
-          type="submit"
-        >
-          {isSaving ? "Saving notes..." : "Save notes"}
-        </button>
-      </form>
-    </section>
-  );
-}

apps/web/src/orders/order-page.tsx

@@ -2,7 +2,7 @@ import { useEffect, useState } from "react";
 import type { Address, AuditEvent, OrderDetail } from "@orderops/shared";
 import { Link, useParams } from "react-router-dom";
 import { Toast } from "../ui/toast";
-import { cancelOrder, getOrder, listAuditEvents, saveOrderNotes, updateOrderItemQuantity, updateShippingAddress } from "./order-api";
+import { cancelOrder, getOrder, listAuditEvents, updateOrderItemQuantity, updateOrderNotes, updateShippingAddress } from "./order-api";
 import { OrderDetailPage } from "./order-detail-page";
 
 interface ToastState {
@@ -55,7 +55,7 @@ export function OrderPage() {
 
   async function runAction(action: () => Promise<OrderDetail>, successMessage: string) {
     if (!orderId) {
-      return;
+      return false;
     }
 
     try {
@@ -64,11 +64,13 @@ export function OrderPage() {
       setOrder(nextOrder);
       await refreshOrder(orderId);
       setToast({ message: successMessage, variant: "success" });
+      return true;
     } catch (caught) {
       setToast({
         message: caught instanceof Error ? caught.message : "Request failed.",
         variant: "error"
       });
+      return false;
     }
   }
 
@@ -84,10 +86,10 @@ export function OrderPage() {
         <OrderDetailPage
           order={order}
           auditEvents={auditEvents}
-          onUpdateQuantity={(itemId, quantity) => runAction(() => updateOrderItemQuantity(order.id, itemId, quantity), "Quantity saved.")}
-          onSaveAddress={(address: Address) => runAction(() => updateShippingAddress(order.id, address), "Shipping address saved.")}
-          onSaveNotes={(notes: string) => runAction(() => saveOrderNotes(order.id, notes), "Internal notes saved.")}
-          onCancel={() => runAction(() => cancelOrder(order.id), "Order cancelled.")}
+          onUpdateQuantity={async (itemId, quantity) => { await runAction(() => updateOrderItemQuantity(order.id, itemId, quantity), "Quantity saved."); }}
+          onSaveAddress={async (address: Address) => { await runAction(() => updateShippingAddress(order.id, address), "Shipping address saved."); }}
+          onCancel={async () => { await runAction(() => cancelOrder(order.id), "Order cancelled."); }}
+          onSaveNotes={(notes) => runAction(() => updateOrderNotes(order.id, notes), "Internal notes saved.")}
         />
       ) : null}
     </div>

packages/shared/src/order-detail.ts

@@ -3,9 +3,6 @@ import type { CustomerSummary } from "./customer";
 import type { Money } from "./money";
 import type { OrderStatus } from "./order-status";
 
-// Shared so the API and the notes panel describe the same limit.
-export const orderNotesMaxLength = 1000;
-
 export interface OrderItemDetail {
   id: string;
   productId: string;
@@ -20,10 +17,10 @@ export interface OrderDetail {
   id: string;
   orderNumber: string;
   status: OrderStatus;
+  notes: string | null;
   createdAt: string;
   updatedAt: string;
   customer: CustomerSummary;
   shippingAddress: Address;
   items: OrderItemDetail[];
-  notes: string;
 }