feat: support ES modules

BREAKING CHANGE: ESM support is required

Author: 0xfede

package.json

@@ -2,6 +2,7 @@
   "name": "jsonref",
   "version": "0.0.0-development",
   "description": "Javascript References ($ref) and Pointers library",
+  "type": "module",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "directories": {
@@ -49,26 +50,26 @@
   },
   "homepage": "https://github.com/vivocha/jsonref#readme",
   "devDependencies": {
-    "@commitlint/config-conventional": "^16.2.1",
-    "@types/chai": "^4.3.0",
+    "@commitlint/config-conventional": "^17.0.2",
+    "@types/chai": "^4.3.1",
     "@types/chai-as-promised": "^7.1.5",
     "@types/chai-spies": "^1.0.3",
-    "@types/mocha": "^9.1.0",
+    "@types/mocha": "^9.1.1",
     "@types/node": "^16.11.26",
     "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
     "chai-spies": "^1.0.0",
     "commitizen": "^4.2.4",
-    "commitlint": "^16.2.1",
+    "commitlint": "^17.0.2",
     "coveralls": "^3.1.1",
     "cz-conventional-changelog": "^3.3.0",
-    "husky": "^7.0.4",
-    "mocha": "^9.2.1",
-    "mochawesome": "^7.1.0",
+    "husky": "^8.0.1",
+    "mocha": "^10.0.0",
+    "mochawesome": "^7.1.3",
     "nyc": "^15.1.0",
     "rimraf": "^3.0.2",
     "semantic-release": "^19.0.2",
-    "typescript": "^4.6.2"
+    "typescript": "^4.7.3"
   },
   "engines": {
     "node": ">=16.14.0"

src/index.ts

@@ -1,12 +1,12 @@
-import { ParserError, RetrieverError } from './errors';
-import * as meta from './meta';
-import { resolve as refResolver } from './ref';
+import { ParserError, RetrieverError } from './errors.js';
+import * as meta from './meta.js';
+import { resolve as refResolver } from './ref.js';
 
-export * from './errors';
-export { getMeta, isAnnotated, isRef, Meta, normalize, normalizeUri, Registry } from './meta';
-export * from './patch';
-export { resolve as pointer } from './pointer';
-export * from './rebase';
+export * from './errors.js';
+export { getMeta, isAnnotated, isRef, Meta, normalize, normalizeUri, Registry } from './meta.js';
+export * from './patch.js';
+export { resolve as pointer } from './pointer.js';
+export * from './rebase.js';
 
 export type Retriever = (url: string) => Promise<any>;
 

src/meta.ts

@@ -1,4 +1,4 @@
-import { escape } from './utils';
+import { escape } from './utils.js';
 
 export interface Registry {
   [uri: string]: any;
@@ -55,7 +55,7 @@ export function getKey(obj: any): string | number | undefined {
     }
     return undefined;
   } else {
-    return Object.keys(parent).find(k => parent[k] === obj);
+    return Object.keys(parent).find((k) => parent[k] === obj);
   }
 }
 export function getById(obj: any, id: string): any {
@@ -74,7 +74,7 @@ export function annotate(obj: any, options: Options): any {
   obj[__meta] = {
     registry: options.registry || {},
     refs: options.refs || new Set(),
-    root: obj
+    root: obj,
   } as Registry;
   obj[__meta].registry[normalizeUri(options.scope)] = obj;
   return (function _annotate(obj: any, scope: string): any {
@@ -107,7 +107,7 @@ export function annotate(obj: any, options: Options): any {
             registry: meta.registry,
             refs: meta.refs,
             parent: obj,
-            root: meta.root
+            root: meta.root,
           };
           _annotate(next, `${meta.scope}/${escape(key)}`);
         }
@@ -119,7 +119,7 @@ export function annotate(obj: any, options: Options): any {
 export function missingRefs(obj: any): string[] {
   const meta = getMeta(obj);
   const known = new Set(Object.keys(meta.registry));
-  return [...meta.refs].filter(r => !known.has(r));
+  return [...meta.refs].filter((r) => !known.has(r));
 }
 export function normalize(obj: any): any {
   if (!isAnnotated(obj)) {

src/patch.ts

@@ -1,5 +1,5 @@
-import * as meta from './meta';
-import * as pointer from './pointer';
+import * as meta from './meta.js';
+import * as pointer from './pointer.js';
 
 export interface JSONPatchOther {
   op: 'add' | 'replace' | 'test';
@@ -40,8 +40,8 @@ export function diff(src: any, dst: any, path: string = '/'): JSONPatch {
         out = out.concat(diff(src[i], dst[i], `${path === '/' ? '' : path}/${i}`));
       }
       if (src.length > dst.length) {
-        for(let i = src.length; i > dst.length; i--) {
-          out.push({ op: 'remove', path: `${path === '/' ? '' : path}/${i-1}` });
+        for (let i = src.length; i > dst.length; i--) {
+          out.push({ op: 'remove', path: `${path === '/' ? '' : path}/${i - 1}` });
         }
       } else if (src.length < dst.length) {
         for (let i = src.length; i < dst.length; i++) {

src/pointer.ts

@@ -1,13 +1,14 @@
-import * as meta from './meta';
-import { unescape } from './utils';
+import * as meta from './meta.js';
+import { unescape } from './utils.js';
 
 const PREFIX_RE: RegExp = /^(0|[1-9][0-9]*?)([#]?)$/;
 const INDEX_RE: RegExp = /-|0|[1-9][0-9]*/;
 
 export function getPointer(obj: any): string {
   const p: string[] = [];
-  let parent: any, current: any = obj;
-  while (parent = meta.getMeta(current).parent) {
+  let parent: any,
+    current: any = obj;
+  while ((parent = meta.getMeta(current).parent)) {
     const frag = meta.getKey(current);
     if (!frag) {
       throw new Error(`Failed to get key for ${JSON.stringify(current)}`);
@@ -39,7 +40,7 @@ export function resolve(obj: any, path: string): any {
         throw new SyntaxError(`Bad prefix ${prefix}`);
       } else {
         let levels = parseInt(match[1]);
-        while(levels--) {
+        while (levels--) {
           current = meta.getMeta(current).parent;
           if (!current) {
             throw new RangeError(`Invalid prefix "${match[1]}"`);
@@ -51,11 +52,11 @@ export function resolve(obj: any, path: string): any {
       }
     }
   }
-  while(parts.length) {
+  while (parts.length) {
     if (current === null || typeof current !== 'object') {
       throw new TypeError(`Invalid type at path`);
     }
-    const part = unescape((parts.shift() as string));
+    const part = unescape(parts.shift() as string);
     if (Array.isArray(current)) {
       if (!part.match(INDEX_RE)) {
         throw new SyntaxError(`Invalid array index "${part}"`);

src/rebase.ts

@@ -1,4 +1,4 @@
-import { RebaserError } from './errors';
+import { RebaserError } from './errors.js';
 
 export interface Rebaser {
   (id: string, obj: any): any;
@@ -28,7 +28,7 @@ export function rebase(id: string, obj: any, rebaser?: Rebaser): any {
         const prop = obj[key];
         if (prop && typeof prop === 'object') {
           if (!Array.isArray(prop)) {
-            if (!parsedProps.find(p => p === prop)) {
+            if (!parsedProps.find((p) => p === prop)) {
               parsedProps.push(prop);
               findAndRebase(prop);
             }

src/ref.ts

@@ -1,5 +1,5 @@
-import * as meta from './meta';
-import * as pointer from './pointer';
+import * as meta from './meta.js';
+import * as pointer from './pointer.js';
 
 const RELATIVE_RE: RegExp = /^#(?:0|[1-9][0-9]*?)(?:$|\/)/;
 

test/ts/index.test.ts

@@ -1,7 +1,7 @@
-import * as chai from 'chai';
-import * as chaiAsPromised from 'chai-as-promised';
-import * as spies from 'chai-spies';
-import * as jsonref from '../../dist/index';
+import chai from 'chai';
+import chaiAsPromised from 'chai-as-promised';
+import spies from 'chai-spies';
+import * as jsonref from '../../dist/index.js';
 
 chai.use(spies);
 chai.use(chaiAsPromised);
@@ -381,7 +381,7 @@ describe('jsonref', function () {
     });
     it('should throw if path is not a string', function () {
       (function () {
-        jsonref.pointer({}, (1 as any) as string);
+        jsonref.pointer({}, 1 as any as string);
       }.should.throw(TypeError, /Bad path/));
     });
     it('should throw if path contains parts pointing to scalars', function () {