@api3/commons 0.6.1 → 0.6.2

package/README.md

@@ -4,13 +4,9 @@
 
 The commons library is meant to stop "reinventing the wheel". It holds the canonical implementations that can be
 imported in other packages. This way we ensure that all package use the same logic, simplify bug fixes and avoid code
-duplication.
+duplication. The package is cross platform and can be used in Node.js and browser.
 
-The commons library is a single repo and a collection of multiple modules:
-
-- [`eslint`](./src/eslint/README.md) - The configrations for ESLint.
-
-Read the documentation of each module for more information.
+The commons library is a collection of multiple modules, with each module having its own README that you can refer to.
 
 ## Related repositories
 
@@ -26,17 +22,23 @@ Read the documentation of each module for more information.
 pnpm add @api3/commons
 ```
 
-Read the documentation of each module how to use it in the project.
+Read the documentation and sources of each module how to use it in the project.
+
+## Using the package in universal context
 
-### Import paths
+Some modules may be used only in both browser and Node.js context and some are Node.js only. To support this
+requirement, we use different entrypoints for each context. Note, there is no support for browser-only modules.
 
-There are two options how to import the commons modules, depending on the module resolution:
+The bundler or Node.js picks up the right entrypoint automatically, but bear in mind that only a subset of modules is
+available when using universal modules. If you use TypeScript, it may not pick up the correct types. You can set these
+manually, by adding the following to your `tsconfig.json`:
 
-```ts
-// 1) Import relative to the "node_modules" directory.
-import { createLogger } from '@api3/commons/dist/logger';
-// 2) Cleaner imports based on the "exports" field in "package.json".
-import { createLogger } from '@api3/commons/logger';
+```json
+"compilerOptions": {
+  "paths": {
+    "@api3/commons": ["./node_modules/@api3/commons/dist/universal-index.d.ts"]
+  }
+}
 ```
 
 ## Release
@@ -60,7 +62,7 @@ To release a new version follow these steps:
 
 1. Create a new directory in `src` with the name of the utility.
 2. Create `index.ts` file in the directory. This file will be the entry point for the utility.
-3. Re-export the new utility from the root `index.ts` file.
+3. Re-export the new utility from `universal-index.ts` or `node-index.ts` file.
 4. Create a `README.md` with documentation.
 
 #### Testing the package locally

package/dist/node-index.d.ts

@@ -0,0 +1,4 @@
+export * from './universal-index';
+export * from './logger';
+export * from './processing';
+//# sourceMappingURL=node-index.d.ts.map

package/dist/node-index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node-index.d.ts","sourceRoot":"","sources":["../src/node-index.ts"],"names":[],"mappings":"AACA,cAAc,mBAAmB,CAAC;AAClC,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC"}

package/dist/{index.js → node-index.js}

@@ -15,7 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 // NOTE: Not exporting ESLint rules because they need to be imported in a special way inside .eslintrc.js config.
+__exportStar(require("./universal-index"), exports);
 __exportStar(require("./logger"), exports);
 __exportStar(require("./processing"), exports);
-__exportStar(require("./blockchain-utilities"), exports);
-//# sourceMappingURL=index.js.map
+//# sourceMappingURL=node-index.js.map

package/dist/node-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"node-index.js","sourceRoot":"","sources":["../src/node-index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iHAAiH;AACjH,oDAAkC;AAClC,2CAAyB;AACzB,+CAA6B"}

package/dist/universal-index.d.ts

@@ -0,0 +1,2 @@
+export * from './blockchain-utilities';
+//# sourceMappingURL=universal-index.d.ts.map

package/dist/universal-index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"universal-index.d.ts","sourceRoot":"","sources":["../src/universal-index.ts"],"names":[],"mappings":"AACA,cAAc,wBAAwB,CAAC"}

package/dist/universal-index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// NOTE: Only export modules which work in both Node.js and browser environments.
+__exportStar(require("./blockchain-utilities"), exports);
+//# sourceMappingURL=universal-index.js.map

package/dist/universal-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"universal-index.js","sourceRoot":"","sources":["../src/universal-index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iFAAiF;AACjF,yDAAuC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@api3/commons",
-  "version": "0.6.1",
+  "version": "0.6.2",
   "keywords": [],
   "license": "MIT",
   "engines": {
@@ -11,8 +11,14 @@
     "dist",
     "src"
   ],
-  "main": "./dist/index.js",
-  "exports": "./dist/index.js",
+  "browser": "./dist/universal-index.js",
+  "main": "./dist/node-index.js",
+  "exports": {
+    ".": {
+      "browser": "./dist/universal-index.js",
+      "default": "./dist/node-index.js"
+    }
+  },
   "dependencies": {
     "@api3/ois": "^2.3.0",
     "@api3/promise-utils": "^0.4.0",

package/src/{index.ts → node-index.ts}

@@ -1,4 +1,4 @@
 // NOTE: Not exporting ESLint rules because they need to be imported in a special way inside .eslintrc.js config.
+export * from './universal-index';
 export * from './logger';
 export * from './processing';
-export * from './blockchain-utilities';

package/src/universal-index.ts

@@ -0,0 +1,2 @@
+// NOTE: Only export modules which work in both Node.js and browser environments.
+export * from './blockchain-utilities';

package/dist/index.d.ts

@@ -1,4 +0,0 @@
-export * from './logger';
-export * from './processing';
-export * from './blockchain-utilities';
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,wBAAwB,CAAC"}

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iHAAiH;AACjH,2CAAyB;AACzB,+CAA6B;AAC7B,yDAAuC"}