Add package.exports (#433)

* Add package.exports

Author: Nir Maoz

package.json

@@ -21,6 +21,7 @@
     "build:entryPoints": "ts-node ./scripts/createEntrypoints.ts",
     "build:copyCleanPackageJSON": "ts-node scripts/copyPackageJsonToSrc.ts",
     "build:injectPackageVersion": "ts-node ./scripts/injectPackageVersionToDistFiles.ts",
+    "build:updatePackageExports": "ts-node scripts/updatePackageJsonExports.ts",
     "lint": "eslint src __TESTS__ --color --ext .ts",
     "start": "rollup -c rollup.dev.config.js -w",
     "bundlewatch": "bundlewatch --config ./bundlewatch.config.js",
@@ -91,5 +92,24 @@
   "dependencies": {
     "@types/lodash.clonedeep": "^4.5.6",
     "lodash.clonedeep": "^4.5.0"
+  },
+  "exports": {
+    "./bundles/umd/package.json": "./bundles/umd/package.json",
+    "./package.json": "./package.json",
+    "./actions/*": "./actions/*.js",
+    "./assets/*": "./assets/*.js",
+    "./backwards/*": "./backwards/*.js",
+    "./bundles/*": "./bundles/*.js",
+    "./config/*": "./config/*.js",
+    "./instance/*": "./instance/*.js",
+    "./qualifiers/*": "./qualifiers/*.js",
+    "./sdkAnalytics/*": "./sdkAnalytics/*.js",
+    "./transformation/*": "./transformation/*.js",
+    "./types/*": "./types/*.js",
+    ".": {
+      "node": "./index.js",
+      "require": "./bundles/umd/base.js",
+      "default": "./index.js"
+    }
   }
-}
+}

scripts/build.sh

@@ -13,6 +13,7 @@ npm run build:UMD
 npm run build:entryPoints
 npm run build:docs
 npm run build:injectPackageVersion
+npm run build:updatePackageExports
 
 #cp CHANGELOG.md to dist
 cp ./CHANGELOG.md ./dist

scripts/updatePackageJsonExports.ts

@@ -0,0 +1,56 @@
+/**
+ * This script Adds "exports" property to package.json.
+ * It fills it with key-value pars for sub-directories of /dist,
+ * excluding /internal
+ */
+
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const {resolve} = require('path');
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const {writeFile, readdirSync} = require('fs');
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const packageJson = require('../package.json');
+
+interface Dirent {
+  isDirectory: () => boolean;
+  name: string;
+}
+
+// List of sub-directories under ./dist
+const distSubDirectoriesArray: string[] = readdirSync(resolve('./dist'), {withFileTypes: true})
+  // Filter out files
+  .filter((dirent: Dirent) => dirent.isDirectory())
+  // Get directory name
+  .map((dirent: Dirent) => `./${dirent.name}`)
+  // Exclude /internal
+  .filter((dir: string) => !dir.toLowerCase().includes('/internal'))
+  // Sort alphabetically
+  .sort();
+
+// Convert directory string to object of {[directory/*]: directory/*.js}
+const distSubDirectoriesObj: Record<string, string> = distSubDirectoriesArray
+  .reduce((obj, dir) => ({...obj, ...{[`${dir}/*`]: `${dir}/*.js`}}), {}); //
+
+// Generate updated package json object
+const resultPackageJson = JSON.stringify({
+  ...packageJson,
+  exports: {
+    "./bundles/umd/package.json": "./bundles/umd/package.json",
+    "./package.json": "./package.json",
+    ...distSubDirectoriesObj,
+    ".": {
+      "node": "./index.js",
+      "require": "./bundles/umd/base.js",
+      "default": "./index.js"
+    }
+  }
+}, null, 2);
+
+// Update (overwrite) package.json
+writeFile(resolve('./package.json'), resultPackageJson, (err: Error) => {
+  if (!err) {
+    console.log('Successfully updated package.json exports field');
+  } else {
+    throw `Failed to updated package.json exports field: ${err}`;
+  }
+});

src/package.json

@@ -9,6 +9,25 @@
 		"@types/lodash.clonedeep": "^4.5.6",
 		"lodash.clonedeep": "^4.5.0"
 	},
+	"exports": {
+		"./bundles/umd/package.json": "./bundles/umd/package.json",
+		"./package.json": "./package.json",
+		"./actions/*": "./actions/*.js",
+		"./assets/*": "./assets/*.js",
+		"./backwards/*": "./backwards/*.js",
+		"./bundles/*": "./bundles/*.js",
+		"./config/*": "./config/*.js",
+		"./instance/*": "./instance/*.js",
+		"./qualifiers/*": "./qualifiers/*.js",
+		"./sdkAnalytics/*": "./sdkAnalytics/*.js",
+		"./transformation/*": "./transformation/*.js",
+		"./types/*": "./types/*.js",
+		".": {
+			"node": "./index.js",
+			"require": "./bundles/umd/base.js",
+			"default": "./index.js"
+		}
+	},
 	"main": "./bundles/umd/base.js",
 	"browser": "./index.js",
 	"module": "./index.js",