@faasjs/load 6.0.0-beta.0 → 6.0.0-beta.1

package/README.md

@@ -13,4 +13,10 @@ npm install @faasjs/load
 
 ## Functions
 
+- [detectNodeRuntime](functions/detectNodeRuntime.md)
 - [loadConfig](functions/loadConfig.md)
+- [loadPackage](functions/loadPackage.md)
+
+## Type Aliases
+
+- [NodeRuntime](type-aliases/NodeRuntime.md)

package/dist/index.cjs

@@ -3,9 +3,10 @@
 var fs = require('fs');
 var path = require('path');
 var deep_merge = require('@faasjs/deep_merge');
-var logger = require('@faasjs/logger');
+var logger$1 = require('@faasjs/logger');
 var jsYaml = require('js-yaml');
 
+var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
 // src/load_config.ts
 var Config = class {
   root;
@@ -13,9 +14,9 @@ var Config = class {
   origin;
   defaults;
   logger;
-  constructor(root, filename, logger$1) {
-    this.logger = new logger.Logger(
-      logger$1?.label ? `${logger$1.label}] [config` : "config"
+  constructor(root, filename, logger2) {
+    this.logger = new logger$1.Logger(
+      logger2?.label ? `${logger2.label}] [config` : "config"
     );
     this.root = root;
     if (!this.root.endsWith(path.sep)) this.root += path.sep;
@@ -52,8 +53,55 @@ var Config = class {
     return this[key] || this.defaults || /* @__PURE__ */ Object.create(null);
   }
 };
-function loadConfig(root, filename, staging, logger) {
-  return new Config(root, filename, logger).get(staging);
+function loadConfig(root, filename, staging, logger2) {
+  return new Config(root, filename, logger2).get(staging);
+}
+var _runtime = null;
+function detectNodeRuntime() {
+  if (_runtime) return _runtime;
+  if (typeof globalThis.require === "function" && typeof module !== "undefined")
+    return _runtime = "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 _runtime = "module";
+  throw Error("Unknown runtime");
+}
+var tsxLoaded = null;
+var logger = new logger$1.Logger("loadPackage");
+async function loadPackage(name) {
+  const runtime = detectNodeRuntime();
+  let module2;
+  if (runtime === "module") {
+    if (tsxLoaded === null) {
+      try {
+        await import('tsx');
+        tsxLoaded = true;
+      } catch (_) {
+        tsxLoaded = false;
+        logger.warn(
+          'Recommend installing the "tsx" package for loading ts/tsx files'
+        );
+      }
+    }
+    module2 = await import(name);
+    return module2.default ? module2.default : module2;
+  }
+  if (runtime === "commonjs") {
+    if (tsxLoaded === null) {
+      try {
+        globalThis.require("tsx");
+        tsxLoaded = true;
+      } catch (_) {
+        tsxLoaded = false;
+        logger.warn(
+          'Recommend installing the "tsx" package for loading ts/tsx files'
+        );
+      }
+    }
+    module2 = globalThis.require(name);
+    return module2.default ? module2.default : module2;
+  }
+  throw Error("Unknown runtime");
 }
 
+exports.detectNodeRuntime = detectNodeRuntime;
 exports.loadConfig = loadConfig;
+exports.loadPackage = loadPackage;

package/dist/index.d.ts

@@ -6,4 +6,33 @@ import { Logger } from '@faasjs/logger';
  */
 declare function loadConfig(root: string, filename: string, staging: string, logger?: Logger): Config;
 
-export { loadConfig };
+type NodeRuntime = 'commonjs' | 'module';
+/**
+ * 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 {NodeRuntime} - 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(): NodeRuntime;
+/**
+ * Asynchronously loads a package by its name, supporting both ESM and CommonJS runtimes.
+ *
+ * Also supports loading TypeScript and TSX files by checking for the presence of the "tsx" package.
+ *
+ * @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 module.
+ * @throws {Error} If the runtime is unknown.
+ *
+ * @example
+ * ```typescript
+ * const myModule = await loadPackage<MyModuleType>('my-module');
+ * ```
+ */
+declare function loadPackage<T = unknown>(name: string): Promise<T>;
+
+export { type NodeRuntime, detectNodeRuntime, loadConfig, loadPackage };

package/dist/index.mjs

@@ -11,9 +11,9 @@ var Config = class {
   origin;
   defaults;
   logger;
-  constructor(root, filename, logger) {
+  constructor(root, filename, logger2) {
     this.logger = new Logger(
-      logger?.label ? `${logger.label}] [config` : "config"
+      logger2?.label ? `${logger2.label}] [config` : "config"
     );
     this.root = root;
     if (!this.root.endsWith(sep)) this.root += sep;
@@ -50,8 +50,53 @@ var Config = class {
     return this[key] || this.defaults || /* @__PURE__ */ Object.create(null);
   }
 };
-function loadConfig(root, filename, staging, logger) {
-  return new Config(root, filename, logger).get(staging);
+function loadConfig(root, filename, staging, logger2) {
+  return new Config(root, filename, logger2).get(staging);
+}
+var _runtime = null;
+function detectNodeRuntime() {
+  if (_runtime) return _runtime;
+  if (typeof globalThis.require === "function" && typeof module !== "undefined")
+    return _runtime = "commonjs";
+  if (typeof import.meta !== "undefined") return _runtime = "module";
+  throw Error("Unknown runtime");
+}
+var tsxLoaded = null;
+var logger = new Logger("loadPackage");
+async function loadPackage(name) {
+  const runtime = detectNodeRuntime();
+  let module2;
+  if (runtime === "module") {
+    if (tsxLoaded === null) {
+      try {
+        await import('tsx');
+        tsxLoaded = true;
+      } catch (_) {
+        tsxLoaded = false;
+        logger.warn(
+          'Recommend installing the "tsx" package for loading ts/tsx files'
+        );
+      }
+    }
+    module2 = await import(name);
+    return module2.default ? module2.default : module2;
+  }
+  if (runtime === "commonjs") {
+    if (tsxLoaded === null) {
+      try {
+        globalThis.require("tsx");
+        tsxLoaded = true;
+      } catch (_) {
+        tsxLoaded = false;
+        logger.warn(
+          'Recommend installing the "tsx" package for loading ts/tsx files'
+        );
+      }
+    }
+    module2 = globalThis.require(name);
+    return module2.default ? module2.default : module2;
+  }
+  throw Error("Unknown runtime");
 }
 
-export { loadConfig };
+export { detectNodeRuntime, loadConfig, loadPackage };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/load",
-  "version": "6.0.0-beta.0",
+  "version": "6.0.0-beta.1",
   "license": "MIT",
   "type": "module",
   "main": "dist/index.cjs",
@@ -31,14 +31,16 @@
   ],
   "peerDependencies": {
     "js-yaml": "*",
-    "@faasjs/deep_merge": "6.0.0-beta.0",
-    "@faasjs/func": "6.0.0-beta.0"
+    "tsx": "*",
+    "@faasjs/deep_merge": "6.0.0-beta.1",
+    "@faasjs/func": "6.0.0-beta.1"
   },
   "devDependencies": {
     "js-yaml": "*",
+    "tsx": "*",
     "@types/js-yaml": "*",
-    "@faasjs/deep_merge": "6.0.0-beta.0",
-    "@faasjs/func": "6.0.0-beta.0"
+    "@faasjs/deep_merge": "6.0.0-beta.1",
+    "@faasjs/func": "6.0.0-beta.1"
   },
   "engines": {
     "node": ">=22.0.0",