@classytic/primitives 0.19.0 → 0.20.0

package/package.json

@@ -1,232 +1,244 @@
-{
-  "name": "@classytic/primitives",
-  "version": "0.19.0",
-  "description": "Framework-agnostic TypeScript primitives shared across Classytic packages — Money, events, pagination, tenant config, and other building blocks.",
-  "author": "Classytic",
-  "license": "MIT",
-  "homepage": "https://www.npmjs.com/package/@classytic/primitives",
-  "bugs": {
-    "url": "https://github.com/classytic/primitives/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/classytic/primitives.git"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "type": "module",
-  "sideEffects": false,
-  "engines": {
-    "node": ">=22"
-  },
-  "exports": {
-    "./money": {
-      "types": "./dist/money.d.mts",
-      "default": "./dist/money.mjs"
-    },
-    "./currency": {
-      "types": "./dist/currency.d.mts",
-      "default": "./dist/currency.mjs"
-    },
-    "./unit-cost-rate": {
-      "types": "./dist/unit-cost-rate.d.mts",
-      "default": "./dist/unit-cost-rate.mjs"
-    },
-    "./address": {
-      "types": "./dist/address.d.mts",
-      "default": "./dist/address.mjs"
-    },
-    "./period": {
-      "types": "./dist/period.d.mts",
-      "default": "./dist/period.mjs"
-    },
-    "./calendar": {
-      "types": "./dist/calendar.d.mts",
-      "default": "./dist/calendar.mjs"
-    },
-    "./timezone": {
-      "types": "./dist/timezone.d.mts",
-      "default": "./dist/timezone.mjs"
-    },
-    "./reference": {
-      "types": "./dist/reference.d.mts",
-      "default": "./dist/reference.mjs"
-    },
-    "./context": {
-      "types": "./dist/context.d.mts",
-      "default": "./dist/context.mjs"
-    },
-    "./events": {
-      "types": "./dist/events.d.mts",
-      "default": "./dist/events.mjs"
-    },
-    "./event-infra": {
-      "types": "./dist/event-infra.d.mts",
-      "default": "./dist/event-infra.mjs"
-    },
-    "./outbox": {
-      "types": "./dist/outbox.d.mts",
-      "default": "./dist/outbox.mjs"
-    },
-    "./result": {
-      "types": "./dist/result.d.mts",
-      "default": "./dist/result.mjs"
-    },
-    "./brand": {
-      "types": "./dist/brand.d.mts",
-      "default": "./dist/brand.mjs"
-    },
-    "./split-allocation": {
-      "types": "./dist/split-allocation.d.mts",
-      "default": "./dist/split-allocation.mjs"
-    },
-    "./approval": {
-      "types": "./dist/approval.d.mts",
-      "default": "./dist/approval.mjs"
-    },
-    "./cadence": {
-      "types": "./dist/cadence.d.mts",
-      "default": "./dist/cadence.mjs"
-    },
-    "./hold": {
-      "types": "./dist/hold.d.mts",
-      "default": "./dist/hold.mjs"
-    },
-    "./sla": {
-      "types": "./dist/sla.d.mts",
-      "default": "./dist/sla.mjs"
-    },
-    "./shelf-life": {
-      "types": "./dist/shelf-life.d.mts",
-      "default": "./dist/shelf-life.mjs"
-    },
-    "./person": {
-      "types": "./dist/person.d.mts",
-      "default": "./dist/person.mjs"
-    },
-    "./identity-verification": {
-      "types": "./dist/identity-verification.d.mts",
-      "default": "./dist/identity-verification.mjs"
-    },
-    "./otp": {
-      "types": "./dist/otp.d.mts",
-      "default": "./dist/otp.mjs"
-    },
-    "./state-machine": {
-      "types": "./dist/state-machine.d.mts",
-      "default": "./dist/state-machine.mjs"
-    },
-    "./bank-transaction": {
-      "types": "./dist/bank-transaction.d.mts",
-      "default": "./dist/bank-transaction.mjs"
-    },
-    "./payment-gateway": {
-      "types": "./dist/payment-gateway.d.mts",
-      "default": "./dist/payment-gateway.mjs"
-    },
-    "./payment-method-kind": {
-      "types": "./dist/payment-method-kind.d.mts",
-      "default": "./dist/payment-method-kind.mjs"
-    },
-    "./payment-allocation-status": {
-      "types": "./dist/payment-allocation-status.d.mts",
-      "default": "./dist/payment-allocation-status.mjs"
-    },
-    "./monetization": {
-      "types": "./dist/monetization.d.mts",
-      "default": "./dist/monetization.mjs"
-    },
-    "./proration": {
-      "types": "./dist/proration.d.mts",
-      "default": "./dist/proration.mjs"
-    },
-    "./payment-events": {
-      "types": "./dist/payment-events.d.mts",
-      "default": "./dist/payment-events.mjs"
-    },
-    "./phone": {
-      "types": "./dist/phone.d.mts",
-      "default": "./dist/phone.mjs"
-    },
-    "./status-history": {
-      "types": "./dist/status-history.d.mts",
-      "default": "./dist/status-history.mjs"
-    },
-    "./condition": {
-      "types": "./dist/condition.d.mts",
-      "default": "./dist/condition.mjs"
-    },
-    "./mixin": {
-      "types": "./dist/mixin.d.mts",
-      "default": "./dist/mixin.mjs"
-    },
-    "./sla-policy": {
-      "types": "./dist/sla-policy.d.mts",
-      "default": "./dist/sla-policy.mjs"
-    },
-    "./retention": {
-      "types": "./dist/retention.d.mts",
-      "default": "./dist/retention.mjs"
-    },
-    "./canonical": {
-      "types": "./dist/canonical.d.mts",
-      "default": "./dist/canonical.mjs"
-    },
-    "./package.json": "./package.json",
-    "./state-diagram": {
-      "types": "./dist/state-diagram.d.mts",
-      "default": "./dist/state-diagram.mjs"
-    },
-    "./suspension": {
-      "types": "./dist/suspension.d.mts",
-      "default": "./dist/suspension.mjs"
-    },
-    "./subject": {
-      "types": "./dist/subject.d.mts",
-      "default": "./dist/subject.mjs"
-    }
-  },
-  "files": [
-    "dist",
-    "README.md",
-    "CHANGELOG.md",
-    "LICENSE"
-  ],
-  "scripts": {
-    "build": "tsdown",
-    "dev": "tsdown --watch",
-    "typecheck": "tsc --noEmit",
-    "lint": "biome check src/ tests/",
-    "lint:fix": "biome check --write src/ tests/",
-    "test": "vitest run --project unit --project integration",
-    "test:unit": "vitest run --project unit",
-    "test:integration": "vitest run --project integration",
-    "test:all": "vitest run",
-    "test:watch": "vitest --project unit --project integration",
-    "test:smoke": "node tests/smoke/smoke.mjs",
-    "push": "classytic-push",
-    "prepublishOnly": "npm run typecheck && npm run test && npm run build && npm run test:smoke",
-    "release": "npm run build && npm run typecheck && npm publish --access public"
-  },
-  "devDependencies": {
-    "@biomejs/biome": "^2.4.9",
-    "@classytic/dev-tools": "^0.2.0",
-    "@types/node": "^25.5.0",
-    "tsdown": "^0.21.7",
-    "typescript": "^5.7.0",
-    "vitest": "^3.0.0"
-  },
-  "keywords": [
-    "typescript",
-    "types",
-    "primitives",
-    "money",
-    "currency",
-    "pagination",
-    "domain-event",
-    "tenant",
-    "classytic",
-    "commerce"
-  ]
-}
+{
+  "name": "@classytic/primitives",
+  "version": "0.20.0",
+  "description": "Framework-agnostic TypeScript primitives shared across Classytic packages — Money, events, pagination, tenant config, and other building blocks.",
+  "author": "Classytic",
+  "license": "MIT",
+  "homepage": "https://www.npmjs.com/package/@classytic/primitives",
+  "bugs": {
+    "url": "https://github.com/classytic/primitives/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/classytic/primitives.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22"
+  },
+  "exports": {
+    "./money": {
+      "types": "./dist/money.d.mts",
+      "default": "./dist/money.mjs"
+    },
+    "./currency": {
+      "types": "./dist/currency.d.mts",
+      "default": "./dist/currency.mjs"
+    },
+    "./unit-cost-rate": {
+      "types": "./dist/unit-cost-rate.d.mts",
+      "default": "./dist/unit-cost-rate.mjs"
+    },
+    "./address": {
+      "types": "./dist/address.d.mts",
+      "default": "./dist/address.mjs"
+    },
+    "./period": {
+      "types": "./dist/period.d.mts",
+      "default": "./dist/period.mjs"
+    },
+    "./calendar": {
+      "types": "./dist/calendar.d.mts",
+      "default": "./dist/calendar.mjs"
+    },
+    "./timezone": {
+      "types": "./dist/timezone.d.mts",
+      "default": "./dist/timezone.mjs"
+    },
+    "./reference": {
+      "types": "./dist/reference.d.mts",
+      "default": "./dist/reference.mjs"
+    },
+    "./context": {
+      "types": "./dist/context.d.mts",
+      "default": "./dist/context.mjs"
+    },
+    "./events": {
+      "types": "./dist/events.d.mts",
+      "default": "./dist/events.mjs"
+    },
+    "./memory-outbox": {
+      "types": "./dist/memory-outbox.d.mts",
+      "default": "./dist/memory-outbox.mjs"
+    },
+    "./event-infra": {
+      "types": "./dist/event-infra.d.mts",
+      "default": "./dist/event-infra.mjs"
+    },
+    "./outbox": {
+      "types": "./dist/outbox.d.mts",
+      "default": "./dist/outbox.mjs"
+    },
+    "./result": {
+      "types": "./dist/result.d.mts",
+      "default": "./dist/result.mjs"
+    },
+    "./brand": {
+      "types": "./dist/brand.d.mts",
+      "default": "./dist/brand.mjs"
+    },
+    "./split-allocation": {
+      "types": "./dist/split-allocation.d.mts",
+      "default": "./dist/split-allocation.mjs"
+    },
+    "./approval": {
+      "types": "./dist/approval.d.mts",
+      "default": "./dist/approval.mjs"
+    },
+    "./idempotency": {
+      "types": "./dist/idempotency.d.mts",
+      "default": "./dist/idempotency.mjs"
+    },
+    "./cadence": {
+      "types": "./dist/cadence.d.mts",
+      "default": "./dist/cadence.mjs"
+    },
+    "./hold": {
+      "types": "./dist/hold.d.mts",
+      "default": "./dist/hold.mjs"
+    },
+    "./sla": {
+      "types": "./dist/sla.d.mts",
+      "default": "./dist/sla.mjs"
+    },
+    "./shelf-life": {
+      "types": "./dist/shelf-life.d.mts",
+      "default": "./dist/shelf-life.mjs"
+    },
+    "./person": {
+      "types": "./dist/person.d.mts",
+      "default": "./dist/person.mjs"
+    },
+    "./person-parse": {
+      "types": "./dist/person-parse.d.mts",
+      "default": "./dist/person-parse.mjs"
+    },
+    "./identity-verification": {
+      "types": "./dist/identity-verification.d.mts",
+      "default": "./dist/identity-verification.mjs"
+    },
+    "./otp": {
+      "types": "./dist/otp.d.mts",
+      "default": "./dist/otp.mjs"
+    },
+    "./state-machine": {
+      "types": "./dist/state-machine.d.mts",
+      "default": "./dist/state-machine.mjs"
+    },
+    "./bank-transaction": {
+      "types": "./dist/bank-transaction.d.mts",
+      "default": "./dist/bank-transaction.mjs"
+    },
+    "./payment-gateway": {
+      "types": "./dist/payment-gateway.d.mts",
+      "default": "./dist/payment-gateway.mjs"
+    },
+    "./payment-method-kind": {
+      "types": "./dist/payment-method-kind.d.mts",
+      "default": "./dist/payment-method-kind.mjs"
+    },
+    "./payment-allocation-status": {
+      "types": "./dist/payment-allocation-status.d.mts",
+      "default": "./dist/payment-allocation-status.mjs"
+    },
+    "./monetization": {
+      "types": "./dist/monetization.d.mts",
+      "default": "./dist/monetization.mjs"
+    },
+    "./proration": {
+      "types": "./dist/proration.d.mts",
+      "default": "./dist/proration.mjs"
+    },
+    "./payment-events": {
+      "types": "./dist/payment-events.d.mts",
+      "default": "./dist/payment-events.mjs"
+    },
+    "./phone": {
+      "types": "./dist/phone.d.mts",
+      "default": "./dist/phone.mjs"
+    },
+    "./status-history": {
+      "types": "./dist/status-history.d.mts",
+      "default": "./dist/status-history.mjs"
+    },
+    "./condition": {
+      "types": "./dist/condition.d.mts",
+      "default": "./dist/condition.mjs"
+    },
+    "./mixin": {
+      "types": "./dist/mixin.d.mts",
+      "default": "./dist/mixin.mjs"
+    },
+    "./sla-policy": {
+      "types": "./dist/sla-policy.d.mts",
+      "default": "./dist/sla-policy.mjs"
+    },
+    "./retention": {
+      "types": "./dist/retention.d.mts",
+      "default": "./dist/retention.mjs"
+    },
+    "./canonical": {
+      "types": "./dist/canonical.d.mts",
+      "default": "./dist/canonical.mjs"
+    },
+    "./package.json": "./package.json",
+    "./state-diagram": {
+      "types": "./dist/state-diagram.d.mts",
+      "default": "./dist/state-diagram.mjs"
+    },
+    "./suspension": {
+      "types": "./dist/suspension.d.mts",
+      "default": "./dist/suspension.mjs"
+    },
+    "./subject": {
+      "types": "./dist/subject.d.mts",
+      "default": "./dist/subject.mjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "typecheck": "tsc --noEmit",
+    "lint": "biome check src/ tests/",
+    "lint:fix": "biome check --write src/ tests/",
+    "test": "vitest run --project unit --project integration",
+    "test:unit": "vitest run --project unit",
+    "test:integration": "vitest run --project integration",
+    "test:all": "vitest run",
+    "test:watch": "vitest --project unit --project integration",
+    "test:smoke": "node tests/smoke/smoke.mjs",
+    "push": "classytic-push",
+    "prepublishOnly": "npm run typecheck && npm run test && npm run build && npm run test:smoke",
+    "release": "npm run build && npm run typecheck && npm publish --access public"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.4.9",
+    "@classytic/dev-tools": "^0.2.0",
+    "@types/node": "^25.5.0",
+    "tsdown": "^0.21.7",
+    "typescript": "^5.7.0",
+    "vitest": "^3.0.0"
+  },
+  "keywords": [
+    "typescript",
+    "types",
+    "primitives",
+    "money",
+    "currency",
+    "pagination",
+    "domain-event",
+    "tenant",
+    "classytic",
+    "commerce"
+  ]
+}

package/dist/currency-BCJnJBlb.d.mts

@@ -1,119 +0,0 @@
-import { t as Brand } from "./brand-LLXqoh5J.mjs";
-
-//#region src/money/currency.d.ts
-/**
- * ISO 4217 currency code (3 uppercase letters).
- *
- * Branded `string` — any 3-letter string is structurally valid, but the brand
- * prevents accidental mixing with raw strings. Use {@link toCurrencyCode} to
- * construct one safely.
- */
-type CurrencyCode = Brand<string, 'CurrencyCode'>;
-/**
- * Common ISO 4217 codes. Non-exhaustive — add more at the consumer level if
- * needed. Listed here because shared-types ships with these by default.
- */
-declare const CURRENCIES: {
-  readonly USD: "USD";
-  readonly EUR: "EUR";
-  readonly GBP: "GBP";
-  readonly JPY: "JPY";
-  readonly CNY: "CNY";
-  readonly INR: "INR";
-  readonly BDT: "BDT";
-  readonly AED: "AED";
-  readonly SAR: "SAR";
-  readonly PKR: "PKR";
-  readonly NPR: "NPR";
-  readonly LKR: "LKR";
-  readonly MYR: "MYR";
-  readonly SGD: "SGD";
-  readonly AUD: "AUD";
-  readonly CAD: "CAD";
-  readonly CHF: "CHF";
-  readonly HKD: "HKD";
-  readonly THB: "THB";
-  readonly IDR: "IDR";
-};
-/**
- * Number of minor units per major unit for common currencies.
- *
- * ISO 4217 defines most currencies with 2 decimal places (cents). A few are
- * zero-decimal (JPY, KRW) or three-decimal (BHD, KWD, JOD). When a currency
- * isn't in this table, {@link minorUnitFactor} returns 100 as the safe default.
- */
-declare const MINOR_UNIT_FACTOR: Readonly<Record<string, number>>;
-/**
- * ISO 4217 format — 3 uppercase letters. Exported so consumers can embed
- * the SAME pattern in JSON-Schema-representable validators (zod `.regex`,
- * Mongoose `match`, OpenAPI `pattern`) instead of hand-rolling a copy:
- * `.refine(isCurrencyCode)` validates at runtime but is dropped by
- * `z.toJSONSchema`, losing the constraint from generated API docs.
- * `isCurrencyCode` / `toCurrencyCode` remain the runtime API.
- */
-declare const CURRENCY_PATTERN: RegExp;
-/**
- * Narrow a raw string to a {@link CurrencyCode}. Returns `null` if the string
- * is not a valid ISO 4217 format (3 uppercase letters). This does not verify
- * the code is registered with ISO — use your own whitelist for that.
- */
-declare function toCurrencyCode(value: string): CurrencyCode | null;
-/** Type predicate for `unknown` input. */
-declare function isCurrencyCode(value: unknown): value is CurrencyCode;
-/**
- * Minor units per major unit (e.g. 100 for USD, 1 for JPY, 1000 for KWD).
- * Falls back to 100 when the currency is unknown — matches the ISO 4217 default.
- */
-declare function minorUnitFactor(currency: string): number;
-/**
- * Frozen FX conversion record — the cost of record for cross-currency
- * transactions. Stored alongside a base-currency amount at the seam where
- * currency crossed (procurement receipt, landed-cost entry, foreign refund).
- *
- * Invariant: once written, never mutated. Revaluation is a new snapshot on
- * a new document — rewriting an existing snapshot corrupts audit history.
- *
- * `rate` is expressed as: 1 sourceCurrency = rate * baseCurrency
- * (e.g. USD→BDT at 110 means rate = 110, so sourceAmount 10 USD → baseAmount 1100 BDT).
- * This matches how banks quote — the source is the "from" currency.
- */
-interface FxSnapshot {
-  /** Currency the transaction was invoiced / quoted in. ISO 4217. */
-  sourceCurrency: string;
-  /** Organisation's functional currency the base amount is expressed in. */
-  baseCurrency: string;
-  /** 1 unit of sourceCurrency equals this many units of baseCurrency. */
-  rate: number;
-  /** When the rate was captured — NOT when the document was last touched. */
-  snapshotAt: Date;
-  /**
-   * Optional provenance tag — e.g. 'manual', 'bangladesh-bank',
-   * 'openexchangerates.org', 'supplier-invoice'. Free-form; hosts use it for
-   * audit filtering and re-pricing policy.
-   */
-  source?: string;
-}
-/**
- * Apply an {@link FxSnapshot} to a source-currency amount. Returns the
- * equivalent base-currency amount. No rounding — callers that persist into
- * an integer minor-unit column must round explicitly with a deterministic
- * rule (`Math.round`, banker's rounding, floor for duty-conservative
- * postings, etc.).
- */
-declare function convertWithSnapshot(sourceAmount: number, fx: FxSnapshot): number;
-/**
- * Reverse an {@link FxSnapshot} — reconstruct the source-currency amount
- * from a stored base amount. Useful for reporting "cost in original
- * currency". Not round-trip safe under rounding; prefer storing the
- * original source amount alongside the base amount when audit fidelity
- * matters.
- */
-declare function reverseWithSnapshot(baseAmount: number, fx: FxSnapshot): number;
-/**
- * Structural validation — checks shape only. Does NOT verify the rate is
- * economically sensible (8.5 USD→BDT would pass this check). Host-level
- * guards / anomaly detection handle that.
- */
-declare function isFxSnapshot(value: unknown): value is FxSnapshot;
-//#endregion
-export { MINOR_UNIT_FACTOR as a, isFxSnapshot as c, toCurrencyCode as d, FxSnapshot as i, minorUnitFactor as l, CURRENCY_PATTERN as n, convertWithSnapshot as o, CurrencyCode as r, isCurrencyCode as s, CURRENCIES as t, reverseWithSnapshot as u };