@tailor-platform/erp-kit 0.5.1 → 0.7.0

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

@@ -0,0 +1,450 @@
+import type { Transaction } from "../generated/kysely-tailordb";
+import {
+  ProductionOrderNotFoundError,
+  ProductionOrderNotReleasableError,
+  BomNotResolvedError,
+  RoutingNotResolvedError,
+  CrossCompanyMasterReferenceError,
+  CrossSiteMasterReferenceError,
+  PlannedMaterialCostUnavailableError,
+} from "../lib/errors.generated";
+import { ok, err, type CommandContext } from "@tailor-platform/erp-kit/module";
+
+export interface ReleaseProductionOrderInput {
+  id: string;
+  from?: string[];
+}
+
+interface ReleaseMaterialValuationSnapshot {
+  plannedUnitCost: number;
+  currencyCode: string;
+  valuationMethod: string;
+  sourceValuationReference: string | null;
+}
+
+function getOptionalNumber(record: Record<string, unknown>, key: string): number | null {
+  const value = record[key];
+  return typeof value === "number" && Number.isFinite(value) ? value : null;
+}
+
+function getOptionalString(record: Record<string, unknown>, key: string): string | null {
+  const value = record[key];
+  return typeof value === "string" && value.length > 0 ? value : null;
+}
+
+function resolveReleaseMaterialValuation(
+  itemRecord: Record<string, unknown> | undefined,
+): ReleaseMaterialValuationSnapshot | null {
+  if (!itemRecord) {
+    return null;
+  }
+
+  const valuationMethod =
+    getOptionalString(itemRecord, "valuationMethod") ??
+    getOptionalString(itemRecord, "costingMethod") ??
+    (getOptionalNumber(itemRecord, "standardCostRate") != null ? "STANDARD_COST" : null) ??
+    (getOptionalNumber(itemRecord, "costPerUnit") != null ? "AVCO" : null);
+
+  if (!valuationMethod) {
+    return null;
+  }
+
+  const plannedUnitCost =
+    valuationMethod === "STANDARD_COST"
+      ? (getOptionalNumber(itemRecord, "standardCostRate") ??
+        getOptionalNumber(itemRecord, "costPerUnit"))
+      : (getOptionalNumber(itemRecord, "costPerUnit") ??
+        getOptionalNumber(itemRecord, "standardCostRate"));
+
+  if (plannedUnitCost == null) {
+    return null;
+  }
+
+  return {
+    plannedUnitCost,
+    currencyCode:
+      getOptionalString(itemRecord, "currencyCode") ??
+      getOptionalString(itemRecord, "valuationCurrency") ??
+      "USD",
+    valuationMethod,
+    sourceValuationReference:
+      getOptionalString(itemRecord, "valuationReference") ??
+      getOptionalString(itemRecord, "valuationPolicyId") ??
+      getOptionalString(itemRecord, "itemValuationId"),
+  };
+}
+
+/**
+ * Function: releaseProductionOrder
+ *
+ * Turns a draft plan into executable work by resolving active BOM and routing
+ * content, freezing snapshots, creating work orders and material requirements,
+ * and opening manufacturing cost collection.
+ */
+export async function run<CF extends Record<string, unknown>>(
+  db: Transaction,
+  input: ReleaseProductionOrderInput & CF,
+  _ctx: CommandContext,
+) {
+  const { id, from, ...customFields } = input;
+  void customFields;
+
+  const allowedStatuses = from ?? ["DRAFT"];
+  const now = new Date();
+
+  // 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 releasable
+  if (!allowedStatuses.includes(order.status)) {
+    return err(new ProductionOrderNotReleasableError(id));
+  }
+
+  // 3. Resolve active BOM
+  let bom;
+  if (order.selectedBomVersionId) {
+    bom = await db
+      .selectFrom("BillOfMaterial")
+      .selectAll()
+      .where("id", "=", order.selectedBomVersionId)
+      .where("status", "=", "ACTIVE")
+      .executeTakeFirst();
+  } else {
+    bom = await db
+      .selectFrom("BillOfMaterial")
+      .selectAll()
+      .where("parentItemId", "=", order.orderedItemId)
+      .where("companyId", "=", order.companyId)
+      .where("status", "=", "ACTIVE")
+      .executeTakeFirst();
+  }
+
+  if (!bom) {
+    return err(new BomNotResolvedError(id));
+  }
+
+  // 4. Validate BOM company scope
+  if (bom.companyId !== order.companyId) {
+    return err(new CrossCompanyMasterReferenceError(id));
+  }
+
+  // 5. Validate BOM site scope
+  if (bom.siteId != null && bom.siteId !== order.siteId) {
+    return err(new CrossSiteMasterReferenceError(id));
+  }
+
+  // 6. Resolve active routing
+  let routing;
+  if (order.selectedRoutingRevisionId) {
+    routing = await db
+      .selectFrom("Routing")
+      .selectAll()
+      .where("id", "=", order.selectedRoutingRevisionId)
+      .where("status", "=", "ACTIVE")
+      .executeTakeFirst();
+  } else {
+    routing = await db
+      .selectFrom("Routing")
+      .selectAll()
+      .where("parentItemId", "=", order.orderedItemId)
+      .where("companyId", "=", order.companyId)
+      .where("status", "=", "ACTIVE")
+      .executeTakeFirst();
+  }
+
+  if (!routing) {
+    return err(new RoutingNotResolvedError(id));
+  }
+
+  // 7. Validate routing company scope
+  if (routing.companyId !== order.companyId) {
+    return err(new CrossCompanyMasterReferenceError(id));
+  }
+
+  // 8. Validate routing site scope
+  if (routing.siteId != null && routing.siteId !== order.siteId) {
+    return err(new CrossSiteMasterReferenceError(id));
+  }
+
+  // 9. Fetch BOM lines for material requirements
+  const bomLines = await db
+    .selectFrom("BillOfMaterialLine")
+    .selectAll()
+    .where("billOfMaterialId", "=", bom.id)
+    .execute();
+
+  // 10. Resolve planned material cost for each component
+  let totalPlannedMaterialCost = 0;
+  let baselineCurrencyCode = "USD";
+  const materialRequirements: {
+    itemId: string;
+    requiredQuantity: number;
+    unitOfMeasure: string | null;
+    plannedUnitCost: number;
+    valuationMethod: string;
+    valuationCurrencyCode: string;
+    sourceValuationReference: string | null;
+  }[] = [];
+
+  for (const line of bomLines) {
+    // Resolve release-time valuation from inventory-owned item valuation context.
+    const itemValuationRecord = (await db
+      .selectFrom("Item")
+      .selectAll()
+      .where("id", "=", line.itemId)
+      .executeTakeFirst()) as Record<string, unknown> | undefined;
+    const valuation = resolveReleaseMaterialValuation(itemValuationRecord);
+
+    if (!valuation) {
+      return err(new PlannedMaterialCostUnavailableError(line.itemId));
+    }
+
+    const requiredQuantity = line.requiredQuantity * order.plannedQuantity;
+    totalPlannedMaterialCost += valuation.plannedUnitCost * requiredQuantity;
+    baselineCurrencyCode = valuation.currencyCode;
+
+    materialRequirements.push({
+      itemId: line.itemId,
+      requiredQuantity,
+      unitOfMeasure: line.unitOfMeasure ?? null,
+      plannedUnitCost: valuation.plannedUnitCost,
+      valuationMethod: valuation.valuationMethod,
+      valuationCurrencyCode: valuation.currencyCode,
+      sourceValuationReference: valuation.sourceValuationReference,
+    });
+  }
+
+  // 11. Fetch routing operations for work orders
+  const operations = await db
+    .selectFrom("RoutingOperation")
+    .selectAll()
+    .where("routingId", "=", routing.id)
+    .execute();
+
+  // 12. Calculate planned labor and machine costs from operations and work centers
+  let totalPlannedLaborCost = 0;
+  let totalPlannedMachineCost = 0;
+  let totalPlannedOverheadCost = 0;
+  const workCenterSnapshots = new Map<
+    string,
+    {
+      workCenterId: string;
+      code: string | null;
+      laborRate: number | null;
+      machineRate: number | null;
+      overheadAbsorptionMethod: string | null;
+      overheadAbsorptionRate: number | null;
+      overheadAbsorptionCurrency: string | null;
+    }
+  >();
+
+  for (const op of operations) {
+    const wc = await db
+      .selectFrom("WorkCenter")
+      .selectAll()
+      .where("id", "=", op.workCenterId)
+      .executeTakeFirst();
+
+    if (wc) {
+      const duration = op.standardSetupTime + op.standardRunTime * order.plannedQuantity;
+      const laborCost = (wc.laborRate ?? 0) * duration;
+      const machineCost = (wc.machineRate ?? 0) * duration;
+      totalPlannedLaborCost += laborCost;
+      totalPlannedMachineCost += machineCost;
+
+      const wcRecord = wc as Record<string, unknown>;
+      const overheadRate = getOptionalNumber(wcRecord, "overheadAbsorptionRate");
+      if (wc.overheadAbsorptionMethod === "PERCENT_OF_LABOR_COST" && overheadRate != null) {
+        totalPlannedOverheadCost += laborCost * (overheadRate / 100);
+      } else if (
+        wc.overheadAbsorptionMethod === "PERCENT_OF_MACHINE_COST" &&
+        overheadRate != null
+      ) {
+        totalPlannedOverheadCost += machineCost * (overheadRate / 100);
+      } else if (
+        wc.overheadAbsorptionMethod === "FIXED_AMOUNT_PER_GOOD_UNIT" &&
+        overheadRate != null
+      ) {
+        totalPlannedOverheadCost += order.plannedQuantity * overheadRate;
+      }
+
+      workCenterSnapshots.set(op.workCenterId, {
+        workCenterId: wc.id,
+        code: wc.code,
+        laborRate: wc.laborRate ?? null,
+        machineRate: wc.machineRate ?? null,
+        overheadAbsorptionMethod: wc.overheadAbsorptionMethod ?? null,
+        overheadAbsorptionRate: overheadRate,
+        overheadAbsorptionCurrency: wc.overheadAbsorptionCurrency ?? null,
+      });
+    }
+  }
+
+  // 13. Create BOM snapshot
+  await db
+    .insertInto("ProductionOrderBomSnapshot")
+    .values({
+      productionOrderId: order.id,
+      parentItemId: bom.parentItemId,
+      bomType: bom.bomType,
+      snapshotData: JSON.stringify({
+        bomId: bom.id,
+        revisionNumber: bom.revisionNumber,
+        companyId: bom.companyId,
+        siteId: bom.siteId,
+        effectivityStartDate: bom.effectivityStartDate,
+        effectivityEndDate: bom.effectivityEndDate,
+        defaultSelection: bom.defaultSelection,
+        lines: bomLines.map((line) => {
+          const requirement = materialRequirements.find((req) => req.itemId === line.itemId);
+          return {
+            itemId: line.itemId,
+            requiredQuantity: line.requiredQuantity,
+            unitOfMeasure: line.unitOfMeasure,
+            scrapAssumption: line.scrapAssumption,
+            isSubassembly: line.isSubassembly,
+            plannedUnitCost: requirement?.plannedUnitCost ?? null,
+            currencyCode: requirement?.valuationCurrencyCode ?? null,
+            valuationMethod: requirement?.valuationMethod ?? null,
+            sourceValuationReference: requirement?.sourceValuationReference ?? null,
+          };
+        }),
+      }),
+      createdAt: now,
+      updatedAt: null,
+    })
+    .returningAll()
+    .executeTakeFirst();
+
+  // 14. Create routing snapshot
+  await db
+    .insertInto("ProductionOrderRoutingSnapshot")
+    .values({
+      productionOrderId: order.id,
+      routingId: routing.id,
+      snapshotData: JSON.stringify({
+        routingId: routing.id,
+        revisionNumber: routing.revisionNumber,
+        companyId: routing.companyId,
+        siteId: routing.siteId,
+        operations: operations.map((op) => ({
+          id: op.id,
+          sequenceNumber: op.sequenceNumber,
+          operationDescription: op.operationDescription,
+          workCenterId: op.workCenterId,
+          standardSetupTime: op.standardSetupTime,
+          standardRunTime: op.standardRunTime,
+          operatorInstructions: op.operatorInstructions,
+          workCenterSnapshot: workCenterSnapshots.get(op.workCenterId) ?? null,
+        })),
+      }),
+      createdAt: now,
+      updatedAt: null,
+    })
+    .returningAll()
+    .executeTakeFirst();
+
+  // 15. Create cost baseline
+  await db
+    .insertInto("ProductionOrderCostBaseline")
+    .values({
+      productionOrderId: order.id,
+      plannedMaterialCost: totalPlannedMaterialCost,
+      plannedLaborCost: totalPlannedLaborCost,
+      plannedMachineCost: totalPlannedMachineCost,
+      plannedOverheadCost: totalPlannedOverheadCost,
+      currencyCode: baselineCurrencyCode,
+      createdAt: now,
+      updatedAt: null,
+    })
+    .returningAll()
+    .executeTakeFirst();
+
+  // 16. Create material requirements
+  for (const matReq of materialRequirements) {
+    await db
+      .insertInto("ProductionOrderMaterialRequirement")
+      .values({
+        productionOrderId: order.id,
+        itemId: matReq.itemId,
+        requiredQuantity: matReq.requiredQuantity,
+        unitOfMeasure: matReq.unitOfMeasure,
+        plannedUnitCost: matReq.plannedUnitCost,
+        createdAt: now,
+        updatedAt: null,
+      })
+      .returningAll()
+      .executeTakeFirst();
+  }
+
+  // 17. Create work orders from routing operations
+  for (const op of operations) {
+    await db
+      .insertInto("WorkOrder")
+      .values({
+        productionOrderId: order.id,
+        routingOperationSequenceNumber: op.sequenceNumber,
+        workCenterId: op.workCenterId,
+        plannedQuantity: order.plannedQuantity,
+        completedQuantity: 0,
+        scrapQuantity: 0,
+        actualSetupTime: 0,
+        actualRunTime: 0,
+        actualStartDate: null,
+        pauseReason: null,
+        executionNotes: null,
+        status: "PENDING",
+        createdAt: now,
+        updatedAt: null,
+      })
+      .returningAll()
+      .executeTakeFirst();
+  }
+
+  // 18. Create manufacturing cost summary in COLLECTING status
+  await db
+    .insertInto("ManufacturingCostSummary")
+    .values({
+      productionOrderId: order.id,
+      plannedMaterialCost: totalPlannedMaterialCost,
+      plannedLaborCost: totalPlannedLaborCost,
+      plannedMachineCost: totalPlannedMachineCost,
+      plannedOverheadCost: totalPlannedOverheadCost,
+      actualMaterialCost: 0,
+      actualLaborCost: 0,
+      actualMachineCost: 0,
+      actualOverheadCost: 0,
+      currencyCode: baselineCurrencyCode,
+      reviewedDate: null,
+      reviewerNotes: null,
+      status: "COLLECTING",
+      createdAt: now,
+      updatedAt: null,
+    })
+    .returningAll()
+    .executeTakeFirst();
+
+  // 19. Update order status to RELEASED with selected BOM/routing IDs
+  const releasedOrder = await db
+    .updateTable("ProductionOrder")
+    .set({
+      selectedBomVersionId: bom.id,
+      selectedRoutingRevisionId: routing.id,
+      status: "RELEASED",
+      updatedAt: now,
+    })
+    .where("id", "=", id)
+    .returningAll()
+    .executeTakeFirstOrThrow();
+
+  return ok({ productionOrder: releasedOrder });
+}

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

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

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

@@ -0,0 +1,196 @@
+import { describe, expect, it } from "vitest";
+import { createMockDb } from "../../../testing/index";
+import type { Transaction } from "../generated/kysely-tailordb";
+import {
+  ProductionOrderNotFoundError,
+  ProductionOrderNotReopenableError,
+  ReopenReasonRequiredError,
+  CostSummaryNotReopenableError,
+  OrderAlreadyClosedError,
+} from "../lib/errors.generated";
+import {
+  baseTechCompleteProductionOrder,
+  baseCompletedProductionOrder,
+  baseClosedProductionOrder,
+  basePendingReviewCostSummary,
+  baseReviewedCostSummary,
+  baseSettledCostSummary,
+} from "../testing/fixtures";
+import { run } from "./reopenProductionOrder";
+import type { CommandContext } from "@tailor-platform/erp-kit/module";
+
+describe("reopenProductionOrder", () => {
+  const ctx: CommandContext = {
+    actorId: "test-actor",
+    permissions: ["manufacturing:reopenProductionOrder"],
+  };
+
+  const validInput = {
+    id: baseTechCompleteProductionOrder.id,
+    reason: "Additional rework needed for quality defects",
+  };
+
+  it("reopens a technically complete order for additional execution", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    const reopened = { ...baseTechCompleteProductionOrder, status: "IN_PROGRESS" as const };
+
+    // order lookup
+    spies.select.mockReturnValueOnce(baseTechCompleteProductionOrder);
+    // cost summary in PENDING_VARIANCE_REVIEW
+    spies.select.mockReturnValueOnce({
+      ...basePendingReviewCostSummary,
+      productionOrderId: baseTechCompleteProductionOrder.id,
+    });
+    // update cost summary
+    spies.update.mockReturnValueOnce(undefined);
+    // update order status
+    spies.update.mockReturnValue(reopened);
+
+    const result = await run(db, validInput, ctx);
+
+    expect(result.ok).toBe(true);
+    if (result.ok) {
+      expect(result.value.productionOrder.status).toBe("IN_PROGRESS");
+    }
+    expect(spies.update).toHaveBeenCalled();
+  });
+
+  it("returns error when the order does not exist", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(undefined);
+
+    const result = await run(db, { id: "nonexistent", reason: "rework" }, ctx);
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(ProductionOrderNotFoundError);
+    }
+  });
+
+  it("returns error when the order is not technically complete", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseCompletedProductionOrder);
+
+    const result = await run(db, { id: baseCompletedProductionOrder.id, reason: "rework" }, ctx);
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(ProductionOrderNotReopenableError);
+    }
+  });
+
+  it("returns error when no reopen reason is provided", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseTechCompleteProductionOrder);
+
+    const result = await run(db, { id: baseTechCompleteProductionOrder.id, reason: "" }, ctx);
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(ReopenReasonRequiredError);
+    }
+  });
+
+  it("reopens an order when the linked cost summary is PENDING_VARIANCE_REVIEW", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    const reopened = { ...baseTechCompleteProductionOrder, status: "IN_PROGRESS" as const };
+
+    // order lookup
+    spies.select.mockReturnValueOnce(baseTechCompleteProductionOrder);
+    // cost summary in PENDING_VARIANCE_REVIEW
+    spies.select.mockReturnValueOnce({
+      ...basePendingReviewCostSummary,
+      productionOrderId: baseTechCompleteProductionOrder.id,
+    });
+    // update cost summary
+    spies.update.mockReturnValueOnce(undefined);
+    // update order status
+    spies.update.mockReturnValue(reopened);
+
+    const result = await run(db, validInput, ctx);
+
+    expect(result.ok).toBe(true);
+    if (result.ok) {
+      expect(result.value.productionOrder.status).toBe("IN_PROGRESS");
+    }
+  });
+
+  it("reopens an order when the linked cost summary is VARIANCE_REVIEWED", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    const reopened = { ...baseTechCompleteProductionOrder, status: "IN_PROGRESS" as const };
+
+    // order lookup
+    spies.select.mockReturnValueOnce(baseTechCompleteProductionOrder);
+    // cost summary in VARIANCE_REVIEWED
+    spies.select.mockReturnValueOnce({
+      ...baseReviewedCostSummary,
+      productionOrderId: baseTechCompleteProductionOrder.id,
+    });
+    // update cost summary
+    spies.update.mockReturnValueOnce(undefined);
+    // update order status
+    spies.update.mockReturnValue(reopened);
+
+    const result = await run(db, validInput, ctx);
+
+    expect(result.ok).toBe(true);
+    if (result.ok) {
+      expect(result.value.productionOrder.status).toBe("IN_PROGRESS");
+    }
+  });
+
+  it("returns error when the linked cost summary is already SETTLED or otherwise not reopenable", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+
+    // order lookup
+    spies.select.mockReturnValueOnce(baseTechCompleteProductionOrder);
+    // cost summary already SETTLED
+    spies.select.mockReturnValueOnce({
+      ...baseSettledCostSummary,
+      productionOrderId: baseTechCompleteProductionOrder.id,
+    });
+
+    const result = await run(db, validInput, ctx);
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(CostSummaryNotReopenableError);
+    }
+  });
+
+  it("returns error when the order is already closed", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseClosedProductionOrder);
+
+    const result = await run(db, { id: baseClosedProductionOrder.id, reason: "rework" }, ctx);
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(OrderAlreadyClosedError);
+    }
+  });
+
+  it("returns the linked cost summary to collecting on reopen", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    const reopened = { ...baseTechCompleteProductionOrder, status: "IN_PROGRESS" as const };
+
+    // order lookup
+    spies.select.mockReturnValueOnce(baseTechCompleteProductionOrder);
+    // cost summary in PENDING_VARIANCE_REVIEW
+    spies.select.mockReturnValueOnce({
+      ...basePendingReviewCostSummary,
+      productionOrderId: baseTechCompleteProductionOrder.id,
+    });
+    // update cost summary to COLLECTING
+    spies.update.mockReturnValueOnce(undefined);
+    // update order status
+    spies.update.mockReturnValue(reopened);
+
+    const result = await run(db, validInput, ctx);
+
+    expect(result.ok).toBe(true);
+    // The first update call should be for cost summary (back to COLLECTING)
+    // The second update call should be for order status (to IN_PROGRESS)
+    expect(spies.update).toHaveBeenCalledTimes(2);
+  });
+});