@bluemarble/bm-components 2.4.7 → 2.5.0

package/dist/index.d.cts

@@ -535,20 +535,29 @@ declare class DomainError extends Error {
     constructor(message: any);
 }
 
-interface HelperRequest {
-    url?: string;
+interface BaseRequest {
     method?: string;
+}
+interface BaseResponse {
+    status(code: number): {
+        json(data: any): any;
+        send(data: any): any;
+        end(data?: any): any;
+    };
+}
+interface HelperRequest extends BaseRequest {
+    url?: string;
     headers: {
         authorization?: string;
         cookie?: string;
         [key: string]: string | string[] | undefined;
     };
-    cookies: Record<string, string>;
+    cookies: Partial<Record<string, string>>;
     body?: any;
-    query: Record<string, string | string[]>;
+    query: Partial<Record<string, string | string[]>>;
     user?: any;
 }
-interface HelperResponse {
+interface HelperResponse extends BaseResponse {
     finished?: boolean;
     status(code: number): HelperResponse;
     json(data: any): any;
@@ -563,39 +572,53 @@ interface ServerSidePropsContext {
 }
 
 type PossibleMethods = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'ALL';
-type NextHandlerApiRequest<T = string> = HelperRequest & {
+type NextHandlerApiRequest<T = string, Req extends BaseRequest = HelperRequest> = Req & {
     user?: T;
 };
-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> = {
+type HandlerProps<UserKeyType, Req extends BaseRequest = HelperRequest, Res extends BaseResponse = HelperResponse> = (req: NextHandlerApiRequest<UserKeyType, Req>, res: Res, options?: TApiOptions<Req, Res>) => Promise<any>;
+type MethodProps<T, Req extends BaseRequest = HelperRequest, Res extends BaseResponse = HelperResponse> = Partial<Record<PossibleMethods, HandlerProps<T, Req, Res>>>;
+type MiddlewaresProps<T, Req extends BaseRequest = HelperRequest, Res extends BaseResponse = HelperResponse> = ((handler: HandlerProps<T, Req, Res>, options?: TApiOptions<Req, Res>) => HandlerProps<T, Req, Res>)[];
+type TApiHelperProps<T, Req extends BaseRequest = HelperRequest, Res extends BaseResponse = HelperResponse> = {
     public?: boolean;
-    middlewares?: MiddlewaresProps<T>;
-    onFinally?: (req: HelperRequest, res: HelperResponse) => Promise<void>;
-    onError?: (req: HelperRequest, res: HelperResponse) => Promise<void>;
+    middlewares?: MiddlewaresProps<T, Req, Res>;
+    onFinally?: (req: Req, res: Res) => Promise<void>;
+    onError?: (req: Req, res: Res) => Promise<void>;
 };
-type TApiOptions = {
+type TApiOptions<Req extends BaseRequest = HelperRequest, Res extends BaseResponse = HelperResponse> = {
     public?: boolean;
-    middlewares?: MiddlewaresProps<any>;
+    middlewares?: MiddlewaresProps<any, Req, Res>;
 };
-declare class ApiHelper<T> {
+declare class ApiHelper<T = string, Req extends BaseRequest = HelperRequest, Res extends BaseResponse = HelperResponse> {
     private middlewares;
     private public;
     private onFinally;
     private onError;
-    constructor(props?: ConstructorProps$1<T>);
-    createMethods(methods: MethodProps<T>): (req: HelperRequest, res: HelperResponse) => Promise<any>;
+    constructor(props?: TApiHelperProps<T, Req, Res>);
+    createMethods(methods: MethodProps<T, Req, Res>): (req: NextHandlerApiRequest<T, Req>, res: Res) => Promise<any>;
     private buildFactory;
-    static build(factory: (req: NextHandlerApiRequest, res: HelperResponse) => MethodProps<string>, options?: TApiOptions): (req: NextHandlerApiRequest, res: HelperResponse) => Promise<any>;
+    static build<T = string, Req extends BaseRequest = HelperRequest, Res extends BaseResponse = HelperResponse>(factory: (req: NextHandlerApiRequest<T, Req>, res: Res) => MethodProps<T, Req, Res>, options?: TApiOptions<Req, Res>): (req: NextHandlerApiRequest<T, Req>, res: Res) => Promise<any>;
     static parse<Output, Def>(body: Record<string, any>, parser: ZodSchema<Output, Def>): Output;
-    /** @deprecated Use {@link ApiHelper.parser} instead. */
+    /** @deprecated Use {@link ApiHelper.parse} instead. */
     static parserErrorWrapper: typeof ApiHelper.parse;
     /** @deprecated Use {@Link ApiHelper.build} instead. */
     static create({ onFinally }: {
         onFinally: any;
-    }): ApiHelper<unknown>;
+    }): ApiHelper<string, HelperRequest, HelperResponse>;
 }
+declare function createApiHelper<Req extends BaseRequest, Res extends BaseResponse, T = string>(defaults?: {
+    public?: boolean;
+    middlewares?: MiddlewaresProps<T, Req, Res>;
+}): {
+    new (props?: TApiHelperProps<T, Req, Res>): {
+        /** @internal instância subjacente; não faz parte da API pública. */
+        readonly helper: ApiHelper<T, Req, Res>;
+        createMethods(methods: MethodProps<T, Req, Res>): (req: NextHandlerApiRequest<T, Req>, res: Res) => Promise<any>;
+    };
+    build(factory: (req: NextHandlerApiRequest<T, Req>, res: Res) => MethodProps<T, Req, Res>, options?: TApiOptions<Req, Res>): (req: NextHandlerApiRequest<T, Req>, res: Res) => Promise<any>;
+    parse: typeof ApiHelper.parse;
+    /** @deprecated Use `parse` instead. */
+    parserErrorWrapper: typeof ApiHelper.parse;
+};
 
 type AuthRequest = HelperRequest & {
     user?: any;
@@ -749,4 +772,4 @@ declare function useFormHelper(): {
     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, 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 };
+export { AlertContext, AlertProvider, ApiHelper, type AuthContextProps, AuthHelper, Autocomplete, BaseDialog, BaseDialogBody, BaseDialogContainer, BaseDialogCreate, BaseDialogTrigger, BaseGrid, BaseGridAutoRows, type BaseRequest, type BaseResponse, 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 TApiHelperProps, type TApiOptions, type TUseDialogConfirm, TabPanel, type TabPanelProps, Td, Tr, UseDialogConfirm, createApiHelper, createAuthContext, createFilter, destroyCookie, filterData, getTabProps, nookies, parseCookies, setCookie, useAlert, useAsyncGrid, useBaseDialog, useBaseDialogInstance, useEvent, useFilter, useFormHelper, useGrid, useLoading };

package/dist/index.d.ts

@@ -535,20 +535,29 @@ declare class DomainError extends Error {
     constructor(message: any);
 }
 
-interface HelperRequest {
-    url?: string;
+interface BaseRequest {
     method?: string;
+}
+interface BaseResponse {
+    status(code: number): {
+        json(data: any): any;
+        send(data: any): any;
+        end(data?: any): any;
+    };
+}
+interface HelperRequest extends BaseRequest {
+    url?: string;
     headers: {
         authorization?: string;
         cookie?: string;
         [key: string]: string | string[] | undefined;
     };
-    cookies: Record<string, string>;
+    cookies: Partial<Record<string, string>>;
     body?: any;
-    query: Record<string, string | string[]>;
+    query: Partial<Record<string, string | string[]>>;
     user?: any;
 }
-interface HelperResponse {
+interface HelperResponse extends BaseResponse {
     finished?: boolean;
     status(code: number): HelperResponse;
     json(data: any): any;
@@ -563,39 +572,53 @@ interface ServerSidePropsContext {
 }
 
 type PossibleMethods = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'ALL';
-type NextHandlerApiRequest<T = string> = HelperRequest & {
+type NextHandlerApiRequest<T = string, Req extends BaseRequest = HelperRequest> = Req & {
     user?: T;
 };
-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> = {
+type HandlerProps<UserKeyType, Req extends BaseRequest = HelperRequest, Res extends BaseResponse = HelperResponse> = (req: NextHandlerApiRequest<UserKeyType, Req>, res: Res, options?: TApiOptions<Req, Res>) => Promise<any>;
+type MethodProps<T, Req extends BaseRequest = HelperRequest, Res extends BaseResponse = HelperResponse> = Partial<Record<PossibleMethods, HandlerProps<T, Req, Res>>>;
+type MiddlewaresProps<T, Req extends BaseRequest = HelperRequest, Res extends BaseResponse = HelperResponse> = ((handler: HandlerProps<T, Req, Res>, options?: TApiOptions<Req, Res>) => HandlerProps<T, Req, Res>)[];
+type TApiHelperProps<T, Req extends BaseRequest = HelperRequest, Res extends BaseResponse = HelperResponse> = {
     public?: boolean;
-    middlewares?: MiddlewaresProps<T>;
-    onFinally?: (req: HelperRequest, res: HelperResponse) => Promise<void>;
-    onError?: (req: HelperRequest, res: HelperResponse) => Promise<void>;
+    middlewares?: MiddlewaresProps<T, Req, Res>;
+    onFinally?: (req: Req, res: Res) => Promise<void>;
+    onError?: (req: Req, res: Res) => Promise<void>;
 };
-type TApiOptions = {
+type TApiOptions<Req extends BaseRequest = HelperRequest, Res extends BaseResponse = HelperResponse> = {
     public?: boolean;
-    middlewares?: MiddlewaresProps<any>;
+    middlewares?: MiddlewaresProps<any, Req, Res>;
 };
-declare class ApiHelper<T> {
+declare class ApiHelper<T = string, Req extends BaseRequest = HelperRequest, Res extends BaseResponse = HelperResponse> {
     private middlewares;
     private public;
     private onFinally;
     private onError;
-    constructor(props?: ConstructorProps$1<T>);
-    createMethods(methods: MethodProps<T>): (req: HelperRequest, res: HelperResponse) => Promise<any>;
+    constructor(props?: TApiHelperProps<T, Req, Res>);
+    createMethods(methods: MethodProps<T, Req, Res>): (req: NextHandlerApiRequest<T, Req>, res: Res) => Promise<any>;
     private buildFactory;
-    static build(factory: (req: NextHandlerApiRequest, res: HelperResponse) => MethodProps<string>, options?: TApiOptions): (req: NextHandlerApiRequest, res: HelperResponse) => Promise<any>;
+    static build<T = string, Req extends BaseRequest = HelperRequest, Res extends BaseResponse = HelperResponse>(factory: (req: NextHandlerApiRequest<T, Req>, res: Res) => MethodProps<T, Req, Res>, options?: TApiOptions<Req, Res>): (req: NextHandlerApiRequest<T, Req>, res: Res) => Promise<any>;
     static parse<Output, Def>(body: Record<string, any>, parser: ZodSchema<Output, Def>): Output;
-    /** @deprecated Use {@link ApiHelper.parser} instead. */
+    /** @deprecated Use {@link ApiHelper.parse} instead. */
     static parserErrorWrapper: typeof ApiHelper.parse;
     /** @deprecated Use {@Link ApiHelper.build} instead. */
     static create({ onFinally }: {
         onFinally: any;
-    }): ApiHelper<unknown>;
+    }): ApiHelper<string, HelperRequest, HelperResponse>;
 }
+declare function createApiHelper<Req extends BaseRequest, Res extends BaseResponse, T = string>(defaults?: {
+    public?: boolean;
+    middlewares?: MiddlewaresProps<T, Req, Res>;
+}): {
+    new (props?: TApiHelperProps<T, Req, Res>): {
+        /** @internal instância subjacente; não faz parte da API pública. */
+        readonly helper: ApiHelper<T, Req, Res>;
+        createMethods(methods: MethodProps<T, Req, Res>): (req: NextHandlerApiRequest<T, Req>, res: Res) => Promise<any>;
+    };
+    build(factory: (req: NextHandlerApiRequest<T, Req>, res: Res) => MethodProps<T, Req, Res>, options?: TApiOptions<Req, Res>): (req: NextHandlerApiRequest<T, Req>, res: Res) => Promise<any>;
+    parse: typeof ApiHelper.parse;
+    /** @deprecated Use `parse` instead. */
+    parserErrorWrapper: typeof ApiHelper.parse;
+};
 
 type AuthRequest = HelperRequest & {
     user?: any;
@@ -749,4 +772,4 @@ declare function useFormHelper(): {
     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, 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 };
+export { AlertContext, AlertProvider, ApiHelper, type AuthContextProps, AuthHelper, Autocomplete, BaseDialog, BaseDialogBody, BaseDialogContainer, BaseDialogCreate, BaseDialogTrigger, BaseGrid, BaseGridAutoRows, type BaseRequest, type BaseResponse, 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 TApiHelperProps, type TApiOptions, type TUseDialogConfirm, TabPanel, type TabPanelProps, Td, Tr, UseDialogConfirm, createApiHelper, createAuthContext, createFilter, destroyCookie, filterData, getTabProps, nookies, parseCookies, setCookie, useAlert, useAsyncGrid, useBaseDialog, useBaseDialogInstance, useEvent, useFilter, useFormHelper, useGrid, useLoading };

package/dist/index.js

@@ -5421,7 +5421,7 @@ var _ApiHelper = class _ApiHelper {
   static build(factory, options) {
     const helper = new _ApiHelper({
       ...options
-    }).buildFactory(factory);
+    })["buildFactory"](factory);
     return helper;
   }
   static parse(body, parser) {
@@ -5443,9 +5443,35 @@ var _ApiHelper = class _ApiHelper {
     });
   }
 };
-/** @deprecated Use {@link ApiHelper.parser} instead. */
+/** @deprecated Use {@link ApiHelper.parse} instead. */
 _ApiHelper.parserErrorWrapper = _ApiHelper.parse;
 var ApiHelper = _ApiHelper;
+function createApiHelper(defaults) {
+  var _a;
+  const mergeOptions = (options) => ({
+    ...defaults,
+    ...options,
+    middlewares: [
+      ...defaults?.middlewares ?? [],
+      ...options?.middlewares ?? []
+    ]
+  });
+  return _a = class {
+    constructor(props) {
+      this.helper = new ApiHelper({
+        ...props,
+        middlewares: mergeOptions(props).middlewares
+      });
+    }
+    createMethods(methods) {
+      return this.helper.createMethods(methods);
+    }
+    static build(factory, options) {
+      return ApiHelper.build(factory, mergeOptions(options));
+    }
+  }, _a.parse = ApiHelper.parse, /** @deprecated Use `parse` instead. */
+  _a.parserErrorWrapper = ApiHelper.parse, _a;
+}
 
 // src/helpers/authHelper.ts
 import { serialize as serialize2 } from "cookie";
@@ -5745,6 +5771,7 @@ export {
   Td,
   Tr,
   UseDialogConfirm,
+  createApiHelper,
   createAuthContext,
   createFilter,
   destroyCookie,