@spinekit/purchase 0.1.0

package/dist/supplier.model-BcAfgyHu.d.mts

@@ -0,0 +1,88 @@
+import { Connection, IndexDefinition, IndexOptions, Model, Types } from "mongoose";
+import { PermissionGate } from "@spinekit/kit/permissions";
+//#region src/resources/supplier/supplier.types.d.ts
+interface SupplierFacet {
+  /** The `@classytic/party` this facet belongs to. Identity is the party's, never this doc's. */
+  partyId?: Types.ObjectId;
+  name: string;
+  nameNormalized?: string;
+  code?: string;
+  type: (typeof SUPPLIER_TYPES)[number];
+  contactPerson?: string;
+  phone?: string;
+  email?: string;
+  address?: string;
+  taxId?: string;
+  paymentTerms: (typeof SUPPLIER_PAYMENT_TERMS)[number];
+  creditDays: number;
+  creditLimit: number;
+  openingBalance: number;
+  isActive: boolean;
+  notes?: string;
+  tags: string[];
+  createdBy?: Types.ObjectId;
+  updatedBy?: Types.ObjectId;
+  createdAt?: Date;
+  updatedAt?: Date;
+  /** `null` = live, `Date` = archived. Managed by mongokit's `softDeletePlugin`. */
+  deletedAt?: Date | null;
+}
+/**
+ * Mongoose model NAMES this facet references.
+ *
+ * INJECTED, never literals: `'user'` is Better Auth's canonical lower-case collection in be-prod
+ * and a different name in another host, and a wrong `ref` yields bare ObjectIds on populate
+ * rather than an error.
+ */
+interface SupplierRefs {
+  party: string;
+  user: string;
+}
+interface SupplierModelDeps {
+  connection: Connection;
+  refs: SupplierRefs;
+  /** Country-pack schema fields. See the model's docblock for why they are not declared inline. */
+  extraFields?: Record<string, unknown>;
+  /** Country-pack indexes, as `[fields, options]` pairs. */
+  extraIndexes?: Array<[IndexDefinition, IndexOptions]>;
+  /** Collection/model name. Default `'Supplier'`. */
+  modelName?: string;
+}
+/**
+ * Supplier code generation — a HOST port.
+ *
+ * Sequence allocation is infrastructure (be-prod runs a Mongo counter collection shared with
+ * every other inventory document number), and the FORMAT is a deployment's convention. Absent,
+ * the repository leaves `code` unset rather than inventing one: a supplier with a fabricated code
+ * that collides with the host's real sequence is worse than one with no code, because the unique
+ * index then rejects a LATER, legitimate row.
+ */
+interface SupplierCodeGenerator {
+  nextCode(): Promise<string>;
+}
+interface SupplierRepositoryDeps {
+  codeGenerator?: SupplierCodeGenerator;
+  /** Page size defaults. Bounded because an unbounded partner list is a latent outage. */
+  defaultLimit?: number;
+  maxLimit?: number;
+}
+interface SupplierPermissions {
+  /** list + get. */
+  view: PermissionGate;
+  /** create + update + delete + the bulk import. */
+  manage: PermissionGate;
+  /**
+   * DELETE gate. Separate slot because a soft-delete archives a vendor the A/P ledger still
+   * references; a deployment may want it narrower than `manage`. Absent ⇒ `manage`.
+   */
+  delete?: PermissionGate;
+}
+//#endregion
+//#region src/resources/supplier/supplier.model.d.ts
+/** Sourcing relationship — generic enough for any jurisdiction. */
+declare const SUPPLIER_TYPES: readonly ['local', 'import', 'manufacturer', 'wholesaler'];
+/** Settlement basis. Terms in DAYS live on `creditDays`, so this stays a two-value axis. */
+declare const SUPPLIER_PAYMENT_TERMS: readonly ['cash', 'credit'];
+declare function createSupplierModel<TSupplier extends SupplierFacet = SupplierFacet>(deps: SupplierModelDeps): Model<TSupplier>;
+//#endregion
+export { SupplierFacet as a, SupplierRefs as c, SupplierCodeGenerator as i, SupplierRepositoryDeps as l, SUPPLIER_TYPES as n, SupplierModelDeps as o, createSupplierModel as r, SupplierPermissions as s, SUPPLIER_PAYMENT_TERMS as t };

package/dist/types-T9gsXOf_.d.mts

@@ -0,0 +1,127 @@
+import { PurchaseEngine } from "@classytic/purchase/engine";
+import { PurchaseBridges } from "@classytic/purchase";
+import { ResourceSeams } from "@classytic/arc";
+import { EngineRef, EngineSlot } from "@spinekit/kit/engine-slot";
+import { Connection } from "mongoose";
+import { EventTransport } from "@classytic/primitives/events";
+import { OutboxStore } from "@classytic/primitives/outbox";
+import { PermissionGate } from "@spinekit/kit/permissions";
+//#region src/types.d.ts
+interface PurchasePermissions {
+  /** List/read purchase orders. */
+  view: PermissionGate;
+  /** Draft create/update/delete. */
+  manage: PermissionGate;
+  /** Lifecycle verbs — approve / receive. */
+  operate: PermissionGate;
+  /** cancel. */
+  cancel: PermissionGate;
+}
+interface PurchaseModuleDeps {
+  /**
+   * ── Host contribution arms ─────────────────────────────────────────────
+   *
+   * Declared because their ABSENCE made hosts spread the returned module and re-attach
+   * these by hand. A spread silently OVERWRITES whatever the factory contributed, and the
+   * host cannot see what that was — so the day this package supplies one of these arms, the
+   * host quietly wins and the package's version never runs.
+   *
+   * Safe in most hosts today only because the overlap does not exist YET. That is a latency,
+   * not a design.
+   */
+  onClose?: (fastify: unknown) => void | Promise<void>;
+  connection: Connection;
+  /**
+   * Functional currency of the deployment (ISO 4217) — REQUIRED by
+   * `createPurchaseEngine` since purchase 0.5 (a money kernel has no
+   * jurisdiction default; same rule as arc-invoice/arc-assets). Documents in
+   * another currency are rejected unless `allowForeignCurrency` is on.
+   */
+  baseCurrency: string;
+  /** Permit POs/bills in a currency other than `baseCurrency`. Default false. */
+  allowForeignCurrency?: boolean | undefined;
+  /** Bring-your-own engine (strangler migrations) — bridges travel with it. */
+  /** BYO engine. Pass a THUNK to defer allocation to arc's bootstrap phase. */
+  engine?: EngineRef<PurchaseEngine>;
+  /**
+   * A slot to publish the bound engine into, SHARED with the host.
+   *
+   * The seam that lets a host READ the engine without OWNING it: the host declares one slot with
+   * spine-kit's `createEngineSlot`, hands it here, and reads `slot.get()` wherever it needs the
+   * engine — this module fills it at bootstrap and empties it at teardown. Without it, a host that
+   * merely needs to read has to construct, which is the ownership inversion §7 fixes.
+   *
+   * Omit it and the slot stays private; nothing outside can read it.
+   */
+  slot?: EngineSlot<PurchaseEngine>;
+  /** Kernel ports: catalog (pricelist cost lookup), stockReceipt (WMS, idempotent), sequence. */
+  bridges?: PurchaseBridges;
+  eventTransport?: EventTransport;
+  /** Mongoose autoIndex — disable in production (deploy runs engine.syncIndexes())
+   *  and in tests (await an explicit syncIndexes instead of racing teardown). */
+  autoIndex?: boolean;
+  outbox?: OutboxStore;
+  /** Kernel tenancy toggle. Default `false` — arc is the tenant boundary (POs
+   *  are company-wide by convention). A vertical that scopes POs per-branch at
+   *  the kernel flips this on (full `PurchaseTenantOptions` = BYO-engine). */
+  tenant?: boolean;
+  /**
+   * Waive the kernel's transaction requirement — DEV/TEST ONLY, and never defaulted here.
+   *
+   * `assertPurchaseCapabilities` requires `transactions`, and since mongokit began OBSERVING
+   * live topology an unreadable topology resolves `'unknown'` — which is not a yes (FAIL LOUD
+   * rule 3). On a replica set this flag changes nothing; on a standalone `mongod` it is the
+   * difference between a laptop that boots and one that refuses.
+   *
+   * OMITTED means the kernel's own fail-closed default stands, which is why this is optional
+   * with no default in this module: a host that forgets it gets refusal, not silent
+   * non-atomic money movement. Pass `!isProduction` from the host's env classifier — never
+   * an unconditional `true`, and never a raw `NODE_ENV` comparison (that spelling misses
+   * `prod`, and the miss OPENS the gate).
+   */
+  allowNonTransactional?: boolean | undefined;
+  /**
+   * Delete + re-register the kernel's models on bind. MULTI-BOOT affordance, not a mode.
+   *
+   * A suite that boots and closes the app repeatedly on ONE mongoose connection hits
+   * `OverwriteModelError` on the second bind, because the connection outlives the module
+   * scope. This permits the re-registration. The kernel refuses it under
+   * `NODE_ENV=production`, so it cannot become a production behaviour by accident.
+   *
+   * SHAPE, not runtime — it decides what happens to the model registry, so it travels with
+   * `definePurchase` rather than `bind`.
+   */
+  forceRecreate?: boolean | undefined;
+  /**
+   * Host wiring that needs the engine, resolved late (inside `resources()`, which arc
+   * runs after `bootstrap`). Note that a wiring function can depend on the engine
+   * WITHOUT taking it as a parameter — purchase's reads the singleton internally.
+   */
+  wiring?: () => PurchaseLateWiring;
+  /**
+   * Required, but may arrive via `wiring` instead when the host derives gates from the
+   * engine. Absent from BOTH is a hard error at mount, never a silent open door.
+   */
+  permissions?: PurchasePermissions;
+  /** Mount point. Default `/inventory/purchase-orders`. */
+  prefix?: string;
+  /** App-policy actions (approval preset, accounting `pay`, …). */
+  extraActions?: ResourceSeams['actions'];
+  /** App-policy routes (composite workflows, reports, exports, …). */
+  extraRoutes?: ResourceSeams['routes'];
+  /**
+   * Mongoose populate specs for HTTP READ paths only (list + detail) —
+   * display joins like `{ path: 'supplier', model: 'Supplier', select:
+   * 'name code' }`. Kernel verbs and internal `getById` callers stay bare.
+   *
+   * NOTE: there are deliberately NO controller/repository/schema override
+   * seams — the module owns HTTP, every write routes through a kernel verb,
+   * and the kernel's Zod schemas are the wire contract. Hosts extend via
+   * `extraActions`/`extraRoutes` (which ADD, never bypass).
+   */
+  readPopulate?: unknown[];
+}
+/** The engine-dependent subset of the deps, resolvable after bootstrap. */
+type PurchaseLateWiring = Partial<Pick<PurchaseModuleDeps, 'permissions' | 'extraActions' | 'extraRoutes' | 'readPopulate'>>;
+//#endregion
+export { PurchasePermissions as n, PurchaseModuleDeps as t };

package/package.json

@@ -0,0 +1,129 @@
+{
+  "name": "@spinekit/purchase",
+  "version": "0.1.0",
+  "description": "Arc module for @classytic/purchase — supplier purchase orders (draft→approve→receive with CAS + compensation + pendingStockReceipt crash heal) composed into arc apps. Paisa money wire; catalog/stockReceipt/sequence kernel ports injected; accounting posting + approval stay host seams.",
+  "type": "module",
+  "license": "SEE LICENSE IN LICENSE",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    },
+    "./repositories/purchase-order": {
+      "types": "./dist/repositories/purchase-order.repository.d.mts",
+      "default": "./dist/repositories/purchase-order.repository.mjs"
+    },
+    "./payment": {
+      "types": "./dist/payment/purchase-payment.application.d.mts",
+      "default": "./dist/payment/purchase-payment.application.mjs"
+    },
+    "./bridges": {
+      "types": "./dist/bridges.d.mts",
+      "default": "./dist/bridges.mjs"
+    },
+    "./package.json": "./package.json",
+    "./receipt": {
+      "types": "./dist/receipt/purchase-stock-receipt.d.mts",
+      "default": "./dist/receipt/purchase-stock-receipt.mjs"
+    },
+    "./lifecycle": {
+      "types": "./dist/lifecycle/purchase-lifecycle.d.mts",
+      "default": "./dist/lifecycle/purchase-lifecycle.mjs"
+    },
+    "./payment/types": {
+      "types": "./dist/payment/purchase-payment.types.d.mts",
+      "default": "./dist/payment/purchase-payment.types.mjs"
+    },
+    "./payment/tax": {
+      "types": "./dist/payment/purchase-payment.tax.d.mts",
+      "default": "./dist/payment/purchase-payment.tax.mjs"
+    },
+    "./receipt/types": {
+      "types": "./dist/receipt/purchase-stock-receipt.types.d.mts",
+      "default": "./dist/receipt/purchase-stock-receipt.types.mjs"
+    },
+    "./lifecycle/types": {
+      "types": "./dist/lifecycle/purchase-lifecycle.types.d.mts",
+      "default": "./dist/lifecycle/purchase-lifecycle.types.mjs"
+    },
+    "./resources/purchase-order/resource": {
+      "types": "./dist/resources/purchase-order/purchase-order.resource.d.mts",
+      "default": "./dist/resources/purchase-order/purchase-order.resource.mjs"
+    },
+    "./resources/supplier/resource": {
+      "types": "./dist/resources/supplier/supplier.resource.d.mts",
+      "default": "./dist/resources/supplier/supplier.resource.mjs"
+    },
+    "./resources/supplier/model": {
+      "types": "./dist/resources/supplier/supplier.model.d.mts",
+      "default": "./dist/resources/supplier/supplier.model.mjs"
+    },
+    "./resources/supplier/repository": {
+      "types": "./dist/resources/supplier/supplier.repository.d.mts",
+      "default": "./dist/resources/supplier/supplier.repository.mjs"
+    },
+    "./resources/supplier/types": {
+      "types": "./dist/resources/supplier/supplier.types.d.mts",
+      "default": "./dist/resources/supplier/supplier.types.mjs"
+    }
+  },
+  "files": [
+    "LICENSE",
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "build": "tsdown",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "clean": "node -e \"require('fs').rmSync('dist',{recursive:true,force:true})\"",
+    "prepublishOnly": "npm run typecheck && npm run test && npm run build"
+  },
+  "peerDependencies": {
+    "@classytic/arc": ">=2.34.0",
+    "@spinekit/kit": ">=0.1.0",
+    "@classytic/mongokit": ">=3.34.0",
+    "@classytic/primitives": ">=0.23.0",
+    "@classytic/purchase": ">=0.6.0",
+    "mongoose": ">=9.4.1",
+    "zod": ">=4.0.0"
+  },
+  "devDependencies": {
+    "@classytic/arc": "^2.34.0",
+    "@spinekit/kit": "workspace:*",
+    "@classytic/arc-testkit": "^0.4.0",
+    "@classytic/mongokit": ">=3.34.0",
+    "@classytic/primitives": ">=0.23.0",
+    "@classytic/purchase": ">=0.6.0",
+    "@types/node": "^24.3.0",
+    "fastify": "^5.12.0",
+    "mongodb-memory-server": "^10.4.3",
+    "mongoose": "^9.7.2",
+    "tsdown": "^0.22.14",
+    "typescript": "^7.0.2",
+    "vitest": "^3.2.4",
+    "zod": "^4.3.6"
+  },
+  "author": "Classytic",
+  "homepage": "https://www.npmjs.com/package/@spinekit/purchase",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/classytic/spine.git",
+    "directory": "packages/spine-purchase"
+  },
+  "keywords": [
+    "arc",
+    "classytic",
+    "spine",
+    "erp",
+    "purchase",
+    "procurement",
+    "purchase-order",
+    "supplier"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}