@appcorp/stellar-solutions-modules 0.1.34 → 0.1.36

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

@@ -0,0 +1,25 @@
+/**
+ * Bank State Reducer
+ *
+ * This module manages the state transitions for the Bank feature using the reducer pattern.
+ * Handles all state updates in a predictable and optimized manner.
+ *
+ * Features:
+ * - Form state management (create/edit bank 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 { BankActions } from "./actions";
+import { BankState } from "./types";
+export declare const initialBankState: BankState;
+export declare function bankReducer(state: BankState, action: BankActions): BankState;

package/global-modules/bank/reducer.js

@@ -0,0 +1,161 @@
+"use strict";
+/**
+ * Bank State Reducer
+ *
+ * This module manages the state transitions for the Bank feature using the reducer pattern.
+ * Handles all state updates in a predictable and optimized manner.
+ *
+ * Features:
+ * - Form state management (create/edit bank 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.initialBankState = void 0;
+exports.bankReducer = bankReducer;
+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 ({
+    accountNumber: "",
+    accountTitle: "",
+    bankAddress: "",
+    bankName: "",
+    enabled: false,
+    errors: {},
+    iban: "",
+    id: "",
+    isDefault: false,
+    swiftCode: "",
+    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.initialBankState = {
+    // Bank Form Data
+    accountNumber: "",
+    accountTitle: "",
+    bankAddress: "",
+    bankName: "",
+    enabled: false,
+    iban: "",
+    id: "",
+    isDefault: false,
+    swiftCode: "",
+    preferenceId: "",
+    // List Data
+    banks: [],
+    count: 0,
+    // Search & Pagination
+    currentPage: 1,
+    pageLimit: constants_1.pageLimit,
+    searchQuery: "",
+    // UI State
+    disableSaveButton: false,
+    drawer: null,
+    // Errors
+    errors: {},
+};
+// ============================================================================
+// REDUCER FUNCTION
+// ============================================================================
+function bankReducer(state, action) {
+    var _a;
+    switch (action.type) {
+        // ------------------------------------------------------------------------
+        // FORM RESET ACTIONS
+        // ------------------------------------------------------------------------
+        case actions_1.BANK_ACTION_TYPES.RESET_ERRORS:
+            return __assign(__assign({}, state), { errors: {} });
+        case actions_1.BANK_ACTION_TYPES.RESET_FORM:
+            return __assign(__assign({}, state), getFormResetState());
+        // ------------------------------------------------------------------------
+        // FORM INPUT ACTIONS
+        // ------------------------------------------------------------------------
+        case actions_1.BANK_ACTION_TYPES.SET_INPUT_FIELD:
+            return __assign(__assign({}, state), (_a = {}, _a[action.payload.key] = action.payload.value, _a));
+        case actions_1.BANK_ACTION_TYPES.SET_FORM:
+            return __assign(__assign({}, state), action.payload.form);
+        // ------------------------------------------------------------------------
+        // ERROR HANDLING ACTIONS
+        // ------------------------------------------------------------------------
+        case actions_1.BANK_ACTION_TYPES.SET_ERRORS:
+            return __assign(__assign({}, state), { disableSaveButton: false, errors: mergeErrors(action.payload.errors) });
+        // ------------------------------------------------------------------------
+        // UI STATE ACTIONS
+        // ------------------------------------------------------------------------
+        case actions_1.BANK_ACTION_TYPES.SET_DISABLE_SAVE_BUTTON:
+            return __assign(__assign({}, state), { disableSaveButton: action.payload.disableSaveButton });
+        case actions_1.BANK_ACTION_TYPES.SET_DRAWER:
+            return __assign(__assign({}, state), { drawer: action.payload.drawer });
+        // ------------------------------------------------------------------------
+        // LIST DATA ACTIONS
+        // ------------------------------------------------------------------------
+        case actions_1.BANK_ACTION_TYPES.SET_BANKS:
+            return __assign(__assign({}, state), { banks: updateArrayState(action.payload.banks) });
+        case actions_1.BANK_ACTION_TYPES.SET_COUNT:
+            return __assign(__assign({}, state), { count: action.payload.count });
+        // ------------------------------------------------------------------------
+        // PAGINATION ACTIONS
+        // ------------------------------------------------------------------------
+        case actions_1.BANK_ACTION_TYPES.SET_CURRENT_PAGE:
+            return __assign(__assign({}, state), { currentPage: action.payload.currentPage });
+        case actions_1.BANK_ACTION_TYPES.SET_PAGE_LIMIT:
+            return __assign(__assign({}, state), { pageLimit: action.payload.pageLimit });
+        // ------------------------------------------------------------------------
+        // SEARCH ACTIONS
+        // ------------------------------------------------------------------------
+        case actions_1.BANK_ACTION_TYPES.SET_SEARCH_QUERY:
+            return __assign(__assign({}, state), { searchQuery: action.payload.searchQuery });
+        // ------------------------------------------------------------------------
+        // DEFAULT CASE
+        // ------------------------------------------------------------------------
+        default:
+            return state;
+    }
+}

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

@@ -0,0 +1,217 @@
+/**
+ * Bank Module Types
+ *
+ * This module defines all TypeScript interfaces, types, and enums for the Bank feature.
+ * Provides type safety and clear contracts for all bank-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:
+ * - Bank management with account details
+ * - 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 "@/components/ui/enhanced-table";
+import { BankActions } from "./actions";
+import { PreferenceBE as PreferenceTypeBE } from "@react-pakistan/util-functions/api/stellar-solutions/type";
+/**
+ * Bank Context Interface
+ *
+ * Defines the complete context API for bank state management.
+ * Includes all handlers, state getters, and utility functions.
+ */
+export interface BankContextType {
+    byIdError?: Error;
+    byIdLoading: boolean;
+    deleteError?: Error;
+    deleteLoading: boolean;
+    listError?: Error;
+    listLoading: boolean;
+    updateError?: Error;
+    updateLoading: boolean;
+    dispatch: Dispatch<BankActions>;
+    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[];
+}
+/**
+ * Bank Backend Entity
+ *
+ * Represents the complete bank data structure as received from the API.
+ * Includes all bank-specific fields and account details.
+ */
+export interface BankTypeBE {
+    accountNumber: string;
+    accountTitle: string;
+    bankAddress?: string;
+    bankName: string;
+    createdAt: string;
+    enabled: boolean;
+    iban?: string;
+    id: string;
+    isDefault: boolean;
+    swiftCode?: string;
+    updatedAt: string;
+    preference: PreferenceTypeBE;
+    preferenceId: string;
+}
+/**
+ * Bank Component State
+ *
+ * Complete state interface for the bank module components.
+ * Extends entity data with UI state, form state, and search capabilities.
+ */
+export interface BankState {
+    banks: BankTypeBE[];
+    count: number;
+    currentPage: number;
+    pageLimit: number;
+    searchQuery: string;
+    disableSaveButton: boolean;
+    drawer: null | BANK_DRAWER;
+    accountNumber: string;
+    accountTitle: string;
+    bankAddress: string;
+    bankName: string;
+    enabled: boolean;
+    errors: Record<string, string>;
+    iban: string;
+    id: string;
+    isDefault: boolean;
+    swiftCode: string;
+    preferenceId: string;
+}
+/**
+ * Fetch Banks API Arguments
+ *
+ * Parameters for bank list API requests.
+ * Supports pagination and search functionality.
+ */
+export interface FetchBanksArgs {
+    currentPage: number;
+    pageLimit: number;
+    searchQuery?: string;
+}
+/**
+ * Bank API Response
+ *
+ * Standard API response format for bank operations.
+ */
+export interface BankApiResponse {
+    data?: BankTypeBE[];
+    count?: number;
+    error?: string;
+    success: boolean;
+}
+/**
+ * Single Bank API Response
+ *
+ * API response format for individual bank operations.
+ */
+export interface SingleBankApiResponse {
+    data?: BankTypeBE;
+    error?: string;
+    success: boolean;
+}
+/**
+ * Update Bank Arguments
+ *
+ * Parameters for bank update operations.
+ */
+export interface UpdateBankArgs {
+    id: string;
+    accountNumber: string;
+    accountTitle: string;
+    bankAddress: string;
+    bankName: string;
+    enabled: boolean;
+    iban: string;
+    swiftCode: string;
+    isDefault: boolean;
+}
+/**
+ * Bank Drawer Types
+ *
+ * Enumeration of available drawer states for bank operations.
+ */
+export declare enum BANK_DRAWER {
+    FILTER_DRAWER = "FILTER_DRAWER",
+    FORM_DRAWER = "FORM_DRAWER"
+}
+export declare enum BANK_MODAL {
+    DUMMY = "DUMMY"
+}
+/**
+ * Bank Form Fields
+ *
+ * Utility type for bank form field keys.
+ * Useful for form validation and dynamic field handling.
+ */
+export type BankFormFields = keyof Omit<BankTypeBE, "id" | "createdAt" | "updatedAt" | "preference">;
+/**
+ * Bank Required Fields
+ *
+ * Fields that are mandatory for bank creation.
+ */
+export type BankRequiredFields = "accountNumber" | "accountTitle" | "bankName" | "preferenceId";
+/**
+ * Bank Optional Fields
+ *
+ * Fields that are optional for bank creation.
+ */
+export type BankOptionalFields = "bankAddress" | "iban" | "swiftCode" | "enabled" | "isDefault";
+/**
+ * Bank Search Fields
+ *
+ * Fields that can be used for searching banks.
+ */
+export type BankSearchFields = "bankName" | "accountTitle" | "accountNumber";
+/**
+ * Bank Sort Fields
+ *
+ * Fields that can be used for sorting bank lists.
+ */
+export type BankSortFields = "bankName" | "accountTitle" | "accountNumber" | "createdAt" | "enabled" | "isDefault";
+/**
+ * Partial Bank Update
+ *
+ * Type for partial bank updates (PATCH operations).
+ */
+export type PartialBankUpdate = Partial<Omit<BankTypeBE, "id" | "createdAt" | "updatedAt">>;
+/**
+ * Bank Form Data
+ *
+ * Type for bank form data (excludes backend-only fields).
+ */
+export type BankForm = Omit<BankTypeBE, "createdAt" | "updatedAt" | "preference">;
+/**
+ * Type guard to check if object is a valid BankTypeBE
+ */
+export declare const isBankTypeBE: (obj: unknown) => obj is BankTypeBE;
+/**
+ * Type guard to check if string is a valid bank drawer type
+ */
+export declare const isBankDrawer: (value: string) => value is BANK_DRAWER;
+/**
+ * Type guard to check if object has valid bank filter structure
+ */
+export declare const isFetchBanksArgs: (obj: unknown) => obj is FetchBanksArgs;

package/global-modules/bank/types.js

@@ -0,0 +1,81 @@
+"use strict";
+/**
+ * Bank Module Types
+ *
+ * This module defines all TypeScript interfaces, types, and enums for the Bank feature.
+ * Provides type safety and clear contracts for all bank-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:
+ * - Bank management with account details
+ * - 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.isFetchBanksArgs = exports.isBankDrawer = exports.isBankTypeBE = exports.BANK_MODAL = exports.BANK_DRAWER = void 0;
+// ============================================================================
+// UI ENUMS (Component State Definitions)
+// ============================================================================
+/**
+ * Bank Drawer Types
+ *
+ * Enumeration of available drawer states for bank operations.
+ */
+var BANK_DRAWER;
+(function (BANK_DRAWER) {
+    BANK_DRAWER["FILTER_DRAWER"] = "FILTER_DRAWER";
+    BANK_DRAWER["FORM_DRAWER"] = "FORM_DRAWER";
+})(BANK_DRAWER || (exports.BANK_DRAWER = BANK_DRAWER = {}));
+var BANK_MODAL;
+(function (BANK_MODAL) {
+    BANK_MODAL["DUMMY"] = "DUMMY";
+})(BANK_MODAL || (exports.BANK_MODAL = BANK_MODAL = {}));
+// ============================================================================
+// TYPE GUARDS (Runtime Type Checking)
+// ============================================================================
+/**
+ * Type guard to check if object is a valid BankTypeBE
+ */
+var isBankTypeBE = function (obj) {
+    return (typeof obj === "object" &&
+        obj !== null &&
+        "id" in obj &&
+        "bankName" in obj &&
+        "accountNumber" in obj &&
+        typeof obj.enabled === "boolean" &&
+        typeof obj.isDefault === "boolean");
+};
+exports.isBankTypeBE = isBankTypeBE;
+/**
+ * Type guard to check if string is a valid bank drawer type
+ */
+var isBankDrawer = function (value) {
+    return Object.values(BANK_DRAWER).includes(value);
+};
+exports.isBankDrawer = isBankDrawer;
+/**
+ * Type guard to check if object has valid bank filter structure
+ */
+var isFetchBanksArgs = function (obj) {
+    return (typeof obj === "object" &&
+        obj !== null &&
+        typeof obj.currentPage === "number" &&
+        typeof obj.pageLimit === "number");
+};
+exports.isFetchBanksArgs = isFetchBanksArgs;
+// ============================================================================
+// SHARED TYPES (From other modules)
+// ============================================================================
+// All shared types are now imported from @react-pakistan/util-functions/api/stellar-solutions/type

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

@@ -0,0 +1,13 @@
+import { z } from "zod";
+export declare const formValidation: z.ZodObject<{
+    accountNumber: z.ZodString;
+    accountTitle: z.ZodString;
+    bankAddress: z.ZodOptional<z.ZodString>;
+    bankName: z.ZodString;
+    enabled: z.ZodBoolean;
+    iban: z.ZodOptional<z.ZodString>;
+    isDefault: z.ZodBoolean;
+    preferenceId: z.ZodString;
+    swiftCode: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type FormValidate = z.infer<typeof formValidation>;

package/global-modules/bank/validate.js

@@ -0,0 +1,22 @@
+"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 = {
+    accountNumberRequired: "validation.accountNumberRequired",
+    accountTitleRequired: "validation.accountTitleRequired",
+    bankNameRequired: "validation.bankNameRequired",
+    preferenceIdRequired: "validation.preferenceIdRequired",
+};
+exports.formValidation = zod_1.z.object({
+    accountNumber: zod_1.z.string().nonempty(VALIDATION_KEYS.accountNumberRequired),
+    accountTitle: zod_1.z.string().nonempty(VALIDATION_KEYS.accountTitleRequired),
+    bankAddress: zod_1.z.string().optional(),
+    bankName: zod_1.z.string().nonempty(VALIDATION_KEYS.bankNameRequired),
+    enabled: zod_1.z.boolean(),
+    iban: zod_1.z.string().optional(),
+    isDefault: zod_1.z.boolean(),
+    preferenceId: zod_1.z.string().nonempty(VALIDATION_KEYS.preferenceIdRequired),
+    swiftCode: zod_1.z.string().optional(),
+});