@classytic/revenue 1.1.4 → 2.0.1

package/dist/audit-B39B0Sdq.mjs

@@ -0,0 +1,53 @@
+import { CurrencyMismatchError, absMoney, addMoney, compareMoney, equalsMoney, fromMajor, fromMajor as fromMajor$1, isMoney, isNegativeMoney, isPositiveMoney, isZeroMoney, money, money as money$1, multiplyMoney, negateMoney, subtractMoney, sumMoney, toMajor, toMajor as toMajor$1 } from "@classytic/primitives/money";
+import { CURRENCIES, MINOR_UNIT_FACTOR, isCurrencyCode, minorUnitFactor, toCurrencyCode } from "@classytic/primitives/currency";
+
+//#region src/shared/formatters/money.ts
+/**
+* Money — re-export from `@classytic/primitives/money`.
+*
+* Per PACKAGE_RULES P1/P12: `Money`, arithmetic, and currency metadata all
+* live in primitives. Revenue does NOT redefine them. This file re-exports
+* the canonical surface so hosts can still do
+* `import { Money, money, addMoney } from '@classytic/revenue'` without
+* adding primitives as a direct dependency.
+*
+* `toSmallestUnit` / `fromSmallestUnit` are thin wrappers over
+* `fromMajor` / `toMajor` kept for downstream compatibility (be-prod's
+* `operational-transactions.ts` imports them).
+*/
+/**
+* Convert a major-unit amount (e.g. 19.99 dollars) into the currency's
+* minor unit integer (e.g. 1999 cents). Wrapper over primitives' `fromMajor`.
+*/
+function toSmallestUnit(amount, currency = "USD") {
+	return fromMajor(amount, currency).amount;
+}
+/**
+* Convert a minor-unit integer (e.g. 1999 cents) back to its major-unit
+* representation (e.g. 19.99). Wrapper over primitives' `toMajor`.
+*/
+function fromSmallestUnit(amount, currency = "USD") {
+	return toMajor(money(amount, currency));
+}
+
+//#endregion
+//#region src/shared/audit.ts
+function appendAuditEvent(doc, event) {
+	const metadata = doc.metadata ?? {};
+	const auditTrail = metadata.auditTrail ?? [];
+	auditTrail.push(event);
+	return { metadata: {
+		...metadata,
+		auditTrail
+	} };
+}
+function getAuditTrail(doc) {
+	return doc.metadata?.auditTrail ?? [];
+}
+function getLastStateChange(doc) {
+	const trail = getAuditTrail(doc);
+	return trail[trail.length - 1];
+}
+
+//#endregion
+export { sumMoney as C, toSmallestUnit as E, subtractMoney as S, toMajor$1 as T, isZeroMoney as _, CurrencyMismatchError as a, multiplyMoney as b, addMoney as c, fromMajor$1 as d, fromSmallestUnit as f, isPositiveMoney as g, isNegativeMoney as h, CURRENCIES as i, compareMoney as l, isMoney as m, getAuditTrail as n, MINOR_UNIT_FACTOR as o, isCurrencyCode as p, getLastStateChange as r, absMoney as s, appendAuditEvent as t, equalsMoney as u, minorUnitFactor as v, toCurrencyCode as w, negateMoney as x, money$1 as y };

package/dist/audit-DZ0eTr9g.d.mts

@@ -0,0 +1,89 @@
+import { StateChangeEvent } from "./core/state-machines.mjs";
+import { CurrencyMismatchError, Money, Money as MoneyValue, absMoney, addMoney, compareMoney, equalsMoney, fromMajor as fromMajor$1, isMoney, isNegativeMoney, isPositiveMoney, isZeroMoney, money as money$1, multiplyMoney, negateMoney, subtractMoney, sumMoney, toMajor as toMajor$1 } from "@classytic/primitives/money";
+import { CURRENCIES, CurrencyCode, MINOR_UNIT_FACTOR, isCurrencyCode, minorUnitFactor, toCurrencyCode } from "@classytic/primitives/currency";
+
+//#region src/shared/calculators/commission.d.ts
+interface CommissionInfo {
+  rate: number;
+  grossAmount: number;
+  gatewayFeeRate: number;
+  gatewayFeeAmount: number;
+  netAmount: number;
+  status: string;
+}
+declare function calculateCommission(amount: number, commissionRate: number, gatewayFeeRate?: number): CommissionInfo | null;
+declare function reverseCommission(originalCommission: CommissionInfo | null | undefined, originalAmount: number, refundAmount: number): CommissionInfo | null;
+//#endregion
+//#region src/shared/calculators/tax.d.ts
+interface TaxConfig {
+  isRegistered: boolean;
+  defaultRate: number;
+  pricesIncludeTax: boolean;
+  exemptCategories?: string[];
+}
+interface TaxCalculation {
+  isApplicable: boolean;
+  rate: number;
+  baseAmount: number;
+  taxAmount: number;
+  totalAmount: number;
+  pricesIncludeTax: boolean;
+  type?: TaxType;
+}
+type TaxType = 'collected' | 'paid' | 'exempt';
+declare function calculateTax(amount: number, category: string, config: TaxConfig | null): TaxCalculation;
+declare function getTaxType(transactionFlow: 'inflow' | 'outflow', category: string, exemptCategories?: string[]): TaxType;
+declare function reverseTax(originalTax: TaxCalculation & {
+  type?: TaxType;
+}, originalAmount: number, refundAmount: number): TaxCalculation & {
+  type?: TaxType;
+};
+declare function validateTaxCalculation(tax: TaxCalculation): boolean;
+//#endregion
+//#region src/shared/calculators/splits.d.ts
+interface SplitRule {
+  type: string;
+  recipientId: string;
+  recipientType: string;
+  rate: number;
+}
+interface SplitInfo {
+  type: string;
+  recipientId: string;
+  recipientType: string;
+  rate: number;
+  grossAmount: number;
+  gatewayFeeRate: number;
+  gatewayFeeAmount: number;
+  netAmount: number;
+  status: string;
+}
+declare function calculateSplits(amount: number, rules: SplitRule[], gatewayFeeRate?: number): SplitInfo[];
+declare function calculateOrganizationPayout(amount: number, splits: SplitInfo[]): number;
+//#endregion
+//#region src/shared/formatters/money.d.ts
+/**
+ * Convert a major-unit amount (e.g. 19.99 dollars) into the currency's
+ * minor unit integer (e.g. 1999 cents). Wrapper over primitives' `fromMajor`.
+ */
+declare function toSmallestUnit(amount: number, currency?: string): number;
+/**
+ * Convert a minor-unit integer (e.g. 1999 cents) back to its major-unit
+ * representation (e.g. 19.99). Wrapper over primitives' `toMajor`.
+ */
+declare function fromSmallestUnit(amount: number, currency?: string): number;
+//#endregion
+//#region src/shared/audit.d.ts
+declare function appendAuditEvent<T extends {
+  metadata?: Record<string, unknown>;
+}>(doc: T, event: StateChangeEvent): {
+  metadata: Record<string, unknown>;
+};
+declare function getAuditTrail(doc: {
+  metadata?: Record<string, unknown>;
+}): StateChangeEvent[];
+declare function getLastStateChange(doc: {
+  metadata?: Record<string, unknown>;
+}): StateChangeEvent | undefined;
+//#endregion
+export { SplitInfo as A, validateTaxCalculation as B, multiplyMoney as C, toCurrencyCode as D, sumMoney as E, TaxConfig as F, calculateCommission as H, TaxType as I, calculateTax as L, calculateOrganizationPayout as M, calculateSplits as N, toMajor$1 as O, TaxCalculation as P, getTaxType as R, money$1 as S, subtractMoney as T, reverseCommission as U, CommissionInfo as V, isMoney as _, CurrencyCode as a, isZeroMoney as b, Money as c, addMoney as d, compareMoney as f, isCurrencyCode as g, fromSmallestUnit as h, CURRENCIES as i, SplitRule as j, toSmallestUnit as k, MoneyValue as l, fromMajor$1 as m, getAuditTrail as n, CurrencyMismatchError as o, equalsMoney as p, getLastStateChange as r, MINOR_UNIT_FACTOR as s, appendAuditEvent as t, absMoney as u, isNegativeMoney as v, negateMoney as w, minorUnitFactor as x, isPositiveMoney as y, reverseTax as z };

package/dist/bridges/index.d.mts

@@ -0,0 +1,2 @@
+import { a as CurrencyBridge, c as LedgerBridge, i as CustomerBridge, n as SourceBridge, o as NotificationBridge, r as AnalyticsBridge, s as TaxBridge, t as RevenueBridges } from "../revenue-bridges-sdlrR85c.mjs";
+export { type AnalyticsBridge, type CurrencyBridge, type CustomerBridge, type LedgerBridge, type NotificationBridge, type RevenueBridges, type SourceBridge, type TaxBridge };

package/dist/bridges/index.mjs

@@ -0,0 +1 @@
+export {  };

package/dist/context-DRqSeTPM.d.mts

@@ -0,0 +1,35 @@
+import { OperationContext } from "@classytic/primitives/context";
+
+//#region src/core/context.d.ts
+interface RevenueContext extends OperationContext {
+  /** Narrowed from primitives' `IdLike` to string. */
+  organizationId?: string;
+  /** Narrowed from primitives' `IdLike` to string. */
+  actorId?: string;
+  /** Actor roles for permission checks at the consumer level. */
+  roles?: string[];
+  /** Override currency for this operation. */
+  currency?: string;
+  /** Bridge-specific free-form context. */
+  custom?: Record<string, unknown>;
+  /**
+   * Platform-admin bypass for tenant scoping.
+   *
+   * When `true`, the `multiTenantPlugin` wired by `createRevenue` skips
+   * injecting the tenant filter/data field for this single call — so
+   * `repo.getAll({}, { _bypassTenant: true })` can span organizations for
+   * superadmin dashboards, audits, and cross-branch reports.
+   *
+   * **The repo does NOT authorize this flag.** Setting it is the caller's
+   * responsibility and MUST be gated behind a platform-role check at the
+   * route/service layer. Never forward this flag from untrusted input.
+   *
+   * Events, validation, soft-delete, and pagination all continue to fire —
+   * only the tenant policy is bypassed. Write paths (create/update/delete)
+   * still pick up `organizationId` from `ctx.organizationId` if provided,
+   * so cross-org mutations require an explicit per-doc tenant in `data`.
+   */
+  _bypassTenant?: boolean;
+}
+//#endregion
+export { RevenueContext as t };

package/dist/core/state-machines.d.mts

@@ -0,0 +1,53 @@
+import { C as SubscriptionStatusValue, F as SplitStatusValue, K as SettlementStatusValue, f as TransactionStatusValue, it as HoldStatusValue } from "../transaction.enums-u4MshXcL.mjs";
+
+//#region src/core/state-machines.d.ts
+/**
+ * Audit-trail event emitted by `validateAndCreateAuditEvent`.
+ *
+ * Revenue-specific shape — primitives' state-machine is intentionally
+ * ledger-agnostic, so the audit envelope stays here next to the consumers.
+ */
+interface StateChangeEvent<TState extends string = string> {
+  resourceType: string;
+  resourceId: string;
+  fromState: TState;
+  toState: TState;
+  changedAt: Date;
+  changedBy?: string;
+  reason?: string;
+  metadata?: Record<string, unknown>;
+}
+/**
+ * Revenue's typed state machine.
+ *
+ * Thin facade over `@classytic/primitives/state-machine`'s
+ * `defineStateMachine` — primitives owns the transition logic, revenue
+ * owns the API shape (`validate`, `getAllowedTransitions`,
+ * `validateAndCreateAuditEvent`) that the existing repos and tests
+ * depend on. Wires `InvalidStateTransitionError` through the primitive's
+ * `errorFactory` so thrown types are unchanged.
+ *
+ * The constructor still accepts `Map<TState, Set<TState>>` so existing
+ * instance definitions don't need to be rewritten.
+ */
+declare class StateMachine<TState extends string> {
+  private readonly inner;
+  constructor(transitions: Map<TState, Set<TState>>, resourceType: string);
+  validate(from: TState, to: TState, resourceId: string): void;
+  canTransition(from: TState, to: TState): boolean;
+  getAllowedTransitions(from: TState): TState[];
+  isTerminalState(state: TState): boolean;
+  getResourceType(): string;
+  validateAndCreateAuditEvent(from: TState, to: TState, resourceId: string, context?: {
+    changedBy?: string;
+    reason?: string;
+    metadata?: Record<string, unknown>;
+  }): StateChangeEvent<TState>;
+}
+declare const TRANSACTION_STATE_MACHINE: StateMachine<TransactionStatusValue>;
+declare const SUBSCRIPTION_STATE_MACHINE: StateMachine<SubscriptionStatusValue>;
+declare const SETTLEMENT_STATE_MACHINE: StateMachine<SettlementStatusValue>;
+declare const HOLD_STATE_MACHINE: StateMachine<HoldStatusValue>;
+declare const SPLIT_STATE_MACHINE: StateMachine<SplitStatusValue>;
+//#endregion
+export { HOLD_STATE_MACHINE, SETTLEMENT_STATE_MACHINE, SPLIT_STATE_MACHINE, SUBSCRIPTION_STATE_MACHINE, StateChangeEvent, StateMachine, TRANSACTION_STATE_MACHINE };

package/dist/core/state-machines.mjs

@@ -0,0 +1,153 @@
+import { F as TRANSACTION_STATUS, g as SETTLEMENT_STATUS, l as SPLIT_STATUS, r as SUBSCRIPTION_STATUS, w as HOLD_STATUS } from "../subscription.enums-tfoAgsTv.mjs";
+import { r as InvalidStateTransitionError } from "../errors-DHa8JVQ-.mjs";
+import { defineStateMachine } from "@classytic/primitives/state-machine";
+
+//#region src/core/state-machines.ts
+/**
+* Revenue's typed state machine.
+*
+* Thin facade over `@classytic/primitives/state-machine`'s
+* `defineStateMachine` — primitives owns the transition logic, revenue
+* owns the API shape (`validate`, `getAllowedTransitions`,
+* `validateAndCreateAuditEvent`) that the existing repos and tests
+* depend on. Wires `InvalidStateTransitionError` through the primitive's
+* `errorFactory` so thrown types are unchanged.
+*
+* The constructor still accepts `Map<TState, Set<TState>>` so existing
+* instance definitions don't need to be rewritten.
+*/
+var StateMachine = class {
+	inner;
+	constructor(transitions, resourceType) {
+		const record = {};
+		for (const [from, toSet] of transitions.entries()) record[from] = Array.from(toSet);
+		this.inner = defineStateMachine({
+			name: resourceType,
+			transitions: record,
+			errorFactory: ({ entityId, from, to }) => new InvalidStateTransitionError(resourceType, entityId, from, to)
+		});
+	}
+	validate(from, to, resourceId) {
+		this.inner.assertTransition(resourceId, from, to);
+	}
+	canTransition(from, to) {
+		return this.inner.canTransition(from, to);
+	}
+	getAllowedTransitions(from) {
+		return [...this.inner.transitions[from] ?? []];
+	}
+	isTerminalState(state) {
+		return this.inner.isTerminal(state);
+	}
+	getResourceType() {
+		return this.inner.name;
+	}
+	validateAndCreateAuditEvent(from, to, resourceId, context) {
+		this.validate(from, to, resourceId);
+		return {
+			resourceType: this.inner.name,
+			resourceId,
+			fromState: from,
+			toState: to,
+			changedAt: /* @__PURE__ */ new Date(),
+			changedBy: context?.changedBy,
+			reason: context?.reason,
+			metadata: context?.metadata
+		};
+	}
+};
+const TRANSACTION_STATE_MACHINE = new StateMachine(new Map([
+	[TRANSACTION_STATUS.PENDING, new Set([
+		TRANSACTION_STATUS.PAYMENT_INITIATED,
+		TRANSACTION_STATUS.PROCESSING,
+		TRANSACTION_STATUS.VERIFIED,
+		TRANSACTION_STATUS.FAILED,
+		TRANSACTION_STATUS.CANCELLED
+	])],
+	[TRANSACTION_STATUS.PAYMENT_INITIATED, new Set([
+		TRANSACTION_STATUS.PROCESSING,
+		TRANSACTION_STATUS.VERIFIED,
+		TRANSACTION_STATUS.REQUIRES_ACTION,
+		TRANSACTION_STATUS.FAILED,
+		TRANSACTION_STATUS.CANCELLED
+	])],
+	[TRANSACTION_STATUS.PROCESSING, new Set([
+		TRANSACTION_STATUS.VERIFIED,
+		TRANSACTION_STATUS.REQUIRES_ACTION,
+		TRANSACTION_STATUS.FAILED
+	])],
+	[TRANSACTION_STATUS.REQUIRES_ACTION, new Set([
+		TRANSACTION_STATUS.VERIFIED,
+		TRANSACTION_STATUS.FAILED,
+		TRANSACTION_STATUS.CANCELLED,
+		TRANSACTION_STATUS.EXPIRED
+	])],
+	[TRANSACTION_STATUS.VERIFIED, new Set([
+		TRANSACTION_STATUS.COMPLETED,
+		TRANSACTION_STATUS.REFUNDED,
+		TRANSACTION_STATUS.PARTIALLY_REFUNDED,
+		TRANSACTION_STATUS.CANCELLED
+	])],
+	[TRANSACTION_STATUS.COMPLETED, new Set([TRANSACTION_STATUS.REFUNDED, TRANSACTION_STATUS.PARTIALLY_REFUNDED])],
+	[TRANSACTION_STATUS.PARTIALLY_REFUNDED, new Set([TRANSACTION_STATUS.REFUNDED])],
+	[TRANSACTION_STATUS.FAILED, /* @__PURE__ */ new Set([])],
+	[TRANSACTION_STATUS.REFUNDED, /* @__PURE__ */ new Set([])],
+	[TRANSACTION_STATUS.CANCELLED, /* @__PURE__ */ new Set([])],
+	[TRANSACTION_STATUS.EXPIRED, /* @__PURE__ */ new Set([])]
+]), "transaction");
+const SUBSCRIPTION_STATE_MACHINE = new StateMachine(new Map([
+	[SUBSCRIPTION_STATUS.PENDING, new Set([SUBSCRIPTION_STATUS.ACTIVE, SUBSCRIPTION_STATUS.CANCELLED])],
+	[SUBSCRIPTION_STATUS.ACTIVE, new Set([
+		SUBSCRIPTION_STATUS.PAUSED,
+		SUBSCRIPTION_STATUS.PENDING_RENEWAL,
+		SUBSCRIPTION_STATUS.CANCELLED,
+		SUBSCRIPTION_STATUS.EXPIRED
+	])],
+	[SUBSCRIPTION_STATUS.PENDING_RENEWAL, new Set([
+		SUBSCRIPTION_STATUS.ACTIVE,
+		SUBSCRIPTION_STATUS.CANCELLED,
+		SUBSCRIPTION_STATUS.EXPIRED
+	])],
+	[SUBSCRIPTION_STATUS.PAUSED, new Set([SUBSCRIPTION_STATUS.ACTIVE, SUBSCRIPTION_STATUS.CANCELLED])],
+	[SUBSCRIPTION_STATUS.INACTIVE, new Set([SUBSCRIPTION_STATUS.ACTIVE, SUBSCRIPTION_STATUS.CANCELLED])],
+	[SUBSCRIPTION_STATUS.CANCELLED, /* @__PURE__ */ new Set([])],
+	[SUBSCRIPTION_STATUS.EXPIRED, /* @__PURE__ */ new Set([])]
+]), "subscription");
+const SETTLEMENT_STATE_MACHINE = new StateMachine(new Map([
+	[SETTLEMENT_STATUS.PENDING, new Set([SETTLEMENT_STATUS.PROCESSING, SETTLEMENT_STATUS.CANCELLED])],
+	[SETTLEMENT_STATUS.PROCESSING, new Set([SETTLEMENT_STATUS.COMPLETED, SETTLEMENT_STATUS.FAILED])],
+	[SETTLEMENT_STATUS.FAILED, new Set([SETTLEMENT_STATUS.PENDING, SETTLEMENT_STATUS.CANCELLED])],
+	[SETTLEMENT_STATUS.COMPLETED, /* @__PURE__ */ new Set([])],
+	[SETTLEMENT_STATUS.CANCELLED, /* @__PURE__ */ new Set([])]
+]), "settlement");
+const HOLD_STATE_MACHINE = new StateMachine(new Map([
+	[HOLD_STATUS.HELD, new Set([
+		HOLD_STATUS.RELEASED,
+		HOLD_STATUS.PARTIALLY_RELEASED,
+		HOLD_STATUS.CANCELLED,
+		HOLD_STATUS.EXPIRED
+	])],
+	[HOLD_STATUS.PARTIALLY_RELEASED, new Set([HOLD_STATUS.RELEASED, HOLD_STATUS.CANCELLED])],
+	[HOLD_STATUS.RELEASED, /* @__PURE__ */ new Set([])],
+	[HOLD_STATUS.CANCELLED, /* @__PURE__ */ new Set([])],
+	[HOLD_STATUS.EXPIRED, /* @__PURE__ */ new Set([])]
+]), "escrow_hold");
+const SPLIT_STATE_MACHINE = new StateMachine(new Map([
+	[SPLIT_STATUS.PENDING, new Set([
+		SPLIT_STATUS.DUE,
+		SPLIT_STATUS.PAID,
+		SPLIT_STATUS.WAIVED,
+		SPLIT_STATUS.CANCELLED
+	])],
+	[SPLIT_STATUS.DUE, new Set([
+		SPLIT_STATUS.PAID,
+		SPLIT_STATUS.WAIVED,
+		SPLIT_STATUS.CANCELLED
+	])],
+	[SPLIT_STATUS.PAID, /* @__PURE__ */ new Set([])],
+	[SPLIT_STATUS.WAIVED, /* @__PURE__ */ new Set([])],
+	[SPLIT_STATUS.CANCELLED, /* @__PURE__ */ new Set([])]
+]), "split");
+
+//#endregion
+export { HOLD_STATE_MACHINE, SETTLEMENT_STATE_MACHINE, SPLIT_STATE_MACHINE, SUBSCRIPTION_STATE_MACHINE, StateMachine, TRANSACTION_STATE_MACHINE };