@classytic/commerce-sdk 0.1.2 → 0.2.1

package/dist/inventory/types/inventory.d.ts

@@ -0,0 +1,485 @@
+import { StatusHistoryEntry } from "../../core/types/shared.js";
+
+//#region src/inventory/types/inventory.d.ts
+/** Flow OperationType — the actual types returned by the WMS kernel */
+type FlowOperationType = 'receipt' | 'transfer' | 'shipment' | 'return' | 'adjustment' | 'count';
+type FlowMoveStatus = 'draft' | 'planned' | 'waiting' | 'ready' | 'partially_done' | 'done' | 'cancelled';
+/** @deprecated Use FlowOperationType — legacy pre-Flow types */
+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;
+}
+/**
+ * StockMovement — maps to Flow's StockMove entity.
+ * Backend returns Flow documents directly from `flow.repositories.move.findMany()`.
+ */
+interface StockMovement {
+  _id: string;
+  organizationId: string;
+  moveGroupId: string;
+  operationType: FlowOperationType;
+  skuRef: string;
+  sourceLocationId: string;
+  destinationLocationId: string;
+  uom?: string;
+  quantityPlanned: number;
+  quantityReserved?: number;
+  quantityDone?: number;
+  status: FlowMoveStatus;
+  referenceType?: string;
+  referenceId?: string;
+  reservationIds?: string[];
+  trackingAssignments?: {
+    lotId?: string;
+    serialId?: string;
+    quantity?: number;
+  }[];
+  scheduledAt?: string;
+  executedAt?: string;
+  cancelledAt?: string;
+  createdBy?: string;
+  modifiedBy?: string;
+  metadata?: Record<string, unknown>;
+  createdAt?: string;
+  updatedAt?: 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;
+}
+type PurchaseStatusHistoryEntry = StatusHistoryEntry<PurchaseStatus>;
+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;
+}
+type TransferStatusHistoryEntry = StatusHistoryEntry<TransferStatus>;
+interface InventoryTransfer {
+  _id: string;
+  documentNumber: string;
+  transferType?: TransferType;
+  documentType?: 'delivery_note' | '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_note' | '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_note' | '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 {
+  product?: string;
+  productId?: string;
+  productName?: string;
+  productSku?: string;
+  variantSku?: string;
+  variantAttributes?: Record<string, string>;
+  cartonNumber?: string;
+  quantityRequested?: number;
+  approvedQuantity?: number;
+  quantityApproved?: number;
+  quantityFulfilled?: number;
+  currentStock?: number;
+  quantity?: 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[];
+  totalItems?: number;
+  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 {
+  skuRef: string;
+  quantity: number;
+  reserved: number;
+  available: number;
+  threshold: number;
+  deficit: number;
+}
+interface TransferStats {
+  total: number;
+  byStatus: Record<TransferStatus, number>;
+  pending: number;
+  inTransit: number;
+}
+interface MovementQueryParams {
+  /** Filter by skuRef (product/variant SKU) */
+  productId?: string;
+  /** Branch (organizationId) — required */
+  branchId?: string;
+  /** Filter by Flow operationType */
+  type?: FlowOperationType;
+  startDate?: string;
+  endDate?: string;
+  page?: number;
+  limit?: number;
+  sort?: string;
+}
+//#endregion
+export { AdjustStockPayload, AdjustStockResult, AdjustmentItem, BulkAdjustmentPayload, CreateAdjustmentPayload, CreatePurchasePayload, CreateStockRequestPayload, CreateTransferPayload, DispatchTransferPayload, FlowMoveStatus, FlowOperationType, InventoryTransfer, LowStockItem, MovementQueryParams, Purchase, PurchaseActionPayload, PurchaseActionType, PurchaseCancelPayload, PurchaseItem, PurchaseItemDoc, PurchasePayPayload, PurchasePaymentDetails, PurchasePaymentStatus, PurchasePaymentTerms, PurchaseReceivePayload, PurchaseStatus, PurchaseStatusHistoryEntry, ReceiveTransferPayload, RecordPurchasePayload, StockEntry, StockMovement, StockMovementType, StockRequest, StockRequestActionPayload, StockRequestActionType, StockRequestItem, StockRequestPriority, StockRequestStatus, Transfer, TransferActionPayload, TransferActionType, TransferItem, TransferItemPayload, TransferStats, TransferStatus, TransferStatusHistoryEntry, TransferType, TransportDetails, UpdatePurchasePayload, UpdateTransferPayload };

package/dist/inventory/types/supplier.d.ts

@@ -0,0 +1,90 @@
+import { ApiResponse, PaginatedResponse } from "../../core/api-factory.js";
+
+//#region src/inventory/types/supplier.d.ts
+type SupplierType = "local" | "import" | "manufacturer" | "wholesaler";
+type SupplierPaymentTerms = "cash" | "credit";
+interface Supplier {
+  _id: string;
+  /** Supplier name (unique for active suppliers) */
+  name: string;
+  /** Auto-generated code (e.g., SUP-0001) */
+  code?: string;
+  /** Supplier type */
+  type?: SupplierType;
+  /** Primary contact person */
+  contactPerson?: string;
+  /** Phone number */
+  phone?: string;
+  /** Email address */
+  email?: string;
+  /** Address */
+  address?: string;
+  /** Tax ID or BIN */
+  taxId?: string;
+  /** Payment terms */
+  paymentTerms?: SupplierPaymentTerms;
+  /** Credit days (0 for cash) */
+  creditDays?: number;
+  /** Credit limit in BDT */
+  creditLimit?: number;
+  /** Opening payable balance */
+  openingBalance?: number;
+  /** Internal notes */
+  notes?: string;
+  /** Free-form tags */
+  tags?: string[];
+  /** Active/inactive status */
+  isActive?: boolean;
+  createdAt?: string;
+  updatedAt?: string;
+}
+interface SupplierCreatePayload {
+  name: string;
+  code?: string;
+  type?: SupplierType;
+  contactPerson?: string;
+  phone?: string;
+  email?: string;
+  address?: string;
+  taxId?: string;
+  paymentTerms?: SupplierPaymentTerms;
+  creditDays?: number;
+  creditLimit?: number;
+  openingBalance?: number;
+  notes?: string;
+  tags?: string[];
+  isActive?: boolean;
+}
+interface SupplierUpdatePayload {
+  name?: string;
+  code?: string;
+  type?: SupplierType;
+  contactPerson?: string;
+  phone?: string;
+  email?: string;
+  address?: string;
+  taxId?: string;
+  paymentTerms?: SupplierPaymentTerms;
+  creditDays?: number;
+  creditLimit?: number;
+  openingBalance?: number;
+  notes?: string;
+  tags?: string[];
+  isActive?: boolean;
+}
+interface SupplierQueryParams {
+  page?: number;
+  limit?: number;
+  after?: string;
+  sort?: string | Record<string, 1 | -1 | "asc" | "desc">;
+  search?: string;
+  name?: string;
+  type?: SupplierType;
+  paymentTerms?: SupplierPaymentTerms;
+  isActive?: boolean;
+  [key: string]: unknown;
+}
+type SupplierListResponse = PaginatedResponse<Supplier>;
+type SupplierResponse = ApiResponse<Supplier>;
+//#endregion
+export { Supplier, SupplierCreatePayload, SupplierListResponse, SupplierPaymentTerms, SupplierQueryParams, SupplierResponse, SupplierType, SupplierUpdatePayload };