fix: export cjs and es (agenda#1298)

* fix: export cjs and es

* fix: export cjs and es renamings and add to doc

* fix: use index (=module) entrypoint for es.js

* docs: add migration note

* Add test for import vs require(). Make sure cjs can be required via destructuring. Update README a bit.

Co-authored-by: vasyl <[email protected]>

README.md

@@ -60,6 +60,21 @@ Install via NPM
 
 You will also need a working [Mongo](https://www.mongodb.com/) database (v3) to point it to.
 
+# CJS / Module Imports
+
+for regular javascript code, just use the default entrypoint
+```js
+const Agenda = require('agenda');
+```
+
+For Typescript, Webpack or other module imports, use `agenda/es` entrypoint:
+e.g.
+```ts
+import { Agenda } from 'agenda/es';
+```
+***NOTE***: If you're migrating from `@types/agenda` you also should change imports to `agenda/es`.
+Instead of `import Agenda from 'agenda'` use `import Agenda from 'agenda/es'`.
+
 # Example Usage
 
 ```js

es.js

@@ -0,0 +1 @@
+module.exports = require('./dist/index')

lib/cjs.ts

@@ -0,0 +1,5 @@
+// old common js export (see index.ts for module exports)
+
+import { Agenda } from "./agenda";
+module.exports = Agenda;
+module.exports.Agenda = Agenda;

lib/index.ts

@@ -1,3 +1,4 @@
+// module export, beware: cjs.ts is exported as main entry point!
 export * from "./agenda";
 export * from "./job";
 
@@ -7,4 +8,3 @@ export { JobOptions } from "./job/repeat-every";
 import { Agenda } from "./agenda";
 export { Agenda };
 export default Agenda;
-

package.json

@@ -2,7 +2,7 @@
   "name": "agenda",
   "version": "4.1.2",
   "description": "Light weight job scheduler for Node.js",
-  "main": "dist/index.js",
+  "main": "dist/cjs.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist"
@@ -65,6 +65,7 @@
     "delay": "5.0.0",
     "eslint": "7.18.0",
     "eslint-config-prettier": "8.1.0",
+    "esm": "^3.2.25",
     "expect.js": "0.3.1",
     "husky": "5.1.1",
     "jsdoc": "3.6.6",

test/exports.js

@@ -0,0 +1,11 @@
+describe("Exports", () => {
+  it("should export both default Agenda and { Agenda }", () => {
+    require("./imports/require.js");
+    require("./imports/require-es.js");
+
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const requireEsm = require("esm")(module /*, options*/);
+    requireEsm("./imports/import.js");
+    requireEsm("./imports/import-es.js");
+  });
+});

test/imports/import-es.js

@@ -0,0 +1,5 @@
+import assert from "assert";
+
+import Agenda1 from "../../es";
+import { Agenda as Agenda2 } from "../../es";
+assert.strictEqual(Agenda1.constructor, Agenda2.constructor); // comparing ctors, as Agenda1 is a JS Proxy in `esm`

test/imports/import.js

@@ -0,0 +1,5 @@
+import assert from "assert";
+
+import Agenda1 from "../..";
+import { Agenda as Agenda2 } from "../..";
+assert.strictEqual(Agenda1.constructor, Agenda2.constructor); // comparing ctors, as Agenda1 is a JS Proxy in `esm`

test/imports/require-es.js

@@ -0,0 +1,5 @@
+const assert = require("assert");
+
+const Agenda1 = require("../../es").default;
+const { Agenda: Agenda2 } = require("../../es");
+assert.strictEqual(Agenda1, Agenda2);

test/imports/require.js

@@ -0,0 +1,5 @@
+const assert = require("assert");
+
+const Agenda1 = require("../..");
+const { Agenda: Agenda2 } = require("../..");
+assert.strictEqual(Agenda1, Agenda2);