shopoflex-types 1.0.56 → 1.0.59

package/dist/common.d.ts

@@ -595,12 +595,12 @@ export interface PaginationOptions {
 export interface PaginatedResponse<T> {
     data: T[];
     pagination: {
-        currentPage: number;
-        totalPages: number;
+        page: number;
+        limit: number;
         totalItems: number;
+        totalPages: number;
         hasNextPage: boolean;
         hasPrevPage: boolean;
-        limit: number;
     };
     filters?: Record<string, any>;
     sort?: {
@@ -627,7 +627,7 @@ export interface SearchConfig {
 export interface successResponse {
     data: any[];
     totalPages: number;
-    currentPage: number;
+    page: number;
     count: number;
     hasNextPage: boolean;
     hasPrevPage: boolean;

package/dist/filters.d.ts

@@ -0,0 +1,246 @@
+export interface BaseFilters {
+    search?: string;
+    page?: number;
+    limit?: number;
+    sortBy?: string;
+    sortOrder?: 'asc' | 'desc';
+}
+export interface ProductFilters extends BaseFilters {
+    isActive?: boolean;
+    hasVariants?: boolean;
+    hasModifiers?: boolean;
+    featured?: boolean;
+    vendorId?: string;
+    categoriesIds?: string | string[];
+    branchesIds?: string | string[];
+    tags?: string | string[];
+    inStock?: boolean;
+    minStock?: number;
+    maxStock?: number;
+    exactStock?: number;
+    branchId?: string;
+    variantPrice?: number;
+    minPrice?: number;
+    maxPrice?: number;
+    priceRange?: [number, number] | string;
+    costRange?: [number, number] | string;
+    discountedPriceRange?: [number, number] | string;
+    variantColor?: string;
+    variantSize?: string;
+    variantMaterial?: string;
+    variantAttribute?: string;
+    variantAttributeValue?: string;
+    variantIndex?: number;
+    variantSku?: string;
+    variantBarcode?: string;
+    hasBarcode?: boolean;
+    hasVariantFiles?: boolean;
+    variantActive?: boolean;
+    allowDecimal?: boolean;
+    unit?: string;
+    stockBehavior?: 'showOutOfStock' | 'allowOrdering' | 'hideFromStore';
+    dateRange?: [Date, Date] | [string, string] | string;
+    anyVariantPrice?: number;
+    anyVariantMinStock?: number;
+    minQuantityRange?: [number, number] | string;
+}
+export interface OrderFilters extends BaseFilters {
+    status?: 'pending' | 'confirmed' | 'preparing' | 'ready' | 'delivered' | 'cancelled' | 'completed' | string;
+    paid?: boolean;
+    vendorId?: string;
+    customerId?: string;
+    branchId?: string;
+    paymentMethod?: 'cash' | 'card' | 'transfer' | 'wallet' | 'cod' | string;
+    orderNumber?: string;
+    customerPhone?: string;
+    customerDialCode?: string;
+    amountRange?: [number, number] | string;
+    cartItemCount?: number;
+    minCartItems?: number;
+    dateRange?: [Date, Date] | [string, string] | string;
+    today?: boolean;
+    yesterday?: boolean;
+    thisWeek?: boolean;
+}
+export interface CustomerFilters extends BaseFilters {
+    isAnonymos?: boolean;
+    vendors?: string | string[];
+    hasAddresses?: boolean;
+    uid?: string;
+    phoneNumber?: string;
+    fullPhone?: string;
+    phoneDialCode?: string;
+    registeredAfter?: Date | string;
+    registeredBefore?: Date | string;
+}
+export interface DiscountFilters extends BaseFilters {
+    status?: 'active' | 'paused' | 'expired' | 'exhausted' | string;
+    type?: 'fixed' | 'percentage' | string;
+    vendorId?: string;
+    isAutomatic?: boolean;
+    combinable?: boolean;
+    firstTimeUsersOnly?: boolean;
+    discountCategory?: string;
+    valueRange?: [number, number] | string;
+    startDateRange?: [Date, Date] | [string, string] | string;
+    endDateRange?: [Date, Date] | [string, string] | string;
+    activeNow?: boolean;
+    expired?: boolean;
+    expiringSoon?: boolean;
+}
+/**
+ * Parse URL query string back to filter object
+ * @param queryString - URL query string
+ * @returns Parsed filter object
+ */
+export declare const parseQuery: (queryString: string) => Record<string, any>;
+/**
+ * Validate and clean filter object
+ * Removes undefined/null values and validates types
+ */
+export declare const cleanFilters: <T extends Record<string, any>>(filters: T) => Partial<T>;
+/**
+ * Merge multiple filter objects
+ * Later objects override earlier ones
+ */
+export declare const mergeFilters: <T extends Record<string, any>>(...filterObjects: Partial<T>[]) => Partial<T>;
+/**
+ * Build query string for any filter object
+ * @param filters - Any filter object
+ * @returns URL query string
+ */
+export declare const buildQuery: (filters: Record<string, any>) => string;
+/**
+ * Build query string for product filtering
+ * @param filters - Typed product filter object
+ * @returns URL query string
+ */
+export declare const buildProductQuery: (filters: ProductFilters) => string;
+/**
+ * Build query string for order filtering
+ * @param filters - Typed order filter object
+ * @returns URL query string
+ */
+export declare const buildOrderQuery: (filters: OrderFilters) => string;
+/**
+ * Build query string for customer filtering
+ * @param filters - Typed customer filter object
+ * @returns URL query string
+ */
+export declare const buildCustomerQuery: (filters: CustomerFilters) => string;
+/**
+ * Build query string for discount filtering
+ * @param filters - Typed discount filter object
+ * @returns URL query string
+ */
+export declare const buildDiscountQuery: (filters: DiscountFilters) => string;
+/**
+ * Create a complete API URL with typed filters
+ * @param baseUrl - Base API URL
+ * @param filters - Typed filter object
+ * @returns Complete URL with query string
+ */
+export declare const buildUrl: (baseUrl: string, filters: Record<string, any>) => string;
+/**
+ * Create product API URL
+ * @param baseUrl - Base API URL
+ * @param filters - Product filters
+ * @returns Complete URL
+ */
+export declare const buildProductUrl: (baseUrl: string, filters: ProductFilters) => string;
+/**
+ * Create order API URL
+ * @param baseUrl - Base API URL
+ * @param filters - Order filters
+ * @returns Complete URL
+ */
+export declare const buildOrderUrl: (baseUrl: string, filters: OrderFilters) => string;
+/**
+ * Create customer API URL
+ * @param baseUrl - Base API URL
+ * @param filters - Customer filters
+ * @returns Complete URL
+ */
+export declare const buildCustomerUrl: (baseUrl: string, filters: CustomerFilters) => string;
+/**
+ * Create discount API URL
+ * @param baseUrl - Base API URL
+ * @param filters - Discount filters
+ * @returns Complete URL
+ */
+export declare const buildDiscountUrl: (baseUrl: string, filters: DiscountFilters) => string;
+export declare const QueryBuilder: {
+    readonly build: (filters: Record<string, any>) => string;
+    readonly buildProduct: (filters: ProductFilters) => string;
+    readonly buildOrder: (filters: OrderFilters) => string;
+    readonly buildCustomer: (filters: CustomerFilters) => string;
+    readonly buildDiscount: (filters: DiscountFilters) => string;
+    readonly parse: (queryString: string) => Record<string, any>;
+};
+export declare const UrlBuilder: {
+    readonly build: (baseUrl: string, filters: Record<string, any>) => string;
+    readonly buildProduct: (baseUrl: string, filters: ProductFilters) => string;
+    readonly buildOrder: (baseUrl: string, filters: OrderFilters) => string;
+    readonly buildCustomer: (baseUrl: string, filters: CustomerFilters) => string;
+    readonly buildDiscount: (baseUrl: string, filters: DiscountFilters) => string;
+};
+export declare const FilterUtils: {
+    readonly clean: <T extends Record<string, any>>(filters: T) => Partial<T>;
+    readonly merge: <T extends Record<string, any>>(...filterObjects: Partial<T>[]) => Partial<T>;
+};
+export declare const FilterAPI: {
+    readonly QueryBuilder: {
+        readonly build: (filters: Record<string, any>) => string;
+        readonly buildProduct: (filters: ProductFilters) => string;
+        readonly buildOrder: (filters: OrderFilters) => string;
+        readonly buildCustomer: (filters: CustomerFilters) => string;
+        readonly buildDiscount: (filters: DiscountFilters) => string;
+        readonly parse: (queryString: string) => Record<string, any>;
+    };
+    readonly UrlBuilder: {
+        readonly build: (baseUrl: string, filters: Record<string, any>) => string;
+        readonly buildProduct: (baseUrl: string, filters: ProductFilters) => string;
+        readonly buildOrder: (baseUrl: string, filters: OrderFilters) => string;
+        readonly buildCustomer: (baseUrl: string, filters: CustomerFilters) => string;
+        readonly buildDiscount: (baseUrl: string, filters: DiscountFilters) => string;
+    };
+    readonly FilterUtils: {
+        readonly clean: <T extends Record<string, any>>(filters: T) => Partial<T>;
+        readonly merge: <T extends Record<string, any>>(...filterObjects: Partial<T>[]) => Partial<T>;
+    };
+};
+declare const _default: {
+    buildQuery: (filters: Record<string, any>) => string;
+    buildProductQuery: (filters: ProductFilters) => string;
+    buildOrderQuery: (filters: OrderFilters) => string;
+    buildCustomerQuery: (filters: CustomerFilters) => string;
+    buildDiscountQuery: (filters: DiscountFilters) => string;
+    buildUrl: (baseUrl: string, filters: Record<string, any>) => string;
+    buildProductUrl: (baseUrl: string, filters: ProductFilters) => string;
+    buildOrderUrl: (baseUrl: string, filters: OrderFilters) => string;
+    buildCustomerUrl: (baseUrl: string, filters: CustomerFilters) => string;
+    buildDiscountUrl: (baseUrl: string, filters: DiscountFilters) => string;
+    parseQuery: (queryString: string) => Record<string, any>;
+    cleanFilters: <T extends Record<string, any>>(filters: T) => Partial<T>;
+    mergeFilters: <T extends Record<string, any>>(...filterObjects: Partial<T>[]) => Partial<T>;
+    QueryBuilder: {
+        readonly build: (filters: Record<string, any>) => string;
+        readonly buildProduct: (filters: ProductFilters) => string;
+        readonly buildOrder: (filters: OrderFilters) => string;
+        readonly buildCustomer: (filters: CustomerFilters) => string;
+        readonly buildDiscount: (filters: DiscountFilters) => string;
+        readonly parse: (queryString: string) => Record<string, any>;
+    };
+    UrlBuilder: {
+        readonly build: (baseUrl: string, filters: Record<string, any>) => string;
+        readonly buildProduct: (baseUrl: string, filters: ProductFilters) => string;
+        readonly buildOrder: (baseUrl: string, filters: OrderFilters) => string;
+        readonly buildCustomer: (baseUrl: string, filters: CustomerFilters) => string;
+        readonly buildDiscount: (baseUrl: string, filters: DiscountFilters) => string;
+    };
+    FilterUtils: {
+        readonly clean: <T extends Record<string, any>>(filters: T) => Partial<T>;
+        readonly merge: <T extends Record<string, any>>(...filterObjects: Partial<T>[]) => Partial<T>;
+    };
+};
+export default _default;

package/dist/filters.js

@@ -0,0 +1,318 @@
+"use strict";
+// =====================================================
+// TYPE DEFINITIONS
+// =====================================================
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FilterAPI = exports.FilterUtils = exports.UrlBuilder = exports.QueryBuilder = exports.buildDiscountUrl = exports.buildCustomerUrl = exports.buildOrderUrl = exports.buildProductUrl = exports.buildUrl = exports.buildDiscountQuery = exports.buildCustomerQuery = exports.buildOrderQuery = exports.buildProductQuery = exports.buildQuery = exports.mergeFilters = exports.cleanFilters = exports.parseQuery = void 0;
+// =====================================================
+// CORE UTILITIES
+// =====================================================
+/**
+ * Converts filter object to URL query string
+ * Handles arrays, dates, and nested values automatically
+ */
+const buildQueryString = (filters) => {
+    const parts = [];
+    Object.entries(filters).forEach(([key, value]) => {
+        if (value === undefined || value === null || value === '')
+            return;
+        // Handle arrays (convert to comma-separated string)
+        if (Array.isArray(value)) {
+            if (value.length === 2 && (key.includes('Range') || key.includes('range'))) {
+                // Range values like [min, max] or [startDate, endDate]
+                const rangeString = value.map(v => v instanceof Date ? v.toISOString().split('T')[0] : v).join(',');
+                parts.push(`${key}=${rangeString}`);
+            }
+            else {
+                // Regular arrays like tags, categories
+                parts.push(`${key}=${value.join(',')}`);
+            }
+        }
+        // Handle dates
+        else if (value instanceof Date) {
+            parts.push(`${key}=${value.toISOString().split('T')[0]}`);
+        }
+        // Handle primitives
+        else {
+            parts.push(`${key}=${value}`);
+        }
+    });
+    return parts.join('&');
+};
+/**
+ * Parse URL query string back to filter object
+ * @param queryString - URL query string
+ * @returns Parsed filter object
+ */
+const parseQuery = (queryString) => {
+    const result = {};
+    if (!queryString)
+        return result;
+    // Remove leading ? if present
+    const cleanQuery = queryString.startsWith('?') ? queryString.slice(1) : queryString;
+    // Split by & to get key=value pairs
+    const pairs = cleanQuery.split('&');
+    pairs.forEach(pair => {
+        const [key, value] = pair.split('=');
+        if (!key || value === undefined)
+            return;
+        // Handle comma-separated values
+        if (value.includes(',')) {
+            const parts = value.split(',');
+            // Check if it's a range (2 items) or array (multiple items)
+            if (parts.length === 2 && (key.includes('Range') || key.includes('range'))) {
+                // Try to parse as numbers for ranges
+                const [first, second] = parts;
+                const firstNum = parseFloat(first);
+                const secondNum = parseFloat(second);
+                if (!isNaN(firstNum) && !isNaN(secondNum)) {
+                    result[key] = [firstNum, secondNum];
+                }
+                else {
+                    // Date range or string range
+                    result[key] = parts;
+                }
+            }
+            else {
+                // Regular array
+                result[key] = parts;
+            }
+        }
+        // Handle boolean strings
+        else if (value === 'true' || value === 'false') {
+            result[key] = value === 'true';
+        }
+        // Handle numbers
+        else if (!isNaN(Number(value)) && value !== '') {
+            result[key] = Number(value);
+        }
+        // Handle strings
+        else {
+            result[key] = value;
+        }
+    });
+    return result;
+};
+exports.parseQuery = parseQuery;
+/**
+ * Validate and clean filter object
+ * Removes undefined/null values and validates types
+ */
+const cleanFilters = (filters) => {
+    const cleaned = {};
+    Object.entries(filters).forEach(([key, value]) => {
+        if (value !== undefined && value !== null && value !== '') {
+            // Handle arrays - remove empty values
+            if (Array.isArray(value)) {
+                const cleanedArray = value.filter(v => v !== undefined && v !== null && v !== '');
+                if (cleanedArray.length > 0) {
+                    cleaned[key] = cleanedArray;
+                }
+            }
+            else {
+                cleaned[key] = value;
+            }
+        }
+    });
+    return cleaned;
+};
+exports.cleanFilters = cleanFilters;
+/**
+ * Merge multiple filter objects
+ * Later objects override earlier ones
+ */
+const mergeFilters = (...filterObjects) => {
+    return Object.assign({}, ...filterObjects.map(exports.cleanFilters));
+};
+exports.mergeFilters = mergeFilters;
+// =====================================================
+// QUERY BUILDERS - Main Functions
+// =====================================================
+/**
+ * Build query string for any filter object
+ * @param filters - Any filter object
+ * @returns URL query string
+ */
+const buildQuery = (filters) => {
+    return buildQueryString(filters);
+};
+exports.buildQuery = buildQuery;
+/**
+ * Build query string for product filtering
+ * @param filters - Typed product filter object
+ * @returns URL query string
+ */
+const buildProductQuery = (filters) => {
+    return buildQueryString(filters);
+};
+exports.buildProductQuery = buildProductQuery;
+/**
+ * Build query string for order filtering
+ * @param filters - Typed order filter object
+ * @returns URL query string
+ */
+const buildOrderQuery = (filters) => {
+    return buildQueryString(filters);
+};
+exports.buildOrderQuery = buildOrderQuery;
+/**
+ * Build query string for customer filtering
+ * @param filters - Typed customer filter object
+ * @returns URL query string
+ */
+const buildCustomerQuery = (filters) => {
+    return buildQueryString(filters);
+};
+exports.buildCustomerQuery = buildCustomerQuery;
+/**
+ * Build query string for discount filtering
+ * @param filters - Typed discount filter object
+ * @returns URL query string
+ */
+const buildDiscountQuery = (filters) => {
+    return buildQueryString(filters);
+};
+exports.buildDiscountQuery = buildDiscountQuery;
+// =====================================================
+// URL BUILDERS - Convenience Functions
+// =====================================================
+/**
+ * Create a complete API URL with typed filters
+ * @param baseUrl - Base API URL
+ * @param filters - Typed filter object
+ * @returns Complete URL with query string
+ */
+const buildUrl = (baseUrl, filters) => {
+    const queryString = (0, exports.buildQuery)(filters);
+    return queryString ? `${baseUrl}?${queryString}` : baseUrl;
+};
+exports.buildUrl = buildUrl;
+/**
+ * Create product API URL
+ * @param baseUrl - Base API URL
+ * @param filters - Product filters
+ * @returns Complete URL
+ */
+const buildProductUrl = (baseUrl, filters) => {
+    return (0, exports.buildUrl)(baseUrl, filters);
+};
+exports.buildProductUrl = buildProductUrl;
+/**
+ * Create order API URL
+ * @param baseUrl - Base API URL
+ * @param filters - Order filters
+ * @returns Complete URL
+ */
+const buildOrderUrl = (baseUrl, filters) => {
+    return (0, exports.buildUrl)(baseUrl, filters);
+};
+exports.buildOrderUrl = buildOrderUrl;
+/**
+ * Create customer API URL
+ * @param baseUrl - Base API URL
+ * @param filters - Customer filters
+ * @returns Complete URL
+ */
+const buildCustomerUrl = (baseUrl, filters) => {
+    return (0, exports.buildUrl)(baseUrl, filters);
+};
+exports.buildCustomerUrl = buildCustomerUrl;
+/**
+ * Create discount API URL
+ * @param baseUrl - Base API URL
+ * @param filters - Discount filters
+ * @returns Complete URL
+ */
+const buildDiscountUrl = (baseUrl, filters) => {
+    return (0, exports.buildUrl)(baseUrl, filters);
+};
+exports.buildDiscountUrl = buildDiscountUrl;
+// =====================================================
+// GROUPED EXPORTS - For Better DX
+// =====================================================
+// Main query builders (most commonly used)
+exports.QueryBuilder = {
+    build: exports.buildQuery,
+    buildProduct: exports.buildProductQuery,
+    buildOrder: exports.buildOrderQuery,
+    buildCustomer: exports.buildCustomerQuery,
+    buildDiscount: exports.buildDiscountQuery,
+    parse: exports.parseQuery
+};
+// URL builders
+exports.UrlBuilder = {
+    build: exports.buildUrl,
+    buildProduct: exports.buildProductUrl,
+    buildOrder: exports.buildOrderUrl,
+    buildCustomer: exports.buildCustomerUrl,
+    buildDiscount: exports.buildDiscountUrl
+};
+// Filter utilities
+exports.FilterUtils = {
+    clean: exports.cleanFilters,
+    merge: exports.mergeFilters
+};
+// All-in-one object for comprehensive access
+exports.FilterAPI = {
+    QueryBuilder: exports.QueryBuilder,
+    UrlBuilder: exports.UrlBuilder,
+    FilterUtils: exports.FilterUtils
+};
+// =====================================================
+// DEFAULT EXPORT - Most Common Use Case
+// =====================================================
+exports.default = {
+    // Types (re-exported for convenience)
+    buildQuery: exports.buildQuery,
+    buildProductQuery: exports.buildProductQuery,
+    buildOrderQuery: exports.buildOrderQuery,
+    buildCustomerQuery: exports.buildCustomerQuery,
+    buildDiscountQuery: exports.buildDiscountQuery,
+    buildUrl: exports.buildUrl,
+    buildProductUrl: exports.buildProductUrl,
+    buildOrderUrl: exports.buildOrderUrl,
+    buildCustomerUrl: exports.buildCustomerUrl,
+    buildDiscountUrl: exports.buildDiscountUrl,
+    parseQuery: exports.parseQuery,
+    cleanFilters: exports.cleanFilters,
+    mergeFilters: exports.mergeFilters,
+    // Grouped objects
+    QueryBuilder: exports.QueryBuilder,
+    UrlBuilder: exports.UrlBuilder,
+    FilterUtils: exports.FilterUtils
+};
+/*
+==============================================
+USAGE EXAMPLES - Multiple Import Patterns
+==============================================
+
+// 1. Import specific functions (tree-shakable)
+import { buildProductQuery, ProductFilters } from 'your-package';
+
+// 2. Import grouped objects
+import { QueryBuilder, UrlBuilder } from 'your-package';
+
+// 3. Import default (all-in-one)
+import FilterAPI from 'your-package';
+
+// 4. Import everything
+import * as Filters from 'your-package';
+
+// Usage examples:
+
+// Method 1: Direct imports
+const filters: ProductFilters = { minStock: 10, isActive: true };
+const query = buildProductQuery(filters);
+
+// Method 2: Grouped objects
+const query2 = QueryBuilder.buildProduct(filters);
+const url = UrlBuilder.buildProduct('/api/products', filters);
+
+// Method 3: Default import
+const query3 = FilterAPI.QueryBuilder.buildProduct(filters);
+const url2 = FilterAPI.UrlBuilder.buildProduct('/api/products', filters);
+
+// Method 4: Namespace import
+const query4 = Filters.buildProductQuery(filters);
+const url3 = Filters.buildProductUrl('/api/products', filters);
+*/ 

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,4 +1,5 @@
 "use strict";
+// index.ts
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -14,4 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+// Export everything from existing common file
 __exportStar(require("./common"), exports);
+// Export everything from new filters file  
+__exportStar(require("./filters"), exports);

package/package.json

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