@tailor-platform/erp-kit 0.5.1 → 0.6.0

package/src/modules/manufacturing/command/completeProductionOrder.ts

@@ -0,0 +1,97 @@
+import type { Transaction } from "../generated/kysely-tailordb";
+import {
+  ProductionOrderNotFoundError,
+  ProductionOrderNotCompletableError,
+  OpenWorkOrderRemainsError,
+  FinalOutputRequiredError,
+  FinalReceiptRequiredError,
+} from "../lib/errors.generated";
+import { ok, err, type CommandContext } from "@tailor-platform/erp-kit/module";
+
+export interface CompleteProductionOrderInput {
+  id: string;
+  from?: string[];
+}
+
+/**
+ * Function: completeProductionOrder
+ *
+ * Marks physical production complete once required work orders are finished
+ * and final receipt obligations are satisfied. The command freezes production
+ * execution while still allowing later technical completion and review.
+ */
+export async function run<CF extends Record<string, unknown>>(
+  db: Transaction,
+  input: CompleteProductionOrderInput & CF,
+  _ctx: CommandContext,
+) {
+  const { id, from, ...customFields } = input;
+  void customFields;
+
+  const allowedStatuses = from ?? ["IN_PROGRESS"];
+
+  // 1. Fetch production order with lock
+  const order = await db
+    .selectFrom("ProductionOrder")
+    .selectAll()
+    .where("id", "=", id)
+    .forUpdate()
+    .executeTakeFirst();
+
+  if (!order) {
+    return err(new ProductionOrderNotFoundError(id));
+  }
+
+  // 2. Validate status is completable
+  if (!allowedStatuses.includes(order.status)) {
+    return err(new ProductionOrderNotCompletableError(id));
+  }
+
+  // 3. Check all required work orders are COMPLETE or CANCELLED
+  const workOrders = await db
+    .selectFrom("WorkOrder")
+    .selectAll()
+    .where("productionOrderId", "=", id)
+    .execute();
+
+  const hasOpenWorkOrders = workOrders.some(
+    (wo) => wo.status !== "COMPLETE" && wo.status !== "CANCELLED",
+  );
+
+  if (hasOpenWorkOrders) {
+    return err(new OpenWorkOrderRemainsError(id));
+  }
+
+  // 4. Check final output has been reported
+  const hasCompletedOutput = workOrders.some(
+    (wo) => wo.status === "COMPLETE" && wo.completedQuantity > 0,
+  );
+
+  if (!hasCompletedOutput) {
+    return err(new FinalOutputRequiredError(id));
+  }
+
+  // 5. Check receipt handoff evidence exists
+  const costSummary = await db
+    .selectFrom("ManufacturingCostSummary")
+    .selectAll()
+    .where("productionOrderId", "=", id)
+    .executeTakeFirst();
+
+  if (!costSummary || costSummary.actualMaterialCost <= 0) {
+    return err(new FinalReceiptRequiredError(id));
+  }
+
+  // 6. Set status to COMPLETED
+  const completedOrder = await db
+    .updateTable("ProductionOrder")
+    .set({
+      status: "COMPLETED",
+      updatedAt: new Date(),
+    })
+    .where("id", "=", id)
+    .returningAll()
+    .executeTakeFirstOrThrow();
+
+  return ok({ productionOrder: completedOrder });
+}

package/src/modules/manufacturing/command/completeWorkOrder.generated.ts

@@ -0,0 +1,6 @@
+// @generated — do not edit
+import { permissions } from "../lib/permissions.generated";
+import { run } from "./completeWorkOrder";
+import { defineCommand } from "@tailor-platform/erp-kit/module";
+
+export const completeWorkOrder = defineCommand(permissions.completeWorkOrder, run);

package/src/modules/manufacturing/command/completeWorkOrder.test.ts

@@ -0,0 +1,369 @@
+import { describe, expect, it } from "vitest";
+import { createMockDb } from "../../../testing/index";
+import type { Transaction } from "../generated/kysely-tailordb";
+import {
+  WorkOrderNotFoundError,
+  WorkOrderNotCompletableError,
+  WorkOrderNotStartedError,
+  InvalidCompletionQuantityError,
+  DuplicateBackflushRiskError,
+  ReceiptHandoffRequiredError,
+  LotReferenceRequiredError,
+  SerialReferenceRequiredError,
+} from "../lib/errors.generated";
+import {
+  baseInProgressWorkOrder,
+  basePendingWorkOrder,
+  baseCompleteWorkOrder,
+} from "../testing/fixtures";
+import { run } from "./completeWorkOrder";
+import type { CommandContext } from "@tailor-platform/erp-kit/module";
+
+describe("completeWorkOrder", () => {
+  const ctx: CommandContext = {
+    actorId: "test-actor",
+    permissions: ["manufacturing:completeWorkOrder"],
+  };
+
+  const baseInput = {
+    id: baseInProgressWorkOrder.id,
+    completedQuantity: 50,
+    backflushRequired: false,
+    receiptRequired: false,
+    notes: "Final completion",
+  };
+
+  it("completes an in-progress work order with final quantity reporting", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    const completedWorkOrder = {
+      ...baseInProgressWorkOrder,
+      status: "COMPLETE" as const,
+      completedQuantity: 100,
+    };
+
+    // work order lookup
+    spies.select.mockReturnValueOnce(baseInProgressWorkOrder);
+    // update work order
+    spies.update.mockReturnValueOnce(completedWorkOrder);
+    // insert execution event
+    spies.insert.mockReturnValueOnce(undefined);
+    // sibling work orders (all complete after this one)
+    spies.select.mockReturnValueOnce([
+      { ...baseInProgressWorkOrder, id: baseInProgressWorkOrder.id, status: "IN_PROGRESS" },
+    ]);
+    // update parent production order
+    spies.update.mockReturnValueOnce(undefined);
+
+    const result = await run(db, baseInput, ctx);
+
+    expect(result.ok).toBe(true);
+    if (result.ok) {
+      expect(result.value.workOrder.status).toBe("COMPLETE");
+      expect(result.value.workOrder.completedQuantity).toBe(100);
+    }
+    expect(spies.update).toHaveBeenCalled();
+    expect(spies.insert).toHaveBeenCalled();
+  });
+
+  it("returns error when the work order does not exist", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(undefined);
+
+    const result = await run(db, { ...baseInput, id: "nonexistent" }, ctx);
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(WorkOrderNotFoundError);
+    }
+  });
+
+  it("returns error when the work order is not in progress", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(basePendingWorkOrder);
+
+    const result = await run(db, { ...baseInput, id: basePendingWorkOrder.id }, ctx);
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(WorkOrderNotCompletableError);
+    }
+  });
+
+  it("returns error when the work order was never started", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    const unstartedWorkOrder = {
+      ...baseInProgressWorkOrder,
+      actualStartDate: null,
+    };
+    spies.select.mockReturnValueOnce(unstartedWorkOrder);
+
+    const result = await run(db, baseInput, ctx);
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(WorkOrderNotStartedError);
+    }
+  });
+
+  it("returns error when completion quantity is invalid", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseInProgressWorkOrder);
+
+    const result = await run(db, { ...baseInput, completedQuantity: 0 }, ctx);
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(InvalidCompletionQuantityError);
+    }
+  });
+
+  it("returns error when backflush would duplicate manual issue", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseInProgressWorkOrder);
+
+    const result = await run(
+      db,
+      {
+        ...baseInput,
+        backflushRequired: true,
+        manuallyIssuedQuantity: 10,
+      },
+      ctx,
+    );
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(DuplicateBackflushRiskError);
+    }
+  });
+
+  it("emits receipt handoff when output receipt is required", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    const completedWorkOrder = {
+      ...baseInProgressWorkOrder,
+      status: "COMPLETE" as const,
+      completedQuantity: 100,
+    };
+
+    // work order lookup
+    spies.select.mockReturnValueOnce(baseInProgressWorkOrder);
+    // update work order
+    spies.update.mockReturnValueOnce(completedWorkOrder);
+    // insert execution event
+    spies.insert.mockReturnValueOnce(undefined);
+    // sibling work orders
+    spies.select.mockReturnValueOnce([
+      { ...baseInProgressWorkOrder, id: baseInProgressWorkOrder.id, status: "IN_PROGRESS" },
+    ]);
+    // update parent production order
+    spies.update.mockReturnValueOnce(undefined);
+
+    const result = await run(
+      db,
+      {
+        ...baseInput,
+        receiptRequired: true,
+        receiptData: {
+          itemReference: "item-fg-1",
+          unitOfMeasure: "EA",
+          siteReference: "site-1",
+          postingDate: new Date("2024-03-01T12:00:00.000Z"),
+          lotTracked: false,
+          serialTracked: false,
+        },
+      },
+      ctx,
+    );
+
+    expect(result.ok).toBe(true);
+    if (result.ok) {
+      expect(result.value.workOrder.status).toBe("COMPLETE");
+      expect(result.value.receiptHandoff?.itemReference).toBe("item-fg-1");
+    }
+  });
+
+  it("returns error when receipt is required but receipt data is missing", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseInProgressWorkOrder);
+
+    const result = await run(
+      db,
+      {
+        ...baseInput,
+        receiptRequired: true,
+        receiptData: null,
+      },
+      ctx,
+    );
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(ReceiptHandoffRequiredError);
+    }
+  });
+
+  it("returns error when a lot-tracked receipt omits finishedGoodLotReference", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseInProgressWorkOrder);
+
+    const result = await run(
+      db,
+      {
+        ...baseInput,
+        receiptRequired: true,
+        receiptData: {
+          itemReference: "item-fg-1",
+          unitOfMeasure: "EA",
+          siteReference: "site-1",
+          postingDate: new Date("2024-03-01T12:00:00.000Z"),
+          lotTracked: true,
+          serialTracked: false,
+          finishedGoodLotReference: null,
+        },
+      },
+      ctx,
+    );
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(LotReferenceRequiredError);
+    }
+  });
+
+  it("returns error when a serial-tracked receipt omits serialReferences", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseInProgressWorkOrder);
+
+    const result = await run(
+      db,
+      {
+        ...baseInput,
+        receiptRequired: true,
+        receiptData: {
+          itemReference: "item-fg-1",
+          unitOfMeasure: "EA",
+          siteReference: "site-1",
+          postingDate: new Date("2024-03-01T12:00:00.000Z"),
+          lotTracked: false,
+          serialTracked: true,
+          serialReferences: null,
+        },
+      },
+      ctx,
+    );
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(SerialReferenceRequiredError);
+    }
+  });
+
+  it("rolls up completion to the parent order", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    const completedWorkOrder = {
+      ...baseInProgressWorkOrder,
+      status: "COMPLETE" as const,
+      completedQuantity: 100,
+    };
+
+    // work order lookup
+    spies.select.mockReturnValueOnce(baseInProgressWorkOrder);
+    // update work order
+    spies.update.mockReturnValueOnce(completedWorkOrder);
+    // insert execution event
+    spies.insert.mockReturnValueOnce(undefined);
+    // sibling work orders - all siblings already complete/cancelled
+    spies.select.mockReturnValueOnce([
+      { ...baseInProgressWorkOrder, id: baseInProgressWorkOrder.id, status: "IN_PROGRESS" },
+      { ...baseCompleteWorkOrder, id: "work-order-sibling", status: "COMPLETE" },
+    ]);
+    // update parent production order to COMPLETED
+    spies.update.mockReturnValueOnce(undefined);
+
+    const result = await run(db, baseInput, ctx);
+
+    expect(result.ok).toBe(true);
+    // The update spy should have been called twice: once for the work order, once for the parent order
+    expect(spies.update).toHaveBeenCalledTimes(2);
+  });
+
+  it("allows zero-quantity completion only under an explicit bypass policy", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    const completedWorkOrder = {
+      ...baseInProgressWorkOrder,
+      status: "COMPLETE" as const,
+      completedQuantity: baseInProgressWorkOrder.completedQuantity,
+    };
+
+    spies.select.mockReturnValueOnce(baseInProgressWorkOrder);
+    spies.update.mockReturnValueOnce(completedWorkOrder);
+    spies.insert.mockReturnValueOnce(undefined);
+    spies.select.mockReturnValueOnce([
+      { ...baseInProgressWorkOrder, id: baseInProgressWorkOrder.id, status: "IN_PROGRESS" },
+    ]);
+    spies.update.mockReturnValueOnce(undefined);
+
+    const result = await run(
+      db,
+      {
+        ...baseInput,
+        completedQuantity: 0,
+        zeroQuantityBypassPolicy: {
+          allowZeroCompletion: true,
+          reasonCode: "QUALITY_HOLD",
+        },
+        receiptRequired: true,
+        receiptData: {
+          itemReference: "item-fg-1",
+          unitOfMeasure: "EA",
+          siteReference: "site-1",
+          postingDate: new Date("2024-03-01T12:00:00.000Z"),
+          lotTracked: false,
+          serialTracked: false,
+        },
+      },
+      ctx,
+    );
+
+    expect(result.ok).toBe(true);
+    if (result.ok) {
+      expect(result.value.backflushHandoff).toBeNull();
+      expect(result.value.receiptHandoff?.quantity).toBe(0);
+    }
+  });
+
+  it("emits a backflush handoff when completion requires backflush consumption", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    const completedWorkOrder = {
+      ...baseInProgressWorkOrder,
+      status: "COMPLETE" as const,
+      completedQuantity: 100,
+    };
+
+    spies.select.mockReturnValueOnce(baseInProgressWorkOrder);
+    spies.update.mockReturnValueOnce(completedWorkOrder);
+    spies.insert.mockReturnValueOnce(undefined);
+    spies.select.mockReturnValueOnce([
+      { ...baseInProgressWorkOrder, id: baseInProgressWorkOrder.id, status: "IN_PROGRESS" },
+    ]);
+    spies.update.mockReturnValueOnce(undefined);
+
+    const result = await run(
+      db,
+      {
+        ...baseInput,
+        backflushRequired: true,
+        manuallyIssuedQuantity: 0,
+      },
+      ctx,
+    );
+
+    expect(result.ok).toBe(true);
+    if (result.ok) {
+      expect(result.value.backflushHandoff?.productionOrderReference).toBe(
+        baseInProgressWorkOrder.productionOrderId,
+      );
+      expect(result.value.backflushHandoff?.completedQuantity).toBe(50);
+    }
+  });
+});

package/src/modules/manufacturing/command/completeWorkOrder.ts

@@ -0,0 +1,212 @@
+import type { Transaction } from "../generated/kysely-tailordb";
+import {
+  WorkOrderNotFoundError,
+  WorkOrderNotCompletableError,
+  WorkOrderNotStartedError,
+  InvalidCompletionQuantityError,
+  DuplicateBackflushRiskError,
+  ReceiptHandoffRequiredError,
+  LotReferenceRequiredError,
+  SerialReferenceRequiredError,
+} from "../lib/errors.generated";
+import { ok, err, type CommandContext } from "@tailor-platform/erp-kit/module";
+
+export interface ReceiptData {
+  itemReference?: string | null;
+  unitOfMeasure?: string | null;
+  siteReference?: string | null;
+  postingDate?: Date | null;
+  storageLocationReference?: string | null;
+  lotTracked: boolean;
+  serialTracked: boolean;
+  finishedGoodLotReference?: string | null;
+  serialReferences?: string[] | null;
+}
+
+export interface ZeroQuantityBypassPolicy {
+  allowZeroCompletion: boolean;
+  reasonCode?: string | null;
+}
+
+export interface CompleteWorkOrderInput {
+  id: string;
+  completedQuantity: number;
+  zeroQuantityBypassPolicy?: ZeroQuantityBypassPolicy | null;
+  backflushRequired: boolean;
+  manuallyIssuedQuantity?: number;
+  receiptRequired: boolean;
+  receiptData?: ReceiptData | null;
+  notes?: string | null;
+}
+
+/**
+ * Function: completeWorkOrder
+ *
+ * Finishes execution on an in-progress work order. Records the final completed
+ * quantity, validates backflush and receipt-handoff obligations, creates a
+ * COMPLETED execution event, and rolls up completion to the parent production
+ * order when all sibling work orders are finished.
+ */
+export async function run<CF extends Record<string, unknown>>(
+  db: Transaction,
+  input: CompleteWorkOrderInput & CF,
+  _ctx: CommandContext,
+) {
+  const {
+    id,
+    completedQuantity,
+    zeroQuantityBypassPolicy,
+    backflushRequired,
+    manuallyIssuedQuantity,
+    receiptRequired,
+    receiptData,
+    notes,
+    ...customFields
+  } = input;
+  void customFields;
+
+  // 1. Fetch work order with lock
+  const workOrder = await db
+    .selectFrom("WorkOrder")
+    .selectAll()
+    .where("id", "=", id)
+    .forUpdate()
+    .executeTakeFirst();
+
+  if (!workOrder) {
+    return err(new WorkOrderNotFoundError(id));
+  }
+
+  // 2. Validate status is IN_PROGRESS
+  if (workOrder.status !== "IN_PROGRESS") {
+    return err(new WorkOrderNotCompletableError(id));
+  }
+
+  // 3. Validate actual start evidence exists
+  if (!workOrder.actualStartDate) {
+    return err(new WorkOrderNotStartedError(id));
+  }
+
+  // 4. Validate completed quantity, allowing explicit zero-quantity bypass.
+  const zeroQuantityBypassAllowed =
+    completedQuantity === 0 && zeroQuantityBypassPolicy?.allowZeroCompletion === true;
+  if (completedQuantity < 0 || (completedQuantity === 0 && !zeroQuantityBypassAllowed)) {
+    return err(new InvalidCompletionQuantityError(id));
+  }
+
+  // 5. Validate backflush does not duplicate manual issue
+  if (backflushRequired && manuallyIssuedQuantity != null && manuallyIssuedQuantity > 0) {
+    return err(new DuplicateBackflushRiskError(id));
+  }
+
+  // 6. Validate receipt handoff data when receipt is required
+  if (receiptRequired) {
+    if (!receiptData) {
+      return err(new ReceiptHandoffRequiredError(id));
+    }
+
+    if (
+      !receiptData.itemReference ||
+      !receiptData.unitOfMeasure ||
+      !receiptData.siteReference ||
+      !receiptData.postingDate
+    ) {
+      return err(new ReceiptHandoffRequiredError(id));
+    }
+
+    if (receiptData.lotTracked && !receiptData.finishedGoodLotReference) {
+      return err(new LotReferenceRequiredError(id));
+    }
+
+    if (
+      receiptData.serialTracked &&
+      (!receiptData.serialReferences || receiptData.serialReferences.length === 0)
+    ) {
+      return err(new SerialReferenceRequiredError(id));
+    }
+  }
+
+  // 7. Update work order to COMPLETE
+  const now = new Date();
+  const updatedWorkOrder = await db
+    .updateTable("WorkOrder")
+    .set({
+      status: "COMPLETE",
+      completedQuantity: workOrder.completedQuantity + completedQuantity,
+      executionNotes: notes ?? workOrder.executionNotes,
+      updatedAt: now,
+    })
+    .where("id", "=", id)
+    .returningAll()
+    .executeTakeFirstOrThrow();
+
+  // 8. Create COMPLETED execution event
+  await db
+    .insertInto("WorkOrderExecutionEvent")
+    .values({
+      workOrderId: id,
+      eventType: "COMPLETED",
+      timestamp: now,
+      quantity: completedQuantity,
+      timeValue: null,
+      scrapValue: null,
+      notes: notes ?? null,
+      createdAt: now,
+      updatedAt: null,
+    })
+    .execute();
+
+  const backflushHandoff = backflushRequired
+    ? {
+        productionOrderReference: workOrder.productionOrderId,
+        workOrderReference: id,
+        completedQuantity,
+        manuallyIssuedQuantity: manuallyIssuedQuantity ?? 0,
+        postingDate: receiptData?.postingDate ?? now,
+        bypassReason: zeroQuantityBypassAllowed
+          ? (zeroQuantityBypassPolicy?.reasonCode ?? null)
+          : null,
+      }
+    : null;
+
+  const receiptHandoff =
+    receiptRequired && receiptData
+      ? {
+          productionOrderReference: workOrder.productionOrderId,
+          workOrderReference: id,
+          itemReference: receiptData.itemReference,
+          quantity: completedQuantity,
+          unitOfMeasure: receiptData.unitOfMeasure,
+          siteReference: receiptData.siteReference,
+          postingDate: receiptData.postingDate,
+          storageLocationReference: receiptData.storageLocationReference ?? null,
+          finishedGoodLotReference: receiptData.finishedGoodLotReference ?? null,
+          serialReferences: receiptData.serialReferences ?? null,
+        }
+      : null;
+
+  // 9. Roll up to parent production order
+  const siblingWorkOrders = await db
+    .selectFrom("WorkOrder")
+    .selectAll()
+    .where("productionOrderId", "=", workOrder.productionOrderId)
+    .execute();
+
+  const allComplete = (siblingWorkOrders as { id: string; status: string }[]).every((wo) => {
+    if (wo.id === id) return true; // this one was just completed
+    return wo.status === "COMPLETE" || wo.status === "CANCELLED";
+  });
+
+  if (allComplete) {
+    await db
+      .updateTable("ProductionOrder")
+      .set({
+        status: "COMPLETED",
+        updatedAt: now,
+      })
+      .where("id", "=", workOrder.productionOrderId)
+      .execute();
+  }
+
+  return ok({ workOrder: updatedWorkOrder, backflushHandoff, receiptHandoff });
+}

package/src/modules/manufacturing/command/createBillOfMaterial.generated.ts

@@ -0,0 +1,6 @@
+// @generated — do not edit
+import { permissions } from "../lib/permissions.generated";
+import { run } from "./createBillOfMaterial";
+import { defineCommand } from "@tailor-platform/erp-kit/module";
+
+export const createBillOfMaterial = defineCommand(permissions.createBillOfMaterial, run);