@tailor-platform/erp-kit 0.4.1 → 0.5.0

package/src/modules/inventory/docs/queries/ListWarehouses.md

@@ -0,0 +1,42 @@
+# ListWarehouses
+
+## Overview
+
+ListWarehouses lists warehouses filtered by site or status. It returns summary-level records without nested storage locations — use GetWarehouse for full detail. Results are ordered by name ascending.
+
+## Business Rules
+
+- Accepts optional filters:
+  - `siteId` — filter by site
+  - `status` — filter by warehouse status (e.g., Active, Inactive)
+- Returns Warehouse records **without** nested StorageLocation records
+- Results are ordered by `name` ascending
+- Returns an empty list if no matching records exist
+
+## Process Flow
+
+```mermaid
+flowchart TD
+    A[Receive optional filters] --> B[Build query from provided filters]
+    B --> C[Apply siteId, status filters as provided]
+    C --> D[Order by name ascending]
+    D --> E{Records found?}
+    E -->|Yes| F[Return list of Warehouse records]
+    E -->|No| G[Return empty list]
+```
+
+## External Dependencies
+
+- None
+
+## Error Scenarios
+
+- Returns empty list if no matching records exist
+
+## Test Cases
+
+- lists warehouses by site
+- lists warehouses by status
+- returns empty list when no matches
+- orders by name ascending
+- does not include storage locations

package/src/modules/inventory/docs/queries/TraceLotBackward.md

@@ -0,0 +1,46 @@
+# TraceLotBackward
+
+## Overview
+
+TraceLotBackward provides backward traceability — given a lot, it returns the originating goods receipt and supplier information. This is used for root cause analysis to identify where a lot's items originated.
+
+## Business Rules
+
+- Requires `lotId`
+- Returns all inbound StockMoveLine records where the lot was part of a goods receipt
+- Each record includes:
+  - Movement date
+  - Source (supplier) location
+  - Quantity
+  - Reference (e.g., purchase order, production order)
+- Joins StockMoveLine with StockMovement to obtain date and reference information
+- Returns error if the lot does not exist
+- Returns an empty list if the lot exists but has no inbound receipt records
+
+## Process Flow
+
+```mermaid
+flowchart TD
+    A[Receive lotId] --> B{Lot exists?}
+    B -->|No| C[Return LOT_NOT_FOUND error]
+    B -->|Yes| D[SELECT from StockMoveLine where lotId matches AND movement type is goods receipt]
+    D --> E[JOIN with StockMovement for date and reference]
+    E --> F{Records found?}
+    F -->|Yes| G[Return list of inbound StockMoveLine records]
+    F -->|No| H[Return empty list]
+```
+
+## External Dependencies
+
+- None
+
+## Error Scenarios
+
+- **LOT_NOT_FOUND**: The specified lot does not exist
+
+## Test Cases
+
+- returns inbound movements for lot
+- includes movement date and source reference
+- returns error when lot not found
+- returns empty list when no receipt found

package/src/modules/inventory/docs/queries/TraceLotForward.md

@@ -0,0 +1,46 @@
+# TraceLotForward
+
+## Overview
+
+TraceLotForward provides forward traceability — given a lot, it returns all outbound stock movements (goods issues) and their destinations. This is used for recall management to identify where a lot's items have been sent.
+
+## Business Rules
+
+- Requires `lotId`
+- Returns all outbound StockMoveLine records where the lot was part of a goods issue
+- Each record includes:
+  - Movement date
+  - Destination location
+  - Quantity
+  - Reference (e.g., sales order, transfer order)
+- Joins StockMoveLine with StockMovement to obtain date and reference information
+- Returns error if the lot does not exist
+- Returns an empty list if the lot exists but has no outbound movements
+
+## Process Flow
+
+```mermaid
+flowchart TD
+    A[Receive lotId] --> B{Lot exists?}
+    B -->|No| C[Return LOT_NOT_FOUND error]
+    B -->|Yes| D[SELECT from StockMoveLine where lotId matches AND movement type is goods issue]
+    D --> E[JOIN with StockMovement for date and reference]
+    E --> F{Records found?}
+    F -->|Yes| G[Return list of outbound StockMoveLine records]
+    F -->|No| H[Return empty list]
+```
+
+## External Dependencies
+
+- None
+
+## Error Scenarios
+
+- **LOT_NOT_FOUND**: The specified lot does not exist
+
+## Test Cases
+
+- returns outbound movements for lot
+- includes movement date and destination
+- returns error when lot not found
+- returns empty list when lot has no outbound movements

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

@@ -0,0 +1,131 @@
+/**
+ * Adjustment type: CORRECTION or SCRAP
+ */
+export const InventoryAdjustmentAdjustmentType = {
+  "CORRECTION": "CORRECTION",
+  "SCRAP": "SCRAP"
+} as const;
+export type InventoryAdjustmentAdjustmentType = (typeof InventoryAdjustmentAdjustmentType)[keyof typeof InventoryAdjustmentAdjustmentType];
+
+/**
+ * Lifecycle status: DRAFT, PENDING_APPROVAL, APPROVED, REJECTED, CONFIRMED
+ */
+export const InventoryAdjustmentStatus = {
+  "DRAFT": "DRAFT",
+  "PENDING_APPROVAL": "PENDING_APPROVAL",
+  "APPROVED": "APPROVED",
+  "REJECTED": "REJECTED",
+  "CONFIRMED": "CONFIRMED"
+} as const;
+export type InventoryAdjustmentStatus = (typeof InventoryAdjustmentStatus)[keyof typeof InventoryAdjustmentStatus];
+
+/**
+ * Count type: FULL (entire warehouse) or CYCLE (specific locations)
+ */
+export const InventoryCountCountType = {
+  "FULL": "FULL",
+  "CYCLE": "CYCLE"
+} as const;
+export type InventoryCountCountType = (typeof InventoryCountCountType)[keyof typeof InventoryCountCountType];
+
+/**
+ * Lifecycle status: PLANNED, IN_PROGRESS, COMPLETED, CANCELLED
+ */
+export const InventoryCountStatus = {
+  "PLANNED": "PLANNED",
+  "IN_PROGRESS": "IN_PROGRESS",
+  "COMPLETED": "COMPLETED",
+  "CANCELLED": "CANCELLED"
+} as const;
+export type InventoryCountStatus = (typeof InventoryCountStatus)[keyof typeof InventoryCountStatus];
+
+/**
+ * Review status: PENDING, APPROVED, REJECTED, RECOUNT
+ */
+export const InventoryCountLineStatus = {
+  "PENDING": "PENDING",
+  "APPROVED": "APPROVED",
+  "REJECTED": "REJECTED",
+  "RECOUNT": "RECOUNT"
+} as const;
+export type InventoryCountLineStatus = (typeof InventoryCountLineStatus)[keyof typeof InventoryCountLineStatus];
+
+/**
+ * Consumption status: ACTIVE or FULLY_CONSUMED
+ */
+export const LotStatus = {
+  "ACTIVE": "ACTIVE",
+  "FULLY_CONSUMED": "FULLY_CONSUMED"
+} as const;
+export type LotStatus = (typeof LotStatus)[keyof typeof LotStatus];
+
+/**
+ * Lifecycle status: AVAILABLE, ISSUED, RETURNED, SCRAPPED
+ */
+export const SerialNumberStatus = {
+  "AVAILABLE": "AVAILABLE",
+  "ISSUED": "ISSUED",
+  "RETURNED": "RETURNED",
+  "SCRAPPED": "SCRAPPED"
+} as const;
+export type SerialNumberStatus = (typeof SerialNumberStatus)[keyof typeof SerialNumberStatus];
+
+/**
+ * Movement type: GOODS_RECEIPT, GOODS_ISSUE, INTERNAL_TRANSFER, BLOCK, UNBLOCK
+ */
+export const StockMovementMovementType = {
+  "GOODS_RECEIPT": "GOODS_RECEIPT",
+  "GOODS_ISSUE": "GOODS_ISSUE",
+  "INTERNAL_TRANSFER": "INTERNAL_TRANSFER",
+  "BLOCK": "BLOCK",
+  "UNBLOCK": "UNBLOCK"
+} as const;
+export type StockMovementMovementType = (typeof StockMovementMovementType)[keyof typeof StockMovementMovementType];
+
+/**
+ * Lifecycle status: DRAFT, CONFIRMED, DONE, CANCELLED
+ */
+export const StockMovementStatus = {
+  "DRAFT": "DRAFT",
+  "CONFIRMED": "CONFIRMED",
+  "DONE": "DONE",
+  "CANCELLED": "CANCELLED"
+} as const;
+export type StockMovementStatus = (typeof StockMovementStatus)[keyof typeof StockMovementStatus];
+
+/**
+ * Location type: zone or bin
+ */
+export const StorageLocationLocationType = {
+  "zone": "zone",
+  "bin": "bin"
+} as const;
+export type StorageLocationLocationType = (typeof StorageLocationLocationType)[keyof typeof StorageLocationLocationType];
+
+/**
+ * Lifecycle status: ACTIVE, INACTIVE
+ */
+export const StorageLocationStatus = {
+  "ACTIVE": "ACTIVE",
+  "INACTIVE": "INACTIVE"
+} as const;
+export type StorageLocationStatus = (typeof StorageLocationStatus)[keyof typeof StorageLocationStatus];
+
+/**
+ * Costing method: FIFO, AVCO, or STANDARD_COST
+ */
+export const ValuationPolicyCostingMethod = {
+  "FIFO": "FIFO",
+  "AVCO": "AVCO",
+  "STANDARD_COST": "STANDARD_COST"
+} as const;
+export type ValuationPolicyCostingMethod = (typeof ValuationPolicyCostingMethod)[keyof typeof ValuationPolicyCostingMethod];
+
+/**
+ * Lifecycle status: ACTIVE, INACTIVE
+ */
+export const WarehouseStatus = {
+  "ACTIVE": "ACTIVE",
+  "INACTIVE": "INACTIVE"
+} as const;
+export type WarehouseStatus = (typeof WarehouseStatus)[keyof typeof WarehouseStatus];

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

@@ -0,0 +1,201 @@
+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": {
+    CostLayer: {
+      id: Generated<string>;
+      itemId: string;
+      valuationPolicyId: string;
+      stockMovementId: string;
+      quantity: number;
+      unitCost: number;
+      remainingQuantity: number;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    InventoryAdjustment: {
+      id: Generated<string>;
+      adjustmentType: "CORRECTION" | "SCRAP";
+      itemId: string;
+      storageLocationId: string;
+      quantityDelta: number;
+      reasonCode: string;
+      status: "DRAFT" | "PENDING_APPROVAL" | "APPROVED" | "REJECTED" | "CONFIRMED";
+      inventoryCountId: string | null;
+      lotId: string | null;
+      serialNumberId: string | null;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    InventoryCount: {
+      id: Generated<string>;
+      countType: "FULL" | "CYCLE";
+      warehouseId: string | null;
+      storageLocationId: string | null;
+      plannedDate: Timestamp;
+      status: "PLANNED" | "IN_PROGRESS" | "COMPLETED" | "CANCELLED";
+      isFrozen: boolean;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    InventoryCountLine: {
+      id: Generated<string>;
+      inventoryCountId: string;
+      itemId: string;
+      storageLocationId: string;
+      systemQuantity: number;
+      countedQuantity: number | null;
+      variance: number | null;
+      status: "PENDING" | "APPROVED" | "REJECTED" | "RECOUNT";
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    ItemValuation: {
+      id: Generated<string>;
+      itemId: string;
+      valuationPolicyId: string;
+      totalQuantity: number;
+      totalValue: number;
+      costPerUnit: number;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    Lot: {
+      id: Generated<string>;
+      lotNumber: string;
+      itemId: string;
+      manufactureDate: Timestamp | null;
+      expirationDate: Timestamp | null;
+      supplierLotReference: string | null;
+      status: "ACTIVE" | "FULLY_CONSUMED";
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    LotStockLevel: {
+      id: Generated<string>;
+      lotId: string;
+      storageLocationId: string;
+      onHand: number;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    SerialNumber: {
+      id: Generated<string>;
+      serialNumber: string;
+      itemId: string;
+      storageLocationId: string;
+      status: "AVAILABLE" | "ISSUED" | "RETURNED" | "SCRAPPED";
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    StockLevel: {
+      id: Generated<string>;
+      itemId: string;
+      storageLocationId: string;
+      onHand: number;
+      reserved: number;
+      incoming: number;
+      blocked: number;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    StockMoveLine: {
+      id: Generated<string>;
+      stockMovementId: string;
+      itemId: string;
+      quantity: number;
+      sourceLocationId: string | null;
+      destinationLocationId: string | null;
+      lotId: string | null;
+      serialNumberId: string | null;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    StockMovement: {
+      id: Generated<string>;
+      movementType: "GOODS_RECEIPT" | "GOODS_ISSUE" | "INTERNAL_TRANSFER" | "BLOCK" | "UNBLOCK";
+      reasonCode: string | null;
+      status: "DRAFT" | "CONFIRMED" | "DONE" | "CANCELLED";
+      executedAt: Timestamp | null;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    StorageLocation: {
+      id: Generated<string>;
+      name: string;
+      code: string | null;
+      warehouseId: string;
+      parentId: string | null;
+      locationType: "zone" | "bin";
+      storageCondition: string | null;
+      capacity: number | null;
+      status: "ACTIVE" | "INACTIVE";
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    ValuationPolicy: {
+      id: Generated<string>;
+      name: string;
+      costingMethod: "FIFO" | "AVCO" | "STANDARD_COST";
+      standardCostRate: number | null;
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    Warehouse: {
+      id: Generated<string>;
+      name: string;
+      siteId: string;
+      storageCondition: string | null;
+      capacity: number | null;
+      status: "ACTIVE" | "INACTIVE";
+      createdAt: Generated<Timestamp>;
+      updatedAt: Timestamp | null;
+    }
+
+    Item: {
+      id: Generated<string>;
+    }
+
+    Site: {
+      id: Generated<string>;
+    }
+  }
+}
+
+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/inventory/index.ts

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

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

@@ -0,0 +1,17 @@
+// 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 site = db
+  .type("Site", {})
+  .permission(unsafeAllowAllTypePermission)
+  .gqlPermission(unsafeAllowAllGqlPermission);
+
+export const item = db
+  .type("Item", {})
+  .permission(unsafeAllowAllTypePermission)
+  .gqlPermission(unsafeAllowAllGqlPermission);