@classytic/commerce-sdk 0.1.0

package/dist/inventory-DCiIZh8P.d.ts

@@ -0,0 +1,742 @@
+import { e as Product, P as ProductImage, b as ProductVariant } from './product-p09zXkXB.js';
+
+/**
+ * POS Types
+ *
+ * Based on: POS_API_GUIDE.md
+ */
+
+interface VariantStock {
+    sku: string;
+    attributes: Record<string, string>;
+    quantity: number;
+    priceModifier?: number;
+    costPrice?: number;
+    barcode?: string;
+}
+interface BranchStock {
+    quantity: number;
+    inStock: boolean;
+    lowStock: boolean;
+    variants?: VariantStock[];
+}
+type PosProduct = Omit<Product, 'costPrice'> & {
+    costPrice?: number;
+    branchStock?: BranchStock;
+};
+interface PosProductsSummary {
+    totalItems: number;
+    totalQuantity: number;
+    lowStockCount: number;
+    outOfStockCount: number;
+}
+interface PosProductsBranch {
+    _id: string;
+    code: string;
+    name: string;
+}
+interface PosProductsResponse {
+    success: boolean;
+    branch: PosProductsBranch;
+    summary: PosProductsSummary;
+    docs: PosProduct[];
+    hasMore: boolean;
+    next: string | null;
+    method?: string;
+    limit?: number;
+}
+interface PosProductsParams {
+    branchId?: string;
+    /** Filter by category slug (matches both parent and child categories) */
+    category?: string;
+    search?: string;
+    inStockOnly?: boolean;
+    lowStockOnly?: boolean;
+    sort?: string;
+    after?: string;
+    limit?: number;
+}
+interface PosLookupProduct {
+    _id: string;
+    name: string;
+    basePrice: number;
+    productType: string;
+    slug?: string;
+    sku?: string;
+    barcode?: string;
+    category?: string;
+    costPrice?: number;
+    images?: ProductImage[];
+    variants?: Array<{
+        sku: string;
+        attributes: Record<string, string>;
+        priceModifier?: number;
+    }>;
+}
+interface PosLookupData {
+    product: PosLookupProduct;
+    variantSku?: string;
+    matchedVariant?: {
+        sku: string;
+        attributes: Record<string, string>;
+        priceModifier: number;
+    };
+    quantity: number;
+    branchId: string;
+}
+interface PosLookupResponse {
+    success: boolean;
+    data: PosLookupData;
+    message?: string;
+}
+interface PosOrderItem {
+    productId: string;
+    variantSku?: string;
+    quantity: number;
+    price?: number;
+}
+interface PosPayment {
+    method: PosPaymentMethod;
+    amount?: number;
+    reference?: string;
+}
+interface PosCustomer {
+    name?: string;
+    phone?: string;
+    id?: string;
+}
+interface PosOrderPayload {
+    items: PosOrderItem[];
+    branchId?: string;
+    branchSlug?: string;
+    customer?: PosCustomer;
+    membershipCardId?: string;
+    pointsToRedeem?: number;
+    payment?: PosPayment;
+    payments?: PosPayment[];
+    discount?: number;
+    deliveryMethod?: 'pickup' | 'delivery';
+    deliveryAddress?: {
+        recipientName: string;
+        recipientPhone: string;
+        addressLine1?: string;
+        city?: string;
+        [key: string]: unknown;
+    };
+    deliveryPrice?: number;
+    deliveryAreaId?: number;
+    terminalId?: string;
+    idempotencyKey?: string;
+    notes?: string;
+}
+type PosPaymentMethod = 'cash' | 'bkash' | 'nagad' | 'rocket' | 'upay' | 'bank_transfer' | 'card';
+interface PosReceiptItem {
+    name: string;
+    variant?: string;
+    quantity: number;
+    unitPrice: number;
+    total: number;
+    vatRate?: number;
+    vatAmount?: number;
+}
+interface PosReceiptVat {
+    applicable: boolean;
+    rate: number;
+    amount: number;
+    taxableAmount: number;
+    sellerBin?: string;
+    pricesIncludeVat?: boolean;
+}
+interface PosReceiptData {
+    orderId: string;
+    orderNumber: string;
+    invoiceNumber?: string;
+    date: string;
+    branch: {
+        name: string;
+        phone?: string;
+    };
+    cashier?: string;
+    customer?: {
+        name?: string;
+        phone?: string | null;
+    };
+    membership?: {
+        cardId?: string;
+        tier?: string;
+        pointsEarned?: number;
+        tierDiscount?: number;
+    };
+    items: PosReceiptItem[];
+    subtotal: number;
+    discount: number;
+    deliveryCharge: number;
+    vat?: PosReceiptVat;
+    total: number;
+    payment: {
+        method: string;
+        amount: number;
+        reference?: string;
+    };
+}
+interface PosReceiptResponse {
+    success: boolean;
+    data: PosReceiptData;
+}
+interface PosReceipt extends PosReceiptData {
+}
+interface PosLookupResult {
+    product: PosProduct;
+    variant?: ProductVariant;
+    scannedCode: string;
+}
+interface PosCartItem {
+    productId: string;
+    productName: string;
+    variantSku?: string;
+    variantLabel?: string;
+    quantity: number;
+    unitPrice: number;
+    lineTotal: number;
+    image?: string;
+}
+interface SplitPaymentEntry {
+    id: string;
+    paymentKey: string;
+    posMethod: PosPaymentMethod;
+    amount: string;
+    reference: string;
+    error?: string;
+}
+interface PaymentOption {
+    key: string;
+    posMethod: PosPaymentMethod;
+    label: string;
+    needsReference: boolean;
+    note?: string;
+    walletNumber?: string;
+}
+interface PaymentState {
+    mode: 'single' | 'split';
+    selectedKey: string | null;
+    selectedMethod: PosPaymentMethod;
+    reference: string;
+    cashReceived: string;
+    changeAmount: number;
+    amountDue: number;
+    splitEntries: SplitPaymentEntry[];
+    splitTotal: number;
+    splitRemaining: number;
+    splitIsBalanced: boolean;
+}
+
+/**
+ * Inventory Types
+ *
+ * Core types for the inventory module including:
+ * - Stock entries
+ * - Stock movements (audit trail)
+ * - Purchases
+ * - Transfers (challans)
+ * - Stock requests
+ * - Adjustments
+ */
+type StockMovementType = 'purchase' | 'sale' | 'transfer_in' | 'transfer_out' | 'adjustment' | 'initial' | 'return' | 'recount';
+type TransferStatus = 'draft' | 'approved' | 'dispatched' | 'in_transit' | 'received' | 'partial_received' | 'cancelled';
+type StockRequestStatus = 'pending' | 'approved' | 'rejected' | 'fulfilled' | 'partial_fulfilled' | 'cancelled';
+type TransferActionType = 'approve' | 'dispatch' | 'in-transit' | 'receive' | 'cancel';
+type StockRequestActionType = 'approve' | 'reject' | 'fulfill' | 'cancel';
+interface StockEntry {
+    _id: string;
+    product: string;
+    variantSku?: string | null;
+    branch: string | {
+        _id: string;
+        name: string;
+        code?: string;
+    };
+    quantity: number;
+    reservedQuantity: number;
+    /** Weighted Average Cost - admin only */
+    costPrice?: number;
+    reorderPoint?: number;
+    reorderQuantity?: number;
+    isActive: boolean;
+    lastCountDate?: string;
+    availableQuantity?: number;
+    needsReorder?: boolean;
+}
+interface StockMovement {
+    _id: string;
+    stockEntry?: string;
+    product: string | {
+        _id: string;
+        name: string;
+    };
+    variantSku?: string;
+    branch: string | {
+        _id: string;
+        name: string;
+        code?: string;
+    };
+    type: StockMovementType;
+    quantity: number;
+    balanceAfter?: number;
+    previousQuantity?: number;
+    newQuantity?: number;
+    reference?: {
+        model?: string;
+        id?: string;
+    } | string;
+    referenceType?: 'transfer' | 'order' | 'purchase' | 'adjustment';
+    costPrice?: number;
+    costPerUnit?: number;
+    reason?: string;
+    actor?: string | {
+        _id: string;
+        name: string;
+    };
+    notes?: string;
+    createdBy?: string | {
+        _id: string;
+        name: string;
+    };
+    createdAt: string;
+}
+type PurchaseStatus = 'draft' | 'approved' | 'received' | 'cancelled';
+type PurchasePaymentStatus = 'unpaid' | 'partial' | 'paid';
+type PurchasePaymentTerms = 'cash' | 'credit';
+type PurchaseActionType = 'receive' | 'pay' | 'cancel';
+interface PurchasePaymentDetails {
+    amount: number;
+    method: string;
+    reference?: string;
+    accountNumber?: string;
+    walletNumber?: string;
+    bankName?: string;
+    accountName?: string;
+    proofUrl?: string;
+    transactionDate?: string;
+    notes?: string;
+}
+interface PurchaseItem {
+    productId: string;
+    variantSku?: string;
+    quantity: number;
+    costPrice?: number;
+    expiryDate?: string;
+}
+interface PurchaseItemDoc {
+    _id?: string;
+    product: string | {
+        _id: string;
+        name: string;
+    };
+    productName: string;
+    variantSku?: string;
+    quantity: number;
+    costPrice: number;
+    discount?: number;
+    taxRate?: number;
+    lineTotal?: number;
+    taxableAmount?: number;
+    taxAmount?: number;
+}
+interface PurchaseStatusHistoryEntry {
+    status: PurchaseStatus;
+    timestamp: string;
+    actor?: string | {
+        _id: string;
+        name: string;
+    };
+    notes?: string;
+}
+interface Purchase {
+    _id: string;
+    invoiceNumber: string;
+    purchaseOrderNumber?: string;
+    supplier?: string | {
+        _id: string;
+        name: string;
+        code?: string;
+    };
+    branch: string | {
+        _id: string;
+        name: string;
+        code?: string;
+    };
+    invoiceDate?: string;
+    paymentTerms: PurchasePaymentTerms;
+    creditDays?: number;
+    dueDate?: string;
+    status: PurchaseStatus;
+    paymentStatus: PurchasePaymentStatus;
+    items: PurchaseItemDoc[];
+    subTotal?: number;
+    discountTotal?: number;
+    taxTotal?: number;
+    grandTotal: number;
+    paidAmount: number;
+    dueAmount: number;
+    transactionIds?: string[];
+    statusHistory?: PurchaseStatusHistoryEntry[];
+    notes?: string;
+    createdAt: string;
+    updatedAt: string;
+    createdBy?: string | {
+        _id: string;
+        name: string;
+    };
+    updatedBy?: string | {
+        _id: string;
+        name: string;
+    };
+    approvedAt?: string;
+    approvedBy?: string | {
+        _id: string;
+        name: string;
+    };
+    receivedAt?: string;
+    receivedBy?: string | {
+        _id: string;
+        name: string;
+    };
+}
+interface CreatePurchasePayload {
+    supplierId?: string;
+    purchaseOrderNumber?: string;
+    paymentTerms?: PurchasePaymentTerms;
+    creditDays?: number;
+    items: PurchaseItem[];
+    notes?: string;
+    autoApprove?: boolean;
+    autoReceive?: boolean;
+    payment?: PurchasePaymentDetails;
+}
+interface UpdatePurchasePayload {
+    supplierId?: string;
+    purchaseOrderNumber?: string;
+    paymentTerms?: PurchasePaymentTerms;
+    creditDays?: number;
+    items?: PurchaseItem[];
+    notes?: string;
+}
+interface PurchaseReceivePayload {
+    action: 'receive';
+}
+interface PurchasePayPayload {
+    action: 'pay';
+    amount: number;
+    method: string;
+    reference?: string;
+    accountNumber?: string;
+    walletNumber?: string;
+    bankName?: string;
+    accountName?: string;
+    proofUrl?: string;
+    transactionDate?: string;
+    notes?: string;
+}
+interface PurchaseCancelPayload {
+    action: 'cancel';
+    reason?: string;
+}
+type PurchaseActionPayload = PurchaseReceivePayload | PurchasePayPayload | PurchaseCancelPayload;
+type RecordPurchasePayload = CreatePurchasePayload;
+type TransferType = 'head_to_sub' | 'sub_to_sub' | 'sub_to_head';
+interface TransferItemPayload {
+    productId: string;
+    variantSku?: string;
+    quantity: number;
+    cartonNumber?: string;
+}
+interface TransferItem {
+    _id?: string;
+    product: string | {
+        _id: string;
+        name: string;
+    };
+    productName?: string;
+    productSku?: string;
+    variantSku?: string;
+    variantAttributes?: Record<string, string>;
+    cartonNumber?: string;
+    quantity: number;
+    quantityReceived?: number;
+    costPrice?: number;
+    notes?: string;
+}
+interface TransportDetails {
+    vehicleNumber?: string;
+    driverName?: string;
+    driverPhone?: string;
+    estimatedArrival?: string;
+    courierName?: string;
+    trackingId?: string;
+    notes?: string;
+}
+interface TransferStatusHistoryEntry {
+    status: TransferStatus;
+    timestamp: string;
+    actor?: string | {
+        _id: string;
+        name: string;
+    };
+    notes?: string | null;
+}
+interface InventoryTransfer {
+    _id: string;
+    challanNumber: string;
+    transferType?: TransferType;
+    documentType?: 'delivery_challan' | 'dispatch_note' | 'delivery_slip';
+    status: TransferStatus;
+    senderBranch: string | {
+        _id: string;
+        name: string;
+        code?: string;
+    };
+    receiverBranch: string | {
+        _id: string;
+        name: string;
+        code?: string;
+    };
+    items: TransferItem[];
+    totalItems?: number;
+    totalQuantity?: number;
+    totalValue?: number;
+    transport?: TransportDetails;
+    remarks?: string;
+    internalNotes?: string;
+    statusHistory?: TransferStatusHistoryEntry[];
+    dispatchMovements?: string[];
+    receiveMovements?: string[];
+    createdAt: string;
+    updatedAt: string;
+    createdBy?: string | {
+        _id: string;
+        name: string;
+    };
+    approvedBy?: string | {
+        _id: string;
+        name: string;
+    };
+    approvedAt?: string;
+    dispatchedBy?: string | {
+        _id: string;
+        name: string;
+    };
+    dispatchedAt?: string;
+    receivedBy?: string | {
+        _id: string;
+        name: string;
+    };
+    receivedAt?: string;
+    isComplete?: boolean;
+    canEdit?: boolean;
+    canApprove?: boolean;
+    canDispatch?: boolean;
+    canReceive?: boolean;
+    canCancel?: boolean;
+}
+type Transfer = InventoryTransfer;
+interface CreateTransferPayload {
+    senderBranchId?: string;
+    receiverBranchId: string;
+    documentType?: 'delivery_challan' | 'dispatch_note' | 'delivery_slip';
+    items: TransferItemPayload[];
+    remarks?: string;
+}
+interface TransferActionPayload {
+    action: TransferActionType;
+    transport?: TransportDetails;
+    items?: {
+        itemId?: string;
+        productId: string;
+        variantSku?: string;
+        quantityReceived: number;
+    }[];
+    reason?: string;
+}
+interface UpdateTransferPayload {
+    items?: TransferItemPayload[];
+    remarks?: string;
+    documentType?: 'delivery_challan' | 'dispatch_note' | 'delivery_slip';
+}
+interface DispatchTransferPayload {
+    transport?: TransportDetails;
+}
+interface ReceiveTransferPayload {
+    items?: {
+        itemId?: string;
+        productId: string;
+        variantSku?: string;
+        quantityReceived: number;
+    }[];
+}
+type StockRequestPriority = 'low' | 'normal' | 'high' | 'urgent';
+interface StockRequestItem {
+    productId: string;
+    variantSku?: string;
+    quantity: number;
+    approvedQuantity?: number;
+    quantityApproved?: number;
+    quantityFulfilled?: number;
+    notes?: string;
+}
+interface StockRequest {
+    _id: string;
+    requestNumber: string;
+    requestingBranch: string | {
+        _id: string;
+        name: string;
+        code?: string;
+    };
+    fulfillingBranch?: string | {
+        _id: string;
+        name: string;
+        code?: string;
+    };
+    items: StockRequestItem[];
+    status: StockRequestStatus;
+    priority?: StockRequestPriority;
+    reason?: string;
+    expectedDate?: string;
+    notes?: string;
+    reviewNotes?: string;
+    rejectionReason?: string;
+    totalQuantityRequested?: number;
+    totalQuantityApproved?: number;
+    totalQuantityFulfilled?: number;
+    createdAt: string;
+    updatedAt: string;
+    createdBy?: string | {
+        _id: string;
+        name: string;
+    };
+    reviewedBy?: string | {
+        _id: string;
+        name: string;
+    };
+}
+interface CreateStockRequestPayload {
+    requestingBranchId?: string;
+    items: {
+        productId: string;
+        variantSku?: string;
+        quantity: number;
+        notes?: string;
+    }[];
+    priority?: StockRequestPriority;
+    reason?: string;
+    expectedDate?: string;
+    notes?: string;
+}
+interface StockRequestActionPayload {
+    action: StockRequestActionType;
+    items?: {
+        productId: string;
+        variantSku?: string;
+        quantityApproved?: number;
+        quantity?: number;
+    }[];
+    reason?: string;
+    remarks?: string;
+    reviewNotes?: string;
+    documentType?: string;
+}
+interface AdjustmentItem {
+    productId: string;
+    variantSku?: string;
+    quantity: number;
+    mode: 'add' | 'remove' | 'set';
+    reason?: string;
+}
+interface CreateAdjustmentPayload {
+    branchId?: string;
+    adjustments?: AdjustmentItem[];
+    items?: AdjustmentItem[];
+    productId?: string;
+    variantSku?: string;
+    quantity?: number;
+    mode?: 'add' | 'remove' | 'set';
+    reason?: string;
+    notes?: string;
+    lostAmount?: number;
+    transactionData?: {
+        paymentMethod?: 'cash' | 'bkash' | 'nagad' | 'rocket' | 'bank_transfer';
+        reference?: string;
+    };
+}
+interface BulkAdjustmentPayload {
+    adjustments: AdjustmentItem[];
+    branchId?: string;
+    reason?: string;
+}
+interface AdjustStockPayload {
+    productId: string;
+    variantSku?: string;
+    quantity: number;
+    mode: 'add' | 'remove' | 'set';
+    branchId?: string;
+    reason?: string;
+    notes?: string;
+}
+interface AdjustStockResult {
+    processed?: number;
+    failed?: number;
+    results?: {
+        success?: unknown[];
+        failed?: {
+            productId?: string;
+            error?: string;
+        }[];
+    };
+    productId?: string;
+    variantSku?: string | null;
+    newQuantity?: number;
+    message?: string;
+    transaction?: {
+        _id?: string;
+        amount?: number;
+        category?: string;
+    };
+}
+interface LowStockItem {
+    _id?: string;
+    product: {
+        _id: string;
+        name: string;
+        slug?: string;
+        sku?: string;
+    };
+    variantSku?: string | null;
+    /** Backend may omit this when querying for a single selected branch */
+    branch?: {
+        _id: string;
+        name: string;
+        code?: string;
+    };
+    quantity: number;
+    reorderPoint: number;
+    needsReorder?: boolean;
+}
+interface TransferStats {
+    total: number;
+    byStatus: Record<TransferStatus, number>;
+    pending: number;
+    inTransit: number;
+}
+interface MovementQueryParams {
+    productId?: string;
+    branchId?: string;
+    type?: StockMovementType;
+    startDate?: string;
+    endDate?: string;
+    page?: number;
+    limit?: number;
+    sort?: string;
+    after?: string;
+    cursor?: string;
+}
+
+export type { CreateTransferPayload as $, PurchasePaymentTerms as A, BranchStock as B, PurchaseActionType as C, PurchasePaymentDetails as D, PurchaseItem as E, PurchaseItemDoc as F, PurchaseStatusHistoryEntry as G, Purchase as H, CreatePurchasePayload as I, PurchaseReceivePayload as J, PurchasePayPayload as K, PurchaseCancelPayload as L, PurchaseActionPayload as M, TransferType as N, TransferActionType as O, PosProduct as P, TransferItemPayload as Q, RecordPurchasePayload as R, SplitPaymentEntry as S, TransferStatus as T, UpdatePurchasePayload as U, VariantStock as V, TransferItem as W, TransportDetails as X, TransferStatusHistoryEntry as Y, InventoryTransfer as Z, Transfer as _, PosProductsResponse as a, TransferActionPayload as a0, UpdateTransferPayload as a1, DispatchTransferPayload as a2, ReceiveTransferPayload as a3, StockRequestStatus as a4, StockRequestActionType as a5, StockRequestPriority as a6, StockRequestItem as a7, StockRequest as a8, CreateStockRequestPayload as a9, StockRequestActionPayload as aa, AdjustmentItem as ab, CreateAdjustmentPayload as ac, BulkAdjustmentPayload as ad, AdjustStockPayload as ae, AdjustStockResult as af, LowStockItem as ag, TransferStats as ah, MovementQueryParams as ai, PosProductsSummary as b, PosProductsBranch as c, PosProductsParams as d, PosLookupProduct as e, PosLookupData as f, PosLookupResponse as g, PosLookupResult as h, PosOrderItem as i, PosPayment as j, PosCustomer as k, PosOrderPayload as l, PosPaymentMethod as m, PosReceiptItem as n, PosReceiptVat as o, PosReceiptData as p, PosReceiptResponse as q, PosReceipt as r, PosCartItem as s, PaymentOption as t, PaymentState as u, StockEntry as v, StockMovement as w, StockMovementType as x, PurchaseStatus as y, PurchasePaymentStatus as z };