@tailor-platform/erp-kit 0.3.0 → 0.4.0

package/src/modules/organization/query/listDepartmentsByCompany.ts

@@ -0,0 +1,43 @@
+import {
+  ok,
+  type ReadonlyDB,
+  type PaginationInput,
+  buildPaginatedResult,
+  DEFAULT_PAGE_SIZE,
+} from "../../../shared";
+import type { DB } from "../generated/kysely-tailordb";
+
+type DepartmentOrderByField = "name" | "code" | "createdAt";
+
+export interface ListDepartmentsByCompanyInput extends PaginationInput<DepartmentOrderByField> {
+  companyId: string;
+  status?: string;
+  parentDepartmentId?: string | null;
+}
+
+export async function run(db: ReadonlyDB<DB>, input: ListDepartmentsByCompanyInput) {
+  const limit = input.limit ?? DEFAULT_PAGE_SIZE;
+  const offset = input.offset ?? 0;
+  const orderBy = input.orderBy ?? "name";
+  const orderDirection = input.orderDirection ?? "asc";
+
+  let query = db.selectFrom("Department").selectAll().where("companyId", "=", input.companyId);
+
+  if (input.status !== undefined) {
+    query = query.where("status", "=", input.status);
+  }
+
+  if (input.parentDepartmentId === null) {
+    query = query.where("parentDepartmentId", "is", null);
+  } else if (input.parentDepartmentId !== undefined) {
+    query = query.where("parentDepartmentId", "=", input.parentDepartmentId);
+  }
+
+  const departments = await query
+    .orderBy(orderBy, orderDirection)
+    .limit(limit + 1)
+    .offset(offset)
+    .execute();
+
+  return ok(buildPaginatedResult(departments, limit));
+}

package/src/modules/organization/query/listSitesByCompany.generated.ts

@@ -0,0 +1,5 @@
+// @generated — do not edit
+import { defineQuery } from "../../../shared";
+import { run } from "./listSitesByCompany";
+
+export const listSitesByCompany = defineQuery(run);

package/src/modules/organization/query/listSitesByCompany.test.ts

@@ -0,0 +1,126 @@
+import { describe, expect, it } from "vitest";
+import { createMockDb } from "../../../testing/index";
+import type { DB } from "../generated/kysely-tailordb";
+import { activeSite, inactiveSite } from "../testing/fixtures";
+import { run } from "./listSitesByCompany";
+
+describe("listSitesByCompany", () => {
+  it("returns sites for a company", async () => {
+    const { db, spies } = createMockDb<DB>();
+    spies.select.mockReturnValue([activeSite, inactiveSite]);
+
+    const result = await run(db, { companyId: "company-2" });
+
+    expect(result.ok).toBe(true);
+    if (result.ok) {
+      expect(result.value.items).toHaveLength(2);
+    }
+  });
+
+  it("returns empty list when no sites exist", async () => {
+    const { db, spies } = createMockDb<DB>();
+    spies.select.mockReturnValue([]);
+
+    const result = await run(db, { companyId: "company-999" });
+
+    expect(result.ok).toBe(true);
+    if (result.ok) {
+      expect(result.value.items).toHaveLength(0);
+      expect(result.value.hasNextPage).toBe(false);
+    }
+  });
+
+  it("filters by status when provided", async () => {
+    const { db, spies } = createMockDb<DB>();
+    spies.select.mockReturnValue([activeSite]);
+
+    const result = await run(db, { companyId: "company-2", status: "ACTIVE" });
+
+    expect(result.ok).toBe(true);
+    if (result.ok) {
+      expect(result.value.items).toHaveLength(1);
+    }
+  });
+
+  it("filters by type when provided", async () => {
+    const { db, spies } = createMockDb<DB>();
+    spies.select.mockReturnValue([inactiveSite]);
+
+    const result = await run(db, { companyId: "company-2", type: "WAREHOUSE" });
+
+    expect(result.ok).toBe(true);
+    if (result.ok) {
+      expect(result.value.items).toHaveLength(1);
+    }
+  });
+
+  it("filters sites by INACTIVE status", async () => {
+    const { db, spies } = createMockDb<DB>();
+    spies.select.mockReturnValue([inactiveSite]);
+
+    const result = await run(db, { companyId: "company-2", status: "INACTIVE" });
+
+    expect(result.ok).toBe(true);
+    if (result.ok) {
+      expect(result.value.items).toHaveLength(1);
+      expect(result.value.items[0].status).toBe("INACTIVE");
+    }
+  });
+
+  it("combines status and type filters", async () => {
+    const { db, spies } = createMockDb<DB>();
+    spies.select.mockReturnValue([inactiveSite]);
+
+    const result = await run(db, { companyId: "company-2", status: "INACTIVE", type: "WAREHOUSE" });
+
+    expect(result.ok).toBe(true);
+    if (result.ok) {
+      expect(result.value.items).toHaveLength(1);
+      expect(result.value.items[0].status).toBe("INACTIVE");
+      expect(result.value.items[0].type).toBe("WAREHOUSE");
+    }
+  });
+
+  it("returns sites ordered by name", async () => {
+    const { db, spies } = createMockDb<DB>();
+    spies.select.mockReturnValue([activeSite, inactiveSite]);
+
+    const result = await run(db, {
+      companyId: "company-2",
+      orderBy: "name",
+      orderDirection: "asc",
+    });
+
+    expect(result.ok).toBe(true);
+    if (result.ok) {
+      expect(result.value.items).toHaveLength(2);
+    }
+  });
+
+  it("returns hasNextPage true when more results exist", async () => {
+    const { db, spies } = createMockDb<DB>();
+    // Simulate limit+1 strategy: 2 rows returned for limit=1 means hasNextPage=true
+    spies.select.mockReturnValue([activeSite, inactiveSite]);
+
+    const result = await run(db, { companyId: "company-2", limit: 1 });
+
+    expect(result.ok).toBe(true);
+    if (result.ok) {
+      expect(result.value.items).toHaveLength(1);
+      expect(result.value.hasNextPage).toBe(true);
+    }
+  });
+
+  it("respects limit parameter", async () => {
+    const { db, spies } = createMockDb<DB>();
+    spies.select.mockReturnValue([activeSite]);
+
+    const result = await run(db, { companyId: "company-2", limit: 5 });
+
+    expect(result.ok).toBe(true);
+    if (result.ok) {
+      expect(result.value.items).toHaveLength(1);
+      expect(result.value.hasNextPage).toBe(false);
+    }
+  });
+});

package/src/modules/organization/query/listSitesByCompany.ts

@@ -0,0 +1,41 @@
+import {
+  ok,
+  type ReadonlyDB,
+  type PaginationInput,
+  buildPaginatedResult,
+  DEFAULT_PAGE_SIZE,
+} from "../../../shared";
+import type { DB } from "../generated/kysely-tailordb";
+
+type SiteOrderByField = "name" | "type" | "createdAt";
+
+export interface ListSitesByCompanyInput extends PaginationInput<SiteOrderByField> {
+  companyId: string;
+  status?: string;
+  type?: string;
+}
+
+export async function run(db: ReadonlyDB<DB>, input: ListSitesByCompanyInput) {
+  const limit = input.limit ?? DEFAULT_PAGE_SIZE;
+  const offset = input.offset ?? 0;
+  const orderBy = input.orderBy ?? "name";
+  const orderDirection = input.orderDirection ?? "asc";
+
+  let query = db.selectFrom("Site").selectAll().where("companyId", "=", input.companyId);
+
+  if (input.status !== undefined) {
+    query = query.where("status", "=", input.status);
+  }
+
+  if (input.type !== undefined) {
+    query = query.where("type", "=", input.type);
+  }
+
+  const sites = await query
+    .orderBy(orderBy, orderDirection)
+    .limit(limit + 1)
+    .offset(offset)
+    .execute();
+
+  return ok(buildPaginatedResult(sites, limit));
+}

package/src/modules/organization/tailor.config.ts

@@ -0,0 +1,13 @@
+import { defineConfig, definePlugins } from "@tailor-platform/sdk";
+import { kyselyTypePlugin } from "@tailor-platform/sdk/plugin/kysely-type";
+import { enumConstantsPlugin } from "@tailor-platform/sdk/plugin/enum-constants";
+
+export default defineConfig({
+  name: "organization",
+  db: { "main-db": { files: [`./db/*.ts`, `./lib/_db_deps.ts`] } },
+});
+
+export const plugins = definePlugins(
+  kyselyTypePlugin({ distPath: `./generated/kysely-tailordb.ts` }),
+  enumConstantsPlugin({ distPath: "./generated/enums.ts" }),
+);

package/src/modules/organization/tailor.d.ts

@@ -0,0 +1,13 @@
+// This file is auto-generated by @tailor-platform/sdk
+// Do not edit this file manually
+// Regenerated automatically when running 'tailor-sdk apply' or 'tailor-sdk generate'
+
+declare module "@tailor-platform/sdk" {
+  interface AttributeMap {}
+  interface AttributeList {
+    __tuple?: [];
+  }
+  interface Env {}
+}
+
+export {};

package/src/modules/organization/testing/fixtures.ts

@@ -0,0 +1,155 @@
+import type { Company, Department, Schema, Site } from "../lib/types";
+
+// Company fixtures
+export const draftCompany = {
+  id: "company-1",
+  legalName: "Acme Corp",
+  taxId: "TAX-12345",
+  registrationNumber: "REG-67890",
+  baseCurrencyId: "currency-usd",
+  street: "123 Main St",
+  city: "Tokyo",
+  state: "Tokyo",
+  postalCode: "100-0001",
+  country: "JP",
+  status: "DRAFT",
+  createdAt: new Date("2024-01-01T00:00:00.000Z"),
+  updatedAt: null,
+} as const satisfies Company<Schema>;
+
+export const activeCompany = {
+  id: "company-2",
+  legalName: "Beta Ltd",
+  taxId: "TAX-99999",
+  registrationNumber: "REG-88888",
+  baseCurrencyId: "currency-usd",
+  street: "456 Business Ave",
+  city: "Osaka",
+  state: "Osaka",
+  postalCode: "530-0001",
+  country: "JP",
+  status: "ACTIVE",
+  createdAt: new Date("2024-01-01T00:00:00.000Z"),
+  updatedAt: null,
+} as const satisfies Company<Schema>;
+
+export const inactiveCompany = {
+  id: "company-3",
+  legalName: "Gamma Inc",
+  taxId: "TAX-77777",
+  registrationNumber: "REG-66666",
+  baseCurrencyId: "currency-usd",
+  street: "789 Closed Rd",
+  city: "Nagoya",
+  state: "Aichi",
+  postalCode: "460-0001",
+  country: "JP",
+  status: "INACTIVE",
+  createdAt: new Date("2024-01-01T00:00:00.000Z"),
+  updatedAt: null,
+} as const satisfies Company<Schema>;
+
+export const draftCompanyNoCurrency = {
+  id: "company-4",
+  legalName: "Delta Corp",
+  taxId: null,
+  registrationNumber: null,
+  baseCurrencyId: null,
+  street: null,
+  city: null,
+  state: null,
+  postalCode: null,
+  country: null,
+  status: "DRAFT",
+  createdAt: new Date("2024-01-01T00:00:00.000Z"),
+  updatedAt: null,
+} as const satisfies Company<Schema>;
+
+// Site fixtures
+export const activeSite = {
+  id: "site-1",
+  name: "Tokyo HQ",
+  type: "OFFICE",
+  companyId: "company-2",
+  street: "123 Office St",
+  city: "Tokyo",
+  state: "Tokyo",
+  postalCode: "100-0001",
+  country: "JP",
+  timezone: "Asia/Tokyo",
+  status: "ACTIVE",
+  createdAt: new Date("2024-01-01T00:00:00.000Z"),
+  updatedAt: null,
+} as const satisfies Site<Schema>;
+
+export const inactiveSite = {
+  id: "site-2",
+  name: "Osaka Warehouse",
+  type: "WAREHOUSE",
+  companyId: "company-2",
+  street: "456 Warehouse Rd",
+  city: "Osaka",
+  state: "Osaka",
+  postalCode: "530-0001",
+  country: "JP",
+  timezone: "Asia/Tokyo",
+  status: "INACTIVE",
+  createdAt: new Date("2024-01-01T00:00:00.000Z"),
+  updatedAt: null,
+} as const satisfies Site<Schema>;
+
+// Department fixtures
+export const activeDepartment = {
+  id: "dept-1",
+  code: "ENG",
+  name: "Engineering",
+  companyId: "company-2",
+  parentDepartmentId: null,
+  status: "ACTIVE",
+  createdAt: new Date("2024-01-01T00:00:00.000Z"),
+  updatedAt: null,
+} as const satisfies Department<Schema>;
+
+export const childDepartment = {
+  id: "dept-2",
+  code: "ENG-BE",
+  name: "Backend Engineering",
+  companyId: "company-2",
+  parentDepartmentId: "dept-1",
+  status: "ACTIVE",
+  createdAt: new Date("2024-01-01T00:00:00.000Z"),
+  updatedAt: null,
+} as const satisfies Department<Schema>;
+
+export const grandchildDepartment = {
+  id: "dept-3",
+  code: "ENG-BE-PLAT",
+  name: "Platform Team",
+  companyId: "company-2",
+  parentDepartmentId: "dept-2",
+  status: "ACTIVE",
+  createdAt: new Date("2024-01-01T00:00:00.000Z"),
+  updatedAt: null,
+} as const satisfies Department<Schema>;
+
+export const inactiveDepartment = {
+  id: "dept-4",
+  code: "FIN",
+  name: "Finance",
+  companyId: "company-2",
+  parentDepartmentId: null,
+  status: "INACTIVE",
+  createdAt: new Date("2024-01-01T00:00:00.000Z"),
+  updatedAt: null,
+} as const satisfies Department<Schema>;
+
+export const otherCompanyDepartment = {
+  id: "dept-5",
+  code: "ENG",
+  name: "Engineering",
+  companyId: "company-3",
+  parentDepartmentId: null,
+  status: "ACTIVE",
+  createdAt: new Date("2024-01-01T00:00:00.000Z"),
+  updatedAt: null,
+} as const satisfies Department<Schema>;

package/src/modules/primitives/README.md

@@ -13,7 +13,7 @@ This module combines related configuration primitives to simplify dependency man
 - **Quantity Conversion**: Convert quantities between any two units within the same category using automatic factor calculation
 - **Rounding Precision**: Configure decimal precision per unit to ensure appropriate rounding for business operations
 - **Currency Definitions**: Define currencies with ISO 4217 codes, symbols, and decimal precision
-- **Base Currency**: Designate a company base currency for reporting and consolidation
+- **Base Currency**: Provide the currency catalog that companies reference for base currency assignment (company→currency mapping is owned by the organization module)
 - **Exchange Rates**: Maintain date-based exchange rates between currency pairs
 - **Amount Conversion**: Convert monetary amounts between currencies using applicable rates
 

package/src/modules/primitives/command/setBaseCurrency.test.ts

@@ -1,83 +1,27 @@
 import { describe, expect, it } from "vitest";
 import { createMockDb } from "../../../testing/index";
 import { Transaction } from "../generated/kysely-tailordb";
-import {
-  CannotSetInactiveAsBaseCurrencyError,
-  CurrencyNotFoundError,
-} from "../lib/errors.generated";
-import { baseCurrencyEUR, baseCurrencyUSD, inactiveCurrency } from "../testing/fixtures";
+import { SetBaseCurrencyDeprecatedError } from "../lib/errors.generated";
 import { run } from "./setBaseCurrency";
 
 describe("setBaseCurrency", () => {
-  // Error cases
-  it("throws when currency doesn't exist", async () => {
-    const { db, spies } = createMockDb<Transaction>();
-    spies.select.mockReturnValue(undefined);
-
-    const result = await run(db, {
-      currencyId: "nonexistent-currency",
-    });
-
-    expect(result.ok).toBe(false);
-    if (!result.ok) {
-      expect(result.error).toBeInstanceOf(CurrencyNotFoundError);
-    }
-  });
-
-  it("throws when currency is inactive", async () => {
-    const { db, spies } = createMockDb<Transaction>();
-    spies.select.mockReturnValue(inactiveCurrency);
+  it("Calling SetBaseCurrency returns a deprecation error directing the caller to the organization module", async () => {
+    const { db } = createMockDb<Transaction>();
 
-    const result = await run(db, {
-      currencyId: inactiveCurrency.id,
-    });
+    const result = await run(db, { currencyId: "any-currency-id" });
 
     expect(result.ok).toBe(false);
     if (!result.ok) {
-      expect(result.error).toBeInstanceOf(CannotSetInactiveAsBaseCurrencyError);
+      expect(result.error).toBeInstanceOf(SetBaseCurrencyDeprecatedError);
     }
   });
 
-  // Idempotent cases
-  it("returns currency unchanged when already base", async () => {
+  it("No currency is modified when SetBaseCurrency is invoked", async () => {
     const { db, spies } = createMockDb<Transaction>();
-    spies.select.mockReturnValue(baseCurrencyUSD); // Already base currency
 
-    const result = await run(db, {
-      currencyId: baseCurrencyUSD.id,
-    });
+    await run(db, { currencyId: "any-currency-id" });
 
-    expect(result.ok).toBe(true);
-    if (result.ok) {
-      expect(result.value.currency).toEqual(baseCurrencyUSD);
-    }
+    expect(spies.select).not.toHaveBeenCalled();
     expect(spies.update).not.toHaveBeenCalled();
   });
-
-  // Success cases
-  it("changes base currency", async () => {
-    const { db, spies } = createMockDb<Transaction>();
-    const newBaseCurrency = {
-      ...baseCurrencyEUR,
-      isBaseCurrency: true,
-      updatedAt: new Date("2024-01-15T00:00:00.000Z"),
-    };
-
-    spies.select
-      .mockReturnValueOnce(baseCurrencyEUR) // Target currency lookup
-      .mockReturnValueOnce(baseCurrencyUSD); // Current base currency lookup
-    spies.update
-      .mockReturnValueOnce({ ...baseCurrencyUSD, isBaseCurrency: false }) // Remove base from old
-      .mockReturnValueOnce(newBaseCurrency); // Set base on new
-
-    const result = await run(db, {
-      currencyId: baseCurrencyEUR.id,
-    });
-
-    expect(result.ok).toBe(true);
-    if (result.ok) {
-      expect(result.value.currency.isBaseCurrency).toBe(true);
-    }
-    expect(spies.update).toHaveBeenCalled();
-  });
 });

package/src/modules/primitives/command/setBaseCurrency.ts

@@ -1,9 +1,6 @@
-import { ok, err } from "../../../shared";
+import { err } from "../../../shared";
 import { Transaction } from "../generated/kysely-tailordb";
-import {
-  CannotSetInactiveAsBaseCurrencyError,
-  CurrencyNotFoundError,
-} from "../lib/errors.generated";
+import { SetBaseCurrencyDeprecatedError } from "../lib/errors.generated";
 
 export interface SetBaseCurrencyInput {
   currencyId: string;
@@ -12,64 +9,9 @@ export interface SetBaseCurrencyInput {
 /**
  * Function: setBaseCurrency
  *
- * Changes the organization's base currency to a different active currency.
- * The base currency serves as the default for financial reporting.
+ * @deprecated Base currency assignment is per company and owned by the organization module.
+ * Use the organization module's company-level base currency assignment instead.
  */
-export async function run(db: Transaction, input: SetBaseCurrencyInput) {
-  // 1. Find currency by ID
-  const currency = await db
-    .selectFrom("Currency")
-    .selectAll()
-    .where("id", "=", input.currencyId)
-    .forUpdate()
-    .executeTakeFirst();
-
-  // 2. If not found, throw error
-  if (!currency) {
-    return err(new CurrencyNotFoundError(input.currencyId));
-  }
-
-  // 3. Check if currency is active
-  if (!currency.isActive) {
-    return err(new CannotSetInactiveAsBaseCurrencyError(input.currencyId));
-  }
-
-  // 4. If already base currency, return (idempotent)
-  if (currency.isBaseCurrency) {
-    return ok({ currency });
-  }
-
-  // 5. Find current base currency
-  const currentBase = await db
-    .selectFrom("Currency")
-    .selectAll()
-    .where("isBaseCurrency", "=", true)
-    .forUpdate()
-    .executeTakeFirst();
-
-  // 6. Remove base flag from current base
-  if (currentBase) {
-    await db
-      .updateTable("Currency")
-      .set({
-        isBaseCurrency: false,
-        updatedAt: new Date(),
-      })
-      .where("id", "=", currentBase.id)
-      .returningAll()
-      .executeTakeFirst();
-  }
-
-  // 7. Set base flag on target currency
-  const updatedCurrency = await db
-    .updateTable("Currency")
-    .set({
-      isBaseCurrency: true,
-      updatedAt: new Date(),
-    })
-    .where("id", "=", input.currencyId)
-    .returningAll()
-    .executeTakeFirst();
-
-  return ok({ currency: updatedCurrency! });
+export function run(_db: Transaction, _input: SetBaseCurrencyInput) {
+  return Promise.resolve(err(new SetBaseCurrencyDeprecatedError("")));
 }

package/src/modules/primitives/docs/commands/ActivateCategory.md

@@ -34,6 +34,6 @@ flowchart TD
 
 ## Test Cases
 
-- throws when category doesn
+- throws when category doesn't exist
 - returns category unchanged when already active
 - activates inactive category

package/src/modules/primitives/docs/commands/ActivateCurrency.md

@@ -33,6 +33,6 @@ flowchart TD
 
 ## Test Cases
 
-- throws when currency doesn
+- throws when currency doesn't exist
 - returns currency unchanged when already active
 - activates inactive currency

package/src/modules/primitives/docs/commands/ActivateUnit.md

@@ -34,6 +34,6 @@ flowchart TD
 
 ## Test Cases
 
-- throws when unit doesn
+- throws when unit doesn't exist
 - returns unit unchanged when already active
 - activates inactive unit

package/src/modules/primitives/docs/commands/CreateExchangeRate.md

@@ -48,9 +48,9 @@ flowchart TD
 
 ## Test Cases
 
-- throws when source currency doesn
+- throws when source currency doesn't exist
 - throws when source currency is inactive
-- throws when target currency doesn
+- throws when target currency doesn't exist
 - throws when target currency is inactive
 - throws when source and target are the same
 - throws when rate is not positive

package/src/modules/primitives/docs/commands/CreateUnit.md

@@ -49,7 +49,7 @@ flowchart TD
 
 ## Test Cases
 
-- throws when category doesn
+- throws when category doesn't exist
 - throws when category is inactive
 - throws when symbol already exists in category
 - throws when conversion factor is not positive

package/src/modules/primitives/docs/commands/DeactivateCategory.md

@@ -38,7 +38,7 @@ flowchart TD
 
 ## Test Cases
 
-- throws when category doesn
+- throws when category doesn't exist
 - throws when category has active units
 - returns category unchanged when already inactive
 - deactivates active category with no active units

package/src/modules/primitives/docs/commands/DeactivateCurrency.md

@@ -38,7 +38,7 @@ flowchart TD
 
 ## Test Cases
 
-- throws when currency doesn
+- throws when currency doesn't exist
 - throws when attempting to deactivate base currency
 - returns currency unchanged when already inactive
 - deactivates active non-base currency

package/src/modules/primitives/docs/commands/DeactivateUnit.md

@@ -38,7 +38,7 @@ flowchart TD
 
 ## Test Cases
 
-- throws when unit doesn
+- throws when unit doesn't exist
 - throws when attempting to deactivate reference unit
 - returns unit unchanged when already inactive
 - deactivates active non-reference unit