@react-pakistan/util-functions 1.25.48 → 1.25.50

package/api/stellar-solutions/types/pos.d.ts

@@ -0,0 +1,176 @@
+import { BaseEntity } from './common';
+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"
+}
+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/types/pos.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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 = void 0;
+// ============================================================================
+// 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/index.d.ts

@@ -66,7 +66,6 @@ export * from './get-href';
 export * from './get-month-name';
 export * from './get-month-number';
 export * from './get-pathname';
-export * from './get-week-day';
 export * from './image-url-to-base64';
 export * from './is-created-or-updated';
 export * from './is-next-button-disabled';

package/general/index.js

@@ -82,7 +82,6 @@ __exportStar(require("./get-href"), exports);
 __exportStar(require("./get-month-name"), exports);
 __exportStar(require("./get-month-number"), exports);
 __exportStar(require("./get-pathname"), exports);
-__exportStar(require("./get-week-day"), exports);
 __exportStar(require("./image-url-to-base64"), exports);
 __exportStar(require("./is-created-or-updated"), exports);
 __exportStar(require("./is-next-button-disabled"), exports);

package/index.d.ts

@@ -21,7 +21,7 @@ export * from './api/stellar-solutions/profile';
 export * from './api/stellar-solutions/quote-invoice-report';
 export * from './api/stellar-solutions/quote-invoice';
 export * from './api/stellar-solutions/tax';
-export * from './api/stellar-solutions/type';
+export * from './api/stellar-solutions/types';
 export * from './constants';
 export * from './general';
 export * from './hooks';

package/index.js

@@ -37,7 +37,7 @@ __exportStar(require("./api/stellar-solutions/profile"), exports);
 __exportStar(require("./api/stellar-solutions/quote-invoice-report"), exports);
 __exportStar(require("./api/stellar-solutions/quote-invoice"), exports);
 __exportStar(require("./api/stellar-solutions/tax"), exports);
-__exportStar(require("./api/stellar-solutions/type"), exports);
+__exportStar(require("./api/stellar-solutions/types"), exports);
 __exportStar(require("./constants"), exports);
 __exportStar(require("./general"), exports);
 __exportStar(require("./hooks"), exports);

package/package.json

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

package/api/stellar-solutions/bank/cache.js

@@ -1,237 +0,0 @@
-// import { API_ROUTES } from '../constants';
-// import { BankBE, LS_KEYS } from '../type';
-// import { API_METHODS } from '../../../constants/api-methods';
-// import { fetchData } from '../../../general/fetch-data';
-// import { getStorageValue } from '../../../local-storage/get-storage-value';
-// import { setStorageValue } from '../../../local-storage/set-storage-value';
-// import { ONE_WEEK_IN_MS } from '../../../constants';
-// interface CachedBanks {
-//   banks: BankBE[];
-//   cachedAt: string;
-// }
-// /**
-//  * Synchronous utility function to get banks from cache only
-//  * Returns cached data immediately if available and fresh, otherwise returns empty array
-//  * Does not trigger any API calls
-//  *
-//  * @returns BankBE[] - Array of cached banks or empty array wrapper ({count, items})
-//  *
-//  * @example
-//  * const banks = getCachedBanksSync();
-//  * if (banks.items.length > 0) {
-//  *   console.log(banks.items[0].bankName);
-//  * }
-//  */
-// export const getCachedBanksSync = (): {
-//   count: number;
-//   items: BankBE[];
-// } => {
-//   try {
-//     const cachedData = getStorageValue(LS_KEYS.BANKS) as CachedBanks | null;
-//     if (!cachedData) {
-//       return { count: 0, items: [] };
-//     }
-//     const currentTime = new Date().getTime();
-//     const cachedTime = new Date(cachedData.cachedAt).getTime();
-//     const ageInMs = currentTime - cachedTime;
-//     // If cached data is less than 1 week old, return it
-//     if (ageInMs < ONE_WEEK_IN_MS) {
-//       return {
-//         count: cachedData.banks.length,
-//         items: cachedData.banks,
-//       };
-//     }
-//     return { count: 0, items: [] };
-//   } catch (error) {
-//     console.error('Error getting cached banks:', error);
-//     return { count: 0, items: [] };
-//   }
-// };
-// /**
-//  * Utility function to get banks from cache or fetch from API
-//  *
-//  * This function manages a localStorage cache of banks with the following logic:
-//  * - If banks exist in cache and are less than 1 week old, return cached version
-//  * - If banks exist but are older than 1 week, fetch fresh data and update cache
-//  * - If banks don't exist in cache, fetch from API and cache them
-//  *
-//  * @param searchQuery - Optional search query to filter banks
-//  * @param pageLimit - Number of banks to fetch (default: 100)
-//  * @returns Promise<{count:number, items: BankBE[]}> - Paged banks
-//  *
-//  * @example
-//  * const banks = await getCachedBanks();
-//  * console.log(banks.items[0].bankName);
-//  *
-//  * // With search
-//  * const filtered = await getCachedBanks('Chase');
-//  */
-// export const getCachedBanks = async (
-//   searchQuery?: string,
-//   pageLimit: number = 100
-// ): Promise<{
-//   count: number;
-//   items: BankBE[];
-// }> => {
-//   try {
-//     // If there's a search query, always fetch fresh data (don't use cache)
-//     if (searchQuery && searchQuery.trim()) {
-//       const response = await fetchData({
-//         url: API_ROUTES.BANKS,
-//         body: JSON.stringify({
-//           searchQuery,
-//           pageLimit,
-//           currentPage: 1,
-//         }),
-//         method: API_METHODS.POST,
-//       });
-//       return response?.data || { count: 0, items: [] };
-//     }
-//     // Get the cached data from localStorage
-//     const cachedData = getStorageValue(LS_KEYS.BANKS) as CachedBanks | null;
-//     const currentTime = new Date().getTime();
-//     // Check if cached data exists and is still fresh
-//     if (cachedData) {
-//       const cachedTime = new Date(cachedData.cachedAt).getTime();
-//       const ageInMs = currentTime - cachedTime;
-//       // If cached data is less than 1 week old, return it
-//       if (ageInMs < ONE_WEEK_IN_MS) {
-//         return {
-//           count: cachedData.banks.length,
-//           items: cachedData.banks,
-//         };
-//       }
-//     }
-//     // If no cached data or data is older than 1 week, fetch fresh data
-//     const response = await fetchData({
-//       url: API_ROUTES.BANKS,
-//       body: JSON.stringify({
-//         pageLimit,
-//         currentPage: 1,
-//       }),
-//       method: API_METHODS.POST,
-//     });
-//     if (response?.data?.items) {
-//       // Update the cache with fresh data
-//       const updatedCache: CachedBanks = {
-//         banks: response.data.items,
-//         cachedAt: new Date().toISOString(),
-//       };
-//       setStorageValue(LS_KEYS.BANKS, updatedCache);
-//       return response.data;
-//     }
-//     return { count: 0, items: [] };
-//   } catch (error) {
-//     console.error('Error fetching banks:', error);
-//     return { count: 0, items: [] };
-//   }
-// };
-// /**
-//  * Utility function to get a specific bank by ID from cache
-//  * If not found in cache, returns null (does not trigger API call)
-//  *
-//  * @param bankId - The ID of the bank to retrieve
-//  * @returns BankBE | null - The bank or null if not found
-//  *
-//  * @example
-//  * const bank = getCachedBankById('bank-123');
-//  * if (bank) {
-//  *   console.log(bank.bankName);
-//  * }
-//  */
-// export const getCachedBankById = (bankId: string): BankBE | null => {
-//   if (!bankId) {
-//     return null;
-//   }
-//   try {
-//     const banks = getCachedBanksSync().items;
-//     return banks.find((bank) => bank.id === bankId) || null;
-//   } catch (error) {
-//     console.error('Error getting cached bank by ID:', error);
-//     return null;
-//   }
-// };
-// /**
-//  * Utility function to get a specific bank by account number from cache
-//  * If not found in cache, returns null (does not trigger API call)
-//  *
-//  * @param accountNumber - The account number of the bank to retrieve
-//  * @returns BankBE | null - The bank or null if not found
-//  *
-//  * @example
-//  * const bank = getCachedBankByAccountNumber('1234567890');
-//  * if (bank) {
-//  *   console.log(bank.bankName);
-//  * }
-//  */
-// export const getCachedBankByAccountNumber = (
-//   accountNumber: string
-// ): BankBE | null => {
-//   if (!accountNumber) {
-//     return null;
-//   }
-//   try {
-//     const banks = getCachedBanksSync().items;
-//     return banks.find((bank) => bank.accountNumber === accountNumber) || null;
-//   } catch (error) {
-//     console.error('Error getting cached bank by account number:', error);
-//     return null;
-//   }
-// };
-// /**
-//  * Utility function to invalidate (remove) banks from cache
-//  * Useful when banks have been updated and you want to force a refresh
-//  *
-//  * @example
-//  * invalidateBanksCache();
-//  * const freshBanks = await getCachedBanks();
-//  */
-// export const invalidateBanksCache = (): void => {
-//   try {
-//     localStorage.removeItem(LS_KEYS.BANKS);
-//   } catch (error) {
-//     console.error('Error invalidating banks cache:', error);
-//   }
-// };
-// /**
-//  * Utility function to preload banks into cache
-//  * Useful to call on app initialization or login
-//  *
-//  * @returns Promise<{count:number, items: BankBE[]}> - Array of preloaded banks
-//  *
-//  * @example
-//  * // On app initialization
-//  * await preloadBanks();
-//  */
-// export const preloadBanks = async (): Promise<{
-//   count: number;
-//   items: BankBE[];
-// }> => {
-//   return getCachedBanks();
-// };
-// /**
-//  * Utility function to check if banks cache is stale
-//  * Returns true if cache is older than 1 week or doesn't exist
-//  *
-//  * @returns boolean - True if cache is stale or doesn't exist
-//  *
-//  * @example
-//  * if (isBanksCacheStale()) {
-//  *   await getCachedBanks(); // This will fetch fresh data
-//  * }
-//  */
-// export const isBanksCacheStale = (): boolean => {
-//   try {
-//     const cachedData = getStorageValue(LS_KEYS.BANKS) as CachedBanks | null;
-//     if (!cachedData) {
-//       return true;
-//     }
-//     const currentTime = new Date().getTime();
-//     const cachedTime = new Date(cachedData.cachedAt).getTime();
-//     const ageInMs = currentTime - cachedTime;
-//     return ageInMs >= ONE_WEEK_IN_MS;
-//   } catch (error) {
-//     console.error('Error checking banks cache staleness:', error);
-//     return true;
-//   }
-// };