@scalar/openapi-parser 0.10.16 → 0.11.0

package/dist/utils/dereference.test.js

@@ -0,0 +1,300 @@
+import { describe, expect, it } from "vitest";
+import { dereference } from "./dereference.js";
+describe("dereference", async () => {
+  it("dereferences an OpenAPI 3.1.0 file", async () => {
+    const result = await dereference(`{
+      "openapi": "3.1.0",
+      "info": {
+          "title": "Hello World",
+          "version": "1.0.0"
+      },
+      "paths": {}
+    }`);
+    expect(result.errors).toStrictEqual([]);
+    expect(result.schema.info.title).toBe("Hello World");
+  });
+  it("dereferences an OpenAPI 3.0.0 file", async () => {
+    const result = await dereference(`{
+      "openapi": "3.0.0",
+      "info": {
+          "title": "Hello World",
+          "version": "1.0.0"
+      },
+      "paths": {}
+    }`);
+    expect(result.errors).toStrictEqual([]);
+    expect(result.schema.info.title).toBe("Hello World");
+  });
+  it("dereferences an Swagger 2.0 file", async () => {
+    const result = await dereference(`{
+      "swagger": "2.0",
+      "info": {
+          "title": "Hello World",
+          "version": "1.0.0"
+      },
+      "paths": {}
+    }`);
+    expect(result.errors).toStrictEqual([]);
+    expect(result.schema.info.title).toBe("Hello World");
+  });
+  it("returns version 3.1", async () => {
+    const result = await dereference(`{
+      "openapi": "3.1.0",
+      "info": {
+          "title": "Hello World",
+          "version": "1.0.0"
+      },
+      "paths": {}
+    }`);
+    expect(result.errors).toStrictEqual([]);
+    expect(result.version).toBe("3.1");
+  });
+  it("returns version 3.0", async () => {
+    const result = await dereference(`{
+      "openapi": "3.0.0",
+      "info": {
+          "title": "Hello World",
+          "version": "1.0.0"
+      },
+      "paths": {}
+    }`);
+    expect(result.errors).toStrictEqual([]);
+    expect(result.version).toBe("3.0");
+  });
+  it("returns version 2.0", async () => {
+    const result = await dereference(`{
+      "swagger": "2.0",
+      "info": {
+          "title": "Hello World",
+          "version": "1.0.0"
+      },
+      "paths": {}
+    }`);
+    expect(result.errors).toStrictEqual([]);
+    expect(result.version).toBe("2.0");
+  });
+  it("doesn\u2019t return version 4.0", async () => {
+    const result = await dereference(`{
+      "openapi": "4.0",
+      "info": {
+          "title": "Hello World",
+          "version": "1.0.0"
+      },
+      "paths": {}
+    }`);
+    expect(result.version).toBe(void 0);
+  });
+  it("dereferences a simple reference", async () => {
+    const openapi = {
+      openapi: "3.1.0",
+      info: {
+        title: "Hello World",
+        version: "1.0.0"
+      },
+      paths: {
+        "/test": {
+          get: {
+            responses: {
+              "200": {
+                // TODO: This is valid in @apidevtools/swagger, but not with our implementation
+                description: "foobar",
+                content: {
+                  "application/json": {
+                    schema: {
+                      $ref: "#/components/schemas/Test"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      components: {
+        schemas: {
+          Test: {
+            type: "object",
+            properties: {
+              id: {
+                type: "string"
+              }
+            }
+          }
+        }
+      }
+    };
+    const result = await dereference(openapi);
+    expect(result.errors).toStrictEqual([]);
+    expect(result.specification.paths["/test"].get.responses["200"].content["application/json"].schema).toEqual({
+      $ref: "#/components/schemas/Test"
+    });
+    expect(result.schema.paths["/test"].get.responses["200"].content["application/json"].schema).toEqual({
+      type: "object",
+      properties: {
+        id: {
+          type: "string"
+        }
+      }
+    });
+  });
+  it("throws an error", async () => {
+    expect(async () => {
+      await dereference(
+        {
+          openapi: "3.1.0",
+          info: {},
+          paths: {
+            "/foobar": {
+              post: {
+                requestBody: {
+                  $ref: "#/components/requestBodies/DoesNotExist"
+                }
+              }
+            }
+          }
+        },
+        {
+          throwOnError: true
+        }
+      );
+    }).rejects.toThrowError("Can\u2019t resolve reference: #/components/requestBodies/DoesNotExist");
+  });
+  it("resolves external file references", async () => {
+    const filesystem = [
+      {
+        isEntrypoint: true,
+        specification: {
+          openapi: "3.1.0",
+          info: {
+            title: "File Reference",
+            version: "1.0.0"
+          },
+          paths: {},
+          components: {
+            schemas: {
+              ExternalSchema: {
+                $ref: "valid.yaml#/components/schemas/ExampleSchema"
+              }
+            }
+          }
+        },
+        filename: "file-reference.yaml",
+        dir: "./",
+        references: ["valid.yaml"]
+      },
+      {
+        isEntrypoint: false,
+        specification: {
+          openapi: "3.1.0",
+          info: {
+            title: "Hello World",
+            version: "1.0.0"
+          },
+          paths: {},
+          components: {
+            schemas: {
+              ExampleSchema: {
+                type: "object",
+                properties: {
+                  id: {
+                    type: "integer",
+                    description: "Unique identifier for the example"
+                  },
+                  name: {
+                    type: "string",
+                    description: "Name of the example"
+                  },
+                  description: {
+                    type: "string",
+                    description: "Detailed description of the example"
+                  }
+                },
+                required: ["id", "name"]
+              }
+            }
+          }
+        },
+        filename: "valid.yaml",
+        dir: "./",
+        references: []
+      }
+    ];
+    const result = await dereference(filesystem);
+    expect(result.errors).toStrictEqual([]);
+    expect(result.schema.components.schemas.ExternalSchema).toEqual({
+      type: "object",
+      properties: {
+        id: {
+          type: "integer",
+          description: "Unique identifier for the example"
+        },
+        name: {
+          type: "string",
+          description: "Name of the example"
+        },
+        description: {
+          type: "string",
+          description: "Detailed description of the example"
+        }
+      },
+      required: ["id", "name"]
+    });
+  });
+  it("calls onDereference when resolving references", async () => {
+    const openapi = {
+      openapi: "3.1.0",
+      info: {
+        title: "Hello World",
+        version: "1.0.0"
+      },
+      paths: {
+        "/test": {
+          get: {
+            responses: {
+              "200": {
+                description: "foobar",
+                content: {
+                  "application/json": {
+                    schema: {
+                      $ref: "#/components/schemas/Test"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      components: {
+        schemas: {
+          Test: {
+            type: "object",
+            properties: {
+              id: {
+                type: "string"
+              }
+            }
+          }
+        }
+      }
+    };
+    const dereferencedSchemas = [];
+    const result = await dereference(openapi, {
+      onDereference: ({ schema, ref }) => {
+        expect(schema).toEqual({
+          type: "object",
+          properties: {
+            id: {
+              type: "string"
+            }
+          }
+        });
+        expect(ref).toEqual("#/components/schemas/Test");
+        dereferencedSchemas.push({ schema, ref });
+      }
+    });
+    expect(result.errors).toStrictEqual([]);
+    expect(dereferencedSchemas).toHaveLength(1);
+  });
+});
+//# sourceMappingURL=dereference.test.js.map

package/dist/utils/dereference.test.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/utils/dereference.test.ts"],
+  "sourcesContent": ["import { describe, expect, it } from 'vitest'\n\nimport { dereference } from './dereference'\n\ndescribe('dereference', async () => {\n  it('dereferences an OpenAPI 3.1.0 file', async () => {\n    const result = await dereference(`{\n      \"openapi\": \"3.1.0\",\n      \"info\": {\n          \"title\": \"Hello World\",\n          \"version\": \"1.0.0\"\n      },\n      \"paths\": {}\n    }`)\n\n    expect(result.errors).toStrictEqual([])\n    expect(result.schema.info.title).toBe('Hello World')\n  })\n\n  it('dereferences an OpenAPI 3.0.0 file', async () => {\n    const result = await dereference(`{\n      \"openapi\": \"3.0.0\",\n      \"info\": {\n          \"title\": \"Hello World\",\n          \"version\": \"1.0.0\"\n      },\n      \"paths\": {}\n    }`)\n\n    expect(result.errors).toStrictEqual([])\n    expect(result.schema.info.title).toBe('Hello World')\n  })\n\n  it('dereferences an Swagger 2.0 file', async () => {\n    const result = await dereference(`{\n      \"swagger\": \"2.0\",\n      \"info\": {\n          \"title\": \"Hello World\",\n          \"version\": \"1.0.0\"\n      },\n      \"paths\": {}\n    }`)\n\n    expect(result.errors).toStrictEqual([])\n    expect(result.schema.info.title).toBe('Hello World')\n  })\n\n  it('returns version 3.1', async () => {\n    const result = await dereference(`{\n      \"openapi\": \"3.1.0\",\n      \"info\": {\n          \"title\": \"Hello World\",\n          \"version\": \"1.0.0\"\n      },\n      \"paths\": {}\n    }`)\n\n    expect(result.errors).toStrictEqual([])\n    expect(result.version).toBe('3.1')\n  })\n\n  it('returns version 3.0', async () => {\n    const result = await dereference(`{\n      \"openapi\": \"3.0.0\",\n      \"info\": {\n          \"title\": \"Hello World\",\n          \"version\": \"1.0.0\"\n      },\n      \"paths\": {}\n    }`)\n\n    expect(result.errors).toStrictEqual([])\n    expect(result.version).toBe('3.0')\n  })\n\n  it('returns version 2.0', async () => {\n    const result = await dereference(`{\n      \"swagger\": \"2.0\",\n      \"info\": {\n          \"title\": \"Hello World\",\n          \"version\": \"1.0.0\"\n      },\n      \"paths\": {}\n    }`)\n\n    expect(result.errors).toStrictEqual([])\n    expect(result.version).toBe('2.0')\n  })\n\n  it('doesn\u2019t return version 4.0', async () => {\n    const result = await dereference(`{\n      \"openapi\": \"4.0\",\n      \"info\": {\n          \"title\": \"Hello World\",\n          \"version\": \"1.0.0\"\n      },\n      \"paths\": {}\n    }`)\n\n    expect(result.version).toBe(undefined)\n  })\n\n  it('dereferences a simple reference', async () => {\n    const openapi = {\n      openapi: '3.1.0',\n      info: {\n        title: 'Hello World',\n        version: '1.0.0',\n      },\n      paths: {\n        '/test': {\n          get: {\n            responses: {\n              '200': {\n                // TODO: This is valid in @apidevtools/swagger, but not with our implementation\n                description: 'foobar',\n                content: {\n                  'application/json': {\n                    schema: {\n                      $ref: '#/components/schemas/Test',\n                    },\n                  },\n                },\n              },\n            },\n          },\n        },\n      },\n      components: {\n        schemas: {\n          Test: {\n            type: 'object',\n            properties: {\n              id: {\n                type: 'string',\n              },\n            },\n          },\n        },\n      },\n    }\n\n    const result = await dereference(openapi)\n\n    expect(result.errors).toStrictEqual([])\n\n    // Original\n    expect(result.specification.paths['/test'].get.responses['200'].content['application/json'].schema).toEqual({\n      $ref: '#/components/schemas/Test',\n    })\n\n    // Resolved references\n    expect(result.schema.paths['/test'].get.responses['200'].content['application/json'].schema).toEqual({\n      type: 'object',\n      properties: {\n        id: {\n          type: 'string',\n        },\n      },\n    })\n  })\n\n  it('throws an error', async () => {\n    expect(async () => {\n      await dereference(\n        {\n          openapi: '3.1.0',\n          info: {},\n          paths: {\n            '/foobar': {\n              post: {\n                requestBody: {\n                  $ref: '#/components/requestBodies/DoesNotExist',\n                },\n              },\n            },\n          },\n        },\n        {\n          throwOnError: true,\n        },\n      )\n    }).rejects.toThrowError('Can\u2019t resolve reference: #/components/requestBodies/DoesNotExist')\n  })\n\n  it('resolves external file references', async () => {\n    const filesystem = [\n      {\n        isEntrypoint: true,\n        specification: {\n          openapi: '3.1.0',\n          info: {\n            title: 'File Reference',\n            version: '1.0.0',\n          },\n          paths: {},\n          components: {\n            schemas: {\n              ExternalSchema: {\n                $ref: 'valid.yaml#/components/schemas/ExampleSchema',\n              },\n            },\n          },\n        },\n        filename: 'file-reference.yaml',\n        dir: './',\n        references: ['valid.yaml'],\n      },\n      {\n        isEntrypoint: false,\n        specification: {\n          openapi: '3.1.0',\n          info: {\n            title: 'Hello World',\n            version: '1.0.0',\n          },\n          paths: {},\n          components: {\n            schemas: {\n              ExampleSchema: {\n                type: 'object',\n                properties: {\n                  id: {\n                    type: 'integer',\n                    description: 'Unique identifier for the example',\n                  },\n                  name: {\n                    type: 'string',\n                    description: 'Name of the example',\n                  },\n                  description: {\n                    type: 'string',\n                    description: 'Detailed description of the example',\n                  },\n                },\n                required: ['id', 'name'],\n              },\n            },\n          },\n        },\n        filename: 'valid.yaml',\n        dir: './',\n        references: [],\n      },\n    ]\n\n    const result = await dereference(filesystem)\n\n    expect(result.errors).toStrictEqual([])\n\n    // Check if the external reference was resolved\n    expect(result.schema.components.schemas.ExternalSchema).toEqual({\n      type: 'object',\n      properties: {\n        id: {\n          type: 'integer',\n          description: 'Unique identifier for the example',\n        },\n        name: {\n          type: 'string',\n          description: 'Name of the example',\n        },\n        description: {\n          type: 'string',\n          description: 'Detailed description of the example',\n        },\n      },\n      required: ['id', 'name'],\n    })\n  })\n\n  it('calls onDereference when resolving references', async () => {\n    const openapi = {\n      openapi: '3.1.0',\n      info: {\n        title: 'Hello World',\n        version: '1.0.0',\n      },\n      paths: {\n        '/test': {\n          get: {\n            responses: {\n              '200': {\n                description: 'foobar',\n                content: {\n                  'application/json': {\n                    schema: {\n                      $ref: '#/components/schemas/Test',\n                    },\n                  },\n                },\n              },\n            },\n          },\n        },\n      },\n      components: {\n        schemas: {\n          Test: {\n            type: 'object',\n            properties: {\n              id: {\n                type: 'string',\n              },\n            },\n          },\n        },\n      },\n    }\n\n    const dereferencedSchemas: Array<{ schema: any; ref: string }> = []\n\n    const result = await dereference(openapi, {\n      onDereference: ({ schema, ref }) => {\n        expect(schema).toEqual({\n          type: 'object',\n          properties: {\n            id: {\n              type: 'string',\n            },\n          },\n        })\n\n        expect(ref).toEqual('#/components/schemas/Test')\n\n        dereferencedSchemas.push({ schema, ref })\n      },\n    })\n\n    expect(result.errors).toStrictEqual([])\n    expect(dereferencedSchemas).toHaveLength(1)\n  })\n})\n"],
+  "mappings": "AAAA,SAAS,UAAU,QAAQ,UAAU;AAErC,SAAS,mBAAmB;AAE5B,SAAS,eAAe,YAAY;AAClC,KAAG,sCAAsC,YAAY;AACnD,UAAM,SAAS,MAAM,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAO/B;AAEF,WAAO,OAAO,MAAM,EAAE,cAAc,CAAC,CAAC;AACtC,WAAO,OAAO,OAAO,KAAK,KAAK,EAAE,KAAK,aAAa;AAAA,EACrD,CAAC;AAED,KAAG,sCAAsC,YAAY;AACnD,UAAM,SAAS,MAAM,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAO/B;AAEF,WAAO,OAAO,MAAM,EAAE,cAAc,CAAC,CAAC;AACtC,WAAO,OAAO,OAAO,KAAK,KAAK,EAAE,KAAK,aAAa;AAAA,EACrD,CAAC;AAED,KAAG,oCAAoC,YAAY;AACjD,UAAM,SAAS,MAAM,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAO/B;AAEF,WAAO,OAAO,MAAM,EAAE,cAAc,CAAC,CAAC;AACtC,WAAO,OAAO,OAAO,KAAK,KAAK,EAAE,KAAK,aAAa;AAAA,EACrD,CAAC;AAED,KAAG,uBAAuB,YAAY;AACpC,UAAM,SAAS,MAAM,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAO/B;AAEF,WAAO,OAAO,MAAM,EAAE,cAAc,CAAC,CAAC;AACtC,WAAO,OAAO,OAAO,EAAE,KAAK,KAAK;AAAA,EACnC,CAAC;AAED,KAAG,uBAAuB,YAAY;AACpC,UAAM,SAAS,MAAM,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAO/B;AAEF,WAAO,OAAO,MAAM,EAAE,cAAc,CAAC,CAAC;AACtC,WAAO,OAAO,OAAO,EAAE,KAAK,KAAK;AAAA,EACnC,CAAC;AAED,KAAG,uBAAuB,YAAY;AACpC,UAAM,SAAS,MAAM,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAO/B;AAEF,WAAO,OAAO,MAAM,EAAE,cAAc,CAAC,CAAC;AACtC,WAAO,OAAO,OAAO,EAAE,KAAK,KAAK;AAAA,EACnC,CAAC;AAED,KAAG,mCAA8B,YAAY;AAC3C,UAAM,SAAS,MAAM,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAO/B;AAEF,WAAO,OAAO,OAAO,EAAE,KAAK,MAAS;AAAA,EACvC,CAAC;AAED,KAAG,mCAAmC,YAAY;AAChD,UAAM,UAAU;AAAA,MACd,SAAS;AAAA,MACT,MAAM;AAAA,QACJ,OAAO;AAAA,QACP,SAAS;AAAA,MACX;AAAA,MACA,OAAO;AAAA,QACL,SAAS;AAAA,UACP,KAAK;AAAA,YACH,WAAW;AAAA,cACT,OAAO;AAAA;AAAA,gBAEL,aAAa;AAAA,gBACb,SAAS;AAAA,kBACP,oBAAoB;AAAA,oBAClB,QAAQ;AAAA,sBACN,MAAM;AAAA,oBACR;AAAA,kBACF;AAAA,gBACF;AAAA,cACF;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,MACA,YAAY;AAAA,QACV,SAAS;AAAA,UACP,MAAM;AAAA,YACJ,MAAM;AAAA,YACN,YAAY;AAAA,cACV,IAAI;AAAA,gBACF,MAAM;AAAA,cACR;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAEA,UAAM,SAAS,MAAM,YAAY,OAAO;AAExC,WAAO,OAAO,MAAM,EAAE,cAAc,CAAC,CAAC;AAGtC,WAAO,OAAO,cAAc,MAAM,OAAO,EAAE,IAAI,UAAU,KAAK,EAAE,QAAQ,kBAAkB,EAAE,MAAM,EAAE,QAAQ;AAAA,MAC1G,MAAM;AAAA,IACR,CAAC;AAGD,WAAO,OAAO,OAAO,MAAM,OAAO,EAAE,IAAI,UAAU,KAAK,EAAE,QAAQ,kBAAkB,EAAE,MAAM,EAAE,QAAQ;AAAA,MACnG,MAAM;AAAA,MACN,YAAY;AAAA,QACV,IAAI;AAAA,UACF,MAAM;AAAA,QACR;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAED,KAAG,mBAAmB,YAAY;AAChC,WAAO,YAAY;AACjB,YAAM;AAAA,QACJ;AAAA,UACE,SAAS;AAAA,UACT,MAAM,CAAC;AAAA,UACP,OAAO;AAAA,YACL,WAAW;AAAA,cACT,MAAM;AAAA,gBACJ,aAAa;AAAA,kBACX,MAAM;AAAA,gBACR;AAAA,cACF;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,QACA;AAAA,UACE,cAAc;AAAA,QAChB;AAAA,MACF;AAAA,IACF,CAAC,EAAE,QAAQ,aAAa,uEAAkE;AAAA,EAC5F,CAAC;AAED,KAAG,qCAAqC,YAAY;AAClD,UAAM,aAAa;AAAA,MACjB;AAAA,QACE,cAAc;AAAA,QACd,eAAe;AAAA,UACb,SAAS;AAAA,UACT,MAAM;AAAA,YACJ,OAAO;AAAA,YACP,SAAS;AAAA,UACX;AAAA,UACA,OAAO,CAAC;AAAA,UACR,YAAY;AAAA,YACV,SAAS;AAAA,cACP,gBAAgB;AAAA,gBACd,MAAM;AAAA,cACR;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,QACA,UAAU;AAAA,QACV,KAAK;AAAA,QACL,YAAY,CAAC,YAAY;AAAA,MAC3B;AAAA,MACA;AAAA,QACE,cAAc;AAAA,QACd,eAAe;AAAA,UACb,SAAS;AAAA,UACT,MAAM;AAAA,YACJ,OAAO;AAAA,YACP,SAAS;AAAA,UACX;AAAA,UACA,OAAO,CAAC;AAAA,UACR,YAAY;AAAA,YACV,SAAS;AAAA,cACP,eAAe;AAAA,gBACb,MAAM;AAAA,gBACN,YAAY;AAAA,kBACV,IAAI;AAAA,oBACF,MAAM;AAAA,oBACN,aAAa;AAAA,kBACf;AAAA,kBACA,MAAM;AAAA,oBACJ,MAAM;AAAA,oBACN,aAAa;AAAA,kBACf;AAAA,kBACA,aAAa;AAAA,oBACX,MAAM;AAAA,oBACN,aAAa;AAAA,kBACf;AAAA,gBACF;AAAA,gBACA,UAAU,CAAC,MAAM,MAAM;AAAA,cACzB;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,QACA,UAAU;AAAA,QACV,KAAK;AAAA,QACL,YAAY,CAAC;AAAA,MACf;AAAA,IACF;AAEA,UAAM,SAAS,MAAM,YAAY,UAAU;AAE3C,WAAO,OAAO,MAAM,EAAE,cAAc,CAAC,CAAC;AAGtC,WAAO,OAAO,OAAO,WAAW,QAAQ,cAAc,EAAE,QAAQ;AAAA,MAC9D,MAAM;AAAA,MACN,YAAY;AAAA,QACV,IAAI;AAAA,UACF,MAAM;AAAA,UACN,aAAa;AAAA,QACf;AAAA,QACA,MAAM;AAAA,UACJ,MAAM;AAAA,UACN,aAAa;AAAA,QACf;AAAA,QACA,aAAa;AAAA,UACX,MAAM;AAAA,UACN,aAAa;AAAA,QACf;AAAA,MACF;AAAA,MACA,UAAU,CAAC,MAAM,MAAM;AAAA,IACzB,CAAC;AAAA,EACH,CAAC;AAED,KAAG,iDAAiD,YAAY;AAC9D,UAAM,UAAU;AAAA,MACd,SAAS;AAAA,MACT,MAAM;AAAA,QACJ,OAAO;AAAA,QACP,SAAS;AAAA,MACX;AAAA,MACA,OAAO;AAAA,QACL,SAAS;AAAA,UACP,KAAK;AAAA,YACH,WAAW;AAAA,cACT,OAAO;AAAA,gBACL,aAAa;AAAA,gBACb,SAAS;AAAA,kBACP,oBAAoB;AAAA,oBAClB,QAAQ;AAAA,sBACN,MAAM;AAAA,oBACR;AAAA,kBACF;AAAA,gBACF;AAAA,cACF;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,MACA,YAAY;AAAA,QACV,SAAS;AAAA,UACP,MAAM;AAAA,YACJ,MAAM;AAAA,YACN,YAAY;AAAA,cACV,IAAI;AAAA,gBACF,MAAM;AAAA,cACR;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAEA,UAAM,sBAA2D,CAAC;AAElE,UAAM,SAAS,MAAM,YAAY,SAAS;AAAA,MACxC,eAAe,CAAC,EAAE,QAAQ,IAAI,MAAM;AAClC,eAAO,MAAM,EAAE,QAAQ;AAAA,UACrB,MAAM;AAAA,UACN,YAAY;AAAA,YACV,IAAI;AAAA,cACF,MAAM;AAAA,YACR;AAAA,UACF;AAAA,QACF,CAAC;AAED,eAAO,GAAG,EAAE,QAAQ,2BAA2B;AAE/C,4BAAoB,KAAK,EAAE,QAAQ,IAAI,CAAC;AAAA,MAC1C;AAAA,IACF,CAAC;AAED,WAAO,OAAO,MAAM,EAAE,cAAc,CAAC,CAAC;AACtC,WAAO,mBAAmB,EAAE,aAAa,CAAC;AAAA,EAC5C,CAAC;AACH,CAAC;",
+  "names": []
+}

package/dist/utils/details.d.ts

@@ -1,5 +1,5 @@
 import type { UnknownObject } from '@scalar/types/utils';
-import type { DetailsResult } from '../types/index.ts';
+import type { DetailsResult } from '../types/index.js';
 /**
  * Get versions of the OpenAPI document.
  */

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

@@ -1 +1 @@
-{"version":3,"file":"details.d.ts","sourceRoot":"","sources":["../../src/utils/details.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAGxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AAEtD;;GAEG;AACH,wBAAgB,OAAO,CAAC,aAAa,EAAE,aAAa,GAAG,aAAa,CA2BnE"}
+{"version":3,"file":"details.d.ts","sourceRoot":"","sources":["../../src/utils/details.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAGxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAEnD;;GAEG;AACH,wBAAgB,OAAO,CAAC,aAAa,EAAE,aAAa,GAAG,aAAa,CA2BnE"}

package/dist/utils/details.js

@@ -1,32 +1,30 @@
-import { OpenApiVersions } from '../configuration/index.js';
-
-/**
- * Get versions of the OpenAPI document.
- */
+import { OpenApiVersions } from "../configuration/index.js";
 function details(specification) {
-    if (specification === null) {
-        return {
-            version: undefined,
-            specificationType: undefined,
-            specificationVersion: undefined,
-        };
-    }
-    for (const version of new Set(OpenApiVersions)) {
-        const specificationType = version === '2.0' ? 'swagger' : 'openapi';
-        const value = specification[specificationType];
-        if (typeof value === 'string' && value.startsWith(version)) {
-            return {
-                version: version,
-                specificationType,
-                specificationVersion: value,
-            };
-        }
-    }
+  if (specification === null) {
     return {
-        version: undefined,
-        specificationType: undefined,
-        specificationVersion: undefined,
+      version: void 0,
+      specificationType: void 0,
+      specificationVersion: void 0
     };
+  }
+  for (const version of new Set(OpenApiVersions)) {
+    const specificationType = version === "2.0" ? "swagger" : "openapi";
+    const value = specification[specificationType];
+    if (typeof value === "string" && value.startsWith(version)) {
+      return {
+        version,
+        specificationType,
+        specificationVersion: value
+      };
+    }
+  }
+  return {
+    version: void 0,
+    specificationType: void 0,
+    specificationVersion: void 0
+  };
 }
-
-export { details };
+export {
+  details
+};
+//# sourceMappingURL=details.js.map

package/dist/utils/details.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/utils/details.ts"],
+  "sourcesContent": ["import type { UnknownObject } from '@scalar/types/utils'\n\nimport { OpenApiVersions } from '../configuration/index'\nimport type { DetailsResult } from '../types/index'\n\n/**\n * Get versions of the OpenAPI document.\n */\nexport function details(specification: UnknownObject): DetailsResult {\n  if (specification === null) {\n    return {\n      version: undefined,\n      specificationType: undefined,\n      specificationVersion: undefined,\n    }\n  }\n\n  for (const version of new Set(OpenApiVersions)) {\n    const specificationType = version === '2.0' ? 'swagger' : 'openapi'\n    const value = specification[specificationType]\n\n    if (typeof value === 'string' && value.startsWith(version)) {\n      return {\n        version: version,\n        specificationType,\n        specificationVersion: value,\n      }\n    }\n  }\n\n  return {\n    version: undefined,\n    specificationType: undefined,\n    specificationVersion: undefined,\n  }\n}\n"],
+  "mappings": "AAEA,SAAS,uBAAuB;AAMzB,SAAS,QAAQ,eAA6C;AACnE,MAAI,kBAAkB,MAAM;AAC1B,WAAO;AAAA,MACL,SAAS;AAAA,MACT,mBAAmB;AAAA,MACnB,sBAAsB;AAAA,IACxB;AAAA,EACF;AAEA,aAAW,WAAW,IAAI,IAAI,eAAe,GAAG;AAC9C,UAAM,oBAAoB,YAAY,QAAQ,YAAY;AAC1D,UAAM,QAAQ,cAAc,iBAAiB;AAE7C,QAAI,OAAO,UAAU,YAAY,MAAM,WAAW,OAAO,GAAG;AAC1D,aAAO;AAAA,QACL;AAAA,QACA;AAAA,QACA,sBAAsB;AAAA,MACxB;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AAAA,IACL,SAAS;AAAA,IACT,mBAAmB;AAAA,IACnB,sBAAsB;AAAA,EACxB;AACF;",
+  "names": []
+}

package/dist/utils/errors.test.js

@@ -0,0 +1,48 @@
+import { describe, expect, it } from "vitest";
+import { validate } from "./validate.js";
+describe("errors", () => {
+  it("info required", async () => {
+    const result = await validate({
+      openapi: "3.1.0",
+      paths: {}
+    });
+    expect(result).toMatchObject({
+      errors: [
+        {
+          message: `must have required property 'info'`
+        }
+      ],
+      valid: false
+    });
+  });
+  it("unevaluated property", async () => {
+    const spec = {
+      openapi: "3.1.0",
+      info: {
+        title: "Hello World",
+        version: "1.0.0"
+      },
+      paths: {
+        "/test": {
+          foobar: {
+            responses: {
+              200: {
+                description: "OK"
+              }
+            }
+          }
+        }
+      }
+    };
+    const result = await validate(spec);
+    expect(result).toMatchObject({
+      errors: [
+        {
+          message: "Property foobar is not expected to be here"
+        }
+      ],
+      valid: false
+    });
+  });
+});
+//# sourceMappingURL=errors.test.js.map

package/dist/utils/errors.test.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/utils/errors.test.ts"],
+  "sourcesContent": ["import { describe, expect, it } from 'vitest'\n\nimport { validate } from './validate'\n\ndescribe('errors', () => {\n  it('info required', async () => {\n    const result = await validate({\n      openapi: '3.1.0',\n      paths: {},\n    })\n\n    expect(result).toMatchObject({\n      errors: [\n        {\n          message: `must have required property 'info'`,\n        },\n      ],\n      valid: false,\n    })\n  })\n\n  it('unevaluated property', async () => {\n    const spec = {\n      openapi: '3.1.0',\n      info: {\n        title: 'Hello World',\n        version: '1.0.0',\n      },\n      paths: {\n        '/test': {\n          foobar: {\n            responses: {\n              200: {\n                description: 'OK',\n              },\n            },\n          },\n        },\n      },\n    }\n    const result = await validate(spec)\n\n    expect(result).toMatchObject({\n      errors: [\n        {\n          message: 'Property foobar is not expected to be here',\n        },\n      ],\n      valid: false,\n    })\n  })\n})\n"],
+  "mappings": "AAAA,SAAS,UAAU,QAAQ,UAAU;AAErC,SAAS,gBAAgB;AAEzB,SAAS,UAAU,MAAM;AACvB,KAAG,iBAAiB,YAAY;AAC9B,UAAM,SAAS,MAAM,SAAS;AAAA,MAC5B,SAAS;AAAA,MACT,OAAO,CAAC;AAAA,IACV,CAAC;AAED,WAAO,MAAM,EAAE,cAAc;AAAA,MAC3B,QAAQ;AAAA,QACN;AAAA,UACE,SAAS;AAAA,QACX;AAAA,MACF;AAAA,MACA,OAAO;AAAA,IACT,CAAC;AAAA,EACH,CAAC;AAED,KAAG,wBAAwB,YAAY;AACrC,UAAM,OAAO;AAAA,MACX,SAAS;AAAA,MACT,MAAM;AAAA,QACJ,OAAO;AAAA,QACP,SAAS;AAAA,MACX;AAAA,MACA,OAAO;AAAA,QACL,SAAS;AAAA,UACP,QAAQ;AAAA,YACN,WAAW;AAAA,cACT,KAAK;AAAA,gBACH,aAAa;AAAA,cACf;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AACA,UAAM,SAAS,MAAM,SAAS,IAAI;AAElC,WAAO,MAAM,EAAE,cAAc;AAAA,MAC3B,QAAQ;AAAA,QACN;AAAA,UACE,SAAS;AAAA,QACX;AAAA,MACF;AAAA,MACA,OAAO;AAAA,IACT,CAAC;AAAA,EACH,CAAC;AACH,CAAC;",
+  "names": []
+}

package/dist/utils/escapeJsonPointer.js

@@ -1,10 +1,7 @@
-/**
- * Escapes a JSON pointer string.
- *
- * Example: `/foo/bar~baz` -> `/foo~1bar~0baz`
- */
 function escapeJsonPointer(str) {
-    return str.replace(/~/g, '~0').replace(/\//g, '~1');
+  return str.replace(/~/g, "~0").replace(/\//g, "~1");
 }
-
-export { escapeJsonPointer };
+export {
+  escapeJsonPointer
+};
+//# sourceMappingURL=escapeJsonPointer.js.map

package/dist/utils/escapeJsonPointer.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/utils/escapeJsonPointer.ts"],
+  "sourcesContent": ["/**\n * Escapes a JSON pointer string.\n *\n * Example: `/foo/bar~baz` -> `/foo~1bar~0baz`\n */\nexport function escapeJsonPointer(str: string) {\n  return str.replace(/~/g, '~0').replace(/\\//g, '~1')\n}\n"],
+  "mappings": "AAKO,SAAS,kBAAkB,KAAa;AAC7C,SAAO,IAAI,QAAQ,MAAM,IAAI,EAAE,QAAQ,OAAO,IAAI;AACpD;",
+  "names": []
+}

package/dist/utils/escapeJsonPointer.test.js

@@ -0,0 +1,11 @@
+import { describe, expect, it } from "vitest";
+import { escapeJsonPointer } from "./escapeJsonPointer.js";
+describe("escapeJsonPointer", async () => {
+  it("should escape a slash", () => {
+    expect(escapeJsonPointer("application/json")).toBe("application~1json");
+  });
+  it("should escape multiple slashes", () => {
+    expect(escapeJsonPointer("/api/users/{id}/reports")).toBe("~1api~1users~1{id}~1reports");
+  });
+});
+//# sourceMappingURL=escapeJsonPointer.test.js.map

package/dist/utils/escapeJsonPointer.test.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/utils/escapeJsonPointer.test.ts"],
+  "sourcesContent": ["import { describe, expect, it } from 'vitest'\n\nimport { escapeJsonPointer } from './escapeJsonPointer'\n\ndescribe('escapeJsonPointer', async () => {\n  it('should escape a slash', () => {\n    expect(escapeJsonPointer('application/json')).toBe('application~1json')\n  })\n\n  it('should escape multiple slashes', () => {\n    expect(escapeJsonPointer('/api/users/{id}/reports')).toBe('~1api~1users~1{id}~1reports')\n  })\n})\n"],
+  "mappings": "AAAA,SAAS,UAAU,QAAQ,UAAU;AAErC,SAAS,yBAAyB;AAElC,SAAS,qBAAqB,YAAY;AACxC,KAAG,yBAAyB,MAAM;AAChC,WAAO,kBAAkB,kBAAkB,CAAC,EAAE,KAAK,mBAAmB;AAAA,EACxE,CAAC;AAED,KAAG,kCAAkC,MAAM;AACzC,WAAO,kBAAkB,yBAAyB,CAAC,EAAE,KAAK,6BAA6B;AAAA,EACzF,CAAC;AACH,CAAC;",
+  "names": []
+}

package/dist/utils/filter.d.ts

@@ -1,4 +1,4 @@
-import type { AnyApiDefinitionFormat, AnyObject, FilterResult } from '../types/index.ts';
+import type { AnyApiDefinitionFormat, AnyObject, FilterResult } from '../types/index.js';
 export type FilterCallback = (schema: AnyObject) => boolean;
 /**
  * Filter the specification based on the callback

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

@@ -1 +1 @@
-{"version":3,"file":"filter.d.ts","sourceRoot":"","sources":["../../src/utils/filter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAKxF,MAAM,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,SAAS,KAAK,OAAO,CAAA;AAE3D;;GAEG;AACH,wBAAgB,MAAM,CAAC,aAAa,EAAE,sBAAsB,EAAE,QAAQ,EAAE,cAAc,GAAG,YAAY,CAQpG"}
+{"version":3,"file":"filter.d.ts","sourceRoot":"","sources":["../../src/utils/filter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAKrF,MAAM,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,SAAS,KAAK,OAAO,CAAA;AAE3D;;GAEG;AACH,wBAAgB,MAAM,CAAC,aAAa,EAAE,sBAAsB,EAAE,QAAQ,EAAE,cAAc,GAAG,YAAY,CAQpG"}

package/dist/utils/filter.js

@@ -1,17 +1,15 @@
-import { getEntrypoint } from './getEntrypoint.js';
-import { makeFilesystem } from './makeFilesystem.js';
-import { traverse } from './traverse.js';
-
-/**
- * Filter the specification based on the callback
- */
+import { getEntrypoint } from "./getEntrypoint.js";
+import { makeFilesystem } from "./makeFilesystem.js";
+import { traverse } from "./traverse.js";
 function filter(specification, callback) {
-    const filesystem = makeFilesystem(specification);
-    return {
-        specification: traverse(getEntrypoint(filesystem).specification, (schema) => {
-            return callback(schema) ? schema : undefined;
-        }),
-    };
+  const filesystem = makeFilesystem(specification);
+  return {
+    specification: traverse(getEntrypoint(filesystem).specification, (schema) => {
+      return callback(schema) ? schema : void 0;
+    })
+  };
 }
-
-export { filter };
+export {
+  filter
+};
+//# sourceMappingURL=filter.js.map

package/dist/utils/filter.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/utils/filter.ts"],
+  "sourcesContent": ["import type { AnyApiDefinitionFormat, AnyObject, FilterResult } from '../types/index'\nimport { getEntrypoint } from './getEntrypoint'\nimport { makeFilesystem } from './makeFilesystem'\nimport { traverse } from './traverse'\n\nexport type FilterCallback = (schema: AnyObject) => boolean\n\n/**\n * Filter the specification based on the callback\n */\nexport function filter(specification: AnyApiDefinitionFormat, callback: FilterCallback): FilterResult {\n  const filesystem = makeFilesystem(specification)\n\n  return {\n    specification: traverse(getEntrypoint(filesystem).specification, (schema) => {\n      return callback(schema) ? schema : undefined\n    }),\n  }\n}\n"],
+  "mappings": "AACA,SAAS,qBAAqB;AAC9B,SAAS,sBAAsB;AAC/B,SAAS,gBAAgB;AAOlB,SAAS,OAAO,eAAuC,UAAwC;AACpG,QAAM,aAAa,eAAe,aAAa;AAE/C,SAAO;AAAA,IACL,eAAe,SAAS,cAAc,UAAU,EAAE,eAAe,CAAC,WAAW;AAC3E,aAAO,SAAS,MAAM,IAAI,SAAS;AAAA,IACrC,CAAC;AAAA,EACH;AACF;",
+  "names": []
+}

package/dist/utils/getEntrypoint.d.ts

@@ -1,4 +1,4 @@
-import type { Filesystem, FilesystemEntry } from '../types/index.ts';
+import type { Filesystem, FilesystemEntry } from '../types/index.js';
 /**
  * Return just the entrypoint of the filesystem.
  */

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

@@ -1 +1 @@
-{"version":3,"file":"getEntrypoint.d.ts","sourceRoot":"","sources":["../../src/utils/getEntrypoint.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEpE;;GAEG;AACH,wBAAgB,aAAa,CAAC,UAAU,CAAC,EAAE,UAAU,GAAG,eAAe,GAAG,SAAS,CAElF"}
+{"version":3,"file":"getEntrypoint.d.ts","sourceRoot":"","sources":["../../src/utils/getEntrypoint.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAEjE;;GAEG;AACH,wBAAgB,aAAa,CAAC,UAAU,CAAC,EAAE,UAAU,GAAG,eAAe,GAAG,SAAS,CAElF"}

package/dist/utils/getEntrypoint.js

@@ -1,8 +1,7 @@
-/**
- * Return just the entrypoint of the filesystem.
- */
 function getEntrypoint(filesystem) {
-    return filesystem?.find((file) => file.isEntrypoint);
+  return filesystem?.find((file) => file.isEntrypoint);
 }
-
-export { getEntrypoint };
+export {
+  getEntrypoint
+};
+//# sourceMappingURL=getEntrypoint.js.map

package/dist/utils/getEntrypoint.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/utils/getEntrypoint.ts"],
+  "sourcesContent": ["import type { Filesystem, FilesystemEntry } from '../types/index'\n\n/**\n * Return just the entrypoint of the filesystem.\n */\nexport function getEntrypoint(filesystem?: Filesystem): FilesystemEntry | undefined {\n  return filesystem?.find((file) => file.isEntrypoint)\n}\n"],
+  "mappings": "AAKO,SAAS,cAAc,YAAsD;AAClF,SAAO,YAAY,KAAK,CAAC,SAAS,KAAK,YAAY;AACrD;",
+  "names": []
+}

package/dist/utils/getEntrypoint.test.js

@@ -0,0 +1,18 @@
+import { describe, expect, it } from "vitest";
+import { getEntrypoint } from "./getEntrypoint.js";
+import { makeFilesystem } from "./makeFilesystem.js";
+describe("getEntrypoint", () => {
+  it("keeps the object reference", () => {
+    const result = makeFilesystem({
+      foo: "bar"
+    });
+    const entrypoint = getEntrypoint(result);
+    entrypoint.specification.foo = "baz";
+    expect(result[0].specification.foo).toBe("baz");
+  });
+  it("returns undefined for an empty filesystem", () => {
+    const entrypoint = getEntrypoint([]);
+    expect(entrypoint).toBe(void 0);
+  });
+});
+//# sourceMappingURL=getEntrypoint.test.js.map

package/dist/utils/getEntrypoint.test.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/utils/getEntrypoint.test.ts"],
+  "sourcesContent": ["import { describe, expect, it } from 'vitest'\n\nimport { getEntrypoint } from './getEntrypoint'\nimport { makeFilesystem } from './makeFilesystem'\n\ndescribe('getEntrypoint', () => {\n  it('keeps the object reference', () => {\n    const result = makeFilesystem({\n      foo: 'bar',\n    })\n\n    const entrypoint = getEntrypoint(result)\n\n    // Modify the entrypoint\n    entrypoint.specification.foo = 'baz'\n\n    // Check whether the original was modified\n    expect(result[0].specification.foo).toBe('baz')\n  })\n\n  it('returns undefined for an empty filesystem', () => {\n    const entrypoint = getEntrypoint([])\n\n    // Check whether the original was modified\n    expect(entrypoint).toBe(undefined)\n  })\n})\n"],
+  "mappings": "AAAA,SAAS,UAAU,QAAQ,UAAU;AAErC,SAAS,qBAAqB;AAC9B,SAAS,sBAAsB;AAE/B,SAAS,iBAAiB,MAAM;AAC9B,KAAG,8BAA8B,MAAM;AACrC,UAAM,SAAS,eAAe;AAAA,MAC5B,KAAK;AAAA,IACP,CAAC;AAED,UAAM,aAAa,cAAc,MAAM;AAGvC,eAAW,cAAc,MAAM;AAG/B,WAAO,OAAO,CAAC,EAAE,cAAc,GAAG,EAAE,KAAK,KAAK;AAAA,EAChD,CAAC;AAED,KAAG,6CAA6C,MAAM;AACpD,UAAM,aAAa,cAAc,CAAC,CAAC;AAGnC,WAAO,UAAU,EAAE,KAAK,MAAS;AAAA,EACnC,CAAC;AACH,CAAC;",
+  "names": []
+}

package/dist/utils/getListOfReferences.d.ts

@@ -1,4 +1,4 @@
-import type { AnyObject } from '../types/index.ts';
+import type { AnyObject } from '../types/index.js';
 /**
  * Walks through the specification and returns all references as an array.
  *