@porulle/plugin-warehouse 0.1.0

package/README.md

@@ -0,0 +1,54 @@
+# @porulle/plugin-warehouse
+
+Inter-warehouse stock transfers with approval and dispatch/receive, wastage notes, and stock reconciliations.
+
+## Install
+
+```bash
+bun add @porulle/plugin-warehouse
+```
+
+Add to `commerce.config.ts`:
+
+```typescript
+import { warehousePlugin } from "@porulle/plugin-warehouse";
+
+export default defineConfig({
+  plugins: [warehousePlugin()],
+});
+```
+
+Add to `drizzle.config.ts`:
+
+```typescript
+schema: [
+  "./node_modules/@porulle/plugin-warehouse/src/schema.ts",
+  // ...
+],
+```
+
+## What it does
+
+Models bins (schema), transfer headers/lines with workflow states, wastage with approval, and cycle-count style reconciliations with submit/approve steps.
+
+## Routes exposed
+
+**`/warehouse`** — transfers: `POST/GET /transfers`, `GET /transfers/{id}`, `POST .../approve|dispatch|receive`; wastage: `POST/GET /wastage`, `POST /wastage/{id}/approve`; reconciliations: `POST/GET /reconciliations`, `GET /reconciliations/{id}`, `POST .../submit|approve`
+
+## Hooks
+
+**Emitted:** none.
+
+**Consumed:** none.
+
+## MCP tools
+
+**`warehouse`** — `list_transfers`, `get_transfer`, `approve_transfer`, `dispatch_transfer`, `list_wastage`, `approve_wastage`, `list_reconciliations`, `get_reconciliation`, `submit_reconciliation`, `approve_reconciliation`
+
+## Configuration options
+
+None (`warehousePlugin()` takes no options).
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export type { Db } from "./types.js";
+export { TransferService } from "./services/transfer-service.js";
+export { WastageService } from "./services/wastage-service.js";
+export { ReconciliationService } from "./services/reconciliation-service.js";
+export declare function warehousePlugin(): import("@porulle/core").CommercePlugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,YAAY,EAAE,EAAE,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAE7E,wBAAgB,eAAe,2CAiB9B"}

package/dist/index.js

@@ -0,0 +1,28 @@
+import { defineCommercePlugin } from "@porulle/core";
+import { warehouseBins, stockTransfers, stockTransferItems, wastageNotes, wastageNoteItems, stockReconciliations, reconciliationItems } from "./schema.js";
+import { TransferService } from "./services/transfer-service.js";
+import { WastageService } from "./services/wastage-service.js";
+import { ReconciliationService } from "./services/reconciliation-service.js";
+import { buildWarehouseRoutes } from "./routes/warehouse.js";
+export { TransferService } from "./services/transfer-service.js";
+export { WastageService } from "./services/wastage-service.js";
+export { ReconciliationService } from "./services/reconciliation-service.js";
+export function warehousePlugin() {
+    return defineCommercePlugin({
+        id: "warehouse",
+        version: "1.0.0",
+        permissions: [
+            { scope: "warehouse:admin", description: "Approve transfers, wastage, reconciliations." },
+            { scope: "warehouse:operate", description: "Create transfers, wastage notes, reconciliations." },
+            { scope: "warehouse:read", description: "View transfers, wastage, reconciliations." },
+        ],
+        schema: () => ({ warehouseBins, stockTransfers, stockTransferItems, wastageNotes, wastageNoteItems, stockReconciliations, reconciliationItems }),
+        hooks: () => [],
+        routes: (ctx) => {
+            const db = ctx.database.db;
+            if (!db)
+                return [];
+            return buildWarehouseRoutes(new TransferService(db), new WastageService(db), new ReconciliationService(db), ctx);
+        },
+    });
+}

package/dist/routes/warehouse.d.ts

@@ -0,0 +1,11 @@
+import type { TransferService } from "../services/transfer-service.js";
+import type { WastageService } from "../services/wastage-service.js";
+import type { ReconciliationService } from "../services/reconciliation-service.js";
+import type { PluginRouteRegistration } from "@porulle/core";
+export declare function buildWarehouseRoutes(transferSvc: TransferService, wastageSvc: WastageService, recSvc: ReconciliationService, ctx: {
+    services?: Record<string, unknown>;
+    database?: {
+        db: unknown;
+    };
+}): PluginRouteRegistration[];
+//# sourceMappingURL=warehouse.d.ts.map

package/dist/routes/warehouse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"warehouse.d.ts","sourceRoot":"","sources":["../../src/routes/warehouse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AACnF,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAC;AAE7D,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,eAAe,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,EAAE,qBAAqB,EACvF,GAAG,EAAE;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAAC,QAAQ,CAAC,EAAE;QAAE,EAAE,EAAE,OAAO,CAAA;KAAE,CAAA;CAAE,GACtE,uBAAuB,EAAE,CA2H3B"}

package/dist/routes/warehouse.js

@@ -0,0 +1,125 @@
+import { router } from "@porulle/core";
+import { z } from "@hono/zod-openapi";
+export function buildWarehouseRoutes(transferSvc, wastageSvc, recSvc, ctx) {
+    const r = router("Warehouse", "/warehouse", ctx);
+    // Transfers
+    r.post("/transfers").summary("Create stock transfer").permission("warehouse:operate")
+        .input(z.object({
+        fromWarehouseId: z.string().uuid(), toWarehouseId: z.string().uuid(), type: z.enum(["requisition", "direct", "return"]).optional(), notes: z.string().optional(),
+        items: z.array(z.object({ entityId: z.string().uuid(), variantId: z.string().uuid().optional(), itemName: z.string(), quantityRequested: z.number().int().positive(), batchNumber: z.string().optional() })).min(1),
+    }))
+        .handler(async ({ input, actor, orgId }) => {
+        const body = input;
+        const result = await transferSvc.create(orgId, { ...body, requestedBy: actor.userId });
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.get("/transfers").summary("List transfers").permission("warehouse:read")
+        .query(z.object({ status: z.string().optional() }))
+        .handler(async ({ query, orgId }) => {
+        const result = await transferSvc.list(orgId, query.status);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.get("/transfers/{id}").summary("Get transfer with items").permission("warehouse:read")
+        .handler(async ({ params, orgId }) => {
+        const result = await transferSvc.getById(orgId, params.id);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.post("/transfers/{id}/approve").summary("Approve transfer").permission("warehouse:admin")
+        .handler(async ({ params, actor, orgId }) => {
+        const result = await transferSvc.approve(orgId, params.id, actor.userId);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.post("/transfers/{id}/dispatch").summary("Dispatch transfer").permission("warehouse:operate")
+        .handler(async ({ params, orgId }) => {
+        const result = await transferSvc.dispatch(orgId, params.id);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.post("/transfers/{id}/receive").summary("Receive transfer").permission("warehouse:operate")
+        .input(z.object({ items: z.array(z.object({ itemId: z.string().uuid(), quantityReceived: z.number().int() })).min(1) }))
+        .handler(async ({ params, input, orgId }) => {
+        const body = input;
+        const result = await transferSvc.receive(orgId, params.id, body.items);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    // Wastage
+    r.post("/wastage").summary("Create wastage note").permission("warehouse:operate")
+        .input(z.object({
+        warehouseId: z.string().uuid(), type: z.enum(["spoilage", "damage", "expiry", "theft", "prep_waste", "other"]), notes: z.string().optional(),
+        items: z.array(z.object({ entityId: z.string().uuid(), variantId: z.string().uuid().optional(), itemName: z.string(), quantity: z.number().int().positive(), unitCost: z.number().int(), reason: z.string().optional(), batchNumber: z.string().optional() })).min(1),
+    }))
+        .handler(async ({ input, actor, orgId }) => {
+        const body = input;
+        const result = await wastageSvc.create(orgId, { ...body, recordedBy: actor.userId });
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.get("/wastage").summary("List wastage notes").permission("warehouse:read")
+        .handler(async ({ orgId }) => {
+        const result = await wastageSvc.list(orgId);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.post("/wastage/{id}/approve").summary("Approve wastage").permission("warehouse:admin")
+        .handler(async ({ params, actor, orgId }) => {
+        const result = await wastageSvc.approve(orgId, params.id, actor.userId);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    // Reconciliation
+    r.post("/reconciliations").summary("Create stock reconciliation").permission("warehouse:operate")
+        .input(z.object({
+        warehouseId: z.string().uuid(),
+        items: z.array(z.object({ entityId: z.string().uuid(), variantId: z.string().uuid().optional(), itemName: z.string(), systemQuantity: z.number().int(), physicalQuantity: z.number().int(), notes: z.string().optional() })).min(1),
+    }))
+        .handler(async ({ input, actor, orgId }) => {
+        const body = input;
+        const result = await recSvc.create(orgId, { ...body, countedBy: actor.userId });
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.get("/reconciliations").summary("List reconciliations").permission("warehouse:read")
+        .handler(async ({ orgId }) => {
+        const result = await recSvc.list(orgId);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.get("/reconciliations/{id}").summary("Get reconciliation with items").permission("warehouse:read")
+        .handler(async ({ params, orgId }) => {
+        const result = await recSvc.getById(orgId, params.id);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.post("/reconciliations/{id}/submit").summary("Submit reconciliation").permission("warehouse:operate")
+        .handler(async ({ params, orgId }) => {
+        const result = await recSvc.submit(orgId, params.id);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.post("/reconciliations/{id}/approve").summary("Approve reconciliation").permission("warehouse:admin")
+        .handler(async ({ params, actor, orgId }) => {
+        const result = await recSvc.approve(orgId, params.id, actor.userId);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    return r.routes();
+}