@bluemarble/bm-components 2.4.1 → 2.4.3

package/dist/index.d.cts

@@ -1,3 +1,4 @@
+import * as cookie from 'cookie';
 import * as React from 'react';
 import React__default, { PropsWithChildren, ReactNode, FC, Provider } from 'react';
 import * as _mui_material from '@mui/material';
@@ -5,25 +6,72 @@ import { TableCellProps, TableCell, TextFieldProps, StandardTextFieldProps, Sele
 import * as _mui_material_OverridableComponent from '@mui/material/OverridableComponent';
 import { FactoryOpts } from 'imask';
 import { IconType } from 'react-icons';
-import * as next from 'next';
-import { NextApiRequest, NextApiResponse, GetServerSidePropsContext } from 'next';
-import { ZodSchema } from 'zod';
 import { AxiosInstance } from 'axios';
-import * as cookie from 'cookie';
-import * as express from 'express';
+import { ZodSchema } from 'zod';
+
+interface NookiesRequest {
+    headers?: {
+        cookie?: string;
+    };
+}
+interface NookiesResponse {
+    finished?: boolean;
+    getHeader(name: string): string | string[] | number | undefined;
+    setHeader(name: string, value: string | readonly string[]): any;
+}
+
+/**
+ * Parses cookies.
+ *
+ * @param ctx Object with a `req` property, null or undefined.
+ * @param options Options that we pass down to `cookie` library.
+ */
+declare function parseCookies(ctx?: {
+    req: NookiesRequest;
+} | null | undefined, options?: cookie.ParseOptions): cookie.Cookies;
+/**
+ * Sets a cookie.
+ *
+ * @param ctx Object with a `res` property, null or undefined.
+ * @param name The name of your cookie.
+ * @param value The value of your cookie.
+ * @param options Options that we pass down to `cookie` library.
+ */
+declare function setCookie(ctx: {
+    res: NookiesResponse;
+} | null | undefined, name: string, value: string, options?: cookie.SerializeOptions): {};
+/**
+ * Destroys a cookie with a particular name.
+ *
+ * @param ctx Object with a `res` property, null or undefined.
+ * @param name Cookie name.
+ * @param options Options that we pass down to `cookie` library.
+ */
+declare function destroyCookie(ctx: {
+    res: NookiesResponse;
+} | null | undefined, name: string, options?: cookie.SerializeOptions): {};
+declare const nookies: {
+    set: typeof setCookie;
+    get: typeof parseCookies;
+    destroy: typeof destroyCookie;
+};
 
+/** @deprecated Use {@link ColumnsProps} from `BaseGrid` instead. */
 interface ColumnTitleProps {
     name: string;
     label: string;
     transformer?: (value: string | number | Date) => string;
     sx?: TableCellProps['sx'];
 }
+/** @deprecated Use {@link FilterProps} from `useFilter` instead. */
 interface FilterProps$1 {
     column: string;
     value: string;
     transformer?: (value: string | number | Date) => string;
 }
+/** @deprecated Use {@link FilterProps} from `useFilter` instead. */
 type IFilter = FilterProps$1;
+/** @deprecated */
 interface GridProps$1<T> {
     columnTitles: ColumnTitleProps[];
     defaultData: T[];
@@ -41,14 +89,22 @@ interface GridProps$1<T> {
     noFilters?: boolean;
     primaryKey?: string;
 }
+/**
+ * @deprecated Use {@link BaseGrid} with the {@link useGrid} or {@link useAsyncGrid} hook instead.
+ * `BaseGrid` separates rendering from state management, eliminating the need to pass
+ * `tableData`, `setTableData`, `selectedFilters`, and `updateFilters` as props.
+ */
 declare const Grid: <ObjectType>(props: PropsWithChildren<GridProps$1<ObjectType>>) => React__default.JSX.Element;
 
+/** @deprecated Use the `useFilter` hook instead. */
 declare function filterData<T>(filters: FilterProps$1[], defaultData: {
     current: T[];
 }): T[];
 
+/** @deprecated Use `TableRow` from `@mui/material` directly. */
 declare const Tr: _mui_material_OverridableComponent.OverridableComponent<_mui_material.TableRowTypeMap<{}, "tr">>;
 
+/** @deprecated Use `TableCell` from `@mui/material` directly. */
 declare const Td: typeof TableCell;
 
 interface EditableTableCellProps extends TableCellProps {
@@ -103,7 +159,7 @@ type SelectProps<T> = MuiSelectPropsWithouVariant<T> & {
     InputLabelProps?: Partial<CustomInputLabelProps>;
     helperText?: string;
 };
-declare function Select<T>({ withFormik, ...rest }: SelectProps<T>): React__default.JSX.Element;
+declare function Select<T>({ withFormik, helperText, ...rest }: SelectProps<T>): React__default.JSX.Element;
 
 type MuiAutocompleteBaseProps<T> = Omit<AutocompleteProps$1<T, boolean, undefined, boolean>, 'renderInput' | 'getOptionLabel'>;
 interface AutocompleteWithoutProps<T> extends MuiAutocompleteBaseProps<T> {
@@ -138,12 +194,14 @@ type CheckboxProps = CheckboxWithFormik | CheckboxWithoutFormik;
 interface CheckboxWithFormik extends CheckboxProps$1 {
     name: string;
     label?: string;
+    helperText?: string;
     withFormik?: true;
     FormControlLabelProps?: Partial<FormControlLabelProps>;
 }
 interface CheckboxWithoutFormik extends CheckboxProps$1 {
     name?: never;
     label?: string;
+    helperText?: string;
     withFormik: false;
     FormControlLabelProps?: Partial<FormControlLabelProps>;
 }
@@ -153,12 +211,14 @@ type SwitchProps = SwitchWithFormik | SwitchWithoutFormik;
 interface SwitchWithFormik extends SwitchProps$1 {
     name: string;
     label?: string;
+    helperText?: string;
     withFormik?: true;
     FormControlLabelProps?: Partial<FormControlLabelProps>;
 }
 interface SwitchWithoutFormik extends SwitchProps$1 {
     name?: never;
     label?: string;
+    helperText?: string;
     withFormik: false;
     FormControlLabelProps?: Partial<FormControlLabelProps>;
 }
@@ -173,12 +233,14 @@ interface RadioWithFormik extends RadioGroupProps {
     name: string;
     label?: string;
     options: RadioOptionProps[];
+    helperText?: string;
     withFormik?: true;
 }
 interface RadioWithoutFormik extends RadioGroupProps {
     name?: never;
     label?: string;
     options: RadioOptionProps[];
+    helperText?: string;
     withFormik: false;
 }
 declare const Radio: ({ name, withFormik, ...rest }: RadioOptionsProps) => React__default.JSX.Element;
@@ -314,6 +376,9 @@ type TModalProps = {
     children: React__default.ReactNode;
     BoxProps?: BoxProps;
 } & Omit<ModalProps, 'children'>;
+/**
+ * @deprecated Use `Dialog` or `BaseDialog` instead. `Modal` will be removed in a future release.
+ */
 declare const Modal: ({ open, onClose, BoxProps, ...rest }: TModalProps) => React__default.JSX.Element;
 
 declare function GetInputLabel<T extends Array<Record<string, any>>, K extends T[number]['name']>(columns: T): (columnName: K) => {
@@ -424,6 +489,42 @@ declare const BaseDialog: {
     Body: (props: IBaseDialogBodyProps) => React__default.JSX.Element;
 };
 
+type FormHelperContextProps = {
+    formatErrorMessage: (message: any) => string;
+    api: AxiosInstance;
+};
+declare const FormHelperContext: React__default.Context<FormHelperContextProps>;
+type FormHelperProviderProps = {
+    formatErrorMessage: (message: any) => string;
+    children: ReactNode;
+    api: AxiosInstance;
+};
+declare const FormHelperProvider: ({ formatErrorMessage, api, children }: FormHelperProviderProps) => React__default.JSX.Element;
+
+type AlertContextProps = {
+    createAlert(message: string, type: AlertColor): void;
+};
+declare const AlertContext: React__default.Context<AlertContextProps>;
+type AlertProviderProps = {
+    children: ReactNode;
+};
+declare const AlertProvider: ({ children }: AlertProviderProps) => React__default.JSX.Element;
+
+type AuthenticateStatus = 'autenticated' | 'unauthenticated' | 'loading';
+interface AuthContextProps<T> {
+    user?: T;
+    status: AuthenticateStatus;
+    signIn(credentials: Record<string, any>): Promise<boolean>;
+    signOut: () => Promise<void>;
+}
+declare function createAuthContext<T>(): React__default.Context<AuthContextProps<T>>;
+declare function CreateAuthProvider<T>({ api, children, sessionTokenName, Provider }: {
+    Provider: Provider<AuthContextProps<T>>;
+    children: ReactNode;
+    api: AxiosInstance;
+    sessionTokenName: string;
+}): React__default.JSX.Element;
+
 declare class HttpError extends Error {
     status: number;
     constructor(status: number, message: any);
@@ -433,18 +534,45 @@ declare class DomainError extends Error {
     constructor(message: any);
 }
 
+interface HelperRequest {
+    url?: string;
+    method?: string;
+    headers: {
+        authorization?: string;
+        cookie?: string;
+        [key: string]: string | string[] | undefined;
+    };
+    cookies: Record<string, string>;
+    body?: any;
+    query?: Record<string, string | string[] | undefined>;
+    user?: any;
+}
+interface HelperResponse {
+    finished?: boolean;
+    status(code: number): HelperResponse;
+    json(data: any): any;
+    send(data: any): any;
+    end(data?: any): any;
+    getHeader(name: string): string | string[] | number | undefined;
+    setHeader(name: string, value: string | readonly string[]): any;
+}
+interface ServerSidePropsContext {
+    query: Record<string, string | string[] | undefined>;
+    res: HelperResponse;
+}
+
 type PossibleMethods = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'ALL';
-type NextHandlerApiRequest<T = string> = NextApiRequest & {
+type NextHandlerApiRequest<T = string> = HelperRequest & {
     user?: T;
 };
-type HandlerProps<UserKeyType> = (req: NextHandlerApiRequest<UserKeyType>, res: NextApiResponse, options?: TApiOptions) => Promise<any>;
+type HandlerProps<UserKeyType> = (req: NextHandlerApiRequest<UserKeyType>, res: HelperResponse, options?: TApiOptions) => Promise<any>;
 type MethodProps<T> = Partial<Record<PossibleMethods, HandlerProps<T>>>;
 type MiddlewaresProps<T> = ((handler: HandlerProps<T>, options?: TApiOptions) => HandlerProps<T>)[];
 type ConstructorProps$1<T> = {
     public?: boolean;
     middlewares?: MiddlewaresProps<T>;
-    onFinally?: (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
-    onError?: (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
+    onFinally?: (req: HelperRequest, res: HelperResponse) => Promise<void>;
+    onError?: (req: HelperRequest, res: HelperResponse) => Promise<void>;
 };
 type TApiOptions = {
     public?: boolean;
@@ -456,9 +584,9 @@ declare class ApiHelper<T> {
     private onFinally;
     private onError;
     constructor(props?: ConstructorProps$1<T>);
-    createMethods(methods: MethodProps<T>): (req: NextApiRequest, res: NextApiResponse) => Promise<any>;
+    createMethods(methods: MethodProps<T>): (req: HelperRequest, res: HelperResponse) => Promise<any>;
     private buildFactory;
-    static build(factory: (req: NextHandlerApiRequest, res: NextApiResponse) => MethodProps<string>, options?: TApiOptions): (req: NextHandlerApiRequest, res: NextApiResponse) => Promise<any>;
+    static build(factory: (req: NextHandlerApiRequest, res: HelperResponse) => MethodProps<string>, options?: TApiOptions): (req: NextHandlerApiRequest, res: HelperResponse) => Promise<any>;
     static parse<Output, Def>(body: Record<string, any>, parser: ZodSchema<Output, Def>): Output;
     /** @deprecated Use {@link ApiHelper.parser} instead. */
     static parserErrorWrapper: typeof ApiHelper.parse;
@@ -468,23 +596,11 @@ declare class ApiHelper<T> {
     }): ApiHelper<unknown>;
 }
 
-type Methods = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options';
-type HandleProps = {
-    name: `${Methods}:${string}`;
-};
-declare function useFormHelper(): {
-    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;
-};
-
-type NextApiRequestWithAuth = NextApiRequest & {
+type AuthRequest = HelperRequest & {
     user?: any;
 };
 interface OnLoginSuccessResponse {
-    status: 'sucess';
+    status: 'success';
     userId: string;
 }
 interface OnLoginFailedResponse {
@@ -525,7 +641,7 @@ declare class AuthHelper {
     onCreateRefreshToken: ConstructorProps['onCreateRefreshToken'];
     onGetUserData: ConstructorProps['onGetUserData'];
     constructor({ cookies, oauth, tokenExpTimeInSeconds, onLogin, onValidateRefreshToken, onInvalidateRefreshToken, onCreateRefreshToken, onGetUserData }: ConstructorProps);
-    handler(req: NextApiRequestWithAuth, res: NextApiResponse): Promise<void>;
+    handler(req: AuthRequest, res: HelperResponse): Promise<any>;
     oauthSignInCallback(code: string): Promise<{
         decodedToken: {
             upn: string;
@@ -538,7 +654,7 @@ declare class AuthHelper {
     createOauthCallbackGetServerSideProps({ onSuccessDestination, onFailedDestination }: {
         onSuccessDestination: string;
         onFailedDestination?: string;
-    }): (ctx: GetServerSidePropsContext) => Promise<{
+    }): (ctx: ServerSidePropsContext) => Promise<{
         redirect: {
             permanent: boolean;
             destination: string;
@@ -551,7 +667,7 @@ declare class AuthHelper {
         redirect?: undefined;
     }>;
     private generateJwtAndRefreshToken;
-    invalidateCookies: (res: NextApiResponse) => NextApiResponse;
+    invalidateCookies: (res: HelperResponse) => any;
 }
 
 type SortedDirectionProps = 'asc' | 'desc';
@@ -620,82 +736,16 @@ declare const useAlert: () => {
     createAlert(message: string, type: _mui_material.AlertColor): void;
 };
 
-type FormHelperContextProps = {
-    formatErrorMessage: (message: any) => string;
-    api: AxiosInstance;
-};
-declare const FormHelperContext: React__default.Context<FormHelperContextProps>;
-type FormHelperProviderProps = {
-    formatErrorMessage: (message: any) => string;
-    children: ReactNode;
-    api: AxiosInstance;
-};
-declare const FormHelperProvider: ({ formatErrorMessage, api, children }: FormHelperProviderProps) => React__default.JSX.Element;
-
-type AlertContextProps = {
-    createAlert(message: string, type: AlertColor): void;
-};
-declare const AlertContext: React__default.Context<AlertContextProps>;
-type AlertProviderProps = {
-    children: ReactNode;
+type Methods = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'options';
+type HandleProps = {
+    name: `${Methods}:${string}`;
 };
-declare const AlertProvider: ({ children }: AlertProviderProps) => React__default.JSX.Element;
-
-type AuthenticateStatus = 'autenticated' | 'unauthenticated' | 'loading';
-interface AuthContextProps<T> {
-    user?: T;
-    status: AuthenticateStatus;
-    signIn(credentials: Record<string, any>): Promise<boolean>;
-    signOut: () => Promise<void>;
-}
-declare function createAuthContext<T>(): React__default.Context<AuthContextProps<T>>;
-declare function CreateAuthProvider<T>({ api, children, sessionTokenName, Provider }: {
-    Provider: Provider<AuthContextProps<T>>;
-    children: ReactNode;
-    api: AxiosInstance;
-    sessionTokenName: string;
-}): React__default.JSX.Element;
-
-/**
- * Parses cookies.
- *
- * @param ctx NextJS page or API context, express context, null or undefined.
- * @param options Options that we pass down to `cookie` library.
- */
-declare function parseCookies(ctx?: Pick<next.NextPageContext, 'req'> | {
-    req: next.NextApiRequest;
-} | {
-    req: express.Request;
-} | null | undefined, options?: cookie.ParseOptions): cookie.Cookies;
-/**
- * Sets a cookie.
- *
- * @param ctx NextJS page or API context, express context, null or undefined.
- * @param name The name of your cookie.
- * @param value The value of your cookie.
- * @param options Options that we pass down to `cookie` library.
- */
-declare function setCookie(ctx: Pick<next.NextPageContext, 'res'> | {
-    res: next.NextApiResponse;
-} | {
-    res: express.Response;
-} | null | undefined, name: string, value: string, options?: cookie.SerializeOptions): {};
-/**
- * Destroys a cookie with a particular name.
- *
- * @param ctx NextJS page or API context, express context, null or undefined.
- * @param name Cookie name.
- * @param options Options that we pass down to `cookie` library.
- */
-declare function destroyCookie(ctx: Pick<next.NextPageContext, 'res'> | {
-    res: next.NextApiResponse;
-} | {
-    res: express.Response;
-} | null | undefined, name: string, options?: cookie.SerializeOptions): {};
-declare const nookies: {
-    set: typeof setCookie;
-    get: typeof parseCookies;
-    destroy: typeof destroyCookie;
+declare function useFormHelper(): {
+    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;
 };
 
-export { AlertContext, AlertProvider, ApiHelper, type AuthContextProps, AuthHelper, Autocomplete, BaseDialog, BaseDialogBody, BaseDialogContainer, BaseDialogCreate, BaseDialogTrigger, BaseGrid, BaseGridAutoRows, Checkbox, type ColumnTitleProps, type ColumnsProps, CreateAuthProvider, Dialog, DialogConfirm, DomainError, EditableTableCell, type FilterCompareType, type FilterProps, FormHelperContext, FormHelperProvider, GetInputLabel, Grid, type HandlerProps, HttpError, type IBaseDialogBodyProps, type IBaseDialogContainerProps, type IBaseDialogTriggerProps, type IDialogConfirmProps, type IFilter, Input, InputMask, LargeButton, type MethodProps, Modal, Radio, Select, type SortedByProps$1 as SortedByProps, Switch, type TApiOptions, type TUseDialogConfirm, TabPanel, type TabPanelProps, Td, Tr, UseDialogConfirm, createAuthContext, createFilter, destroyCookie, filterData, getTabProps, nookies, parseCookies, setCookie, useAlert, useAsyncGrid, useBaseDialog, useBaseDialogInstance, useEvent, useFilter, useFormHelper, useGrid, useLoading };
+export { AlertContext, AlertProvider, ApiHelper, type AuthContextProps, AuthHelper, Autocomplete, BaseDialog, BaseDialogBody, BaseDialogContainer, BaseDialogCreate, BaseDialogTrigger, BaseGrid, BaseGridAutoRows, Checkbox, type ColumnTitleProps, type ColumnsProps, CreateAuthProvider, Dialog, DialogConfirm, DomainError, EditableTableCell, type FilterCompareType, type FilterProps, FormHelperContext, FormHelperProvider, GetInputLabel, Grid, type HandlerProps, type HelperRequest, type HelperResponse, HttpError, type IBaseDialogBodyProps, type IBaseDialogContainerProps, type IBaseDialogTriggerProps, type IDialogConfirmProps, type IFilter, Input, InputMask, LargeButton, type MethodProps, type MiddlewaresProps, Modal, type NextHandlerApiRequest, type NookiesRequest, type NookiesResponse, Radio, Select, type ServerSidePropsContext, type SortedByProps$1 as SortedByProps, Switch, type TApiOptions, type TUseDialogConfirm, TabPanel, type TabPanelProps, Td, Tr, UseDialogConfirm, createAuthContext, createFilter, destroyCookie, filterData, getTabProps, nookies, parseCookies, setCookie, useAlert, useAsyncGrid, useBaseDialog, useBaseDialogInstance, useEvent, useFilter, useFormHelper, useGrid, useLoading };