@classytic/commerce-sdk 0.1.0

package/dist/platform/index.d.ts

@@ -0,0 +1,645 @@
+export { g as Branch, f as BranchAddress, B as BranchApi, e as BranchRole, l as BranchRoleType, k as BranchSummary, d as BranchType, A as CheckoutPickupBranch, Q as CheckoutSettings, r as Coupon, C as CouponApi, w as CouponListResponse, x as CouponResponse, z as CouponUsage, y as CouponValidationResponse, s as CouponValidationResult, h as CreateBranchPayload, t as CreateCouponPayload, n as CreateUserPayload, O as DeliveryFeeSource, D as DeliveryZone, L as LogisticsSettings, H as MembershipConfig, G as MembershipRedemptionConfig, M as MembershipRoundingMode, F as MembershipTierConfig, R as PaymentMethodConfig, I as PlatformConfig, P as PlatformConfigApi, E as PlatformPolicies, j as UpdateBranchPayload, v as UpdateCouponPayload, J as UpdatePlatformConfigPayload, o as UpdateUserPayload, T as User, U as UserApi, m as UserBranchAssignment, q as UserListParams, S as UserRoleType, V as ValidateCouponPayload, b as branchApi, N as businessApi, c as couponApi, i as isHeadOffice, a as isSubBranch, K as platformApi, p as platformConfigApi, u as userApi } from '../coupon-CHFcw7cd.js';
+import { A as ApiResponse, R as RequestOptions } from '../api-factory-B_h4RKBm.js';
+import { c as TransactionStatus, e as TransactionCategory } from '../transaction-BTmoHpWh.js';
+export { B as BRANCH_KEYS, C as COUPON_KEYS, P as PLATFORM_KEYS, U as USER_KEYS, w as UseDeliveryZonesReturn, x as UseMembershipConfigReturn, v as UsePaymentMethodsReturn, t as UsePlatformConfigReturn, y as UseUpdatePlatformConfigReturn, e as branchHooks, o as couponHooks, h as useBranchActions, g as useBranchDetail, i as useBranchNavigation, f as useBranches, r as useCouponActions, q as useCouponDetail, s as useCouponNavigation, p as useCoupons, c as useDeliveryZones, d as useMembershipConfig, b as usePaymentMethods, u as usePlatformConfig, a as useUpdatePlatformConfig, m as useUserActions, l as useUserDetail, n as useUserNavigation, k as useUsers, j as userHooks } from '../coupon-zGkvO-Xx.js';
+import '../crud.factory-DyKaPHcU.js';
+import '@tanstack/react-query';
+
+/**
+ * Webhook Types
+ *
+ * Type definitions for payment webhook API endpoints.
+ * Matches backend routes/webhooks/payment-webhook.plugin.js
+ */
+
+/**
+ * Supported payment gateway providers
+ * - manual: Built-in manual verification (cash, bank transfer, mobile money)
+ * - stripe: Stripe payment gateway
+ * - sslcommerz: SSLCommerz (Bangladesh)
+ * - bkash: bKash API integration
+ * - nagad: Nagad API integration
+ */
+type PaymentGatewayProvider = 'manual' | 'stripe' | 'sslcommerz' | 'bkash' | 'nagad';
+/**
+ * Request payload for manual payment verification
+ * POST /webhooks/payments/manual/verify
+ *
+ * Used by superadmin to verify manual payments (cash, bank transfer, bKash, Nagad)
+ */
+interface ManualVerifyPayload {
+    /** Transaction ID to verify (MongoDB ObjectId as string) */
+    transactionId: string;
+    /** Optional verification notes */
+    notes?: string;
+}
+/**
+ * Request payload for manual payment rejection
+ * POST /webhooks/payments/manual/reject
+ *
+ * Used by superadmin to reject invalid payments (fraud, invalid reference, etc.)
+ */
+interface ManualRejectPayload {
+    /** Transaction ID to reject (MongoDB ObjectId as string) */
+    transactionId: string;
+    /** Reason for rejection (required) */
+    reason: string;
+}
+/**
+ * Entity reference information from transaction
+ */
+interface TransactionEntityRef {
+    /** Reference model type (Order, Commission, etc.) */
+    referenceModel: string;
+    /** Reference document ID */
+    referenceId: string;
+}
+/**
+ * Successful verification response data
+ */
+interface ManualVerifyResponseData {
+    /** Transaction ID */
+    transactionId: string;
+    /** New transaction status */
+    status: TransactionStatus;
+    /** Transaction amount (in smallest currency unit) */
+    amount: number;
+    /** Transaction category */
+    category: TransactionCategory | string;
+    /** Verification timestamp (ISO 8601) */
+    verifiedAt: string;
+    /** User ID who verified */
+    verifiedBy: string;
+    /** Linked entity (Order, etc.) if exists */
+    entity: TransactionEntityRef | null;
+}
+/**
+ * Successful rejection response data
+ */
+interface ManualRejectResponseData {
+    /** Transaction ID */
+    transactionId: string;
+    /** Transaction status (always 'failed') */
+    status: 'failed';
+    /** Failure timestamp (ISO 8601) */
+    failedAt: string;
+    /** Rejection reason */
+    failureReason: string;
+}
+/**
+ * Provider webhook response data
+ */
+interface ProviderWebhookResponseData {
+    /** Webhook event type from provider */
+    event: string;
+    /** Provider's event ID */
+    eventId: string;
+    /** Transaction ID (if found) */
+    transactionId?: string;
+    /** Processing status */
+    status: 'processed' | 'already_processed';
+    /** Provider name */
+    provider: PaymentGatewayProvider;
+}
+/**
+ * Webhook error names for error handling
+ */
+type WebhookErrorName = 'TransactionNotFoundError' | 'AlreadyVerifiedError' | 'AlreadyRejectedError' | 'PaymentVerificationError' | 'PaymentRejectionError' | 'ProviderNotFoundError' | 'ValidationError' | 'ProviderError';
+/**
+ * Webhook error response
+ */
+interface WebhookErrorResponse {
+    success: false;
+    message: string;
+    error: WebhookErrorName | string;
+}
+/**
+ * Manual verification API response
+ */
+interface ManualVerifyResponse {
+    success: true;
+    message: string;
+    data: ManualVerifyResponseData;
+}
+/**
+ * Manual rejection API response
+ */
+interface ManualRejectResponse {
+    success: true;
+    message: string;
+    data: ManualRejectResponseData;
+}
+/**
+ * Provider webhook API response
+ */
+interface ProviderWebhookResponse {
+    success: true;
+    message: string;
+    data: ProviderWebhookResponseData;
+}
+/**
+ * Stripe webhook event types (common ones)
+ */
+type StripeWebhookEventType = 'payment_intent.succeeded' | 'payment_intent.payment_failed' | 'checkout.session.completed' | 'checkout.session.expired' | 'charge.refunded' | 'charge.dispute.created';
+/**
+ * SSLCommerz IPN status values
+ */
+type SSLCommerzStatus = 'VALID' | 'FAILED' | 'CANCELLED' | 'UNATTEMPTED' | 'EXPIRED';
+/**
+ * Generic provider webhook payload
+ * Each provider has different formats - this is the common interface
+ */
+interface ProviderWebhookPayload {
+    /** Provider-specific event/transaction ID */
+    id?: string;
+    /** Event type (provider-specific naming) */
+    type?: string;
+    /** Status (provider-specific) */
+    status?: string;
+    /** Nested data object (common in Stripe) */
+    data?: {
+        object?: {
+            id?: string;
+            payment_intent?: string;
+            metadata?: Record<string, string>;
+            [key: string]: unknown;
+        };
+        [key: string]: unknown;
+    };
+    /** SSLCommerz specific fields */
+    tran_id?: string;
+    val_id?: string;
+    /** Allow additional provider-specific fields */
+    [key: string]: unknown;
+}
+
+/**
+ * Export & Archive Types
+ *
+ * Type definitions for data export (CSV/XLSX) and archival operations.
+ */
+/**
+ * Supported collection names for export
+ */
+type ExportCollection = 'product' | 'order' | 'customer' | 'transaction' | 'stockEntry' | 'stockMovement';
+/**
+ * Export format
+ */
+type ExportFormat = 'csv' | 'xlsx';
+/**
+ * Export request parameters
+ */
+interface ExportParams {
+    /** Collection to export */
+    collection: ExportCollection;
+    /** Comma-separated field names to include */
+    select?: string;
+    /** JSON filter criteria (stringified) */
+    filter?: string | Record<string, unknown>;
+}
+/**
+ * Export response (blob data)
+ */
+interface ExportResponse {
+    data: Blob;
+    response: Response;
+}
+/**
+ * Supported archive types
+ */
+type ArchiveType = 'transaction' | 'stock_movement';
+/**
+ * Archive creation payload
+ */
+interface CreateArchivePayload {
+    type: ArchiveType;
+    organizationId?: string;
+    rangeFrom?: Date | string;
+    rangeTo?: Date | string;
+    ttlDays?: number;
+}
+/**
+ * Archive record
+ */
+interface Archive {
+    _id: string;
+    type: ArchiveType;
+    organizationId?: string;
+    rangeFrom: string;
+    rangeTo: string;
+    filePath: string;
+    format: 'json';
+    recordCount: number;
+    sizeBytes: number;
+    expiresAt?: string;
+    archivedAt: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Archive result (after creation)
+ */
+interface ArchiveResult {
+    archived: number;
+    filePath: string;
+    cutoffDate: string;
+    olderThanDays: number;
+    message?: string;
+}
+/**
+ * Stock movement statistics
+ */
+interface StockMovementStats {
+    total: number;
+    last30Days: number;
+    last90Days: number;
+    lastYear: number;
+    olderThanYear: number;
+    recommendation: string;
+}
+/**
+ * Transaction statistics
+ */
+interface TransactionStats {
+    total: number;
+    last30Days: number;
+    last90Days: number;
+    lastYear: number;
+    olderThanYear: number;
+    pending: number;
+    archivable: number;
+    recommendation: string;
+}
+/**
+ * Options for archiving old data
+ */
+interface ArchiveOptions {
+    /** Archive records older than X days (default: 365) */
+    olderThanDays?: number;
+    /** Branch ID filter (optional) */
+    branchId?: string;
+    /** How long to keep archives before deletion (default: 730 days for movements, 2555 for transactions) */
+    ttlDays?: number;
+}
+/**
+ * Cleanup expired archives result
+ */
+interface CleanupResult {
+    deletedArchives: number;
+    deletedFiles: number;
+    orphanedFilesRemoved: number;
+}
+
+/**
+ * Payment Webhook API
+ *
+ * Handles manual payment verification/rejection for superadmins.
+ *
+ * Routes:
+ * - POST /webhooks/payments/manual/verify - Verify manual payment (superadmin)
+ * - POST /webhooks/payments/manual/reject - Reject manual payment (superadmin)
+ *
+ * Note: Provider webhooks (POST /webhooks/payments/:provider) are called
+ * directly by payment providers (Stripe, SSLCommerz, etc.) and don't need
+ * a frontend client method.
+ */
+
+type FetchOptions$1 = Omit<RequestInit, 'body' | 'method'>;
+declare class WebhookApi {
+    private baseUrl;
+    constructor();
+    /**
+     * Verify a manual payment (superadmin only)
+     * POST /webhooks/payments/manual/verify
+     *
+     * Flow:
+     * 1. Customer places order with manual payment (cash, bKash, Nagad, bank)
+     * 2. Customer pays and provides transaction reference
+     * 3. Admin verifies payment via this endpoint
+     * 4. Transaction status -> 'verified'
+     * 5. Order payment status -> 'verified', order status -> 'confirmed'
+     *
+     * @param params.transactionId - Transaction ID to verify
+     * @param params.notes - Optional verification notes
+     * @param params.token - Auth token (superadmin required)
+     * @param params.options - Additional fetch options
+     * @returns Verification result with transaction details
+     *
+     * @example
+     * ```typescript
+     * const result = await webhookApi.verifyPayment({
+     *   token: adminToken,
+     *   transactionId: '507f1f77bcf86cd799439011',
+     *   notes: 'Verified bKash TrxID via app',
+     * });
+     * ```
+     */
+    verifyPayment({ token, transactionId, notes, options, }: {
+        token: string;
+        transactionId: string;
+        notes?: string;
+        options?: FetchOptions$1;
+    }): Promise<ApiResponse<ManualVerifyResponseData>>;
+    /**
+     * Reject a manual payment (superadmin only)
+     * POST /webhooks/payments/manual/reject
+     *
+     * Flow:
+     * 1. Customer claims to have paid but admin finds issue
+     * 2. Admin rejects payment with reason via this endpoint
+     * 3. Transaction status -> 'failed', failureReason recorded
+     * 4. Order payment status -> 'failed'
+     *
+     * Common rejection reasons:
+     * - Invalid transaction reference
+     * - Amount mismatch
+     * - Duplicate claim
+     * - Suspected fraud
+     * - Payment not received
+     *
+     * @param params.transactionId - Transaction ID to reject
+     * @param params.reason - Rejection reason (required)
+     * @param params.token - Auth token (superadmin required)
+     * @param params.options - Additional fetch options
+     * @returns Rejection result with failure details
+     *
+     * @example
+     * ```typescript
+     * const result = await webhookApi.rejectPayment({
+     *   token: adminToken,
+     *   transactionId: '507f1f77bcf86cd799439011',
+     *   reason: 'Invalid bKash TrxID - no matching transaction found',
+     * });
+     * ```
+     */
+    rejectPayment({ token, transactionId, reason, options, }: {
+        token: string;
+        transactionId: string;
+        reason: string;
+        options?: FetchOptions$1;
+    }): Promise<ApiResponse<ManualRejectResponseData>>;
+    /**
+     * Alias for verifyPayment - more explicit naming
+     * @deprecated Use verifyPayment instead
+     */
+    verifyManualPayment(params: Parameters<typeof this.verifyPayment>[0]): Promise<ApiResponse<ManualVerifyResponseData>>;
+    /**
+     * Alias for rejectPayment - more explicit naming
+     * @deprecated Use rejectPayment instead
+     */
+    rejectManualPayment(params: Parameters<typeof this.rejectPayment>[0]): Promise<ApiResponse<ManualRejectResponseData>>;
+}
+declare const webhookApi: WebhookApi;
+
+/**
+ * Export API - Data Export Operations
+ *
+ * Consolidated API for exporting data to CSV/XLSX formats.
+ *
+ * Routes:
+ * - GET /export/csv?collection=xxx&select=yyy&filter=zzz
+ * - GET /export/xlsx?collection=xxx&select=yyy&filter=zzz
+ *
+ * Features:
+ * - MongoKit repository-based exports (secure, role-filtered)
+ * - Role-based field filtering (hides sensitive data like costPrice)
+ * - CSV and XLSX formats
+ * - Direct download or programmatic handling
+ * - Filter support with MongoDB query syntax
+ *
+ * Supported Collections:
+ * - product: Product catalog with pricing
+ * - order: Order history
+ * - customer: Customer list
+ * - transaction: Financial transactions
+ * - stockEntry: Current inventory levels
+ * - stockMovement: Inventory movement history
+ *
+ * Usage Examples:
+ * ```ts
+ * // Export all products to CSV
+ * const blob = await exportApi.toCSV({ token, collection: 'product' });
+ *
+ * // Export orders with filters
+ * const blob = await exportApi.toXLSX({
+ *   token,
+ *   collection: 'order',
+ *   filter: { status: 'delivered' },
+ *   select: 'orderNumber,customer,totalAmount,createdAt'
+ * });
+ *
+ * // Trigger browser download
+ * exportApi.downloadFile(blob, 'orders.xlsx');
+ * ```
+ */
+
+type FetchOptions = Omit<RequestOptions, 'token' | 'organizationId'>;
+declare class ExportApi {
+    private readonly basePath;
+    constructor();
+    /**
+     * Build query string from export parameters
+     */
+    private buildQueryString;
+    /**
+     * Export data to CSV format
+     * GET /export/csv
+     *
+     * Returns CSV file as blob for download or processing.
+     *
+     * @example
+     * // Export all products
+     * const blob = await exportApi.toCSV({ token, collection: 'product' });
+     *
+     * // Export filtered transactions
+     * const blob = await exportApi.toCSV({
+     *   token,
+     *   collection: 'transaction',
+     *   filter: { status: 'verified' },
+     *   select: 'amount,method,status,createdAt'
+     * });
+     */
+    toCSV({ token, collection, filter, select, options, }: {
+        token: string;
+        collection: ExportCollection;
+        filter?: Record<string, unknown> | string;
+        select?: string;
+        options?: FetchOptions;
+    }): Promise<Blob>;
+    /**
+     * Export data to XLSX (Excel) format
+     * GET /export/xlsx
+     *
+     * Returns Excel file as blob for download or processing.
+     *
+     * @example
+     * // Export stock movements
+     * const blob = await exportApi.toXLSX({
+     *   token,
+     *   collection: 'stockMovement',
+     *   filter: { type: 'sale', createdAt: { $gte: '2024-01-01' } }
+     * });
+     */
+    toXLSX({ token, collection, filter, select, options, }: {
+        token: string;
+        collection: ExportCollection;
+        filter?: Record<string, unknown> | string;
+        select?: string;
+        options?: FetchOptions;
+    }): Promise<Blob>;
+    /**
+     * Export data with specified format
+     * Convenience method for format-agnostic exports
+     *
+     * @example
+     * const format = userPreference.exportFormat; // 'csv' | 'xlsx'
+     * const blob = await exportApi.export({
+     *   token,
+     *   format,
+     *   collection: 'customer',
+     *   select: 'name,phone,email'
+     * });
+     */
+    export({ token, format, collection, filter, select, options, }: {
+        token: string;
+        format: ExportFormat;
+        collection: ExportCollection;
+        filter?: Record<string, unknown> | string;
+        select?: string;
+        options?: FetchOptions;
+    }): Promise<Blob>;
+    /**
+     * Trigger browser download of blob
+     * Creates temporary link and clicks it to download file
+     *
+     * @example
+     * const blob = await exportApi.toCSV({ token, collection: 'product' });
+     * exportApi.downloadFile(blob, 'products.csv');
+     */
+    downloadFile(blob: Blob, filename: string): void;
+    /**
+     * Get suggested filename based on collection and format
+     *
+     * @example
+     * const filename = exportApi.getSuggestedFilename('product', 'csv');
+     * // Returns: 'products-2024-12-11.csv'
+     */
+    getSuggestedFilename(collection: ExportCollection, format: ExportFormat): string;
+}
+declare const exportApi: ExportApi;
+
+/**
+ * Export and download in one call
+ * Convenience wrapper for common use case
+ *
+ * @example
+ * await exportAndDownload({
+ *   token,
+ *   format: 'xlsx',
+ *   collection: 'order',
+ *   filter: { status: 'delivered' }
+ * });
+ */
+declare function exportAndDownload({ token, format, collection, filter, select, filename, }: {
+    token: string;
+    format: ExportFormat;
+    collection: ExportCollection;
+    filter?: Record<string, unknown> | string;
+    select?: string;
+    filename?: string;
+}): Promise<void>;
+/**
+ * Read CSV blob as text
+ * Useful for preview or parsing
+ *
+ * @example
+ * const blob = await exportApi.toCSV({ token, collection: 'customer' });
+ * const csvText = await readCSVBlob(blob);
+ * console.log('First 100 chars:', csvText.slice(0, 100));
+ */
+declare function readCSVBlob(blob: Blob): Promise<string>;
+/**
+ * Parse CSV text to array of objects
+ * Simple CSV parser for client-side processing
+ *
+ * @example
+ * const csvText = await readCSVBlob(blob);
+ * const data = parseCSV(csvText);
+ * console.log('First row:', data[0]);
+ */
+declare function parseCSV(csvText: string): Array<Record<string, string>>;
+/**
+ * Common filter builders for exports
+ */
+declare const ExportFilters: {
+    /** Orders by date range */
+    ordersByDateRange: (startDate: string, endDate: string) => {
+        createdAt: {
+            $gte: string;
+            $lte: string;
+        };
+    };
+    /** Orders by status */
+    ordersByStatus: (status: string | string[]) => {
+        status: {
+            $in: string[];
+        };
+    } | {
+        status: string;
+    };
+    /** Transactions by date and status */
+    transactionsByDate: (startDate: string, endDate: string, status?: string) => {
+        status?: string | undefined;
+        transactionDate: {
+            $gte: string;
+            $lte: string;
+        };
+    };
+    /** Stock movements by type and date */
+    movementsByType: (type: string, startDate?: string, endDate?: string) => {
+        createdAt?: {
+            $gte: string;
+            $lte: string;
+        } | undefined;
+        type: string;
+    };
+    /** Products by category */
+    productsByCategory: (category: string | string[]) => {
+        category: {
+            $in: string[];
+        };
+    } | {
+        category: string;
+    };
+    /** Customers with orders */
+    customersWithOrders: () => {
+        'stats.totalOrders': {
+            $gt: number;
+        };
+    };
+};
+/**
+ * Common field selections for exports
+ */
+declare const ExportFields: {
+    /** Product essentials */
+    productBasic: string;
+    productFull: string;
+    /** Order essentials */
+    orderBasic: string;
+    orderFull: string;
+    /** Customer essentials */
+    customerBasic: string;
+    customerFull: string;
+    /** Transaction essentials */
+    transactionBasic: string;
+    transactionFull: string;
+    /** Stock essentials */
+    stockBasic: string;
+    stockFull: string;
+    /** Movement essentials */
+    movementBasic: string;
+    movementFull: string;
+};
+
+export { type Archive, type ArchiveOptions, type ArchiveResult, type ArchiveType, type CleanupResult, type CreateArchivePayload, ExportApi, type ExportCollection, ExportFields, ExportFilters, type ExportFormat, type ExportParams, type ExportResponse, type ManualRejectPayload, type ManualRejectResponse, type ManualRejectResponseData, type ManualVerifyPayload, type ManualVerifyResponse, type ManualVerifyResponseData, type PaymentGatewayProvider, type ProviderWebhookPayload, type ProviderWebhookResponse, type ProviderWebhookResponseData, type SSLCommerzStatus, type StockMovementStats, type StripeWebhookEventType, type TransactionEntityRef, type TransactionStats, WebhookApi, type WebhookErrorName, type WebhookErrorResponse, exportAndDownload, exportApi, parseCSV, readCSVBlob, webhookApi };

package/dist/platform/index.js

@@ -0,0 +1,8 @@
+"use client";
+export { BRANCH_KEYS, BranchApi, COUPON_KEYS, CouponApi, ExportApi, ExportFields, ExportFilters, PLATFORM_KEYS, PlatformConfigApi, USER_KEYS, UserApi, WebhookApi, branchApi, branchHooks, businessApi, couponApi, couponHooks, exportAndDownload, exportApi, isHeadOffice, isSubBranch, parseCSV, platformApi, platformConfigApi, readCSVBlob, useBranchActions, useBranchDetail, useBranchNavigation, useBranches, useCouponActions, useCouponDetail, useCouponNavigation, useCoupons, useDeliveryZones, useMembershipConfig, usePaymentMethods, usePlatformConfig, useUpdatePlatformConfig, useUserActions, useUserDetail, useUserNavigation, useUsers, userApi, userHooks, webhookApi } from '../chunk-OF5M6R2S.js';
+import '../chunk-I5TIKUIQ.js';
+import '../chunk-B6MPVOV7.js';
+import '../chunk-U3XT35GZ.js';
+import '../chunk-VR36QVX2.js';
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/platform/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}