@appcorp/stellar-solutions-modules 0.1.34 → 0.1.36

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

@@ -0,0 +1,200 @@
+/**
+ * Bank Actions
+ *
+ * This module defines all action types and interfaces for the Bank state management.
+ * Actions are organized by functionality and follow consistent naming patterns.
+ *
+ * Organization:
+ * - Action Types Enum (grouped by functionality)
+ * - Reset Actions (form/error reset)
+ * - Form Data Actions (input fields, form state)
+ * - UI State Actions (drawers, buttons)
+ * - List Management Actions (banks, pagination)
+ * - Search Actions (queries)
+ * - Union Type Export
+ * - Action Creators (helper functions)
+ * - Type Utilities (guards and helpers)
+ *
+ * Naming Convention: Bank{Operation}{Target}Action
+ * Examples: BankSetInputFieldAction, BankResetFormAction
+ */
+import { BANK_DRAWER, BankForm, BankTypeBE } from "./types";
+export declare enum BANK_ACTION_TYPES {
+    RESET_ERRORS = "RESET_ERRORS",
+    RESET_FORM = "RESET_FORM",
+    SET_INPUT_FIELD = "SET_INPUT_FIELD",
+    SET_FORM = "SET_FORM",
+    SET_ERRORS = "SET_ERRORS",
+    SET_DISABLE_SAVE_BUTTON = "SET_DISABLE_SAVE_BUTTON",
+    SET_DRAWER = "SET_DRAWER",
+    SET_BANKS = "SET_BANKS",
+    SET_COUNT = "SET_COUNT",
+    SET_CURRENT_PAGE = "SET_CURRENT_PAGE",
+    SET_PAGE_LIMIT = "SET_PAGE_LIMIT",
+    SET_SEARCH_QUERY = "SET_SEARCH_QUERY"
+}
+/**
+ * Reset form validation errors
+ */
+export type BankResetErrorsAction = {
+    type: BANK_ACTION_TYPES.RESET_ERRORS;
+};
+/**
+ * Reset entire form to initial state
+ */
+export type BankResetFormAction = {
+    type: BANK_ACTION_TYPES.RESET_FORM;
+};
+/**
+ * Update individual form field dynamically
+ */
+export type BankSetInputFieldAction = {
+    type: BANK_ACTION_TYPES.SET_INPUT_FIELD;
+    payload: {
+        key: keyof BankForm;
+        value: string | string[] | boolean | number | number[];
+    };
+};
+/**
+ * Set entire form data (used when editing existing bank)
+ */
+export type BankSetFormAction = {
+    type: BANK_ACTION_TYPES.SET_FORM;
+    payload: {
+        form: BankTypeBE;
+    };
+};
+/**
+ * Set form validation errors
+ */
+export type BankSetErrorsAction = {
+    type: BANK_ACTION_TYPES.SET_ERRORS;
+    payload: {
+        errors: Record<string, string>;
+    };
+};
+/**
+ * Control save button state (enabled/disabled)
+ */
+export type BankSetDisableSaveButtonAction = {
+    type: BANK_ACTION_TYPES.SET_DISABLE_SAVE_BUTTON;
+    payload: {
+        disableSaveButton: boolean;
+    };
+};
+/**
+ * Manage drawer state (open/closed with specific drawer type)
+ */
+export type BankSetDrawerAction = {
+    type: BANK_ACTION_TYPES.SET_DRAWER;
+    payload: {
+        drawer: null | BANK_DRAWER;
+    };
+};
+/**
+ * Set banks list data
+ */
+export type BankSetBanksAction = {
+    type: BANK_ACTION_TYPES.SET_BANKS;
+    payload: {
+        banks: BankTypeBE[];
+    };
+};
+/**
+ * Set total count of banks (for pagination)
+ */
+export type BankSetCountAction = {
+    type: BANK_ACTION_TYPES.SET_COUNT;
+    payload: {
+        count: number;
+    };
+};
+/**
+ * Update current page number
+ */
+export type BankSetCurrentPageAction = {
+    type: BANK_ACTION_TYPES.SET_CURRENT_PAGE;
+    payload: {
+        currentPage: number;
+    };
+};
+/**
+ * Update page limit (items per page)
+ */
+export type BankSetPageLimitAction = {
+    type: BANK_ACTION_TYPES.SET_PAGE_LIMIT;
+    payload: {
+        pageLimit: number;
+    };
+};
+/**
+ * Update search query for banks
+ */
+export type BankSetSearchQueryAction = {
+    type: BANK_ACTION_TYPES.SET_SEARCH_QUERY;
+    payload: {
+        searchQuery: string;
+    };
+};
+/**
+ * All bank-related actions grouped by functionality
+ */
+export type BankActions = BankResetErrorsAction | BankResetFormAction | BankSetInputFieldAction | BankSetFormAction | BankSetErrorsAction | BankSetDisableSaveButtonAction | BankSetDrawerAction | BankSetBanksAction | BankSetCountAction | BankSetCurrentPageAction | BankSetPageLimitAction | BankSetSearchQueryAction;
+/**
+ * Type guard for reset actions
+ */
+export type BankResetActions = BankResetErrorsAction | BankResetFormAction;
+/**
+ * Type guard for form-related actions
+ */
+export type BankFormActions = BankSetInputFieldAction | BankSetFormAction | BankSetErrorsAction;
+/**
+ * Type guard for UI state actions
+ */
+export type BankUIActions = BankSetDisableSaveButtonAction | BankSetDrawerAction;
+/**
+ * Type guard for list management actions
+ */
+export type BankListActions = BankSetBanksAction | BankSetCountAction | BankSetCurrentPageAction | BankSetPageLimitAction;
+/**
+ * Action creators for common bank operations
+ * These provide type-safe action creation with better developer experience
+ */
+export declare const bankActionCreators: {
+    readonly resetErrors: () => BankResetErrorsAction;
+    readonly resetForm: () => BankResetFormAction;
+    readonly setInputField: (key: keyof BankForm, value: string | string[] | boolean | number | number[]) => BankSetInputFieldAction;
+    readonly setForm: (form: BankTypeBE) => BankSetFormAction;
+    readonly setErrors: (errors: Record<string, string>) => BankSetErrorsAction;
+    readonly setDisableSaveButton: (disableSaveButton: boolean) => BankSetDisableSaveButtonAction;
+    readonly setDrawer: (drawer: null | BANK_DRAWER) => BankSetDrawerAction;
+    readonly setBanks: (banks: BankTypeBE[]) => BankSetBanksAction;
+    readonly setCount: (count: number) => BankSetCountAction;
+    readonly setCurrentPage: (currentPage: number) => BankSetCurrentPageAction;
+    readonly setPageLimit: (pageLimit: number) => BankSetPageLimitAction;
+    readonly setSearchQuery: (searchQuery: string) => BankSetSearchQueryAction;
+};
+/**
+ * Extract action type from action object
+ */
+export type ActionType<T extends BankActions> = T["type"];
+/**
+ * Extract payload type from action object
+ */
+export type ActionPayload<T extends BankActions> = T extends {
+    payload: infer P;
+} ? P : never;
+/**
+ * Utility type to check if action has payload
+ */
+export type HasPayload<T extends BankActions> = T extends {
+    payload: unknown;
+} ? true : false;
+/**
+ * Runtime type guards for action validation
+ */
+export declare const isBankAction: (action: unknown) => action is BankActions;
+/**
+ * Type guard for reset actions
+ */
+export declare const isResetAction: (action: BankActions) => action is BankResetActions;

package/global-modules/bank/actions.js

@@ -0,0 +1,124 @@
+"use strict";
+/**
+ * Bank Actions
+ *
+ * This module defines all action types and interfaces for the Bank state management.
+ * Actions are organized by functionality and follow consistent naming patterns.
+ *
+ * Organization:
+ * - Action Types Enum (grouped by functionality)
+ * - Reset Actions (form/error reset)
+ * - Form Data Actions (input fields, form state)
+ * - UI State Actions (drawers, buttons)
+ * - List Management Actions (banks, pagination)
+ * - Search Actions (queries)
+ * - Union Type Export
+ * - Action Creators (helper functions)
+ * - Type Utilities (guards and helpers)
+ *
+ * Naming Convention: Bank{Operation}{Target}Action
+ * Examples: BankSetInputFieldAction, BankResetFormAction
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isResetAction = exports.isBankAction = exports.bankActionCreators = exports.BANK_ACTION_TYPES = void 0;
+// ============================================================================
+// ACTION TYPES ENUM
+// ============================================================================
+var BANK_ACTION_TYPES;
+(function (BANK_ACTION_TYPES) {
+    // Reset Actions
+    BANK_ACTION_TYPES["RESET_ERRORS"] = "RESET_ERRORS";
+    BANK_ACTION_TYPES["RESET_FORM"] = "RESET_FORM";
+    // Form Data Actions
+    BANK_ACTION_TYPES["SET_INPUT_FIELD"] = "SET_INPUT_FIELD";
+    BANK_ACTION_TYPES["SET_FORM"] = "SET_FORM";
+    BANK_ACTION_TYPES["SET_ERRORS"] = "SET_ERRORS";
+    // UI State Actions
+    BANK_ACTION_TYPES["SET_DISABLE_SAVE_BUTTON"] = "SET_DISABLE_SAVE_BUTTON";
+    BANK_ACTION_TYPES["SET_DRAWER"] = "SET_DRAWER";
+    // List Management Actions
+    BANK_ACTION_TYPES["SET_BANKS"] = "SET_BANKS";
+    BANK_ACTION_TYPES["SET_COUNT"] = "SET_COUNT";
+    BANK_ACTION_TYPES["SET_CURRENT_PAGE"] = "SET_CURRENT_PAGE";
+    BANK_ACTION_TYPES["SET_PAGE_LIMIT"] = "SET_PAGE_LIMIT";
+    // Search Actions
+    BANK_ACTION_TYPES["SET_SEARCH_QUERY"] = "SET_SEARCH_QUERY";
+})(BANK_ACTION_TYPES || (exports.BANK_ACTION_TYPES = BANK_ACTION_TYPES = {}));
+// ============================================================================
+// ACTION CREATORS (Optional Helper Functions)
+// ============================================================================
+/**
+ * Action creators for common bank operations
+ * These provide type-safe action creation with better developer experience
+ */
+exports.bankActionCreators = {
+    // Reset Actions
+    resetErrors: function () { return ({
+        type: BANK_ACTION_TYPES.RESET_ERRORS,
+    }); },
+    resetForm: function () { return ({
+        type: BANK_ACTION_TYPES.RESET_FORM,
+    }); },
+    // Form Actions
+    setInputField: function (key, value) { return ({
+        type: BANK_ACTION_TYPES.SET_INPUT_FIELD,
+        payload: { key: key, value: value },
+    }); },
+    setForm: function (form) { return ({
+        type: BANK_ACTION_TYPES.SET_FORM,
+        payload: { form: form },
+    }); },
+    setErrors: function (errors) { return ({
+        type: BANK_ACTION_TYPES.SET_ERRORS,
+        payload: { errors: errors },
+    }); },
+    // UI Actions
+    setDisableSaveButton: function (disableSaveButton) { return ({
+        type: BANK_ACTION_TYPES.SET_DISABLE_SAVE_BUTTON,
+        payload: { disableSaveButton: disableSaveButton },
+    }); },
+    setDrawer: function (drawer) { return ({
+        type: BANK_ACTION_TYPES.SET_DRAWER,
+        payload: { drawer: drawer },
+    }); },
+    // List Actions
+    setBanks: function (banks) { return ({
+        type: BANK_ACTION_TYPES.SET_BANKS,
+        payload: { banks: banks },
+    }); },
+    setCount: function (count) { return ({
+        type: BANK_ACTION_TYPES.SET_COUNT,
+        payload: { count: count },
+    }); },
+    setCurrentPage: function (currentPage) { return ({
+        type: BANK_ACTION_TYPES.SET_CURRENT_PAGE,
+        payload: { currentPage: currentPage },
+    }); },
+    setPageLimit: function (pageLimit) { return ({
+        type: BANK_ACTION_TYPES.SET_PAGE_LIMIT,
+        payload: { pageLimit: pageLimit },
+    }); },
+    // Search Actions
+    setSearchQuery: function (searchQuery) { return ({
+        type: BANK_ACTION_TYPES.SET_SEARCH_QUERY,
+        payload: { searchQuery: searchQuery },
+    }); },
+};
+/**
+ * Runtime type guards for action validation
+ */
+var isBankAction = function (action) {
+    return (typeof action === "object" &&
+        action !== null &&
+        "type" in action &&
+        Object.values(BANK_ACTION_TYPES).includes(action.type));
+};
+exports.isBankAction = isBankAction;
+/**
+ * Type guard for reset actions
+ */
+var isResetAction = function (action) {
+    return (action.type === BANK_ACTION_TYPES.RESET_ERRORS ||
+        action.type === BANK_ACTION_TYPES.RESET_FORM);
+};
+exports.isResetAction = isResetAction;

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

@@ -0,0 +1,2 @@
+import { FC } from "react";
+export declare const Bank: FC;

package/global-modules/bank/bank.js

@@ -0,0 +1,87 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Bank = void 0;
+var react_1 = __importDefault(require("react"));
+var next_intl_1 = require("next-intl");
+var util_functions_1 = require("@react-pakistan/util-functions");
+var use_rtl_1 = require("@/hooks/use-rtl");
+var enhanced_table_1 = require("@/components/ui/enhanced-table");
+var sonner_1 = require("@/components/ui/sonner");
+var theme_switcher_1 = require("@/components/theme-switcher");
+var constants_1 = require("./constants");
+var context_1 = require("./context");
+var drawer_1 = require("./drawer");
+var Bank = function () {
+    var _a = (0, context_1.useBankStateContext)(), banks = _a.banks, count = _a.count, currentPage = _a.currentPage, handleNextClick = _a.handleNextClick, handlePageLimit = _a.handlePageLimit, handlePreviousClick = _a.handlePreviousClick, headerActions = _a.headerActions, listLoading = _a.listLoading, pageLimit = _a.pageLimit, rowActions = _a.rowActions, searchOnChange = _a.searchOnChange, searchQuery = _a.searchQuery;
+    var t = (0, next_intl_1.useTranslations)("bankPage");
+    var isRTL = (0, use_rtl_1.useRTL)();
+    var translationMap = {
+        formLabelBankName: t("formLabelBankName"),
+        formLabelBankAddress: t("formLabelBankAddress"),
+        formLabelAccountTitle: t("formLabelAccountTitle"),
+        formLabelAccountNumber: t("formLabelAccountNumber"),
+        formLabelIBAN: t("formLabelIBAN"),
+        formLabelSwiftCode: t("formLabelSwiftCode"),
+        headingFormCreate: t("headingFormCreate"),
+        srCloseDrawer: t("srCloseDrawer"),
+        cancelBtn: t("cancelBtn"),
+        saveBtn: t("saveBtn"),
+        enableDescription: t("enableDescription"),
+        setAsDefault: t("setAsDefault"),
+        defaultDescription: t("defaultDescription"),
+    };
+    var tableHeadItems = [
+        {
+            label: t("tableColumnHeaderId"),
+            width: "5%",
+        },
+        {
+            label: t("tableColumnHeaderBankName"),
+            width: "15%",
+        },
+        {
+            label: t("tableColumnHeaderBankAddress"),
+            width: "15%",
+        },
+        {
+            label: t("tableColumnHeaderAccountTitle"),
+            width: "15%",
+        },
+        {
+            label: t("tableColumnHeaderAccountNumber"),
+            width: "15%",
+        },
+        {
+            label: t("tableColumnHeaderIBAN"),
+            width: "10%",
+        },
+        {
+            label: t("tableColumnHeaderSwiftCode"),
+            width: "10%",
+        },
+        {
+            label: t("tableColumnHeaderEnabled"),
+            width: "5%",
+        },
+        {
+            label: t("tableColumnHeaderIsDefault"),
+            width: "5%",
+        },
+        {
+            label: t("tableColumnHeaderActions"),
+            width: "5%",
+        },
+    ];
+    var totalPages = (0, util_functions_1.calculatePages)(count, pageLimit);
+    return (react_1.default.createElement("div", { className: "space-y-4 ".concat(isRTL ? "rtl" : "ltr"), dir: isRTL ? "rtl" : "ltr" },
+        react_1.default.createElement("div", { className: "flex items-center justify-between ".concat(isRTL ? "flex-row-reverse" : "") },
+            react_1.default.createElement("div", null),
+            react_1.default.createElement(theme_switcher_1.ThemeSwitcher, null)),
+        react_1.default.createElement(enhanced_table_1.EnhancedTable, { currentPage: Number(currentPage), handleNextOnClick: handleNextClick, handleOnSelect: handlePageLimit, handlePreviousOnClick: handlePreviousClick, handleSearchInput: searchOnChange, headerActions: headerActions, isNextDisabled: (0, util_functions_1.isNextButtonDisabled)(currentPage, totalPages), isPreviousDisabled: (0, util_functions_1.isPreviousButtonDisabled)(currentPage), listOptions: (0, util_functions_1.getAvailablePageLimits)(count), loading: listLoading, nodeSelectKey: "pageLimit", pageLimit: pageLimit, rowActions: rowActions, searchDisabled: false, searchEnabled: true, searchId: "bank-search", searchPlaceholder: t("tableHeaderSearchPlaceholder"), searchValue: searchQuery, tableBodyCols: constants_1.tableBodyCols, tableBodyRows: banks, tableDescription: t("tableDescription"), tableHeadItems: tableHeadItems, tableHeading: t("tableTitle"), totalPages: Number(totalPages) }),
+        react_1.default.createElement(drawer_1.BankDrawer, { isRTL: isRTL, translationMap: translationMap }),
+        react_1.default.createElement(sonner_1.Toaster, null)));
+};
+exports.Bank = Bank;

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

@@ -0,0 +1,45 @@
+/**
+ * Bank Constants
+ *
+ * This module defines all constants used throughout the Bank module.
+ * Constants are organized by functionality and follow consistent naming patterns.
+ *
+ * Organization:
+ * - Page Configuration (pagination, limits)
+ * - API Routes (backend endpoints)
+ * - Table Configuration (column definitions)
+ * - Toast Messages (user feedback)
+ *
+ * Naming Convention: Descriptive names with clear purpose
+ */
+import { VISTA_TABLE_CELL_TYPE } from "@appcorp/app-corp-vista/type/vista-table-type";
+/**
+ * Default page limit for pagination
+ */
+export declare const pageLimit: number;
+/**
+ * API endpoints for bank operations
+ */
+export declare const BANK_API_ROUTES: {
+    readonly BANK: "/api/bank";
+    readonly BANKS: "/api/banks";
+    readonly BANK_BY_ID: "/api/bank/bank-by-id";
+};
+/**
+ * Table column definitions for bank listing
+ */
+export declare const tableBodyCols: {
+    componentType: VISTA_TABLE_CELL_TYPE;
+    key: string;
+}[];
+/**
+ * Toast error messages for user feedback
+ */
+export declare const toastErrors: {
+    fetchInvoiceError: string;
+    formSubmittedSuccess: string;
+    genericError: string;
+    networkError: string;
+    submitFormError: string;
+    validationError: string;
+};

package/global-modules/bank/constants.js

@@ -0,0 +1,98 @@
+"use strict";
+/**
+ * Bank Constants
+ *
+ * This module defines all constants used throughout the Bank module.
+ * Constants are organized by functionality and follow consistent naming patterns.
+ *
+ * Organization:
+ * - Page Configuration (pagination, limits)
+ * - API Routes (backend endpoints)
+ * - Table Configuration (column definitions)
+ * - Toast Messages (user feedback)
+ *
+ * Naming Convention: Descriptive names with clear purpose
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toastErrors = exports.tableBodyCols = exports.BANK_API_ROUTES = exports.pageLimit = void 0;
+var vista_table_type_1 = require("@appcorp/app-corp-vista/type/vista-table-type");
+// ============================================================================
+// PAGE CONFIGURATION
+// ============================================================================
+/**
+ * Default page limit for pagination
+ */
+exports.pageLimit = Number(process.env.NEXT_PUBLIC_PAGE_LIMIT);
+// ============================================================================
+// API ROUTES
+// ============================================================================
+/**
+ * API endpoints for bank operations
+ */
+exports.BANK_API_ROUTES = {
+    BANK: "/api/bank",
+    BANKS: "/api/banks",
+    BANK_BY_ID: "/api/bank/bank-by-id",
+};
+// ============================================================================
+// TABLE CONFIGURATION
+// ============================================================================
+/**
+ * Table column definitions for bank listing
+ */
+exports.tableBodyCols = [
+    {
+        componentType: vista_table_type_1.VISTA_TABLE_CELL_TYPE.ID,
+        key: "id",
+    },
+    {
+        componentType: vista_table_type_1.VISTA_TABLE_CELL_TYPE.BOLD_TEXT,
+        key: "bankName",
+    },
+    {
+        componentType: vista_table_type_1.VISTA_TABLE_CELL_TYPE.TEXT,
+        key: "accountNumber",
+    },
+    {
+        componentType: vista_table_type_1.VISTA_TABLE_CELL_TYPE.TEXT,
+        key: "accountTitle",
+    },
+    {
+        componentType: vista_table_type_1.VISTA_TABLE_CELL_TYPE.TEXT,
+        key: "iban",
+    },
+    {
+        componentType: vista_table_type_1.VISTA_TABLE_CELL_TYPE.TEXT,
+        key: "swiftCode",
+    },
+    {
+        componentType: vista_table_type_1.VISTA_TABLE_CELL_TYPE.BOOLEAN,
+        key: "enabled",
+    },
+    {
+        componentType: vista_table_type_1.VISTA_TABLE_CELL_TYPE.BOOLEAN,
+        key: "isDefault",
+    },
+    {
+        componentType: vista_table_type_1.VISTA_TABLE_CELL_TYPE.TEXT,
+        key: "createdAt",
+    },
+    {
+        componentType: vista_table_type_1.VISTA_TABLE_CELL_TYPE.ACTIONS,
+        key: "action",
+    },
+];
+// ============================================================================
+// TOAST MESSAGES
+// ============================================================================
+/**
+ * Toast error messages for user feedback
+ */
+exports.toastErrors = {
+    fetchInvoiceError: "Error Fetching Invoice",
+    formSubmittedSuccess: "Form Submitted Successfully",
+    genericError: "Something Went Wrong",
+    networkError: "Network Error Occurred",
+    submitFormError: "Error Submitting Form",
+    validationError: "Validation Failed",
+};

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

@@ -0,0 +1,41 @@
+/**
+ * Bank State Context
+ *
+ * This module provides comprehensive state management for the Bank feature including:
+ * - CRUD operations (create, read, update, delete)
+ * - Form validation and error handling
+ * - Search and filtering functionality
+ * - Pagination controls
+ * - Internationalization support
+ * - Theme-aware toast notifications
+ *
+ * Organization:
+ * - Types & Interfaces
+ * - Main Hook (useBankState)
+ *   - State & Core Hooks
+ *   - Debounced Values
+ *   - API Parameters (memoized)
+ *   - API Callbacks (with error handling)
+ *   - Module Entity Hook
+ *   - Effects (list refresh)
+ *   - Drawer & Modal Handlers
+ *   - CRUD Operation Handlers
+ *   - Form Handlers
+ *   - Pagination Handlers
+ *   - Search Handlers
+ *   - Table Actions (memoized)
+ *   - Return State
+ * - Context Setup
+ * - Provider Component
+ * - Custom Hook
+ */
+import React, { FC, ReactNode } from "react";
+import { BankContextType, BankState } from "./types";
+type State = BankContextType & BankState;
+interface StateProviderProps {
+    children: ReactNode;
+}
+export declare const BankStateContext: React.Context<State>;
+export declare const BankStateContextProvider: FC<StateProviderProps>;
+export declare const useBankStateContext: () => State;
+export {};