@tailor-platform/erp-kit 0.5.1 → 0.6.0

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

@@ -0,0 +1,174 @@
+import type { Transaction } from "../generated/kysely-tailordb";
+import {
+  BomNotFoundError,
+  BomNotMutableError,
+  InvalidComponentQuantityError,
+  ComponentItemInactiveError,
+  AmbiguousEffectivityRuleError,
+} from "../lib/errors.generated";
+import { ok, err, type CommandContext } from "@tailor-platform/erp-kit/module";
+
+export interface UpdateBillOfMaterialLineInput {
+  itemId: string;
+  requiredQuantity: number;
+  unitOfMeasure?: string | null;
+  scrapAssumption?: number | null;
+  isSubassembly?: boolean | null;
+}
+
+export interface UpdateBillOfMaterialInput {
+  id: string;
+  bomType?: string | null;
+  effectivityStartDate?: Date | null;
+  effectivityEndDate?: Date | null;
+  defaultSelection?: boolean | null;
+  revisionNumber?: string | null;
+  lines?: UpdateBillOfMaterialLineInput[];
+}
+
+/**
+ * Function: updateBillOfMaterial
+ *
+ * Revises mutable draft BOM content before activation. Supports changes to
+ * effectivity, default flags, bomType, and component lines while preserving
+ * released production-order snapshots.
+ */
+export async function run<CF extends Record<string, unknown>>(
+  db: Transaction,
+  input: UpdateBillOfMaterialInput & CF,
+  _ctx: CommandContext,
+) {
+  const {
+    id,
+    bomType,
+    effectivityStartDate,
+    effectivityEndDate,
+    defaultSelection,
+    revisionNumber,
+    lines,
+    ...customFields
+  } = input;
+
+  // 1. Fetch BOM with lock
+  const bom = await db
+    .selectFrom("BillOfMaterial")
+    .selectAll()
+    .where("id", "=", id)
+    .forUpdate()
+    .executeTakeFirst();
+
+  if (!bom) {
+    return err(new BomNotFoundError(id));
+  }
+
+  // 2. Only DRAFT BOMs are mutable
+  if (bom.status !== "DRAFT") {
+    return err(new BomNotMutableError(id));
+  }
+
+  // 3. Validate revised component lines if provided
+  if (lines) {
+    for (const line of lines) {
+      if (line.requiredQuantity <= 0) {
+        return err(new InvalidComponentQuantityError(line.itemId));
+      }
+
+      // Check component item is not inactive
+      const componentItem = await db
+        .selectFrom("Item")
+        .selectAll()
+        .where("id", "=", line.itemId)
+        .executeTakeFirst();
+
+      if (!componentItem) {
+        return err(new ComponentItemInactiveError(line.itemId));
+      }
+    }
+  }
+
+  // 4. Check effectivity ambiguity — if effectivity or default selection changed,
+  //    verify no ambiguous active-selection plan would result once activated
+  const effectiveDefaultSelection =
+    defaultSelection !== undefined ? defaultSelection : bom.defaultSelection;
+  const effectiveStartDate =
+    effectivityStartDate !== undefined ? effectivityStartDate : bom.effectivityStartDate;
+  const effectiveEndDate =
+    effectivityEndDate !== undefined ? effectivityEndDate : bom.effectivityEndDate;
+
+  if (
+    defaultSelection !== undefined ||
+    effectivityStartDate !== undefined ||
+    effectivityEndDate !== undefined
+  ) {
+    // Find other active BOMs for same parent item and scope that could conflict
+    const conflictingBom = await db
+      .selectFrom("BillOfMaterial")
+      .selectAll()
+      .where("parentItemId", "=", bom.parentItemId)
+      .where("companyId", "=", bom.companyId)
+      .where("id", "!=", id)
+      .where("status", "=", "ACTIVE")
+      .where("defaultSelection", "=", effectiveDefaultSelection ?? false)
+      .executeTakeFirst();
+
+    if (conflictingBom && effectiveDefaultSelection) {
+      // Check date overlap
+      const hasOverlap =
+        !effectiveStartDate ||
+        !conflictingBom.effectivityEndDate ||
+        effectiveStartDate <= conflictingBom.effectivityEndDate;
+      const hasOverlap2 =
+        !effectiveEndDate ||
+        !conflictingBom.effectivityStartDate ||
+        effectiveEndDate >= conflictingBom.effectivityStartDate;
+
+      if (hasOverlap && hasOverlap2) {
+        return err(new AmbiguousEffectivityRuleError(id));
+      }
+    }
+  }
+
+  // 5. Build update set for BOM header
+  const updateSet: Record<string, unknown> = {
+    ...customFields,
+    updatedAt: new Date(),
+  };
+
+  if (bomType !== undefined) updateSet.bomType = bomType;
+  if (effectivityStartDate !== undefined) updateSet.effectivityStartDate = effectivityStartDate;
+  if (effectivityEndDate !== undefined) updateSet.effectivityEndDate = effectivityEndDate;
+  if (defaultSelection !== undefined) updateSet.defaultSelection = defaultSelection;
+  if (revisionNumber !== undefined) updateSet.revisionNumber = revisionNumber;
+
+  // 6. Persist BOM header changes
+  const updatedBom = await db
+    .updateTable("BillOfMaterial")
+    .set(updateSet)
+    .where("id", "=", id)
+    .returningAll()
+    .executeTakeFirstOrThrow();
+
+  // 7. Replace lines if provided (delete old, insert new)
+  if (lines) {
+    await db.deleteFrom("BillOfMaterialLine").where("billOfMaterialId", "=", id).execute();
+
+    for (const line of lines) {
+      await db
+        .insertInto("BillOfMaterialLine")
+        .values({
+          billOfMaterialId: id,
+          itemId: line.itemId,
+          requiredQuantity: line.requiredQuantity,
+          unitOfMeasure: line.unitOfMeasure ?? null,
+          scrapAssumption: line.scrapAssumption ?? null,
+          isSubassembly: line.isSubassembly ?? null,
+          createdAt: new Date(),
+          updatedAt: null,
+        })
+        .returningAll()
+        .executeTakeFirst();
+    }
+  }
+
+  return ok({ billOfMaterial: updatedBom });
+}

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

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

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

@@ -0,0 +1,112 @@
+import { describe, expect, it } from "vitest";
+import { createMockDb } from "../../../testing/index";
+import type { Transaction } from "../generated/kysely-tailordb";
+import {
+  ProductionOrderNotFoundError,
+  ProductionOrderNotMutableError,
+  InvalidPlannedQuantityError,
+  ImmutableScopeFieldError,
+  CrossScopeMasterReferenceError,
+} from "../lib/errors.generated";
+import {
+  baseDraftProductionOrder,
+  baseReleasedProductionOrder,
+  baseActiveBom,
+} from "../testing/fixtures";
+import { run } from "./updateProductionOrder";
+import type { CommandContext } from "@tailor-platform/erp-kit/module";
+
+describe("updateProductionOrder", () => {
+  const ctx: CommandContext = {
+    actorId: "test-actor",
+    permissions: ["manufacturing:updateProductionOrder"],
+  };
+
+  it("updates draft planning fields on a production order", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    const updated = { ...baseDraftProductionOrder, plannedQuantity: 200 };
+
+    spies.select.mockReturnValueOnce(baseDraftProductionOrder);
+    spies.update.mockReturnValue(updated);
+
+    const result = await run(db, { id: baseDraftProductionOrder.id, plannedQuantity: 200 }, ctx);
+
+    expect(result.ok).toBe(true);
+    if (result.ok) {
+      expect(result.value.productionOrder.plannedQuantity).toBe(200);
+    }
+    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" }, ctx);
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(ProductionOrderNotFoundError);
+    }
+  });
+
+  it("returns error when the order is not in DRAFT", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseReleasedProductionOrder);
+
+    const result = await run(db, { id: baseReleasedProductionOrder.id, plannedQuantity: 200 }, ctx);
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(ProductionOrderNotMutableError);
+    }
+  });
+
+  it("returns error when planned quantity is not positive", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseDraftProductionOrder);
+
+    const result = await run(db, { id: baseDraftProductionOrder.id, plannedQuantity: 0 }, ctx);
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(InvalidPlannedQuantityError);
+    }
+  });
+
+  it("returns error when immutable scope identity is changed", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseDraftProductionOrder);
+
+    const result = await run(
+      db,
+      { id: baseDraftProductionOrder.id, orderedItemId: "different-item" },
+      ctx,
+    );
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(ImmutableScopeFieldError);
+    }
+  });
+
+  it("returns error when BOM or routing references are out of scope", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    const crossScopeBom = { ...baseActiveBom, companyId: "other-company" };
+
+    spies.select.mockReturnValueOnce(baseDraftProductionOrder);
+    // bom lookup
+    spies.select.mockReturnValueOnce(crossScopeBom);
+
+    const result = await run(
+      db,
+      { id: baseDraftProductionOrder.id, selectedBomVersionId: crossScopeBom.id },
+      ctx,
+    );
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(CrossScopeMasterReferenceError);
+    }
+  });
+});

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

@@ -0,0 +1,145 @@
+import type { Transaction } from "../generated/kysely-tailordb";
+import {
+  ProductionOrderNotFoundError,
+  ProductionOrderNotMutableError,
+  InvalidPlannedQuantityError,
+  ImmutableScopeFieldError,
+  CrossScopeMasterReferenceError,
+} from "../lib/errors.generated";
+import { ok, err, type CommandContext } from "@tailor-platform/erp-kit/module";
+
+export interface UpdateProductionOrderInput {
+  id: string;
+  plannedQuantity?: number | null;
+  plannedStartDate?: Date | null;
+  plannedEndDate?: Date | null;
+  selectedBomVersionId?: string | null;
+  selectedRoutingRevisionId?: string | null;
+  orderedItemId?: string | null;
+  companyId?: string | null;
+  siteId?: string | null;
+}
+
+/**
+ * Function: updateProductionOrder
+ *
+ * Revises mutable draft planning fields such as dates, quantity, and
+ * preferred BOM or routing before release freezes execution assumptions.
+ */
+export async function run<CF extends Record<string, unknown>>(
+  db: Transaction,
+  input: UpdateProductionOrderInput & CF,
+  _ctx: CommandContext,
+) {
+  const {
+    id,
+    plannedQuantity,
+    plannedStartDate,
+    plannedEndDate,
+    selectedBomVersionId,
+    selectedRoutingRevisionId,
+    orderedItemId,
+    companyId,
+    siteId,
+    ...customFields
+  } = input;
+
+  // 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. Only DRAFT orders are mutable
+  if (order.status !== "DRAFT") {
+    return err(new ProductionOrderNotMutableError(id));
+  }
+
+  // 3. Validate planned quantity if provided
+  if (plannedQuantity != null && plannedQuantity <= 0) {
+    return err(new InvalidPlannedQuantityError(id));
+  }
+
+  // 4. Immutable scope fields
+  if (
+    orderedItemId !== undefined &&
+    orderedItemId !== null &&
+    orderedItemId !== order.orderedItemId
+  ) {
+    return err(new ImmutableScopeFieldError(id));
+  }
+  if (companyId !== undefined && companyId !== null && companyId !== order.companyId) {
+    return err(new ImmutableScopeFieldError(id));
+  }
+  if (siteId !== undefined && siteId !== null && siteId !== order.siteId) {
+    return err(new ImmutableScopeFieldError(id));
+  }
+
+  // 5. Validate optional BOM reference scope
+  const effectiveBomId =
+    selectedBomVersionId !== undefined ? selectedBomVersionId : order.selectedBomVersionId;
+  if (effectiveBomId) {
+    const bom = await db
+      .selectFrom("BillOfMaterial")
+      .selectAll()
+      .where("id", "=", effectiveBomId)
+      .executeTakeFirst();
+
+    if (
+      bom &&
+      (bom.companyId !== order.companyId || (bom.siteId != null && bom.siteId !== order.siteId))
+    ) {
+      return err(new CrossScopeMasterReferenceError(id));
+    }
+  }
+
+  // 6. Validate optional routing reference scope
+  const effectiveRoutingId =
+    selectedRoutingRevisionId !== undefined
+      ? selectedRoutingRevisionId
+      : order.selectedRoutingRevisionId;
+  if (effectiveRoutingId) {
+    const routing = await db
+      .selectFrom("Routing")
+      .selectAll()
+      .where("id", "=", effectiveRoutingId)
+      .executeTakeFirst();
+
+    if (
+      routing &&
+      (routing.companyId !== order.companyId ||
+        (routing.siteId != null && routing.siteId !== order.siteId))
+    ) {
+      return err(new CrossScopeMasterReferenceError(id));
+    }
+  }
+
+  // 7. Build update set
+  const updateSet: Record<string, unknown> = {
+    ...customFields,
+    updatedAt: new Date(),
+  };
+
+  if (plannedQuantity !== undefined) updateSet.plannedQuantity = plannedQuantity;
+  if (plannedStartDate !== undefined) updateSet.plannedStartDate = plannedStartDate;
+  if (plannedEndDate !== undefined) updateSet.plannedEndDate = plannedEndDate;
+  if (selectedBomVersionId !== undefined) updateSet.selectedBomVersionId = selectedBomVersionId;
+  if (selectedRoutingRevisionId !== undefined)
+    updateSet.selectedRoutingRevisionId = selectedRoutingRevisionId;
+
+  // 8. Persist changes
+  const updated = await db
+    .updateTable("ProductionOrder")
+    .set(updateSet)
+    .where("id", "=", id)
+    .returningAll()
+    .executeTakeFirstOrThrow();
+
+  return ok({ productionOrder: updated });
+}

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

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

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

@@ -0,0 +1,211 @@
+import { describe, expect, it } from "vitest";
+import { createMockDb } from "../../../testing/index";
+import type { Transaction } from "../generated/kysely-tailordb";
+import {
+  RoutingNotFoundError,
+  RoutingNotMutableError,
+  DuplicateOperationSequenceError,
+  InvalidStandardTimeError,
+  WorkCenterNotFoundError,
+  CrossCompanyWorkCenterError,
+} from "../lib/errors.generated";
+import { baseDraftRouting, baseActiveRouting, baseActiveWorkCenter } from "../testing/fixtures";
+import { run } from "./updateRouting";
+import type { CommandContext } from "@tailor-platform/erp-kit/module";
+
+describe("updateRouting", () => {
+  const ctx: CommandContext = {
+    actorId: "test-actor",
+    permissions: ["manufacturing:updateRouting"],
+  };
+
+  const validOperations = [
+    {
+      sequenceNumber: 10,
+      operationDescription: "Revised assembly",
+      workCenterId: "work-center-2",
+      standardSetupTime: 25,
+      standardRunTime: 55,
+      operatorInstructions: null,
+    },
+    {
+      sequenceNumber: 20,
+      operationDescription: "Revised QC",
+      workCenterId: "work-center-2",
+      standardSetupTime: 15,
+      standardRunTime: 20,
+      operatorInstructions: null,
+    },
+  ];
+
+  const validInput = {
+    id: "routing-1",
+    operations: validOperations,
+  };
+
+  it("updates draft routing operations", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+
+    // select: Routing lookup
+    spies.select.mockReturnValueOnce(baseDraftRouting);
+    // select: WorkCenter lookup for op 1
+    spies.select.mockReturnValueOnce(baseActiveWorkCenter);
+    // select: WorkCenter lookup for op 2
+    spies.select.mockReturnValueOnce(baseActiveWorkCenter);
+    // update: Routing header
+    spies.update.mockReturnValue({ ...baseDraftRouting, updatedAt: new Date() });
+    // insert: new operations
+    spies.insert.mockReturnValue({
+      id: "op-new",
+      routingId: "routing-1",
+      sequenceNumber: 10,
+      operationDescription: "Revised assembly",
+      workCenterId: "work-center-2",
+      standardSetupTime: 25,
+      standardRunTime: 55,
+      operatorInstructions: null,
+      createdAt: new Date(),
+      updatedAt: null,
+    });
+
+    const result = await run(db, validInput, ctx);
+
+    expect(result.ok).toBe(true);
+    if (result.ok) {
+      expect(result.value.routing).toBeDefined();
+    }
+    expect(spies.update).toHaveBeenCalled();
+  });
+
+  it("returns error when the routing does not exist", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+
+    // select: Routing lookup - not found
+    spies.select.mockReturnValueOnce(undefined);
+
+    const result = await run(db, validInput, ctx);
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(RoutingNotFoundError);
+    }
+  });
+
+  it("returns error when the routing is not in DRAFT", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+
+    // select: Routing lookup - ACTIVE
+    spies.select.mockReturnValueOnce(baseActiveRouting);
+
+    const result = await run(db, { ...validInput, id: "routing-2" }, ctx);
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(RoutingNotMutableError);
+    }
+  });
+
+  it("returns error when revised sequence numbers conflict", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+
+    // select: Routing lookup
+    spies.select.mockReturnValueOnce(baseDraftRouting);
+
+    const duplicateOps = [
+      { ...validOperations[0], sequenceNumber: 10 },
+      { ...validOperations[1], sequenceNumber: 10 },
+    ];
+
+    const result = await run(db, { ...validInput, operations: duplicateOps }, ctx);
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(DuplicateOperationSequenceError);
+    }
+  });
+
+  it("returns error when a revised standard time is negative", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+
+    // select: Routing lookup
+    spies.select.mockReturnValueOnce(baseDraftRouting);
+
+    const badOps = [{ ...validOperations[0], standardRunTime: -1 }];
+
+    const result = await run(db, { ...validInput, operations: badOps }, ctx);
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(InvalidStandardTimeError);
+    }
+  });
+
+  it("returns error when a referenced work center does not exist", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+
+    // select: Routing lookup
+    spies.select.mockReturnValueOnce(baseDraftRouting);
+    // select: WorkCenter lookup - not found
+    spies.select.mockReturnValueOnce(undefined);
+
+    const result = await run(db, validInput, ctx);
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(WorkCenterNotFoundError);
+    }
+  });
+
+  it("returns error when a referenced work center is outside the routing company", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+
+    // select: Routing lookup
+    spies.select.mockReturnValueOnce(baseDraftRouting);
+    // select: WorkCenter lookup - different company
+    spies.select.mockReturnValueOnce({
+      ...baseActiveWorkCenter,
+      companyId: "other-company",
+    });
+
+    const result = await run(db, validInput, ctx);
+
+    expect(result.ok).toBe(false);
+    if (!result.ok) {
+      expect(result.error).toBeInstanceOf(CrossCompanyWorkCenterError);
+    }
+  });
+
+  it("preserves released routing snapshots after update", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+
+    // select: Routing lookup - DRAFT (only DRAFT can be updated)
+    spies.select.mockReturnValueOnce(baseDraftRouting);
+    // select: WorkCenter lookup for op 1
+    spies.select.mockReturnValueOnce(baseActiveWorkCenter);
+    // update: Routing header
+    spies.update.mockReturnValue({ ...baseDraftRouting, updatedAt: new Date() });
+    // insert: new operations
+    spies.insert.mockReturnValue({
+      id: "op-new",
+      routingId: "routing-1",
+      sequenceNumber: 10,
+      operationDescription: "Revised assembly",
+      workCenterId: "work-center-2",
+      standardSetupTime: 25,
+      standardRunTime: 55,
+      operatorInstructions: null,
+      createdAt: new Date(),
+      updatedAt: null,
+    });
+
+    const singleOp = [validOperations[0]];
+    const result = await run(db, { ...validInput, operations: singleOp }, ctx);
+
+    // The update only touches the Routing and RoutingOperation tables,
+    // not ProductionOrderRoutingSnapshot, preserving frozen snapshots.
+    expect(result.ok).toBe(true);
+    if (result.ok) {
+      expect(result.value.routing.status).toBe("DRAFT");
+    }
+  });
+});