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

package/README.md

@@ -19,7 +19,6 @@ npm install @faasjs/func
 
 ## Functions
 
-- [defineFunc](functions/defineFunc.md)
 - [nameFunc](functions/nameFunc.md)
 - [parseFuncFilenameFromStack](functions/parseFuncFilenameFromStack.md)
 - [useFunc](functions/useFunc.md)

package/dist/index.cjs

@@ -1,328 +1,271 @@
-'use strict';
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+let node_crypto = require("node:crypto");
+let node_url = require("node:url");
+let _faasjs_logger = require("@faasjs/logger");
 
-var crypto = require('crypto');
-var url = require('url');
-var logger = require('@faasjs/logger');
-
-// src/index.ts
-
-// src/plugins/run_handler/index.ts
-var Name = "handler";
+//#region src/plugins/run_handler/index.ts
+const Name = "handler";
 var RunHandler = class {
-  type = Name;
-  name = Name;
-  async onInvoke(data, next) {
-    if (data.handler)
-      if (!data.runHandler) {
-        try {
-          data.response = await new Promise((resolve, reject) => {
-            data.callback = (error, result) => {
-              if (error) reject(error);
-              else resolve(result);
-            };
-            Promise.resolve(data.handler?.(data)).then(resolve).catch(reject);
-          });
-        } catch (error) {
-          data.logger.error(error);
-          data.response = error;
-        }
-        data.runHandler = true;
-      } else data.logger.warn("handler has been run");
-    await next();
-  }
+	type = Name;
+	name = Name;
+	async onInvoke(data, next) {
+		if (data.handler) if (!data.runHandler) {
+			try {
+				data.response = await new Promise((resolve, reject) => {
+					data.callback = (error, result) => {
+						if (error) reject(error);
+						else resolve(result);
+					};
+					Promise.resolve(data.handler?.(data)).then(resolve).catch(reject);
+				});
+			} catch (error) {
+				data.logger.error(error);
+				data.response = error;
+			}
+			data.runHandler = true;
+		} else data.logger.warn("handler has been run");
+		await next();
+	}
 };
 
-// src/utils.ts
+//#endregion
+//#region src/utils.ts
+/**
+* Assigns a name to a given function handler, which will be displayed in logs and error messages.
+*
+* @template T - The type of the function handler.
+* @param {string} name - The name to assign to the function handler.
+* @param {T} handler - The function handler to which the name will be assigned.
+* @returns {T} - The original function handler with the assigned name.
+*
+* @example
+* ```ts
+* import { nameFunc } from '@faasjs/func'
+*
+* const handler = nameFunc('myHandler', () => {
+*  return 'Hello World'
+* })
+*
+* console.log(handler.name) // => 'myHandler'
+* ```
+*/
 function nameFunc(name, handler) {
-  Object.defineProperty(handler, "name", { value: name });
-  return handler;
+	Object.defineProperty(handler, "name", { value: name });
+	return handler;
 }
 
-// src/index.ts
+//#endregion
+//#region src/index.ts
+/**
+* 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
+*/
 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("");
+	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 match = (content.endsWith(")") && content.includes("(") ? content.slice(content.lastIndexOf("(") + 1, -1) : content).match(/^(.+\.func\.ts):\d+:\d+$/);
+	if (!match) return;
+	const filename = match[1];
+	if (filename.startsWith("file://")) try {
+		return (0, node_url.fileURLToPath)(filename);
+	} catch (_) {
+		return filename;
+	}
+	return filename;
 }
 var Func = class {
-  plugins;
-  handler;
-  config;
-  mounted = false;
-  filename;
-  autoLoadPluginsFromConfig;
-  loadedConfigPlugins = false;
-  cachedFunctions = /* @__PURE__ */ Object.create(null);
-  /**
-   * Create a cloud function
-   * @param config {object} config
-   * @param config.plugins {Plugin[]} plugins list
-   * @param config.handler {Handler} business logic
-   */
-  constructor(config) {
-    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 {
-      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];
-    else {
-      for (const plugin of this.plugins) {
-        const handler = plugin[key];
-        if (typeof handler === "function")
-          list.push({
-            key: plugin.name,
-            handler: handler.bind(plugin)
-          });
-      }
-      this.cachedFunctions[key] = list;
-    }
-    return async (data, next) => {
-      let index = -1;
-      if (!data.logger) data.logger = new logger.Logger();
-      const dispatch = async (i) => {
-        if (i <= index)
-          return Promise.reject(Error("next() called multiple times"));
-        index = i;
-        let fn = list[i];
-        if (i === list.length) fn = next;
-        if (!fn) return Promise.resolve();
-        if (typeof fn.key === "undefined") fn.key = `uname#${i}`;
-        if (!data.context) data.context = /* @__PURE__ */ Object.create(null);
-        if (!data.context.request_at)
-          data.context.request_at = crypto.randomBytes(16).toString("hex");
-        const label = `${data.context.request_id}] [${fn.key}] [${key}`;
-        data.logger.label = label;
-        data.logger.debug("begin");
-        data.logger.time(label);
-        try {
-          const res = await Promise.resolve(
-            fn.handler(data, dispatch.bind(null, i + 1))
-          );
-          data.logger.label = label;
-          data.logger.timeEnd(label, "end");
-          return res;
-        } catch (err) {
-          data.logger.label = label;
-          data.logger.timeEnd(label, "failed");
-          data.logger.error(err);
-          return Promise.reject(err);
-        }
-      };
-      return await dispatch(0);
-    };
-  }
-  /**
-   * First time mount the function
-   */
-  async mount(data = {
-    event: /* @__PURE__ */ Object.create(null),
-    context: /* @__PURE__ */ Object.create(null)
-  }) {
-    if (!data.logger) data.logger = new logger.Logger("Func");
-    if (this.mounted) {
-      data.logger.warn("mount() has been called, skipped.");
-      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(",")}`
-    );
-    await this.compose("onMount")(data);
-    this.mounted = true;
-  }
-  /**
-   * Invoke the function
-   * @param data {object} data
-   */
-  async invoke(data) {
-    if (!this.mounted) await this.mount(data);
-    try {
-      await this.compose("onInvoke")(data);
-    } catch (error) {
-      data.logger.error(error);
-      data.response = error;
-    }
-  }
-  /**
-   * Export the function
-   */
-  export() {
-    const handler = async (event, context, callback) => {
-      if (typeof context === "undefined") context = {};
-      if (!context.request_id)
-        context.request_id = event?.headers?.["x-faasjs-request-id"] || crypto.randomBytes(16).toString("hex");
-      if (!context.request_at)
-        context.request_at = crypto.randomBytes(16).toString("hex");
-      context.callbackWaitsForEmptyEventLoop = false;
-      const logger$1 = new logger.Logger(context.request_id);
-      const data = {
-        event: event ?? /* @__PURE__ */ Object.create(null),
-        context,
-        callback,
-        response: void 0,
-        handler: this.handler,
-        logger: logger$1,
-        config: this.config
-      };
-      await this.invoke(data);
-      if (Object.prototype.toString.call(data.response) === "[object Error]")
-        throw data.response;
-      return data.response;
-    };
-    return {
-      handler: handler.bind(this)
-    };
-  }
+	plugins;
+	handler;
+	config;
+	mounted = false;
+	filename;
+	cachedFunctions = Object.create(null);
+	/**
+	* Create a cloud function
+	* @param config {object} config
+	* @param config.plugins {Plugin[]} plugins list
+	* @param config.handler {Handler} business logic
+	*/
+	constructor(config) {
+		if (config.handler) this.handler = config.handler;
+		this.plugins = config.plugins || [];
+		this.plugins.push(new RunHandler());
+		this.config = { plugins: Object.create(null) };
+		try {
+			const filename = parseFuncFilenameFromStack((/* @__PURE__ */ new Error()).stack);
+			if (filename) this.filename = filename;
+		} catch (_) {}
+	}
+	compose(key) {
+		let list = [];
+		if (this.cachedFunctions[key]) list = this.cachedFunctions[key];
+		else {
+			for (const plugin of this.plugins) {
+				const handler = plugin[key];
+				if (typeof handler === "function") list.push({
+					key: plugin.name,
+					handler: handler.bind(plugin)
+				});
+			}
+			this.cachedFunctions[key] = list;
+		}
+		return async (data, next) => {
+			let index = -1;
+			if (!data.logger) data.logger = new _faasjs_logger.Logger();
+			const dispatch = async (i) => {
+				if (i <= index) return Promise.reject(Error("next() called multiple times"));
+				index = i;
+				let fn = list[i];
+				if (i === list.length) fn = next;
+				if (!fn) return Promise.resolve();
+				if (typeof fn.key === "undefined") fn.key = `uname#${i}`;
+				if (!data.context) data.context = Object.create(null);
+				if (!data.context.request_at) data.context.request_at = (0, node_crypto.randomBytes)(16).toString("hex");
+				const label = `${data.context.request_id}] [${fn.key}] [${key}`;
+				data.logger.label = label;
+				data.logger.debug("begin");
+				data.logger.time(label);
+				try {
+					const res = await Promise.resolve(fn.handler(data, dispatch.bind(null, i + 1)));
+					data.logger.label = label;
+					data.logger.timeEnd(label, "end");
+					return res;
+				} catch (err) {
+					data.logger.label = label;
+					data.logger.timeEnd(label, "failed");
+					data.logger.error(err);
+					return Promise.reject(err);
+				}
+			};
+			return await dispatch(0);
+		};
+	}
+	/**
+	* First time mount the function
+	*/
+	async mount(data = {
+		event: Object.create(null),
+		context: Object.create(null)
+	}) {
+		if (!data.logger) data.logger = new _faasjs_logger.Logger("Func");
+		if (this.mounted) {
+			data.logger.warn("mount() has been called, skipped.");
+			return;
+		}
+		if (!data.config) data.config = this.config;
+		data.logger.debug(`plugins: ${this.plugins.map((p) => `${p.type}#${p.name}`).join(",")}`);
+		await this.compose("onMount")(data);
+		this.mounted = true;
+	}
+	/**
+	* Invoke the function
+	* @param data {object} data
+	*/
+	async invoke(data) {
+		if (!this.mounted) await this.mount(data);
+		try {
+			await this.compose("onInvoke")(data);
+		} catch (error) {
+			data.logger.error(error);
+			data.response = error;
+		}
+	}
+	/**
+	* Export the function
+	*/
+	export() {
+		const handler = async (event, context, callback) => {
+			if (typeof context === "undefined") context = {};
+			if (!context.request_id) context.request_id = event?.headers?.["x-faasjs-request-id"] || (0, node_crypto.randomBytes)(16).toString("hex");
+			if (!context.request_at) context.request_at = (0, node_crypto.randomBytes)(16).toString("hex");
+			context.callbackWaitsForEmptyEventLoop = false;
+			const logger = new _faasjs_logger.Logger(context.request_id);
+			const data = {
+				event: event ?? Object.create(null),
+				context,
+				callback,
+				response: void 0,
+				logger,
+				config: this.config,
+				...this.handler ? { handler: this.handler } : {}
+			};
+			await this.invoke(data);
+			if (Object.prototype.toString.call(data.response) === "[object Error]") throw data.response;
+			return data.response;
+		};
+		return { handler: handler.bind(this) };
+	}
 };
-var plugins = [];
+let plugins = [];
 function usePlugin(plugin) {
-  if (!plugins.find((p) => p.name === plugin.name)) plugins.push(plugin);
-  if (!plugin.mount)
-    plugin.mount = async (data) => {
-      const parsedData = data || /* @__PURE__ */ Object.create(null);
-      if (!parsedData.config) parsedData.config = /* @__PURE__ */ Object.create(null);
-      if (!parsedData.context) parsedData.context = /* @__PURE__ */ Object.create(null);
-      if (!parsedData.event) parsedData.event = /* @__PURE__ */ Object.create(null);
-      if (!parsedData.logger) parsedData.logger = new logger.Logger(plugin.name);
-      if (plugin.onMount)
-        await plugin.onMount(parsedData, async () => Promise.resolve());
-      return plugin;
-    };
-  return plugin;
+	if (!plugins.find((p) => p.name === plugin.name)) plugins.push(plugin);
+	if (!plugin.mount) plugin.mount = async (data) => {
+		const parsedData = data || Object.create(null);
+		if (!parsedData.config) parsedData.config = Object.create(null);
+		if (!parsedData.context) parsedData.context = Object.create(null);
+		if (!parsedData.event) parsedData.event = Object.create(null);
+		if (!parsedData.logger) parsedData.logger = new _faasjs_logger.Logger(plugin.name);
+		if (plugin.onMount) await plugin.onMount(parsedData, async () => Promise.resolve());
+		return plugin;
+	};
+	return plugin;
 }
+/**
+* Create a cloud function.
+*
+* @example
+* ```ts
+* // pure function
+* export const func = useFunc(() => {
+*   return () => {
+*     return 'Hello World'
+*   }
+* })
+*
+* // with http
+* import { useHttp } from '@faasjs/http'
+*
+* export const func = useFunc<{
+*   params: { name: string }
+* }>(() => {
+*   useHttp()
+*
+*   return ({ event }) => {
+*     return `Hello ${event.params.name}`
+*   }
+* })
+* ```
+*/
 function useFunc(handler) {
-  plugins = [];
-  const invokeHandler = handler();
-  const func = new Func({
-    plugins,
-    handler: invokeHandler
-  });
-  plugins = [];
-  return func;
-}
-function defineFunc(handler) {
-  plugins = [];
-  const func = new Func({
-    plugins,
-    handler,
-    autoLoadPluginsFromConfig: true
-  });
-  plugins = [];
-  return func;
+	plugins = [];
+	const invokeHandler = handler();
+	const func = new Func({
+		plugins,
+		handler: invokeHandler
+	});
+	plugins = [];
+	return func;
 }
 
+//#endregion
 exports.Func = Func;
-exports.defineFunc = defineFunc;
 exports.nameFunc = nameFunc;
 exports.parseFuncFilenameFromStack = parseFuncFilenameFromStack;
 exports.useFunc = useFunc;
-exports.usePlugin = usePlugin;
+exports.usePlugin = usePlugin;