@faasjs/func 5.0.1 → 6.0.0-beta.0

package/README.md

@@ -19,6 +19,8 @@ npm install @faasjs/func
 
 ## Functions
 
+- [detectNodeRuntime](functions/detectNodeRuntime.md)
+- [loadPackage](functions/loadPackage.md)
 - [nameFunc](functions/nameFunc.md)
 - [useFunc](functions/useFunc.md)
 - [usePlugin](functions/usePlugin.md)

package/dist/index.cjs

@@ -3,6 +3,7 @@
 var crypto = require('crypto');
 var logger = require('@faasjs/logger');
 
+var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
 // src/index.ts
 
 // src/plugins/run_handler/index.ts
@@ -31,6 +32,30 @@ var RunHandler = class {
   }
 };
 
+// src/utils.ts
+function nameFunc(name, handler) {
+  Object.defineProperty(handler, "name", { value: name });
+  return handler;
+}
+function detectNodeRuntime() {
+  if (typeof globalThis.require === "function" && typeof module !== "undefined")
+    return "commonjs";
+  if (typeof ({ url: (typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href)) }) !== "undefined") return "module";
+  throw Error("Unknown runtime");
+}
+async function loadPackage(name) {
+  const runtime = detectNodeRuntime();
+  if (runtime === "module") {
+    const module2 = await import(name);
+    return module2.default ? module2.default : module2;
+  }
+  if (runtime === "commonjs") {
+    const module2 = globalThis.require(name);
+    return module2.default ? module2.default : module2;
+  }
+  throw Error("Unknown runtime");
+}
+
 // src/index.ts
 var Func = class {
   plugins;
@@ -154,7 +179,7 @@ var Func = class {
         event,
         context,
         callback,
-        response: void 0,
+        response: undefined,
         handler: this.handler,
         logger: logger$1,
         config: this.config
@@ -195,12 +220,10 @@ function useFunc(handler) {
   plugins = [];
   return func;
 }
-function nameFunc(name, handler) {
-  Object.defineProperty(handler, "name", { value: name });
-  return handler;
-}
 
 exports.Func = Func;
+exports.detectNodeRuntime = detectNodeRuntime;
+exports.loadPackage = loadPackage;
 exports.nameFunc = nameFunc;
 exports.useFunc = useFunc;
 exports.usePlugin = usePlugin;

package/dist/index.d.ts

@@ -1,5 +1,48 @@
 import { Logger } from '@faasjs/logger';
 
+/**
+ * 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'
+ * ```
+ */
+declare function nameFunc<T extends (...args: any[]) => any>(name: string, handler: T): T;
+/**
+ * Detect the current JavaScript runtime environment.
+ *
+ * This function checks for the presence of `import.meta` and `require` to determine
+ * whether the runtime is using ECMAScript modules (ESM) or CommonJS modules (CJS).
+ *
+ * @returns {'commonjs' | 'module'} - Returns 'module' if the runtime is using ECMAScript modules,
+ *                            and 'cjs' if the runtime is using CommonJS modules.
+ * @throws {Error} - Throws an error if the runtime cannot be determined.
+ */
+declare function detectNodeRuntime(): 'commonjs' | 'module';
+/**
+ * Load a package dynamically based on the Node.js runtime environment.
+ *
+ * This function detects the current Node.js runtime (either 'module' or 'commonjs') and loads the specified package accordingly.
+ *
+ * @template T - The type of the module to be loaded.
+ * @param {string} name - The name of the package to load.
+ * @returns {Promise<T>} A promise that resolves to the loaded package.
+ * @throws {Error} If the runtime is neither 'module' nor 'commonjs'.
+ */
+declare function loadPackage<T = unknown>(name: string): Promise<T>;
+
 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>;
@@ -139,25 +182,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>;
-/**
- * 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'
- * ```
- */
-declare function nameFunc<T extends (...args: any[]) => any>(name: string, handler: T): T;
 
-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, Func, type FuncConfig, type FuncEventType, type FuncReturnType, type Handler, type InvokeData, type LifeCycleKey, type MountData, type Next, type Plugin, type UseifyPlugin, detectNodeRuntime, loadPackage, nameFunc, useFunc, usePlugin };

package/dist/index.mjs

@@ -29,6 +29,30 @@ var RunHandler = class {
   }
 };
 
+// src/utils.ts
+function nameFunc(name, handler) {
+  Object.defineProperty(handler, "name", { value: name });
+  return handler;
+}
+function detectNodeRuntime() {
+  if (typeof globalThis.require === "function" && typeof module !== "undefined")
+    return "commonjs";
+  if (typeof import.meta !== "undefined") return "module";
+  throw Error("Unknown runtime");
+}
+async function loadPackage(name) {
+  const runtime = detectNodeRuntime();
+  if (runtime === "module") {
+    const module2 = await import(name);
+    return module2.default ? module2.default : module2;
+  }
+  if (runtime === "commonjs") {
+    const module2 = globalThis.require(name);
+    return module2.default ? module2.default : module2;
+  }
+  throw Error("Unknown runtime");
+}
+
 // src/index.ts
 var Func = class {
   plugins;
@@ -152,7 +176,7 @@ var Func = class {
         event,
         context,
         callback,
-        response: void 0,
+        response: undefined,
         handler: this.handler,
         logger,
         config: this.config
@@ -193,9 +217,5 @@ function useFunc(handler) {
   plugins = [];
   return func;
 }
-function nameFunc(name, handler) {
-  Object.defineProperty(handler, "name", { value: name });
-  return handler;
-}
 
-export { Func, nameFunc, useFunc, usePlugin };
+export { Func, detectNodeRuntime, loadPackage, nameFunc, useFunc, usePlugin };

package/package.json

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