feat: support CJS and ESM (#601)

.eslintignore

@@ -4,4 +4,5 @@ jest.setup.ts
 jest.config.js
 commitlint.config.js
 .eslintrc.js
-webpack.config.js
+webpack.config.js
+scripts

jest.config.mjs

@@ -1,4 +1,4 @@
-const unmockedDependencies = ['query-string', 'decode-uri-component', 'split-on-first', 'filter-obj'];
+const unmockedDependencies = ['query-string-esm', 'decode-uri-component', 'split-on-first', 'filter-obj'];
 
 // /*
 //  * For a detailed explanation regarding each configuration property, visit:
@@ -19,6 +19,7 @@ export default {
             preset: 'ts-jest/presets/default-esm',
             moduleNameMapper: {
                 '^(\\.{1,2}/.*)\\.js$': '$1',
+                '^#query-string': 'query-string-esm',
             },
             globals: {'ts-jest': {tsconfig: '<rootDir>/../tsconfig.test.json', useESM: true}},
             transform: {

package.json

@@ -2,9 +2,16 @@
     "name": "@coveo/platform-client",
     "version": "0.0.0-development",
     "description": "",
-    "main": "dist/Entry.js",
     "type": "module",
-    "types": "dist/definitions/Entry.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/types/Entry.d.ts",
+            "import": "./dist/esm/Entry.js",
+            "require": "./dist/cjs/Entry.js"
+        }
+    },
+    "types": "dist/types/Entry.d.ts",
+    "main": "dist/cjs/Entry.js",
     "keywords": [
         "coveo",
         "api",
@@ -14,8 +21,8 @@
         "web"
     ],
     "scripts": {
-        "start": "tsc -p tsconfig.build.json --watch",
-        "build": "eslint \"src/**.*\" --ignore-pattern '**/*.spec.*' --color && tsc -p tsconfig.build.json",
+        "start": "tsc -p tsconfig.build.esm.json --watch",
+        "build": "eslint \"src/**.*\" --ignore-pattern '**/*.spec.*' --color && tsc -p tsconfig.build.cjs.json && tsc -p tsconfig.build.esm.json && node scripts/dualOutputCompat.js",
         "test": "jest --clearCache && jest",
         "test:changed": "jest --watch",
         "test:watch": "jest --watchAll",
@@ -74,9 +81,16 @@
             "path": "./node_modules/cz-conventional-changelog"
         }
     },
+    "imports": {
+        "#query-string": {
+            "import": "query-string-esm",
+            "require": "query-string-cjs"
+        }
+    },
     "dependencies": {
         "exponential-backoff": "^3.1.0",
-        "query-string": "^8.0.0"
+        "query-string-esm": "npm:query-string@^8.0.0",
+        "query-string-cjs": "npm:query-string@^7.0.0"
     },
     "publishConfig": {
         "access": "public"

scripts/dualOutputCompat.js

@@ -0,0 +1,23 @@
+import {readFileSync, writeFileSync} from 'node:fs';
+
+// Ensure NodeJS resolves dist/cjs/**/*.js as dist/cjs/**/*.cjs
+writeFileSync(
+    'dist/cjs/package.json',
+    JSON.stringify({
+        type: 'commonjs',
+    })
+);
+
+// Ensure NodeJS resolves dist/esm/**/*.js as dist/esm/**/*.mjs
+writeFileSync(
+    'dist/esm/package.json',
+    JSON.stringify({
+        type: 'module',
+    })
+);
+
+// Replace #query-string by the proper query-string version.
+const cjsPath = 'dist/cjs/resources/Resource.js';
+writeFileSync(cjsPath, readFileSync(cjsPath, 'utf-8').replaceAll(/#query-string/gm, 'query-string-cjs'));
+const esmPath = 'dist/esm/resources/Resource.js';
+writeFileSync(esmPath, readFileSync(esmPath, 'utf-8').replaceAll(/#query-string/gm, 'query-string-esm'));

src/resources/Resource.ts

@@ -1,6 +1,5 @@
-import queryString from 'query-string';
-
 import API from '../APICore.js';
+import queryString from '#query-string';
 
 class Resource {
     static baseUrl: string;

tsconfig.build.cjs.json

@@ -0,0 +1,9 @@
+{
+    "extends": "./tsconfig",
+    "include": ["src/*"],
+    "exclude": ["node_modules"],
+    "compilerOptions": {
+        "module": "CommonJS",
+        "outDir": "dist/cjs"
+    }
+}

tsconfig.build.esm.json

@@ -0,0 +1,8 @@
+{
+    "extends": "./tsconfig",
+    "include": ["src/*"],
+    "exclude": ["node_modules"],
+    "compilerOptions": {
+        "outDir": "dist/esm"
+    }
+}

tsconfig.json

@@ -7,7 +7,7 @@
         "sourceMap": true,
         "declaration": true,
         "target": "ESNext",
-        "declarationDir": "dist/definitions",
+        "declarationDir": "dist/types",
         "lib": ["DOM", "ESNext"],
         "moduleResolution": "Node16",
         "importHelpers": true,