feat(core): add support for ESM via gen-esm-wrapper

Closes #1010
mikro-orm · Apr 17, 2021 · aa71065 · aa71065
1 parent ff280bc
commit aa71065
Show file tree

Hide file tree

Showing 15 changed files with 159 additions and 16 deletions.
diff --git a/package.json b/package.json
@@ -91,11 +91,15 @@
     "semanticCommits": "enabled",
     "packageRules": [
       {
-        "depTypeList": ["devDependencies"],
+        "depTypeList": [
+          "devDependencies"
+        ],
         "automerge": true
       }
     ],
-    "schedule": ["every weekday"]
+    "schedule": [
+      "every weekday"
+    ]
   },
   "engines": {
     "node": ">= 12.17.0 || >= 13.10.0"
@@ -121,6 +125,7 @@
     "eslint": "7.24.0",
     "eslint-plugin-jsdoc": "32.3.0",
     "fs-extra": "9.1.0",
+    "gen-esm-wrapper": "^1.1.1",
     "husky": "6.0.0",
     "jest": "26.6.3",
     "lerna": "4.0.0",

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -3,7 +3,14 @@
   "version": "4.5.3",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "main": "dist/index.js",
+  "module": "dist/index.mjs",
   "typings": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/mikro-orm/mikro-orm.git"
@@ -38,10 +45,11 @@
     "mikro-orm": "./dist/cli.js"
   },
   "engines": {
-    "node": ">= 10.13.0"
+    "node": ">= 12.17.0 || >= 13.10.0"
   },
   "scripts": {
     "build": "yarn clean && yarn compile && yarn copy",
+    "postbuild": "yarn gen-esm-wrapper dist/index.js dist/index.mjs",
     "clean": "rimraf ./dist",
     "compile": "tsc -p tsconfig.build.json",
     "copy": "ts-node -T ../../scripts/copy.ts"

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -3,7 +3,14 @@
   "version": "4.5.3",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "main": "dist/index.js",
+  "module": "dist/index.mjs",
   "typings": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/mikro-orm/mikro-orm.git"
@@ -35,10 +42,11 @@
   },
   "homepage": "https://mikro-orm.io",
   "engines": {
-    "node": ">= 10.13.0"
+    "node": ">= 12.17.0 || >= 13.10.0"
   },
   "scripts": {
     "build": "yarn clean && yarn compile && yarn copy",
+    "postbuild": "yarn gen-esm-wrapper dist/index.js dist/index.mjs",
     "clean": "rimraf ./dist",
     "compile": "tsc -p tsconfig.build.json",
     "copy": "ts-node -T ../../scripts/copy.ts"

diff --git a/packages/entity-generator/package.json b/packages/entity-generator/package.json
@@ -3,7 +3,14 @@
   "version": "4.5.3",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "main": "dist/index.js",
+  "module": "dist/index.mjs",
   "typings": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/mikro-orm/mikro-orm.git"
@@ -35,10 +42,11 @@
   },
   "homepage": "https://mikro-orm.io",
   "engines": {
-    "node": ">= 10.13.0"
+    "node": ">= 12.17.0 || >= 13.10.0"
   },
   "scripts": {
     "build": "yarn clean && yarn compile && yarn copy",
+    "postbuild": "yarn gen-esm-wrapper dist/index.js dist/index.mjs",
     "clean": "rimraf ./dist",
     "compile": "tsc -p tsconfig.build.json",
     "copy": "ts-node -T ../../scripts/copy.ts"

diff --git a/packages/knex/package.json b/packages/knex/package.json
@@ -3,7 +3,14 @@
   "version": "4.5.3",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "main": "dist/index.js",
+  "module": "dist/index.mjs",
   "typings": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/mikro-orm/mikro-orm.git"
@@ -35,10 +42,11 @@
   },
   "homepage": "https://mikro-orm.io",
   "engines": {
-    "node": ">= 10.13.0"
+    "node": ">= 12.17.0 || >= 13.10.0"
   },
   "scripts": {
     "build": "yarn clean && yarn compile && yarn copy",
+    "postbuild": "yarn gen-esm-wrapper dist/index.js dist/index.mjs",
     "clean": "rimraf ./dist",
     "compile": "tsc -p tsconfig.build.json",
     "copy": "ts-node -T ../../scripts/copy.ts"

diff --git a/packages/mariadb/package.json b/packages/mariadb/package.json
@@ -3,7 +3,14 @@
   "version": "4.5.3",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "main": "dist/index.js",
+  "module": "dist/index.mjs",
   "typings": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/mikro-orm/mikro-orm.git"
@@ -35,10 +42,11 @@
   },
   "homepage": "https://mikro-orm.io",
   "engines": {
-    "node": ">= 10.13.0"
+    "node": ">= 12.17.0 || >= 13.10.0"
   },
   "scripts": {
     "build": "yarn clean && yarn compile && yarn copy",
+    "postbuild": "yarn gen-esm-wrapper dist/index.js dist/index.mjs",
     "clean": "rimraf ./dist",
     "compile": "tsc -p tsconfig.build.json",
     "copy": "ts-node -T ../../scripts/copy.ts"

diff --git a/packages/migrations/package.json b/packages/migrations/package.json
@@ -3,7 +3,14 @@
   "version": "4.5.3",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "main": "dist/index.js",
+  "module": "dist/index.mjs",
   "typings": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/mikro-orm/mikro-orm.git"
@@ -35,10 +42,11 @@
   },
   "homepage": "https://mikro-orm.io",
   "engines": {
-    "node": ">= 10.13.0"
+    "node": ">= 12.17.0 || >= 13.10.0"
   },
   "scripts": {
     "build": "yarn clean && yarn compile && yarn copy",
+    "postbuild": "yarn gen-esm-wrapper dist/index.js dist/index.mjs",
     "clean": "rimraf ./dist",
     "compile": "tsc -p tsconfig.build.json",
     "copy": "ts-node -T ../../scripts/copy.ts"

diff --git a/packages/mikro-orm/package.json b/packages/mikro-orm/package.json
@@ -3,7 +3,14 @@
   "version": "4.5.3",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "main": "dist/index.js",
+  "module": "dist/index.mjs",
   "typings": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/mikro-orm/mikro-orm.git"
@@ -35,10 +42,11 @@
   },
   "homepage": "https://mikro-orm.io",
   "engines": {
-    "node": ">= 10.13.0"
+    "node": ">= 12.17.0 || >= 13.10.0"
   },
   "scripts": {
     "build": "yarn clean && yarn compile && yarn copy",
+    "postbuild": "yarn gen-esm-wrapper dist/index.js dist/index.mjs",
     "clean": "rimraf ./dist",
     "compile": "tsc -p tsconfig.build.json",
     "copy": "ts-node -T ../../scripts/copy.ts"

diff --git a/packages/mongodb/package.json b/packages/mongodb/package.json
@@ -3,7 +3,14 @@
   "version": "4.5.3",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "main": "dist/index.js",
+  "module": "dist/index.mjs",
   "typings": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/mikro-orm/mikro-orm.git"
@@ -35,10 +42,11 @@
   },
   "homepage": "https://mikro-orm.io",
   "engines": {
-    "node": ">= 10.13.0"
+    "node": ">= 12.17.0 || >= 13.10.0"
   },
   "scripts": {
     "build": "yarn clean && yarn compile && yarn copy",
+    "postbuild": "yarn gen-esm-wrapper dist/index.js dist/index.mjs",
     "clean": "rimraf ./dist",
     "compile": "tsc -p tsconfig.build.json",
     "copy": "ts-node -T ../../scripts/copy.ts"

diff --git a/packages/mysql-base/package.json b/packages/mysql-base/package.json
@@ -3,7 +3,14 @@
   "version": "4.5.3",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "main": "dist/index.js",
+  "module": "dist/index.mjs",
   "typings": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/mikro-orm/mikro-orm.git"
@@ -35,10 +42,11 @@
   },
   "homepage": "https://mikro-orm.io",
   "engines": {
-    "node": ">= 10.13.0"
+    "node": ">= 12.17.0 || >= 13.10.0"
   },
   "scripts": {
     "build": "yarn clean && yarn compile && yarn copy",
+    "postbuild": "yarn gen-esm-wrapper dist/index.js dist/index.mjs",
     "clean": "rimraf ./dist",
     "compile": "tsc -p tsconfig.build.json",
     "copy": "ts-node -T ../../scripts/copy.ts"

diff --git a/packages/mysql/package.json b/packages/mysql/package.json
@@ -3,7 +3,14 @@
   "version": "4.5.3",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "main": "dist/index.js",
+  "module": "dist/index.mjs",
   "typings": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/mikro-orm/mikro-orm.git"
@@ -35,10 +42,11 @@
   },
   "homepage": "https://mikro-orm.io",
   "engines": {
-    "node": ">= 10.13.0"
+    "node": ">= 12.17.0 || >= 13.10.0"
   },
   "scripts": {
     "build": "yarn clean && yarn compile && yarn copy",
+    "postbuild": "yarn gen-esm-wrapper dist/index.js dist/index.mjs",
     "clean": "rimraf ./dist",
     "compile": "tsc -p tsconfig.build.json",
     "copy": "ts-node -T ../../scripts/copy.ts"

diff --git a/packages/postgresql/package.json b/packages/postgresql/package.json
@@ -3,7 +3,14 @@
   "version": "4.5.3",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "main": "dist/index.js",
+  "module": "dist/index.mjs",
   "typings": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/mikro-orm/mikro-orm.git"
@@ -35,10 +42,11 @@
   },
   "homepage": "https://mikro-orm.io",
   "engines": {
-    "node": ">= 10.13.0"
+    "node": ">= 12.17.0 || >= 13.10.0"
   },
   "scripts": {
     "build": "yarn clean && yarn compile && yarn copy",
+    "postbuild": "yarn gen-esm-wrapper dist/index.js dist/index.mjs",
     "clean": "rimraf ./dist",
     "compile": "tsc -p tsconfig.build.json",
     "copy": "ts-node -T ../../scripts/copy.ts"

diff --git a/packages/reflection/package.json b/packages/reflection/package.json
@@ -3,7 +3,14 @@
   "version": "4.5.3",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "main": "dist/index.js",
+  "module": "dist/index.mjs",
   "typings": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/mikro-orm/mikro-orm.git"
@@ -35,10 +42,11 @@
   },
   "homepage": "https://mikro-orm.io",
   "engines": {
-    "node": ">= 10.13.0"
+    "node": ">= 12.17.0 || >= 13.10.0"
   },
   "scripts": {
     "build": "yarn clean && yarn compile && yarn copy",
+    "postbuild": "yarn gen-esm-wrapper dist/index.js dist/index.mjs",
     "clean": "rimraf ./dist",
     "compile": "tsc -p tsconfig.build.json",
     "copy": "ts-node -T ../../scripts/copy.ts"

diff --git a/packages/sqlite/package.json b/packages/sqlite/package.json
@@ -3,7 +3,14 @@
   "version": "4.5.3",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "main": "dist/index.js",
+  "module": "dist/index.mjs",
   "typings": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+ssh://git@github.com/mikro-orm/mikro-orm.git"
@@ -35,10 +42,11 @@
   },
   "homepage": "https://mikro-orm.io",
   "engines": {
-    "node": ">= 10.13.0"
+    "node": ">= 12.17.0 || >= 13.10.0"
   },
   "scripts": {
     "build": "yarn clean && yarn compile && yarn copy",
+    "postbuild": "yarn gen-esm-wrapper dist/index.js dist/index.mjs",
     "clean": "rimraf ./dist",
     "compile": "tsc -p tsconfig.build.json",
     "copy": "ts-node -T ../../scripts/copy.ts"