@scalar/openapi-parser 0.29.0 → 0.29.2

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

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

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":"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"}
+{"version":3,"file":"resolve-references.d.ts","sourceRoot":"","sources":["../../src/utils/resolve-references.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAGnE,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAgBjG,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

@@ -1,4 +1,4 @@
-import { isObject } from '@scalar/helpers/object/is-object';
+import { isObject, isObjectLike } from '@scalar/helpers/object/is-object';
 import { ERRORS } from '../configuration/index.js';
 import { getEntrypoint } from './get-entrypoint.js';
 import { getSegmentsFromPath } from './get-segments-from-path.js';
@@ -161,12 +161,12 @@ resolve, errors) {
         // resolve refs first before accessing properties directly
         return resolveUri(`#${path}`, options, resolve(externalReference), filesystem, resolve, errors);
     }
-    // Pointers
-    const segments = getSegmentsFromPath(path);
     // Try to find the URI
     try {
+        // Decoding malformed percent escapes can throw before the target is read.
+        const segments = getSegmentsFromPath(path);
         return segments.reduce((acc, key) => {
-            if (typeof acc !== 'object' || acc === null || !(key in acc)) {
+            if (!isObjectLike(acc) || !(key in acc)) {
                 throw new Error(ERRORS.INVALID_REFERENCE.replace('%s', uri));
             }
             return acc[key];

package/dist/utils/to-json.d.ts

@@ -1,3 +1,3 @@
-import type { AnyObject } from '../types/index.js';
+import type { AnyObject } from '@scalar/types/utils';
 export declare const toJson: (value: AnyObject) => string;
 //# sourceMappingURL=to-json.d.ts.map

package/dist/utils/to-json.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"to-json.d.ts","sourceRoot":"","sources":["../../src/utils/to-json.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C,eAAO,MAAM,MAAM,GAAI,OAAO,SAAS,WAAmC,CAAA"}
+{"version":3,"file":"to-json.d.ts","sourceRoot":"","sources":["../../src/utils/to-json.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAEpD,eAAO,MAAM,MAAM,GAAI,OAAO,SAAS,WAAmC,CAAA"}

package/dist/utils/to-yaml.d.ts

@@ -1,3 +1,3 @@
-import type { AnyObject } from '../types/index.js';
+import type { AnyObject } from '@scalar/types/utils';
 export declare const toYaml: (value: AnyObject) => string;
 //# sourceMappingURL=to-yaml.d.ts.map

package/dist/utils/to-yaml.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"to-yaml.d.ts","sourceRoot":"","sources":["../../src/utils/to-yaml.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C,eAAO,MAAM,MAAM,GAAI,OAAO,SAAS,WAAqB,CAAA"}
+{"version":3,"file":"to-yaml.d.ts","sourceRoot":"","sources":["../../src/utils/to-yaml.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAGpD,eAAO,MAAM,MAAM,GAAI,OAAO,SAAS,WAAqB,CAAA"}

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

@@ -1,4 +1,4 @@
-import type { AnyObject, UnknownObject } from '../../types/index.js';
+import type { AnyObject, UnknownObject } from '@scalar/types/utils';
 export { DEFAULT_TITLE } from './utils/addInfoObject.js';
 export { DEFAULT_OPENAPI_VERSION } from './utils/addLatestOpenApiVersion.js';
 /**

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,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"}
+{"version":3,"file":"sanitize.d.ts","sourceRoot":"","sources":["../../../src/utils/transform/sanitize.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AASnE,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/transform/utils/addInfoObject.d.ts

@@ -1,4 +1,4 @@
-import type { AnyObject } from '../../../types/index.js';
+import type { AnyObject } from '@scalar/types/utils';
 export declare const DEFAULT_TITLE = "API";
 export declare const addInfoObject: (definition: AnyObject) => {
     info: any;

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

@@ -1 +1 @@
-{"version":3,"file":"addInfoObject.d.ts","sourceRoot":"","sources":["../../../../src/utils/transform/utils/addInfoObject.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C,eAAO,MAAM,aAAa,QAAQ,CAAA;AAGlC,eAAO,MAAM,aAAa,GAAI,YAAY,SAAS;;CAOjD,CAAA"}
+{"version":3,"file":"addInfoObject.d.ts","sourceRoot":"","sources":["../../../../src/utils/transform/utils/addInfoObject.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAEpD,eAAO,MAAM,aAAa,QAAQ,CAAA;AAGlC,eAAO,MAAM,aAAa,GAAI,YAAY,SAAS;;CAOjD,CAAA"}

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

@@ -1,4 +1,4 @@
-import type { AnyObject } from '../../../types/index.js';
+import type { AnyObject } from '@scalar/types/utils';
 export declare const DEFAULT_OPENAPI_VERSION = "3.1.1";
 export declare const addLatestOpenApiVersion: (definition: AnyObject) => {
     openapi: any;

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

@@ -1 +1 @@
-{"version":3,"file":"addLatestOpenApiVersion.d.ts","sourceRoot":"","sources":["../../../../src/utils/transform/utils/addLatestOpenApiVersion.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C,eAAO,MAAM,uBAAuB,UAAU,CAAA;AAE9C,eAAO,MAAM,uBAAuB,GAAI,YAAY,SAAS;;CAG3D,CAAA"}
+{"version":3,"file":"addLatestOpenApiVersion.d.ts","sourceRoot":"","sources":["../../../../src/utils/transform/utils/addLatestOpenApiVersion.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAEpD,eAAO,MAAM,uBAAuB,UAAU,CAAA;AAE9C,eAAO,MAAM,uBAAuB,GAAI,YAAY,SAAS;;CAG3D,CAAA"}

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

@@ -1,3 +1,3 @@
-import type { AnyObject } from '../../../types/index.js';
+import type { AnyObject } from '@scalar/types/utils';
 export declare const addMissingTags: (definition: AnyObject) => AnyObject;
 //# sourceMappingURL=addMissingTags.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"addMissingTags.d.ts","sourceRoot":"","sources":["../../../../src/utils/transform/utils/addMissingTags.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C,eAAO,MAAM,cAAc,GAAI,YAAY,SAAS,cAmCnD,CAAA"}
+{"version":3,"file":"addMissingTags.d.ts","sourceRoot":"","sources":["../../../../src/utils/transform/utils/addMissingTags.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAEpD,eAAO,MAAM,cAAc,GAAI,YAAY,SAAS,cAmCnD,CAAA"}

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

@@ -1,3 +1,3 @@
-import type { AnyObject } from '../../../types/index.js';
+import type { AnyObject } from '@scalar/types/utils';
 export declare const normalizeSecuritySchemes: (definition: AnyObject) => AnyObject;
 //# sourceMappingURL=normalizeSecuritySchemes.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"normalizeSecuritySchemes.d.ts","sourceRoot":"","sources":["../../../../src/utils/transform/utils/normalizeSecuritySchemes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C,eAAO,MAAM,wBAAwB,GAAI,YAAY,SAAS,cAiD7D,CAAA"}
+{"version":3,"file":"normalizeSecuritySchemes.d.ts","sourceRoot":"","sources":["../../../../src/utils/transform/utils/normalizeSecuritySchemes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAEpD,eAAO,MAAM,wBAAwB,GAAI,YAAY,SAAS,cAiD7D,CAAA"}

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

@@ -1,3 +1,3 @@
-import type { AnyObject } from '../../../types/index.js';
+import type { AnyObject } from '@scalar/types/utils';
 export declare const rejectSwaggerDocuments: (defintion: AnyObject) => AnyObject;
 //# sourceMappingURL=rejectSwaggerDocuments.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"rejectSwaggerDocuments.d.ts","sourceRoot":"","sources":["../../../../src/utils/transform/utils/rejectSwaggerDocuments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C,eAAO,MAAM,sBAAsB,GAAI,WAAW,SAAS,cAM1D,CAAA"}
+{"version":3,"file":"rejectSwaggerDocuments.d.ts","sourceRoot":"","sources":["../../../../src/utils/transform/utils/rejectSwaggerDocuments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAEpD,eAAO,MAAM,sBAAsB,GAAI,WAAW,SAAS,cAM1D,CAAA"}

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

@@ -1 +1 @@
-{"version":3,"file":"traverse.d.ts","sourceRoot":"","sources":["../../src/utils/traverse.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAExD;;GAEG;AACH,wBAAgB,QAAQ,CACtB,OAAO,EAAE,aAAa,EACtB,SAAS,EAAE,CAAC,OAAO,EAAE,aAAa,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,aAAa,EACrE,IAAI,GAAE,MAAM,EAAO,iBA6BpB"}
+{"version":3,"file":"traverse.d.ts","sourceRoot":"","sources":["../../src/utils/traverse.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAa,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAEnE;;GAEG;AACH,wBAAgB,QAAQ,CACtB,OAAO,EAAE,aAAa,EACtB,SAAS,EAAE,CAAC,OAAO,EAAE,aAAa,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,aAAa,EACrE,IAAI,GAAE,MAAM,EAAO,iBA6BpB"}

package/dist/utils/upgrade.d.ts

@@ -1,7 +1,8 @@
 import type { Document as OpenApiDocumentV3_1 } from '@scalar/openapi-types/3.1';
-import type { Filesystem, UnknownObject, UpgradeResult } from '../types/index.js';
+import type { UnknownObject } from '@scalar/types/utils';
+import type { Filesystem, UpgradeResult } from '../types/index.js';
 /**
- * Upgrade specification to OpenAPI 3.1.0
+ * Upgrade older documents to OpenAPI 3.1 and preserve documents that are already newer.
  */
 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,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"}
+{"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;AAEhF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAExD,OAAO,KAAK,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAO9D;;GAEG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,GAAG,UAAU,GAAG,aAAa,CAAC,mBAAmB,CAAC,CAoBtG"}

package/dist/utils/upgrade.js

@@ -1,22 +1,23 @@
 import { upgrade as originalUpgrade } from '@scalar/openapi-upgrader';
+import { details } from './details.js';
 import { getEntrypoint } from './get-entrypoint.js';
 import { isFilesystem } from './is-filesystem.js';
 import { normalize } from './normalize.js';
 /**
- * Upgrade specification to OpenAPI 3.1.0
+ * Upgrade older documents to OpenAPI 3.1 and preserve documents that are already newer.
  */
 export function upgrade(value) {
     if (!value) {
         return {
             specification: null,
-            version: '3.1',
+            version: undefined,
         };
     }
     // TODO: Run upgrade over the whole filesystem
     const document = originalUpgrade(isFilesystem(value) ? getEntrypoint(value).specification : normalize(value), '3.1');
+    const { version } = details(document);
     return {
         specification: document,
-        // TODO: Make dynamic
-        version: '3.1',
+        version: version === '3.1' || version === '3.2' ? version : undefined,
     };
 }

package/dist/utils/validate.d.ts

@@ -1,4 +1,5 @@
-import type { Filesystem, ThrowOnErrorOption, UnknownObject, ValidateResult } from '../types/index.js';
+import type { UnknownObject } from '@scalar/types/utils';
+import type { Filesystem, ThrowOnErrorOption, ValidateResult } from '../types/index.js';
 export type ValidateOptions = ThrowOnErrorOption;
 /**
  * Validates an OpenAPI document.

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

@@ -1 +1 @@
-{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../src/utils/validate.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAEV,UAAU,EAEV,kBAAkB,EAClB,aAAa,EACb,cAAc,EACf,MAAM,eAAe,CAAA;AAMtB,MAAM,MAAM,eAAe,GAAG,kBAAkB,CAAA;AAqBhD;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,MAAM,GAAG,aAAa,GAAG,UAAU,EAC1C,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,cAAc,CAAC,CAyFzB"}
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../src/utils/validate.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAGxD,OAAO,KAAK,EAAe,UAAU,EAAyB,kBAAkB,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAMvH,MAAM,MAAM,eAAe,GAAG,kBAAkB,CAAA;AAqBhD;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,MAAM,GAAG,aAAa,GAAG,UAAU,EAC1C,OAAO,CAAC,EAAE,eAAe,GACxB,OAAO,CAAC,cAAc,CAAC,CAuFzB"}

package/dist/utils/validate.js

@@ -63,9 +63,7 @@ export function validate(value, options) {
         // Path-template semantics run on the resolved document (schema validation
         // stays on the unresolved one to avoid following circular references). This
         // matches the previous validator, which merged reference and semantic errors.
-        const semanticErrors = passedSchemaValidation
-            ? validatePathParameters((schema ?? specification))
-            : [];
+        const semanticErrors = passedSchemaValidation ? validatePathParameters(schema ?? specification) : [];
         const errors = [...(outcome.errors ?? []), ...referenceErrors, ...semanticErrors];
         const valid = outcome.valid && referenceErrors.length === 0 && semanticErrors.length === 0;
         if (!valid) {

package/package.json

@@ -17,7 +17,7 @@
     "parser",
     "typescript"
   ],
-  "version": "0.29.0",
+  "version": "0.29.2",
   "engines": {
     "node": ">=22"
   },
@@ -49,12 +49,12 @@
   "sideEffects": false,
   "dependencies": {
     "yaml": "^2.9.0",
-    "@scalar/helpers": "0.11.2",
-    "@scalar/json-magic": "0.13.3",
-    "@scalar/openapi-upgrader": "0.2.15",
-    "@scalar/openapi-validator": "0.1.0",
-    "@scalar/openapi-types": "0.9.5",
-    "@scalar/types": "0.18.3"
+    "@scalar/openapi-upgrader": "0.2.16",
+    "@scalar/helpers": "0.12.0",
+    "@scalar/openapi-types": "0.9.6",
+    "@scalar/types": "0.20.0",
+    "@scalar/openapi-validator": "0.1.2",
+    "@scalar/json-magic": "0.13.5"
   },
   "devDependencies": {
     "@apidevtools/swagger-parser": "10.1.0",