@tailor-platform/erp-kit 0.6.0 → 0.8.0

package/src/modules/business-partner/command/updatePartner.ts

@@ -10,12 +10,11 @@ import { ok, err, type CommandContext } from "@tailor-platform/erp-kit/module";
 type PrimitivesModule = ReturnType<typeof definePrimitivesModule>;
 type PrimitivesQueries = PrimitivesModule["queries"];
 
-export interface UpdatePartnerInput {
+export type UpdatePartnerInput = {
   id: string;
   name?: string;
   preferredCurrencyId?: string;
-}
-
+};
 /**
  * Function: updatePartner
  *
@@ -24,11 +23,19 @@ export interface UpdatePartnerInput {
  */
 export async function run<CF extends Record<string, unknown>>(
   db: Transaction,
-  input: UpdatePartnerInput & Partial<CF>,
+  input: UpdatePartnerInput & Omit<Partial<CF>, "status">,
   ctx: CommandContext,
   primitivesQueries?: Pick<PrimitivesQueries, "getCurrency">,
 ) {
-  const { id, name, preferredCurrencyId, ...customFields } = input;
+  const { id, name, preferredCurrencyId } = input;
+
+  const KNOWN_KEYS = new Set(["id", "name", "preferredCurrencyId"]);
+  const customFields: Record<string, unknown> = {};
+  for (const [key, value] of Object.entries(input as Record<string, unknown>)) {
+    if (!KNOWN_KEYS.has(key)) {
+      customFields[key] = value;
+    }
+  }
 
   // 1. Check partner exists
   const partner = await db
@@ -59,7 +66,7 @@ export async function run<CF extends Record<string, unknown>>(
 
   // 4. Apply updates
   const updates: Record<string, unknown> = {
-    ...(customFields as Record<string, unknown>),
+    ...customFields,
     updatedAt: new Date(),
   };
   if (name !== undefined) updates.name = name;

package/src/modules/business-partner/command/updatePartnerAddress.ts

@@ -2,7 +2,7 @@ import type { Transaction } from "../generated/kysely-tailordb";
 import { AddressNotFoundError, InvalidCountryCodeError } from "../lib/errors.generated";
 import { ok, err } from "@tailor-platform/erp-kit/module";
 
-export interface UpdatePartnerAddressInput {
+export type UpdatePartnerAddressInput = {
   id: string;
   line1?: string;
   line2?: string | null;
@@ -10,8 +10,7 @@ export interface UpdatePartnerAddressInput {
   state?: string | null;
   postalCode?: string;
   country?: string;
-}
-
+};
 /**
  * Function: updatePartnerAddress
  *
@@ -20,9 +19,17 @@ export interface UpdatePartnerAddressInput {
  */
 export async function run<CF extends Record<string, unknown>>(
   db: Transaction,
-  input: UpdatePartnerAddressInput & Partial<CF>,
+  input: UpdatePartnerAddressInput & Omit<Partial<CF>, "status">,
 ) {
-  const { id, line1, line2, city, state, postalCode, country, ...customFields } = input;
+  const { id, line1, line2, city, state, postalCode, country } = input;
+
+  const KNOWN_KEYS = new Set(["id", "line1", "line2", "city", "state", "postalCode", "country"]);
+  const customFields: Record<string, unknown> = {};
+  for (const [key, value] of Object.entries(input as Record<string, unknown>)) {
+    if (!KNOWN_KEYS.has(key)) {
+      customFields[key] = value;
+    }
+  }
 
   // 1. Check address exists
   const address = await db
@@ -43,7 +50,7 @@ export async function run<CF extends Record<string, unknown>>(
 
   // 3. Apply updates
   const updates: Record<string, unknown> = {
-    ...(customFields as Record<string, unknown>),
+    ...customFields,
     updatedAt: new Date(),
   };
   if (line1 !== undefined) updates.line1 = line1;

package/src/modules/business-partner/command/updatePartnerBankAccount.ts

@@ -12,7 +12,7 @@ import { ok, err, type CommandContext } from "@tailor-platform/erp-kit/module";
 type PrimitivesModule = ReturnType<typeof definePrimitivesModule>;
 type PrimitivesQueries = PrimitivesModule["queries"];
 
-export interface UpdatePartnerBankAccountInput {
+export type UpdatePartnerBankAccountInput = {
   id: string;
   bankName?: string;
   accountHolderName?: string;
@@ -21,8 +21,7 @@ export interface UpdatePartnerBankAccountInput {
   iban?: string;
   swiftBic?: string | null;
   currencyId?: string;
-}
-
+};
 /**
  * Function: updatePartnerBankAccount
  *
@@ -31,7 +30,7 @@ export interface UpdatePartnerBankAccountInput {
  */
 export async function run<CF extends Record<string, unknown>>(
   db: Transaction,
-  input: UpdatePartnerBankAccountInput & CF,
+  input: UpdatePartnerBankAccountInput & Omit<Partial<CF>, "status">,
   ctx: CommandContext,
   primitivesQueries?: Pick<PrimitivesQueries, "getCurrency">,
 ) {

package/src/modules/business-partner/command/updatePartnerIdentification.ts

@@ -7,14 +7,13 @@ import {
 } from "../lib/errors.generated";
 import { ok, err, type CommandContext } from "@tailor-platform/erp-kit/module";
 
-export interface UpdatePartnerIdentificationInput {
+export type UpdatePartnerIdentificationInput = {
   id: string;
   value?: string;
   issuingCountry?: string;
   validFrom?: Date;
   validTo?: Date;
-}
-
+};
 /**
  * Function: updatePartnerIdentification
  *
@@ -24,7 +23,7 @@ export interface UpdatePartnerIdentificationInput {
  */
 export async function run<CF extends Record<string, unknown>>(
   db: Transaction,
-  input: UpdatePartnerIdentificationInput & CF,
+  input: UpdatePartnerIdentificationInput & Omit<Partial<CF>, "status">,
   _ctx: CommandContext,
 ) {
   const { id, value, issuingCountry, validFrom, validTo, ...customFields } = input;

package/src/modules/business-partner/docs/commands/UpdateContactPerson.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-updateContactPerson modifies the details of an existing contact person. All fields are optional, but validation rules are enforced for any provided values. The contact person's association with its organization partner cannot be changed. After the update, at least one communication channel (email or phone) must remain present.
+updateContactPerson modifies the details of an existing contact person. All fields are optional, but validation rules are enforced for any provided values. The contact person's organization association is fixed by the existing record and is not part of the update input. After the update, at least one communication channel (email or phone) must remain present.
 
 ## Business Rules
 
@@ -11,8 +11,8 @@ updateContactPerson modifies the details of an existing contact person. All fiel
 - Last name, if provided, must be non-empty and not whitespace-only
 - Email, if provided, must be in a valid format
 - After update, at least one of email or phone must still be present (whitespace-only values do not count)
-- The organization association is immutable and cannot be changed
-- The primary contact designation (isPrimary) is not modifiable through this command; it is preserved as-is
+- The organization association is not part of the update input
+- The primary contact designation (`isPrimary`) is not part of the update input; the existing value is preserved as-is
 - Only provided fields are updated; omitted fields retain their current values
 
 ## Process Flow

package/src/modules/business-partner/docs/commands/UpdatePartner.md

@@ -2,14 +2,14 @@
 
 ## Overview
 
-updatePartner modifies the mutable fields of an existing business partner. Only name and preferred currency can be updated. The partner type remains immutable after creation. This command supports incremental enrichment of partner data throughout the partner lifecycle.
+updatePartner modifies the mutable fields of an existing business partner. Only name and preferred currency can be updated. Partner type is fixed by the existing record and is not part of the update input. This command supports incremental enrichment of partner data throughout the partner lifecycle.
 
 ## Business Rules
 
 - Partner must exist in the system
 - Name, if provided, must be non-empty
 - Preferred currency, if provided, must reference an existing Currency in the primitives module
-- Partner type cannot be changed via this command
+- Partner type is not part of the update input
 
 ## Process Flow
 

package/src/modules/business-partner/docs/commands/UpdatePartnerAddress.md

@@ -2,13 +2,13 @@
 
 ## Overview
 
-updatePartnerAddress modifies the fields of an existing partner address. The address type is immutable and cannot be changed after creation. All other address fields (line1, line2, city, state, postalCode, country) can be updated individually. Country validation is enforced when a new country value is provided. Updates are permitted regardless of the parent partner's lifecycle status (DRAFT, ACTIVE, or INACTIVE) — existing addresses always remain updatable.
+updatePartnerAddress modifies the fields of an existing partner address. Address type is fixed by the existing record and is not part of the update input. All other address fields (line1, line2, city, state, postalCode, country) can be updated individually. Country validation is enforced when a new country value is provided. Updates are permitted regardless of the parent partner's lifecycle status (DRAFT, ACTIVE, or INACTIVE) — existing addresses always remain updatable.
 
 ## Business Rules
 
 - Address must exist in the system
 - Parent partner's lifecycle status is not checked — updates are permitted in any state (DRAFT, ACTIVE, or INACTIVE)
-- Address type is immutable — it cannot be changed after creation
+- Address type is not part of the update input
 - Country, if provided, must be a valid ISO 3166-1 alpha-2 code
 - Only provided fields are updated; omitted fields retain their current values
 

package/src/modules/business-partner/docs/commands/UpdatePartnerIdentification.md

@@ -2,12 +2,12 @@
 
 ## Overview
 
-updatePartnerIdentification modifies the fields of an existing partner identification. The identification type is immutable and cannot be changed after creation. When the value is updated, uniqueness is re-validated against the company scope to prevent duplicate registrations.
+updatePartnerIdentification modifies the fields of an existing partner identification. Identification type is fixed by the existing record and is not part of the update input. When the value is updated, uniqueness is re-validated against the company scope to prevent duplicate registrations.
 
 ## Business Rules
 
 - Identification must exist in the system
-- Type is immutable — it cannot be changed after creation
+- Type is not part of the update input
 - If value is provided, it must be non-empty and not whitespace-only
 - If value is changed, the new (type, value) combination must be unique within the company scope
 - When both validFrom and validTo are set, validTo must be greater than or equal to validFrom

package/src/modules/coa-management/command/updateAccount.ts

@@ -16,7 +16,7 @@ import {
 } from "../lib/errors.generated";
 import { ok, err, type CommandContext } from "@tailor-platform/erp-kit/module";
 
-export interface UpdateAccountInput {
+export type UpdateAccountInput = {
   id: string;
   name?: string;
   code?: string;
@@ -34,7 +34,7 @@ export interface UpdateAccountInput {
   defaultTaxCode?: string | null;
   tags?: string | null;
   accountGroupId?: string | null;
-}
+};
 
 export interface AuditCommands {
   logAuditEvent: (
@@ -80,7 +80,7 @@ const RECONCILIATION_REQUIRED_CLASSIFICATIONS = ["RECEIVABLE", "PAYABLE", "BANK_
  */
 export async function run<CF extends Record<string, unknown>>(
   db: Transaction,
-  input: UpdateAccountInput & CF,
+  input: UpdateAccountInput & Omit<Partial<CF>, "status">,
   ctx: CommandContext,
   deps?: GetCurrencyDep,
   auditCommands?: AuditCommands,

package/src/modules/coa-management/command/updateAccountGroup.test.ts

@@ -52,6 +52,28 @@ describe("updateAccountGroup", () => {
     }
   });
 
+  it("looks up group by chartOfAccountsId and code and updates name", async () => {
+    const { db, spies } = createMockDb<Transaction>();
+    const updatedGroup = { ...baseRootGroup, name: "Lookup Assets" };
+    spies.select.mockReturnValueOnce(baseRootGroup).mockReturnValueOnce(baseActiveCoa);
+    spies.update.mockReturnValue(updatedGroup);
+
+    const result = await run(
+      db,
+      {
+        chartOfAccountsId: baseRootGroup.chartOfAccountsId,
+        code: baseRootGroup.code,
+        name: "Lookup Assets",
+      },
+      ctx,
+    );
+
+    expect(result.ok).toBe(true);
+    if (result.ok) {
+      expect(result.value.accountGroup.name).toBe("Lookup Assets");
+    }
+  });
+
   it("returns error when name is empty", async () => {
     const { db, spies } = createMockDb<Transaction>();
     spies.select

package/src/modules/coa-management/command/updateAccountGroup.ts

@@ -9,13 +9,15 @@ import {
 } from "../lib/errors.generated";
 import { ok, err, type CommandContext } from "@tailor-platform/erp-kit/module";
 
-export interface UpdateAccountGroupInput {
-  id: string;
+export type UpdateAccountGroupInput = (
+  | { id: string }
+  | { chartOfAccountsId: string; code: string }
+) & {
   name?: string;
   sortOrder?: number | null;
   numberRangeStart?: number | null;
   numberRangeEnd?: number | null;
-}
+};
 
 export interface AuditCommands {
   logAuditEvent: (
@@ -33,7 +35,6 @@ export interface AuditCommands {
     ctx: CommandContext,
   ) => Promise<{ ok: true; value: unknown }>;
 }
-
 /**
  * Function: updateAccountGroup
  *
@@ -42,22 +43,33 @@ export interface AuditCommands {
  */
 export async function run<CF extends Record<string, unknown>>(
   db: Transaction,
-  input: UpdateAccountGroupInput & CF,
+  input: UpdateAccountGroupInput & Omit<Partial<CF>, "status">,
   ctx: CommandContext,
   auditCommands?: AuditCommands,
 ) {
-  const { id, name, sortOrder, numberRangeStart, numberRangeEnd, ...customFields } = input;
+  const { name, sortOrder, numberRangeStart, numberRangeEnd, ...customFields } = input;
+  delete (customFields as Record<string, unknown>).id;
+  delete (customFields as Record<string, unknown>).chartOfAccountsId;
+  delete (customFields as Record<string, unknown>).code;
 
   // 1. Find the group
-  const existing = await db
-    .selectFrom("AccountGroup")
-    .selectAll()
-    .where("id", "=", id)
-    .forUpdate()
-    .executeTakeFirst();
+  let existingQuery = db.selectFrom("AccountGroup").selectAll();
+  if ("id" in input) {
+    existingQuery = existingQuery.where("id", "=", (input as { id: string }).id);
+  } else {
+    const lookup = input as { chartOfAccountsId: string; code: string };
+    existingQuery = existingQuery
+      .where("chartOfAccountsId", "=", lookup.chartOfAccountsId)
+      .where("code", "=", lookup.code);
+  }
+  const existing = await existingQuery.forUpdate().executeTakeFirst();
 
   if (!existing) {
-    return err(new AccountGroupNotFoundError(id));
+    const key =
+      "id" in input
+        ? (input as { id: string }).id
+        : `${(input as { chartOfAccountsId: string; code: string }).chartOfAccountsId}:${(input as { chartOfAccountsId: string; code: string }).code}`;
+    return err(new AccountGroupNotFoundError(key));
   }
 
   // 2. Check parent CoA status
@@ -101,7 +113,7 @@ export async function run<CF extends Record<string, unknown>>(
         .execute();
 
       for (const group of existingGroups) {
-        if (group.id === id) continue;
+        if (group.id === existing.id) continue;
         if (group.numberRangeStart !== null && group.numberRangeEnd !== null) {
           if (newRangeStart <= group.numberRangeEnd && newRangeEnd >= group.numberRangeStart) {
             return err(new InvalidNumberRangeError(`${newRangeStart}-${newRangeEnd}`));
@@ -113,14 +125,14 @@ export async function run<CF extends Record<string, unknown>>(
       const assignedAccounts = await db
         .selectFrom("Account")
         .selectAll()
-        .where("accountGroupId", "=", id)
+        .where("accountGroupId", "=", existing.id)
         .execute();
 
       for (const account of assignedAccounts) {
         const accountCode = parseInt(account.code, 10);
         if (!isNaN(accountCode)) {
           if (accountCode < newRangeStart || accountCode > newRangeEnd) {
-            return err(new AccountsOutOfRangeError(id));
+            return err(new AccountsOutOfRangeError(existing.id));
           }
         }
       }
@@ -141,7 +153,7 @@ export async function run<CF extends Record<string, unknown>>(
   const accountGroup = await db
     .updateTable("AccountGroup")
     .set(updateData)
-    .where("id", "=", id)
+    .where("id", "=", existing.id)
     .returningAll()
     .executeTakeFirst();
 
@@ -177,7 +189,7 @@ export async function run<CF extends Record<string, unknown>>(
           actorType: "USER",
           actorId: ctx.actorId,
           entityType: "AccountGroup",
-          entityId: id,
+          entityId: existing.id,
           operationType: "UPDATE",
           companyId: coa!.companyId,
           changes,

package/src/modules/coa-management/command/updateChartOfAccounts.ts

@@ -7,11 +7,11 @@ import {
 } from "../lib/errors.generated";
 import { ok, err, type CommandContext } from "@tailor-platform/erp-kit/module";
 
-export interface UpdateChartOfAccountsInput {
+export type UpdateChartOfAccountsInput = {
   id: string;
   name?: string;
   description?: string | null;
-}
+};
 
 export interface AuditCommands {
   logAuditEvent: (
@@ -29,7 +29,6 @@ export interface AuditCommands {
     ctx: CommandContext,
   ) => Promise<{ ok: true; value: unknown }>;
 }
-
 /**
  * Function: updateChartOfAccounts
  *
@@ -38,7 +37,7 @@ export interface AuditCommands {
  */
 export async function run<CF extends Record<string, unknown>>(
   db: Transaction,
-  input: UpdateChartOfAccountsInput & CF,
+  input: UpdateChartOfAccountsInput & Omit<Partial<CF>, "status">,
   ctx: CommandContext,
   auditCommands?: AuditCommands,
 ) {

package/src/modules/coa-management/docs/commands/UpdateAccountGroup.md

@@ -2,14 +2,14 @@
 
 ## Overview
 
-updateAccountGroup modifies the mutable fields (name, sort order, number range) of an existing account group. Code is immutable after creation. Number range changes must not conflict with existing account assignments or overlap with other groups' ranges.
+updateAccountGroup modifies the mutable fields (name, sort order, number range) of an existing account group. The target group can be looked up by `id` or by `chartOfAccountsId` + `code`. Group code is fixed by the existing record and is used only as a lookup key when paired with `chartOfAccountsId`. Number range changes must not conflict with existing account assignments or overlap with other groups' ranges.
 
 ## Business Rules
 
-- Target group must exist
+- Target group must exist (looked up by `id` or `chartOfAccountsId` + `code`)
 - Parent CoA must be in DRAFT or ACTIVE status; updating a group under an ARCHIVED CoA is rejected
 - Name, when provided, must be non-empty
-- Group code is immutable
+- Group code is not part of the update input
 - Number range changes, when provided, require both start and end to be provided together, must remain a valid non-overlapping interval within the CoA
 - Changing a number range must not invalidate existing accounts already assigned to the group (their codes must still fall within the new range)
 - Emits an audit event via the audit module recording the acting user, timestamp, and previous and new field values for all changed attributes
@@ -48,6 +48,7 @@ flowchart TD
 ## Test Cases
 
 - returns error when group does not exist
+- looks up group by chartOfAccountsId and code and updates name
 - returns error when parent CoA is ARCHIVED
 - returns error when name is empty
 - returns error when new number range is invalid

package/src/modules/finance-ledger/README.md

@@ -0,0 +1,50 @@
+# README
+
+<!-- This section should contain the following subsections in order: -->
+<!-- 1. ## Overview (required) -->
+<!-- 2. ## Key Features (required) -->
+<!-- 3. ## Module Scope (required) -->
+<!-- 4. ## Module Dependencies (required) -->
+
+## Overview
+
+## Key Features
+
+<!-- List requirements: -->
+<!-- Minimum 1 unordered lists required -->
+<!-- Minimum 1 items per list -->
+
+- TODO: Add list item
+
+## Module Scope
+
+<!-- This section should contain the following subsections in order: -->
+<!-- 1. ### In Scope (required) -->
+<!-- 2. ### Out of Scope (required) -->
+<!-- 3. ### Scope Decision Rationale (required) -->
+
+### In Scope
+
+<!-- List requirements: -->
+<!-- Minimum 1 unordered lists required -->
+<!-- Minimum 1 items per list -->
+
+- TODO: Add list item
+
+### Out of Scope
+
+<!-- List requirements: -->
+<!-- Minimum 1 unordered lists required -->
+<!-- Minimum 1 items per list -->
+
+- TODO: Add list item
+
+### Scope Decision Rationale
+
+<!-- Explain why capabilities are in-scope or out-of-scope — domain alignment, separation of concerns, etc. -->
+
+## Module Dependencies
+
+<!-- List requirements: -->
+<!-- Minimum 1 items per list -->
+

package/src/modules/finance-ledger/command/addJournalLine.generated.ts

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