@appcorp/stellar-solutions-invoice-module 0.1.74 → 0.1.75

package/base-modules/quote/context.d.ts

@@ -1,50 +1,660 @@
 /**
- * Invoice State Context
+ * Quote State Context - Using Generic Module Factory
  *
- * This module provides comprehensive state management for the Invoice feature including:
- * - CRUD operations (create, read, update, delete)
- * - Form validation and error handling
- * - Multi-section forms (company, customer, pricing, products, services)
- * - Complex calculations (subtotal, tax, discount, total)
- * - Dynamic product and service row management
- * - Search and filtering functionality
- * - Pagination controls
- * - Company and customer integration
- * - Currency and tax management
- * - Internationalization support
- * - Theme-aware toast notifications
- *
- * Organization:
- * - Types & Interfaces
- * - Main Hook (useInvoiceState)
- *   - State & Core Hooks
- *   - Theme Support
- *   - Toast Helpers
- *   - Debounced Values
- *   - Tax & Currency Defaults
- *   - API Parameters (memoized)
- *   - API Callbacks (with error handling)
- *   - Module Entity Hook
- *   - Effects (list refresh, defaults, calculations)
- *   - Drawer & Modal Handlers
- *   - CRUD Operation Handlers
- *   - Form Handlers (products, services, pricing)
- *   - Calculation Handlers
- *   - Pagination Handlers
- *   - Search Handlers
- *   - Table Actions (memoized)
- *   - Return State
- * - Context Setup
- * - Provider Component
- * - Custom Hook
+ * This module provides comprehensive state management for the Quote feature using
+ * the createGenericModule factory pattern.
  */
-import React, { FC, ReactNode } from "react";
-import { QuoteContextType, QuoteState } from "./types";
-type State = QuoteContextType & QuoteState;
-interface StateProviderProps {
-    children: ReactNode;
+import { QUOTE_INVOICE_CATEGORY, DISCOUNT_UNIT, INVOICE_STATUS, QUOTE_STATUS } from "@react-pakistan/util-functions";
+export declare const quoteReducer: (state: {
+    items: never[];
+    count: number;
+    currentPage: number;
+    pageLimit: number;
+    searchQuery: string;
+    disableSaveButton: boolean;
+    drawer: null;
+    quoteMode: null;
+    modal: null;
+    loading: boolean;
+    afterDiscount: string;
+    category: QUOTE_INVOICE_CATEGORY;
+    companiesList: never[];
+    companyId: string;
+    companyQuery: string;
+    contactsList: never[];
+    countryQuery: string;
+    currency: string;
+    customerId: string;
+    date: string;
+    discount: string;
+    discountUnit: DISCOUNT_UNIT;
+    errors: Record<string, string>;
+    expiryDate: string;
+    getProducts: never[];
+    id: string;
+    invoiceStatus: INVOICE_STATUS;
+    mode: "Create" | "Edit";
+    netTotal: string;
+    note: string;
+    payments: never[];
+    products: never[];
+    productQuery: string;
+    productsList: {
+        id: string;
+        mode: "Create" | "Edit" | "";
+        price: string;
+        quantity: string;
+        rowTotal: string;
+    }[];
+    quoteStatus: QUOTE_STATUS;
+    ref: string;
+    servicesList: {
+        description: string;
+        mode: "Create" | "Edit" | "";
+        name: string;
+        price: string;
+        quantity: string;
+        rowTotal: string;
+    }[];
+    services: never[];
+    subTotal: string;
+    tax: string;
+    taxQuery: string;
+    taxRate: string;
+    taxes: never[];
+    total: string;
+    customer: {
+        address: string;
+        city: string;
+        country: string;
+        createdAt: string;
+        email: string;
+        firstName: string;
+        id: string;
+        lastName: string;
+        phone: string;
+        quotesInvoices: never[];
+        updatedAt: string;
+    };
+    company: {
+        contacts: never[];
+        country: string;
+        createdAt: string;
+        email: string;
+        id: string;
+        name: string;
+        phone: string;
+        quotesInvoices: never[];
+        updatedAt: string;
+        website: string;
+    };
+}, action: any) => {
+    items: never[];
+    count: number;
+    currentPage: number;
+    pageLimit: number;
+    searchQuery: string;
+    disableSaveButton: boolean;
+    drawer: null;
+    quoteMode: null;
+    modal: null;
+    loading: boolean;
+    afterDiscount: string;
+    category: QUOTE_INVOICE_CATEGORY;
+    companiesList: never[];
+    companyId: string;
+    companyQuery: string;
+    contactsList: never[];
+    countryQuery: string;
+    currency: string;
+    customerId: string;
+    date: string;
+    discount: string;
+    discountUnit: DISCOUNT_UNIT;
+    errors: Record<string, string>;
+    expiryDate: string;
+    getProducts: never[];
+    id: string;
+    invoiceStatus: INVOICE_STATUS;
+    mode: "Create" | "Edit";
+    netTotal: string;
+    note: string;
+    payments: never[];
+    products: never[];
+    productQuery: string;
+    productsList: {
+        id: string;
+        mode: "Create" | "Edit" | "";
+        price: string;
+        quantity: string;
+        rowTotal: string;
+    }[];
+    quoteStatus: QUOTE_STATUS;
+    ref: string;
+    servicesList: {
+        description: string;
+        mode: "Create" | "Edit" | "";
+        name: string;
+        price: string;
+        quantity: string;
+        rowTotal: string;
+    }[];
+    services: never[];
+    subTotal: string;
+    tax: string;
+    taxQuery: string;
+    taxRate: string;
+    taxes: never[];
+    total: string;
+    customer: {
+        address: string;
+        city: string;
+        country: string;
+        createdAt: string;
+        email: string;
+        firstName: string;
+        id: string;
+        lastName: string;
+        phone: string;
+        quotesInvoices: never[];
+        updatedAt: string;
+    };
+    company: {
+        contacts: never[];
+        country: string;
+        createdAt: string;
+        email: string;
+        id: string;
+        name: string;
+        phone: string;
+        quotesInvoices: never[];
+        updatedAt: string;
+        website: string;
+    };
+}, QuoteProvider: import("react").FC<{
+    children: React.ReactNode;
+}>, useQuoteContext: () => import("@react-pakistan/util-functions/factory/generic-module-factory").GenericModuleContext<{
+    items: never[];
+    count: number;
+    currentPage: number;
+    pageLimit: number;
+    searchQuery: string;
+    disableSaveButton: boolean;
+    drawer: null;
+    quoteMode: null;
+    modal: null;
+    loading: boolean;
+    afterDiscount: string;
+    category: QUOTE_INVOICE_CATEGORY;
+    companiesList: never[];
+    companyId: string;
+    companyQuery: string;
+    contactsList: never[];
+    countryQuery: string;
+    currency: string;
+    customerId: string;
+    date: string;
+    discount: string;
+    discountUnit: DISCOUNT_UNIT;
+    errors: Record<string, string>;
+    expiryDate: string;
+    getProducts: never[];
+    id: string;
+    invoiceStatus: INVOICE_STATUS;
+    mode: "Create" | "Edit";
+    netTotal: string;
+    note: string;
+    payments: never[];
+    products: never[];
+    productQuery: string;
+    productsList: {
+        id: string;
+        mode: "Create" | "Edit" | "";
+        price: string;
+        quantity: string;
+        rowTotal: string;
+    }[];
+    quoteStatus: QUOTE_STATUS;
+    ref: string;
+    servicesList: {
+        description: string;
+        mode: "Create" | "Edit" | "";
+        name: string;
+        price: string;
+        quantity: string;
+        rowTotal: string;
+    }[];
+    services: never[];
+    subTotal: string;
+    tax: string;
+    taxQuery: string;
+    taxRate: string;
+    taxes: never[];
+    total: string;
+    customer: {
+        address: string;
+        city: string;
+        country: string;
+        createdAt: string;
+        email: string;
+        firstName: string;
+        id: string;
+        lastName: string;
+        phone: string;
+        quotesInvoices: never[];
+        updatedAt: string;
+    };
+    company: {
+        contacts: never[];
+        country: string;
+        createdAt: string;
+        email: string;
+        id: string;
+        name: string;
+        phone: string;
+        quotesInvoices: never[];
+        updatedAt: string;
+        website: string;
+    };
+}>, quoteModuleConfig: import("@react-pakistan/util-functions/factory/generic-module-factory").ModuleConfig<{
+    items: never[];
+    count: number;
+    currentPage: number;
+    pageLimit: number;
+    searchQuery: string;
+    disableSaveButton: boolean;
+    drawer: null;
+    quoteMode: null;
+    modal: null;
+    loading: boolean;
+    afterDiscount: string;
+    category: QUOTE_INVOICE_CATEGORY;
+    companiesList: never[];
+    companyId: string;
+    companyQuery: string;
+    contactsList: never[];
+    countryQuery: string;
+    currency: string;
+    customerId: string;
+    date: string;
+    discount: string;
+    discountUnit: DISCOUNT_UNIT;
+    errors: Record<string, string>;
+    expiryDate: string;
+    getProducts: never[];
+    id: string;
+    invoiceStatus: INVOICE_STATUS;
+    mode: "Create" | "Edit";
+    netTotal: string;
+    note: string;
+    payments: never[];
+    products: never[];
+    productQuery: string;
+    productsList: {
+        id: string;
+        mode: "Create" | "Edit" | "";
+        price: string;
+        quantity: string;
+        rowTotal: string;
+    }[];
+    quoteStatus: QUOTE_STATUS;
+    ref: string;
+    servicesList: {
+        description: string;
+        mode: "Create" | "Edit" | "";
+        name: string;
+        price: string;
+        quantity: string;
+        rowTotal: string;
+    }[];
+    services: never[];
+    subTotal: string;
+    tax: string;
+    taxQuery: string;
+    taxRate: string;
+    taxes: never[];
+    total: string;
+    customer: {
+        address: string;
+        city: string;
+        country: string;
+        createdAt: string;
+        email: string;
+        firstName: string;
+        id: string;
+        lastName: string;
+        phone: string;
+        quotesInvoices: never[];
+        updatedAt: string;
+    };
+    company: {
+        contacts: never[];
+        country: string;
+        createdAt: string;
+        email: string;
+        id: string;
+        name: string;
+        phone: string;
+        quotesInvoices: never[];
+        updatedAt: string;
+        website: string;
+    };
+}>, QUOTE_ACTION_TYPES: {
+    readonly RESET_FORM: "RESET_FORM";
+    readonly SET_CURRENT_PAGE: "SET_CURRENT_PAGE";
+    readonly SET_PAGE_LIMIT: "SET_PAGE_LIMIT";
+    readonly SET_SEARCH_QUERY: "SET_SEARCH_QUERY";
+    readonly SET_DRAWER: "SET_DRAWER";
+    readonly SET_ITEMS: "SET_ITEMS";
+    readonly SET_FORM_DATA: "SET_FORM_DATA";
+    readonly SET_DISABLE_SAVE_BUTTON: "SET_DISABLE_SAVE_BUTTON";
+    readonly SET_INPUT_FIELD: "SET_INPUT_FIELD";
+    readonly SET_ERRORS: "SET_ERRORS";
+}, initialQuoteState: {
+    items: never[];
+    count: number;
+    currentPage: number;
+    pageLimit: number;
+    searchQuery: string;
+    disableSaveButton: boolean;
+    drawer: null;
+    quoteMode: null;
+    modal: null;
+    loading: boolean;
+    afterDiscount: string;
+    category: QUOTE_INVOICE_CATEGORY;
+    companiesList: never[];
+    companyId: string;
+    companyQuery: string;
+    contactsList: never[];
+    countryQuery: string;
+    currency: string;
+    customerId: string;
+    date: string;
+    discount: string;
+    discountUnit: DISCOUNT_UNIT;
+    errors: Record<string, string>;
+    expiryDate: string;
+    getProducts: never[];
+    id: string;
+    invoiceStatus: INVOICE_STATUS;
+    mode: "Create" | "Edit";
+    netTotal: string;
+    note: string;
+    payments: never[];
+    products: never[];
+    productQuery: string;
+    productsList: {
+        id: string;
+        mode: "Create" | "Edit" | "";
+        price: string;
+        quantity: string;
+        rowTotal: string;
+    }[];
+    quoteStatus: QUOTE_STATUS;
+    ref: string;
+    servicesList: {
+        description: string;
+        mode: "Create" | "Edit" | "";
+        name: string;
+        price: string;
+        quantity: string;
+        rowTotal: string;
+    }[];
+    services: never[];
+    subTotal: string;
+    tax: string;
+    taxQuery: string;
+    taxRate: string;
+    taxes: never[];
+    total: string;
+    customer: {
+        address: string;
+        city: string;
+        country: string;
+        createdAt: string;
+        email: string;
+        firstName: string;
+        id: string;
+        lastName: string;
+        phone: string;
+        quotesInvoices: never[];
+        updatedAt: string;
+    };
+    company: {
+        contacts: never[];
+        country: string;
+        createdAt: string;
+        email: string;
+        id: string;
+        name: string;
+        phone: string;
+        quotesInvoices: never[];
+        updatedAt: string;
+        website: string;
+    };
+};
+export interface ServiceParams {
+    index: number;
+    key: string;
+    value: string | number;
+}
+export interface ProductParams {
+    index: number;
+    key: string;
+    value: string | number;
 }
-export declare const QuoteStateContext: React.Context<State>;
-export declare const QuoteStateContextProvider: FC<StateProviderProps>;
-export declare const useQuoteStateContext: () => State;
-export {};
+export declare const useQuoteModule: () => {
+    quotes: never[];
+    byIdError: Error | undefined;
+    byIdLoading: boolean;
+    clearSearch: () => void;
+    closeDrawer: () => void;
+    deleteError: Error | undefined;
+    deleteLoading: boolean;
+    dispatch: import("react").Dispatch<any>;
+    handleAddItemProduct: () => void;
+    handleAddItemService: () => void;
+    handleChange: (key: string, value: string) => void;
+    handleCloseDrawer: () => void;
+    handleCreate: (text: "customer" | "company") => void;
+    handleDelete: (row: unknown) => void;
+    handleDeleteProductRow: (i: number) => void;
+    handleDeleteServiceRow: (i: number) => void;
+    handleEdit: (row: unknown) => void;
+    handleItemChangeProducts: ({ index, key, value }: ProductParams) => void;
+    handleItemChangeServices: ({ index, key, value }: ServiceParams) => void;
+    handleNextClick: () => void;
+    handlePageChange: (page: number) => void;
+    handlePageLimit: (k: string, value: object) => void;
+    handlePageLimitChange: (limit: number) => void;
+    handlePreviousClick: () => void;
+    handleSearch: (query: string) => void;
+    handleSubmit: () => void;
+    handleTaxSearch: (searchQuery: string) => void;
+    handleView: (row: unknown) => void;
+    headerActions: {
+        enabled: boolean;
+        handleOnClick: () => void;
+        label: string;
+        order: number;
+    }[];
+    listError: Error | undefined;
+    listFetchNow: (url?: string, config?: import("@react-pakistan/util-functions").FetchConfig) => void;
+    listLoading: boolean;
+    rowActions: {
+        enabled: boolean;
+        handleAction: (id: string) => void;
+        label: string;
+        order: number;
+    }[];
+    searchOnChange: (k: string, v: string) => void;
+    updateError: Error | undefined;
+    updateLoading: boolean;
+    items: never[];
+    count: number;
+    currentPage: number;
+    pageLimit: number;
+    searchQuery: string;
+    disableSaveButton: boolean;
+    drawer: null;
+    quoteMode: null;
+    modal: null;
+    loading: boolean;
+    afterDiscount: string;
+    category: QUOTE_INVOICE_CATEGORY;
+    companiesList: never[];
+    companyId: string;
+    companyQuery: string;
+    contactsList: never[];
+    countryQuery: string;
+    currency: string;
+    customerId: string;
+    date: string;
+    discount: string;
+    discountUnit: DISCOUNT_UNIT;
+    errors: Record<string, string>;
+    expiryDate: string;
+    getProducts: never[];
+    id: string;
+    invoiceStatus: INVOICE_STATUS;
+    mode: "Create" | "Edit";
+    netTotal: string;
+    note: string;
+    payments: never[];
+    products: never[];
+    productQuery: string;
+    productsList: {
+        id: string;
+        mode: "Create" | "Edit" | "";
+        price: string;
+        quantity: string;
+        rowTotal: string;
+    }[];
+    quoteStatus: QUOTE_STATUS;
+    ref: string;
+    servicesList: {
+        description: string;
+        mode: "Create" | "Edit" | "";
+        name: string;
+        price: string;
+        quantity: string;
+        rowTotal: string;
+    }[];
+    services: never[];
+    subTotal: string;
+    tax: string;
+    taxQuery: string;
+    taxRate: string;
+    taxes: never[];
+    total: string;
+    customer: {
+        address: string;
+        city: string;
+        country: string;
+        createdAt: string;
+        email: string;
+        firstName: string;
+        id: string;
+        lastName: string;
+        phone: string;
+        quotesInvoices: never[];
+        updatedAt: string;
+    };
+    company: {
+        contacts: never[];
+        country: string;
+        createdAt: string;
+        email: string;
+        id: string;
+        name: string;
+        phone: string;
+        quotesInvoices: never[];
+        updatedAt: string;
+        website: string;
+    };
+    state: {
+        items: never[];
+        count: number;
+        currentPage: number;
+        pageLimit: number;
+        searchQuery: string;
+        disableSaveButton: boolean;
+        drawer: null;
+        quoteMode: null;
+        modal: null;
+        loading: boolean;
+        afterDiscount: string;
+        category: QUOTE_INVOICE_CATEGORY;
+        companiesList: never[];
+        companyId: string;
+        companyQuery: string;
+        contactsList: never[];
+        countryQuery: string;
+        currency: string;
+        customerId: string;
+        date: string;
+        discount: string;
+        discountUnit: DISCOUNT_UNIT;
+        errors: Record<string, string>;
+        expiryDate: string;
+        getProducts: never[];
+        id: string;
+        invoiceStatus: INVOICE_STATUS;
+        mode: "Create" | "Edit";
+        netTotal: string;
+        note: string;
+        payments: never[];
+        products: never[];
+        productQuery: string;
+        productsList: {
+            id: string;
+            mode: "Create" | "Edit" | "";
+            price: string;
+            quantity: string;
+            rowTotal: string;
+        }[];
+        quoteStatus: QUOTE_STATUS;
+        ref: string;
+        servicesList: {
+            description: string;
+            mode: "Create" | "Edit" | "";
+            name: string;
+            price: string;
+            quantity: string;
+            rowTotal: string;
+        }[];
+        services: never[];
+        subTotal: string;
+        tax: string;
+        taxQuery: string;
+        taxRate: string;
+        taxes: never[];
+        total: string;
+        customer: {
+            address: string;
+            city: string;
+            country: string;
+            createdAt: string;
+            email: string;
+            firstName: string;
+            id: string;
+            lastName: string;
+            phone: string;
+            quotesInvoices: never[];
+            updatedAt: string;
+        };
+        company: {
+            contacts: never[];
+            country: string;
+            createdAt: string;
+            email: string;
+            id: string;
+            name: string;
+            phone: string;
+            quotesInvoices: never[];
+            updatedAt: string;
+            website: string;
+        };
+    };
+};