@faasjs/func 8.0.0-beta.6 → 8.0.0-beta.8

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-import { Logger } from '@faasjs/logger';
+import { Logger } from "@faasjs/logger";
 
+//#region src/utils.d.ts
 /**
  * Assigns a name to a given function handler, which will be displayed in logs and error messages.
  *
@@ -20,69 +21,50 @@ import { Logger } from '@faasjs/logger';
  * ```
  */
 declare function nameFunc<T extends (...args: any[]) => any>(name: string, handler: T): T;
-
-/**
- * FaasJS's function module.
- *
- * [![License: MIT](https://img.shields.io/npm/l/@faasjs/func.svg)](https://github.com/faasjs/faasjs/blob/main/packages/func/LICENSE)
- * [![NPM Version](https://img.shields.io/npm/v/@faasjs/func.svg)](https://www.npmjs.com/package/@faasjs/func)
- *
- * ## Install
- *
- * ```sh
- * npm install @faasjs/func
- * ```
- *
- * ## Usage
- *
- * @see {@link useFunc}
- *
- * @packageDocumentation
- */
-
+//#endregion
+//#region src/index.d.ts
 type Handler<TEvent = any, TContext = any, TResult = any> = (data: InvokeData<TEvent, TContext>) => Promise<TResult>;
 type Next = () => Promise<void>;
 type ExportedHandler<TEvent = any, TContext = any, TResult = any> = (event?: TEvent, context?: TContext, callback?: (...args: any) => any) => Promise<TResult>;
 type Plugin = {
-    [key: string]: any;
-    readonly type: string;
-    readonly name: string;
-    onMount?: (data: MountData, next: Next) => Promise<void>;
-    onInvoke?: (data: InvokeData, next: Next) => Promise<void>;
+  [key: string]: any;
+  readonly type: string;
+  readonly name: string;
+  onMount?: (data: MountData, next: Next) => Promise<void>;
+  onInvoke?: (data: InvokeData, next: Next) => Promise<void>;
 };
 type Config = {
-    [key: string]: any;
-    plugins?: {
-        [key: string]: {
-            [key: string]: any;
-            type?: string;
-            config?: {
-                [key: string]: any;
-            };
-        };
+  [key: string]: any;
+  plugins?: {
+    [key: string]: {
+      [key: string]: any;
+      type?: string;
+      config?: {
+        [key: string]: any;
+      };
     };
+  };
 };
 type MountData = {
-    [key: string]: any;
-    config: Config;
-    event: any;
-    context: any;
+  [key: string]: any;
+  config: Config;
+  event: any;
+  context: any;
 };
 type InvokeData<TEvent = any, TContext = any, TResult = any> = {
-    [key: string]: any;
-    event: TEvent;
-    context: TContext;
-    callback: any;
-    response: any;
-    logger: Logger;
-    handler?: Handler<TEvent, TContext, TResult>;
-    config: Config;
+  [key: string]: any;
+  event: TEvent;
+  context: TContext;
+  callback: any;
+  response: any;
+  logger: Logger;
+  handler?: Handler<TEvent, TContext, TResult>;
+  config: Config;
 };
 type LifeCycleKey = 'onMount' | 'onInvoke';
 type FuncConfig<TEvent = any, TContext = any, TResult = any> = {
-    plugins?: Plugin[];
-    handler?: Handler<TEvent, TContext, TResult>;
-    autoLoadPluginsFromConfig?: boolean;
+  plugins?: Plugin[];
+  handler?: Handler<TEvent, TContext, TResult>;
 };
 /**
  * Get the event type of a func
@@ -111,18 +93,15 @@ type FuncEventType<T extends Func<any, any, any>> = T extends Func<infer P, any,
  */
 type FuncReturnType<T extends Func<any, any, any>> = T extends Func<any, any, infer R> ? R : any;
 type NormalizePluginType<TType extends string> = TType extends `npm:${infer Name}` ? Name : TType extends `@faasjs/${infer Name}` ? Name : TType;
-type UnionToIntersection<T> = (T extends unknown ? (arg: T) => void : never) extends (arg: infer TResult) => void ? TResult : never;
-type Simplify<T> = {
-    [K in keyof T]: T[K];
-} & {};
+type UnionToIntersection<T> = (T extends unknown ? (arg: T) => void : never) extends ((arg: infer TResult) => void) ? TResult : never;
+type Simplify<T> = { [K in keyof T]: T[K] } & {};
 /**
  * Plugin event augmentation map.
  *
  * Extend this interface in plugin packages to describe which event fields are
  * injected when the plugin is enabled through `faas.yaml`.
  */
-interface FaasPluginEventMap {
-}
+interface FaasPluginEventMap {}
 type ResolvePluginEvent<TType extends string> = NormalizePluginType<TType> extends keyof FaasPluginEventMap ? FaasPluginEventMap[NormalizePluginType<TType>] : Record<never, never>;
 /**
  * Infer event type from plugin type names.
@@ -135,52 +114,47 @@ type ResolvePluginEvent<TType extends string> = NormalizePluginType<TType> exten
 type InferPluginEvent<TPlugins extends readonly string[]> = Simplify<Record<string, any> & UnionToIntersection<ResolvePluginEvent<TPlugins[number]>>>;
 declare function parseFuncFilenameFromStack(stack?: string): string | undefined;
 declare class Func<TEvent = any, TContext = any, TResult = any> {
-    [key: string]: any;
-    plugins: Plugin[];
-    handler?: Handler<TEvent, TContext, TResult>;
-    config: Config;
-    mounted: boolean;
-    filename?: string;
-    private readonly autoLoadPluginsFromConfig;
-    private loadedConfigPlugins;
-    private cachedFunctions;
-    /**
-     * Create a cloud function
-     * @param config {object} config
-     * @param config.plugins {Plugin[]} plugins list
-     * @param config.handler {Handler} business logic
-     */
-    constructor(config: FuncConfig<TEvent, TContext>);
-    private insertPluginBeforeRunHandler;
-    private resolvePluginConstructor;
-    private loadPluginsFromConfig;
-    private compose;
-    /**
-     * First time mount the function
-     */
-    mount(data?: {
-        event: TEvent;
-        context: TContext;
-        config?: Config;
-        logger?: Logger;
-    }): Promise<void>;
-    /**
-     * Invoke the function
-     * @param data {object} data
-     */
-    invoke(data: InvokeData<TEvent, TContext, TResult>): Promise<void>;
-    /**
-     * Export the function
-     */
-    export(): {
-        handler: ExportedHandler<TEvent, TContext, TResult>;
-    };
+  [key: string]: any;
+  plugins: Plugin[];
+  handler?: Handler<TEvent, TContext, TResult>;
+  config: Config;
+  mounted: boolean;
+  filename?: string;
+  private cachedFunctions;
+  /**
+   * Create a cloud function
+   * @param config {object} config
+   * @param config.plugins {Plugin[]} plugins list
+   * @param config.handler {Handler} business logic
+   */
+  constructor(config: FuncConfig<TEvent, TContext>);
+  private compose;
+  /**
+   * First time mount the function
+   */
+  mount(data?: {
+    event: TEvent;
+    context: TContext;
+    config?: Config;
+    logger?: Logger;
+  }): Promise<void>;
+  /**
+   * Invoke the function
+   * @param data {object} data
+   */
+  invoke(data: InvokeData<TEvent, TContext, TResult>): Promise<void>;
+  /**
+   * Export the function
+   */
+  export(): {
+    handler: ExportedHandler<TEvent, TContext, TResult>;
+  };
 }
 type UseifyPlugin<T> = T & {
-    mount: (data?: MountData) => Promise<T>;
+  mount: (data?: MountData) => Promise<T>;
 };
 declare function usePlugin<T extends Plugin>(plugin: T & {
-    mount?: (data?: MountData) => Promise<T>;
+  mount?: (data?: MountData) => Promise<T>;
 }): UseifyPlugin<T>;
 /**
  * Create a cloud function.
@@ -209,15 +183,5 @@ declare function usePlugin<T extends Plugin>(plugin: T & {
  * ```
  */
 declare function useFunc<TEvent = any, TContext = any, TResult = any>(handler: () => Handler<TEvent, TContext, TResult>): Func<TEvent, TContext, TResult>;
-/**
- * Create a cloud function from business logic and auto-load plugins from
- * `func.config.plugins`.
- *
- * `defineFunc` receives business logic directly (no wrapper function), and
- * resolves plugin modules during the first mount based on config from
- * `faas.yaml` (already loaded into `func.config` by `@faasjs/load`,
- * `@faasjs/server`, or `@faasjs/dev`).
- */
-declare function defineFunc<TEvent = any, TContext = any, TResult = any>(handler: Handler<TEvent, TContext, TResult>): Func<TEvent, TContext, TResult>;
-
-export { type Config, type ExportedHandler, type FaasPluginEventMap, Func, type FuncConfig, type FuncEventType, type FuncReturnType, type Handler, type InferPluginEvent, type InvokeData, type LifeCycleKey, type MountData, type Next, type NormalizePluginType, type Plugin, type ResolvePluginEvent, type Simplify, type UnionToIntersection, type UseifyPlugin, defineFunc, nameFunc, parseFuncFilenameFromStack, useFunc, usePlugin };
+//#endregion
+export { Config, ExportedHandler, FaasPluginEventMap, Func, FuncConfig, FuncEventType, FuncReturnType, Handler, InferPluginEvent, InvokeData, LifeCycleKey, MountData, Next, NormalizePluginType, Plugin, ResolvePluginEvent, Simplify, UnionToIntersection, UseifyPlugin, nameFunc, parseFuncFilenameFromStack, useFunc, usePlugin };