@classytic/commerce-sdk 0.1.1

package/dist/order-B3dCvHgK.d.ts

@@ -0,0 +1,360 @@
+/**
+ * Order Types
+ *
+ * Source of truth: modules/commerce/order/order.model.js
+ */
+type ShippingStatus = 'pending' | 'requested' | 'picked_up' | 'in_transit' | 'out_for_delivery' | 'delivered' | 'failed_attempt' | 'returned' | 'cancelled';
+type ShippingProvider = 'redx' | 'pathao' | 'steadfast' | 'paperfly' | 'sundarban' | 'sa_paribahan' | 'dhl' | 'fedex' | 'manual' | 'other';
+declare enum OrderStatus {
+    PENDING = "pending",
+    PROCESSING = "processing",
+    CONFIRMED = "confirmed",
+    SHIPPED = "shipped",
+    DELIVERED = "delivered",
+    CANCELLED = "cancelled"
+}
+declare enum PaymentStatus {
+    PENDING = "pending",
+    VERIFIED = "verified",
+    FAILED = "failed",
+    REFUNDED = "refunded",
+    PARTIALLY_REFUNDED = "partially_refunded",
+    CANCELLED = "cancelled"
+}
+/**
+ * Order Item
+ */
+interface OrderItem {
+    _id?: string;
+    product: string;
+    productName: string;
+    productSlug?: string;
+    variantSku?: string;
+    variantAttributes?: Record<string, string>;
+    variantPriceModifier?: number;
+    quantity: number;
+    price: number;
+    /**
+     * System field: Cost of Goods Sold at time of sale
+     * Used for profit calculation. Read-only.
+     */
+    costPriceAtSale?: number;
+    vatRate?: number;
+    vatAmount?: number;
+    lineTotal?: number;
+    lineTotalExVat?: number;
+    profit?: number | null;
+    profitMargin?: number | null;
+}
+interface OrderDelivery {
+    method: string;
+    price: number;
+    estimatedDays?: number;
+}
+/**
+ * Order Delivery Address
+ */
+interface OrderAddress {
+    /** Address label (e.g., "Home", "Office") - optional */
+    label?: string;
+    /** Recipient name for delivery label */
+    recipientName?: string;
+    /** Contact phone for delivery (format: 01XXXXXXXXX) */
+    recipientPhone?: string;
+    /** Street address (required for checkout) */
+    addressLine1?: string;
+    /** Additional address details (apartment, floor, etc.) */
+    addressLine2?: string;
+    /** Area ID from @classytic/bd-areas constants */
+    areaId?: number;
+    /** Area display name (e.g., "Mohammadpur", "Dhanmondi") */
+    areaName?: string;
+    /** Zone ID for delivery pricing (1-6) */
+    zoneId?: number;
+    /** Provider-specific area IDs for logistics integration */
+    providerAreaIds?: {
+        redx?: number;
+        pathao?: number;
+        steadfast?: number;
+    };
+    /** City/District name */
+    city?: string;
+    /** Division/State */
+    division?: string;
+    /** Postal code */
+    postalCode?: string;
+    /** Country (defaults to "Bangladesh") */
+    country?: string;
+}
+interface OrderVat {
+    applicable: boolean;
+    rate: number;
+    amount: number;
+    pricesIncludeVat: boolean;
+    taxableAmount: number;
+    sellerBin?: string;
+    invoiceNumber?: string;
+    invoiceIssuedAt?: string;
+    invoiceBranch?: string;
+    invoiceDateKey?: string;
+}
+interface OrderPayment {
+    transactionId?: string;
+    /** Amount in paisa (smallest unit). Divide by 100 for BDT display. */
+    amount: number;
+    status: PaymentStatus | string;
+    method: string;
+    reference?: string;
+    verifiedAt?: string;
+    verifiedBy?: string;
+}
+interface OrderShippingHistory {
+    status: ShippingStatus | string;
+    note?: string;
+    actor?: string;
+    timestamp: string;
+}
+interface OrderShipping {
+    provider?: ShippingProvider | string;
+    status?: ShippingStatus | string;
+    trackingNumber?: string;
+    trackingUrl?: string;
+    consignmentId?: string;
+    labelUrl?: string;
+    estimatedDelivery?: string;
+    requestedAt?: string;
+    pickedUpAt?: string;
+    deliveredAt?: string;
+    metadata?: Record<string, unknown>;
+    history?: OrderShippingHistory[];
+}
+/**
+ * Parcel metrics for delivery estimation
+ */
+interface OrderParcel {
+    /** Total weight in grams */
+    weightGrams: number;
+    /** Package dimensions in centimeters */
+    dimensionsCm?: {
+        length: number;
+        width: number;
+        height: number;
+    };
+    /** Number of items without weight data */
+    missingWeightItems: number;
+    /** Number of items without dimension data */
+    missingDimensionItems: number;
+}
+/**
+ * Cancellation request details
+ */
+interface CancellationRequest {
+    requested: boolean;
+    reason?: string;
+    requestedAt?: string;
+    requestedBy?: string;
+}
+/**
+ * Main Order Interface
+ */
+interface Order {
+    _id: string;
+    /** Virtual: last 8 chars of _id (uppercase) */
+    orderNumber?: string;
+    customer?: string;
+    customerName: string;
+    customerPhone?: string;
+    customerEmail?: string;
+    userId?: string;
+    items: OrderItem[];
+    subtotal: number;
+    discountAmount: number;
+    deliveryCharge: number;
+    totalAmount: number;
+    vat?: OrderVat;
+    delivery?: OrderDelivery;
+    deliveryAddress?: OrderAddress;
+    /** True if ordering on behalf of someone else (gift order) */
+    isGift?: boolean;
+    status: OrderStatus | string;
+    source: 'web' | 'pos' | 'api';
+    branch?: string;
+    terminalId?: string;
+    cashier?: string;
+    /** Idempotency key for safe retries */
+    idempotencyKey?: string;
+    /** Reservation ID for stock hold */
+    stockReservationId?: string;
+    stockReservationExpiresAt?: string;
+    currentPayment?: OrderPayment;
+    shipping?: OrderShipping;
+    /** Parcel metrics for delivery estimation */
+    parcel?: OrderParcel;
+    /** Customer cancellation request (awaiting admin review) */
+    cancellationRequest?: CancellationRequest;
+    /** Final cancellation reason (after cancelled) */
+    cancellationReason?: string;
+    notes?: string;
+    createdAt: string;
+    updatedAt: string;
+    canCancel?: boolean;
+    isCompleted?: boolean;
+    paymentStatus?: string;
+    paymentMethod?: string;
+    netAmount?: number;
+    grossAmount?: number;
+    trackingNumber?: string;
+    shippedAt?: string;
+    deliveredAt?: string;
+    shippingStatus?: string;
+}
+/**
+ * Payment Data for checkout
+ */
+interface PaymentData {
+    /**
+     * Payment method (optional, defaults to 'cash')
+     */
+    type?: 'cash' | 'bkash' | 'nagad' | 'rocket' | 'bank_transfer' | 'card' | string;
+    /**
+     * Payment gateway (default: 'manual')
+     */
+    gateway?: string;
+    /**
+     * Transaction ID/reference (recommended for verification)
+     */
+    reference?: string;
+    /**
+     * Mobile wallet sender phone (REQUIRED for bkash/nagad/rocket)
+     */
+    senderPhone?: string;
+    /**
+     * Additional payment verification details
+     */
+    paymentDetails?: {
+        walletNumber?: string;
+        walletType?: 'personal' | 'merchant';
+        bankName?: string;
+        accountNumber?: string;
+        accountName?: string;
+        proofUrl?: string;
+    };
+    /** Additional payment notes */
+    notes?: string;
+}
+/**
+ * Payload for Creating an Order (Web/API)
+ */
+interface CreateOrderPayload {
+    /** Delivery address (required) */
+    deliveryAddress: OrderAddress & {
+        recipientName: string;
+        recipientPhone: string;
+        addressLine1: string;
+        areaId: number;
+        areaName: string;
+        zoneId: number;
+        city: string;
+    };
+    /** Delivery method and pricing (required) */
+    delivery: OrderDelivery & {
+        method: string;
+        price: number;
+    };
+    /**
+     * Payment details for verification (optional, defaults to cash)
+     */
+    paymentData?: PaymentData;
+    /** True if ordering on behalf of someone else (gift order) */
+    isGift?: boolean;
+    /** Coupon code to apply */
+    couponCode?: string;
+    /** Order notes */
+    notes?: string;
+    /** Preferred branch ID for fulfillment */
+    branchId?: string;
+    /** Preferred branch slug (alternative to branchId) */
+    branchSlug?: string;
+    /** Idempotency key for safe retries (prevents duplicate orders) */
+    idempotencyKey?: string;
+}
+/**
+ * Payload for Updating Order Status (Admin)
+ */
+interface UpdateStatusPayload {
+    status: OrderStatus;
+    /** Optional note for status change */
+    note?: string;
+}
+/**
+ * Payload for Cancelling an Order
+ */
+interface CancelOrderPayload {
+    /** Cancellation reason */
+    reason?: string;
+    /** Process refund if payment was verified */
+    refund?: boolean;
+}
+/**
+ * Payload for Requesting Cancellation (awaits admin review)
+ */
+interface CancelRequestPayload {
+    /** Reason for cancellation request */
+    reason?: string;
+}
+/**
+ * Payload for Fulfilling/Shipping an Order (Admin)
+ */
+interface FulfillOrderPayload {
+    /** Shipping tracking number */
+    trackingNumber?: string;
+    /** Shipping carrier (e.g., Pathao, Redx) */
+    carrier?: string;
+    /** Fulfillment notes */
+    notes?: string;
+    /** Shipping date */
+    shippedAt?: string;
+    /** Estimated delivery date */
+    estimatedDelivery?: string;
+    /** Branch ID for inventory decrement (overrides order.branch) */
+    branchId?: string;
+    /** Branch slug (alternative to branchId) */
+    branchSlug?: string;
+    /**
+     * Record COGS expense transaction (default: false)
+     */
+    recordCogs?: boolean;
+}
+/**
+ * Payload for Refunding an Order (Admin)
+ */
+interface RefundOrderPayload {
+    /** Refund amount in smallest unit (paisa). Omit for full refund. */
+    amount?: number;
+    /** Refund reason */
+    reason?: string;
+}
+/**
+ * Payload for Requesting Shipping Pickup (Admin)
+ */
+interface RequestShippingPayload {
+    /** Shipping provider (required) */
+    provider: string;
+    /** Additional shipping options */
+    options?: Record<string, unknown>;
+}
+/**
+ * Payload for Updating Shipping Status (Admin/Webhook)
+ */
+interface UpdateShippingPayload {
+    /** Shipping status (required) */
+    status: string;
+    /** Status note */
+    note?: string;
+    /** Tracking number */
+    trackingNumber?: string;
+    /** Tracking URL */
+    trackingUrl?: string;
+}
+
+export { type CancellationRequest as C, type FulfillOrderPayload as F, OrderStatus as O, PaymentStatus as P, type RefundOrderPayload as R, type ShippingStatus as S, type UpdateStatusPayload as U, type ShippingProvider as a, type Order as b, type OrderItem as c, type OrderDelivery as d, type OrderAddress as e, type OrderVat as f, type OrderPayment as g, type OrderShipping as h, type OrderShippingHistory as i, type OrderParcel as j, type PaymentData as k, type CreateOrderPayload as l, type CancelOrderPayload as m, type CancelRequestPayload as n, type RequestShippingPayload as o, type UpdateShippingPayload as p };

package/dist/payment-BRboLqvU.d.ts

@@ -0,0 +1,127 @@
+import { A as ApiResponse } from './api-factory-B_h4RKBm.js';
+
+type PaymentStatus = "pending" | "verified" | "failed" | "refunded" | "partially_refunded" | "cancelled";
+/**
+ * Transaction reference info
+ */
+interface TransactionEntity {
+    referenceModel: "Order";
+    referenceId: string;
+}
+/**
+ * Verification result returned from backend
+ */
+interface VerificationResult {
+    transactionId: string;
+    status: PaymentStatus;
+    amount: number;
+    category: string;
+    verifiedAt: string;
+    verifiedBy: string;
+    entity: TransactionEntity | null;
+}
+/**
+ * Reject result returned from backend
+ */
+interface RejectResult {
+    transactionId: string;
+    status: "failed";
+    failedAt: string;
+    failureReason: string;
+}
+/**
+ * Verify payment request payload
+ */
+interface VerifyPaymentPayload {
+    /** Transaction ID (MongoDB ObjectId) */
+    transactionId: string;
+    /** Optional verification notes */
+    notes?: string;
+}
+/**
+ * Reject payment request payload
+ */
+interface RejectPaymentPayload {
+    /** Transaction ID (MongoDB ObjectId) */
+    transactionId: string;
+    /** Reason for rejection */
+    reason: string;
+}
+
+interface FetchOptions {
+    cache?: RequestCache;
+    revalidate?: number;
+    tags?: string[];
+}
+/**
+ * Payment API for admin payment management
+ *
+ * Manual Payment Verification Flow:
+ * 1. Customer places order → Transaction created with status 'pending'
+ * 2. Customer pays via bKash/Nagad/bank transfer/cash
+ * 3. Admin verifies payment via verifyPayment() endpoint
+ * 4. Backend updates transaction to 'verified'
+ * 5. Order status auto-updates to 'confirmed', payment status to 'verified'
+ *
+ * Endpoints:
+ * - POST /webhooks/payments/manual/verify - Verify pending payment (superadmin)
+ * - POST /webhooks/payments/manual/reject - Reject pending payment (superadmin)
+ */
+declare class PaymentApi {
+    private baseUrl;
+    /**
+     * Verify a manual payment (Admin/Superadmin only)
+     * POST /webhooks/payments/manual/verify
+     *
+     * Use this when admin confirms a customer's manual payment
+     * (bKash, Nagad, bank transfer, cash, etc.)
+     *
+     * After verification:
+     * - Transaction status → 'verified'
+     * - Order payment status → 'verified'
+     * - Order status → 'confirmed' (if was 'pending')
+     *
+     * @example
+     * const result = await paymentApi.verifyPayment({
+     *   token: adminToken,
+     *   data: {
+     *     transactionId: '507f1f77bcf86cd799439011',
+     *     notes: 'Verified bKash payment TrxID: ABC123'
+     *   }
+     * });
+     */
+    verifyPayment({ token, data, options, }: {
+        token: string;
+        data: VerifyPaymentPayload;
+        options?: FetchOptions;
+    }): Promise<ApiResponse<VerificationResult>>;
+    /**
+     * Reject a manual payment (Admin/Superadmin only)
+     * POST /webhooks/payments/manual/reject
+     *
+     * Use this when admin rejects a customer's payment claim
+     * (invalid reference, insufficient amount, fraud, etc.)
+     *
+     * After rejection:
+     * - Transaction status → 'failed'
+     * - Order payment status → 'failed'
+     * - Reason recorded in transaction
+     *
+     * @example
+     * const result = await paymentApi.rejectPayment({
+     *   token: adminToken,
+     *   data: {
+     *     transactionId: '507f1f77bcf86cd799439011',
+     *     reason: 'Invalid bKash TrxID - payment not found'
+     *   }
+     * });
+     */
+    rejectPayment({ token, data, options, }: {
+        token: string;
+        data: RejectPaymentPayload;
+        options?: FetchOptions;
+    }): Promise<ApiResponse<RejectResult>>;
+}
+declare const paymentApi: PaymentApi;
+
+export { PaymentApi as P, type RejectResult as R, type TransactionEntity as T, type VerificationResult as V, type VerifyPaymentPayload as a, type RejectPaymentPayload as b, paymentApi as p };

package/dist/payments/index.d.ts

@@ -0,0 +1,55 @@
+import { a as VerifyPaymentPayload, V as VerificationResult, b as RejectPaymentPayload, R as RejectResult } from '../payment-BRboLqvU.js';
+export { P as PaymentApi, T as TransactionEntity, p as paymentApi } from '../payment-BRboLqvU.js';
+import '../api-factory-B_h4RKBm.js';
+
+interface UsePaymentActionsReturn {
+    verifyPayment: (data: VerifyPaymentPayload) => Promise<VerificationResult>;
+    isVerifying: boolean;
+    rejectPayment: (data: RejectPaymentPayload) => Promise<RejectResult>;
+    isRejecting: boolean;
+    isLoading: boolean;
+}
+
+/**
+ * Payment verification actions for admin
+ *
+ * Manual Payment Verification Flow:
+ * 1. Customer places order → Transaction created with status 'pending'
+ * 2. Customer pays via bKash/Nagad/bank transfer/cash
+ * 3. Admin verifies payment via verifyPayment()
+ * 4. Backend updates transaction to 'verified'
+ * 5. Order status auto-updates to 'confirmed', payment status to 'verified'
+ *
+ * @param token - Auth token (admin/superadmin)
+ *
+ * @example
+ * ```tsx
+ * function PaymentVerifier({ transaction }) {
+ *   const { verifyPayment, rejectPayment, isLoading } = usePaymentActions(token);
+ *
+ *   const handleVerify = async () => {
+ *     await verifyPayment({
+ *       transactionId: transaction._id,
+ *       notes: 'Verified bKash payment TrxID: ABC123',
+ *     });
+ *   };
+ *
+ *   const handleReject = async () => {
+ *     await rejectPayment({
+ *       transactionId: transaction._id,
+ *       reason: 'Invalid bKash TrxID - payment not found',
+ *     });
+ *   };
+ *
+ *   return (
+ *     <>
+ *       <Button onClick={handleVerify} disabled={isLoading}>Verify</Button>
+ *       <Button onClick={handleReject} disabled={isLoading}>Reject</Button>
+ *     </>
+ *   );
+ * }
+ * ```
+ */
+declare function usePaymentActions(token: string): UsePaymentActionsReturn;
+
+export { RejectPaymentPayload, RejectResult, type UsePaymentActionsReturn, VerificationResult, VerifyPaymentPayload, usePaymentActions };

package/dist/payments/index.js

@@ -0,0 +1,6 @@
+"use client";
+export { PaymentApi, paymentApi, usePaymentActions } from '../chunk-5E57JODA.js';
+import '../chunk-U3XT35GZ.js';
+import '../chunk-IHCBBLLW.js';
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/payments/index.js.map

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