@open-norantec/herbal 1.0.2-alpha.9 → 1.0.2

package/dist/core.d.ts

@@ -1,18 +1,68 @@
 import 'reflect-metadata';
 import { HeaderUtil } from '@open-norantec/utilities/dist/header-util.class';
 import { z } from 'zod';
-import { Request } from './types/request.type';
+import { Request, RequestContext } from './types/request.type';
+import 'reflect-metadata';
+import { Request as ExpressRequest } from 'express';
+import { Constructor } from 'type-fest';
+import { AuthAdapter } from './abstracts/auth-adapter.abstract.class';
+import { PathsObject } from 'zod-openapi/dist/openapi3-ts/dist/model/openapi31';
 export * from '@nestjs/core';
-export interface MethodContext<IS extends z.Schema<any>> {
-    headers: ReturnType<typeof HeaderUtil.parse>;
-    input: z.infer<IS>;
-    request: Request;
-}
 export type MethodHandler<IS extends z.Schema<any>, OS extends z.Schema<any>> = (request: Request, input: unknown, headers: ReturnType<typeof HeaderUtil.parse>) => Promise<{
     request: z.infer<IS>;
     response: z.infer<OS>;
 }>;
-export declare class HerbalController {
-    protected registerMethod: <IS extends z.ZodType<any, z.ZodTypeDef, any>, OS extends z.ZodType<any, z.ZodTypeDef, any>>(inputSchema: IS, outputSchema: OS, callback: (context: MethodContext<IS>) => Promise<z.TypeOf<OS>>) => MethodHandler<IS, OS>;
-    private handler;
+type ClientGroups = Array<string> | null | undefined;
+type ClienttGroupsFactory = (defaultGroupName: string) => ClientGroups;
+export interface MethodRegisterOptions<IS extends z.Schema<any>, OS extends z.Schema<any>> {
+    inputSchema: IS;
+    outputSchema: OS;
+    authAdapters?: Constructor<AuthAdapter>[];
+    clientGroups?: ClientGroups | ClienttGroupsFactory;
+    disableTransaction?: boolean;
+}
+export type MethodRegisterFn<C> = <IS extends z.Schema<any>, OS extends z.Schema<any>>(name: string, options: MethodRegisterOptions<IS, OS>, callback: MethodCallback<IS, OS, C>) => void;
+export interface MethodContext<IS extends z.Schema<any>> extends RequestContext {
+    headers: ReturnType<typeof HeaderUtil.parse>;
+    input: z.infer<IS>;
+    url: string;
+}
+export type MethodCallContext<IS extends z.Schema<any>> = Omit<MethodContext<IS>, 'input'>;
+export type MethodCallback<IS extends z.Schema<any>, OS extends z.Schema<any>, C> = (this: C, context: MethodContext<IS>) => Promise<z.infer<OS>>;
+declare class MethodConfig<IS extends z.Schema<any>, OS extends z.Schema<any>, C> {
+    readonly name: string;
+    readonly options: MethodRegisterOptions<IS, OS>;
+    protected readonly callback: MethodCallback<IS, OS, C>;
+    constructor(name: string, options: MethodRegisterOptions<IS, OS>, callback: MethodCallback<IS, OS, C>);
+    call(controller: C, callContext: MethodCallContext<IS>): Promise<z.TypeOf<OS>>;
+}
+declare class MethodPool {
+    protected readonly methods: Map<string, MethodConfig<any, any, any>>;
+    registerMethod<IS extends z.Schema<any>, OS extends z.Schema<any>, C>(name: string, options: MethodRegisterOptions<IS, OS>, callback: MethodCallback<IS, OS, C>): void;
+    transactionDisabled(name: string): boolean | undefined;
+    getCallFn(name: string): ((controller: any, callContext: MethodCallContext<any>) => Promise<any>) | null;
+    getAuthAdapters(name: string): Constructor<AuthAdapter>[] | null | undefined;
+    getOpenAPIPathsObject(group?: string): PathsObject;
+}
+export declare function isHerbalController(target: Function): boolean;
+export declare function getControllerName(target: Function): any;
+export interface HerbalControllerOptions<C> {
+    ignoreControllerNamePostfix?: boolean;
+    prefix?: string;
+    useHeadGuards?: Constructor<any>[];
+    useTailGuards?: Constructor<any>[];
+    methods?: (register: MethodRegisterFn<C>) => void;
+}
+export interface ControllerUtilCreateOptions {
+    prefix?: string;
+    useGuards?: Constructor<any>[];
+    getTraceId?: (request: ExpressRequest) => string;
+}
+export declare function getMethodPool(targetPrototype: object): MethodPool | null;
+export declare class ControllerUtil {
+    static create(createOptions?: ControllerUtilCreateOptions): {
+        <C>(options?: HerbalControllerOptions<C> | undefined): ClassDecorator;
+        isHerbalController: typeof isHerbalController;
+        getControllerName: typeof getControllerName;
+    };
 }