@scalar/openapi-parser 0.26.1 → 0.27.0

package/dist/utils/resolve-references.d.ts

@@ -1,9 +1,8 @@
-import type { OpenAPI } from '@scalar/openapi-types';
-import type { AnyObject, ErrorObject, Filesystem, FilesystemEntry, ThrowOnErrorOption } from '../types/index.js';
+import type { AnyObject, ErrorObject, Filesystem, FilesystemEntry, ThrowOnErrorOption, UnknownObject } from '../types/index.js';
 type ResolveReferencesResult = {
     valid: boolean;
     errors: ErrorObject[];
-    schema: OpenAPI.Document;
+    schema: UnknownObject;
 };
 export type ResolveReferencesOptions = ThrowOnErrorOption & {
     /**

package/dist/utils/resolve-references.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resolve-references.d.ts","sourceRoot":"","sources":["../../src/utils/resolve-references.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAGpD,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAgB5G,KAAK,uBAAuB,GAAG;IAC7B,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,CAAC;QAAC,QAAQ,EAAE,SAAS,CAAA;KAAE,KAAK,IAAI,CAAA;CACxF,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,CAuCzB"}
+{"version":3,"file":"resolve-references.d.ts","sourceRoot":"","sources":["../../src/utils/resolve-references.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,SAAS,EACT,WAAW,EACX,UAAU,EACV,eAAe,EACf,kBAAkB,EAClB,aAAa,EACd,MAAM,eAAe,CAAA;AAgBtB,KAAK,uBAAuB,GAAG;IAC7B,KAAK,EAAE,OAAO,CAAA;IACd,MAAM,EAAE,WAAW,EAAE,CAAA;IACrB,MAAM,EAAE,aAAa,CAAA;CACtB,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,CAAC;QAAC,QAAQ,EAAE,SAAS,CAAA;KAAE,KAAK,IAAI,CAAA;CACxF,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,CAuCzB"}

package/dist/utils/resolve-references.js

@@ -166,6 +166,9 @@ resolve, errors) {
     // Try to find the URI
     try {
         return segments.reduce((acc, key) => {
+            if (typeof acc !== 'object' || acc === null || !(key in acc)) {
+                throw new Error(ERRORS.INVALID_REFERENCE.replace('%s', uri));
+            }
             return acc[key];
         }, file.specification);
     }

package/dist/utils/transform/sanitize.d.ts

@@ -1,5 +1,4 @@
-import type { OpenAPI } from '@scalar/openapi-types';
-import type { AnyObject } from '../../types/index.js';
+import type { AnyObject, UnknownObject } from '../../types/index.js';
 export { DEFAULT_TITLE } from './utils/addInfoObject.js';
 export { DEFAULT_OPENAPI_VERSION } from './utils/addLatestOpenApiVersion.js';
 /**
@@ -7,5 +6,5 @@ export { DEFAULT_OPENAPI_VERSION } from './utils/addLatestOpenApiVersion.js';
  *
  * @deprecated We're about to drop this from the package.
  */
-export declare function sanitize(definition: AnyObject): OpenAPI.Document;
+export declare function sanitize(definition: AnyObject): UnknownObject;
 //# sourceMappingURL=sanitize.d.ts.map

package/dist/utils/transform/sanitize.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sanitize.d.ts","sourceRoot":"","sources":["../../../src/utils/transform/sanitize.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAEpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAS9C,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAA;AAEzE;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,UAAU,EAAE,SAAS,GAAG,OAAO,CAAC,QAAQ,CAUhE"}
+{"version":3,"file":"sanitize.d.ts","sourceRoot":"","sources":["../../../src/utils/transform/sanitize.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAS7D,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAA;AAEzE;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,UAAU,EAAE,SAAS,GAAG,aAAa,CAU7D"}

package/dist/utils/upgrade.d.ts

@@ -1,7 +1,7 @@
-import type { OpenAPIV3_1 } from '@scalar/openapi-types';
-import type { AnyObject, Filesystem, UpgradeResult } from '../types/index.js';
+import type { Document as OpenApiDocumentV3_1 } from '@scalar/openapi-types/3.1';
+import type { Filesystem, UnknownObject, UpgradeResult } from '../types/index.js';
 /**
  * Upgrade specification to OpenAPI 3.1.0
  */
-export declare function upgrade(value: string | AnyObject | Filesystem): UpgradeResult<OpenAPIV3_1.Document>;
+export declare function upgrade(value: string | UnknownObject | Filesystem): UpgradeResult<OpenApiDocumentV3_1>;
 //# sourceMappingURL=upgrade.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"upgrade.d.ts","sourceRoot":"","sources":["../../src/utils/upgrade.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAIxD,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAMzE;;GAEG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,aAAa,CAAC,WAAW,CAAC,QAAQ,CAAC,CAmBnG"}
+{"version":3,"file":"upgrade.d.ts","sourceRoot":"","sources":["../../src/utils/upgrade.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,IAAI,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AAGhF,OAAO,KAAK,EAAE,UAAU,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAM7E;;GAEG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,GAAG,UAAU,GAAG,aAAa,CAAC,mBAAmB,CAAC,CAmBtG"}

package/dist/utils/validate.d.ts

@@ -1,7 +1,7 @@
-import type { AnyObject, Filesystem, ThrowOnErrorOption, ValidateResult } from '../types/index.js';
+import type { Filesystem, ThrowOnErrorOption, UnknownObject, ValidateResult } from '../types/index.js';
 export type ValidateOptions = ThrowOnErrorOption;
 /**
  * Validates an OpenAPI document
  */
-export declare function validate(value: string | AnyObject | Filesystem, options?: ValidateOptions): Promise<ValidateResult>;
+export declare function validate(value: string | UnknownObject | Filesystem, options?: ValidateOptions): Promise<ValidateResult>;
 //# sourceMappingURL=validate.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../src/utils/validate.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAI9F,MAAM,MAAM,eAAe,GAAG,kBAAkB,CAAA;AAEhD;;GAEG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC,CAmBnH"}
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../src/utils/validate.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,UAAU,EAEV,kBAAkB,EAClB,aAAa,EACb,cAAc,EACf,MAAM,eAAe,CAAA;AAItB,MAAM,MAAM,eAAe,GAAG,kBAAkB,CAAA;AAqBhD;;GAEG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,MAAM,GAAG,aAAa,GAAG,UAAU,EAC1C,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,cAAc,CAAC,CA6CzB"}

package/dist/utils/validate.js

@@ -1,5 +1,17 @@
 import { Validator } from '../lib/Validator/Validator.js';
 import { makeFilesystem } from './make-filesystem.js';
+const withStrictSpecification = (specification, version) => {
+    if (!specification || typeof specification !== 'object') {
+        return undefined;
+    }
+    if (version === '2.0' && specification.swagger === '2.0') {
+        return specification;
+    }
+    if ((version === '3.0' || version === '3.1' || version === '3.2') && typeof specification.openapi === 'string') {
+        return specification;
+    }
+    return undefined;
+};
 /**
  * Validates an OpenAPI document
  */
@@ -12,8 +24,31 @@ export function validate(value, options) {
          * Currently contains no asynchronous logic, but returns a Promise
          * to preserve API compatibility and allow async logic in the future.
          */
+        if (result.valid) {
+            const specification = withStrictSpecification(validator.specification, validator.version);
+            if (!specification) {
+                return Promise.resolve({
+                    valid: false,
+                    errors: [
+                        {
+                            message: `Validated OpenAPI ${validator.version} document is missing required top-level version field.`,
+                        },
+                    ],
+                    schema: result.schema,
+                    specification: validator.specification,
+                    version: validator.version,
+                });
+            }
+            return Promise.resolve({
+                ...result,
+                specification,
+                version: validator.version,
+            });
+        }
         return Promise.resolve({
-            ...result,
+            valid: false,
+            errors: result.errors,
+            schema: result.schema,
             specification: validator.specification,
             version: validator.version,
         });

package/package.json

@@ -17,7 +17,7 @@
     "parser",
     "typescript"
   ],
-  "version": "0.26.1",
+  "version": "0.27.0",
   "engines": {
     "node": ">=22"
   },
@@ -53,11 +53,11 @@
     "ajv-formats": "^3.0.1",
     "jsonpointer": "^5.0.1",
     "leven": "^4.0.0",
-    "yaml": "^2.8.0",
+    "yaml": "^2.8.3",
     "@scalar/helpers": "0.5.3",
-    "@scalar/json-magic": "0.12.9",
+    "@scalar/openapi-upgrader": "0.2.6",
     "@scalar/openapi-types": "0.8.0",
-    "@scalar/openapi-upgrader": "0.2.6"
+    "@scalar/json-magic": "0.12.9"
   },
   "devDependencies": {
     "@apidevtools/swagger-parser": "10.1.0",