@appcorp/fusion-storybook 0.2.12 → 0.2.14

package/base-modules/student-profile/context.d.ts

@@ -1,256 +1,20 @@
-import { StudentProfileBE } from "../../type";
-import { type RowAction, type TableRow } from "@appcorp/shadcn/components/enhanced-table";
-export declare const STUDENT_PROFILE_DRAWER: {
-    readonly FILTER_DRAWER: string;
-    readonly FORM_DRAWER: string;
-    readonly MORE_ACTIONS_DRAWER: string;
-    readonly VIEW_DRAWER: string;
-};
-export declare const STUDENT_PROFILE_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";
-    readonly SET_FILTERS: "SET_FILTERS";
-}, studentProfileModuleConfig: import("@react-pakistan/util-functions/factory/generic-module-factory").ModuleConfig<{
-    items: StudentProfileBE[];
-    count: number;
-    currentPage: number;
-    pageLimit: number;
-    searchQuery: string;
-    disableSaveButton: boolean;
-    drawer: string | null;
-    errors: Record<string, string>;
-    id: string;
-    familyMemberId: string;
-    studentCode: string;
-    status: string;
-    enabled: boolean;
-    remarks: string | null;
-    firstName: string;
-    lastName: string;
-    dateOfBirth: string | Date | null;
-    gender: string | null;
-    bloodGroup: string | null;
-    phone: string | null;
-    email: string | null;
-    emergencyPhone: string | null;
-    avatar: string | null;
-    familyId: string;
-    address: string | null;
-    city: string | null;
-    state: string | null;
-    country: string | null;
-    postalCode: string | null;
-    filterEnabled: boolean | undefined;
-    filterGender: string | undefined;
-    filterStatus: string | undefined;
-}>, initialStudentProfileState: {
-    items: StudentProfileBE[];
-    count: number;
-    currentPage: number;
-    pageLimit: number;
-    searchQuery: string;
-    disableSaveButton: boolean;
-    drawer: string | null;
-    errors: Record<string, string>;
-    id: string;
-    familyMemberId: string;
-    studentCode: string;
-    status: string;
-    enabled: boolean;
-    remarks: string | null;
-    firstName: string;
-    lastName: string;
-    dateOfBirth: string | Date | null;
-    gender: string | null;
-    bloodGroup: string | null;
-    phone: string | null;
-    email: string | null;
-    emergencyPhone: string | null;
-    avatar: string | null;
-    familyId: string;
-    address: string | null;
-    city: string | null;
-    state: string | null;
-    country: string | null;
-    postalCode: string | null;
-    filterEnabled: boolean | undefined;
-    filterGender: string | undefined;
-    filterStatus: string | undefined;
-}, StudentProfileProvider: import("react").FC<{
-    children: React.ReactNode;
-}>, studentProfileReducer: (state: {
-    items: StudentProfileBE[];
-    count: number;
-    currentPage: number;
-    pageLimit: number;
-    searchQuery: string;
-    disableSaveButton: boolean;
-    drawer: string | null;
-    errors: Record<string, string>;
-    id: string;
-    familyMemberId: string;
-    studentCode: string;
-    status: string;
-    enabled: boolean;
-    remarks: string | null;
-    firstName: string;
-    lastName: string;
-    dateOfBirth: string | Date | null;
-    gender: string | null;
-    bloodGroup: string | null;
-    phone: string | null;
-    email: string | null;
-    emergencyPhone: string | null;
-    avatar: string | null;
-    familyId: string;
-    address: string | null;
-    city: string | null;
-    state: string | null;
-    country: string | null;
-    postalCode: string | null;
-    filterEnabled: boolean | undefined;
-    filterGender: string | undefined;
-    filterStatus: string | undefined;
-}, action: any) => {
-    items: StudentProfileBE[];
-    count: number;
-    currentPage: number;
-    pageLimit: number;
-    searchQuery: string;
-    disableSaveButton: boolean;
-    drawer: string | null;
-    errors: Record<string, string>;
-    id: string;
-    familyMemberId: string;
-    studentCode: string;
-    status: string;
-    enabled: boolean;
-    remarks: string | null;
-    firstName: string;
-    lastName: string;
-    dateOfBirth: string | Date | null;
-    gender: string | null;
-    bloodGroup: string | null;
-    phone: string | null;
-    email: string | null;
-    emergencyPhone: string | null;
-    avatar: string | null;
-    familyId: string;
-    address: string | null;
-    city: string | null;
-    state: string | null;
-    country: string | null;
-    postalCode: string | null;
-    filterEnabled: boolean | undefined;
-    filterGender: string | undefined;
-    filterStatus: string | undefined;
-}, useStudentProfileContext: () => import("@react-pakistan/util-functions/factory/generic-module-factory").GenericModuleContext<{
-    items: StudentProfileBE[];
-    count: number;
-    currentPage: number;
-    pageLimit: number;
-    searchQuery: string;
-    disableSaveButton: boolean;
-    drawer: string | null;
-    errors: Record<string, string>;
-    id: string;
-    familyMemberId: string;
-    studentCode: string;
-    status: string;
-    enabled: boolean;
-    remarks: string | null;
-    firstName: string;
-    lastName: string;
-    dateOfBirth: string | Date | null;
-    gender: string | null;
-    bloodGroup: string | null;
-    phone: string | null;
-    email: string | null;
-    emergencyPhone: string | null;
-    avatar: string | null;
-    familyId: string;
-    address: string | null;
-    city: string | null;
-    state: string | null;
-    country: string | null;
-    postalCode: string | null;
-    filterEnabled: boolean | undefined;
-    filterGender: string | undefined;
-    filterStatus: string | undefined;
-}>;
-export declare const useStudentProfileModule: () => {
-    applyFilters: () => void;
-    byIdLoading: boolean;
-    clearFilters: () => void;
-    clearSearch: () => void;
-    closeDrawer: () => void;
-    deleteLoading: boolean;
-    handleAvatar: (files: File[]) => void;
-    handleChange: (field: string, value: string | number | boolean | undefined | null) => void;
-    handleCreate: () => void;
-    handleDelete: (row?: TableRow) => void;
-    handleEdit: (row?: TableRow) => void;
-    handleFilters: () => void;
-    handleMoreActions: () => void;
-    handlePageChange: (page: number | unknown) => void;
-    handlePageLimitChange: (k: string, value: object) => void;
-    handleReAdmitStudent: (row?: TableRow) => Promise<void>;
-    handleSearch: (query: string) => void;
-    handleSubmit: () => void;
-    handleView: (row?: TableRow) => void;
-    handleWithdrawStudent: () => Promise<void>;
-    headerActions: {
-        enabled: boolean;
-        handleOnClick: () => void;
-        label: string;
-        order: number;
-    }[];
-    listFetchNow: (url?: string, config?: import("@react-pakistan/util-functions/hooks/use-fetch").FetchConfig) => void;
-    listLoading: boolean;
-    rowActions: RowAction[];
-    toggleStatus: (row?: TableRow) => void;
-    updateLoading: boolean;
-    state: {
-        items: StudentProfileBE[];
-        count: number;
-        currentPage: number;
-        pageLimit: number;
-        searchQuery: string;
-        disableSaveButton: boolean;
-        drawer: string | null;
-        errors: Record<string, string>;
-        id: string;
-        familyMemberId: string;
-        studentCode: string;
-        status: string;
-        enabled: boolean;
-        remarks: string | null;
-        firstName: string;
-        lastName: string;
-        dateOfBirth: string | Date | null;
-        gender: string | null;
-        bloodGroup: string | null;
-        phone: string | null;
-        email: string | null;
-        emergencyPhone: string | null;
-        avatar: string | null;
-        familyId: string;
-        address: string | null;
-        city: string | null;
-        state: string | null;
-        country: string | null;
-        postalCode: string | null;
-        filterEnabled: boolean | undefined;
-        filterGender: string | undefined;
-        filterStatus: string | undefined;
-    };
-    dispatch: React.Dispatch<any>;
-};
+/**
+ * StudentProfile Context
+ *
+ * Wires the generic module state (created by `createGenericModule`) to network
+ * actions using `useModuleEntityV2`. Contains domain-specific handlers for
+ * CRUD operations, withdraw, re-admit, and status changes.
+ *
+ * Key responsibilities:
+ * - Expose `useStudentProfileModule()` which UI components call for actions
+ * - Keep module-specific `apiParams` and callbacks in one place
+ * - Ensure cache invalidation and toast notifications on mutation
+ *
+ * Exported utilities:
+ * - `StudentProfileProvider` — provider component used by the page
+ * - `STUDENT_PROFILE_ACTION_TYPES` — action type constants (from factory)
+ * - `STUDENT_PROFILE_DRAWER` — drawer type constants
+ * - `useStudentProfileModule()` — hook that returns state, dispatch, and handlers
+ */
+export { STUDENT_PROFILE_DRAWER, STUDENT_PROFILE_ACTION_TYPES, studentProfileModuleConfig, initialStudentProfileState, StudentProfileProvider, studentProfileReducer, useStudentProfileContext, } from "./context/module-base";
+export { useStudentProfileModule } from "./context/use-student-profile-module";