fix imports, use esm

jonluca · jonluca · commit 6d4ebf694620 · 2025-11-11T10:00:10.000-08:00
diff --git a/lib/bundle.ts b/lib/bundle.ts
@@ -2,10 +2,10 @@ import $Ref from "./ref.js";
 import Pointer from "./pointer.js";
 import * as url from "./util/url.js";
 import type $Refs from "./refs.js";
-import type $RefParser from "./index";
-import type { ParserOptions } from "./index";
-import type { JSONSchema } from "./index";
-import type { BundleOptions } from "./options";
+import type $RefParser from "./index.js";
+import type { ParserOptions } from "./index.js";
+import type { JSONSchema } from "./index.js";
+import type { BundleOptions } from "./options.js";
 
 export interface InventoryEntry {
   $ref: any;
diff --git a/lib/dereference.ts b/lib/dereference.ts
@@ -3,9 +3,8 @@ import Pointer from "./pointer.js";
 import * as url from "./util/url.js";
 import type $Refs from "./refs.js";
 import type { DereferenceOptions, ParserOptions } from "./options.js";
-import type { JSONSchema } from "./types";
-import type $RefParser from "./index";
-import { TimeoutError } from "./util/errors";
+import { type $RefParser, type JSONSchema } from "./index.js";
+import { TimeoutError } from "./util/errors.js";
 
 export default dereference;
 
diff --git a/lib/normalize-args.ts b/lib/normalize-args.ts
@@ -1,6 +1,6 @@
 import type { Options, ParserOptions } from "./options.js";
 import { getNewOptions } from "./options.js";
-import type { JSONSchema, SchemaCallback } from "./types";
+import type { JSONSchema, SchemaCallback } from "./index.js";
 
 // I really dislike this function and the way it's written. It's not clear what it's doing, and it's way too flexible
 // In the future, I'd like to deprecate the api and accept only named parameters in index.ts
diff --git a/lib/pointer.ts b/lib/pointer.ts
@@ -3,7 +3,7 @@ import type { ParserOptions } from "./options.js";
 import $Ref from "./ref.js";
 import * as url from "./util/url.js";
 import { JSONParserError, InvalidPointerError, MissingPointerError, isHandledError } from "./util/errors.js";
-import type { JSONSchema } from "./types";
+import type { JSONSchema } from "./index.js";
 import type { JSONSchema4Type, JSONSchema6Type, JSONSchema7Type } from "json-schema";
 
 export const nullSymbol = Symbol("null");
diff --git a/lib/ref.ts b/lib/ref.ts
@@ -4,7 +4,7 @@ import { InvalidPointerError, isHandledError, normalizeError } from "./util/erro
 import { safePointerToPath, stripHash, getHash } from "./util/url.js";
 import type $Refs from "./refs.js";
 import type { ParserOptions } from "./options.js";
-import type { JSONSchema } from "./types";
+import type { JSONSchema } from "./index.js";
 import type { JSONSchema4Type, JSONSchema6Type, JSONSchema7Type } from "json-schema";
 
 export type $RefError = JSONParserError | ResolverError | ParserError | MissingPointerError;
diff --git a/lib/refs.ts b/lib/refs.ts
@@ -2,8 +2,8 @@ import $Ref from "./ref.js";
 import * as url from "./util/url.js";
 import type { JSONSchema4Type, JSONSchema6Type, JSONSchema7Type } from "json-schema";
 import type { ParserOptions } from "./options.js";
-import convertPathToPosix from "./util/convert-path-to-posix";
-import type { JSONSchema } from "./types";
+import convertPathToPosix from "./util/convert-path-to-posix.js";
+import type { JSONSchema } from "./index.js";
 
 interface $RefsMap<S extends object = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>> {
   [url: string]: $Ref<S, O>;
diff --git a/lib/types/index.ts b/lib/types/index.ts
@@ -7,7 +7,7 @@ import type {
   JSONSchema7Object,
 } from "json-schema";
 import type $Refs from "../refs.js";
-import type { ParserOptions } from "../options";
+import type { ParserOptions } from "../options.js";
 
 export type JSONSchema = JSONSchema4 | JSONSchema6 | JSONSchema7;
 export type JSONSchemaObject = JSONSchema4Object | JSONSchema6Object | JSONSchema7Object;
diff --git a/lib/util/errors.ts b/lib/util/errors.ts
@@ -2,7 +2,7 @@ import { getHash, stripHash, toFileSystemPath } from "./url.js";
 import type $RefParser from "../index.js";
 import type { ParserOptions } from "../index.js";
 import type { JSONSchema } from "../index.js";
-import type $Ref from "../ref";
+import type $Ref from "../ref.js";
 
 export type JSONParserErrorType =
   | "EUNKNOWN"
diff --git a/lib/util/url.ts b/lib/util/url.ts
@@ -1,4 +1,4 @@
-import convertPathToPosix from "./convert-path-to-posix";
+import convertPathToPosix from "./convert-path-to-posix.js";
 import path, { win32 } from "path";
 
 const forwardSlashPattern = /\//g;
@@ -7,7 +7,7 @@ const jsonPointerSlash = /~1/g;
 const jsonPointerTilde = /~0/g;
 
 import { join } from "path";
-import { isWindows } from "./is-windows";
+import { isWindows } from "./is-windows.js";
 
 // RegExp patterns to URL-encode special characters in local filesystem paths
 const urlEncodePatterns = [
diff --git a/package.json b/package.json
@@ -2,13 +2,17 @@
   "name": "@apidevtools/json-schema-ref-parser",
   "version": "0.0.0-dev",
   "description": "Parse, Resolve, and Dereference JSON Schema $ref pointers",
+  "type": "module",
+  "types": "dist/lib/index.d.ts",
+  "module": "dist/lib/index.js",
   "scripts": {
     "prepublishOnly": "yarn build",
     "lint": "eslint lib",
     "build": "rimraf dist && tsc",
     "typecheck": "tsc --noEmit",
     "prettier": "prettier --write \"**/*.+(js|jsx|ts|tsx|har||json|css|md)\"",
     "test": "vitest --coverage",
+    "test:specific": "vitest defs-encoding",
     "test:node": "yarn test",
     "test:browser": "cross-env BROWSER=\"true\" yarn test",
     "test:update": "vitest -u",
@@ -53,14 +57,11 @@
     "url": "https://github.com/APIDevTools/json-schema-ref-parser.git"
   },
   "license": "MIT",
-  "funding": "https://github.com/sponsors/philsturgeon",
-  "types": "dist/lib/index.d.ts",
-  "main": "dist/lib/index.js",
   "browser": {
     "fs": false
   },
   "engines": {
-    "node": ">= 20"
+    "node": ">=20"
   },
   "files": [
     "lib",
diff --git a/test/specs/bundle-defs-encoding/bundle-defs-encoding.spec.ts b/test/specs/bundle-defs-encoding/bundle-defs-encoding.spec.ts
@@ -0,0 +1,70 @@
+import { describe, it } from "vitest";
+import { expect } from "vitest";
+import $RefParser from "../../../lib/index.js";
+import path from "../../utils/path";
+
+describe("Bundle $defs encoding", () => {
+  it("should not URL-encode $ in $defs when bundling cross-references", async () => {
+    const parser = new $RefParser();
+    const schema = path.rel("test/specs/bundle-defs-encoding/parent.json");
+    const bundled = await parser.bundle(schema);
+
+    // The bundled schema should have $defs section with myschema that references otherschema
+    expect(bundled).toHaveProperty("$defs");
+    expect(bundled.$defs).toHaveProperty("myschema");
+    expect(bundled.$defs).toHaveProperty("otherschema");
+
+    // Check that myschema has allOf with a reference to otherschema
+    const myschema = bundled.$defs.myschema;
+    expect(myschema).toHaveProperty("allOf");
+    expect(Array.isArray(myschema.allOf)).toBe(true);
+    expect(myschema.allOf.length).toBeGreaterThan(0);
+
+    // The critical assertion: the $ref should be #/$defs/otherschema, NOT #/%24defs/otherschema
+    const refToOtherSchema = myschema.allOf[0].$ref;
+    expect(refToOtherSchema).toBeDefined();
+    expect(refToOtherSchema).toMatch(/^#\/\$defs\//);
+    expect(refToOtherSchema).not.toMatch(/%24defs/);
+    expect(refToOtherSchema).toBe("#/$defs/otherschema");
+
+    // Verify the complete bundled structure matches expected output
+    const expected = {
+      $schema: "http://json-schema.org/draft-07/schema#",
+      type: "object",
+      properties: {
+        foo: {
+          type: "string",
+        },
+      },
+      $defs: {
+        myschema: {
+          $schema: "http://json-schema.org/draft-07/schema#",
+          type: "object",
+          allOf: [
+            {
+              $ref: "#/$defs/otherschema",
+            },
+            {
+              properties: {
+                someProp: {
+                  type: "string",
+                },
+              },
+            },
+          ],
+        },
+        otherschema: {
+          $schema: "http://json-schema.org/draft-07/schema#",
+          type: "object",
+          properties: {
+            otherProp: {
+              type: "string",
+            },
+          },
+        },
+      },
+    };
+
+    expect(bundled).toEqual(expected);
+  });
+});
diff --git a/test/specs/bundle-defs-encoding/myschema.json b/test/specs/bundle-defs-encoding/myschema.json
@@ -0,0 +1,16 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "./otherschema.json"
+    },
+    {
+      "properties": {
+        "someProp": {
+          "type": "string"
+        }
+      }
+    }
+  ]
+}
diff --git a/test/specs/bundle-defs-encoding/otherschema.json b/test/specs/bundle-defs-encoding/otherschema.json
@@ -0,0 +1,9 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "otherProp": {
+      "type": "string"
+    }
+  }
+}
diff --git a/test/specs/bundle-defs-encoding/parent.json b/test/specs/bundle-defs-encoding/parent.json
@@ -0,0 +1,17 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "foo": {
+      "type": "string"
+    }
+  },
+  "$defs": {
+    "myschema": {
+      "$ref": "./myschema.json"
+    },
+    "otherschema": {
+      "$ref": "./otherschema.json"
+    }
+  }
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,11 +1,12 @@
 {
   "compilerOptions": {
-    "module": "commonjs",
+    "module": "NodeNext",
     "outDir": "dist",
     "target": "ES2022",
     "allowJs": true,
     "allowSyntheticDefaultImports": true,
     "baseUrl": "src",
+    "moduleResolution": "node16",
     "declaration": true,
     "esModuleInterop": true,
     "inlineSourceMap": false,
