@classytic/revenue 0.2.4 → 1.0.1

package/index.js

@@ -1,76 +0,0 @@
-/**
- * @classytic/revenue
- * Revenue Management System
- *
- * A unified, enterprise-grade revenue management system combining
- * monetization (subscriptions, purchases, proration) and payment processing
- * (verification, refunds, webhooks) into a single, cohesive package.
- *
- * Thin, focused, production-ready library with smart defaults.
- *
- * @version 0.2.0
- * @author Classytic (Classytic)
- * @license MIT
- */
-
-// ============ CORE API ============
-export { createRevenue } from './core/builder.js';
-export { Container } from './core/container.js';
-import { createRevenue as _createRevenue } from './core/builder.js';
-import { Container as _Container } from './core/container.js';
-
-// ============ ERROR CLASSES ============
-export * from './core/errors.js';
-import { RevenueError } from './core/errors.js';
-
-// ============ PROVIDER SYSTEM ============
-export {
-  PaymentProvider,
-  PaymentIntent,
-  PaymentResult,
-  RefundResult,
-  WebhookEvent,
-} from './providers/base.js';
-import { PaymentProvider as _PaymentProvider } from './providers/base.js';
-// Note: ManualProvider moved to @classytic/revenue-manual (separate package)
-
-// ============ SERVICES (ADVANCED USAGE) ============
-export { MonetizationService } from './services/monetization.service.js';
-export { PaymentService } from './services/payment.service.js';
-export { TransactionService } from './services/transaction.service.js';
-export { EscrowService } from './services/escrow.service.js';
-
-// ============ ENUMS & SCHEMAS (FOR INJECTION) ============
-export * from './enums/index.js';
-export * from './schemas/index.js';
-
-// ============ UTILITIES ============
-export {
-  logger,
-  setLogger,
-  calculateCommission,
-  reverseCommission,
-  // Split/Escrow utilities
-  calculateSplits,
-  calculateOrganizationPayout,
-  reverseSplits,
-  calculateCommissionWithSplits,
-  // Subscription utilities
-  addDuration,
-  calculatePeriodRange,
-  calculateProratedAmount,
-  resolveIntervalToDuration,
-  isSubscriptionActive,
-  canRenewSubscription,
-  canCancelSubscription,
-  canPauseSubscription,
-  canResumeSubscription,
-} from './utils/index.js';
-
-// ============ DEFAULT EXPORT ============
-export default {
-  createRevenue: _createRevenue,
-  PaymentProvider: _PaymentProvider,
-  RevenueError,
-  Container: _Container,
-};

package/providers/base.js

@@ -1,162 +0,0 @@
-/**
- * Payment Provider Base Class
- * @classytic/revenue
- *
- * Abstract base class for all payment providers
- * Inspired by: Vercel AI SDK, Stripe SDK
- */
-
-/**
- * Payment Intent - standardized response from createIntent
- */
-export class PaymentIntent {
-  constructor(data) {
-    this.id = data.id;
-    this.sessionId = data.sessionId || null;
-    this.paymentIntentId = data.paymentIntentId || null;
-    this.provider = data.provider;
-    this.status = data.status;
-    this.amount = data.amount;
-    this.currency = data.currency || 'BDT';
-    this.metadata = data.metadata || {};
-    this.clientSecret = data.clientSecret;
-    this.paymentUrl = data.paymentUrl;
-    this.instructions = data.instructions;
-    this.raw = data.raw;
-  }
-}
-
-/**
- * Payment Result - standardized response from verifyPayment
- */
-export class PaymentResult {
-  constructor(data) {
-    this.id = data.id;
-    this.provider = data.provider;
-    this.status = data.status; // 'succeeded', 'failed', 'processing'
-    this.amount = data.amount;
-    this.currency = data.currency || 'BDT';
-    this.paidAt = data.paidAt;
-    this.metadata = data.metadata || {};
-    this.raw = data.raw;
-  }
-}
-
-/**
- * Refund Result - standardized response from refund
- */
-export class RefundResult {
-  constructor(data) {
-    this.id = data.id;
-    this.provider = data.provider;
-    this.status = data.status; // 'succeeded', 'failed', 'processing'
-    this.amount = data.amount;
-    this.currency = data.currency || 'BDT';
-    this.refundedAt = data.refundedAt;
-    this.reason = data.reason;
-    this.metadata = data.metadata || {};
-    this.raw = data.raw;
-  }
-}
-
-/**
- * Webhook Event - standardized webhook event
- */
-export class WebhookEvent {
-  constructor(data) {
-    this.id = data.id;
-    this.provider = data.provider;
-    this.type = data.type; // 'payment.succeeded', 'payment.failed', 'refund.succeeded', etc.
-    this.data = data.data;
-    this.createdAt = data.createdAt;
-    this.raw = data.raw;
-  }
-}
-
-/**
- * Base Payment Provider
- * All payment providers must extend this class
- */
-export class PaymentProvider {
-  constructor(config = {}) {
-    this.config = config;
-    this.name = 'base'; // Override in subclass
-  }
-
-  /**
-   * Create a payment intent
-   * @param {Object} params - Payment parameters
-   * @param {number} params.amount - Amount in smallest currency unit
-   * @param {string} params.currency - Currency code
-   * @param {Object} params.metadata - Additional metadata
-   * @returns {Promise<PaymentIntent>}
-   */
-  async createIntent(params) {
-    throw new Error(`${this.constructor.name}: createIntent() must be implemented`);
-  }
-
-  /**
-   * Verify a payment
-   * @param {string} intentId - Payment intent ID
-   * @returns {Promise<PaymentResult>}
-   */
-  async verifyPayment(intentId) {
-    throw new Error(`${this.constructor.name}: verifyPayment() must be implemented`);
-  }
-
-  /**
-   * Get payment status
-   * @param {string} intentId - Payment intent ID
-   * @returns {Promise<PaymentResult>}
-   */
-  async getStatus(intentId) {
-    throw new Error(`${this.constructor.name}: getStatus() must be implemented`);
-  }
-
-  /**
-   * Refund a payment
-   * @param {string} paymentId - Payment ID
-   * @param {number} amount - Amount to refund (optional, full refund if not provided)
-   * @param {Object} options - Refund options
-   * @returns {Promise<RefundResult>}
-   */
-  async refund(paymentId, amount, options = {}) {
-    throw new Error(`${this.constructor.name}: refund() must be implemented`);
-  }
-
-  /**
-   * Handle webhook from provider
-   * @param {Object} payload - Webhook payload
-   * @param {Object} headers - Request headers (for signature verification)
-   * @returns {Promise<WebhookEvent>}
-   */
-  async handleWebhook(payload, headers = {}) {
-    throw new Error(`${this.constructor.name}: handleWebhook() must be implemented`);
-  }
-
-  /**
-   * Verify webhook signature (optional)
-   * @param {Object} payload - Webhook payload
-   * @param {string} signature - Webhook signature
-   * @returns {boolean}
-   */
-  verifyWebhookSignature(payload, signature) {
-    // Override in subclass if provider supports webhook signatures
-    return true;
-  }
-
-  /**
-   * Get provider capabilities
-   * @returns {Object}
-   */
-  getCapabilities() {
-    return {
-      supportsWebhooks: false,
-      supportsRefunds: false,
-      supportsPartialRefunds: false,
-      requiresManualVerification: true,
-    };
-  }
-}
-
-export default PaymentProvider;

package/schemas/escrow/hold.schema.js

@@ -1,62 +0,0 @@
-/**
- * Hold/Escrow Schema
- * @classytic/revenue
- *
- * Schema for platform-as-intermediary escrow flow
- * Spread into transaction schema when needed
- */
-
-import { HOLD_STATUS, HOLD_STATUS_VALUES, HOLD_REASON, HOLD_REASON_VALUES } from '../../enums/escrow.enums.js';
-
-export const holdSchema = {
-  status: {
-    type: String,
-    enum: HOLD_STATUS_VALUES,
-    default: HOLD_STATUS.PENDING,
-    index: true,
-  },
-
-  heldAmount: {
-    type: Number,
-    required: false,
-  },
-
-  releasedAmount: {
-    type: Number,
-    default: 0,
-  },
-
-  reason: {
-    type: String,
-    enum: HOLD_REASON_VALUES,
-    required: false,
-  },
-
-  holdUntil: {
-    type: Date,
-    required: false,
-  },
-
-  heldAt: Date,
-  releasedAt: Date,
-  cancelledAt: Date,
-
-  releases: [
-    {
-      amount: Number,
-      recipientId: String,
-      recipientType: String,
-      releasedAt: Date,
-      releasedBy: String,
-      reason: String,
-      metadata: Object,
-    },
-  ],
-
-  metadata: {
-    type: Object,
-    default: {},
-  },
-};
-
-export default holdSchema;

package/schemas/escrow/index.js

@@ -1,15 +0,0 @@
-/**
- * Escrow Schemas
- * @classytic/revenue
- */
-
-// Import first
-import { holdSchema } from './hold.schema.js';
-
-// Then re-export
-export { holdSchema };
-
-// Now it's in scope for default export
-export default {
-  holdSchema,
-};

package/schemas/index.d.ts

@@ -1,33 +0,0 @@
-/**
- * TypeScript definitions for @classytic/revenue/schemas
- * Core schemas for injection into your models
- */
-
-import { Schema } from 'mongoose';
-
-// ============ TRANSACTION SCHEMAS ============
-
-export const currentPaymentSchema: Schema;
-export const paymentSummarySchema: Schema;
-export const paymentDetailsSchema: Schema;
-export const gatewaySchema: Schema;
-export const commissionSchema: Schema;
-
-// ============ SUBSCRIPTION SCHEMAS ============
-
-export const subscriptionInfoSchema: Schema;
-export const subscriptionPlanSchema: Schema;
-
-// ============ DEFAULT EXPORT ============
-
-declare const _default: {
-  currentPaymentSchema: Schema;
-  paymentSummarySchema: Schema;
-  paymentDetailsSchema: Schema;
-  gatewaySchema: Schema;
-  commissionSchema: Schema;
-  subscriptionInfoSchema: Schema;
-  subscriptionPlanSchema: Schema;
-};
-
-export default _default;

package/schemas/index.js

@@ -1,27 +0,0 @@
-/**
- * Schema Index
- * @classytic/revenue
- *
- * Core schemas for injection into your models
- *
- * Note: Enums are separate. Import them from '@classytic/revenue/enums'
- */
-
-// Re-export core schemas only
-export * from './transaction/index.js';
-export * from './subscription/index.js';
-export * from './escrow/index.js';
-export * from './split/index.js';
-
-// Default export with core schemas
-import transactionSchemas from './transaction/index.js';
-import subscriptionSchemas from './subscription/index.js';
-import escrowSchemas from './escrow/index.js';
-import splitSchemas from './split/index.js';
-
-export default {
-  ...transactionSchemas,
-  ...subscriptionSchemas,
-  ...escrowSchemas,
-  ...splitSchemas,
-};

package/schemas/split/index.js

@@ -1,16 +0,0 @@
-/**
- * Split Payment Schemas
- * @classytic/revenue
- */
-
-// Import first
-import { splitItemSchema, splitsSchema } from './split.schema.js';
-
-// Then re-export
-export { splitItemSchema, splitsSchema };
-
-// Now they're in scope for default export
-export default {
-  splitItemSchema,
-  splitsSchema,
-};

package/schemas/split/split.schema.js

@@ -1,86 +0,0 @@
-/**
- * Split Payment Schema
- * @classytic/revenue
- *
- * Schema for multi-party commission splits
- * Spread into transaction schema when needed
- */
-
-import { SPLIT_TYPE, SPLIT_TYPE_VALUES, SPLIT_STATUS, SPLIT_STATUS_VALUES, PAYOUT_METHOD, PAYOUT_METHOD_VALUES } from '../../enums/split.enums.js';
-
-export const splitItemSchema = {
-  type: {
-    type: String,
-    enum: SPLIT_TYPE_VALUES,
-    required: true,
-  },
-
-  recipientId: {
-    type: String,
-    required: true,
-    index: true,
-  },
-
-  recipientType: {
-    type: String,
-    required: true,
-  },
-
-  rate: {
-    type: Number,
-    required: true,
-    min: 0,
-    max: 1,
-  },
-
-  grossAmount: {
-    type: Number,
-    required: true,
-  },
-
-  gatewayFeeRate: {
-    type: Number,
-    default: 0,
-  },
-
-  gatewayFeeAmount: {
-    type: Number,
-    default: 0,
-  },
-
-  netAmount: {
-    type: Number,
-    required: true,
-  },
-
-  status: {
-    type: String,
-    enum: SPLIT_STATUS_VALUES,
-    default: SPLIT_STATUS.PENDING,
-  },
-
-  dueDate: Date,
-  paidDate: Date,
-
-  payoutMethod: {
-    type: String,
-    enum: PAYOUT_METHOD_VALUES,
-    required: false,
-  },
-
-  payoutTransactionId: String,
-
-  metadata: {
-    type: Object,
-    default: {},
-  },
-};
-
-export const splitsSchema = {
-  splits: {
-    type: [splitItemSchema],
-    default: [],
-  },
-};
-
-export default splitsSchema;

package/schemas/subscription/index.js

@@ -1,17 +0,0 @@
-/**
- * Subscription Schemas
- * @classytic/revenue
- *
- * Re-exports all subscription-related schemas
- */
-
-export * from './plan.schema.js';
-export * from './info.schema.js';
-
-import planSchemas from './plan.schema.js';
-import infoSchemas from './info.schema.js';
-
-export default {
-  ...planSchemas,
-  ...infoSchemas,
-};

package/schemas/subscription/info.schema.js

@@ -1,115 +0,0 @@
-/**
- * Subscription Info Schema
- * @classytic/revenue
- *
- * Complete subscription information schema
- */
-
-import { Schema } from 'mongoose';
-import { subscriptionPlanSchema } from './plan.schema.js';
-
-/**
- * Subscription Info Schema
- * Use this in your model: subscription: { type: subscriptionInfoSchema }
- *
- * Complete subscription information
- */
-export const subscriptionInfoSchema = new Schema({
-  isActive: {
-    type: Boolean,
-    default: false,
-    index: true
-  },
-  plan: {
-    type: subscriptionPlanSchema,
-    required: true
-  },
-  startDate: {
-    type: Date,
-    index: true
-  },
-  endDate: {
-    type: Date,
-    index: true
-  },
-  autoRenew: {
-    type: Boolean,
-    default: true
-  },
-  renewalCount: {
-    type: Number,
-    default: 0,
-    min: 0
-  },
-
-  // Cancellation
-  canceledAt: {
-    type: Date
-  },
-  cancelAt: {
-    type: Date
-  },
-  cancellationReason: {
-    type: String
-  },
-
-  // Pause/Resume
-  pausedAt: {
-    type: Date
-  },
-  pauseReason: {
-    type: String
-  },
-
-  // Scheduled Plan Changes (Upgrade/Downgrade)
-  scheduledChange: {
-    type: new Schema({
-      // New plan details
-      newPlan: {
-        type: subscriptionPlanSchema,
-        required: true
-      },
-      // When the change takes effect
-      effectiveDate: {
-        type: Date,
-        required: true
-      },
-      // Type of change
-      changeType: {
-        type: String,
-        enum: ['upgrade', 'downgrade'],
-        required: true
-      },
-      // Scheduled date
-      scheduledAt: {
-        type: Date,
-        default: Date.now
-      },
-      // Optional admin price override (for upgrades)
-      priceOverride: {
-        type: Number,
-        min: 0
-      },
-      // Who scheduled the change
-      scheduledBy: {
-        type: Schema.Types.ObjectId,
-        ref: 'User'
-      },
-      // Calculation details (for audit trail)
-      calculation: {
-        type: Schema.Types.Mixed
-      }
-    }, { _id: false }),
-    default: null
-  },
-
-  // Metadata
-  metadata: {
-    type: Schema.Types.Mixed,
-    default: {}
-  },
-}, { _id: false });
-
-export default {
-  subscriptionInfoSchema,
-};

package/schemas/subscription/plan.schema.js

@@ -1,48 +0,0 @@
-/**
- * Subscription Plan Schema
- * @classytic/revenue
- *
- * Schema for subscription plan definitions
- */
-
-import { Schema } from 'mongoose';
-import { PLAN_KEY_VALUES } from '../../enums/index.js';
-
-/**
- * Subscription Plan Schema
- * Embedded in subscription info
- */
-export const subscriptionPlanSchema = new Schema({
-  key: {
-    type: String,
-    required: true,
-    enum: PLAN_KEY_VALUES,
-  },
-  label: {
-    type: String,
-    required: true,
-  },
-  duration: {
-    type: Number,
-    required: true,
-    min: 1,
-  },
-  durationUnit: {
-    type: String,
-    default: 'days',
-  },
-  price: {
-    type: Number,
-    required: true,
-    min: 0,
-  },
-  discount: {
-    type: Number,
-    default: 0,
-    min: 0,
-  },
-}, { _id: false });
-
-export default {
-  subscriptionPlanSchema,
-};

package/schemas/transaction/common.schema.js

@@ -1,22 +0,0 @@
-/**
- * Common Transaction Fields
- * @classytic/revenue
- *
- * Common field definitions for transaction-related models
- */
-
-/**
- * Common Field Definitions
- * Use these for consistent field definitions across models
- */
-export const commonFields = {
-  isNewRequest: {
-    type: Boolean,
-    default: false,
-    index: true,
-  },
-};
-
-export default {
-  commonFields,
-};