@tailor-platform/erp-kit 0.6.0 → 0.8.0

package/src/modules/accounting/generated/enums.ts

@@ -0,0 +1,110 @@
+/**
+ * Allocation type
+ */
+export const AllocationCycleAllocationType = {
+  "ASSESSMENT": "ASSESSMENT",
+  "DISTRIBUTION": "DISTRIBUTION"
+} as const;
+export type AllocationCycleAllocationType = (typeof AllocationCycleAllocationType)[keyof typeof AllocationCycleAllocationType];
+
+/**
+ * Allocation cycle lifecycle status
+ */
+export const AllocationCycleStatus = {
+  "DRAFT": "DRAFT",
+  "VALIDATED": "VALIDATED",
+  "EXECUTED": "EXECUTED",
+  "POSTED": "POSTED",
+  "REVERSED": "REVERSED"
+} as const;
+export type AllocationCycleStatus = (typeof AllocationCycleStatus)[keyof typeof AllocationCycleStatus];
+
+/**
+ * Budget lifecycle status
+ */
+export const BudgetStatus = {
+  "DRAFT": "DRAFT",
+  "SUBMITTED": "SUBMITTED",
+  "APPROVED": "APPROVED",
+  "ACTIVE": "ACTIVE",
+  "CLOSED": "CLOSED"
+} as const;
+export type BudgetStatus = (typeof BudgetStatus)[keyof typeof BudgetStatus];
+
+/**
+ * Cost element type
+ */
+export const CostElementType = {
+  "PRIMARY": "PRIMARY",
+  "SECONDARY": "SECONDARY"
+} as const;
+export type CostElementType = (typeof CostElementType)[keyof typeof CostElementType];
+
+/**
+ * Cost element lifecycle status
+ */
+export const CostElementStatus = {
+  "DRAFT": "DRAFT",
+  "ACTIVE": "ACTIVE",
+  "INACTIVE": "INACTIVE"
+} as const;
+export type CostElementStatus = (typeof CostElementStatus)[keyof typeof CostElementStatus];
+
+/**
+ * Internal order type
+ */
+export const InternalOrderOrderType = {
+  "OVERHEAD": "OVERHEAD",
+  "INVESTMENT": "INVESTMENT",
+  "ACCRUAL": "ACCRUAL"
+} as const;
+export type InternalOrderOrderType = (typeof InternalOrderOrderType)[keyof typeof InternalOrderOrderType];
+
+/**
+ * Internal order lifecycle status
+ */
+export const InternalOrderStatus = {
+  "CREATED": "CREATED",
+  "RELEASED": "RELEASED",
+  "TECHNICALLY_COMPLETED": "TECHNICALLY_COMPLETED",
+  "CLOSED": "CLOSED"
+} as const;
+export type InternalOrderStatus = (typeof InternalOrderStatus)[keyof typeof InternalOrderStatus];
+
+/**
+ * Plan version type
+ */
+export const PlanVersionType = {
+  "BUDGET": "BUDGET",
+  "FORECAST": "FORECAST",
+  "SIMULATION": "SIMULATION"
+} as const;
+export type PlanVersionType = (typeof PlanVersionType)[keyof typeof PlanVersionType];
+
+/**
+ * Profit center lifecycle status
+ */
+export const ProfitCenterStatus = {
+  "DRAFT": "DRAFT",
+  "ACTIVE": "ACTIVE",
+  "INACTIVE": "INACTIVE"
+} as const;
+export type ProfitCenterStatus = (typeof ProfitCenterStatus)[keyof typeof ProfitCenterStatus];
+
+/**
+ * Variance report lifecycle status
+ */
+export const VarianceReportStatus = {
+  "DRAFT": "DRAFT",
+  "FINAL": "FINAL"
+} as const;
+export type VarianceReportStatus = (typeof VarianceReportStatus)[keyof typeof VarianceReportStatus];
+
+/**
+ * Direction of the variance
+ */
+export const VarianceReportLineVarianceDirection = {
+  "FAVORABLE": "FAVORABLE",
+  "UNFAVORABLE": "UNFAVORABLE"
+} as const;
+export type VarianceReportLineVarianceDirection = (typeof VarianceReportLineVarianceDirection)[keyof typeof VarianceReportLineVarianceDirection];

package/src/modules/accounting/generated/kysely-tailordb.ts

@@ -0,0 +1,302 @@
+import {
+  createGetDB,
+  type Generated,
+  type Timestamp,
+  type NamespaceDB,
+  type NamespaceInsertable,
+  type NamespaceSelectable,
+  type NamespaceTable,
+  type NamespaceTableName,
+  type NamespaceTransaction,
+  type NamespaceUpdateable,
+} from "@tailor-platform/sdk/kysely";
+
+export interface Namespace {
+  "main-db": {
+    AllocationCycle: {
+      id: Generated<string>;
+      name: string;
+      allocationType: "ASSESSMENT" | "DISTRIBUTION";
+      companyId: string;
+      accountingPeriodId: string;
+      status: "DRAFT" | "VALIDATED" | "EXECUTED" | "POSTED" | "REVERSED";
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    AllocationResult: {
+      id: Generated<string>;
+      allocationCycleId: string;
+      senderCostCenterId: string;
+      receiverType: string;
+      receiverId: string;
+      allocatedAmount: number;
+      costElementId: string;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    AllocationRule: {
+      id: Generated<string>;
+      allocationCycleId: string;
+      senderCostCenterId: string;
+      receiverType: string;
+      receiverId: string;
+      percentage: number;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    Budget: {
+      id: Generated<string>;
+      name: string;
+      description: string | null;
+      budgetHolderId: string;
+      fiscalYearId: string;
+      companyId: string;
+      costObjectType: string;
+      costObjectId: string;
+      planVersionId: string;
+      totalAmount: number;
+      rejectionReason: string | null;
+      status: "DRAFT" | "SUBMITTED" | "APPROVED" | "ACTIVE" | "CLOSED";
+      createdByUserId: string;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    BudgetLineItem: {
+      id: Generated<string>;
+      budgetId: string;
+      costElementId: string;
+      accountingPeriodId: string;
+      glAccountId: string | null;
+      plannedAmount: number;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    Commitment: {
+      id: Generated<string>;
+      costElementId: string;
+      costObjectType: string;
+      costObjectId: string;
+      accountingPeriodId: string;
+      amount: number;
+      consumedAmount: number;
+      purchaseOrderId: string;
+      companyId: string;
+      status: string;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    CostCenter: {
+      id: Generated<string>;
+      code: string;
+      name: string;
+      description: string | null;
+      category: string;
+      responsiblePersonId: string | null;
+      departmentId: string | null;
+      companyId: string;
+      hierarchyNodeId: string;
+      validFrom: Timestamp;
+      validTo: Timestamp | null;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    CostCenterHierarchy: {
+      id: Generated<string>;
+      name: string;
+      version: string;
+      companyId: string;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    CostCenterHierarchyNode: {
+      id: Generated<string>;
+      name: string;
+      hierarchyId: string;
+      parentNodeId: string | null;
+      sortOrder: number;
+      level: number;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    CostElement: {
+      id: Generated<string>;
+      code: string;
+      name: string;
+      type: "PRIMARY" | "SECONDARY";
+      category: string;
+      description: string | null;
+      glAccountId: string | null;
+      companyId: string;
+      validFrom: Timestamp | null;
+      validTo: Timestamp | null;
+      status: "DRAFT" | "ACTIVE" | "INACTIVE";
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    InternalOrder: {
+      id: Generated<string>;
+      orderNumber: string;
+      orderType: "OVERHEAD" | "INVESTMENT" | "ACCRUAL";
+      description: string;
+      responsiblePersonId: string;
+      costCenterId: string;
+      companyId: string;
+      validFrom: Timestamp | null;
+      validTo: Timestamp | null;
+      status: "CREATED" | "RELEASED" | "TECHNICALLY_COMPLETED" | "CLOSED";
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    PlanVersion: {
+      id: Generated<string>;
+      name: string;
+      type: "BUDGET" | "FORECAST" | "SIMULATION";
+      baseVersionId: string | null;
+      companyId: string;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    ProfitCenter: {
+      id: Generated<string>;
+      code: string;
+      name: string;
+      description: string | null;
+      responsiblePersonId: string | null;
+      companyId: string;
+      validFrom: Timestamp;
+      validTo: Timestamp | null;
+      status: "DRAFT" | "ACTIVE" | "INACTIVE";
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    ProfitCenterHierarchy: {
+      id: Generated<string>;
+      name: string;
+      companyId: string;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    ProfitCenterHierarchyAssignment: {
+      id: Generated<string>;
+      profitCenterId: string;
+      hierarchyId: string;
+      hierarchyNodeId: string;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    ProfitCenterHierarchyNode: {
+      id: Generated<string>;
+      name: string;
+      hierarchyId: string;
+      parentNodeId: string | null;
+      sortOrder: number;
+      level: number;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    VarianceReport: {
+      id: Generated<string>;
+      costObjectType: string;
+      costObjectId: string;
+      accountingPeriodId: string;
+      companyId: string;
+      totalPlanned: number;
+      totalActual: number;
+      totalVariance: number;
+      status: "DRAFT" | "FINAL";
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    VarianceReportLine: {
+      id: Generated<string>;
+      varianceReportId: string;
+      costElementId: string;
+      accountingPeriodId: string;
+      plannedAmount: number;
+      actualAmount: number;
+      varianceAmount: number;
+      variancePercentage: number;
+      varianceDirection: "FAVORABLE" | "UNFAVORABLE";
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    Account: {
+      id: Generated<string>;
+      code: string | null;
+      name: string | null;
+      classification: string | null;
+      status: string | null;
+      chartOfAccountsId: string | null;
+    }
+
+    AccountingPeriod: {
+      id: Generated<string>;
+      companyId: string | null;
+      fiscalYearId: string | null;
+      status: string | null;
+    }
+
+    ChartOfAccounts: {
+      id: Generated<string>;
+      companyId: string | null;
+      status: string | null;
+    }
+
+    Company: {
+      id: Generated<string>;
+      status: string | null;
+    }
+
+    Department: {
+      id: Generated<string>;
+      name: string | null;
+    }
+
+    FiscalYear: {
+      id: Generated<string>;
+      companyId: string | null;
+    }
+
+    PurchaseOrder: {
+      id: Generated<string>;
+      status: string | null;
+    }
+
+    User: {
+      id: Generated<string>;
+      status: string | null;
+    }
+  }
+}
+
+export const getDB = createGetDB<Namespace>();
+
+export type DB<N extends keyof Namespace = keyof Namespace> = NamespaceDB<Namespace, N>;
+
+export type Transaction<K extends keyof Namespace | DB = keyof Namespace> =
+  NamespaceTransaction<Namespace, K>;
+
+type TableName = NamespaceTableName<Namespace>;
+export type Table<T extends TableName> = NamespaceTable<Namespace, T>;
+
+export type Insertable<T extends TableName> = NamespaceInsertable<Namespace, T>;
+export type Selectable<T extends TableName> = NamespaceSelectable<Namespace, T>;
+export type Updateable<T extends TableName> = NamespaceUpdateable<Namespace, T>;

package/src/modules/accounting/index.ts

@@ -0,0 +1,2 @@
+export { defineModule } from "./module";
+export { permissions, own, all } from "./lib/permissions.generated";

package/src/modules/accounting/lib/_db_deps.ts

@@ -0,0 +1,70 @@
+// Stub types for cross-module dependencies — used only for codegen.
+// At runtime, actual types are injected via defineModule() params.
+import {
+  db,
+  unsafeAllowAllGqlPermission,
+  unsafeAllowAllTypePermission,
+} from "@tailor-platform/sdk";
+
+export const company = db
+  .type("Company", {
+    status: db.string({ optional: true }),
+  })
+  .permission(unsafeAllowAllTypePermission)
+  .gqlPermission(unsafeAllowAllGqlPermission);
+
+export const account = db
+  .type("Account", {
+    code: db.string({ optional: true }),
+    name: db.string({ optional: true }),
+    classification: db.string({ optional: true }),
+    status: db.string({ optional: true }),
+    chartOfAccountsId: db.uuid({ optional: true }),
+  })
+  .permission(unsafeAllowAllTypePermission)
+  .gqlPermission(unsafeAllowAllGqlPermission);
+
+export const chartOfAccounts = db
+  .type(["ChartOfAccounts", "ChartsOfAccounts"], {
+    companyId: db.uuid({ optional: true }),
+    status: db.string({ optional: true }),
+  })
+  .permission(unsafeAllowAllTypePermission)
+  .gqlPermission(unsafeAllowAllGqlPermission);
+
+export const user = db
+  .type("User", {
+    status: db.string({ optional: true }),
+  })
+  .permission(unsafeAllowAllTypePermission)
+  .gqlPermission(unsafeAllowAllGqlPermission);
+
+export const department = db
+  .type("Department", {
+    name: db.string({ optional: true }),
+  })
+  .permission(unsafeAllowAllTypePermission)
+  .gqlPermission(unsafeAllowAllGqlPermission);
+
+export const accountingPeriod = db
+  .type("AccountingPeriod", {
+    companyId: db.uuid({ optional: true }),
+    fiscalYearId: db.uuid({ optional: true }),
+    status: db.string({ optional: true }),
+  })
+  .permission(unsafeAllowAllTypePermission)
+  .gqlPermission(unsafeAllowAllGqlPermission);
+
+export const fiscalYear = db
+  .type("FiscalYear", {
+    companyId: db.uuid({ optional: true }),
+  })
+  .permission(unsafeAllowAllTypePermission)
+  .gqlPermission(unsafeAllowAllGqlPermission);
+
+export const purchaseOrder = db
+  .type("PurchaseOrder", {
+    status: db.string({ optional: true }),
+  })
+  .permission(unsafeAllowAllTypePermission)
+  .gqlPermission(unsafeAllowAllGqlPermission);

package/src/modules/accounting/lib/actualAmounts.ts

@@ -0,0 +1,93 @@
+import type { DB, Transaction } from "../generated/kysely-tailordb";
+import type { ReadonlyDB } from "@tailor-platform/erp-kit/module";
+
+type QueryableDB = ReadonlyDB<DB> | Transaction;
+
+type ActualAmountRow = Record<string, unknown>;
+
+interface CrossModuleJournalLineQuery {
+  innerJoin(table: string, left: string, right: string): CrossModuleJournalLineQuery;
+  selectAll(table: string): CrossModuleJournalLineQuery;
+  where(column: string, operator: string, value: string): CrossModuleJournalLineQuery;
+  execute(): Promise<unknown>;
+}
+
+interface ActualAmountParams {
+  accountingPeriodId: string;
+  costObjectType: string;
+  costObjectId: string;
+}
+
+interface SumActualAmountParams extends ActualAmountParams {
+  costElementId: string;
+}
+
+function toNumber(value: unknown): number | null {
+  return typeof value === "number" && Number.isFinite(value) ? value : null;
+}
+
+function getRowAmount(row: ActualAmountRow): number {
+  const explicitAmount =
+    toNumber(row.amount) ??
+    toNumber(row.functionalAmount) ??
+    toNumber(row.actualAmount) ??
+    toNumber(row.netAmount);
+  if (explicitAmount !== null) {
+    return explicitAmount;
+  }
+
+  const debit = toNumber(row.functionalDebitAmount) ?? toNumber(row.debitAmount) ?? 0;
+  const credit = toNumber(row.functionalCreditAmount) ?? toNumber(row.creditAmount) ?? 0;
+
+  if (debit !== 0 || credit !== 0) {
+    return debit !== 0 ? debit : credit;
+  }
+
+  return 0;
+}
+
+async function listActualAmountRows(db: QueryableDB, params: ActualAmountParams) {
+  const query = db.selectFrom("JournalLine" as never) as unknown as CrossModuleJournalLineQuery;
+  const rows = await query
+    .innerJoin("JournalEntry", "JournalEntry.id", "JournalLine.journalEntryId")
+    .selectAll("JournalLine")
+    .where("JournalEntry.accountingPeriodId", "=", params.accountingPeriodId)
+    .where("JournalEntry.status", "=", "POSTED")
+    .where("JournalLine.costObjectType", "=", params.costObjectType)
+    .where("JournalLine.costObjectId", "=", params.costObjectId)
+    .execute();
+
+  return rows as ActualAmountRow[];
+}
+
+export async function listPostedActualAmountsByCostElement(
+  db: QueryableDB,
+  params: ActualAmountParams,
+) {
+  const rows = await listActualAmountRows(db, params);
+  const totals = new Map<string, number>();
+
+  for (const row of rows) {
+    const costElementId = typeof row.costElementId === "string" ? row.costElementId : null;
+    if (!costElementId) {
+      continue;
+    }
+
+    totals.set(costElementId, (totals.get(costElementId) ?? 0) + getRowAmount(row));
+  }
+
+  return totals;
+}
+
+export async function sumPostedActualAmount(db: QueryableDB, params: SumActualAmountParams) {
+  const rows = await listActualAmountRows(db, params);
+
+  return rows.reduce((sum, row) => {
+    const costElementId = typeof row.costElementId === "string" ? row.costElementId : null;
+    if (costElementId !== params.costElementId) {
+      return sum;
+    }
+
+    return sum + getRowAmount(row);
+  }, 0);
+}