@classytic/revenue 1.1.2 → 1.1.3

package/dist/index-Dsp7H5Wb.d.mts

@@ -0,0 +1,471 @@
+import { Types } from "mongoose";
+import { HoldInfo, ITransaction, ITransactionCreateInput } from "@classytic/shared-types";
+
+//#region src/shared/types/index.d.ts
+/** ObjectId type from Mongoose */
+type ObjectId = Types.ObjectId;
+/** Generic Mongoose model interface - simplified for compatibility */
+interface MongooseModel<T = unknown> {
+  findById(id: string | ObjectId): Promise<T | null>;
+  find(filter?: object): unknown;
+  findOne(filter?: object): Promise<T | null>;
+  create(data: Partial<T> | Record<string, unknown>): Promise<T>;
+  countDocuments?(filter?: object): Promise<number>;
+  count?(filter?: object): Promise<number>;
+  findByIdAndUpdate(id: string | ObjectId, update: object, options?: object): Promise<T | null>;
+  update?(id: string, data: object): Promise<T | null>;
+}
+/** Transaction status values */
+type TransactionStatusValue = 'pending' | 'payment_initiated' | 'processing' | 'requires_action' | 'verified' | 'completed' | 'failed' | 'cancelled' | 'expired' | 'refunded' | 'partially_refunded';
+/** Transaction flow values - directional money movement */
+type TransactionFlowValue = 'inflow' | 'outflow';
+/** Gateway information stored on transaction */
+interface TransactionGateway {
+  type: string;
+  sessionId?: string | null;
+  paymentIntentId?: string | null;
+  provider?: string;
+  metadata?: Record<string, unknown>;
+  verificationData?: Record<string, unknown>;
+}
+/** Commission information */
+interface CommissionInfo {
+  rate: number;
+  grossAmount: number;
+  gatewayFeeRate: number;
+  gatewayFeeAmount: number;
+  netAmount: number;
+  status: 'pending' | 'paid' | 'waived';
+  splits?: SplitInfo[];
+  affiliate?: {
+    recipientId: string;
+    recipientType: string;
+    rate: number;
+    grossAmount: number;
+    netAmount: number;
+  };
+}
+/** Webhook information */
+interface WebhookInfo {
+  eventId: string;
+  eventType: string;
+  receivedAt: Date;
+  processedAt?: Date;
+  data: Record<string, unknown>;
+}
+/**
+ * Base transaction document interface
+ * Note: Implements unified transaction model (compatible with ITransaction but doesn't extend it)
+ */
+interface TransactionDocument {
+  _id: ObjectId;
+  organizationId: string | ObjectId;
+  customerId?: string | ObjectId | null;
+  type: string;
+  flow: TransactionFlowValue;
+  tags?: string[];
+  status: TransactionStatusValue;
+  amount: number;
+  currency: string;
+  fee?: number;
+  tax?: number;
+  net: number;
+  taxDetails?: {
+    type?: 'sales_tax' | 'vat' | 'gst' | 'income_tax' | 'withholding_tax' | 'none';
+    rate?: number;
+    isInclusive?: boolean;
+    jurisdiction?: string;
+  };
+  method: string;
+  gateway?: TransactionGateway;
+  paymentDetails?: Record<string, unknown>;
+  commission?: CommissionInfo | null;
+  splits?: SplitInfo[];
+  hold?: HoldInfo;
+  escrow?: HoldInfo;
+  sourceId?: string | ObjectId;
+  sourceModel?: string;
+  relatedTransactionId?: ObjectId;
+  category?: string;
+  date?: Date;
+  verifiedAt?: Date;
+  verifiedBy?: string | ObjectId | null;
+  failedAt?: Date;
+  failureReason?: string;
+  refundedAmount?: number;
+  refundedAt?: Date;
+  createdAt: Date;
+  updatedAt: Date;
+  webhook?: WebhookInfo;
+  metadata?: Record<string, unknown>;
+  idempotencyKey?: string;
+  save(options?: {
+    session?: any;
+  }): Promise<this>;
+}
+/** Subscription status values */
+type SubscriptionStatusValue = 'active' | 'paused' | 'cancelled' | 'expired' | 'pending' | 'inactive' | 'pending_renewal';
+/** Plan key values */
+type PlanKeyValue = 'monthly' | 'quarterly' | 'yearly' | string;
+/** Base subscription document interface */
+interface SubscriptionDocument {
+  _id: ObjectId;
+  organizationId?: string | ObjectId;
+  customerId?: string | ObjectId | null;
+  planKey: PlanKeyValue;
+  amount: number;
+  currency: string;
+  status: SubscriptionStatusValue;
+  isActive: boolean;
+  gateway?: string;
+  transactionId?: ObjectId | null;
+  paymentIntentId?: string | null;
+  startDate?: Date;
+  endDate?: Date;
+  activatedAt?: Date;
+  canceledAt?: Date;
+  cancelAt?: Date;
+  cancellationReason?: string | null;
+  pausedAt?: Date | null;
+  pauseReason?: string | null;
+  renewalCount?: number;
+  renewalTransactionId?: ObjectId;
+  metadata?: Record<string, unknown>;
+  createdAt: Date;
+  updatedAt: Date;
+  save(): Promise<this>;
+}
+/** Monetization type values */
+type MonetizationTypeValue = 'free' | 'purchase' | 'subscription';
+/** Hold reason values */
+type HoldReasonValue = 'payment_verification' | 'fraud_check' | 'manual_review' | 'dispute' | 'compliance';
+/** Release reason values */
+type ReleaseReasonValue = 'payment_verified' | 'manual_release' | 'auto_release' | 'dispute_resolved';
+/** Split type values */
+type SplitTypeValue = 'platform_commission' | 'affiliate_commission' | 'referral_commission' | 'partner_commission' | 'custom';
+/** Split status values */
+type SplitStatusValue = 'pending' | 'due' | 'paid' | 'waived' | 'cancelled';
+/** Split rule configuration */
+interface SplitRule {
+  type?: SplitTypeValue;
+  recipientId: string;
+  recipientType: string;
+  rate: number;
+  dueDate?: Date | null;
+  metadata?: Record<string, unknown>;
+}
+/** Calculated split info */
+interface SplitInfo {
+  _id?: ObjectId;
+  type: SplitTypeValue;
+  recipientId: string;
+  recipientType: string;
+  rate: number;
+  grossAmount: number;
+  gatewayFeeRate: number;
+  gatewayFeeAmount: number;
+  netAmount: number;
+  status: SplitStatusValue;
+  dueDate?: Date | null;
+  paidDate?: Date;
+  payoutTransactionId?: string;
+  metadata: Record<string, unknown>;
+}
+/** Payment intent parameters */
+interface CreateIntentParams {
+  amount: number;
+  currency?: string;
+  metadata?: Record<string, unknown>;
+}
+/** Payment intent data */
+interface PaymentIntentData {
+  id: string;
+  sessionId?: string | null;
+  paymentIntentId?: string | null;
+  provider: string;
+  status: string;
+  amount: number;
+  currency?: string;
+  metadata?: Record<string, unknown>;
+  clientSecret?: string;
+  paymentUrl?: string;
+  instructions?: string;
+  raw?: unknown;
+}
+/** Payment result data */
+interface PaymentResultData {
+  id: string;
+  provider: string;
+  status: 'succeeded' | 'failed' | 'processing' | 'requires_action';
+  amount?: number;
+  currency?: string;
+  paidAt?: Date;
+  metadata?: Record<string, unknown>;
+  raw?: unknown;
+}
+/** Refund result data */
+interface RefundResultData {
+  id: string;
+  provider: string;
+  status: 'succeeded' | 'failed' | 'processing';
+  amount?: number;
+  currency?: string;
+  refundedAt?: Date;
+  reason?: string;
+  metadata?: Record<string, unknown>;
+  raw?: unknown;
+}
+/** Webhook event data */
+interface WebhookEventData {
+  id: string;
+  provider: string;
+  type: string;
+  data: {
+    sessionId?: string;
+    paymentIntentId?: string;
+    [key: string]: unknown;
+  };
+  createdAt?: Date;
+  raw?: unknown;
+}
+/** Provider capabilities */
+interface ProviderCapabilities {
+  supportsWebhooks: boolean;
+  supportsRefunds: boolean;
+  supportsPartialRefunds: boolean;
+  requiresManualVerification: boolean;
+}
+/** Logger interface */
+interface Logger {
+  info(...args: unknown[]): void;
+  warn(...args: unknown[]): void;
+  error(...args: unknown[]): void;
+  debug(...args: unknown[]): void;
+  log?(...args: unknown[]): void;
+}
+/** Revenue configuration */
+interface RevenueConfig {
+  targetModels: string[];
+  categoryMappings: Record<string, string>;
+  commissionRates?: Record<string, number>;
+  gatewayFeeRates?: Record<string, number>;
+  /** Maps transaction categories to flow direction (inflow/outflow) */
+  transactionTypeMapping?: Record<string, TransactionFlowValue>;
+}
+/** Payment provider interface */
+interface PaymentProviderInterface {
+  name: string;
+  config: Record<string, unknown>;
+  createIntent(params: CreateIntentParams): Promise<PaymentIntentData>;
+  verifyPayment(intentId: string): Promise<PaymentResultData>;
+  getStatus(intentId: string): Promise<PaymentResultData>;
+  refund(paymentId: string, amount?: number | null, options?: {
+    reason?: string;
+  }): Promise<RefundResultData>;
+  handleWebhook(payload: unknown, headers?: Record<string, string>): Promise<WebhookEventData>;
+  verifyWebhookSignature(payload: unknown, signature: string): boolean;
+  getCapabilities(): ProviderCapabilities;
+}
+/** Monetization create data */
+interface MonetizationData {
+  organizationId?: string | ObjectId;
+  customerId?: string | ObjectId;
+  sourceId?: string | ObjectId;
+  sourceModel?: string;
+}
+/** Monetization create params */
+interface MonetizationCreateParams {
+  data: MonetizationData;
+  planKey: string;
+  amount: number;
+  currency?: string;
+  gateway?: string;
+  entity?: string | null;
+  monetizationType?: MonetizationTypeValue;
+  paymentData?: Record<string, unknown>;
+  metadata?: Record<string, unknown>;
+  idempotencyKey?: string | null;
+  /** Tax data injected by tax plugin (optional) */
+  tax?: {
+    isApplicable: boolean;
+    rate: number;
+    baseAmount: number;
+    taxAmount: number;
+    totalAmount: number;
+    pricesIncludeTax: boolean;
+    type: 'collected' | 'paid' | 'exempt';
+  };
+}
+/** Monetization create result */
+interface MonetizationCreateResult {
+  subscription: SubscriptionDocument | null;
+  transaction: TransactionDocument | null;
+  paymentIntent: PaymentIntentData | null;
+}
+/** Activation options */
+interface ActivateOptions {
+  timestamp?: Date;
+}
+/** Renewal params */
+interface RenewalParams {
+  gateway?: string;
+  entity?: string | null;
+  paymentData?: Record<string, unknown>;
+  metadata?: Record<string, unknown>;
+  idempotencyKey?: string | null;
+}
+/** Cancellation options */
+interface CancelOptions {
+  immediate?: boolean;
+  reason?: string | null;
+}
+/** Pause options */
+interface PauseOptions {
+  reason?: string | null;
+}
+/** Resume options */
+interface ResumeOptions {
+  extendPeriod?: boolean;
+}
+/** List options */
+interface ListOptions {
+  limit?: number;
+  skip?: number;
+  page?: number | null;
+  sort?: Record<string, 1 | -1>;
+  populate?: string[];
+}
+/** Payment verify options */
+interface PaymentVerifyOptions {
+  verifiedBy?: string | null;
+}
+/** Payment verify result */
+interface PaymentVerifyResult {
+  transaction: TransactionDocument;
+  paymentResult: PaymentResultData | null;
+  status: TransactionStatusValue;
+}
+/** Payment status result */
+interface PaymentStatusResult {
+  transaction: TransactionDocument;
+  paymentResult?: PaymentResultData | null;
+  status: TransactionStatusValue | string;
+  provider?: string;
+}
+/** Refund options */
+interface RefundOptions {
+  reason?: string | null;
+}
+/** Payment refund result */
+interface PaymentRefundResult {
+  transaction: TransactionDocument;
+  refundTransaction: TransactionDocument;
+  refundResult: RefundResultData;
+  status: TransactionStatusValue;
+}
+/** Webhook result */
+interface WebhookResult {
+  event: WebhookEventData;
+  transaction: TransactionDocument;
+  status: 'processed' | 'already_processed';
+}
+/** Transaction list result */
+interface TransactionListResult {
+  transactions: TransactionDocument[];
+  total: number;
+  page: number;
+  limit: number;
+  pages: number;
+}
+/** Hold options */
+interface HoldOptions {
+  reason?: HoldReasonValue;
+  holdUntil?: Date | null;
+  metadata?: Record<string, unknown>;
+}
+/** Release options */
+interface ReleaseOptions {
+  amount?: number | null;
+  recipientId: string;
+  recipientType?: string;
+  reason?: ReleaseReasonValue;
+  releasedBy?: string | null;
+  createTransaction?: boolean;
+  metadata?: Record<string, unknown>;
+}
+/** Release result */
+interface ReleaseResult {
+  transaction: TransactionDocument;
+  releaseTransaction: TransactionDocument | null;
+  releaseAmount: number;
+  isFullRelease: boolean;
+  isPartialRelease: boolean;
+}
+/** Cancel hold options */
+interface CancelHoldOptions {
+  reason?: string;
+  metadata?: Record<string, unknown>;
+}
+/** Split result */
+interface SplitResult {
+  transaction: TransactionDocument;
+  splits: SplitInfo[];
+  splitTransactions: TransactionDocument[];
+  organizationTransaction: TransactionDocument | null;
+  organizationPayout: number;
+}
+/** Escrow status result */
+interface EscrowStatusResult {
+  transaction: TransactionDocument;
+  hold: HoldInfo | null;
+  splits: SplitInfo[];
+  hasHold: boolean;
+  hasSplits: boolean;
+}
+/** Period range params */
+interface PeriodRangeParams {
+  currentEndDate?: Date | null;
+  startDate?: Date | null;
+  duration: number;
+  unit?: 'days' | 'weeks' | 'months' | 'years';
+  now?: Date;
+}
+/** Period range result */
+interface PeriodRangeResult {
+  startDate: Date;
+  endDate: Date;
+}
+/** Prorated amount params */
+interface ProratedAmountParams {
+  amountPaid: number;
+  startDate: Date;
+  endDate: Date;
+  asOfDate?: Date;
+  precision?: number;
+}
+/** Duration result */
+interface DurationResult {
+  duration: number;
+  unit: 'days' | 'weeks' | 'months' | 'years';
+}
+/** Subscription entity for action checks */
+interface SubscriptionEntity {
+  subscription?: {
+    isActive?: boolean;
+    endDate?: Date;
+    canceledAt?: Date;
+  };
+  status?: SubscriptionStatusValue;
+}
+/** Transaction type detection options */
+interface TransactionTypeOptions {
+  targetModels?: string[];
+  additionalCategories?: string[];
+}
+/** Field update validation result */
+interface FieldUpdateValidationResult {
+  allowed: boolean;
+  reason?: string;
+}
+//#endregion
+export { ReleaseOptions as A, TransactionDocument as B, PaymentVerifyResult as C, ProviderCapabilities as D, ProratedAmountParams as E, SplitInfo as F, WebhookResult as G, TransactionListResult as H, SplitResult as I, ITransaction as K, SplitRule as L, RenewalParams as M, ResumeOptions as N, RefundOptions as O, RevenueConfig as P, SubscriptionDocument as R, PaymentVerifyOptions as S, PeriodRangeResult as T, TransactionTypeOptions as U, TransactionFlowValue as V, WebhookEventData as W, PaymentIntentData as _, CreateIntentParams as a, PaymentResultData as b, FieldUpdateValidationResult as c, Logger as d, MonetizationCreateParams as f, PauseOptions as g, MongooseModel as h, CommissionInfo as i, ReleaseResult as j, RefundResultData as k, HoldOptions as l, MonetizationTypeValue as m, CancelHoldOptions as n, DurationResult as o, MonetizationCreateResult as p, ITransactionCreateInput as q, CancelOptions as r, EscrowStatusResult as s, ActivateOptions as t, ListOptions as u, PaymentProviderInterface as v, PeriodRangeParams as w, PaymentStatusResult as x, PaymentRefundResult as y, SubscriptionEntity as z };

package/dist/index.d.mts

@@ -0,0 +1,9 @@
+import "./settlement.service-BxuiHpNC.mjs";
+import { K as ITransaction, q as ITransactionCreateInput } from "./index-Dsp7H5Wb.mjs";
+import "./settlement.schema-D5uWB5tP.mjs";
+import { a as WebhookEvent, i as RefundResult, n as PaymentProvider, r as PaymentResult, t as PaymentIntent } from "./base-CsTlVQJe.mjs";
+import "./plugin-BbK0OVHy.mjs";
+import { S as unwrapOr, c as Ok, d as err, l as Result, m as isOk, p as isErr, s as Err, v as ok, x as unwrap } from "./retry-HHCOXYdn.mjs";
+import { A as SUBSCRIPTION_STATE_MACHINE, B as Revenue, C as TransactionNotFoundError, D as HOLD_STATE_MACHINE, E as isRevenueError, F as filterAuditTrail, H as RevenueOptions, I as getAuditTrail, L as getLastStateChange, M as StateMachine, N as StateChangeEvent, O as SETTLEMENT_STATE_MACHINE, P as appendAuditEvent, R as ModelsConfig, S as SubscriptionNotFoundError, T as isRetryable, U as createRevenue, V as RevenueBuilder, _ as RefundNotSupportedError, a as InvalidAmountError, b as StateError, c as ModelNotRegisteredError, d as PaymentIntentCreationError, f as PaymentVerificationError, g as RefundError, h as ProviderNotFoundError, i as ErrorCode, j as TRANSACTION_STATE_MACHINE, k as SPLIT_STATE_MACHINE, l as NotFoundError, m as ProviderError, n as ConfigurationError, o as InvalidStateTransitionError, p as ProviderCapabilityError, r as ERROR_CODES, s as MissingRequiredFieldError, t as AlreadyVerifiedError, u as OperationError, v as RevenueError, w as ValidationError, x as SubscriptionNotActiveError, y as RevenueErrorOptions, z as ProvidersConfig } from "./errors-CorrWz7A.mjs";
+import { i as toSmallestUnit, n as MoneyValue, r as fromSmallestUnit, t as Money } from "./money-DPG8AtJ8.mjs";
+export { AlreadyVerifiedError, ConfigurationError, ERROR_CODES, type Err, ErrorCode, HOLD_STATE_MACHINE, type ITransaction, type ITransactionCreateInput, InvalidAmountError, InvalidStateTransitionError, MissingRequiredFieldError, ModelNotRegisteredError, type ModelsConfig, Money, type MoneyValue, NotFoundError, type Ok, OperationError, PaymentIntent, PaymentIntentCreationError, PaymentProvider, PaymentResult, PaymentVerificationError, ProviderCapabilityError, ProviderError, ProviderNotFoundError, type ProvidersConfig, RefundError, RefundNotSupportedError, RefundResult, Result, Revenue, RevenueBuilder, RevenueError, RevenueErrorOptions, type RevenueOptions, SETTLEMENT_STATE_MACHINE, SPLIT_STATE_MACHINE, SUBSCRIPTION_STATE_MACHINE, type StateChangeEvent, StateError, StateMachine, SubscriptionNotActiveError, SubscriptionNotFoundError, TRANSACTION_STATE_MACHINE, TransactionNotFoundError, ValidationError, WebhookEvent, appendAuditEvent, createRevenue, err, filterAuditTrail, fromSmallestUnit, getAuditTrail, getLastStateChange, isErr, isOk, isRetryable, isRevenueError, ok, toSmallestUnit, unwrap, unwrapOr };

package/dist/index.mjs

@@ -0,0 +1,38 @@
+import { n as RevenueBuilder, r as createRevenue, t as Revenue } from "./revenue-9scqKSef.mjs";
+import { S as unwrapOr, d as err, l as Result, m as isOk, p as isErr, v as ok, x as unwrap } from "./commission-split-BzB8cd39.mjs";
+import { C as ValidationError, S as TransactionNotFoundError, T as isRevenueError, _ as RefundNotSupportedError, a as InvalidAmountError, b as SubscriptionNotActiveError, c as ModelNotRegisteredError, d as PaymentIntentCreationError, f as PaymentVerificationError, g as RefundError, h as ProviderNotFoundError, i as ERROR_CODES, l as NotFoundError, m as ProviderError, n as AlreadyVerifiedError, o as InvalidStateTransitionError, p as ProviderCapabilityError, r as ConfigurationError, s as MissingRequiredFieldError, u as OperationError, v as RevenueError, w as isRetryable, x as SubscriptionNotFoundError, y as StateError } from "./category-resolver-DV83N8ok.mjs";
+import { c as getAuditTrail, d as SETTLEMENT_STATE_MACHINE, f as SPLIT_STATE_MACHINE, h as StateMachine, l as getLastStateChange, m as TRANSACTION_STATE_MACHINE, o as appendAuditEvent, p as SUBSCRIPTION_STATE_MACHINE, s as filterAuditTrail, u as HOLD_STATE_MACHINE } from "./settlement.service-CUxbUTzT.mjs";
+import { a as WebhookEvent, i as RefundResult, n as PaymentProvider, r as PaymentResult, t as PaymentIntent } from "./base-DCoyIUj6.mjs";
+import { n as fromSmallestUnit, r as toSmallestUnit, t as Money } from "./money-CvrDOijQ.mjs";
+
+//#region src/index.ts
+/**
+* For advanced features, import from submodules:
+*
+* @example
+* ```ts
+* // Plugins
+* import { loggingPlugin, auditPlugin, createTaxPlugin } from '@classytic/revenue/plugins';
+*
+* // Enums
+* import { TRANSACTION_STATUS, PAYMENT_STATUS } from '@classytic/revenue/enums';
+*
+* // Events
+* import { EventBus, type RevenueEvents } from '@classytic/revenue/events';
+*
+* // Schemas
+* import { CreatePaymentSchema, transactionSchema } from '@classytic/revenue/schemas';
+*
+* // Utilities
+* import { retry, calculateCommission } from '@classytic/revenue/utils';
+*
+* // Services (advanced)
+* import { MonetizationService } from '@classytic/revenue/services';
+*
+* // Reconciliation
+* import { reconcileSettlement } from '@classytic/revenue/reconciliation';
+* ```
+*/
+
+//#endregion
+export { AlreadyVerifiedError, ConfigurationError, ERROR_CODES, HOLD_STATE_MACHINE, InvalidAmountError, InvalidStateTransitionError, MissingRequiredFieldError, ModelNotRegisteredError, Money, NotFoundError, OperationError, PaymentIntent, PaymentIntentCreationError, PaymentProvider, PaymentResult, PaymentVerificationError, ProviderCapabilityError, ProviderError, ProviderNotFoundError, RefundError, RefundNotSupportedError, RefundResult, Result, Revenue, RevenueBuilder, RevenueError, SETTLEMENT_STATE_MACHINE, SPLIT_STATE_MACHINE, SUBSCRIPTION_STATE_MACHINE, StateError, StateMachine, SubscriptionNotActiveError, SubscriptionNotFoundError, TRANSACTION_STATE_MACHINE, TransactionNotFoundError, ValidationError, WebhookEvent, appendAuditEvent, createRevenue, err, filterAuditTrail, fromSmallestUnit, getAuditTrail, getLastStateChange, isErr, isOk, isRetryable, isRevenueError, ok, toSmallestUnit, unwrap, unwrapOr };