build: export ES module as well as CommonJS

universal-geocoder · Dec 18, 2020 · ac23a2f · ac23a2f
1 parent d316764
commit ac23a2f
Show file tree

Hide file tree

Showing 14 changed files with 38 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -36,7 +36,7 @@ npm install --save universal-geocoder
 Usage
 -----
 
-You can either use Universal Geocoder as a module or as a direct dependency.
+You can either use Universal Geocoder as a module (both CommonJS and ES module syntaxes are provided) or as a direct dependency.
 
 As a module:
 

diff --git a/example/node/bing.ts b/example/node/bing.ts
@@ -1,6 +1,6 @@
 /* eslint-disable no-console */
-import UniversalGeocoder from "../../dist/UniversalGeocoder";
-import GeoJsonDumper from "../../dist/GeoJsonDumper";
+import UniversalGeocoder from "../../dist/cjs/UniversalGeocoder";
+import GeoJsonDumper from "../../dist/cjs/GeoJsonDumper";
 
 const bingGeocoder = UniversalGeocoder.createGeocoder({
   provider: "bing",

diff --git a/example/node/chain.ts b/example/node/chain.ts
@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-import UniversalGeocoder from "../../dist/UniversalGeocoder";
+import UniversalGeocoder from "../../dist/cjs/UniversalGeocoder";
 
 const yandexGeocoder = UniversalGeocoder.createGeocoder("yandex");
 const openStreetMapGeocoder = UniversalGeocoder.createGeocoder({

diff --git a/example/node/geoplugin.ts b/example/node/geoplugin.ts
@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-import UniversalGeocoder from "../../dist/UniversalGeocoder";
+import UniversalGeocoder from "../../dist/cjs/UniversalGeocoder";
 
 const geoPluginGeocoder = UniversalGeocoder.createGeocoder({
   provider: "geoplugin",

diff --git a/example/node/googlemaps.ts b/example/node/googlemaps.ts
@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-import UniversalGeocoder from "../../dist/UniversalGeocoder";
+import UniversalGeocoder from "../../dist/cjs/UniversalGeocoder";
 
 const googleGeocoder = UniversalGeocoder.createGeocoder({
   provider: "googlemaps",

diff --git a/example/node/mapbox.ts b/example/node/mapbox.ts
@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-import UniversalGeocoder from "../../dist/UniversalGeocoder";
+import UniversalGeocoder from "../../dist/cjs/UniversalGeocoder";
 
 const mapboxGeocoder = UniversalGeocoder.createGeocoder({ provider: "mapbox" });
 

diff --git a/example/node/mapquest.ts b/example/node/mapquest.ts
@@ -1,7 +1,10 @@
 /* eslint-disable no-console */
-import UniversalGeocoder from "../../dist/UniversalGeocoder";
-import Geocoded from "../../dist/Geocoded";
-import { MapQuestGeocodeQuery, MapQuestLocation } from "../../dist/provider";
+import UniversalGeocoder from "../../dist/cjs/UniversalGeocoder";
+import Geocoded from "../../dist/cjs/Geocoded";
+import {
+  MapQuestGeocodeQuery,
+  MapQuestLocation,
+} from "../../dist/cjs/provider";
 
 let mapQuestGeocoder = UniversalGeocoder.createGeocoder({
   provider: "mapquest",

diff --git a/example/node/opencage.ts b/example/node/opencage.ts
@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-import UniversalGeocoder from "../../dist/UniversalGeocoder";
+import UniversalGeocoder from "../../dist/cjs/UniversalGeocoder";
 
 const openCageGeocoder = UniversalGeocoder.createGeocoder({
   provider: "opencage",

diff --git a/example/node/openstreetmap.ts b/example/node/openstreetmap.ts
@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-import UniversalGeocoder from "../../dist/UniversalGeocoder";
+import UniversalGeocoder from "../../dist/cjs/UniversalGeocoder";
 
 const openStreetMapGeocoder = UniversalGeocoder.createGeocoder({
   provider: "openstreetmap",

diff --git a/example/node/yandex.ts b/example/node/yandex.ts
@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-import UniversalGeocoder from "../../dist/UniversalGeocoder";
+import UniversalGeocoder from "../../dist/cjs/UniversalGeocoder";
 
 const yandexGeocoder = UniversalGeocoder.createGeocoder("yandex");
 

diff --git a/package.json b/package.json
@@ -26,7 +26,12 @@
     "type": "git",
     "url": "git+https://github.com/universal-geocoder/universal-geocoder-js.git"
   },
-  "main": "dist/index.js",
+  "main": "./dist/cjs/index.js",
+  "exports": {
+    "import": "./dist/esm/index.js",
+    "require": "./dist/cjs/index.js"
+  },
+  "module": "./dist/esm/index.js",
   "types": "types/index.d.ts",
   "files": [
     "/dist",
@@ -78,13 +83,13 @@
     "webpack-merge": "^5.1.0"
   },
   "scripts": {
-    "build": "rm -rf types && rm -rf dist && webpack --config webpack.dev.js && webpack --config webpack.prod.js && ttsc",
+    "build": "rm -rf types && rm -rf dist && webpack --config webpack.dev.js && webpack --config webpack.prod.js && ttsc -p tsconfig-cjs.json && ttsc",
     "coverage": "nyc npm test",
     "coverage-lcov": "nyc --reporter=lcov npm test",
     "lint": "eslint --fix --ext .ts .",
     "prepublishOnly": "npm run build",
     "serve": "http-server",
-    "test": "ts-node --compiler ttypescript -r tsconfig-paths/register node_modules/.bin/jasmine",
+    "test": "ts-node --project tsconfig-cjs.json --compiler ttypescript -r tsconfig-paths/register node_modules/.bin/jasmine",
     "test-record": "POLLY_RECORD=1 npm test",
     "ts-node": "ts-node --skip-project",
     "watch": "webpack --config webpack.dev.js --watch"

diff --git a/src/ExternalLoader.ts b/src/ExternalLoader.ts
@@ -105,7 +105,7 @@ export default class ExternalLoader implements ExternalLoaderInterface {
       method,
       body: method === "POST" ? JSON.stringify(body) : undefined,
     })
-      .then((response) => {
+      .then((response: Response) => {
         if (!response.ok) {
           throw new ResponseError(
             `Received HTTP status code ${response.status} when attempting geocoding request.`,
@@ -114,8 +114,9 @@ export default class ExternalLoader implements ExternalLoaderInterface {
         }
         return response.json();
       })
-      .then((data) => callback(data))
-      .catch((error) => {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      .then((data: any) => callback(data))
+      .catch((error: Error | ResponseError) => {
         if (errorCallback && error instanceof ResponseError) {
           errorCallback(error);
           return;

diff --git a/tsconfig-cjs.json b/tsconfig-cjs.json
@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "CommonJS",
+    "outDir": "dist/cjs"
+  }
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -5,10 +5,12 @@
     "declarationDir": "types",
     "declarationMap": true,
     "esModuleInterop": true,
-    "outDir": "dist",
+    "outDir": "dist/esm",
     "sourceMap": true,
     "strict": true,
     "target": "ES5",
+    "module": "ES2020",
+    "moduleResolution": "node",
     "plugins": [
       {
         "transform": "@zerollup/ts-transform-paths",