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

package/README.md

@@ -19,7 +19,9 @@ npm install @faasjs/func
 
 ## Functions
 
+- [defineFunc](functions/defineFunc.md)
 - [nameFunc](functions/nameFunc.md)
+- [parseFuncFilenameFromStack](functions/parseFuncFilenameFromStack.md)
 - [useFunc](functions/useFunc.md)
 - [usePlugin](functions/usePlugin.md)
 
@@ -27,6 +29,10 @@ npm install @faasjs/func
 
 - [Func](classes/Func.md)
 
+## Interfaces
+
+- [FaasPluginEventMap](interfaces/FaasPluginEventMap.md)
+
 ## Type Aliases
 
 - [Config](type-aliases/Config.md)
@@ -35,9 +41,14 @@ npm install @faasjs/func
 - [FuncEventType](type-aliases/FuncEventType.md)
 - [FuncReturnType](type-aliases/FuncReturnType.md)
 - [Handler](type-aliases/Handler.md)
+- [InferPluginEvent](type-aliases/InferPluginEvent.md)
 - [InvokeData](type-aliases/InvokeData.md)
 - [LifeCycleKey](type-aliases/LifeCycleKey.md)
 - [MountData](type-aliases/MountData.md)
 - [Next](type-aliases/Next.md)
+- [NormalizePluginType](type-aliases/NormalizePluginType.md)
 - [Plugin](type-aliases/Plugin.md)
+- [ResolvePluginEvent](type-aliases/ResolvePluginEvent.md)
+- [Simplify](type-aliases/Simplify.md)
+- [UnionToIntersection](type-aliases/UnionToIntersection.md)
 - [UseifyPlugin](type-aliases/UseifyPlugin.md)

package/dist/index.cjs

@@ -1,6 +1,7 @@
 'use strict';
 
 var crypto = require('crypto');
+var url = require('url');
 var logger = require('@faasjs/logger');
 
 // src/index.ts
@@ -38,12 +39,41 @@ function nameFunc(name, handler) {
 }
 
 // src/index.ts
+function parseFuncFilenameFromStack(stack) {
+  if (!stack) return;
+  const frame = stack.split("\n").map((line) => line.trim()).find((line) => line.includes(".func.ts"));
+  if (!frame) return;
+  const content = frame.replace(/^at\s+/, "");
+  const location = content.endsWith(")") && content.includes("(") ? content.slice(content.lastIndexOf("(") + 1, -1) : content;
+  const match = location.match(/^(.+\.func\.ts):\d+:\d+$/);
+  if (!match) return;
+  const filename = match[1];
+  if (filename.startsWith("file://")) {
+    try {
+      return url.fileURLToPath(filename);
+    } catch (_) {
+      return filename;
+    }
+  }
+  return filename;
+}
+function formatPluginModuleName(type) {
+  if (type.startsWith("npm:")) return type.slice(4);
+  if (type.startsWith("@") || type.startsWith(".") || type.startsWith("/") || type.includes(":"))
+    return type;
+  return `@faasjs/${type}`;
+}
+function formatPluginClassName(type) {
+  return type.replace(/^@[^/]+\//, "").split(/[^A-Za-z0-9]+/).filter(Boolean).map((item) => item.slice(0, 1).toUpperCase() + item.slice(1)).join("");
+}
 var Func = class {
   plugins;
   handler;
   config;
   mounted = false;
   filename;
+  autoLoadPluginsFromConfig;
+  loadedConfigPlugins = false;
   cachedFunctions = /* @__PURE__ */ Object.create(null);
   /**
    * Create a cloud function
@@ -55,20 +85,90 @@ var Func = class {
     this.handler = config.handler;
     this.plugins = config.plugins || [];
     this.plugins.push(new RunHandler());
+    this.autoLoadPluginsFromConfig = !!config.autoLoadPluginsFromConfig;
     this.config = {
       plugins: /* @__PURE__ */ Object.create(null)
     };
     try {
-      const stack = new Error().stack;
-      if (stack) {
-        const match = stack.split("\n").find((s) => /[^/]\.func\.ts/.test(s))?.match(/\((.*\.func\.ts).*\)/);
-        if (match) {
-          this.filename = match[1];
-        }
-      }
+      this.filename = parseFuncFilenameFromStack(new Error().stack);
     } catch (_) {
     }
   }
+  insertPluginBeforeRunHandler(plugin) {
+    const index = this.plugins.findIndex(
+      (p) => p.type === "handler" && p.name === "handler"
+    );
+    if (index === -1) this.plugins.push(plugin);
+    else this.plugins.splice(index, 0, plugin);
+    this.cachedFunctions = /* @__PURE__ */ Object.create(null);
+  }
+  async resolvePluginConstructor(moduleName, className, pluginName) {
+    let mod;
+    try {
+      mod = await import(moduleName);
+    } catch (error) {
+      throw Error(
+        `[defineFunc] Failed to load plugin "${pluginName}" from "${moduleName}": ${error.message}`
+      );
+    }
+    const constructors = [];
+    if (className && mod[className]) constructors.push(mod[className]);
+    if (typeof mod.default === "function") constructors.push(mod.default);
+    if (mod.default && typeof mod.default === "object" && className && mod.default[className])
+      constructors.push(mod.default[className]);
+    for (const key in mod) {
+      if (key === className || key === "default") continue;
+      constructors.push(mod[key]);
+    }
+    if (mod.default && typeof mod.default === "object")
+      for (const key in mod.default) {
+        if (key === className) continue;
+        constructors.push(mod.default[key]);
+      }
+    const PluginConstructor = constructors.find(
+      (pluginConstructor) => typeof pluginConstructor === "function" && pluginConstructor.prototype && (typeof pluginConstructor.prototype.onMount === "function" || typeof pluginConstructor.prototype.onInvoke === "function")
+    );
+    if (!PluginConstructor)
+      throw Error(
+        `[defineFunc] Failed to resolve plugin class "${className}" from "${moduleName}" for plugin "${pluginName}".`
+      );
+    return PluginConstructor;
+  }
+  async loadPluginsFromConfig(config) {
+    const pluginConfigs = config.plugins || /* @__PURE__ */ Object.create(null);
+    for (const key in pluginConfigs) {
+      const rawConfig = pluginConfigs[key];
+      const configValue = rawConfig && typeof rawConfig === "object" ? Object.assign(/* @__PURE__ */ Object.create(null), rawConfig) : /* @__PURE__ */ Object.create(null);
+      const pluginName = typeof configValue.name === "string" && configValue.name.length ? configValue.name : key;
+      if (this.plugins.find((plugin2) => plugin2.name === pluginName)) continue;
+      const pluginType = typeof configValue.type === "string" && configValue.type || typeof rawConfig === "string" && rawConfig || key;
+      const moduleName = formatPluginModuleName(pluginType);
+      const className = formatPluginClassName(pluginType);
+      const PluginConstructor = await this.resolvePluginConstructor(
+        moduleName,
+        className,
+        pluginName
+      );
+      let plugin;
+      try {
+        plugin = new PluginConstructor({
+          ...configValue,
+          name: pluginName,
+          type: pluginType
+        });
+      } catch (error) {
+        throw Error(
+          `[defineFunc] Failed to initialize plugin "${pluginName}" from "${moduleName}": ${error.message}`
+        );
+      }
+      if (!plugin || typeof plugin !== "object")
+        throw Error(
+          `[defineFunc] Invalid plugin instance for "${pluginName}" from "${moduleName}".`
+        );
+      this.insertPluginBeforeRunHandler(plugin);
+    }
+    this.loadedConfigPlugins = true;
+  }
   compose(key) {
     let list = [];
     if (this.cachedFunctions[key]) list = this.cachedFunctions[key];
@@ -131,6 +231,8 @@ var Func = class {
       return;
     }
     if (!data.config) data.config = this.config;
+    if (this.autoLoadPluginsFromConfig && !this.loadedConfigPlugins)
+      await this.loadPluginsFromConfig(data.config);
     data.logger.debug(
       `plugins: ${this.plugins.map((p) => `${p.type}#${p.name}`).join(",")}`
     );
@@ -207,8 +309,20 @@ function useFunc(handler) {
   plugins = [];
   return func;
 }
+function defineFunc(handler) {
+  plugins = [];
+  const func = new Func({
+    plugins,
+    handler,
+    autoLoadPluginsFromConfig: true
+  });
+  plugins = [];
+  return func;
+}
 
 exports.Func = Func;
+exports.defineFunc = defineFunc;
 exports.nameFunc = nameFunc;
+exports.parseFuncFilenameFromStack = parseFuncFilenameFromStack;
 exports.useFunc = useFunc;
 exports.usePlugin = usePlugin;

package/dist/index.d.ts

@@ -55,7 +55,7 @@ type Config = {
     plugins?: {
         [key: string]: {
             [key: string]: any;
-            type: string;
+            type?: string;
             config?: {
                 [key: string]: any;
             };
@@ -82,6 +82,7 @@ type LifeCycleKey = 'onMount' | 'onInvoke';
 type FuncConfig<TEvent = any, TContext = any, TResult = any> = {
     plugins?: Plugin[];
     handler?: Handler<TEvent, TContext, TResult>;
+    autoLoadPluginsFromConfig?: boolean;
 };
 /**
  * Get the event type of a func
@@ -109,6 +110,30 @@ 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];
+} & {};
+/**
+ * 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 {
+}
+type ResolvePluginEvent<TType extends string> = NormalizePluginType<TType> extends keyof FaasPluginEventMap ? FaasPluginEventMap[NormalizePluginType<TType>] : Record<never, never>;
+/**
+ * Infer event type from plugin type names.
+ *
+ * @example
+ * ```ts
+ * type Event = InferPluginEvent<['http']>
+ * ```
+ */
+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[];
@@ -116,6 +141,8 @@ declare class Func<TEvent = any, TContext = any, TResult = any> {
     config: Config;
     mounted: boolean;
     filename?: string;
+    private readonly autoLoadPluginsFromConfig;
+    private loadedConfigPlugins;
     private cachedFunctions;
     /**
      * Create a cloud function
@@ -124,6 +151,9 @@ declare class Func<TEvent = any, TContext = any, TResult = any> {
      * @param config.handler {Handler} business logic
      */
     constructor(config: FuncConfig<TEvent, TContext>);
+    private insertPluginBeforeRunHandler;
+    private resolvePluginConstructor;
+    private loadPluginsFromConfig;
     private compose;
     /**
      * First time mount the function
@@ -179,5 +209,15 @@ 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, Func, type FuncConfig, type FuncEventType, type FuncReturnType, type Handler, type InvokeData, type LifeCycleKey, type MountData, type Next, type Plugin, type UseifyPlugin, nameFunc, useFunc, usePlugin };
+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 };

package/dist/index.mjs

@@ -1,4 +1,5 @@
 import { randomBytes } from 'crypto';
+import { fileURLToPath } from 'url';
 import { Logger } from '@faasjs/logger';
 
 // src/index.ts
@@ -36,12 +37,41 @@ function nameFunc(name, handler) {
 }
 
 // src/index.ts
+function parseFuncFilenameFromStack(stack) {
+  if (!stack) return;
+  const frame = stack.split("\n").map((line) => line.trim()).find((line) => line.includes(".func.ts"));
+  if (!frame) return;
+  const content = frame.replace(/^at\s+/, "");
+  const location = content.endsWith(")") && content.includes("(") ? content.slice(content.lastIndexOf("(") + 1, -1) : content;
+  const match = location.match(/^(.+\.func\.ts):\d+:\d+$/);
+  if (!match) return;
+  const filename = match[1];
+  if (filename.startsWith("file://")) {
+    try {
+      return fileURLToPath(filename);
+    } catch (_) {
+      return filename;
+    }
+  }
+  return filename;
+}
+function formatPluginModuleName(type) {
+  if (type.startsWith("npm:")) return type.slice(4);
+  if (type.startsWith("@") || type.startsWith(".") || type.startsWith("/") || type.includes(":"))
+    return type;
+  return `@faasjs/${type}`;
+}
+function formatPluginClassName(type) {
+  return type.replace(/^@[^/]+\//, "").split(/[^A-Za-z0-9]+/).filter(Boolean).map((item) => item.slice(0, 1).toUpperCase() + item.slice(1)).join("");
+}
 var Func = class {
   plugins;
   handler;
   config;
   mounted = false;
   filename;
+  autoLoadPluginsFromConfig;
+  loadedConfigPlugins = false;
   cachedFunctions = /* @__PURE__ */ Object.create(null);
   /**
    * Create a cloud function
@@ -53,20 +83,90 @@ var Func = class {
     this.handler = config.handler;
     this.plugins = config.plugins || [];
     this.plugins.push(new RunHandler());
+    this.autoLoadPluginsFromConfig = !!config.autoLoadPluginsFromConfig;
     this.config = {
       plugins: /* @__PURE__ */ Object.create(null)
     };
     try {
-      const stack = new Error().stack;
-      if (stack) {
-        const match = stack.split("\n").find((s) => /[^/]\.func\.ts/.test(s))?.match(/\((.*\.func\.ts).*\)/);
-        if (match) {
-          this.filename = match[1];
-        }
-      }
+      this.filename = parseFuncFilenameFromStack(new Error().stack);
     } catch (_) {
     }
   }
+  insertPluginBeforeRunHandler(plugin) {
+    const index = this.plugins.findIndex(
+      (p) => p.type === "handler" && p.name === "handler"
+    );
+    if (index === -1) this.plugins.push(plugin);
+    else this.plugins.splice(index, 0, plugin);
+    this.cachedFunctions = /* @__PURE__ */ Object.create(null);
+  }
+  async resolvePluginConstructor(moduleName, className, pluginName) {
+    let mod;
+    try {
+      mod = await import(moduleName);
+    } catch (error) {
+      throw Error(
+        `[defineFunc] Failed to load plugin "${pluginName}" from "${moduleName}": ${error.message}`
+      );
+    }
+    const constructors = [];
+    if (className && mod[className]) constructors.push(mod[className]);
+    if (typeof mod.default === "function") constructors.push(mod.default);
+    if (mod.default && typeof mod.default === "object" && className && mod.default[className])
+      constructors.push(mod.default[className]);
+    for (const key in mod) {
+      if (key === className || key === "default") continue;
+      constructors.push(mod[key]);
+    }
+    if (mod.default && typeof mod.default === "object")
+      for (const key in mod.default) {
+        if (key === className) continue;
+        constructors.push(mod.default[key]);
+      }
+    const PluginConstructor = constructors.find(
+      (pluginConstructor) => typeof pluginConstructor === "function" && pluginConstructor.prototype && (typeof pluginConstructor.prototype.onMount === "function" || typeof pluginConstructor.prototype.onInvoke === "function")
+    );
+    if (!PluginConstructor)
+      throw Error(
+        `[defineFunc] Failed to resolve plugin class "${className}" from "${moduleName}" for plugin "${pluginName}".`
+      );
+    return PluginConstructor;
+  }
+  async loadPluginsFromConfig(config) {
+    const pluginConfigs = config.plugins || /* @__PURE__ */ Object.create(null);
+    for (const key in pluginConfigs) {
+      const rawConfig = pluginConfigs[key];
+      const configValue = rawConfig && typeof rawConfig === "object" ? Object.assign(/* @__PURE__ */ Object.create(null), rawConfig) : /* @__PURE__ */ Object.create(null);
+      const pluginName = typeof configValue.name === "string" && configValue.name.length ? configValue.name : key;
+      if (this.plugins.find((plugin2) => plugin2.name === pluginName)) continue;
+      const pluginType = typeof configValue.type === "string" && configValue.type || typeof rawConfig === "string" && rawConfig || key;
+      const moduleName = formatPluginModuleName(pluginType);
+      const className = formatPluginClassName(pluginType);
+      const PluginConstructor = await this.resolvePluginConstructor(
+        moduleName,
+        className,
+        pluginName
+      );
+      let plugin;
+      try {
+        plugin = new PluginConstructor({
+          ...configValue,
+          name: pluginName,
+          type: pluginType
+        });
+      } catch (error) {
+        throw Error(
+          `[defineFunc] Failed to initialize plugin "${pluginName}" from "${moduleName}": ${error.message}`
+        );
+      }
+      if (!plugin || typeof plugin !== "object")
+        throw Error(
+          `[defineFunc] Invalid plugin instance for "${pluginName}" from "${moduleName}".`
+        );
+      this.insertPluginBeforeRunHandler(plugin);
+    }
+    this.loadedConfigPlugins = true;
+  }
   compose(key) {
     let list = [];
     if (this.cachedFunctions[key]) list = this.cachedFunctions[key];
@@ -129,6 +229,8 @@ var Func = class {
       return;
     }
     if (!data.config) data.config = this.config;
+    if (this.autoLoadPluginsFromConfig && !this.loadedConfigPlugins)
+      await this.loadPluginsFromConfig(data.config);
     data.logger.debug(
       `plugins: ${this.plugins.map((p) => `${p.type}#${p.name}`).join(",")}`
     );
@@ -205,5 +307,15 @@ function useFunc(handler) {
   plugins = [];
   return func;
 }
+function defineFunc(handler) {
+  plugins = [];
+  const func = new Func({
+    plugins,
+    handler,
+    autoLoadPluginsFromConfig: true
+  });
+  plugins = [];
+  return func;
+}
 
-export { Func, nameFunc, useFunc, usePlugin };
+export { Func, defineFunc, nameFunc, parseFuncFilenameFromStack, useFunc, usePlugin };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/func",
-  "version": "v8.0.0-beta.4",
+  "version": "8.0.0-beta.6",
   "license": "MIT",
   "type": "module",
   "main": "dist/index.cjs",
@@ -30,12 +30,12 @@
     "dist"
   ],
   "peerDependencies": {
-    "@faasjs/deep_merge": ">=v8.0.0-beta.4",
-    "@faasjs/logger": ">=v8.0.0-beta.4"
+    "@faasjs/deep_merge": ">=8.0.0-beta.6",
+    "@faasjs/logger": ">=8.0.0-beta.6"
   },
   "devDependencies": {
-    "@faasjs/deep_merge": ">=v8.0.0-beta.4",
-    "@faasjs/logger": ">=v8.0.0-beta.4"
+    "@faasjs/deep_merge": ">=8.0.0-beta.6",
+    "@faasjs/logger": ">=8.0.0-beta.6"
   },
   "engines": {
     "node": ">=24.0.0",