@scalar/openapi-parser 0.10.16 → 0.11.0

package/dist/utils/openapi/utils/workThroughQueue.test.js

@@ -0,0 +1,244 @@
+import { describe, expect, it } from "vitest";
+import { workThroughQueue } from "./workThroughQueue.js";
+describe("workThroughQueue", () => {
+  it("loads a specification", async () => {
+    const result = workThroughQueue({
+      input: {
+        openapi: "3.1.0",
+        info: {
+          title: "Hello World",
+          version: "1.0.0"
+        },
+        paths: {}
+      },
+      specification: {
+        openapi: "3.1.1",
+        info: {
+          title: "Hello World",
+          version: "1.0.0"
+        },
+        paths: {}
+      },
+      tasks: [
+        {
+          name: "load"
+        }
+      ]
+    });
+    expect(await result).toStrictEqual({
+      errors: [],
+      specification: {
+        info: {
+          title: "Hello World",
+          version: "1.0.0"
+        },
+        openapi: "3.1.0",
+        paths: {}
+      },
+      filesystem: [
+        {
+          dir: "./",
+          filename: null,
+          isEntrypoint: true,
+          references: [],
+          specification: {
+            info: {
+              title: "Hello World",
+              version: "1.0.0"
+            },
+            openapi: "3.1.0",
+            paths: {}
+          }
+        }
+      ]
+    });
+  });
+  it("validates a specification", async () => {
+    const result = workThroughQueue({
+      input: {
+        openapi: "3.1.0",
+        info: {
+          title: "Hello World",
+          version: "1.0.0"
+        },
+        paths: {}
+      },
+      specification: {
+        openapi: "3.1.0",
+        info: {
+          title: "Hello World",
+          version: "1.0.0"
+        },
+        paths: {}
+      },
+      tasks: [
+        {
+          name: "load"
+        },
+        {
+          name: "validate"
+        }
+      ]
+    });
+    expect(await result).toStrictEqual({
+      errors: [],
+      valid: true,
+      version: "3.1",
+      filesystem: [
+        {
+          dir: "./",
+          filename: null,
+          isEntrypoint: true,
+          references: [],
+          specification: {
+            info: {
+              title: "Hello World",
+              version: "1.0.0"
+            },
+            openapi: "3.1.0",
+            paths: {}
+          }
+        }
+      ],
+      specification: {
+        openapi: "3.1.0",
+        info: {
+          title: "Hello World",
+          version: "1.0.0"
+        },
+        paths: {}
+      },
+      schema: {
+        info: {
+          title: "Hello World",
+          version: "1.0.0"
+        },
+        openapi: "3.1.0",
+        paths: {}
+      }
+    });
+  });
+  it("dereferences a specification", async () => {
+    const result = workThroughQueue({
+      input: {
+        openapi: "3.1.0",
+        info: {
+          title: "Hello World",
+          version: "1.0.0"
+        },
+        paths: {}
+      },
+      specification: {
+        openapi: "3.1.0",
+        info: {
+          title: "Hello World",
+          version: "1.0.0"
+        },
+        paths: {}
+      },
+      tasks: [
+        {
+          name: "load"
+        },
+        {
+          name: "dereference"
+        }
+      ]
+    });
+    expect(await result).toStrictEqual({
+      errors: [],
+      specificationType: "openapi",
+      specificationVersion: "3.1.0",
+      version: "3.1",
+      filesystem: [
+        {
+          dir: "./",
+          filename: null,
+          isEntrypoint: true,
+          references: [],
+          specification: {
+            info: {
+              title: "Hello World",
+              version: "1.0.0"
+            },
+            openapi: "3.1.0",
+            paths: {}
+          }
+        }
+      ],
+      specification: {
+        openapi: "3.1.0",
+        info: {
+          title: "Hello World",
+          version: "1.0.0"
+        },
+        paths: {}
+      },
+      schema: {
+        info: {
+          title: "Hello World",
+          version: "1.0.0"
+        },
+        openapi: "3.1.0",
+        paths: {}
+      }
+    });
+  });
+  it("upgrades a specification", async () => {
+    const result = workThroughQueue({
+      input: {
+        openapi: "3.0.0",
+        info: {
+          title: "Hello World",
+          version: "1.0.0"
+        },
+        paths: {}
+      },
+      specification: {
+        openapi: "3.0.0",
+        info: {
+          title: "Hello World",
+          version: "1.0.0"
+        },
+        paths: {}
+      },
+      tasks: [
+        {
+          name: "load"
+        },
+        {
+          name: "upgrade"
+        }
+      ]
+    });
+    expect(await result).toStrictEqual({
+      errors: [],
+      version: "3.1",
+      specification: {
+        openapi: "3.1.1",
+        info: {
+          title: "Hello World",
+          version: "1.0.0"
+        },
+        paths: {}
+      },
+      filesystem: [
+        {
+          dir: "./",
+          filename: null,
+          isEntrypoint: true,
+          references: [],
+          specification: {
+            info: {
+              title: "Hello World",
+              version: "1.0.0"
+            },
+            openapi: "3.1.1",
+            paths: {}
+          }
+        }
+      ]
+    });
+  });
+});
+//# sourceMappingURL=workThroughQueue.test.js.map

package/dist/utils/openapi/utils/workThroughQueue.test.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../src/utils/openapi/utils/workThroughQueue.test.ts"],
+  "sourcesContent": ["import { describe, expect, it } from 'vitest'\n\nimport { workThroughQueue } from './workThroughQueue'\n\ndescribe('workThroughQueue', () => {\n  it('loads a specification', async () => {\n    const result = workThroughQueue({\n      input: {\n        openapi: '3.1.0',\n        info: {\n          title: 'Hello World',\n          version: '1.0.0',\n        },\n        paths: {},\n      },\n      specification: {\n        openapi: '3.1.1',\n        info: {\n          title: 'Hello World',\n          version: '1.0.0',\n        },\n        paths: {},\n      },\n      tasks: [\n        {\n          name: 'load',\n        },\n      ],\n    })\n\n    expect(await result).toStrictEqual({\n      errors: [],\n      specification: {\n        info: {\n          title: 'Hello World',\n          version: '1.0.0',\n        },\n        openapi: '3.1.0',\n        paths: {},\n      },\n      filesystem: [\n        {\n          dir: './',\n          filename: null,\n          isEntrypoint: true,\n          references: [],\n          specification: {\n            info: {\n              title: 'Hello World',\n              version: '1.0.0',\n            },\n            openapi: '3.1.0',\n            paths: {},\n          },\n        },\n      ],\n    })\n  })\n\n  it('validates a specification', async () => {\n    const result = workThroughQueue({\n      input: {\n        openapi: '3.1.0',\n        info: {\n          title: 'Hello World',\n          version: '1.0.0',\n        },\n        paths: {},\n      },\n      specification: {\n        openapi: '3.1.0',\n        info: {\n          title: 'Hello World',\n          version: '1.0.0',\n        },\n        paths: {},\n      },\n      tasks: [\n        {\n          name: 'load',\n        },\n        {\n          name: 'validate',\n        },\n      ],\n    })\n\n    expect(await result).toStrictEqual({\n      errors: [],\n      valid: true,\n      version: '3.1',\n      filesystem: [\n        {\n          dir: './',\n          filename: null,\n          isEntrypoint: true,\n          references: [],\n          specification: {\n            info: {\n              title: 'Hello World',\n              version: '1.0.0',\n            },\n            openapi: '3.1.0',\n            paths: {},\n          },\n        },\n      ],\n      specification: {\n        openapi: '3.1.0',\n        info: {\n          title: 'Hello World',\n          version: '1.0.0',\n        },\n        paths: {},\n      },\n      schema: {\n        info: {\n          title: 'Hello World',\n          version: '1.0.0',\n        },\n        openapi: '3.1.0',\n        paths: {},\n      },\n    })\n  })\n\n  it('dereferences a specification', async () => {\n    const result = workThroughQueue({\n      input: {\n        openapi: '3.1.0',\n        info: {\n          title: 'Hello World',\n          version: '1.0.0',\n        },\n        paths: {},\n      },\n      specification: {\n        openapi: '3.1.0',\n        info: {\n          title: 'Hello World',\n          version: '1.0.0',\n        },\n        paths: {},\n      },\n      tasks: [\n        {\n          name: 'load',\n        },\n        {\n          name: 'dereference',\n        },\n      ],\n    })\n\n    expect(await result).toStrictEqual({\n      errors: [],\n      specificationType: 'openapi',\n      specificationVersion: '3.1.0',\n      version: '3.1',\n      filesystem: [\n        {\n          dir: './',\n          filename: null,\n          isEntrypoint: true,\n          references: [],\n          specification: {\n            info: {\n              title: 'Hello World',\n              version: '1.0.0',\n            },\n            openapi: '3.1.0',\n            paths: {},\n          },\n        },\n      ],\n      specification: {\n        openapi: '3.1.0',\n        info: {\n          title: 'Hello World',\n          version: '1.0.0',\n        },\n        paths: {},\n      },\n      schema: {\n        info: {\n          title: 'Hello World',\n          version: '1.0.0',\n        },\n        openapi: '3.1.0',\n        paths: {},\n      },\n    })\n  })\n\n  it('upgrades a specification', async () => {\n    const result = workThroughQueue({\n      input: {\n        openapi: '3.0.0',\n        info: {\n          title: 'Hello World',\n          version: '1.0.0',\n        },\n        paths: {},\n      },\n      specification: {\n        openapi: '3.0.0',\n        info: {\n          title: 'Hello World',\n          version: '1.0.0',\n        },\n        paths: {},\n      },\n      tasks: [\n        {\n          name: 'load',\n        },\n        {\n          name: 'upgrade',\n        },\n      ],\n    })\n\n    expect(await result).toStrictEqual({\n      errors: [],\n      version: '3.1',\n      specification: {\n        openapi: '3.1.1',\n        info: {\n          title: 'Hello World',\n          version: '1.0.0',\n        },\n        paths: {},\n      },\n      filesystem: [\n        {\n          dir: './',\n          filename: null,\n          isEntrypoint: true,\n          references: [],\n          specification: {\n            info: {\n              title: 'Hello World',\n              version: '1.0.0',\n            },\n            openapi: '3.1.1',\n            paths: {},\n          },\n        },\n      ],\n    })\n  })\n})\n"],
+  "mappings": "AAAA,SAAS,UAAU,QAAQ,UAAU;AAErC,SAAS,wBAAwB;AAEjC,SAAS,oBAAoB,MAAM;AACjC,KAAG,yBAAyB,YAAY;AACtC,UAAM,SAAS,iBAAiB;AAAA,MAC9B,OAAO;AAAA,QACL,SAAS;AAAA,QACT,MAAM;AAAA,UACJ,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,QACA,OAAO,CAAC;AAAA,MACV;AAAA,MACA,eAAe;AAAA,QACb,SAAS;AAAA,QACT,MAAM;AAAA,UACJ,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,QACA,OAAO,CAAC;AAAA,MACV;AAAA,MACA,OAAO;AAAA,QACL;AAAA,UACE,MAAM;AAAA,QACR;AAAA,MACF;AAAA,IACF,CAAC;AAED,WAAO,MAAM,MAAM,EAAE,cAAc;AAAA,MACjC,QAAQ,CAAC;AAAA,MACT,eAAe;AAAA,QACb,MAAM;AAAA,UACJ,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,QACA,SAAS;AAAA,QACT,OAAO,CAAC;AAAA,MACV;AAAA,MACA,YAAY;AAAA,QACV;AAAA,UACE,KAAK;AAAA,UACL,UAAU;AAAA,UACV,cAAc;AAAA,UACd,YAAY,CAAC;AAAA,UACb,eAAe;AAAA,YACb,MAAM;AAAA,cACJ,OAAO;AAAA,cACP,SAAS;AAAA,YACX;AAAA,YACA,SAAS;AAAA,YACT,OAAO,CAAC;AAAA,UACV;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAED,KAAG,6BAA6B,YAAY;AAC1C,UAAM,SAAS,iBAAiB;AAAA,MAC9B,OAAO;AAAA,QACL,SAAS;AAAA,QACT,MAAM;AAAA,UACJ,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,QACA,OAAO,CAAC;AAAA,MACV;AAAA,MACA,eAAe;AAAA,QACb,SAAS;AAAA,QACT,MAAM;AAAA,UACJ,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,QACA,OAAO,CAAC;AAAA,MACV;AAAA,MACA,OAAO;AAAA,QACL;AAAA,UACE,MAAM;AAAA,QACR;AAAA,QACA;AAAA,UACE,MAAM;AAAA,QACR;AAAA,MACF;AAAA,IACF,CAAC;AAED,WAAO,MAAM,MAAM,EAAE,cAAc;AAAA,MACjC,QAAQ,CAAC;AAAA,MACT,OAAO;AAAA,MACP,SAAS;AAAA,MACT,YAAY;AAAA,QACV;AAAA,UACE,KAAK;AAAA,UACL,UAAU;AAAA,UACV,cAAc;AAAA,UACd,YAAY,CAAC;AAAA,UACb,eAAe;AAAA,YACb,MAAM;AAAA,cACJ,OAAO;AAAA,cACP,SAAS;AAAA,YACX;AAAA,YACA,SAAS;AAAA,YACT,OAAO,CAAC;AAAA,UACV;AAAA,QACF;AAAA,MACF;AAAA,MACA,eAAe;AAAA,QACb,SAAS;AAAA,QACT,MAAM;AAAA,UACJ,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,QACA,OAAO,CAAC;AAAA,MACV;AAAA,MACA,QAAQ;AAAA,QACN,MAAM;AAAA,UACJ,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,QACA,SAAS;AAAA,QACT,OAAO,CAAC;AAAA,MACV;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAED,KAAG,gCAAgC,YAAY;AAC7C,UAAM,SAAS,iBAAiB;AAAA,MAC9B,OAAO;AAAA,QACL,SAAS;AAAA,QACT,MAAM;AAAA,UACJ,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,QACA,OAAO,CAAC;AAAA,MACV;AAAA,MACA,eAAe;AAAA,QACb,SAAS;AAAA,QACT,MAAM;AAAA,UACJ,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,QACA,OAAO,CAAC;AAAA,MACV;AAAA,MACA,OAAO;AAAA,QACL;AAAA,UACE,MAAM;AAAA,QACR;AAAA,QACA;AAAA,UACE,MAAM;AAAA,QACR;AAAA,MACF;AAAA,IACF,CAAC;AAED,WAAO,MAAM,MAAM,EAAE,cAAc;AAAA,MACjC,QAAQ,CAAC;AAAA,MACT,mBAAmB;AAAA,MACnB,sBAAsB;AAAA,MACtB,SAAS;AAAA,MACT,YAAY;AAAA,QACV;AAAA,UACE,KAAK;AAAA,UACL,UAAU;AAAA,UACV,cAAc;AAAA,UACd,YAAY,CAAC;AAAA,UACb,eAAe;AAAA,YACb,MAAM;AAAA,cACJ,OAAO;AAAA,cACP,SAAS;AAAA,YACX;AAAA,YACA,SAAS;AAAA,YACT,OAAO,CAAC;AAAA,UACV;AAAA,QACF;AAAA,MACF;AAAA,MACA,eAAe;AAAA,QACb,SAAS;AAAA,QACT,MAAM;AAAA,UACJ,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,QACA,OAAO,CAAC;AAAA,MACV;AAAA,MACA,QAAQ;AAAA,QACN,MAAM;AAAA,UACJ,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,QACA,SAAS;AAAA,QACT,OAAO,CAAC;AAAA,MACV;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAED,KAAG,4BAA4B,YAAY;AACzC,UAAM,SAAS,iBAAiB;AAAA,MAC9B,OAAO;AAAA,QACL,SAAS;AAAA,QACT,MAAM;AAAA,UACJ,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,QACA,OAAO,CAAC;AAAA,MACV;AAAA,MACA,eAAe;AAAA,QACb,SAAS;AAAA,QACT,MAAM;AAAA,UACJ,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,QACA,OAAO,CAAC;AAAA,MACV;AAAA,MACA,OAAO;AAAA,QACL;AAAA,UACE,MAAM;AAAA,QACR;AAAA,QACA;AAAA,UACE,MAAM;AAAA,QACR;AAAA,MACF;AAAA,IACF,CAAC;AAED,WAAO,MAAM,MAAM,EAAE,cAAc;AAAA,MACjC,QAAQ,CAAC;AAAA,MACT,SAAS;AAAA,MACT,eAAe;AAAA,QACb,SAAS;AAAA,QACT,MAAM;AAAA,UACJ,OAAO;AAAA,UACP,SAAS;AAAA,QACX;AAAA,QACA,OAAO,CAAC;AAAA,MACV;AAAA,MACA,YAAY;AAAA,QACV;AAAA,UACE,KAAK;AAAA,UACL,UAAU;AAAA,UACV,cAAc;AAAA,UACd,YAAY,CAAC;AAAA,UACb,eAAe;AAAA,YACb,MAAM;AAAA,cACJ,OAAO;AAAA,cACP,SAAS;AAAA,YACX;AAAA,YACA,SAAS;AAAA,YACT,OAAO,CAAC;AAAA,UACV;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AACH,CAAC;",
+  "names": []
+}

package/dist/utils/resolveReferences.d.ts

@@ -1,5 +1,5 @@
 import type { OpenAPI } from '@scalar/openapi-types';
-import type { AnyObject, ErrorObject, Filesystem, FilesystemEntry, ThrowOnErrorOption } from '../types/index.ts';
+import type { AnyObject, ErrorObject, Filesystem, FilesystemEntry, ThrowOnErrorOption } from '../types/index.js';
 export type ResolveReferencesResult = {
     valid: boolean;
     errors: ErrorObject[];

package/dist/utils/resolveReferences.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resolveReferences.d.ts","sourceRoot":"","sources":["../../src/utils/resolveReferences.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAGpD,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAehH,MAAM,MAAM,uBAAuB,GAAG;IACpC,KAAK,EAAE,OAAO,CAAA;IACd,MAAM,EAAE,WAAW,EAAE,CAAA;IACrB,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG,kBAAkB,GAAG;IAC1D;;;;OAIG;IACH,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,SAAS,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAA;CACnE,CAAA;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAE/B,KAAK,EAAE,SAAS,GAAG,UAAU,EAE7B,OAAO,CAAC,EAAE,wBAAwB,EAElC,IAAI,CAAC,EAAE,eAAe,EAEtB,MAAM,GAAE,WAAW,EAAO,GACzB,uBAAuB,CA0BzB"}
+{"version":3,"file":"resolveReferences.d.ts","sourceRoot":"","sources":["../../src/utils/resolveReferences.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAGpD,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AAe7G,MAAM,MAAM,uBAAuB,GAAG;IACpC,KAAK,EAAE,OAAO,CAAA;IACd,MAAM,EAAE,WAAW,EAAE,CAAA;IACrB,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG,kBAAkB,GAAG;IAC1D;;;;OAIG;IACH,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,SAAS,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAA;CACnE,CAAA;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAE/B,KAAK,EAAE,SAAS,GAAG,UAAU,EAE7B,OAAO,CAAC,EAAE,wBAAwB,EAElC,IAAI,CAAC,EAAE,eAAe,EAEtB,MAAM,GAAE,WAAW,EAAO,GACzB,uBAAuB,CA0BzB"}

package/dist/utils/resolveReferences.js

@@ -1,150 +1,102 @@
-import { ERRORS } from '../configuration/index.js';
-import { getEntrypoint } from './getEntrypoint.js';
-import { getSegmentsFromPath } from './getSegmentsFromPath.js';
-import { makeFilesystem } from './makeFilesystem.js';
-
-/**
- * Takes a specification and resolves all references.
- */
-function resolveReferences(
-// Just a specification, or a set of files.
-input, 
-// Additional options to control the behaviour
-options, 
-// Fallback to the entrypoint
-file, 
-// Errors that occurred during the process
-errors = []) {
-    // Detach from input
-    const clonedInput = structuredClone(input);
-    // Make it a filesystem, even if it’s just one file
-    const filesystem = makeFilesystem(clonedInput);
-    // Get the main file
-    const entrypoint = getEntrypoint(filesystem);
-    const finalInput = file?.specification ?? entrypoint.specification;
-    // Recursively resolve all references
-    dereference(finalInput, filesystem, file ?? entrypoint, new WeakSet(), errors, options);
-    // Remove duplicats (according to message) from errors
-    errors = errors.filter((error, index, self) => index === self.findIndex((t) => t.message === error.message && t.code === error.code));
-    // Return the resolved specification
-    return {
-        valid: errors.length === 0,
-        errors,
-        schema: finalInput,
-    };
+import { ERRORS } from "../configuration/index.js";
+import { getEntrypoint } from "./getEntrypoint.js";
+import { getSegmentsFromPath } from "./getSegmentsFromPath.js";
+import { makeFilesystem } from "./makeFilesystem.js";
+function resolveReferences(input, options, file, errors = []) {
+  const clonedInput = structuredClone(input);
+  const filesystem = makeFilesystem(clonedInput);
+  const entrypoint = getEntrypoint(filesystem);
+  const finalInput = file?.specification ?? entrypoint.specification;
+  dereference(finalInput, filesystem, file ?? entrypoint, /* @__PURE__ */ new WeakSet(), errors, options);
+  errors = errors.filter(
+    (error, index, self) => index === self.findIndex((t) => t.message === error.message && t.code === error.code)
+  );
+  return {
+    valid: errors.length === 0,
+    errors,
+    schema: finalInput
+  };
 }
-/**
- * Resolves the circular reference to an object and deletes the $ref properties (in-place).
- */
-function dereference(schema, filesystem, entrypoint, 
-// references to resolved object
-resolvedSchemas, 
-// error output
-errors, options) {
-    if (schema === null || resolvedSchemas.has(schema)) {
-        return;
+function dereference(schema, filesystem, entrypoint, resolvedSchemas, errors, options) {
+  if (schema === null || resolvedSchemas.has(schema)) {
+    return;
+  }
+  resolvedSchemas.add(schema);
+  function resolveExternal(externalFile) {
+    dereference(externalFile.specification, filesystem, externalFile, resolvedSchemas, errors, options);
+    return externalFile;
+  }
+  while (schema.$ref !== void 0) {
+    const resolved = resolveUri(schema.$ref, options, entrypoint, filesystem, resolveExternal, errors);
+    if (typeof resolved !== "object" || resolved === null) {
+      break;
     }
-    resolvedSchemas.add(schema);
-    function resolveExternal(externalFile) {
-        dereference(externalFile.specification, filesystem, externalFile, resolvedSchemas, errors, options);
-        return externalFile;
+    const dereferencedRef = schema.$ref;
+    delete schema.$ref;
+    for (const key of Object.keys(resolved)) {
+      if (schema[key] === void 0) {
+        schema[key] = resolved[key];
+      }
     }
-    while (schema.$ref !== undefined) {
-        // Find the referenced content
-        const resolved = resolveUri(schema.$ref, options, entrypoint, filesystem, resolveExternal, errors);
-        // invalid
-        if (typeof resolved !== 'object' || resolved === null) {
-            break;
-        }
-        const dereferencedRef = schema.$ref;
-        // Get rid of the reference
-        delete schema.$ref;
-        for (const key of Object.keys(resolved)) {
-            if (schema[key] === undefined) {
-                schema[key] = resolved[key];
-            }
-        }
-        if (dereferencedRef) {
-            options?.onDereference?.({ schema, ref: dereferencedRef });
-        }
+    if (dereferencedRef) {
+      options?.onDereference?.({ schema, ref: dereferencedRef });
     }
-    // Iterate over the whole object
-    for (const value of Object.values(schema)) {
-        if (typeof value === 'object' && value !== null) {
-            dereference(value, filesystem, entrypoint, resolvedSchemas, errors, options);
-        }
+  }
+  for (const value of Object.values(schema)) {
+    if (typeof value === "object" && value !== null) {
+      dereference(value, filesystem, entrypoint, resolvedSchemas, errors, options);
     }
+  }
 }
-/**
- * Resolves a URI to a part of the specification
- *
- * The output is not necessarily dereferenced
- */
-function resolveUri(
-// 'foobar.json#/foo/bar'
-uri, options, 
-// { filename: './foobar.json '}
-file, 
-// [ { filename: './foobar.json '} ]
-filesystem, 
-// a function to resolve references in external file
-resolve, errors) {
-    // Ignore invalid URIs
-    if (typeof uri !== 'string') {
-        if (options?.throwOnError) {
-            throw new Error(ERRORS.INVALID_REFERENCE.replace('%s', uri));
-        }
-        errors.push({
-            code: 'INVALID_REFERENCE',
-            message: ERRORS.INVALID_REFERENCE.replace('%s', uri),
-        });
-        return undefined;
+function resolveUri(uri, options, file, filesystem, resolve, errors) {
+  if (typeof uri !== "string") {
+    if (options?.throwOnError) {
+      throw new Error(ERRORS.INVALID_REFERENCE.replace("%s", uri));
     }
-    // Understand the URI
-    const [prefix, path] = uri.split('#', 2);
-    /** Check whether the file is pointing to itself */
-    const isDifferentFile = prefix !== file.filename;
-    // External references
-    if (prefix && isDifferentFile) {
-        const externalReference = filesystem.find((entry) => {
-            return entry.filename === prefix;
-        });
-        if (!externalReference) {
-            if (options?.throwOnError) {
-                throw new Error(ERRORS.EXTERNAL_REFERENCE_NOT_FOUND.replace('%s', prefix));
-            }
-            errors.push({
-                code: 'EXTERNAL_REFERENCE_NOT_FOUND',
-                message: ERRORS.EXTERNAL_REFERENCE_NOT_FOUND.replace('%s', prefix),
-            });
-            return undefined;
-        }
-        // $ref: 'other-file.yaml'
-        if (path === undefined) {
-            return externalReference.specification;
-        }
-        // $ref: 'other-file.yaml#/foo/bar'
-        // resolve refs first before accessing properties directly
-        return resolveUri(`#${path}`, options, resolve(externalReference), filesystem, resolve, errors);
+    errors.push({
+      code: "INVALID_REFERENCE",
+      message: ERRORS.INVALID_REFERENCE.replace("%s", uri)
+    });
+    return void 0;
+  }
+  const [prefix, path] = uri.split("#", 2);
+  const isDifferentFile = prefix !== file.filename;
+  if (prefix && isDifferentFile) {
+    const externalReference = filesystem.find((entry) => {
+      return entry.filename === prefix;
+    });
+    if (!externalReference) {
+      if (options?.throwOnError) {
+        throw new Error(ERRORS.EXTERNAL_REFERENCE_NOT_FOUND.replace("%s", prefix));
+      }
+      errors.push({
+        code: "EXTERNAL_REFERENCE_NOT_FOUND",
+        message: ERRORS.EXTERNAL_REFERENCE_NOT_FOUND.replace("%s", prefix)
+      });
+      return void 0;
     }
-    // Pointers
-    const segments = getSegmentsFromPath(path);
-    // Try to find the URI
-    try {
-        return segments.reduce((acc, key) => {
-            return acc[key];
-        }, file.specification);
+    if (path === void 0) {
+      return externalReference.specification;
     }
-    catch (_error) {
-        if (options?.throwOnError) {
-            throw new Error(ERRORS.INVALID_REFERENCE.replace('%s', uri));
-        }
-        errors.push({
-            code: 'INVALID_REFERENCE',
-            message: ERRORS.INVALID_REFERENCE.replace('%s', uri),
-        });
+    return resolveUri(`#${path}`, options, resolve(externalReference), filesystem, resolve, errors);
+  }
+  const segments = getSegmentsFromPath(path);
+  try {
+    return segments.reduce((acc, key) => {
+      return acc[key];
+    }, file.specification);
+  } catch (_error) {
+    if (options?.throwOnError) {
+      throw new Error(ERRORS.INVALID_REFERENCE.replace("%s", uri));
     }
-    return undefined;
+    errors.push({
+      code: "INVALID_REFERENCE",
+      message: ERRORS.INVALID_REFERENCE.replace("%s", uri)
+    });
+  }
+  return void 0;
 }
-
-export { resolveReferences };
+export {
+  resolveReferences
+};
+//# sourceMappingURL=resolveReferences.js.map

package/dist/utils/resolveReferences.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/utils/resolveReferences.ts"],
+  "sourcesContent": ["import type { OpenAPI } from '@scalar/openapi-types'\n\nimport { ERRORS } from '../configuration/index'\nimport type { AnyObject, ErrorObject, Filesystem, FilesystemEntry, ThrowOnErrorOption } from '../types/index'\nimport { getEntrypoint } from './getEntrypoint'\nimport { getSegmentsFromPath } from './getSegmentsFromPath'\nimport { makeFilesystem } from './makeFilesystem'\n\n// TODO: Add support for all pointer words\n// export const pointerWords = new Set([\n//   '$ref',\n//   '$id',\n//   '$anchor',\n//   '$dynamicRef',\n//   '$dynamicAnchor',\n//   '$schema',\n// ])\n\nexport type ResolveReferencesResult = {\n  valid: boolean\n  errors: ErrorObject[]\n  schema: OpenAPI.Document\n}\n\nexport type ResolveReferencesOptions = ThrowOnErrorOption & {\n  /**\n   * Fired when dereferenced a schema.\n   *\n   * Note that for object schemas, its properties may not be dereferenced when the hook is called.\n   */\n  onDereference?: (data: { schema: AnyObject; ref: string }) => void\n}\n\n/**\n * Takes a specification and resolves all references.\n */\nexport function resolveReferences(\n  // Just a specification, or a set of files.\n  input: AnyObject | Filesystem,\n  // Additional options to control the behaviour\n  options?: ResolveReferencesOptions,\n  // Fallback to the entrypoint\n  file?: FilesystemEntry,\n  // Errors that occurred during the process\n  errors: ErrorObject[] = [],\n): ResolveReferencesResult {\n  // Detach from input\n  const clonedInput = structuredClone(input)\n\n  // Make it a filesystem, even if it\u2019s just one file\n  const filesystem = makeFilesystem(clonedInput)\n\n  // Get the main file\n  const entrypoint = getEntrypoint(filesystem)\n\n  const finalInput = file?.specification ?? entrypoint.specification\n\n  // Recursively resolve all references\n  dereference(finalInput, filesystem, file ?? entrypoint, new WeakSet(), errors, options)\n\n  // Remove duplicats (according to message) from errors\n  errors = errors.filter(\n    (error, index, self) => index === self.findIndex((t) => t.message === error.message && t.code === error.code),\n  )\n\n  // Return the resolved specification\n  return {\n    valid: errors.length === 0,\n    errors,\n    schema: finalInput as OpenAPI.Document,\n  }\n}\n\n/**\n * Resolves the circular reference to an object and deletes the $ref properties (in-place).\n */\nfunction dereference(\n  schema: AnyObject,\n  filesystem: Filesystem,\n  entrypoint: FilesystemEntry,\n  // references to resolved object\n  resolvedSchemas: WeakSet<object>,\n  // error output\n  errors: ErrorObject[],\n\n  options?: ResolveReferencesOptions,\n): void {\n  if (schema === null || resolvedSchemas.has(schema)) {\n    return\n  }\n  resolvedSchemas.add(schema)\n\n  function resolveExternal(externalFile: FilesystemEntry) {\n    dereference(externalFile.specification, filesystem, externalFile, resolvedSchemas, errors, options)\n\n    return externalFile\n  }\n\n  while (schema.$ref !== undefined) {\n    // Find the referenced content\n    const resolved = resolveUri(schema.$ref, options, entrypoint, filesystem, resolveExternal, errors)\n\n    // invalid\n    if (typeof resolved !== 'object' || resolved === null) {\n      break\n    }\n    const dereferencedRef = schema.$ref\n\n    // Get rid of the reference\n    delete schema.$ref\n\n    for (const key of Object.keys(resolved)) {\n      if (schema[key] === undefined) {\n        schema[key] = resolved[key]\n      }\n    }\n\n    if (dereferencedRef) {\n      options?.onDereference?.({ schema, ref: dereferencedRef })\n    }\n  }\n\n  // Iterate over the whole object\n  for (const value of Object.values(schema)) {\n    if (typeof value === 'object' && value !== null) {\n      dereference(value, filesystem, entrypoint, resolvedSchemas, errors, options)\n    }\n  }\n}\n\n/**\n * Resolves a URI to a part of the specification\n *\n * The output is not necessarily dereferenced\n */\nfunction resolveUri(\n  // 'foobar.json#/foo/bar'\n  uri: string,\n  options: ResolveReferencesOptions,\n  // { filename: './foobar.json '}\n  file: FilesystemEntry,\n  // [ { filename: './foobar.json '} ]\n  filesystem: Filesystem,\n\n  // a function to resolve references in external file\n  resolve: (file: FilesystemEntry) => FilesystemEntry,\n\n  errors: ErrorObject[],\n): AnyObject | undefined {\n  // Ignore invalid URIs\n  if (typeof uri !== 'string') {\n    if (options?.throwOnError) {\n      throw new Error(ERRORS.INVALID_REFERENCE.replace('%s', uri))\n    }\n\n    errors.push({\n      code: 'INVALID_REFERENCE',\n      message: ERRORS.INVALID_REFERENCE.replace('%s', uri),\n    })\n\n    return undefined\n  }\n\n  // Understand the URI\n  const [prefix, path] = uri.split('#', 2)\n\n  /** Check whether the file is pointing to itself */\n  const isDifferentFile = prefix !== file.filename\n\n  // External references\n  if (prefix && isDifferentFile) {\n    const externalReference = filesystem.find((entry) => {\n      return entry.filename === prefix\n    })\n\n    if (!externalReference) {\n      if (options?.throwOnError) {\n        throw new Error(ERRORS.EXTERNAL_REFERENCE_NOT_FOUND.replace('%s', prefix))\n      }\n\n      errors.push({\n        code: 'EXTERNAL_REFERENCE_NOT_FOUND',\n        message: ERRORS.EXTERNAL_REFERENCE_NOT_FOUND.replace('%s', prefix),\n      })\n\n      return undefined\n    }\n    // $ref: 'other-file.yaml'\n    if (path === undefined) {\n      return externalReference.specification\n    }\n\n    // $ref: 'other-file.yaml#/foo/bar'\n    // resolve refs first before accessing properties directly\n    return resolveUri(`#${path}`, options, resolve(externalReference), filesystem, resolve, errors)\n  }\n\n  // Pointers\n  const segments = getSegmentsFromPath(path)\n\n  // Try to find the URI\n  try {\n    return segments.reduce((acc, key) => {\n      return acc[key]\n    }, file.specification)\n  } catch (_error) {\n    if (options?.throwOnError) {\n      throw new Error(ERRORS.INVALID_REFERENCE.replace('%s', uri))\n    }\n\n    errors.push({\n      code: 'INVALID_REFERENCE',\n      message: ERRORS.INVALID_REFERENCE.replace('%s', uri),\n    })\n  }\n\n  return undefined\n}\n"],
+  "mappings": "AAEA,SAAS,cAAc;AAEvB,SAAS,qBAAqB;AAC9B,SAAS,2BAA2B;AACpC,SAAS,sBAAsB;AA8BxB,SAAS,kBAEd,OAEA,SAEA,MAEA,SAAwB,CAAC,GACA;AAEzB,QAAM,cAAc,gBAAgB,KAAK;AAGzC,QAAM,aAAa,eAAe,WAAW;AAG7C,QAAM,aAAa,cAAc,UAAU;AAE3C,QAAM,aAAa,MAAM,iBAAiB,WAAW;AAGrD,cAAY,YAAY,YAAY,QAAQ,YAAY,oBAAI,QAAQ,GAAG,QAAQ,OAAO;AAGtF,WAAS,OAAO;AAAA,IACd,CAAC,OAAO,OAAO,SAAS,UAAU,KAAK,UAAU,CAAC,MAAM,EAAE,YAAY,MAAM,WAAW,EAAE,SAAS,MAAM,IAAI;AAAA,EAC9G;AAGA,SAAO;AAAA,IACL,OAAO,OAAO,WAAW;AAAA,IACzB;AAAA,IACA,QAAQ;AAAA,EACV;AACF;AAKA,SAAS,YACP,QACA,YACA,YAEA,iBAEA,QAEA,SACM;AACN,MAAI,WAAW,QAAQ,gBAAgB,IAAI,MAAM,GAAG;AAClD;AAAA,EACF;AACA,kBAAgB,IAAI,MAAM;AAE1B,WAAS,gBAAgB,cAA+B;AACtD,gBAAY,aAAa,eAAe,YAAY,cAAc,iBAAiB,QAAQ,OAAO;AAElG,WAAO;AAAA,EACT;AAEA,SAAO,OAAO,SAAS,QAAW;AAEhC,UAAM,WAAW,WAAW,OAAO,MAAM,SAAS,YAAY,YAAY,iBAAiB,MAAM;AAGjG,QAAI,OAAO,aAAa,YAAY,aAAa,MAAM;AACrD;AAAA,IACF;AACA,UAAM,kBAAkB,OAAO;AAG/B,WAAO,OAAO;AAEd,eAAW,OAAO,OAAO,KAAK,QAAQ,GAAG;AACvC,UAAI,OAAO,GAAG,MAAM,QAAW;AAC7B,eAAO,GAAG,IAAI,SAAS,GAAG;AAAA,MAC5B;AAAA,IACF;AAEA,QAAI,iBAAiB;AACnB,eAAS,gBAAgB,EAAE,QAAQ,KAAK,gBAAgB,CAAC;AAAA,IAC3D;AAAA,EACF;AAGA,aAAW,SAAS,OAAO,OAAO,MAAM,GAAG;AACzC,QAAI,OAAO,UAAU,YAAY,UAAU,MAAM;AAC/C,kBAAY,OAAO,YAAY,YAAY,iBAAiB,QAAQ,OAAO;AAAA,IAC7E;AAAA,EACF;AACF;AAOA,SAAS,WAEP,KACA,SAEA,MAEA,YAGA,SAEA,QACuB;AAEvB,MAAI,OAAO,QAAQ,UAAU;AAC3B,QAAI,SAAS,cAAc;AACzB,YAAM,IAAI,MAAM,OAAO,kBAAkB,QAAQ,MAAM,GAAG,CAAC;AAAA,IAC7D;AAEA,WAAO,KAAK;AAAA,MACV,MAAM;AAAA,MACN,SAAS,OAAO,kBAAkB,QAAQ,MAAM,GAAG;AAAA,IACrD,CAAC;AAED,WAAO;AAAA,EACT;AAGA,QAAM,CAAC,QAAQ,IAAI,IAAI,IAAI,MAAM,KAAK,CAAC;AAGvC,QAAM,kBAAkB,WAAW,KAAK;AAGxC,MAAI,UAAU,iBAAiB;AAC7B,UAAM,oBAAoB,WAAW,KAAK,CAAC,UAAU;AACnD,aAAO,MAAM,aAAa;AAAA,IAC5B,CAAC;AAED,QAAI,CAAC,mBAAmB;AACtB,UAAI,SAAS,cAAc;AACzB,cAAM,IAAI,MAAM,OAAO,6BAA6B,QAAQ,MAAM,MAAM,CAAC;AAAA,MAC3E;AAEA,aAAO,KAAK;AAAA,QACV,MAAM;AAAA,QACN,SAAS,OAAO,6BAA6B,QAAQ,MAAM,MAAM;AAAA,MACnE,CAAC;AAED,aAAO;AAAA,IACT;AAEA,QAAI,SAAS,QAAW;AACtB,aAAO,kBAAkB;AAAA,IAC3B;AAIA,WAAO,WAAW,IAAI,IAAI,IAAI,SAAS,QAAQ,iBAAiB,GAAG,YAAY,SAAS,MAAM;AAAA,EAChG;AAGA,QAAM,WAAW,oBAAoB,IAAI;AAGzC,MAAI;AACF,WAAO,SAAS,OAAO,CAAC,KAAK,QAAQ;AACnC,aAAO,IAAI,GAAG;AAAA,IAChB,GAAG,KAAK,aAAa;AAAA,EACvB,SAAS,QAAQ;AACf,QAAI,SAAS,cAAc;AACzB,YAAM,IAAI,MAAM,OAAO,kBAAkB,QAAQ,MAAM,GAAG,CAAC;AAAA,IAC7D;AAEA,WAAO,KAAK;AAAA,MACV,MAAM;AAAA,MACN,SAAS,OAAO,kBAAkB,QAAQ,MAAM,GAAG;AAAA,IACrD,CAAC;AAAA,EACH;AAEA,SAAO;AACT;",
+  "names": []
+}