@scalar/openapi-parser 0.10.16 → 0.11.0

package/dist/utils/validate.js

@@ -1,18 +1,16 @@
-import { Validator } from '../lib/Validator/Validator.js';
-import { makeFilesystem } from './makeFilesystem.js';
-
-/**
- * Validates an OpenAPI document
- */
+import { Validator } from "../lib/Validator/Validator.js";
+import { makeFilesystem } from "./makeFilesystem.js";
 async function validate(value, options) {
-    const filesystem = makeFilesystem(value);
-    const validator = new Validator();
-    const result = await validator.validate(filesystem, options);
-    return {
-        ...result,
-        specification: validator.specification,
-        version: validator.version,
-    };
+  const filesystem = makeFilesystem(value);
+  const validator = new Validator();
+  const result = await validator.validate(filesystem, options);
+  return {
+    ...result,
+    specification: validator.specification,
+    version: validator.version
+  };
 }
-
-export { validate };
+export {
+  validate
+};
+//# sourceMappingURL=validate.js.map

package/dist/utils/validate.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/utils/validate.ts"],
+  "sourcesContent": ["import type { OpenAPI } from '@scalar/openapi-types'\n\nimport { Validator } from '../lib/Validator/Validator'\nimport type { AnyObject, Filesystem, ThrowOnErrorOption, ValidateResult } from '../types/index'\nimport { makeFilesystem } from './makeFilesystem'\n\nexport type ValidateOptions = ThrowOnErrorOption\n\n/**\n * Validates an OpenAPI document\n */\nexport async function validate(\n  value: string | AnyObject | Filesystem,\n  options?: ValidateOptions,\n): Promise<ValidateResult> {\n  const filesystem = makeFilesystem(value)\n\n  const validator = new Validator()\n  const result = await validator.validate(filesystem, options)\n\n  return {\n    ...result,\n    specification: validator.specification as OpenAPI.Document,\n    version: validator.version,\n  }\n}\n"],
+  "mappings": "AAEA,SAAS,iBAAiB;AAE1B,SAAS,sBAAsB;AAO/B,eAAsB,SACpB,OACA,SACyB;AACzB,QAAM,aAAa,eAAe,KAAK;AAEvC,QAAM,YAAY,IAAI,UAAU;AAChC,QAAM,SAAS,MAAM,UAAU,SAAS,YAAY,OAAO;AAE3D,SAAO;AAAA,IACL,GAAG;AAAA,IACH,eAAe,UAAU;AAAA,IACzB,SAAS,UAAU;AAAA,EACrB;AACF;",
+  "names": []
+}

package/dist/utils/validate.test.js

@@ -0,0 +1,64 @@
+import { describe, expect, it } from "vitest";
+import { validate } from "./validate.js";
+describe("validate", async () => {
+  it("fails on invalid schema", async () => {
+    const result = await validate("");
+    expect(result.valid).toBe(false);
+    expect(result.errors).toMatchObject([
+      {
+        message: "Can\u2019t find supported Swagger/OpenAPI version in specification, version must be a string."
+      }
+    ]);
+  });
+  it("returns errors for an invalid schema", async () => {
+    const result = await validate(
+      `{
+        "openapi": "3.1.0",
+        "paths": {}
+      }`
+    );
+    expect(result.valid).toBe(false);
+    expect(result.errors).toBeTypeOf("object");
+    expect(Array.isArray(result.errors)).toBe(true);
+    expect(result.errors.length).toBe(1);
+    expect(result.errors[0]).toMatchObject({
+      message: "must have required property 'info'"
+    });
+  });
+  it("returns errors for an invalid specification", async () => {
+    const result = await validate("pineapples");
+    expect(result.errors).toHaveLength(1);
+    expect(result.errors[0].message).toBe(
+      "Can\u2019t find supported Swagger/OpenAPI version in specification, version must be a string."
+    );
+  });
+  it("works with YAML", async () => {
+    const result = await validate(`openapi: 3.1.0
+info:
+  title: Hello World
+  version: 1.0.0
+paths: {}
+`);
+    expect(result.schema.info.title).toBe("Hello World");
+  });
+  it("doesn\u2019t work with OpenAPI 4.0.0", async () => {
+    const result = await validate(`{
+      "openapi": "4.0.0",
+      "info": {
+          "title": "Hello World",
+          "version": "1.0.0"
+      },
+      "paths": {}
+    }`);
+    expect(result.errors).toHaveLength(1);
+    expect(result.errors[0].message).toContain("Can\u2019t find supported Swagger/OpenAPI version in specification");
+  });
+  it("throws an error", async () => {
+    expect(async () => {
+      await validate(void 0, {
+        throwOnError: true
+      });
+    }).rejects.toThrowError("Can\u2019t find JSON, YAML or filename in data");
+  });
+});
+//# sourceMappingURL=validate.test.js.map

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

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/utils/validate.test.ts"],
+  "sourcesContent": ["import { describe, expect, it } from 'vitest'\n\nimport { validate } from './validate'\n\ndescribe('validate', async () => {\n  it('fails on invalid schema', async () => {\n    const result = await validate('')\n\n    expect(result.valid).toBe(false)\n    expect(result.errors).toMatchObject([\n      {\n        message: 'Can\u2019t find supported Swagger/OpenAPI version in specification, version must be a string.',\n      },\n    ])\n  })\n\n  it('returns errors for an invalid schema', async () => {\n    const result = await validate(\n      `{\n        \"openapi\": \"3.1.0\",\n        \"paths\": {}\n      }`,\n    )\n\n    expect(result.valid).toBe(false)\n\n    expect(result.errors).toBeTypeOf('object')\n    expect(Array.isArray(result.errors)).toBe(true)\n    expect(result.errors.length).toBe(1)\n    expect(result.errors[0]).toMatchObject({\n      message: \"must have required property 'info'\",\n    })\n  })\n\n  it('returns errors for an invalid specification', async () => {\n    const result = await validate('pineapples')\n\n    expect(result.errors).toHaveLength(1)\n    expect(result.errors[0].message).toBe(\n      'Can\u2019t find supported Swagger/OpenAPI version in specification, version must be a string.',\n    )\n  })\n\n  it('works with YAML', async () => {\n    const result = await validate(`openapi: 3.1.0\ninfo:\n  title: Hello World\n  version: 1.0.0\npaths: {}\n`)\n\n    expect(result.schema.info.title).toBe('Hello World')\n  })\n\n  it('doesn\u2019t work with OpenAPI 4.0.0', async () => {\n    const result = await validate(`{\n      \"openapi\": \"4.0.0\",\n      \"info\": {\n          \"title\": \"Hello World\",\n          \"version\": \"1.0.0\"\n      },\n      \"paths\": {}\n    }`)\n\n    expect(result.errors).toHaveLength(1)\n    expect(result.errors[0].message).toContain('Can\u2019t find supported Swagger/OpenAPI version in specification')\n  })\n\n  it('throws an error', async () => {\n    expect(async () => {\n      await validate(undefined, {\n        throwOnError: true,\n      })\n    }).rejects.toThrowError('Can\u2019t find JSON, YAML or filename in data')\n  })\n})\n"],
+  "mappings": "AAAA,SAAS,UAAU,QAAQ,UAAU;AAErC,SAAS,gBAAgB;AAEzB,SAAS,YAAY,YAAY;AAC/B,KAAG,2BAA2B,YAAY;AACxC,UAAM,SAAS,MAAM,SAAS,EAAE;AAEhC,WAAO,OAAO,KAAK,EAAE,KAAK,KAAK;AAC/B,WAAO,OAAO,MAAM,EAAE,cAAc;AAAA,MAClC;AAAA,QACE,SAAS;AAAA,MACX;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAED,KAAG,wCAAwC,YAAY;AACrD,UAAM,SAAS,MAAM;AAAA,MACnB;AAAA;AAAA;AAAA;AAAA,IAIF;AAEA,WAAO,OAAO,KAAK,EAAE,KAAK,KAAK;AAE/B,WAAO,OAAO,MAAM,EAAE,WAAW,QAAQ;AACzC,WAAO,MAAM,QAAQ,OAAO,MAAM,CAAC,EAAE,KAAK,IAAI;AAC9C,WAAO,OAAO,OAAO,MAAM,EAAE,KAAK,CAAC;AACnC,WAAO,OAAO,OAAO,CAAC,CAAC,EAAE,cAAc;AAAA,MACrC,SAAS;AAAA,IACX,CAAC;AAAA,EACH,CAAC;AAED,KAAG,+CAA+C,YAAY;AAC5D,UAAM,SAAS,MAAM,SAAS,YAAY;AAE1C,WAAO,OAAO,MAAM,EAAE,aAAa,CAAC;AACpC,WAAO,OAAO,OAAO,CAAC,EAAE,OAAO,EAAE;AAAA,MAC/B;AAAA,IACF;AAAA,EACF,CAAC;AAED,KAAG,mBAAmB,YAAY;AAChC,UAAM,SAAS,MAAM,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,CAKjC;AAEG,WAAO,OAAO,OAAO,KAAK,KAAK,EAAE,KAAK,aAAa;AAAA,EACrD,CAAC;AAED,KAAG,wCAAmC,YAAY;AAChD,UAAM,SAAS,MAAM,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAO5B;AAEF,WAAO,OAAO,MAAM,EAAE,aAAa,CAAC;AACpC,WAAO,OAAO,OAAO,CAAC,EAAE,OAAO,EAAE,UAAU,oEAA+D;AAAA,EAC5G,CAAC;AAED,KAAG,mBAAmB,YAAY;AAChC,WAAO,YAAY;AACjB,YAAM,SAAS,QAAW;AAAA,QACxB,cAAc;AAAA,MAChB,CAAC;AAAA,IACH,CAAC,EAAE,QAAQ,aAAa,gDAA2C;AAAA,EACrE,CAAC;AACH,CAAC;",
+  "names": []
+}

package/package.json

@@ -17,9 +17,9 @@
     "parser",
     "typescript"
   ],
-  "version": "0.10.16",
+  "version": "0.11.0",
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "type": "module",
   "main": "./dist/index.js",
@@ -58,22 +58,21 @@
   "devDependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
     "@babel/code-frame": "^7.24.7",
-    "@google-cloud/storage": "^7.12.1",
     "@types/node": "^20.17.10",
     "glob": "^10.3.10",
     "json-to-ast": "^2.1.0",
     "just-diff": "^6.0.2",
     "tinybench": "^2.8.0",
-    "@scalar/build-tooling": "0.1.17",
-    "@scalar/types": "0.1.8",
-    "@scalar/openapi-types": "0.2.0"
+    "@scalar/build-tooling": "0.2.0",
+    "@scalar/types": "0.2.1",
+    "@scalar/openapi-types": "0.3.1"
   },
   "scripts": {
-    "build": "scalar-build-rollup",
+    "build": "scalar-build-esbuild",
     "format": "prettier --write .",
     "lint:check": "eslint .",
     "lint:fix": "eslint .  --fix",
-    "test": "vitest",
+    "test": "NODE_OPTIONS=--max_old_space_size=8192 vitest",
     "test:prepare": "vite-node scripts/load-files.ts",
     "test:unit": "vite-node scripts/load-files.ts && vitest",
     "types:build": "scalar-types-build",