@react-pakistan/util-functions 1.25.39 → 1.25.41

package/api/stellar-solutions/type.d.ts

@@ -21,10 +21,6 @@ export declare enum QUOTE_STATUS {
     ACCEPTED = "ACCEPTED",
     DECLINED = "DECLINED"
 }
-export declare enum QUOTE_INVOICE_MODE {
-    CUSTOMER = "CUSTOMER",
-    COMPANY = "COMPANY"
-}
 export declare enum PAYMENT_TYPE {
     FULL_AMOUNT = "FULL_AMOUNT",
     PARTIAL_AMOUNT = "PARTIAL_AMOUNT"
@@ -70,6 +66,52 @@ export declare enum LS_KEYS {
     PRODUCTS = "stellar_products_cache",
     TAXES = "stellar_taxes_cache"
 }
+export declare enum POS_ORDER_STATUS {
+    OPEN = "OPEN",
+    CLOSED = "CLOSED",
+    CANCELLED = "CANCELLED",
+    REFUNDED = "REFUNDED"
+}
+export declare enum POS_PAYMENT_STATUS {
+    PENDING = "PENDING",
+    PAID = "PAID",
+    FAILED = "FAILED",
+    REFUNDED = "REFUNDED"
+}
+export declare enum POS_PAYMENT_METHOD_TYPE {
+    CASH = "CASH",
+    CARD = "CARD",
+    GIFT_CARD = "GIFT_CARD",
+    MOBILE_WALLET = "MOBILE_WALLET",
+    OTHER = "OTHER"
+}
+export declare enum POS_REGISTER_STATUS {
+    ACTIVE = "ACTIVE",
+    INACTIVE = "INACTIVE"
+}
+export declare enum POS_TAX_TYPE {
+    EXCLUSIVE = "EXCLUSIVE",
+    INCLUSIVE = "INCLUSIVE"
+}
+export declare enum POS_TABLE_STATUS {
+    AVAILABLE = "AVAILABLE",
+    OCCUPIED = "OCCUPIED",
+    RESERVED = "RESERVED"
+}
+export declare enum POS_RESERVATION_STATUS {
+    PENDING = "PENDING",
+    CONFIRMED = "CONFIRMED",
+    CANCELLED = "CANCELLED",
+    COMPLETED = "COMPLETED"
+}
+export declare enum POS_SHIFT_STATUS {
+    OPEN = "OPEN",
+    CLOSED = "CLOSED"
+}
+export declare enum POS_DISCOUNT_TYPE {
+    FIXED = "FIXED",
+    PERCENTAGE = "PERCENTAGE"
+}
 /**
  * Base entity interface with common audit fields and meta support
  */
@@ -323,3 +365,132 @@ export interface QuotesInvoicesOnStellarProducts {
     quantity: number;
     quoteInvoiceId: string;
 }
+export interface POSStoreBE extends BaseEntity {
+    name: string;
+    code?: string;
+    address?: string;
+    phone?: string;
+    email?: string;
+    currency: string;
+    meta?: any;
+    enabled: boolean;
+}
+export interface POSRegisterBE extends BaseEntity {
+    name: string;
+    storeId: string;
+    status: POS_REGISTER_STATUS;
+    meta?: any;
+}
+export interface POSShiftBE extends BaseEntity {
+    registerId: string;
+    openedByUserId?: string;
+    openedAt: Date;
+    closedAt?: Date;
+    openingAmount: number;
+    closingAmount?: number;
+    status: POS_SHIFT_STATUS;
+    meta?: any;
+}
+export interface POSCategoryBE extends BaseEntity {
+    name: string;
+    description?: string;
+    storeId: string;
+    parentId?: string;
+    meta?: any;
+}
+export interface POSProductBE extends BaseEntity {
+    sku?: string;
+    name: string;
+    description?: string;
+    price: number;
+    cost?: number;
+    stock: number;
+    storeId: string;
+    categoryId?: string;
+    meta?: any;
+}
+export interface POSProductVariantBE extends BaseEntity {
+    productId: string;
+    name: string;
+    sku?: string;
+    price: number;
+    stock: number;
+    meta?: any;
+}
+export interface POSCustomerBE extends BaseEntity {
+    name: string;
+    email?: string;
+    phone?: string;
+    storeId: string;
+    loyaltyPoints: number;
+    meta?: any;
+}
+export interface POSTableBE extends BaseEntity {
+    storeId: string;
+    name: string;
+    seats: number;
+    status: POS_TABLE_STATUS;
+    meta?: any;
+}
+export interface POSReservationBE extends BaseEntity {
+    tableId: string;
+    customerId: string;
+    startAt: Date;
+    endAt: Date;
+    partySize: number;
+    status: POS_RESERVATION_STATUS;
+    meta?: any;
+}
+export interface POSOrderBE extends BaseEntity {
+    orderNumber: string;
+    storeId: string;
+    registerId?: string;
+    customerId?: string;
+    tableId?: string;
+    status: POS_ORDER_STATUS;
+    paymentStatus: POS_PAYMENT_STATUS;
+    subTotal: number;
+    taxTotal: number;
+    discountTotal: number;
+    serviceCharge: number;
+    total: number;
+    note?: string;
+    meta?: any;
+}
+export interface POSOrderItemBE extends BaseEntity {
+    orderId: string;
+    productId?: string;
+    variantId?: string;
+    name: string;
+    quantity: number;
+    unitPrice: number;
+    total: number;
+    taxAmount: number;
+    discountAmount: number;
+    meta?: any;
+}
+export interface POSPaymentBE extends BaseEntity {
+    orderId: string;
+    amount: number;
+    method: POS_PAYMENT_METHOD_TYPE;
+    methodLabel?: string;
+    status: POS_PAYMENT_STATUS;
+    transactionRef?: string;
+    processedAt?: Date;
+    meta?: any;
+}
+export interface POSTaxBE extends BaseEntity {
+    name: string;
+    rate: number;
+    type: POS_TAX_TYPE;
+    isDefault: boolean;
+    storeId: string;
+    meta?: any;
+}
+export interface POSDiscountBE extends BaseEntity {
+    name: string;
+    type: POS_DISCOUNT_TYPE;
+    value: number;
+    storeId: string;
+    meta?: any;
+}

package/api/stellar-solutions/type.js

@@ -3,7 +3,7 @@
 // ENUMS
 // ============================================================================
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LS_KEYS = exports.LEAD_STATUS = exports.LEAD_TYPE = exports.LEAD_SOURCE = exports.PAYMENT_TYPE = exports.QUOTE_INVOICE_MODE = exports.QUOTE_STATUS = exports.INVOICE_STATUS = exports.DISCOUNT_UNIT = exports.QUOTE_INVOICE_CATEGORY = exports.GENDER = void 0;
+exports.POS_DISCOUNT_TYPE = exports.POS_SHIFT_STATUS = exports.POS_RESERVATION_STATUS = exports.POS_TABLE_STATUS = exports.POS_TAX_TYPE = exports.POS_REGISTER_STATUS = exports.POS_PAYMENT_METHOD_TYPE = exports.POS_PAYMENT_STATUS = exports.POS_ORDER_STATUS = exports.LS_KEYS = exports.LEAD_STATUS = exports.LEAD_TYPE = exports.LEAD_SOURCE = exports.PAYMENT_TYPE = exports.QUOTE_STATUS = exports.INVOICE_STATUS = exports.DISCOUNT_UNIT = exports.QUOTE_INVOICE_CATEGORY = exports.GENDER = void 0;
 var GENDER;
 (function (GENDER) {
     GENDER["MALE"] = "MALE";
@@ -32,11 +32,6 @@ var QUOTE_STATUS;
     QUOTE_STATUS["ACCEPTED"] = "ACCEPTED";
     QUOTE_STATUS["DECLINED"] = "DECLINED";
 })(QUOTE_STATUS || (exports.QUOTE_STATUS = QUOTE_STATUS = {}));
-var QUOTE_INVOICE_MODE;
-(function (QUOTE_INVOICE_MODE) {
-    QUOTE_INVOICE_MODE["CUSTOMER"] = "CUSTOMER";
-    QUOTE_INVOICE_MODE["COMPANY"] = "COMPANY";
-})(QUOTE_INVOICE_MODE || (exports.QUOTE_INVOICE_MODE = QUOTE_INVOICE_MODE = {}));
 var PAYMENT_TYPE;
 (function (PAYMENT_TYPE) {
     PAYMENT_TYPE["FULL_AMOUNT"] = "FULL_AMOUNT";
@@ -87,3 +82,61 @@ var LS_KEYS;
     LS_KEYS["PRODUCTS"] = "stellar_products_cache";
     LS_KEYS["TAXES"] = "stellar_taxes_cache";
 })(LS_KEYS || (exports.LS_KEYS = LS_KEYS = {}));
+// ============================================================================
+// POS ENUMS
+// ============================================================================
+var POS_ORDER_STATUS;
+(function (POS_ORDER_STATUS) {
+    POS_ORDER_STATUS["OPEN"] = "OPEN";
+    POS_ORDER_STATUS["CLOSED"] = "CLOSED";
+    POS_ORDER_STATUS["CANCELLED"] = "CANCELLED";
+    POS_ORDER_STATUS["REFUNDED"] = "REFUNDED";
+})(POS_ORDER_STATUS || (exports.POS_ORDER_STATUS = POS_ORDER_STATUS = {}));
+var POS_PAYMENT_STATUS;
+(function (POS_PAYMENT_STATUS) {
+    POS_PAYMENT_STATUS["PENDING"] = "PENDING";
+    POS_PAYMENT_STATUS["PAID"] = "PAID";
+    POS_PAYMENT_STATUS["FAILED"] = "FAILED";
+    POS_PAYMENT_STATUS["REFUNDED"] = "REFUNDED";
+})(POS_PAYMENT_STATUS || (exports.POS_PAYMENT_STATUS = POS_PAYMENT_STATUS = {}));
+var POS_PAYMENT_METHOD_TYPE;
+(function (POS_PAYMENT_METHOD_TYPE) {
+    POS_PAYMENT_METHOD_TYPE["CASH"] = "CASH";
+    POS_PAYMENT_METHOD_TYPE["CARD"] = "CARD";
+    POS_PAYMENT_METHOD_TYPE["GIFT_CARD"] = "GIFT_CARD";
+    POS_PAYMENT_METHOD_TYPE["MOBILE_WALLET"] = "MOBILE_WALLET";
+    POS_PAYMENT_METHOD_TYPE["OTHER"] = "OTHER";
+})(POS_PAYMENT_METHOD_TYPE || (exports.POS_PAYMENT_METHOD_TYPE = POS_PAYMENT_METHOD_TYPE = {}));
+var POS_REGISTER_STATUS;
+(function (POS_REGISTER_STATUS) {
+    POS_REGISTER_STATUS["ACTIVE"] = "ACTIVE";
+    POS_REGISTER_STATUS["INACTIVE"] = "INACTIVE";
+})(POS_REGISTER_STATUS || (exports.POS_REGISTER_STATUS = POS_REGISTER_STATUS = {}));
+var POS_TAX_TYPE;
+(function (POS_TAX_TYPE) {
+    POS_TAX_TYPE["EXCLUSIVE"] = "EXCLUSIVE";
+    POS_TAX_TYPE["INCLUSIVE"] = "INCLUSIVE";
+})(POS_TAX_TYPE || (exports.POS_TAX_TYPE = POS_TAX_TYPE = {}));
+var POS_TABLE_STATUS;
+(function (POS_TABLE_STATUS) {
+    POS_TABLE_STATUS["AVAILABLE"] = "AVAILABLE";
+    POS_TABLE_STATUS["OCCUPIED"] = "OCCUPIED";
+    POS_TABLE_STATUS["RESERVED"] = "RESERVED";
+})(POS_TABLE_STATUS || (exports.POS_TABLE_STATUS = POS_TABLE_STATUS = {}));
+var POS_RESERVATION_STATUS;
+(function (POS_RESERVATION_STATUS) {
+    POS_RESERVATION_STATUS["PENDING"] = "PENDING";
+    POS_RESERVATION_STATUS["CONFIRMED"] = "CONFIRMED";
+    POS_RESERVATION_STATUS["CANCELLED"] = "CANCELLED";
+    POS_RESERVATION_STATUS["COMPLETED"] = "COMPLETED";
+})(POS_RESERVATION_STATUS || (exports.POS_RESERVATION_STATUS = POS_RESERVATION_STATUS = {}));
+var POS_SHIFT_STATUS;
+(function (POS_SHIFT_STATUS) {
+    POS_SHIFT_STATUS["OPEN"] = "OPEN";
+    POS_SHIFT_STATUS["CLOSED"] = "CLOSED";
+})(POS_SHIFT_STATUS || (exports.POS_SHIFT_STATUS = POS_SHIFT_STATUS = {}));
+var POS_DISCOUNT_TYPE;
+(function (POS_DISCOUNT_TYPE) {
+    POS_DISCOUNT_TYPE["FIXED"] = "FIXED";
+    POS_DISCOUNT_TYPE["PERCENTAGE"] = "PERCENTAGE";
+})(POS_DISCOUNT_TYPE || (exports.POS_DISCOUNT_TYPE = POS_DISCOUNT_TYPE = {}));

package/general/fetch-data.d.ts

@@ -1,11 +1,13 @@
 import { API_METHODS } from '../constants/api-methods';
+export type FetchDataParamValue = string | number | boolean | null | undefined;
 export interface FetchDataParams {
     url: string;
     method?: API_METHODS;
     body?: string;
     headers?: Record<string, string>;
+    params?: Record<string, FetchDataParamValue>;
 }
-export declare const fetchData: ({ url, method, body, headers, }: FetchDataParams) => Promise<{
+export declare const fetchData: ({ url, method, body, headers, params, }: FetchDataParams) => Promise<{
     data: any | undefined;
     error: Error | undefined;
 }>;

package/general/fetch-data.js

@@ -49,14 +49,29 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetchData = void 0;
 var api_methods_1 = require("../constants/api-methods");
+var buildUrl = function (url, params) {
+    if (!params)
+        return url;
+    var filteredEntries = Object.entries(params).filter(function (entry) {
+        return entry[1] !== null && entry[1] !== undefined;
+    });
+    if (filteredEntries.length === 0)
+        return url;
+    var searchParams = new URLSearchParams(filteredEntries.map(function (_a) {
+        var key = _a[0], value = _a[1];
+        return [key, String(value)];
+    }));
+    var separator = url.includes('?') ? '&' : '?';
+    return "".concat(url).concat(separator).concat(searchParams.toString());
+};
 var fetchData = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
     var data, error, res, err_1;
-    var url = _b.url, _c = _b.method, method = _c === void 0 ? api_methods_1.API_METHODS.GET : _c, body = _b.body, headers = _b.headers;
+    var url = _b.url, _c = _b.method, method = _c === void 0 ? api_methods_1.API_METHODS.GET : _c, body = _b.body, headers = _b.headers, params = _b.params;
     return __generator(this, function (_d) {
         switch (_d.label) {
             case 0:
                 _d.trys.push([0, 3, , 4]);
-                return [4 /*yield*/, fetch(url, __assign(__assign({ method: method }, (headers ? { headers: headers } : {})), (method !== api_methods_1.API_METHODS.GET && body && { body: body })))];
+                return [4 /*yield*/, fetch(buildUrl(url, params), __assign(__assign({ method: method }, (headers ? { headers: headers } : {})), (method !== api_methods_1.API_METHODS.GET && body && { body: body })))];
             case 1:
                 res = _d.sent();
                 return [4 /*yield*/, res.json()];

package/general/generic-cache.d.ts

@@ -132,6 +132,27 @@ export declare const getCachedSingleItemSync: <T>(cacheKey: string, expirationMs
  * const workspace = await getCachedSingleItem<WorkspaceBE>(config, { subdomain: 'school1' });
  */
 export declare const getCachedSingleItem: <T>(config: CacheConfig, params?: Record<string, string>, headers?: Record<string, string>) => Promise<T | null>;
+/**
+ * Get cached data but fall back to the API when sync cache is empty.
+ *
+ * This helper first performs a quick synchronous cache check via
+ * `getCachedDataSync`. If that returns an empty result it will call
+ * the async `getCachedData` to fetch fresh data from the API and return
+ * the result. Use this when callers want a fast-path cache read but also
+ * need the ability to recall the API transparently when cache is missing.
+ */
+export declare const getCachedDataWithFallback: <T>(config: CacheConfig, params?: Record<string, unknown>, headers?: Record<string, string>) => Promise<ListResponse<T>>;
+/**
+ * Async variant to get a single item by ID with API fallback.
+ *
+ * Unlike `getCachedItemById` (sync), this function will call the API
+ * (via `getCachedDataWithFallback`) when the item is not available in
+ * the local cache. Requires a full `CacheConfig` so the API URL is
+ * available for fetching.
+ */
+export declare const getCachedItemByIdAsync: <T extends {
+    id: string;
+}>(config: CacheConfig, itemId: string, params?: Record<string, unknown>, headers?: Record<string, string>) => Promise<T | null>;
 /**
  * Invalidate (remove) cache for a module
  * Useful after create/update/delete operations

package/general/generic-cache.js

@@ -72,7 +72,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isCacheStale = exports.preloadCache = exports.invalidateCache = exports.getCachedSingleItem = exports.getCachedSingleItemSync = exports.getCachedItemById = exports.getCachedData = exports.getCachedDataSync = void 0;
+exports.isCacheStale = exports.preloadCache = exports.invalidateCache = exports.getCachedItemByIdAsync = exports.getCachedDataWithFallback = exports.getCachedSingleItem = exports.getCachedSingleItemSync = exports.getCachedItemById = exports.getCachedData = exports.getCachedDataSync = void 0;
 var constants_1 = require("../constants");
 var fetch_data_1 = require("./fetch-data");
 var local_storage_1 = require("../local-storage");
@@ -508,6 +508,86 @@ var getCachedSingleItem = function (config, params, headers) { return __awaiter(
     });
 }); };
 exports.getCachedSingleItem = getCachedSingleItem;
+/**
+ * Get cached data but fall back to the API when sync cache is empty.
+ *
+ * This helper first performs a quick synchronous cache check via
+ * `getCachedDataSync`. If that returns an empty result it will call
+ * the async `getCachedData` to fetch fresh data from the API and return
+ * the result. Use this when callers want a fast-path cache read but also
+ * need the ability to recall the API transparently when cache is missing.
+ */
+var getCachedDataWithFallback = function (config, params, headers) { return __awaiter(void 0, void 0, void 0, function () {
+    var expirationMs, sync, error_3;
+    var _a;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0:
+                expirationMs = (_a = config.expirationMs) !== null && _a !== void 0 ? _a : constants_1.ONE_DAY_IN_MS;
+                _b.label = 1;
+            case 1:
+                _b.trys.push([1, 3, , 4]);
+                sync = (0, exports.getCachedDataSync)(config.cacheKey, expirationMs);
+                if (sync &&
+                    sync.count > 0 &&
+                    Array.isArray(sync.items) &&
+                    sync.items.length > 0) {
+                    return [2 /*return*/, sync];
+                }
+                return [4 /*yield*/, (0, exports.getCachedData)({ config: config, params: params, headers: headers })];
+            case 2: 
+            // Sync cache empty — fetch from API and return result
+            return [2 /*return*/, _b.sent()];
+            case 3:
+                error_3 = _b.sent();
+                console.error("Error in getCachedDataWithFallback for ".concat(config.cacheKey, ":"), error_3);
+                return [2 /*return*/, { count: 0, items: [] }];
+            case 4: return [2 /*return*/];
+        }
+    });
+}); };
+exports.getCachedDataWithFallback = getCachedDataWithFallback;
+/**
+ * Async variant to get a single item by ID with API fallback.
+ *
+ * Unlike `getCachedItemById` (sync), this function will call the API
+ * (via `getCachedDataWithFallback`) when the item is not available in
+ * the local cache. Requires a full `CacheConfig` so the API URL is
+ * available for fetching.
+ */
+var getCachedItemByIdAsync = function (config, itemId, params, headers) { return __awaiter(void 0, void 0, void 0, function () {
+    var raw, found, list, error_4;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                if (!itemId)
+                    return [2 /*return*/, null];
+                _a.label = 1;
+            case 1:
+                _a.trys.push([1, 3, , 4]);
+                raw = (0, local_storage_1.getStorageValue)(config.cacheKey);
+                if (isCachedArrayShape(raw)) {
+                    found = raw.items.find(function (i) { return i.id === itemId; });
+                    if (found)
+                        return [2 /*return*/, found];
+                }
+                if (isCachedMapShape(raw)) {
+                    if (raw.items && raw.items[itemId])
+                        return [2 /*return*/, raw.items[itemId]];
+                }
+                return [4 /*yield*/, (0, exports.getCachedDataWithFallback)(config, params, headers)];
+            case 2:
+                list = _a.sent();
+                return [2 /*return*/, list.items.find(function (i) { return i.id === itemId; }) || null];
+            case 3:
+                error_4 = _a.sent();
+                console.error("Error in getCachedItemByIdAsync for ".concat(config.cacheKey, ":"), error_4);
+                return [2 /*return*/, null];
+            case 4: return [2 /*return*/];
+        }
+    });
+}); };
+exports.getCachedItemByIdAsync = getCachedItemByIdAsync;
 // ============================================================================
 // CACHE UTILITIES
 // ============================================================================

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-pakistan/util-functions",
-  "version": "1.25.39",
+  "version": "1.25.41",
   "description": "A library of all util functions",
   "main": "index.js",
   "scripts": {