@porulle/plugin-procurement 0.1.0

package/README.md

@@ -0,0 +1,54 @@
+# @porulle/plugin-procurement
+
+Suppliers with catalog links, purchase orders through approval, and goods-received notes for inbound receiving.
+
+## Install
+
+```bash
+bun add @porulle/plugin-procurement
+```
+
+Add to `commerce.config.ts`:
+
+```typescript
+import { procurementPlugin } from "@porulle/plugin-procurement";
+
+export default defineConfig({
+  plugins: [procurementPlugin()],
+});
+```
+
+Add to `drizzle.config.ts`:
+
+```typescript
+schema: [
+  "./node_modules/@porulle/plugin-procurement/src/schema.ts",
+  // ...
+],
+```
+
+## What it does
+
+Manages supplier master data, links sellable items to suppliers, creates and approves POs, records GRNs, and accepts GRNs into inventory context via services (see procurement routes for permissions).
+
+## Routes exposed
+
+**`/procurement`** — `POST/GET /suppliers`, `GET /suppliers/{id}`, `POST /suppliers/{id}/items`, `POST/GET /purchase-orders`, `GET /purchase-orders/{id}`, `POST .../submit|approve|cancel`, `POST/GET /grn`, `GET /grn/{id}`, `POST /grn/{id}/accept`
+
+## Hooks
+
+**Emitted:** none.
+
+**Consumed:** none.
+
+## MCP tools
+
+**`procurement`** — `list_suppliers`, `get_supplier`, `list_po`, `get_po`, `approve_po`, `cancel_po`, `list_grn`, `get_grn`, `accept_grn`
+
+## Configuration options
+
+None (`procurementPlugin()` takes no options).
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export type { Db } from "./types.js";
+export { SupplierService } from "./services/supplier-service.js";
+export { PurchaseOrderService } from "./services/po-service.js";
+export { GRNService } from "./services/grn-service.js";
+export declare function procurementPlugin(): 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,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAEvD,wBAAgB,iBAAiB,2CAiBhC"}

package/dist/index.js

@@ -0,0 +1,28 @@
+import { defineCommercePlugin } from "@porulle/core";
+import { suppliers, supplierItems, purchaseOrders, purchaseOrderItems, goodsReceivedNotes, grnItems } from "./schema.js";
+import { SupplierService } from "./services/supplier-service.js";
+import { PurchaseOrderService } from "./services/po-service.js";
+import { GRNService } from "./services/grn-service.js";
+import { buildProcurementRoutes } from "./routes/procurement.js";
+export { SupplierService } from "./services/supplier-service.js";
+export { PurchaseOrderService } from "./services/po-service.js";
+export { GRNService } from "./services/grn-service.js";
+export function procurementPlugin() {
+    return defineCommercePlugin({
+        id: "procurement",
+        version: "1.0.0",
+        permissions: [
+            { scope: "procurement:admin", description: "Approve POs, manage suppliers, accept GRNs." },
+            { scope: "procurement:create", description: "Create POs, create GRNs." },
+            { scope: "procurement:read", description: "View POs, GRNs, suppliers." },
+        ],
+        schema: () => ({ suppliers, supplierItems, purchaseOrders, purchaseOrderItems, goodsReceivedNotes, grnItems }),
+        hooks: () => [],
+        routes: (ctx) => {
+            const db = ctx.database.db;
+            if (!db)
+                return [];
+            return buildProcurementRoutes(new SupplierService(db), new PurchaseOrderService(db), new GRNService(db), ctx);
+        },
+    });
+}

package/dist/routes/procurement.d.ts

@@ -0,0 +1,11 @@
+import type { SupplierService } from "../services/supplier-service.js";
+import type { PurchaseOrderService } from "../services/po-service.js";
+import type { GRNService } from "../services/grn-service.js";
+import type { PluginRouteRegistration } from "@porulle/core";
+export declare function buildProcurementRoutes(supplierSvc: SupplierService, poSvc: PurchaseOrderService, grnSvc: GRNService, ctx: {
+    services?: Record<string, unknown>;
+    database?: {
+        db: unknown;
+    };
+}): PluginRouteRegistration[];
+//# sourceMappingURL=procurement.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"procurement.d.ts","sourceRoot":"","sources":["../../src/routes/procurement.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAC;AAE7D,wBAAgB,sBAAsB,CACpC,WAAW,EAAE,eAAe,EAAE,KAAK,EAAE,oBAAoB,EAAE,MAAM,EAAE,UAAU,EAC7E,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,CA4H3B"}

package/dist/routes/procurement.js

@@ -0,0 +1,126 @@
+import { router } from "@porulle/core";
+import { z } from "@hono/zod-openapi";
+export function buildProcurementRoutes(supplierSvc, poSvc, grnSvc, ctx) {
+    const r = router("Procurement", "/procurement", ctx);
+    // Suppliers
+    r.post("/suppliers").summary("Register supplier").permission("procurement:admin")
+        .input(z.object({ name: z.string().min(1), code: z.string().min(1), contactName: z.string().optional(), contactEmail: z.string().email().optional(), contactPhone: z.string().optional(), paymentTermsDays: z.number().int().optional(), currency: z.string().optional() }))
+        .handler(async ({ input, orgId }) => {
+        const result = await supplierSvc.create(orgId, input);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.get("/suppliers").summary("List suppliers").permission("procurement:read")
+        .handler(async ({ orgId }) => {
+        const result = await supplierSvc.list(orgId);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.get("/suppliers/{id}").summary("Get supplier with items").permission("procurement:read")
+        .handler(async ({ params, orgId }) => {
+        const result = await supplierSvc.getById(orgId, params.id);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.post("/suppliers/{id}/items").summary("Link item to supplier").permission("procurement:admin")
+        .input(z.object({ entityId: z.string().uuid(), variantId: z.string().uuid().optional(), supplierSku: z.string().optional(), unitCost: z.number().int().positive(), minOrderQuantity: z.number().int().optional(), leadTimeDays: z.number().int().optional(), isPreferred: z.boolean().optional() }))
+        .handler(async ({ params, input }) => {
+        const result = await supplierSvc.addItem(params.id, input);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    // Purchase Orders
+    r.post("/purchase-orders").summary("Create purchase order").permission("procurement:create")
+        .input(z.object({
+        supplierId: z.string().uuid(), warehouseId: z.string().uuid(), notes: z.string().optional(),
+        expectedDelivery: z.string().optional(),
+        items: z.array(z.object({ entityId: z.string().uuid(), variantId: z.string().uuid().optional(), itemName: z.string(), quantityOrdered: z.number().int().positive(), unitCost: z.number().int().positive() })).min(1),
+    }))
+        .handler(async ({ input, actor, orgId }) => {
+        const body = input;
+        const result = await poSvc.create(orgId, { ...body, requestedBy: actor.userId });
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.get("/purchase-orders").summary("List purchase orders").permission("procurement:read")
+        .query(z.object({ status: z.string().optional() }))
+        .handler(async ({ query, orgId }) => {
+        const result = await poSvc.list(orgId, query.status);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.get("/purchase-orders/{id}").summary("Get PO with items").permission("procurement:read")
+        .handler(async ({ params, orgId }) => {
+        const result = await poSvc.getById(orgId, params.id);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.post("/purchase-orders/{id}/submit").summary("Submit PO for approval").permission("procurement:create")
+        .handler(async ({ params, orgId }) => {
+        const result = await poSvc.submit(orgId, params.id);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.post("/purchase-orders/{id}/approve").summary("Approve PO").permission("procurement:admin")
+        .handler(async ({ params, actor, orgId }) => {
+        const result = await poSvc.approve(orgId, params.id, actor.userId);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.post("/purchase-orders/{id}/cancel").summary("Cancel PO").permission("procurement:admin")
+        .handler(async ({ params, orgId }) => {
+        const result = await poSvc.cancel(orgId, params.id);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    // GRN
+    r.post("/grn").summary("Create GRN").permission("procurement:create")
+        .input(z.object({
+        poId: z.string().uuid(), supplierId: z.string().uuid(), warehouseId: z.string().uuid(), notes: z.string().optional(),
+        items: z.array(z.object({
+            poItemId: z.string().uuid(), entityId: z.string().uuid(), variantId: z.string().uuid().optional(),
+            quantityOrdered: z.number().int(), quantityReceived: z.number().int(), quantityAccepted: z.number().int(),
+            quantityRejected: z.number().int().optional(), rejectionReason: z.string().optional(),
+            batchNumber: z.string().optional(), expiryDate: z.string().optional(), unitCost: z.number().int(),
+        })).min(1),
+    }))
+        .handler(async ({ input, actor, orgId }) => {
+        const body = input;
+        const result = await grnSvc.create(orgId, { ...body, receivedBy: actor.userId });
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.get("/grn").summary("List GRNs").permission("procurement:read")
+        .handler(async ({ orgId }) => {
+        const result = await grnSvc.list(orgId);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.get("/grn/{id}").summary("Get GRN with items").permission("procurement:read")
+        .handler(async ({ params, orgId }) => {
+        const result = await grnSvc.getById(orgId, params.id);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    r.post("/grn/{id}/accept").summary("Accept GRN").permission("procurement:admin")
+        .handler(async ({ params, orgId }) => {
+        const result = await grnSvc.accept(orgId, params.id);
+        if (!result.ok)
+            throw new Error(result.error);
+        return result.value;
+    });
+    return r.routes();
+}