Initial commit

Author: Borewit

.gitignore

@@ -0,0 +1,11 @@
+# Project
+node_modules/
+
+#IntelliJ IDEA:
+.idea
+*.iml
+
+# Yarn:
+.pnp.*
+.yarn
+yarn-error.log

README.md

@@ -0,0 +1,84 @@
+# load-esm
+
+***load-esm*** is a utility for dynamically importing pure ESM (ECMAScript Module) packages in CommonJS TypeScript projects.
+This is particularly useful when working with Node.js environments configured for CommonJS while needing to integrate ESM-only dependencies.
+
+## Installation
+```bash
+npm install load-esm
+```
+
+or
+
+```bash
+yarn add load-esm
+```
+
+## Features
+- Enables dynamic import of pure ESM modules in CommonJS-based projects.
+- Compatible with TypeScript, offering proper type definitions.
+- Simple and lightweight implementation.
+
+## Usage
+
+Here’s an example demonstrating how to use load-esm to dynamically load an ESM module in a CommonJS project:
+
+```ts
+import * as path from 'path';
+import { loadModule } from 'load-esm';
+
+/**
+ * Import 'file-type' ES-Module in CommonJS Node.js module
+ */
+(async () => {
+    try {
+        // Dynamically import the ESM module
+        const { fileTypeFromFile } = await loadModule('file-type');
+
+        // Use the imported function
+        const type = await fileTypeFromFile('fixture.gif');
+        console.log(type);
+    } catch (error) {
+        console.error('Error importing module:', error);
+    }
+})();
+```
+
+## API
+
+```ts
+loadModule<T = any>(name: string): Promise<T>
+```
+Dynamically imports an ESM module.
+
+#### Parameters
+- `name` (string): The name or path of the module to load.
+
+#### Returns
+- A `Promise<T>` that resolves to the imported module object.
+  
+### Example
+```ts
+import { loadModule } from 'load-esm';
+
+(async () => {
+  const module = await loadModule('some-esm-module');
+  console.log(module);
+})();
+```
+
+## How It Works
+The utility leverages Node.js's import() function to dynamically load ESM modules.
+This allows CommonJS-based projects to interact with ESM dependencies without converting the entire project to ESM.
+
+## Compatibility
+- Node.js: Requires Node.js 13.2.0 or later, as import() is only supported in these versions and beyond.
+- TypeScript: Fully typed and compatible with TypeScript.
+
+## Why Use load-esm?
+In mixed-module environments where your project is primarily CommonJS but relies on some ESM-only dependencies,
+load-esm serves as a seamless bridge,
+enabling interoperability without changing your project’s module system.
+
+## License
+[MIT](./LICENSE)

index.cjs.js

@@ -0,0 +1,3 @@
+module.exports = {
+    loadModule: (module) => import(module)
+};

index.d.ts

@@ -0,0 +1 @@
+export function loadModule<T = any>(name: string): Promise<T>;

package.json

@@ -0,0 +1,45 @@
+{
+  "name": "load-esm",
+  "version": "0.1.0",
+  "main": "index.cjs",
+  "types": "index.d.ts",
+  "author": {
+    "name": "Borewit",
+    "url": "https://github.com/Borewit"
+  },
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/Borewit"
+    },
+    {
+      "type": "buymeacoffee",
+      "url": "https://buymeacoffee.com/borewit"
+    }
+  ],
+  "license": "MIT",
+  "description": "Utility to dynamically load ESM modules in TypeScript CommonJS projects",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Borewit/load-esm.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Borewit/load-esm/issues"
+  },
+  "homepage": "https://github.com/Borewit/load-esm#readme",
+  "keywords": [
+    "load-esm",
+    "ESM",
+    "CommonJS",
+    "TypeScript",
+    "Node.js",
+    "dynamic import",
+    "JavaScript modules",
+    "module interoperability",
+    "mixed-module environment"
+  ],
+  "engines": {
+    "node": ">=13.2.0"
+  },
+  "dependencies": {}
+}