@appcorp/stellar-solutions-modules 0.1.56 → 0.1.58

package/global-modules/currency/reducer.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Currency State Reducer
+ *
+ * This module manages the state transitions for the Currency feature using the reducer pattern.
+ * Handles all state updates in a predictable and optimized manner.
+ *
+ * Features:
+ * - Form state management (create/edit currency data)
+ * - UI state management (drawers, loading states)
+ * - Search and pagination state
+ * - Error handling state
+ *
+ * Performance Optimizations:
+ * - Grouped related actions for better readability and maintainability
+ * - Helper functions for common operations (form reset, array updates, error merging)
+ * - Optimized object spreading patterns with shallow copies
+ * - Immutable state updates to prevent reference issues
+ * - Clear action-to-state mapping with logical grouping
+ * - Consistent patterns for similar operations
+ * - Type-safe helper functions for better error prevention
+ */
+import { CurrencyActions } from "./actions";
+import { CurrencyState } from "./types";
+export declare const initialCurrencyState: CurrencyState;
+export declare function currencyReducer(state: CurrencyState, action: CurrencyActions): CurrencyState;

package/global-modules/currency/reducer.js

@@ -0,0 +1,153 @@
+"use strict";
+/**
+ * Currency State Reducer
+ *
+ * This module manages the state transitions for the Currency feature using the reducer pattern.
+ * Handles all state updates in a predictable and optimized manner.
+ *
+ * Features:
+ * - Form state management (create/edit currency data)
+ * - UI state management (drawers, loading states)
+ * - Search and pagination state
+ * - Error handling state
+ *
+ * Performance Optimizations:
+ * - Grouped related actions for better readability and maintainability
+ * - Helper functions for common operations (form reset, array updates, error merging)
+ * - Optimized object spreading patterns with shallow copies
+ * - Immutable state updates to prevent reference issues
+ * - Clear action-to-state mapping with logical grouping
+ * - Consistent patterns for similar operations
+ * - Type-safe helper functions for better error prevention
+ */
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initialCurrencyState = void 0;
+exports.currencyReducer = currencyReducer;
+var actions_1 = require("./actions");
+var constants_1 = require("./constants");
+// ============================================================================
+// HELPER FUNCTIONS
+// ============================================================================
+/**
+ * Helper function to reset form fields to their initial values
+ */
+var getFormResetState = function () { return ({
+    code: "",
+    enabled: false,
+    errors: {},
+    id: "",
+    isDefault: false,
+    label: "",
+    preferenceId: "",
+    disableSaveButton: false,
+}); };
+/**
+ * Helper function to safely update array state with immutability
+ */
+var updateArrayState = function (array) { return __spreadArray([], array, true); };
+/**
+ * Helper function to safely merge errors with existing state
+ */
+var mergeErrors = function (errors) { return (__assign({}, errors)); };
+// ============================================================================
+// INITIAL STATE
+// ============================================================================
+exports.initialCurrencyState = {
+    // Currency Form Data
+    code: "",
+    enabled: false,
+    id: "",
+    isDefault: false,
+    label: "",
+    preferenceId: "",
+    // List Data
+    currencies: [],
+    count: 0,
+    // Search & Pagination
+    currentPage: 1,
+    pageLimit: constants_1.pageLimit,
+    searchQuery: "",
+    // UI State
+    disableSaveButton: false,
+    drawer: null,
+    // Errors
+    errors: {},
+};
+// ============================================================================
+// REDUCER FUNCTION
+// ============================================================================
+function currencyReducer(state, action) {
+    var _a;
+    switch (action.type) {
+        // ------------------------------------------------------------------------
+        // FORM RESET ACTIONS
+        // ------------------------------------------------------------------------
+        case actions_1.CURRENCY_ACTION_TYPES.RESET_ERRORS:
+            return __assign(__assign({}, state), { errors: {} });
+        case actions_1.CURRENCY_ACTION_TYPES.RESET_FORM:
+            return __assign(__assign({}, state), getFormResetState());
+        // ------------------------------------------------------------------------
+        // FORM INPUT ACTIONS
+        // ------------------------------------------------------------------------
+        case actions_1.CURRENCY_ACTION_TYPES.SET_INPUT_FIELD:
+            return __assign(__assign({}, state), (_a = {}, _a[action.payload.key] = action.payload.value, _a));
+        case actions_1.CURRENCY_ACTION_TYPES.SET_FORM:
+            return __assign(__assign({}, state), action.payload.form);
+        // ------------------------------------------------------------------------
+        // ERROR HANDLING ACTIONS
+        // ------------------------------------------------------------------------
+        case actions_1.CURRENCY_ACTION_TYPES.SET_ERRORS:
+            return __assign(__assign({}, state), { disableSaveButton: false, errors: mergeErrors(action.payload.errors) });
+        // ------------------------------------------------------------------------
+        // UI STATE ACTIONS
+        // ------------------------------------------------------------------------
+        case actions_1.CURRENCY_ACTION_TYPES.SET_DISABLE_SAVE_BUTTON:
+            return __assign(__assign({}, state), { disableSaveButton: action.payload.disableSaveButton });
+        case actions_1.CURRENCY_ACTION_TYPES.SET_DRAWER:
+            return __assign(__assign({}, state), { drawer: action.payload.drawer });
+        // ------------------------------------------------------------------------
+        // LIST DATA ACTIONS
+        // ------------------------------------------------------------------------
+        case actions_1.CURRENCY_ACTION_TYPES.SET_CURRENCIES:
+            return __assign(__assign({}, state), { currencies: updateArrayState(action.payload.currencies) });
+        case actions_1.CURRENCY_ACTION_TYPES.SET_COUNT:
+            return __assign(__assign({}, state), { count: action.payload.count });
+        // ------------------------------------------------------------------------
+        // PAGINATION ACTIONS
+        // ------------------------------------------------------------------------
+        case actions_1.CURRENCY_ACTION_TYPES.SET_CURRENT_PAGE:
+            return __assign(__assign({}, state), { currentPage: action.payload.currentPage });
+        case actions_1.CURRENCY_ACTION_TYPES.SET_PAGE_LIMIT:
+            return __assign(__assign({}, state), { pageLimit: action.payload.pageLimit });
+        // ------------------------------------------------------------------------
+        // SEARCH ACTIONS
+        // ------------------------------------------------------------------------
+        case actions_1.CURRENCY_ACTION_TYPES.SET_SEARCH_QUERY:
+            return __assign(__assign({}, state), { searchQuery: action.payload.searchQuery });
+        // ------------------------------------------------------------------------
+        // DEFAULT CASE
+        // ------------------------------------------------------------------------
+        default:
+            return state;
+    }
+}

package/global-modules/currency/types.d.ts

@@ -0,0 +1,163 @@
+/**
+ * Currency Module Types
+ *
+ * This module defines all TypeScript interfaces, types, and enums for the Currency feature.
+ * Provides type safety and clear contracts for all currency-related operations.
+ *
+ * Type Categories:
+ * - Context Types (React context and state management)
+ * - Entity Types (Backend data structures)
+ * - State Types (Frontend component state)
+ * - API Types (Request/response interfaces)
+ * - UI Types (Drawer and component enums)
+ * - Utility Types (Helper and computed types)
+ *
+ * Advanced Features:
+ * - Currency management with code and symbol
+ * - CRUD operations support
+ * - Enhanced search and pagination
+ *
+ * Naming Conventions:
+ * - Interfaces: PascalCase with descriptive suffixes (Type, State, Args)
+ * - Enums: UPPER_SNAKE_CASE for values, PascalCase for enum names
+ * - Types: PascalCase following interface conventions
+ */
+import { Dispatch } from "react";
+import { RowAction, HeaderAction } from "@appcorp/shadcn/components/enhanced-table";
+import { CurrencyActions } from "./actions";
+import { CurrencyBE as CurrencyTypeBE } from "@react-pakistan/util-functions/api/stellar-solutions/type";
+/**
+ * Currency Context Interface
+ *
+ * Defines the complete context API for currency state management.
+ * Includes all handlers, state getters, and utility functions.
+ */
+export interface CurrencyContextType {
+    byIdError?: Error;
+    byIdLoading: boolean;
+    deleteError?: Error;
+    deleteLoading: boolean;
+    listError?: Error;
+    listLoading: boolean;
+    updateError?: Error;
+    updateLoading: boolean;
+    dispatch: Dispatch<CurrencyActions>;
+    handleInputChange: (key: string, value: string | boolean) => void;
+    handleNextClick: () => void;
+    handlePageLimit: (k: string, v: object) => void;
+    handlePreviousClick: () => void;
+    handleSubmit: () => void;
+    clearSearch: () => void;
+    closeDrawer: () => void;
+    searchOnChange: (k: string, v: string) => void;
+    headerActions: HeaderAction[];
+    rowActions: RowAction[];
+}
+export type { CurrencyTypeBE };
+/**
+ * Currency Component State
+ *
+ * Complete state interface for the currency module components.
+ * Extends entity data with UI state, form state, and search capabilities.
+ */
+export interface CurrencyState extends Omit<CurrencyTypeBE, "preference" | "createdAt" | "updatedAt"> {
+    currencies: CurrencyTypeBE[];
+    count: number;
+    currentPage: number;
+    pageLimit: number;
+    searchQuery: string;
+    disableSaveButton: boolean;
+    drawer: null | CURRENCY_DRAWER;
+    preferenceId: string;
+    errors: Record<string, string>;
+}
+/**
+ * Fetch Currencies API Arguments
+ *
+ * Parameters for currency list API requests.
+ * Supports pagination and search functionality.
+ */
+export interface FetchCurrenciesArgs {
+    currentPage: number;
+    pageLimit: number;
+    searchQuery?: string;
+}
+/**
+ * Currency API Response
+ *
+ * Standard API response format for currency operations.
+ */
+export interface CurrencyApiResponse {
+    data?: CurrencyTypeBE[];
+    count?: number;
+    error?: string;
+    success: boolean;
+}
+/**
+ * Update Currency Arguments
+ *
+ * Parameters for currency update operations.
+ */
+export interface UpdateCurrencyArgs {
+    id: string;
+    code: string;
+    enabled: boolean;
+    isDefault: boolean;
+    name: string;
+    symbol: string;
+}
+/**
+ * Currency Drawer Types
+ *
+ * Enumeration of available drawer states for currency operations.
+ */
+export declare enum CURRENCY_DRAWER {
+    FILTER_DRAWER = "FILTER_DRAWER",
+    FORM_DRAWER = "FORM_DRAWER"
+}
+export declare enum CURRENCY_MODAL {
+    DUMMY = "DUMMY"
+}
+/**
+ * Currency Form Fields
+ *
+ * Utility type for currency form field keys.
+ * Useful for form validation and dynamic field handling.
+ */
+export type CurrencyFormFields = keyof Omit<CurrencyTypeBE, "id" | "createdAt" | "updatedAt" | "preference">;
+/**
+ * Currency Required Fields
+ *
+ * Fields that are mandatory for currency creation.
+ */
+export type CurrencyRequiredFields = "code" | "name" | "symbol" | "preferenceId";
+/**
+ * Currency Optional Fields
+ *
+ * Fields that are optional for currency creation.
+ */
+export type CurrencyOptionalFields = "enabled" | "isDefault";
+/**
+ * Currency Form Type
+ *
+ * Complete form interface for currency operations.
+ * Combines required and optional fields.
+ */
+export interface CurrencyForm extends Record<CurrencyRequiredFields, string>, Partial<Record<CurrencyOptionalFields, boolean>> {
+}
+/**
+ * Currency Sort Fields
+ *
+ * Fields available for sorting currency lists.
+ */
+export type CurrencySortField = "name" | "code" | "symbol" | "createdAt" | "updatedAt";
+/**
+ * Currency Filter Options
+ *
+ * Available filter options for currency lists.
+ */
+export interface CurrencyFilterOptions {
+    enabled?: boolean;
+    isDefault?: boolean;
+    searchQuery?: string;
+}

package/global-modules/currency/types.js

@@ -0,0 +1,44 @@
+"use strict";
+/**
+ * Currency Module Types
+ *
+ * This module defines all TypeScript interfaces, types, and enums for the Currency feature.
+ * Provides type safety and clear contracts for all currency-related operations.
+ *
+ * Type Categories:
+ * - Context Types (React context and state management)
+ * - Entity Types (Backend data structures)
+ * - State Types (Frontend component state)
+ * - API Types (Request/response interfaces)
+ * - UI Types (Drawer and component enums)
+ * - Utility Types (Helper and computed types)
+ *
+ * Advanced Features:
+ * - Currency management with code and symbol
+ * - CRUD operations support
+ * - Enhanced search and pagination
+ *
+ * Naming Conventions:
+ * - Interfaces: PascalCase with descriptive suffixes (Type, State, Args)
+ * - Enums: UPPER_SNAKE_CASE for values, PascalCase for enum names
+ * - Types: PascalCase following interface conventions
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CURRENCY_MODAL = exports.CURRENCY_DRAWER = void 0;
+// ============================================================================
+// UI ENUMS (Component State Definitions)
+// ============================================================================
+/**
+ * Currency Drawer Types
+ *
+ * Enumeration of available drawer states for currency operations.
+ */
+var CURRENCY_DRAWER;
+(function (CURRENCY_DRAWER) {
+    CURRENCY_DRAWER["FILTER_DRAWER"] = "FILTER_DRAWER";
+    CURRENCY_DRAWER["FORM_DRAWER"] = "FORM_DRAWER";
+})(CURRENCY_DRAWER || (exports.CURRENCY_DRAWER = CURRENCY_DRAWER = {}));
+var CURRENCY_MODAL;
+(function (CURRENCY_MODAL) {
+    CURRENCY_MODAL["DUMMY"] = "DUMMY";
+})(CURRENCY_MODAL || (exports.CURRENCY_MODAL = CURRENCY_MODAL = {}));

package/global-modules/currency/validate.d.ts

@@ -0,0 +1,9 @@
+import { z } from "zod";
+export declare const formValidation: z.ZodObject<{
+    code: z.ZodString;
+    enabled: z.ZodBoolean;
+    isDefault: z.ZodBoolean;
+    label: z.ZodString;
+    preferenceId: z.ZodString;
+}, z.core.$strip>;
+export type FormValidate = z.infer<typeof formValidation>;

package/global-modules/currency/validate.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formValidation = void 0;
+var zod_1 = require("zod");
+// Validation error keys for i18n translation
+var VALIDATION_KEYS = {
+    codeRequired: "validationCodeRequired",
+    nameRequired: "validationNameRequired",
+    preferenceIdRequired: "validationCurrencyPreferenceIdRequired",
+    symbolRequired: "validationSymbolRequired",
+};
+exports.formValidation = zod_1.z.object({
+    code: zod_1.z.string().nonempty(VALIDATION_KEYS.codeRequired),
+    enabled: zod_1.z.boolean(),
+    isDefault: zod_1.z.boolean(),
+    label: zod_1.z.string().nonempty(VALIDATION_KEYS.nameRequired),
+    preferenceId: zod_1.z.string().nonempty(VALIDATION_KEYS.preferenceIdRequired),
+});

package/global-modules/payment-mode/types.d.ts

@@ -25,6 +25,7 @@
 import { Dispatch } from "react";
 import { RowAction, HeaderAction } from "@appcorp/shadcn/components/enhanced-table";
 import { PaymentModeActions } from "./actions";
+import { BankBE as BankTypeBE, BranchBE as BranchTypeBE, CurrencyBE as CurrencyTypeBE, MenuOrderBE as MenuOrderTypeBE, PaymentBE as PaymentTypeBE, PaymentModeBE as PaymentModeTypeBE, PreferenceBE as PreferenceTypeBE, TaxBE as TaxTypeBE } from "@react-pakistan/util-functions/api/stellar-solutions/type";
 /**
  * Payment Mode Context Interface
  *
@@ -58,56 +59,19 @@ export interface PaymentModeContextType {
  * Represents the complete payment mode data structure as received from the API.
  * Includes all payment mode-specific fields and relationships.
  */
-export interface PaymentModeTypeBE {
-    createdAt: string;
-    enabled: boolean;
-    id: string;
-    isDefault: boolean;
-    label: string;
-    payments?: PaymentTypeBE[];
-    preference?: PreferenceTypeBE;
-    preferenceId: string;
-    updatedAt: string;
-}
+export type { PaymentModeTypeBE };
 /**
  * Payment Backend Entity
  *
  * Represents payment data structure with payment mode relationship.
  */
-export interface PaymentTypeBE {
-    amount: string;
-    attachment?: string;
-    balance: string;
-    createdAt: string;
-    currency: string;
-    date: string;
-    description?: string;
-    id: string;
-    paymentMode?: PaymentModeTypeBE;
-    paymentModeId: string;
-    paymentType: PAYMENT_TYPE;
-    quoteInvoice?: undefined;
-    quoteInvoiceId: string;
-    ref: string;
-    updatedAt: string;
-}
+export type { PaymentTypeBE };
 /**
  * Preference Backend Entity
  *
  * Represents preference data structure containing payment modes.
  */
-export interface PreferenceTypeBE {
-    bankingDetails: BankingDetailTypeBE[];
-    branches: BranchTypeBE[];
-    createdAt: string;
-    currencies: CurrencyTypeBE[];
-    id: string;
-    menuOrder: MenuOrderTypeBE[];
-    onboarding: boolean;
-    paymentModes: PaymentModeTypeBE[];
-    taxes: TaxTypeBE[];
-    updatedAt: string;
-}
+export type { PreferenceTypeBE };
 /**
  * Payment Mode Component State
  *
@@ -261,206 +225,31 @@ export declare const getPaymentModeDisplayLabel: (paymentMode: PaymentModeTypeBE
 /**
  * Check if payment mode has payments associated
  */
-export declare const hasPayments: (paymentMode: PaymentModeTypeBE) => boolean;
+export declare const hasPayments: (paymentMode: PaymentModeTypeBE & {
+    payments?: PaymentTypeBE[];
+}) => boolean;
 /**
  * Legacy Banking Detail Type
  * TODO: Move to banking-details module
  */
-export interface BankingDetailTypeBE {
-    accountNumber: string;
-    accountTitle: string;
-    bankAddress?: string;
-    bankName: string;
-    createdAt: string;
-    enabled: boolean;
-    iban?: string;
-    id: string;
-    isDefault: boolean;
-    preference: PreferenceTypeBE;
-    preferenceId: string;
-    swiftCode?: string;
-    updatedAt: string;
-}
+export type { BankTypeBE };
 /**
  * Legacy Branch Type
  * TODO: Move to branches module
  */
-export interface BranchTypeBE {
-    branchAddress: string;
-    branchName: string;
-    createdAt: string;
-    enabled: boolean;
-    id: string;
-    isDefault: boolean;
-    personEmail: string;
-    personName: string;
-    personPhone: string;
-    preference: PreferenceTypeBE;
-    preferenceId: string;
-    updatedAt: string;
-}
+export type { BranchTypeBE };
 /**
  * Legacy Currency Type
  * TODO: Move to currencies module
  */
-export interface CurrencyTypeBE {
-    code: string;
-    createdAt: string;
-    enabled: boolean;
-    id: string;
-    isDefault: boolean;
-    label: string;
-    preference?: PreferenceTypeBE;
-    preferenceId: string;
-    updatedAt: string;
-}
+export type { CurrencyTypeBE };
 /**
  * Legacy Menu Order Type
  * TODO: Move to preferences module
  */
-export interface MenuOrderTypeBE {
-    createdAt: string;
-    id: string;
-    label: string;
-    order: number;
-    preference: PreferenceTypeBE;
-    preferenceId: string;
-    updatedAt: string;
-}
+export type { MenuOrderTypeBE };
 /**
  * Legacy Tax Type
  * TODO: Move to taxes module
  */
-export interface TaxTypeBE {
-    createdAt: string;
-    description?: string;
-    enabled: boolean;
-    id: string;
-    isDefault: boolean;
-    preference: PreferenceTypeBE;
-    preferenceId: string;
-    taxName: string;
-    taxRate: string;
-    updatedAt: string;
-}
-/**
- * Legacy Tax Interface
- * TODO: Move to taxes module
- */
-export interface Tax {
-    taxName: string;
-    taxValue: string;
-    id: string;
-    description: string;
-    preferenceId: string;
-    enabled: boolean;
-    errors: {
-        [key: string]: string;
-    };
-    createdAt?: string;
-    updatedAt?: string;
-    loading: boolean;
-    isDefault: boolean;
-    btnDisableTax: boolean;
-}
-/**
- * Legacy Menu Item Interface
- * TODO: Move to preferences module
- */
-export interface MenuItem {
-    preferenceId: string;
-    label: string;
-    order: number;
-    id: string;
-}
-/**
- * Legacy Currency Args
- * TODO: Move to currencies module
- */
-export type CurrencyArgs = {
-    id: string;
-    label: string;
-    enabled: boolean;
-    code: string;
-    isDefault: boolean;
-    preferenceId: string;
-};
-/**
- * Legacy Create Bank Detail Args
- * TODO: Move to banking-details module
- */
-export interface CreateBankDetailArg {
-    id: string;
-    accountNumber: string;
-    accountTitle: string;
-    bankAddress: string;
-    bankName: string;
-    enabled: boolean;
-    iban: string;
-    swiftCode: string;
-    preferenceId: string;
-    errors: {
-        [key: string]: string;
-    };
-    loading: boolean;
-    isDefault: boolean;
-}
-/**
- * Legacy Create Branches Args
- * TODO: Move to branches module
- */
-export interface createBranchesArgs {
-    personName: string;
-    personEmail: string;
-    id: string;
-    personPhone: string;
-    branchAddress: string;
-    branchName: string;
-    preferenceId: string;
-    enabled: boolean;
-    errors: {
-        [key: string]: string;
-    };
-    createdAt?: string;
-    updatedAt?: string;
-    loading: boolean;
-    isDefault: boolean;
-}
-/**
- * Legacy Create Taxes Args
- * TODO: Move to taxes module
- */
-export interface createTaxesArgs {
-    taxName: string;
-    taxValue: string;
-    id: string;
-    description: string;
-    preferenceId: string;
-    enabled: boolean;
-    errors: {
-        [key: string]: string;
-    };
-    createdAt?: string;
-    updatedAt?: string;
-    loading: boolean;
-    isDefault: boolean;
-}
-/**
- * Legacy Update Currency Args
- * TODO: Move to currencies module
- */
-export interface updateCurrencyArgs {
-    id: string;
-    label: string;
-    enabled: boolean;
-    code: string;
-    isDefault: boolean;
-    preferenceId: string;
-}
-/**
- * Legacy Branch Modal Enum
- * TODO: Move to branches module
- */
-export declare enum BRANCH_MODAL {
-    DUMMY = "DUMMY"
-}
+export type { TaxTypeBE };