@classytic/revenue 0.0.1 → 0.0.2

package/enums/index.d.ts

@@ -0,0 +1,107 @@
+/**
+ * TypeScript definitions for @classytic/revenue/enums
+ * Centralized Enums
+ */
+
+// ============ TRANSACTION ENUMS ============
+
+export 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';
+};
+
+export const TRANSACTION_STATUS_VALUES: string[];
+
+export const LIBRARY_CATEGORIES: {
+  readonly SUBSCRIPTION: 'subscription';
+  readonly PURCHASE: 'purchase';
+};
+
+export const LIBRARY_CATEGORY_VALUES: string[];
+
+// ============ PAYMENT ENUMS ============
+
+export const PAYMENT_STATUS: {
+  readonly PENDING: 'pending';
+  readonly VERIFIED: 'verified';
+  readonly FAILED: 'failed';
+  readonly REFUNDED: 'refunded';
+  readonly CANCELLED: 'cancelled';
+};
+
+export const PAYMENT_STATUS_VALUES: string[];
+
+export const PAYMENT_GATEWAY_TYPE: {
+  readonly MANUAL: 'manual';
+  readonly STRIPE: 'stripe';
+  readonly SSLCOMMERZ: 'sslcommerz';
+};
+
+export const PAYMENT_GATEWAY_TYPE_VALUES: string[];
+
+// Backward compatibility aliases
+export const GATEWAY_TYPES: typeof PAYMENT_GATEWAY_TYPE;
+export const GATEWAY_TYPE_VALUES: typeof PAYMENT_GATEWAY_TYPE_VALUES;
+
+// ============ SUBSCRIPTION ENUMS ============
+
+export const SUBSCRIPTION_STATUS: {
+  readonly ACTIVE: 'active';
+  readonly PAUSED: 'paused';
+  readonly CANCELLED: 'cancelled';
+  readonly EXPIRED: 'expired';
+  readonly PENDING: 'pending';
+  readonly INACTIVE: 'inactive';
+};
+
+export const SUBSCRIPTION_STATUS_VALUES: string[];
+
+export const PLAN_KEYS: {
+  readonly MONTHLY: 'monthly';
+  readonly QUARTERLY: 'quarterly';
+  readonly YEARLY: 'yearly';
+};
+
+export const PLAN_KEY_VALUES: string[];
+
+// ============ MONETIZATION ENUMS ============
+
+export const MONETIZATION_TYPES: {
+  readonly FREE: 'free';
+  readonly PURCHASE: 'purchase';
+  readonly SUBSCRIPTION: 'subscription';
+};
+
+export const MONETIZATION_TYPE_VALUES: string[];
+
+// ============ DEFAULT EXPORT ============
+
+declare const _default: {
+  TRANSACTION_STATUS: typeof TRANSACTION_STATUS;
+  TRANSACTION_STATUS_VALUES: typeof TRANSACTION_STATUS_VALUES;
+  LIBRARY_CATEGORIES: typeof LIBRARY_CATEGORIES;
+  LIBRARY_CATEGORY_VALUES: typeof LIBRARY_CATEGORY_VALUES;
+  PAYMENT_STATUS: typeof PAYMENT_STATUS;
+  PAYMENT_STATUS_VALUES: typeof PAYMENT_STATUS_VALUES;
+  PAYMENT_GATEWAY_TYPE: typeof PAYMENT_GATEWAY_TYPE;
+  PAYMENT_GATEWAY_TYPE_VALUES: typeof PAYMENT_GATEWAY_TYPE_VALUES;
+  GATEWAY_TYPES: typeof GATEWAY_TYPES;
+  GATEWAY_TYPE_VALUES: typeof GATEWAY_TYPE_VALUES;
+  SUBSCRIPTION_STATUS: typeof SUBSCRIPTION_STATUS;
+  SUBSCRIPTION_STATUS_VALUES: typeof SUBSCRIPTION_STATUS_VALUES;
+  PLAN_KEYS: typeof PLAN_KEYS;
+  PLAN_KEY_VALUES: typeof PLAN_KEY_VALUES;
+  MONETIZATION_TYPES: typeof MONETIZATION_TYPES;
+  MONETIZATION_TYPE_VALUES: typeof MONETIZATION_TYPE_VALUES;
+};
+
+export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@classytic/revenue",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Enterprise revenue management system with subscriptions, purchases, proration, and payment processing",
   "main": "index.js",
   "types": "revenue.d.ts",
@@ -39,10 +39,22 @@
     "node": ">=18.0.0"
   },
   "exports": {
-    ".": "./index.js",
-    "./enums": "./enums/index.js",
-    "./schemas": "./schemas/index.js",
-    "./utils": "./utils/index.js"
+    ".": {
+      "types": "./revenue.d.ts",
+      "default": "./index.js"
+    },
+    "./enums": {
+      "types": "./enums/index.d.ts",
+      "default": "./enums/index.js"
+    },
+    "./schemas": {
+      "types": "./schemas/index.d.ts",
+      "default": "./schemas/index.js"
+    },
+    "./utils": {
+      "types": "./utils/index.d.ts",
+      "default": "./utils/index.js"
+    }
   },
   "files": [
     "index.js",

package/schemas/index.d.ts

@@ -0,0 +1,54 @@
+/**
+ * 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;
+export const tenantSnapshotSchema: Schema;
+export const timelineEventSchema: Schema;
+export const customerInfoSchema: Schema;
+
+// ============ SUBSCRIPTION SCHEMAS ============
+
+export const subscriptionInfoSchema: Schema;
+export const subscriptionPlanSchema: Schema;
+export const customDiscountSchema: Schema;
+
+// ============ GATEWAY ACCOUNT SCHEMAS ============
+
+export const stripeAccountSchema: Schema;
+export const sslcommerzAccountSchema: Schema;
+export const bkashMerchantSchema: Schema;
+export const bankAccountSchema: Schema;
+export const walletSchema: Schema;
+
+// ============ DEFAULT EXPORT ============
+
+declare const _default: {
+  currentPaymentSchema: Schema;
+  paymentSummarySchema: Schema;
+  paymentDetailsSchema: Schema;
+  gatewaySchema: Schema;
+  commissionSchema: Schema;
+  tenantSnapshotSchema: Schema;
+  timelineEventSchema: Schema;
+  customerInfoSchema: Schema;
+  subscriptionInfoSchema: Schema;
+  subscriptionPlanSchema: Schema;
+  customDiscountSchema: Schema;
+  stripeAccountSchema: Schema;
+  sslcommerzAccountSchema: Schema;
+  bkashMerchantSchema: Schema;
+  bankAccountSchema: Schema;
+  walletSchema: Schema;
+};
+
+export default _default;

package/utils/index.d.ts

@@ -0,0 +1,99 @@
+/**
+ * TypeScript definitions for @classytic/revenue/utils
+ * Core utilities
+ */
+
+// ============ TRANSACTION TYPE UTILITIES ============
+
+export const TRANSACTION_TYPE: {
+  readonly MONETIZATION: 'monetization';
+  readonly MANUAL: 'manual';
+};
+
+export const PROTECTED_MONETIZATION_FIELDS: readonly string[];
+export const EDITABLE_MONETIZATION_FIELDS_PRE_VERIFICATION: readonly string[];
+export const MANUAL_TRANSACTION_CREATE_FIELDS: readonly string[];
+export const MANUAL_TRANSACTION_UPDATE_FIELDS: readonly string[];
+
+export interface TransactionTypeOptions {
+  targetModels?: string[];
+  additionalCategories?: string[];
+}
+
+export function isMonetizationTransaction(
+  transaction: any,
+  options?: TransactionTypeOptions
+): boolean;
+
+export function isManualTransaction(
+  transaction: any,
+  options?: TransactionTypeOptions
+): boolean;
+
+export function getTransactionType(
+  transaction: any,
+  options?: TransactionTypeOptions
+): 'monetization' | 'manual';
+
+export function getAllowedUpdateFields(
+  transaction: any,
+  options?: TransactionTypeOptions
+): string[];
+
+export interface FieldValidationResult {
+  allowed: boolean;
+  reason?: string;
+}
+
+export function validateFieldUpdate(
+  transaction: any,
+  fieldName: string,
+  options?: TransactionTypeOptions
+): FieldValidationResult;
+
+export function canSelfVerify(
+  transaction: any,
+  options?: TransactionTypeOptions
+): boolean;
+
+// ============ LOGGER UTILITIES ============
+
+export interface Logger {
+  info(...args: any[]): void;
+  warn(...args: any[]): void;
+  error(...args: any[]): void;
+  debug(...args: any[]): void;
+}
+
+export const logger: Logger;
+export function setLogger(logger: Logger | Console): void;
+
+// ============ HOOK UTILITIES ============
+
+export function triggerHook(
+  hooks: Record<string, Function[]>,
+  event: string,
+  data: any,
+  logger: Logger
+): void;
+
+// ============ DEFAULT EXPORT ============
+
+declare const _default: {
+  TRANSACTION_TYPE: typeof TRANSACTION_TYPE;
+  isMonetizationTransaction: typeof isMonetizationTransaction;
+  isManualTransaction: typeof isManualTransaction;
+  getTransactionType: typeof getTransactionType;
+  PROTECTED_MONETIZATION_FIELDS: typeof PROTECTED_MONETIZATION_FIELDS;
+  EDITABLE_MONETIZATION_FIELDS_PRE_VERIFICATION: typeof EDITABLE_MONETIZATION_FIELDS_PRE_VERIFICATION;
+  MANUAL_TRANSACTION_CREATE_FIELDS: typeof MANUAL_TRANSACTION_CREATE_FIELDS;
+  MANUAL_TRANSACTION_UPDATE_FIELDS: typeof MANUAL_TRANSACTION_UPDATE_FIELDS;
+  getAllowedUpdateFields: typeof getAllowedUpdateFields;
+  validateFieldUpdate: typeof validateFieldUpdate;
+  canSelfVerify: typeof canSelfVerify;
+  logger: typeof logger;
+  setLogger: typeof setLogger;
+  triggerHook: typeof triggerHook;
+};
+
+export default _default;