shopoflex-types 1.0.65 → 1.0.67

package/dist/accounting.d.ts

@@ -0,0 +1,353 @@
+import { PaginatedResponse } from "./common";
+export interface SupplierContactInfo {
+    email?: string;
+    phone?: string;
+    address?: string;
+}
+export interface SupplierPaymentTerms {
+    method: 'cash' | 'credit' | 'check';
+    creditDays: number;
+}
+export interface SupplierType {
+    _id?: any;
+    name: string;
+    contactInfo: SupplierContactInfo;
+    paymentTerms: SupplierPaymentTerms;
+    isActive: boolean;
+    vendorId: any;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface PurchaseOrderItem {
+    productId: any;
+    variantId: string;
+    quantity: number;
+    unitCost: number;
+    totalCost: number;
+    receivedQuantity: number;
+}
+export interface PurchaseOrderType {
+    _id?: any;
+    poNumber: string;
+    supplierId: any;
+    vendorId: any;
+    branchId: string;
+    items: PurchaseOrderItem[];
+    totalAmount: number;
+    status: 'draft' | 'sent' | 'confirmed' | 'partial' | 'completed' | 'cancelled';
+    expectedDelivery?: Date;
+    notes: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface InventoryAdjustmentType {
+    _id?: any;
+    vendorId: any;
+    branchId: string;
+    productId: any;
+    variantId: string;
+    adjustmentType: 'wastage' | 'damage' | 'theft' | 'expired' | 'restock' | 'correction';
+    quantityChanged: number;
+    unitCost: number;
+    totalValue: number;
+    reason: string;
+    approvedBy?: string;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface ExpenseType {
+    _id?: any;
+    vendorId: any;
+    branchId?: string;
+    category: 'utilities' | 'rent' | 'payroll' | 'insurance' | 'maintenance' | 'marketing' | 'supplies' | 'fees' | 'transportation' | 'other';
+    description: string;
+    amount: number;
+    expenseDate: Date;
+    isRecurring: boolean;
+    recurringPeriod?: 'monthly' | 'weekly' | 'yearly';
+    receiptUrl?: string;
+    isPaid: boolean;
+    paidDate?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface CashTransactionReference {
+    type: 'order' | 'purchase_order' | 'expense' | 'manual';
+    id?: any;
+}
+export interface CashTransactionType {
+    _id?: any;
+    vendorId: any;
+    branchId?: string;
+    type: 'in' | 'out';
+    category: 'sales_payment' | 'refund' | 'supplier_payment' | 'expense_payment' | 'loan' | 'investment' | 'withdrawal' | 'bank_fee' | 'other';
+    amount: number;
+    paymentMethod: 'cash' | 'card' | 'bank_transfer' | 'check' | 'digital_wallet';
+    reference?: CashTransactionReference;
+    description?: string;
+    transactionDate: Date;
+    processingFee: number;
+    netAmount: number;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface FinancialSummaryPeriod {
+    type: 'daily' | 'monthly';
+    date: Date;
+}
+export interface FinancialSummaryRevenue {
+    totalSales: number;
+    totalOrders: number;
+    averageOrderValue: number;
+}
+export interface FinancialSummaryCosts {
+    cogs: number;
+    expenses: number;
+    wastage: number;
+}
+export interface FinancialSummaryCashFlow {
+    cashIn: number;
+    cashOut: number;
+    netCashFlow: number;
+}
+export interface FinancialSummaryProfit {
+    gross: number;
+    net: number;
+}
+export interface FinancialSummaryType {
+    _id?: any;
+    vendorId: any;
+    branchId?: string;
+    period: FinancialSummaryPeriod;
+    revenue: FinancialSummaryRevenue;
+    costs: FinancialSummaryCosts;
+    cashFlow: FinancialSummaryCashFlow;
+    profit: FinancialSummaryProfit;
+    createdAt: Date;
+    updatedAt: Date;
+}
+export interface CreateSupplierRequest {
+    name: string;
+    contactInfo: SupplierContactInfo;
+    paymentTerms: SupplierPaymentTerms;
+}
+export interface CreatePurchaseOrderRequest {
+    supplierId: string;
+    branchId: string;
+    items: Omit<PurchaseOrderItem, 'receivedQuantity'>[];
+    expectedDelivery?: string;
+    notes?: string;
+}
+export interface ReceivePurchaseOrderRequest {
+    receivedItems: {
+        productId: string;
+        variantId: string;
+        receivedQuantity: number;
+        actualCost?: number;
+    }[];
+}
+export interface CreateInventoryAdjustmentRequest {
+    productId: string;
+    variantId: string;
+    branchId: string;
+    adjustmentType: InventoryAdjustmentType['adjustmentType'];
+    quantityChanged: number;
+    reason: string;
+    approvedBy?: string;
+}
+export interface CreateExpenseRequest {
+    branchId?: string;
+    category: ExpenseType['category'];
+    description: string;
+    amount: number;
+    expenseDate: string;
+    isRecurring?: boolean;
+    recurringPeriod?: ExpenseType['recurringPeriod'];
+}
+export interface MarkExpenseAsPaidRequest {
+    paymentMethod: CashTransactionType['paymentMethod'];
+    transactionDate?: string;
+}
+export interface CreateCashTransactionRequest {
+    branchId?: string;
+    type: CashTransactionType['type'];
+    category: CashTransactionType['category'];
+    amount: number;
+    paymentMethod: CashTransactionType['paymentMethod'];
+    reference?: CashTransactionReference;
+    description?: string;
+    transactionDate?: string;
+    processingFee?: number;
+}
+export interface SuppliersResponse extends PaginatedResponse<SupplierType> {
+}
+export interface PurchaseOrdersResponse extends PaginatedResponse<PurchaseOrderType> {
+}
+export interface InventoryAdjustmentsResponse extends PaginatedResponse<InventoryAdjustmentType> {
+}
+export interface ExpensesResponse extends PaginatedResponse<ExpenseType> {
+}
+export interface CashTransactionsResponse extends PaginatedResponse<CashTransactionType> {
+}
+export interface ExpensesByCategory {
+    category: string;
+    totalAmount: number;
+    count: number;
+    avgAmount: number;
+}
+export interface CashFlowSummary {
+    cashIn: number;
+    cashOut: number;
+    netCashFlow: number;
+}
+export interface CashFlowReport {
+    cashFlow: {
+        type: string;
+        totalAmount: number;
+        totalNetAmount: number;
+        totalProcessingFees: number;
+        count: number;
+    }[];
+    summary: CashFlowSummary;
+}
+export interface WastageReportItem {
+    type: string;
+    totalQuantity: number;
+    totalValue: number;
+    count: number;
+}
+export interface FinancialReportRevenue {
+    totalRevenue: number;
+    totalOrders: number;
+    avgOrderValue: number;
+}
+export interface FinancialReportExpenses {
+    totalExpenses: number;
+    breakdown: ExpensesByCategory[];
+}
+export interface FinancialReportCashFlow {
+    cashIn: number;
+    cashOut: number;
+    netCashFlow: number;
+}
+export interface FinancialReportProfitability {
+    grossProfit: number;
+    profitMargin: number;
+}
+export interface FinancialReport {
+    period?: {
+        startDate?: string;
+        endDate?: string;
+    };
+    revenue: FinancialReportRevenue;
+    expenses: FinancialReportExpenses;
+    cashFlow: FinancialReportCashFlow;
+    profitability: FinancialReportProfitability;
+}
+export interface ProfitLossRevenue {
+    grossRevenue: number;
+    discounts: number;
+    netRevenue: number;
+}
+export interface ProfitLossOperatingExpenses {
+    total: number;
+    breakdown: {
+        category: string;
+        amount: number;
+    }[];
+}
+export interface ProfitLossReport {
+    period: {
+        start: Date;
+        end: Date;
+    };
+    revenue: ProfitLossRevenue;
+    costOfGoodsSold: number;
+    grossProfit: number;
+    operatingExpenses: ProfitLossOperatingExpenses;
+    netProfit: number;
+}
+export interface DailyCashFlow {
+    date: string;
+    cashIn: number;
+    cashOut: number;
+    netFlow: number;
+    transactionCount: number;
+}
+export interface CashFlowByCategory {
+    category: string;
+    type: 'in' | 'out';
+    totalAmount: number;
+    count: number;
+}
+export interface CashFlowAnalyticsReport {
+    period: {
+        start: Date;
+        end: Date;
+    };
+    dailyCashFlow: DailyCashFlow[];
+    cashFlowByCategory: CashFlowByCategory[];
+}
+export interface ExpenseTrend {
+    _id: {
+        year: number;
+        month: number;
+    };
+    totalExpenses: number;
+    categories: {
+        category: string;
+        amount: number;
+        count: number;
+    }[];
+}
+export interface RecurringAnalysis {
+    type: 'recurring' | 'one-time';
+    totalAmount: number;
+    count: number;
+    avgAmount: number;
+}
+export interface ExpenseAnalyticsReport {
+    expenseTrends: ExpenseTrend[];
+    topExpenses: Partial<ExpenseType>[];
+    recurringAnalysis: RecurringAnalysis[];
+}
+export interface SupplierPerformanceMetric {
+    supplierName: string;
+    totalOrders: number;
+    totalAmount: number;
+    completedOrders: number;
+    completionRate: number;
+    avgOrderValue: number;
+    avgDeliveryTime: number;
+}
+export interface SupplierPerformanceReport {
+    period: {
+        start: Date;
+        end: Date;
+    };
+    supplierPerformance: SupplierPerformanceMetric[];
+}
+export interface BaseQueryParams {
+    page?: number;
+    limit?: number;
+    startDate?: string;
+    endDate?: string;
+    branchId?: string;
+}
+export interface SuppliersQueryParams extends BaseQueryParams {
+    search?: string;
+}
+export interface PurchaseOrdersQueryParams extends BaseQueryParams {
+    status?: PurchaseOrderType['status'];
+    supplierId?: string;
+}
+export interface InventoryAdjustmentsQueryParams extends BaseQueryParams {
+    adjustmentType?: InventoryAdjustmentType['adjustmentType'];
+}
+export interface ExpensesQueryParams extends BaseQueryParams {
+    category?: ExpenseType['category'];
+}
+export interface CashTransactionsQueryParams extends BaseQueryParams {
+    type?: CashTransactionType['type'];
+    category?: CashTransactionType['category'];
+}

package/dist/accounting.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// ============================================
+// ERROR INTERFACES
+// ============================================

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export * from './common';
 export * from './filters';
+export * from './accounting';

package/dist/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./common"), exports);
 __exportStar(require("./filters"), exports);
+__exportStar(require("./accounting"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shopoflex-types",
-  "version": "1.0.65",
+  "version": "1.0.67",
   "description": "Shared TypeScript types for Shopoflex applications",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",