@bluemarble/bm-components 0.0.92 → 0.0.94

package/dist/index.d.mts

@@ -1,6 +1,10 @@
 import React, { ReactNode, FC } from 'react';
-import { TableCellProps, TextFieldProps, TableRowProps, StandardTextFieldProps, SelectProps as SelectProps$1, FormControlProps, InputLabelProps, AutocompleteRenderInputParams, AutocompleteProps as AutocompleteProps$1, CheckboxProps as CheckboxProps$1, FormControlLabelProps, SwitchProps as SwitchProps$1, RadioGroupProps, ButtonProps, CircularProgressProps, SxProps, PaperProps, TableProps, TableHeadProps, TableBodyProps, ModalProps as ModalProps$1, DialogProps } from '@mui/material';
+import * as _mui_material from '@mui/material';
+import { TableCellProps, TextFieldProps, TableRowProps, StandardTextFieldProps, SelectProps as SelectProps$1, FormControlProps, InputLabelProps, AutocompleteRenderInputParams, AutocompleteProps as AutocompleteProps$1, CheckboxProps as CheckboxProps$1, FormControlLabelProps, SwitchProps as SwitchProps$1, RadioGroupProps, ButtonProps, CircularProgressProps, SxProps, PaperProps, TableProps, TableHeadProps, TableBodyProps, ModalProps as ModalProps$1, DialogProps, AlertColor } from '@mui/material';
 import IMask$1 from 'imask';
+import { NextApiRequest, NextApiResponse } from 'next';
+import { ZodTypeDef, ZodSchema } from 'zod';
+import { AxiosInstance } from 'axios';
 
 interface ColumnTitleProps {
     name: string;
@@ -230,6 +234,75 @@ interface GridProps {
 }
 declare function BaseGrid({ columns, children, paperProps, tableBodyProps, tableHeadProps, tableProps, sortedDirection, sortedBy, onSortBy, dense, striped, bordered, currentPage, totalNumberOfPages, onPageChange, rowsPerPage, setRowsPerPage, rowsPerPageOptions, hideFooter, prependColumn, appendColumn, isLoading }: GridProps): JSX.Element;
 
+declare type ModalProps = {
+    open: boolean;
+    onClose: () => void;
+} & ModalProps$1;
+declare const Modal: ({ open, onClose, ...rest }: ModalProps) => JSX.Element;
+
+declare function GetInputLabel<T extends Array<Record<string, any>>, K extends T[number]['name']>(columns: T): (columnName: K) => {
+    label: any;
+    name: any;
+};
+
+interface DialogOptionsProps {
+    label: string;
+    focus?: boolean;
+    cb(label: string): void;
+}
+interface DialogCustomProps extends DialogProps {
+    open: boolean;
+    title: string;
+    body: string;
+    options: DialogOptionsProps[];
+    loading: boolean;
+}
+declare const Dialog: ({ open, title, loading, body, options, ...rest }: DialogCustomProps) => JSX.Element;
+
+declare class HttpError extends Error {
+    status: number;
+    constructor(status: number, message: any);
+}
+
+declare type PossibleMethods = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+declare type HandlerProps = (req: NextApiRequest & {
+    user?: number;
+}, res: NextApiResponse) => Promise<any>;
+declare type MethodProps = Partial<Record<PossibleMethods, HandlerProps>>;
+declare type MiddlewaresProps = ((handler: HandlerProps) => HandlerProps)[];
+declare type ConstructorProps = {
+    middlewares?: MiddlewaresProps;
+    onFinally: () => void;
+};
+declare class ApiHelper {
+    middlewares: MiddlewaresProps;
+    private onFinally;
+    constructor(props?: ConstructorProps);
+    setMiddlewares(middlewares: any[]): this;
+    createMethods(methods: MethodProps): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
+    static parserErrorWrapper<Output, Def extends ZodTypeDef, Input>(body: Record<string, any>, parser: ZodSchema<Output, Def, Input>): Output;
+    static parseQueyFilters<T extends Record<string, any>>(filters: T): T;
+    static create({ onFinally }: {
+        onFinally: any;
+    }): ApiHelper;
+}
+
+declare type Methods = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options';
+declare type HandleProps = {
+    name: `${Methods}:${string}`;
+};
+declare type UseFormHelperProps = {
+    formatErrorMessage: (message: any) => string;
+    api: AxiosInstance;
+};
+declare function useFormHelper({ formatErrorMessage, api }: UseFormHelperProps): {
+    onSubmitWrapper: <T extends Record<string, any>>(fn: (fields: T, methods: any) => Promise<void>, { name }: HandleProps) => (fields: T, methods: any) => Promise<void>;
+    onRequestWrapper: <F extends (...args: Parameters<F>) => R, R>(fn: F, { name }: HandleProps) => (...params: Parameters<F>) => Promise<R>;
+    isLoading: (prop: string) => boolean;
+    setLoading: (prop: string, remove?: boolean) => void;
+    createAlert(message: string, type: _mui_material.AlertColor): void;
+};
+
 declare type FilterCompareType = 'gte' | 'lte' | 'lt' | 'gt' | 'equal' | 'in' | 'notEqual' | 'notIn';
 declare type FilterProps = {
     id?: string;
@@ -283,29 +356,13 @@ declare function useLoading<T = string>(): {
     setLoading: (prop: T, remove?: boolean) => void;
 };
 
-declare type ModalProps = {
-    open: boolean;
-    onClose: () => void;
-} & ModalProps$1;
-declare const Modal: ({ open, onClose, ...rest }: ModalProps) => JSX.Element;
-
-declare function GetInputLabel<T extends Array<Record<string, any>>, K extends T[number]['name']>(columns: T): (columnName: K) => {
-    label: any;
-    name: any;
+declare const useAlert: () => {
+    createAlert(message: string, type: _mui_material.AlertColor): void;
 };
 
-interface DialogOptionsProps {
-    label: string;
-    focus?: boolean;
-    cb(label: string): void;
-}
-interface DialogCustomProps extends DialogProps {
-    open: boolean;
-    title: string;
-    body: string;
-    options: DialogOptionsProps[];
-    loading: boolean;
-}
-declare const Dialog: ({ open, title, loading, body, options, ...rest }: DialogCustomProps) => JSX.Element;
+declare type AlertContextProps = {
+    createAlert(message: string, type: AlertColor): void;
+};
+declare const AlertContext: React.Context<AlertContextProps>;
 
-export { Autocomplete, BaseGrid, Checkbox, type ColumnTitleProps, type ColumnsProps, Dialog, EditableTableCell, type FilterCompareType, type FilterProps, GetInputLabel, Grid, type IFilter, Input, InputMask, LargeButton, Modal, Radio, Select, Switch, TabPanel, type TabPanelProps, Td, Tr, createFilter, filterData, getTabProps, useEvent, useFilter, useGrid, useLoading };
+export { AlertContext, ApiHelper, Autocomplete, BaseGrid, Checkbox, type ColumnTitleProps, type ColumnsProps, Dialog, EditableTableCell, type FilterCompareType, type FilterProps, GetInputLabel, Grid, HttpError, type IFilter, Input, InputMask, LargeButton, Modal, Radio, Select, Switch, TabPanel, type TabPanelProps, Td, Tr, createFilter, filterData, getTabProps, useAlert, useEvent, useFilter, useFormHelper, useGrid, useLoading };

package/dist/index.d.ts

@@ -0,0 +1,368 @@
+import React, { ReactNode, FC } from 'react';
+import * as _mui_material from '@mui/material';
+import { TableCellProps, TextFieldProps, TableRowProps, StandardTextFieldProps, SelectProps as SelectProps$1, FormControlProps, InputLabelProps, AutocompleteRenderInputParams, AutocompleteProps as AutocompleteProps$1, CheckboxProps as CheckboxProps$1, FormControlLabelProps, SwitchProps as SwitchProps$1, RadioGroupProps, ButtonProps, CircularProgressProps, SxProps, PaperProps, TableProps, TableHeadProps, TableBodyProps, ModalProps as ModalProps$1, DialogProps, AlertColor } from '@mui/material';
+import IMask$1 from 'imask';
+import { NextApiRequest, NextApiResponse } from 'next';
+import { ZodTypeDef, ZodSchema } from 'zod';
+import { AxiosInstance } from 'axios';
+
+interface ColumnTitleProps {
+    name: string;
+    label: string;
+    transformer?: (value: string | number | Date) => string;
+    sx?: TableCellProps['sx'];
+}
+interface FilterProps$1 {
+    column: string;
+    value: string;
+    transformer?: (value: string | number | Date) => string;
+}
+declare type IFilter = FilterProps$1;
+interface GridProps$1<T> {
+    columnTitles: ColumnTitleProps[];
+    defaultData: T[];
+    tableData: T[];
+    selectedFilters: FilterProps$1[];
+    setSelectedFilters(value: FilterProps$1[]): void;
+    setTableData(value: T[]): void;
+    updateFilters(value: Record<string, any>[]): void;
+    rowOptions?: number[];
+    footer?: ReactNode;
+    customButtons?: ReactNode;
+    isLoading?: boolean;
+    noFilterButtons?: boolean;
+    noPagination?: boolean;
+    noFilters?: boolean;
+    primaryKey?: string;
+}
+declare const Grid: <ObjectType>(props: React.PropsWithChildren<GridProps$1<ObjectType>>) => JSX.Element;
+
+declare function filterData<T>(filters: FilterProps$1[], defaultData: {
+    current: T[];
+}): T[];
+
+interface EditableTableCellProps extends TableCellProps {
+    name: string;
+    TextFieldProps?: TextFieldProps;
+    type?: TextFieldProps['type'];
+    fullWidth?: boolean;
+    rowData?: Record<string, any>;
+    mask?: IMask.AnyMaskedOptions;
+    bordered?: boolean;
+    rowIndex?: string | number;
+    formatCellValue?: (value: string) => string;
+    formatInputDefautvalue?: (value: string) => string;
+    onSave?: (props: OnSaveProps) => void;
+    onCancel?: () => void;
+}
+interface OnSaveProps {
+    name: string;
+    event: FocusEvent;
+    value: string;
+    data: Record<string, any>;
+}
+declare const EditableTableCell: (allProps: EditableTableCellProps) => JSX.Element;
+
+interface CustomTableRowProps extends TableRowProps {
+    striped?: boolean;
+    bordered?: boolean;
+    index?: number;
+    rowData?: Record<string, any>;
+    onSave?: (props: OnSaveProps) => void;
+    children: React.ReactNode;
+}
+declare const Tr: React.MemoExoticComponent<(props: CustomTableRowProps) => JSX.Element>;
+
+declare const Td: React.MemoExoticComponent<({ children, ...props }: TableCellProps) => JSX.Element>;
+
+interface InputProps extends StandardTextFieldProps {
+    name: string;
+    label: string;
+    shrink?: boolean;
+    withFormik?: boolean;
+}
+declare const Input: FC<InputProps>;
+
+interface InputMaskProps extends Partial<StandardTextFieldProps> {
+    name: string;
+    label: string;
+    withFormik?: boolean;
+    value?: string;
+    mask: IMask$1.AnyMaskedOptions;
+    onChangeValue?: (value: string, unmaskedValue: string) => void;
+}
+declare function InputMask({ withFormik, ...rest }: InputMaskProps): JSX.Element;
+
+interface CustomInputLabelProps extends InputLabelProps {
+    size?: 'small';
+}
+interface SelectProps extends SelectProps$1 {
+    name: string;
+    label: string;
+    defaultValue?: string;
+    withFormik?: boolean;
+    FormControlProps?: Partial<FormControlProps>;
+    InputLabelProps?: Partial<CustomInputLabelProps>;
+    helperText?: string;
+}
+declare const Select: FC<SelectProps>;
+
+declare type MuiAutocompleteBaseProps<T> = Omit<AutocompleteProps$1<T, boolean, undefined, boolean>, 'renderInput' | 'getOptionLabel'>;
+interface AutocompleteWithoutProps<T> extends MuiAutocompleteBaseProps<T> {
+    name?: never;
+    withFormik: false;
+    getOptionValue?: never;
+    label?: string;
+    getOptionLabel: (option: T) => string;
+    renderInput?: (params: AutocompleteRenderInputParams) => ReactNode;
+}
+interface AutocompleteWithFormikProps<T> extends MuiAutocompleteBaseProps<T> {
+    name: string;
+    withFormik?: true;
+    label?: string;
+    option?: {
+        label?: keyof T;
+        value?: keyof T;
+        key?: string;
+    };
+    renderInput?: (params: AutocompleteRenderInputParams) => ReactNode;
+    getOptionLabel?: (option: T) => string;
+    getOptionValue?: (option: T) => string | number;
+}
+declare type AutocompleteProps<T> = AutocompleteWithoutProps<T> | AutocompleteWithFormikProps<T>;
+declare function Autocomplete<T>({ withFormik, name, getOptionValue, ...rest }: AutocompleteProps<T>): JSX.Element;
+
+declare type CheckboxProps = CheckboxWithFormik | CheckboxWithoutFormik;
+interface CheckboxWithFormik extends CheckboxProps$1 {
+    name: string;
+    label?: string;
+    withFormik?: true;
+    FormControlLabelProps?: Partial<FormControlLabelProps>;
+}
+interface CheckboxWithoutFormik extends CheckboxProps$1 {
+    name?: never;
+    label?: string;
+    withFormik: false;
+    FormControlLabelProps?: Partial<FormControlLabelProps>;
+}
+declare const Checkbox: ({ withFormik, name, ...props }: CheckboxProps) => JSX.Element;
+
+declare type SwitchProps = SwitchWithFormik | SwitchWithoutFormik;
+interface SwitchWithFormik extends SwitchProps$1 {
+    name: string;
+    label?: string;
+    withFormik?: true;
+    FormControlLabelProps?: Partial<FormControlLabelProps>;
+}
+interface SwitchWithoutFormik extends SwitchProps$1 {
+    name?: never;
+    label?: string;
+    withFormik: false;
+    FormControlLabelProps?: Partial<FormControlLabelProps>;
+}
+declare const Switch: ({ withFormik, name, ...props }: SwitchProps) => JSX.Element;
+
+declare type RadioOptionProps = {
+    value: string | number | boolean;
+    label: string;
+};
+declare type RadioOptionsProps = RadioWithFormik | RadioWithoutFormik;
+interface RadioWithFormik extends RadioGroupProps {
+    name: string;
+    label?: string;
+    options: RadioOptionProps[];
+    withFormik?: true;
+}
+interface RadioWithoutFormik extends RadioGroupProps {
+    name?: never;
+    label?: string;
+    options: RadioOptionProps[];
+    withFormik: false;
+}
+declare const Radio: ({ name, withFormik, ...rest }: RadioOptionsProps) => JSX.Element;
+
+interface LargeButtonProps extends ButtonProps {
+    loading?: boolean;
+    children: ReactNode;
+    CircularProgressProps?: CircularProgressProps;
+}
+declare const LargeButton: ({ loading, children, CircularProgressProps, sx, ...rest }: LargeButtonProps) => JSX.Element;
+
+declare function getTabProps(index: string): {
+    id: string;
+    'aria-controls': string;
+};
+interface TabPanelProps {
+    children: React.ReactNode;
+    value: number;
+    index: number;
+}
+declare const TabPanel: (props: TabPanelProps) => JSX.Element;
+
+interface ColumnsProps {
+    label: string;
+    name?: string;
+    width?: number;
+    sx?: SxProps;
+    canSort?: boolean;
+    children?: ReactNode;
+}
+interface GridProps {
+    columns: ColumnsProps[];
+    children: ReactNode;
+    prependColumn?: ReactNode;
+    appendColumn?: ReactNode;
+    fixedColumns?: boolean;
+    sortedBy: string;
+    sortedDirection: 'asc' | 'desc';
+    dense?: boolean;
+    onSortBy: (prop: string) => void;
+    paperProps?: PaperProps;
+    tableProps?: TableProps;
+    tableHeadProps?: TableHeadProps;
+    tableBodyProps?: TableBodyProps;
+    striped?: boolean;
+    bordered?: boolean;
+    currentPage: number;
+    totalNumberOfPages: number;
+    rowsPerPageOptions: number[];
+    rowsPerPage: number;
+    onPageChange: (pageNumber: number) => void;
+    setRowsPerPage: (rows: number) => void;
+    isLoading?: boolean;
+    hideFooter?: boolean;
+}
+declare function BaseGrid({ columns, children, paperProps, tableBodyProps, tableHeadProps, tableProps, sortedDirection, sortedBy, onSortBy, dense, striped, bordered, currentPage, totalNumberOfPages, onPageChange, rowsPerPage, setRowsPerPage, rowsPerPageOptions, hideFooter, prependColumn, appendColumn, isLoading }: GridProps): JSX.Element;
+
+declare type ModalProps = {
+    open: boolean;
+    onClose: () => void;
+} & ModalProps$1;
+declare const Modal: ({ open, onClose, ...rest }: ModalProps) => JSX.Element;
+
+declare function GetInputLabel<T extends Array<Record<string, any>>, K extends T[number]['name']>(columns: T): (columnName: K) => {
+    label: any;
+    name: any;
+};
+
+interface DialogOptionsProps {
+    label: string;
+    focus?: boolean;
+    cb(label: string): void;
+}
+interface DialogCustomProps extends DialogProps {
+    open: boolean;
+    title: string;
+    body: string;
+    options: DialogOptionsProps[];
+    loading: boolean;
+}
+declare const Dialog: ({ open, title, loading, body, options, ...rest }: DialogCustomProps) => JSX.Element;
+
+declare class HttpError extends Error {
+    status: number;
+    constructor(status: number, message: any);
+}
+
+declare type PossibleMethods = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+declare type HandlerProps = (req: NextApiRequest & {
+    user?: number;
+}, res: NextApiResponse) => Promise<any>;
+declare type MethodProps = Partial<Record<PossibleMethods, HandlerProps>>;
+declare type MiddlewaresProps = ((handler: HandlerProps) => HandlerProps)[];
+declare type ConstructorProps = {
+    middlewares?: MiddlewaresProps;
+    onFinally: () => void;
+};
+declare class ApiHelper {
+    middlewares: MiddlewaresProps;
+    private onFinally;
+    constructor(props?: ConstructorProps);
+    setMiddlewares(middlewares: any[]): this;
+    createMethods(methods: MethodProps): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
+    static parserErrorWrapper<Output, Def extends ZodTypeDef, Input>(body: Record<string, any>, parser: ZodSchema<Output, Def, Input>): Output;
+    static parseQueyFilters<T extends Record<string, any>>(filters: T): T;
+    static create({ onFinally }: {
+        onFinally: any;
+    }): ApiHelper;
+}
+
+declare type Methods = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options';
+declare type HandleProps = {
+    name: `${Methods}:${string}`;
+};
+declare type UseFormHelperProps = {
+    formatErrorMessage: (message: any) => string;
+    api: AxiosInstance;
+};
+declare function useFormHelper({ formatErrorMessage, api }: UseFormHelperProps): {
+    onSubmitWrapper: <T extends Record<string, any>>(fn: (fields: T, methods: any) => Promise<void>, { name }: HandleProps) => (fields: T, methods: any) => Promise<void>;
+    onRequestWrapper: <F extends (...args: Parameters<F>) => R, R>(fn: F, { name }: HandleProps) => (...params: Parameters<F>) => Promise<R>;
+    isLoading: (prop: string) => boolean;
+    setLoading: (prop: string, remove?: boolean) => void;
+    createAlert(message: string, type: _mui_material.AlertColor): void;
+};
+
+declare type FilterCompareType = 'gte' | 'lte' | 'lt' | 'gt' | 'equal' | 'in' | 'notEqual' | 'notIn';
+declare type FilterProps = {
+    id?: string;
+    prop: string;
+    value: unknown;
+    compareType: FilterCompareType;
+};
+declare function useFilter(): {
+    filters: FilterProps[];
+    filterBy: (newFilter: FilterProps) => void;
+    removeFilter: (prop: string, isId?: boolean) => void;
+    createFilter: typeof createFilter;
+    clearAllFilters: () => void;
+};
+declare function createFilter<T extends Record<string, any>>(filters: FilterProps[]): {
+    apply: (item: T) => boolean;
+};
+
+interface SearchOptions {
+    caseSensitive?: boolean;
+    exact?: boolean;
+    value: string;
+}
+interface UseGridProps {
+    columns: ColumnsProps[];
+    filters?: FilterProps[];
+    rowsPerPageOptions?: number[];
+    search?: SearchOptions;
+}
+declare function useGrid<T extends Record<string, any>>({ columns, filters, search, rowsPerPageOptions }: UseGridProps): {
+    data: T[];
+    set: (data: T[]) => void;
+    onSortBy: (prop: string) => void;
+    sortedBy: string;
+    defaultData: T[];
+    sortedDirection: "desc" | "asc";
+    columns: ColumnsProps[];
+    currentPage: number;
+    totalNumberOfPages: number;
+    onPageChange: (pageNumber: number) => void;
+    setRowsPerPage: (rows: number) => void;
+    rowsPerPageOptions: number[];
+    rowsPerPage: number;
+    setSort: (prop: string, direction: 'desc' | 'asc') => void;
+};
+
+declare function useEvent(event: keyof WindowEventMap, handler: (ev: any) => void, passive?: boolean): void;
+
+declare function useLoading<T = string>(): {
+    isLoading: (prop: T) => boolean;
+    setLoading: (prop: T, remove?: boolean) => void;
+};
+
+declare const useAlert: () => {
+    createAlert(message: string, type: _mui_material.AlertColor): void;
+};
+
+declare type AlertContextProps = {
+    createAlert(message: string, type: AlertColor): void;
+};
+declare const AlertContext: React.Context<AlertContextProps>;
+
+export { AlertContext, ApiHelper, Autocomplete, BaseGrid, Checkbox, type ColumnTitleProps, type ColumnsProps, Dialog, EditableTableCell, type FilterCompareType, type FilterProps, GetInputLabel, Grid, HttpError, type IFilter, Input, InputMask, LargeButton, Modal, Radio, Select, Switch, TabPanel, type TabPanelProps, Td, Tr, createFilter, filterData, getTabProps, useAlert, useEvent, useFilter, useFormHelper, useGrid, useLoading };