@faasjs/func 2.8.1 → 3.0.0-canary.1

package/README.md

@@ -18,7 +18,6 @@ npm install @faasjs/func
 ## Type Aliases
 
 - [Config](type-aliases/Config.md)
-- [DeployData](type-aliases/DeployData.md)
 - [ExportedHandler](type-aliases/ExportedHandler.md)
 - [FuncConfig](type-aliases/FuncConfig.md)
 - [FuncEventType](type-aliases/FuncEventType.md)
@@ -29,7 +28,6 @@ npm install @faasjs/func
 - [MountData](type-aliases/MountData.md)
 - [Next](type-aliases/Next.md)
 - [Plugin](type-aliases/Plugin.md)
-- [ProviderConfig](type-aliases/ProviderConfig.md)
 - [UseifyPlugin](type-aliases/UseifyPlugin.md)
 
 ## Functions

package/dist/index.d.mts

@@ -16,30 +16,19 @@ import { Logger } from '@faasjs/logger';
 
 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 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;
-    onDeploy?: (data: DeployData, next: Next) => Promise<void>;
     onMount?: (data: MountData, next: Next) => Promise<void>;
     onInvoke?: (data: InvokeData, next: Next) => Promise<void>;
 };
-type ProviderConfig = {
-    type: string;
-    config: {
-        [key: string]: any;
-    };
-};
 type Config = {
     [key: string]: any;
-    providers?: {
-        [key: string]: ProviderConfig;
-    };
     plugins?: {
         [key: string]: {
             [key: string]: any;
-            provider?: string | ProviderConfig;
             type: string;
             config?: {
                 [key: string]: any;
@@ -47,31 +36,6 @@ type Config = {
         };
     };
 };
-type DeployData = {
-    [key: string]: any;
-    root: string;
-    filename: string;
-    env?: string;
-    name?: string;
-    config?: Config;
-    version?: string;
-    dependencies: {
-        [name: string]: string;
-    };
-    plugins?: {
-        [name: string]: {
-            [key: string]: any;
-            name?: string;
-            type: string;
-            provider?: string;
-            config: {
-                [key: string]: any;
-            };
-            plugin: Plugin;
-        };
-    };
-    logger?: Logger;
-};
 type MountData = {
     [key: string]: any;
     config: Config;
@@ -88,7 +52,7 @@ type InvokeData<TEvent = any, TContext = any, TResult = any> = {
     handler?: Handler<TEvent, TContext, TResult>;
     config: Config;
 };
-type LifeCycleKey = 'onDeploy' | 'onMount' | 'onInvoke';
+type LifeCycleKey = 'onMount' | 'onInvoke';
 type FuncConfig<TEvent = any, TContext = any, TResult = any> = {
     plugins?: Plugin[];
     handler?: Handler<TEvent, TContext, TResult>;
@@ -135,14 +99,6 @@ declare class Func<TEvent = any, TContext = any, TResult = any> {
      */
     constructor(config: FuncConfig<TEvent, TContext>);
     private compose;
-    /**
-     * Deploy the function
-     * @param data {object} data
-     * @param data.root {string} root path
-     * @param data.filename {string} filename
-     * @param data.env {string} environment
-     */
-    deploy(data: DeployData): any;
     /**
      * First time mount the function
      */
@@ -165,11 +121,15 @@ declare class Func<TEvent = any, TContext = any, TResult = any> {
     };
 }
 type UseifyPlugin<T> = T & {
-    mount?: (data?: {
+    mount: (data?: {
         config?: Config;
     }) => Promise<T>;
 };
-declare function usePlugin<T extends Plugin>(plugin: UseifyPlugin<T>): UseifyPlugin<T>;
+declare function usePlugin<T extends Plugin>(plugin: T & {
+    mount?: (data?: {
+        config?: Config;
+    }) => Promise<T>;
+}): UseifyPlugin<T>;
 /**
  * ```ts
  * // pure function
@@ -193,4 +153,4 @@ declare function usePlugin<T extends Plugin>(plugin: UseifyPlugin<T>): UseifyPlu
  */
 declare function useFunc<TEvent = any, TContext = any, TResult = any>(handler: () => Handler<TEvent, TContext, TResult>): Func<TEvent, TContext, TResult>;
 
-export { type Config, type DeployData, type ExportedHandler, Func, type FuncConfig, type FuncEventType, type FuncReturnType, type Handler, type InvokeData, type LifeCycleKey, type MountData, type Next, type Plugin, type ProviderConfig, type UseifyPlugin, useFunc, usePlugin };
+export { type Config, type ExportedHandler, Func, type FuncConfig, type FuncEventType, type FuncReturnType, type Handler, type InvokeData, type LifeCycleKey, type MountData, type Next, type Plugin, type UseifyPlugin, useFunc, usePlugin };

package/dist/index.d.ts

@@ -16,30 +16,19 @@ import { Logger } from '@faasjs/logger';
 
 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 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;
-    onDeploy?: (data: DeployData, next: Next) => Promise<void>;
     onMount?: (data: MountData, next: Next) => Promise<void>;
     onInvoke?: (data: InvokeData, next: Next) => Promise<void>;
 };
-type ProviderConfig = {
-    type: string;
-    config: {
-        [key: string]: any;
-    };
-};
 type Config = {
     [key: string]: any;
-    providers?: {
-        [key: string]: ProviderConfig;
-    };
     plugins?: {
         [key: string]: {
             [key: string]: any;
-            provider?: string | ProviderConfig;
             type: string;
             config?: {
                 [key: string]: any;
@@ -47,31 +36,6 @@ type Config = {
         };
     };
 };
-type DeployData = {
-    [key: string]: any;
-    root: string;
-    filename: string;
-    env?: string;
-    name?: string;
-    config?: Config;
-    version?: string;
-    dependencies: {
-        [name: string]: string;
-    };
-    plugins?: {
-        [name: string]: {
-            [key: string]: any;
-            name?: string;
-            type: string;
-            provider?: string;
-            config: {
-                [key: string]: any;
-            };
-            plugin: Plugin;
-        };
-    };
-    logger?: Logger;
-};
 type MountData = {
     [key: string]: any;
     config: Config;
@@ -88,7 +52,7 @@ type InvokeData<TEvent = any, TContext = any, TResult = any> = {
     handler?: Handler<TEvent, TContext, TResult>;
     config: Config;
 };
-type LifeCycleKey = 'onDeploy' | 'onMount' | 'onInvoke';
+type LifeCycleKey = 'onMount' | 'onInvoke';
 type FuncConfig<TEvent = any, TContext = any, TResult = any> = {
     plugins?: Plugin[];
     handler?: Handler<TEvent, TContext, TResult>;
@@ -135,14 +99,6 @@ declare class Func<TEvent = any, TContext = any, TResult = any> {
      */
     constructor(config: FuncConfig<TEvent, TContext>);
     private compose;
-    /**
-     * Deploy the function
-     * @param data {object} data
-     * @param data.root {string} root path
-     * @param data.filename {string} filename
-     * @param data.env {string} environment
-     */
-    deploy(data: DeployData): any;
     /**
      * First time mount the function
      */
@@ -165,11 +121,15 @@ declare class Func<TEvent = any, TContext = any, TResult = any> {
     };
 }
 type UseifyPlugin<T> = T & {
-    mount?: (data?: {
+    mount: (data?: {
         config?: Config;
     }) => Promise<T>;
 };
-declare function usePlugin<T extends Plugin>(plugin: UseifyPlugin<T>): UseifyPlugin<T>;
+declare function usePlugin<T extends Plugin>(plugin: T & {
+    mount?: (data?: {
+        config?: Config;
+    }) => Promise<T>;
+}): UseifyPlugin<T>;
 /**
  * ```ts
  * // pure function
@@ -193,4 +153,4 @@ declare function usePlugin<T extends Plugin>(plugin: UseifyPlugin<T>): UseifyPlu
  */
 declare function useFunc<TEvent = any, TContext = any, TResult = any>(handler: () => Handler<TEvent, TContext, TResult>): Func<TEvent, TContext, TResult>;
 
-export { type Config, type DeployData, type ExportedHandler, Func, type FuncConfig, type FuncEventType, type FuncReturnType, type Handler, type InvokeData, type LifeCycleKey, type MountData, type Next, type Plugin, type ProviderConfig, type UseifyPlugin, useFunc, usePlugin };
+export { type Config, type ExportedHandler, Func, type FuncConfig, type FuncEventType, type FuncReturnType, type Handler, type InvokeData, type LifeCycleKey, type MountData, type Next, type Plugin, type UseifyPlugin, useFunc, usePlugin };

package/dist/index.js

@@ -7,10 +7,8 @@ var crypto = require('crypto');
 
 // src/plugins/run_handler/index.ts
 var RunHandler = class {
-  constructor() {
-    this.type = "handler";
-    this.name = "handler";
-  }
+  type = "handler";
+  name = "handler";
   async onInvoke(data, next) {
     if (data.handler)
       if (!data.runHandler) {
@@ -32,6 +30,12 @@ var RunHandler = class {
   }
 };
 var Func = class {
+  plugins;
+  handler;
+  config;
+  mounted;
+  filename;
+  cachedFunctions;
   /**
    * Create a cloud function
    * @param config {object} config
@@ -43,7 +47,6 @@ var Func = class {
     this.plugins = config.plugins || [];
     this.plugins.push(new RunHandler());
     this.config = {
-      providers: /* @__PURE__ */ Object.create(null),
       plugins: /* @__PURE__ */ Object.create(null)
     };
     this.mounted = false;
@@ -69,7 +72,7 @@ var Func = class {
     }
     return async (data, next) => {
       let index = -1;
-      const logger$1 = (data == null ? void 0 : data.logger) || new logger.Logger();
+      const logger$1 = data?.logger || new logger.Logger();
       const dispatch = async (i) => {
         if (i <= index)
           return Promise.reject(Error("next() called multiple times"));
@@ -95,28 +98,12 @@ var Func = class {
       return await dispatch(0);
     };
   }
-  /**
-   * Deploy the function
-   * @param data {object} data
-   * @param data.root {string} root path
-   * @param data.filename {string} filename
-   * @param data.env {string} environment
-   */
-  deploy(data) {
-    if (!data.logger) data.logger = new logger.Logger("Func");
-    data.logger.debug("onDeploy");
-    data.logger.debug(
-      `Plugins: ${this.plugins.map((p) => `${p.type}#${p.name}`).join(",")}`
-    );
-    return this.compose("onDeploy")(data);
-  }
   /**
    * First time mount the function
    */
   async mount(data) {
-    var _a;
     if (!data.logger) data.logger = new logger.Logger("Func");
-    const logger$1 = new logger.Logger(((_a = data.logger) == null ? void 0 : _a.label) || "Func");
+    const logger$1 = new logger.Logger(data.logger?.label || "Func");
     if (!logger$1.label.endsWith("Func")) logger$1.label = `${logger$1.label}] [Func`;
     logger$1.debug("onMount");
     if (this.mounted) {
@@ -159,10 +146,9 @@ var Func = class {
    */
   export() {
     const handler = async (event, context, callback) => {
-      var _a;
       if (typeof context === "undefined") context = {};
       if (!context.request_id)
-        context.request_id = ((_a = event == null ? void 0 : event.headers) == null ? void 0 : _a["x-faasjs-request-id"]) || crypto.randomBytes(16).toString("hex");
+        context.request_id = event?.headers?.["x-faasjs-request-id"] || crypto.randomBytes(16).toString("hex");
       if (!context.request_at)
         context.request_at = Math.round(Date.now() / 1e3);
       context.callbackWaitsForEmptyEventLoop = false;
@@ -195,7 +181,7 @@ function usePlugin(plugin) {
       if (plugin.onMount)
         await plugin.onMount(
           {
-            config: (data == null ? void 0 : data.config) || /* @__PURE__ */ Object.create(null),
+            config: data?.config || /* @__PURE__ */ Object.create(null),
             event: /* @__PURE__ */ Object.create(null),
             context: /* @__PURE__ */ Object.create(null),
             logger: new logger.Logger(plugin.name)

package/dist/index.mjs

@@ -5,10 +5,8 @@ import { randomBytes } from 'node:crypto';
 
 // src/plugins/run_handler/index.ts
 var RunHandler = class {
-  constructor() {
-    this.type = "handler";
-    this.name = "handler";
-  }
+  type = "handler";
+  name = "handler";
   async onInvoke(data, next) {
     if (data.handler)
       if (!data.runHandler) {
@@ -30,6 +28,12 @@ var RunHandler = class {
   }
 };
 var Func = class {
+  plugins;
+  handler;
+  config;
+  mounted;
+  filename;
+  cachedFunctions;
   /**
    * Create a cloud function
    * @param config {object} config
@@ -41,7 +45,6 @@ var Func = class {
     this.plugins = config.plugins || [];
     this.plugins.push(new RunHandler());
     this.config = {
-      providers: /* @__PURE__ */ Object.create(null),
       plugins: /* @__PURE__ */ Object.create(null)
     };
     this.mounted = false;
@@ -67,7 +70,7 @@ var Func = class {
     }
     return async (data, next) => {
       let index = -1;
-      const logger = (data == null ? void 0 : data.logger) || new Logger();
+      const logger = data?.logger || new Logger();
       const dispatch = async (i) => {
         if (i <= index)
           return Promise.reject(Error("next() called multiple times"));
@@ -93,28 +96,12 @@ var Func = class {
       return await dispatch(0);
     };
   }
-  /**
-   * Deploy the function
-   * @param data {object} data
-   * @param data.root {string} root path
-   * @param data.filename {string} filename
-   * @param data.env {string} environment
-   */
-  deploy(data) {
-    if (!data.logger) data.logger = new Logger("Func");
-    data.logger.debug("onDeploy");
-    data.logger.debug(
-      `Plugins: ${this.plugins.map((p) => `${p.type}#${p.name}`).join(",")}`
-    );
-    return this.compose("onDeploy")(data);
-  }
   /**
    * First time mount the function
    */
   async mount(data) {
-    var _a;
     if (!data.logger) data.logger = new Logger("Func");
-    const logger = new Logger(((_a = data.logger) == null ? void 0 : _a.label) || "Func");
+    const logger = new Logger(data.logger?.label || "Func");
     if (!logger.label.endsWith("Func")) logger.label = `${logger.label}] [Func`;
     logger.debug("onMount");
     if (this.mounted) {
@@ -157,10 +144,9 @@ var Func = class {
    */
   export() {
     const handler = async (event, context, callback) => {
-      var _a;
       if (typeof context === "undefined") context = {};
       if (!context.request_id)
-        context.request_id = ((_a = event == null ? void 0 : event.headers) == null ? void 0 : _a["x-faasjs-request-id"]) || randomBytes(16).toString("hex");
+        context.request_id = event?.headers?.["x-faasjs-request-id"] || randomBytes(16).toString("hex");
       if (!context.request_at)
         context.request_at = Math.round(Date.now() / 1e3);
       context.callbackWaitsForEmptyEventLoop = false;
@@ -193,7 +179,7 @@ function usePlugin(plugin) {
       if (plugin.onMount)
         await plugin.onMount(
           {
-            config: (data == null ? void 0 : data.config) || /* @__PURE__ */ Object.create(null),
+            config: data?.config || /* @__PURE__ */ Object.create(null),
             event: /* @__PURE__ */ Object.create(null),
             context: /* @__PURE__ */ Object.create(null),
             logger: new Logger(plugin.name)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/func",
-  "version": "2.8.1",
+  "version": "3.0.0-canary.1",
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -34,11 +34,11 @@
     "dist"
   ],
   "dependencies": {
-    "@faasjs/deep_merge": "2.8.1",
-    "@faasjs/logger": "2.8.1"
+    "@faasjs/deep_merge": "3.0.0-canary.1",
+    "@faasjs/logger": "3.0.0-canary.1"
   },
   "engines": {
-    "npm": ">=9.0.0",
-    "node": ">=18.0.0"
+    "node": ">=22.0.0",
+    "npm": ">=10.0.0"
   }
 }