@classytic/revenue 1.1.4 → 2.0.0

package/dist/settlement.enums-DFhkqZEY.d.mts

@@ -1,132 +0,0 @@
-//#region src/enums/transaction.enums.d.ts
-/**
- * Transaction Enums
- * @classytic/revenue
- *
- * Library-managed transaction enums only.
- * Users should define their own categories and merge with these.
- */
-/**
- * Transaction Flow - Directional money movement
- *
- * INFLOW: Money coming in (payments, subscriptions, purchases, receipts)
- * OUTFLOW: Money going out (refunds, payouts, expenses, disbursements)
- *
- * Industry-standard terminology compatible with QuickBooks, Xero, and other accounting systems.
- * Users can map categories to flow directions via transactionTypeMapping config.
- *
- * @example
- * // Revenue platform
- * { type: 'subscription', flow: 'inflow' }
- *
- * // Payroll platform
- * { type: 'salary', flow: 'outflow' }
- *
- * // Marketplace
- * { type: 'commission', flow: 'outflow' }  // Paying sellers
- * { type: 'platform_fee', flow: 'inflow' } // Platform revenue
- */
-declare const TRANSACTION_FLOW: {
-  readonly INFLOW: "inflow";
-  readonly OUTFLOW: "outflow";
-};
-/** @deprecated Use TRANSACTION_FLOW instead */
-declare const TRANSACTION_TYPE: {
-  readonly INFLOW: "inflow";
-  readonly OUTFLOW: "outflow";
-};
-type TransactionFlow = typeof TRANSACTION_FLOW;
-type TransactionFlowValue = TransactionFlow[keyof TransactionFlow];
-declare const TRANSACTION_FLOW_VALUES: TransactionFlowValue[];
-/** @deprecated Use TransactionFlow instead */
-type TransactionType = TransactionFlow;
-/** @deprecated Use TransactionFlowValue instead */
-type TransactionTypeValue = TransactionFlowValue;
-/** @deprecated Use TRANSACTION_FLOW_VALUES instead */
-declare const TRANSACTION_TYPE_VALUES: TransactionFlowValue[];
-/**
- * Transaction Status - Library-managed states
- */
-declare const TRANSACTION_STATUS: {
-  readonly PENDING: "pending";
-  readonly PAYMENT_INITIATED: "payment_initiated";
-  readonly PROCESSING: "processing";
-  readonly REQUIRES_ACTION: "requires_action";
-  readonly VERIFIED: "verified";
-  readonly COMPLETED: "completed";
-  readonly FAILED: "failed";
-  readonly CANCELLED: "cancelled";
-  readonly EXPIRED: "expired";
-  readonly REFUNDED: "refunded";
-  readonly PARTIALLY_REFUNDED: "partially_refunded";
-};
-type TransactionStatus = typeof TRANSACTION_STATUS;
-type TransactionStatusValue = TransactionStatus[keyof TransactionStatus];
-declare const TRANSACTION_STATUS_VALUES: TransactionStatusValue[];
-/**
- * Categories managed by this library
- *
- * SUBSCRIPTION: Recurring subscription payments
- * PURCHASE: One-time purchases
- *
- * Users should spread these into their own category enums:
- *
- * @example
- * import { LIBRARY_CATEGORIES } from '@classytic/revenue';
- *
- * export const MY_CATEGORIES = {
- *   ...LIBRARY_CATEGORIES,
- *   SALARY: 'salary',
- *   RENT: 'rent',
- *   EQUIPMENT: 'equipment',
- * } as const;
- */
-declare const LIBRARY_CATEGORIES: {
-  readonly SUBSCRIPTION: "subscription";
-  readonly PURCHASE: "purchase";
-};
-type LibraryCategories = typeof LIBRARY_CATEGORIES;
-type LibraryCategoryValue = LibraryCategories[keyof LibraryCategories];
-declare const LIBRARY_CATEGORY_VALUES: LibraryCategoryValue[];
-declare function isLibraryCategory(value: unknown): value is LibraryCategoryValue;
-declare function isTransactionFlow(value: unknown): value is TransactionFlowValue;
-/** @deprecated Use isTransactionFlow instead */
-declare function isTransactionType(value: unknown): value is TransactionTypeValue;
-declare function isTransactionStatus(value: unknown): value is TransactionStatusValue;
-//#endregion
-//#region src/enums/settlement.enums.d.ts
-/**
- * Settlement Enums
- * @classytic/revenue
- *
- * Enums for settlement/payout tracking
- */
-declare const SETTLEMENT_STATUS: {
-  readonly PENDING: "pending";
-  readonly PROCESSING: "processing";
-  readonly COMPLETED: "completed";
-  readonly FAILED: "failed";
-  readonly CANCELLED: "cancelled";
-};
-type SettlementStatus = typeof SETTLEMENT_STATUS;
-type SettlementStatusValue = SettlementStatus[keyof SettlementStatus];
-declare const SETTLEMENT_STATUS_VALUES: ("pending" | "processing" | "completed" | "failed" | "cancelled")[];
-/**
- * Type guard for settlement status
- */
-declare function isSettlementStatus(value: unknown): value is SettlementStatusValue;
-declare const SETTLEMENT_TYPE: {
-  readonly SPLIT_PAYOUT: "split_payout";
-  readonly PLATFORM_WITHDRAWAL: "platform_withdrawal";
-  readonly MANUAL_PAYOUT: "manual_payout";
-  readonly ESCROW_RELEASE: "escrow_release";
-};
-type SettlementType = typeof SETTLEMENT_TYPE;
-type SettlementTypeValue = SettlementType[keyof SettlementType];
-declare const SETTLEMENT_TYPE_VALUES: ("split_payout" | "platform_withdrawal" | "manual_payout" | "escrow_release")[];
-/**
- * Type guard for settlement type
- */
-declare function isSettlementType(value: unknown): value is SettlementTypeValue;
-//#endregion
-export { isTransactionType as A, TransactionStatus as C, isLibraryCategory as D, TransactionTypeValue as E, isTransactionFlow as O, TransactionFlowValue as S, TransactionType as T, TRANSACTION_STATUS as _, SettlementStatus as a, TRANSACTION_TYPE_VALUES as b, SettlementTypeValue as c, LIBRARY_CATEGORIES as d, LIBRARY_CATEGORY_VALUES as f, TRANSACTION_FLOW_VALUES as g, TRANSACTION_FLOW as h, SETTLEMENT_TYPE_VALUES as i, isTransactionStatus as k, isSettlementStatus as l, LibraryCategoryValue as m, SETTLEMENT_STATUS_VALUES as n, SettlementStatusValue as o, LibraryCategories as p, SETTLEMENT_TYPE as r, SettlementType as s, SETTLEMENT_STATUS as t, isSettlementType as u, TRANSACTION_STATUS_VALUES as v, TransactionStatusValue as w, TransactionFlow as x, TRANSACTION_TYPE as y };

package/dist/settlement.schema-DnNSFpGd.d.mts

@@ -1,344 +0,0 @@
-import { i as PayoutMethodValue } from "./split.enums-DmskfLOM.mjs";
-import mongoose from "mongoose";
-
-//#region src/schemas/settlement/settlement.schema.d.ts
-/**
- * Settlement Schema
- * Tracks payouts from platform to vendors/affiliates/partners
- *
- * Use in your Settlement model:
- * ```typescript
- * import mongoose from 'mongoose';
- * import { settlementSchema } from '@classytic/revenue/schemas';
- *
- * const Settlement = mongoose.model('Settlement', settlementSchema);
- * ```
- */
-declare const settlementSchema: mongoose.Schema<any, mongoose.Model<any, any, any, any, any, any, any>, {}, {}, {}, {}, {
-  timestamps: true;
-}, {
-  type: "split_payout" | "platform_withdrawal" | "manual_payout" | "escrow_release";
-  metadata: any;
-  status: "pending" | "processing" | "completed" | "failed" | "cancelled";
-  recipientId: mongoose.Types.ObjectId;
-  recipientType: "affiliate" | "user" | "organization" | "partner" | "platform";
-  amount: number;
-  currency: string;
-  payoutMethod: PayoutMethodValue;
-  organizationId: mongoose.Types.ObjectId;
-  sourceTransactionIds: mongoose.Types.ObjectId[];
-  sourceSplitIds: string[];
-  retryCount: number;
-  bankTransferDetails?: {
-    bankName?: string | null | undefined;
-    accountNumber?: string | null | undefined;
-    accountName?: string | null | undefined;
-    routingNumber?: string | null | undefined;
-    swiftCode?: string | null | undefined;
-    iban?: string | null | undefined;
-    transferReference?: string | null | undefined;
-    transferredAt?: NativeDate | null | undefined;
-  } | null | undefined;
-  mobileWalletDetails?: {
-    provider?: string | null | undefined;
-    transactionId?: string | null | undefined;
-    accountNumber?: string | null | undefined;
-    transferredAt?: NativeDate | null | undefined;
-    phoneNumber?: string | null | undefined;
-  } | null | undefined;
-  cryptoDetails?: {
-    transferredAt?: NativeDate | null | undefined;
-    network?: string | null | undefined;
-    walletAddress?: string | null | undefined;
-    transactionHash?: string | null | undefined;
-  } | null | undefined;
-  platformBalanceDetails?: {
-    balanceId?: mongoose.Types.ObjectId | null | undefined;
-    appliedAt?: NativeDate | null | undefined;
-  } | null | undefined;
-  scheduledAt?: NativeDate | null | undefined;
-  processedAt?: NativeDate | null | undefined;
-  completedAt?: NativeDate | null | undefined;
-  failedAt?: NativeDate | null | undefined;
-  cancelledAt?: NativeDate | null | undefined;
-  failureReason?: string | null | undefined;
-  failureCode?: string | null | undefined;
-  notes?: string | null | undefined;
-} & mongoose.DefaultTimestampProps, mongoose.Document<unknown, {}, {
-  type: "split_payout" | "platform_withdrawal" | "manual_payout" | "escrow_release";
-  metadata: any;
-  status: "pending" | "processing" | "completed" | "failed" | "cancelled";
-  recipientId: mongoose.Types.ObjectId;
-  recipientType: "affiliate" | "user" | "organization" | "partner" | "platform";
-  amount: number;
-  currency: string;
-  payoutMethod: PayoutMethodValue;
-  organizationId: mongoose.Types.ObjectId;
-  sourceTransactionIds: mongoose.Types.ObjectId[];
-  sourceSplitIds: string[];
-  retryCount: number;
-  bankTransferDetails?: {
-    bankName?: string | null | undefined;
-    accountNumber?: string | null | undefined;
-    accountName?: string | null | undefined;
-    routingNumber?: string | null | undefined;
-    swiftCode?: string | null | undefined;
-    iban?: string | null | undefined;
-    transferReference?: string | null | undefined;
-    transferredAt?: NativeDate | null | undefined;
-  } | null | undefined;
-  mobileWalletDetails?: {
-    provider?: string | null | undefined;
-    transactionId?: string | null | undefined;
-    accountNumber?: string | null | undefined;
-    transferredAt?: NativeDate | null | undefined;
-    phoneNumber?: string | null | undefined;
-  } | null | undefined;
-  cryptoDetails?: {
-    transferredAt?: NativeDate | null | undefined;
-    network?: string | null | undefined;
-    walletAddress?: string | null | undefined;
-    transactionHash?: string | null | undefined;
-  } | null | undefined;
-  platformBalanceDetails?: {
-    balanceId?: mongoose.Types.ObjectId | null | undefined;
-    appliedAt?: NativeDate | null | undefined;
-  } | null | undefined;
-  scheduledAt?: NativeDate | null | undefined;
-  processedAt?: NativeDate | null | undefined;
-  completedAt?: NativeDate | null | undefined;
-  failedAt?: NativeDate | null | undefined;
-  cancelledAt?: NativeDate | null | undefined;
-  failureReason?: string | null | undefined;
-  failureCode?: string | null | undefined;
-  notes?: string | null | undefined;
-} & mongoose.DefaultTimestampProps, {
-  id: string;
-}, mongoose.ResolveSchemaOptions<{
-  timestamps: true;
-}>> & Omit<{
-  type: "split_payout" | "platform_withdrawal" | "manual_payout" | "escrow_release";
-  metadata: any;
-  status: "pending" | "processing" | "completed" | "failed" | "cancelled";
-  recipientId: mongoose.Types.ObjectId;
-  recipientType: "affiliate" | "user" | "organization" | "partner" | "platform";
-  amount: number;
-  currency: string;
-  payoutMethod: PayoutMethodValue;
-  organizationId: mongoose.Types.ObjectId;
-  sourceTransactionIds: mongoose.Types.ObjectId[];
-  sourceSplitIds: string[];
-  retryCount: number;
-  bankTransferDetails?: {
-    bankName?: string | null | undefined;
-    accountNumber?: string | null | undefined;
-    accountName?: string | null | undefined;
-    routingNumber?: string | null | undefined;
-    swiftCode?: string | null | undefined;
-    iban?: string | null | undefined;
-    transferReference?: string | null | undefined;
-    transferredAt?: NativeDate | null | undefined;
-  } | null | undefined;
-  mobileWalletDetails?: {
-    provider?: string | null | undefined;
-    transactionId?: string | null | undefined;
-    accountNumber?: string | null | undefined;
-    transferredAt?: NativeDate | null | undefined;
-    phoneNumber?: string | null | undefined;
-  } | null | undefined;
-  cryptoDetails?: {
-    transferredAt?: NativeDate | null | undefined;
-    network?: string | null | undefined;
-    walletAddress?: string | null | undefined;
-    transactionHash?: string | null | undefined;
-  } | null | undefined;
-  platformBalanceDetails?: {
-    balanceId?: mongoose.Types.ObjectId | null | undefined;
-    appliedAt?: NativeDate | null | undefined;
-  } | null | undefined;
-  scheduledAt?: NativeDate | null | undefined;
-  processedAt?: NativeDate | null | undefined;
-  completedAt?: NativeDate | null | undefined;
-  failedAt?: NativeDate | null | undefined;
-  cancelledAt?: NativeDate | null | undefined;
-  failureReason?: string | null | undefined;
-  failureCode?: string | null | undefined;
-  notes?: string | null | undefined;
-} & mongoose.DefaultTimestampProps & {
-  _id: mongoose.Types.ObjectId;
-} & {
-  __v: number;
-}, "id"> & {
-  id: string;
-}, {
-  [path: string]: mongoose.SchemaDefinitionProperty<undefined, any, any>;
-} | {
-  [x: string]: mongoose.SchemaDefinitionProperty<any, any, mongoose.Document<unknown, {}, {
-    type: "split_payout" | "platform_withdrawal" | "manual_payout" | "escrow_release";
-    metadata: any;
-    status: "pending" | "processing" | "completed" | "failed" | "cancelled";
-    recipientId: mongoose.Types.ObjectId;
-    recipientType: "affiliate" | "user" | "organization" | "partner" | "platform";
-    amount: number;
-    currency: string;
-    payoutMethod: PayoutMethodValue;
-    organizationId: mongoose.Types.ObjectId;
-    sourceTransactionIds: mongoose.Types.ObjectId[];
-    sourceSplitIds: string[];
-    retryCount: number;
-    bankTransferDetails?: {
-      bankName?: string | null | undefined;
-      accountNumber?: string | null | undefined;
-      accountName?: string | null | undefined;
-      routingNumber?: string | null | undefined;
-      swiftCode?: string | null | undefined;
-      iban?: string | null | undefined;
-      transferReference?: string | null | undefined;
-      transferredAt?: NativeDate | null | undefined;
-    } | null | undefined;
-    mobileWalletDetails?: {
-      provider?: string | null | undefined;
-      transactionId?: string | null | undefined;
-      accountNumber?: string | null | undefined;
-      transferredAt?: NativeDate | null | undefined;
-      phoneNumber?: string | null | undefined;
-    } | null | undefined;
-    cryptoDetails?: {
-      transferredAt?: NativeDate | null | undefined;
-      network?: string | null | undefined;
-      walletAddress?: string | null | undefined;
-      transactionHash?: string | null | undefined;
-    } | null | undefined;
-    platformBalanceDetails?: {
-      balanceId?: mongoose.Types.ObjectId | null | undefined;
-      appliedAt?: NativeDate | null | undefined;
-    } | null | undefined;
-    scheduledAt?: NativeDate | null | undefined;
-    processedAt?: NativeDate | null | undefined;
-    completedAt?: NativeDate | null | undefined;
-    failedAt?: NativeDate | null | undefined;
-    cancelledAt?: NativeDate | null | undefined;
-    failureReason?: string | null | undefined;
-    failureCode?: string | null | undefined;
-    notes?: string | null | undefined;
-  } & mongoose.DefaultTimestampProps, {
-    id: string;
-  }, mongoose.ResolveSchemaOptions<{
-    timestamps: true;
-  }>> & Omit<{
-    type: "split_payout" | "platform_withdrawal" | "manual_payout" | "escrow_release";
-    metadata: any;
-    status: "pending" | "processing" | "completed" | "failed" | "cancelled";
-    recipientId: mongoose.Types.ObjectId;
-    recipientType: "affiliate" | "user" | "organization" | "partner" | "platform";
-    amount: number;
-    currency: string;
-    payoutMethod: PayoutMethodValue;
-    organizationId: mongoose.Types.ObjectId;
-    sourceTransactionIds: mongoose.Types.ObjectId[];
-    sourceSplitIds: string[];
-    retryCount: number;
-    bankTransferDetails?: {
-      bankName?: string | null | undefined;
-      accountNumber?: string | null | undefined;
-      accountName?: string | null | undefined;
-      routingNumber?: string | null | undefined;
-      swiftCode?: string | null | undefined;
-      iban?: string | null | undefined;
-      transferReference?: string | null | undefined;
-      transferredAt?: NativeDate | null | undefined;
-    } | null | undefined;
-    mobileWalletDetails?: {
-      provider?: string | null | undefined;
-      transactionId?: string | null | undefined;
-      accountNumber?: string | null | undefined;
-      transferredAt?: NativeDate | null | undefined;
-      phoneNumber?: string | null | undefined;
-    } | null | undefined;
-    cryptoDetails?: {
-      transferredAt?: NativeDate | null | undefined;
-      network?: string | null | undefined;
-      walletAddress?: string | null | undefined;
-      transactionHash?: string | null | undefined;
-    } | null | undefined;
-    platformBalanceDetails?: {
-      balanceId?: mongoose.Types.ObjectId | null | undefined;
-      appliedAt?: NativeDate | null | undefined;
-    } | null | undefined;
-    scheduledAt?: NativeDate | null | undefined;
-    processedAt?: NativeDate | null | undefined;
-    completedAt?: NativeDate | null | undefined;
-    failedAt?: NativeDate | null | undefined;
-    cancelledAt?: NativeDate | null | undefined;
-    failureReason?: string | null | undefined;
-    failureCode?: string | null | undefined;
-    notes?: string | null | undefined;
-  } & mongoose.DefaultTimestampProps & {
-    _id: mongoose.Types.ObjectId;
-  } & {
-    __v: number;
-  }, "id"> & {
-    id: string;
-  }> | undefined;
-}, {
-  type: "split_payout" | "platform_withdrawal" | "manual_payout" | "escrow_release";
-  metadata: any;
-  status: "pending" | "processing" | "completed" | "failed" | "cancelled";
-  recipientId: mongoose.Types.ObjectId;
-  recipientType: "affiliate" | "user" | "organization" | "partner" | "platform";
-  amount: number;
-  currency: string;
-  payoutMethod: PayoutMethodValue;
-  organizationId: mongoose.Types.ObjectId;
-  sourceTransactionIds: mongoose.Types.ObjectId[];
-  sourceSplitIds: string[];
-  retryCount: number;
-  bankTransferDetails?: {
-    bankName?: string | null | undefined;
-    accountNumber?: string | null | undefined;
-    accountName?: string | null | undefined;
-    routingNumber?: string | null | undefined;
-    swiftCode?: string | null | undefined;
-    iban?: string | null | undefined;
-    transferReference?: string | null | undefined;
-    transferredAt?: NativeDate | null | undefined;
-  } | null | undefined;
-  mobileWalletDetails?: {
-    provider?: string | null | undefined;
-    transactionId?: string | null | undefined;
-    accountNumber?: string | null | undefined;
-    transferredAt?: NativeDate | null | undefined;
-    phoneNumber?: string | null | undefined;
-  } | null | undefined;
-  cryptoDetails?: {
-    transferredAt?: NativeDate | null | undefined;
-    network?: string | null | undefined;
-    walletAddress?: string | null | undefined;
-    transactionHash?: string | null | undefined;
-  } | null | undefined;
-  platformBalanceDetails?: {
-    balanceId?: mongoose.Types.ObjectId | null | undefined;
-    appliedAt?: NativeDate | null | undefined;
-  } | null | undefined;
-  scheduledAt?: NativeDate | null | undefined;
-  processedAt?: NativeDate | null | undefined;
-  completedAt?: NativeDate | null | undefined;
-  failedAt?: NativeDate | null | undefined;
-  cancelledAt?: NativeDate | null | undefined;
-  failureReason?: string | null | undefined;
-  failureCode?: string | null | undefined;
-  notes?: string | null | undefined;
-  createdAt: NativeDate;
-  updatedAt: NativeDate;
-} & {
-  _id: mongoose.Types.ObjectId;
-} & {
-  __v: number;
-}>;
-type SettlementDocument = mongoose.InferSchemaType<typeof settlementSchema> & mongoose.Document & {
-  _id: mongoose.Types.ObjectId;
-  createdAt: Date;
-  updatedAt: Date;
-};
-//#endregion
-export { settlementSchema as n, SettlementDocument as t };