@tailor-platform/erp-kit 0.7.0 → 0.9.0

package/src/modules/accounting/command/createInternalOrder.ts

@@ -0,0 +1,104 @@
+import type { Transaction } from "../generated/kysely-tailordb";
+import {
+  CompanyNotFoundError,
+  DuplicateOrderNumberError,
+  InvalidOrderTypeError,
+  DescriptionRequiredError,
+  ResponsiblePersonRequiredError,
+  CostCenterNotFoundError,
+  InvalidValidityPeriodError,
+} from "../lib/errors.generated";
+import { err, ok, type CommandContext } from "@tailor-platform/erp-kit/module";
+
+const VALID_ORDER_TYPES = ["OVERHEAD", "INVESTMENT", "ACCRUAL"];
+
+export interface CreateInternalOrderInput {
+  companyId: string;
+  orderNumber: string;
+  orderType: string;
+  description: string;
+  responsiblePersonId: string;
+  costCenterId: string;
+  validFrom?: Date | null;
+  validTo?: Date | null;
+}
+
+export async function run(db: Transaction, input: CreateInternalOrderInput, ctx: CommandContext) {
+  void ctx;
+
+  // Validate company exists and is ACTIVE
+  const company = await db
+    .selectFrom("Company" as never)
+    .where("id" as never, "=", input.companyId as never)
+    .selectAll()
+    .executeTakeFirst();
+
+  if (!company || (company as Record<string, unknown>).status !== "ACTIVE") {
+    return err(new CompanyNotFoundError(input.companyId));
+  }
+
+  // Validate unique order number within company
+  const existing = await db
+    .selectFrom("InternalOrder")
+    .where("companyId", "=", input.companyId)
+    .where("orderNumber", "=", input.orderNumber)
+    .selectAll()
+    .executeTakeFirst();
+
+  if (existing) {
+    return err(new DuplicateOrderNumberError(input.orderNumber));
+  }
+
+  // Validate order type
+  if (!VALID_ORDER_TYPES.includes(input.orderType)) {
+    return err(new InvalidOrderTypeError(input.orderType));
+  }
+
+  // Validate description
+  if (!input.description || input.description.trim() === "") {
+    return err(new DescriptionRequiredError(input.companyId));
+  }
+
+  // Validate responsible person
+  if (!input.responsiblePersonId) {
+    return err(new ResponsiblePersonRequiredError(input.companyId));
+  }
+
+  // Validate cost center exists in same company
+  const costCenter = await db
+    .selectFrom("CostCenter")
+    .where("id", "=", input.costCenterId)
+    .where("companyId", "=", input.companyId)
+    .selectAll()
+    .executeTakeFirst();
+
+  if (!costCenter) {
+    return err(new CostCenterNotFoundError(input.costCenterId));
+  }
+
+  // Validate validity dates
+  if (input.validFrom && input.validTo && input.validFrom > input.validTo) {
+    return err(new InvalidValidityPeriodError(input.companyId));
+  }
+
+  // Create internal order
+  const internalOrder = await db
+    .insertInto("InternalOrder")
+    .values({
+      companyId: input.companyId,
+      orderNumber: input.orderNumber,
+      orderType: input.orderType as "OVERHEAD" | "INVESTMENT" | "ACCRUAL",
+      description: input.description,
+      responsiblePersonId: input.responsiblePersonId,
+      costCenterId: input.costCenterId,
+      validFrom: input.validFrom ?? null,
+      validTo: input.validTo ?? null,
+      status: "CREATED",
+      createdAt: new Date(),
+      updatedAt: null,
+    })
+    .returningAll()
+    .executeTakeFirst();
+
+  return ok({ internalOrder: internalOrder! });
+}

package/src/modules/accounting/command/createPlanVersion.generated.ts

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

package/src/modules/accounting/command/createPlanVersion.test.ts

@@ -0,0 +1,230 @@
+import { describe, expect, it } from "vitest";
+import { createMockDb } from "../../../testing/index";
+import type { Transaction } from "../generated/kysely-tailordb";
+import {
+  CompanyNotFoundError,
+  InvalidNameError,
+  InvalidVersionTypeError,
+  BaseVersionNotFoundError,
+} from "../lib/errors.generated";
+import { baseCompany, basePlanVersion } from "../testing/fixtures";
+import { commandCtx, expectErr, expectOk } from "../testing/commandTestUtils";
+import { run } from "./createPlanVersion";
+
+describe("createPlanVersion", () => {
+  it("creates a plan version of type BUDGET", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseCompany);
+    spies.insert.mockReturnValueOnce(basePlanVersion);
+
+    const result = await run(
+      db,
+      {
+        companyId: baseCompany.id,
+        name: "FY2024 Budget",
+        type: "BUDGET",
+      },
+      commandCtx,
+    );
+
+    const value = expectOk(result);
+    expect(value.planVersion).toEqual(basePlanVersion);
+  });
+
+  it("creates a plan version of type FORECAST", async () => {
+    const forecastVersion = {
+      ...basePlanVersion,
+      id: "plan-version-forecast",
+      type: "FORECAST" as const,
+    };
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseCompany);
+    spies.insert.mockReturnValueOnce(forecastVersion);
+
+    const result = await run(
+      db,
+      {
+        companyId: baseCompany.id,
+        name: "FY2024 Forecast",
+        type: "FORECAST",
+      },
+      commandCtx,
+    );
+
+    const value = expectOk(result);
+    expect(value.planVersion.type).toBe("FORECAST");
+  });
+
+  it("creates a plan version of type SIMULATION", async () => {
+    const simulationVersion = {
+      ...basePlanVersion,
+      id: "plan-version-sim",
+      type: "SIMULATION" as const,
+    };
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseCompany);
+    spies.insert.mockReturnValueOnce(simulationVersion);
+
+    const result = await run(
+      db,
+      {
+        companyId: baseCompany.id,
+        name: "FY2024 Simulation",
+        type: "SIMULATION",
+      },
+      commandCtx,
+    );
+
+    const value = expectOk(result);
+    expect(value.planVersion.type).toBe("SIMULATION");
+  });
+
+  it("creates a plan version with a base version reference", async () => {
+    const versionWithBase = {
+      ...basePlanVersion,
+      id: "plan-version-with-base",
+      baseVersionId: basePlanVersion.id,
+    };
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseCompany).mockReturnValueOnce(basePlanVersion); // base version lookup
+    spies.insert.mockReturnValueOnce(versionWithBase);
+
+    const result = await run(
+      db,
+      {
+        companyId: baseCompany.id,
+        name: "FY2024 Budget v2",
+        type: "BUDGET",
+        baseVersionId: basePlanVersion.id,
+      },
+      commandCtx,
+    );
+
+    const value = expectOk(result);
+    expect(value.planVersion.baseVersionId).toBe(basePlanVersion.id);
+  });
+
+  it("creates a plan version without a base version reference", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseCompany);
+    spies.insert.mockReturnValueOnce(basePlanVersion);
+
+    const result = await run(
+      db,
+      {
+        companyId: baseCompany.id,
+        name: "FY2024 Budget",
+        type: "BUDGET",
+      },
+      commandCtx,
+    );
+
+    const value = expectOk(result);
+    expect(value.planVersion.baseVersionId).toBeNull();
+  });
+
+  it("returns error when company does not exist", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(undefined);
+
+    const result = await run(
+      db,
+      {
+        companyId: "missing-company",
+        name: "FY2024 Budget",
+        type: "BUDGET",
+      },
+      commandCtx,
+    );
+
+    expectErr(result, CompanyNotFoundError);
+  });
+
+  it("returns error when company is not ACTIVE", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce({ ...baseCompany, status: "INACTIVE" });
+
+    const result = await run(
+      db,
+      {
+        companyId: baseCompany.id,
+        name: "FY2024 Budget",
+        type: "BUDGET",
+      },
+      commandCtx,
+    );
+
+    expectErr(result, CompanyNotFoundError);
+  });
+
+  it("returns error when version type is invalid", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseCompany);
+
+    const result = await run(
+      db,
+      {
+        companyId: baseCompany.id,
+        name: "FY2024 Budget",
+        type: "INVALID_TYPE",
+      },
+      commandCtx,
+    );
+
+    expectErr(result, InvalidVersionTypeError);
+  });
+
+  it("returns error when name is missing", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseCompany);
+
+    const result = await run(
+      db,
+      {
+        companyId: baseCompany.id,
+        name: "",
+        type: "BUDGET",
+      },
+      commandCtx,
+    );
+
+    expectErr(result, InvalidNameError);
+  });
+
+  it("returns error when base version does not exist", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseCompany).mockReturnValueOnce(undefined); // base version not found
+
+    const result = await run(
+      db,
+      {
+        companyId: baseCompany.id,
+        name: "FY2024 Budget v2",
+        type: "BUDGET",
+        baseVersionId: "missing-version",
+      },
+      commandCtx,
+    );
+
+    expectErr(result, BaseVersionNotFoundError);
+  });
+
+  it("emits audit event recording acting user, timestamp, and initial field values", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseCompany);
+    spies.insert.mockReturnValueOnce(basePlanVersion);
+
+    const result = await run(
+      db,
+      {
+        companyId: baseCompany.id,
+        name: "FY2024 Budget",
+        type: "BUDGET",
+      },
+      commandCtx,
+    );
+
+    expectOk(result);
+    expect(spies.insert).toHaveBeenCalled();
+  });
+});

package/src/modules/accounting/command/createPlanVersion.ts

@@ -0,0 +1,71 @@
+import type { Transaction } from "../generated/kysely-tailordb";
+import {
+  CompanyNotFoundError,
+  InvalidNameError,
+  InvalidVersionTypeError,
+  BaseVersionNotFoundError,
+} from "../lib/errors.generated";
+import { err, ok, type CommandContext } from "@tailor-platform/erp-kit/module";
+
+const VALID_VERSION_TYPES = ["BUDGET", "FORECAST", "SIMULATION"] as const;
+
+export interface CreatePlanVersionInput {
+  companyId: string;
+  name: string;
+  type: string;
+  baseVersionId?: string | null;
+}
+
+export async function run(db: Transaction, input: CreatePlanVersionInput, ctx: CommandContext) {
+  void ctx;
+
+  // Validate company exists and is ACTIVE
+  const company = await db
+    .selectFrom("Company" as never)
+    .where("id" as never, "=", input.companyId as never)
+    .selectAll()
+    .executeTakeFirst();
+
+  if (!company || (company as Record<string, unknown>).status !== "ACTIVE") {
+    return err(new CompanyNotFoundError(input.companyId));
+  }
+
+  // Validate version type
+  if (!VALID_VERSION_TYPES.includes(input.type as (typeof VALID_VERSION_TYPES)[number])) {
+    return err(new InvalidVersionTypeError(input.type));
+  }
+
+  // Validate name is non-empty
+  if (!input.name || input.name.trim() === "") {
+    return err(new InvalidNameError(input.companyId));
+  }
+
+  // Validate base version if provided
+  if (input.baseVersionId) {
+    const baseVersion = await db
+      .selectFrom("PlanVersion")
+      .where("id", "=", input.baseVersionId)
+      .selectAll()
+      .executeTakeFirst();
+
+    if (!baseVersion) {
+      return err(new BaseVersionNotFoundError(input.baseVersionId));
+    }
+  }
+
+  // Create plan version
+  const planVersion = await db
+    .insertInto("PlanVersion")
+    .values({
+      companyId: input.companyId,
+      name: input.name,
+      type: input.type as "BUDGET" | "FORECAST" | "SIMULATION",
+      baseVersionId: input.baseVersionId ?? null,
+      createdAt: new Date(),
+      updatedAt: null,
+    })
+    .returningAll()
+    .executeTakeFirst();
+
+  return ok({ planVersion: planVersion! });
+}

package/src/modules/accounting/command/createProfitCenter.generated.ts

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

package/src/modules/accounting/command/createProfitCenter.test.ts

@@ -0,0 +1,227 @@
+import { describe, expect, it } from "vitest";
+import { createMockDb } from "../../../testing/index";
+import type { Transaction } from "../generated/kysely-tailordb";
+import {
+  CompanyNotFoundError,
+  DuplicateProfitCenterCodeError,
+  InvalidNameError,
+  ValidFromRequiredError,
+  InvalidValidityPeriodError,
+} from "../lib/errors.generated";
+import { baseCompany, baseProfitCenter } from "../testing/fixtures";
+import { commandCtx, expectErr, expectOk } from "../testing/commandTestUtils";
+import { run } from "./createProfitCenter";
+
+describe("createProfitCenter", () => {
+  it("creates profit center in DRAFT status with required fields", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseCompany).mockReturnValueOnce(undefined);
+    spies.insert.mockReturnValueOnce(baseProfitCenter);
+
+    const result = await run(
+      db,
+      {
+        companyId: baseCompany.id,
+        code: "PC-001",
+        name: "Product Line Alpha",
+        validFrom: new Date("2024-01-01"),
+      },
+      commandCtx,
+    );
+
+    const value = expectOk(result);
+    expect(value.profitCenter).toEqual(baseProfitCenter);
+  });
+
+  it("returns error when company does not exist", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(undefined);
+
+    const result = await run(
+      db,
+      {
+        companyId: "missing-company",
+        code: "PC-001",
+        name: "Test",
+        validFrom: new Date("2024-01-01"),
+      },
+      commandCtx,
+    );
+
+    expectErr(result, CompanyNotFoundError);
+  });
+
+  it("returns error when company is not ACTIVE", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce({ ...baseCompany, status: "INACTIVE" });
+
+    const result = await run(
+      db,
+      {
+        companyId: baseCompany.id,
+        code: "PC-001",
+        name: "Test",
+        validFrom: new Date("2024-01-01"),
+      },
+      commandCtx,
+    );
+
+    expectErr(result, CompanyNotFoundError);
+  });
+
+  it("returns error when code already exists within the company", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseCompany).mockReturnValueOnce(baseProfitCenter);
+
+    const result = await run(
+      db,
+      {
+        companyId: baseCompany.id,
+        code: "PC-001",
+        name: "Test",
+        validFrom: new Date("2024-01-01"),
+      },
+      commandCtx,
+    );
+
+    expectErr(result, DuplicateProfitCenterCodeError);
+  });
+
+  it("returns error when name is missing", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseCompany).mockReturnValueOnce(undefined);
+
+    const result = await run(
+      db,
+      {
+        companyId: baseCompany.id,
+        code: "PC-002",
+        name: "",
+        validFrom: new Date("2024-01-01"),
+      },
+      commandCtx,
+    );
+
+    expectErr(result, InvalidNameError);
+  });
+
+  it("returns error when validFrom is not provided", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseCompany).mockReturnValueOnce(undefined);
+
+    const result = await run(
+      db,
+      {
+        companyId: baseCompany.id,
+        code: "PC-002",
+        name: "Test",
+        validFrom: null,
+      },
+      commandCtx,
+    );
+
+    expectErr(result, ValidFromRequiredError);
+  });
+
+  it("returns error when validTo is before validFrom", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseCompany).mockReturnValueOnce(undefined);
+
+    const result = await run(
+      db,
+      {
+        companyId: baseCompany.id,
+        code: "PC-002",
+        name: "Test",
+        validFrom: new Date("2024-06-01"),
+        validTo: new Date("2024-01-01"),
+      },
+      commandCtx,
+    );
+
+    expectErr(result, InvalidValidityPeriodError);
+  });
+
+  it("creates profit center with optional description", async () => {
+    const pcWithDesc = { ...baseProfitCenter, description: "A description" };
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseCompany).mockReturnValueOnce(undefined);
+    spies.insert.mockReturnValueOnce(pcWithDesc);
+
+    const result = await run(
+      db,
+      {
+        companyId: baseCompany.id,
+        code: "PC-001",
+        name: "Product Line Alpha",
+        description: "A description",
+        validFrom: new Date("2024-01-01"),
+      },
+      commandCtx,
+    );
+
+    const value = expectOk(result);
+    expect(value.profitCenter.description).toBe("A description");
+  });
+
+  it("creates profit center without validTo", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseCompany).mockReturnValueOnce(undefined);
+    spies.insert.mockReturnValueOnce(baseProfitCenter);
+
+    const result = await run(
+      db,
+      {
+        companyId: baseCompany.id,
+        code: "PC-001",
+        name: "Product Line Alpha",
+        validFrom: new Date("2024-01-01"),
+      },
+      commandCtx,
+    );
+
+    expectOk(result);
+  });
+
+  it("profit centers from different companies are isolated", async () => {
+    const companyB = { id: "company-2", status: "ACTIVE" };
+    const pcCompanyB = { ...baseProfitCenter, id: "pc-b", companyId: companyB.id };
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(companyB).mockReturnValueOnce(undefined);
+    spies.insert.mockReturnValueOnce(pcCompanyB);
+
+    const result = await run(
+      db,
+      {
+        companyId: companyB.id,
+        code: "PC-001",
+        name: "Product Line Alpha",
+        validFrom: new Date("2024-01-01"),
+      },
+      commandCtx,
+    );
+
+    const value = expectOk(result);
+    expect(value.profitCenter.companyId).toBe(companyB.id);
+  });
+
+  it("emits audit event recording acting user, timestamp, and initial field values", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    spies.select.mockReturnValueOnce(baseCompany).mockReturnValueOnce(undefined);
+    spies.insert.mockReturnValueOnce(baseProfitCenter);
+
+    const result = await run(
+      db,
+      {
+        companyId: baseCompany.id,
+        code: "PC-001",
+        name: "Product Line Alpha",
+        validFrom: new Date("2024-01-01"),
+      },
+      commandCtx,
+    );
+
+    expectOk(result);
+    expect(spies.insert).toHaveBeenCalled();
+  });
+});