@classytic/revenue 1.1.3 → 2.0.0

package/dist/index-Dsp7H5Wb.d.mts

@@ -1,471 +0,0 @@
-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/infrastructure/plugins/index.d.mts

@@ -1,239 +0,0 @@
-import "../../index-Dsp7H5Wb.mjs";
-import "../../settlement.schema-D5uWB5tP.mjs";
-import "../../base-CsTlVQJe.mjs";
-import { c as definePlugin, o as RevenuePlugin } from "../../plugin-BbK0OVHy.mjs";
-import { n as TaxConfig } from "../../tax-BoCt5cEd.mjs";
-
-//#region src/infrastructure/plugins/business/logging.plugin.d.ts
-/**
- * Logging plugin options
- */
-interface LoggingPluginOptions {
-  /** Log level: 'debug' or 'info' */
-  level?: 'debug' | 'info';
-}
-/**
- * Logging plugin - logs all operations
- *
- * Logs payment creation, verification, and refund operations
- *
- * @param options - Plugin options
- * @returns Logging plugin
- *
- * @example
- * ```typescript
- * import { Revenue } from '@classytic/revenue';
- * import { loggingPlugin } from '@classytic/revenue/plugins';
- *
- * const revenue = Revenue
- *   .create()
- *   .withPlugin(loggingPlugin({ level: 'debug' }))
- *   .build();
- * ```
- */
-declare function loggingPlugin(options?: LoggingPluginOptions): RevenuePlugin;
-//#endregion
-//#region src/infrastructure/plugins/business/audit.plugin.d.ts
-/**
- * Audit entry record
- */
-interface AuditEntry {
-  action: string;
-  requestId: string;
-  timestamp: Date;
-  input: Record<string, unknown>;
-  output: Record<string, unknown>;
-  idempotencyKey?: string;
-}
-/**
- * Audit plugin options
- */
-interface AuditPluginOptions {
-  /** Custom storage function for audit entries */
-  store?: (entry: AuditEntry) => Promise<void>;
-}
-/**
- * Audit plugin - records all operations for compliance
- *
- * Records payment creation, refunds, and other operations with sanitized data
- *
- * @param options - Plugin options
- * @returns Audit plugin
- *
- * @example
- * ```typescript
- * import { Revenue } from '@classytic/revenue';
- * import { auditPlugin } from '@classytic/revenue/plugins';
- *
- * const revenue = Revenue
- *   .create()
- *   .withPlugin(auditPlugin({
- *     store: async (entry) => {
- *       await AuditLog.create(entry);
- *     }
- *   }))
- *   .build();
- * ```
- */
-declare function auditPlugin(options?: AuditPluginOptions): RevenuePlugin;
-//#endregion
-//#region src/infrastructure/plugins/business/metrics.plugin.d.ts
-/**
- * Metric record
- */
-interface Metric {
-  name: string;
-  duration: number;
-  success: boolean;
-  error?: string;
-  [key: string]: unknown;
-}
-/**
- * Metrics plugin options
- */
-interface MetricsPluginOptions {
-  /** Callback for each metric */
-  onMetric?: (metric: Metric) => void;
-}
-/**
- * Metrics plugin - collects operation metrics
- *
- * Tracks duration and success/failure of operations
- *
- * @param options - Plugin options
- * @returns Metrics plugin
- *
- * @example
- * ```typescript
- * import { Revenue } from '@classytic/revenue';
- * import { metricsPlugin } from '@classytic/revenue/plugins';
- *
- * const revenue = Revenue
- *   .create()
- *   .withPlugin(metricsPlugin({
- *     onMetric: (metric) => {
- *       // Send to Datadog, Prometheus, etc.
- *       statsd.timing(metric.name, metric.duration);
- *       if (!metric.success) {
- *         statsd.increment(`${metric.name}.error`);
- *       }
- *     }
- *   }))
- *   .build();
- * ```
- */
-declare function metricsPlugin(options?: MetricsPluginOptions): RevenuePlugin;
-//#endregion
-//#region src/infrastructure/plugins/business/tax.plugin.d.ts
-/**
- * Tax Plugin Options
- */
-interface TaxPluginOptions {
-  /**
-   * Function to get tax configuration for an organization
-   * Apps implement this to return jurisdiction-specific config
-   *
-   * @param orgId - Organization ID
-   * @returns Tax configuration or null if not registered
-   *
-   * @example
-   * ```typescript
-   * getTaxConfig: async (orgId) => {
-   *   const org = await Organization.findById(orgId);
-   *   if (!org) return null;
-   *
-   *   return {
-   *     isRegistered: org.country === 'AU',
-   *     defaultRate: org.country === 'AU' ? 0.10 : 0, // 10% GST in Australia
-   *     pricesIncludeTax: org.pricesIncludeTax || false,
-   *     exemptCategories: ['education', 'medical'],
-   *   };
-   * }
-   * ```
-   */
-  getTaxConfig: (orgId: string) => Promise<TaxConfig | null>;
-  /**
-   * Category mappings for resolving transaction categories
-   * Maps entity names to category strings
-   *
-   * @example
-   * ```typescript
-   * {
-   *   Order: 'order_subscription',
-   *   PlatformSubscription: 'platform_subscription',
-   *   Membership: 'gym_membership',
-   * }
-   * ```
-   */
-  categoryMappings?: Record<string, string>;
-  /**
-   * Categories that represent income (vs expense)
-   * Used to determine tax type: 'collected' vs 'paid'
-   *
-   * Default: ['subscription', 'purchase', 'course_enrollment']
-   */
-  incomeCategories?: string[];
-}
-/**
- * Create Tax Plugin
- *
- * Automatically calculates and applies tax to transactions during monetization.create()
- *
- * @param options - Plugin options
- * @returns Tax plugin
- *
- * @example
- * ```typescript
- * import { Revenue } from '@classytic/revenue';
- * import { createTaxPlugin } from '@classytic/revenue/plugins';
- *
- * const revenue = Revenue
- *   .create({ defaultCurrency: 'USD' })
- *   .withModels({ Transaction, Subscription })
- *   .withProvider('stripe', stripeProvider)
- *   .withPlugin(createTaxPlugin({
- *     getTaxConfig: async (orgId) => {
- *       const org = await Organization.findById(orgId);
- *       return {
- *         isRegistered: true,
- *         defaultRate: 0.15, // 15% tax
- *         pricesIncludeTax: false,
- *         exemptCategories: ['education'],
- *       };
- *     },
- *     categoryMappings: {
- *       Order: 'order_subscription',
- *       Membership: 'gym_membership',
- *     },
- *   }))
- *   .build();
- *
- * // Tax is now automatically calculated
- * await revenue.monetization.create({
- *   data: { organizationId: 'org_123', customerId: 'cust_456' },
- *   planKey: 'monthly',
- *   amount: 10000, // $100
- *   entity: 'Order',
- *   monetizationType: 'subscription',
- * });
- * // → Creates transaction with tax: {
- * //   isApplicable: true,
- * //   rate: 0.15,
- * //   baseAmount: 10000,
- * //   taxAmount: 1500,
- * //   totalAmount: 11500,
- * //   type: 'collected'
- * // }
- * ```
- */
-declare function createTaxPlugin(options: TaxPluginOptions): RevenuePlugin;
-//#endregion
-//#region src/infrastructure/plugins/index.d.ts
-declare const _default: {
-  loggingPlugin: typeof loggingPlugin;
-  auditPlugin: typeof auditPlugin;
-  metricsPlugin: typeof metricsPlugin;
-  createTaxPlugin: typeof createTaxPlugin;
-};
-//#endregion
-export { type AuditEntry, type AuditPluginOptions, type LoggingPluginOptions, type Metric, type MetricsPluginOptions, type TaxPluginOptions, auditPlugin, createTaxPlugin, _default as default, definePlugin, loggingPlugin, metricsPlugin };