@scalar/openapi-validator 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# @scalar/openapi-validator
+
+## 0.1.0
+
+### Minor Changes
+
+- [#9967](https://github.com/scalar/scalar/pull/9967): Add a new `@scalar/openapi-validator` package that validates OpenAPI documents on its own. `@scalar/openapi-parser` now uses it under the hood.
+
+  Two type-level changes in `@scalar/openapi-parser` are worth noting:
+  - `ErrorObject.path` is now `string | string[]` instead of `string[]`. Schema errors carry a JSON Pointer string, semantic errors carry path segments — both shapes were already produced at runtime, the type just says so now. Narrow with `Array.isArray` before treating it as a list.
+  - The unused `ValidationOutcome` type and the internal `OpenApiDocument` alias are no longer exported.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present Scalar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,76 @@
+# Scalar OpenAPI Validator
+
+[![Version](https://img.shields.io/npm/v/%40scalar/openapi-validator)](https://www.npmjs.com/package/@scalar/openapi-validator)
+[![Downloads](https://img.shields.io/npm/dm/%40scalar/openapi-validator)](https://www.npmjs.com/package/@scalar/openapi-validator)
+[![License](https://img.shields.io/npm/l/%40scalar%2Fopenapi-validator)](https://www.npmjs.com/package/@scalar/openapi-validator)
+[![Discord](https://img.shields.io/discord/1135330207960678410?style=flat&color=5865F2)](https://discord.gg/scalar)
+
+Validate OpenAPI documents against the OpenAPI Specification. Supports OpenAPI 3.2, 3.1, 3.0 and Swagger 2.0.
+
+This package does the schema validation part of [`@scalar/openapi-parser`](https://www.npmjs.com/package/@scalar/openapi-parser) on its own. Use it when all you need is validation and you do not want the rest of the parser.
+
+---
+
+Scalar is an open-source API platform for teams who want beautiful developer interfaces without vendor lock-in.
+
+- **[API References](https://scalar.com/products/api-references/getting-started)** — Interactive API documentation from OpenAPI and AsyncAPI specs.
+- **[Developer Docs](https://scalar.com/products/docs/getting-started)** — Write in Markdown/MDX, generate API references, sync with two-way Git.
+- **[SDK Generator](https://scalar.com/products/sdk-generator/getting-started)** — Type-safe SDKs and CLIs in TypeScript, Python, Go, PHP, Java, and Ruby.
+- **[API Client](https://scalar.com/products/api-client/getting-started)** — Open-source, offline-first Postman alternative built on OpenAPI.
+
+20M+ monthly npm installs · 15,500+ GitHub stars · MIT licensed · [scalar.com](https://scalar.com)
+
+---
+
+## Installation
+
+```bash
+npm add @scalar/openapi-validator
+```
+
+## Usage
+
+Pass a JSON string, a YAML string, or an object:
+
+```ts
+import { validate } from '@scalar/openapi-validator'
+
+const result = validate({
+  openapi: '3.1.0',
+  info: {
+    title: 'Hello World',
+    version: '1.0.0',
+  },
+  paths: {},
+})
+
+console.log(result.valid)
+
+if (!result.valid) {
+  console.log(result.errors)
+}
+```
+
+### References
+
+This validator does not resolve references. It validates a single, self-contained document. If your document references other files or URLs, bundle or dereference it first (for example with [`@scalar/json-magic`](https://www.npmjs.com/package/@scalar/json-magic) or [`@scalar/openapi-parser`](https://www.npmjs.com/package/@scalar/openapi-parser)) and then validate the result.
+
+### Throw on error
+
+```ts
+import { validate } from '@scalar/openapi-validator'
+
+try {
+  validate(document, { throwOnError: true })
+} catch (error) {
+  // Handle the first validation error
+}
+```
+
+## Community
+
+We are API nerds. You too? Let's chat on Discord: <https://discord.gg/scalar>
+
+## License
+
+The source code in this repository is licensed under [MIT](https://github.com/scalar/scalar/blob/main/LICENSE).

package/dist/detect-version.d.ts

@@ -0,0 +1,10 @@
+import { type OpenApiVersion } from './specifications.js';
+/**
+ * Detects the OpenAPI/Swagger version of a document by looking at its top-level
+ * `openapi` (3.x) or `swagger` (2.0) field.
+ *
+ * This is an intentionally small, internal copy of the parser's version
+ * detection. It is kept private so the validator does not depend on the parser.
+ */
+export declare function detectVersion(document: unknown): OpenApiVersion | undefined;
+//# sourceMappingURL=detect-version.d.ts.map

package/dist/detect-version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"detect-version.d.ts","sourceRoot":"","sources":["../src/detect-version.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,cAAc,EAAmB,MAAM,kBAAkB,CAAA;AAEvE;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,OAAO,GAAG,cAAc,GAAG,SAAS,CAuB3E"}

package/dist/detect-version.js

@@ -0,0 +1,28 @@
+import { isObject } from '@scalar/helpers/object/is-object';
+import { OpenApiVersions } from './specifications.js';
+/**
+ * Detects the OpenAPI/Swagger version of a document by looking at its top-level
+ * `openapi` (3.x) or `swagger` (2.0) field.
+ *
+ * This is an intentionally small, internal copy of the parser's version
+ * detection. It is kept private so the validator does not depend on the parser.
+ */
+export function detectVersion(document) {
+    if (!isObject(document)) {
+        return undefined;
+    }
+    for (const version of OpenApiVersions) {
+        const field = version === '2.0' ? 'swagger' : 'openapi';
+        const value = document[field];
+        if (typeof value !== 'string') {
+            continue;
+        }
+        // Match on major.minor exactly. A `startsWith` check would mistake a future
+        // "3.10.0" for "3.1" and validate it against the wrong schema.
+        const [major, minor] = value.split('.');
+        if (`${major}.${minor}` === version) {
+            return version;
+        }
+    }
+    return undefined;
+}

package/dist/errors.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Error messages used by the validator.
+ *
+ * Kept local to this package on purpose: error messages should live where they
+ * are used and be copied rather than imported across packages.
+ */
+export declare const ERRORS: {
+    readonly EMPTY_OR_INVALID: "Can't find JSON, YAML or filename in data.";
+    readonly OPENAPI_VERSION_NOT_SUPPORTED: "Can't find supported Swagger/OpenAPI version in the provided document, version must be a string.";
+};
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,MAAM;;;CAIT,CAAA"}

package/dist/errors.js

@@ -0,0 +1,10 @@
+/**
+ * Error messages used by the validator.
+ *
+ * Kept local to this package on purpose: error messages should live where they
+ * are used and be copied rather than imported across packages.
+ */
+export const ERRORS = {
+    EMPTY_OR_INVALID: "Can't find JSON, YAML or filename in data.",
+    OPENAPI_VERSION_NOT_SUPPORTED: "Can't find supported Swagger/OpenAPI version in the provided document, version must be a string.",
+};

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { OpenApiVersions as supportedVersions } from './specifications.js';
+export type { ErrorObject, OpenApiVersion, ThrowOnErrorOption, ValidationOutcome } from './types.js';
+export { type ValidateOptions, validate } from './validate.js';
+export { validatePathParameters } from './validate-path-parameters.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,IAAI,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AACvE,YAAY,EAAE,WAAW,EAAE,cAAc,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AACjG,OAAO,EAAE,KAAK,eAAe,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAC3D,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAA"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export { OpenApiVersions as supportedVersions } from './specifications.js';
+export { validate } from './validate.js';
+export { validatePathParameters } from './validate-path-parameters.js';