@scalar/openapi-parser 0.26.1 → 0.27.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @scalar/openapi-parser
 
+## 0.27.0
+
+### Minor Changes
+
+- [#8965](https://github.com/scalar/scalar/pull/8965): refactor: adopt strict versioned @scalar/openapi-types imports in parser types
+
 ## 0.26.1
 
 ## 0.26.0

package/dist/index.d.ts

@@ -7,7 +7,7 @@ upgradeFromTwoToThree, } from '@scalar/openapi-upgrader/2.0-to-3.0';
 export { 
 /** @deprecated Please import from @scalar/openapi-upgrader/3.0-to-3.1 instead */
 upgradeFromThreeToThreeOne, } from '@scalar/openapi-upgrader/3.0-to-3.1';
-export type { AnyObject, ErrorObject, Filesystem, LoadResult } from './types/index.js';
+export type { AnyObject, ErrorObject, Filesystem, LoadResult, UnknownObject } from './types/index.js';
 export { type DereferenceOptions, dereference } from './utils/dereference.js';
 export { filter } from './utils/filter.js';
 export { isJson } from './utils/is-json.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO;AACL,4FAA4F;AAC5F,iBAAiB,GAClB,MAAM,gDAAgD,CAAA;AACvD,OAAO;AACL,iFAAiF;AACjF,qBAAqB,GACtB,MAAM,qCAAqC,CAAA;AAC5C,OAAO;AACL,iFAAiF;AACjF,0BAA0B,GAC3B,MAAM,qCAAqC,CAAA;AAE5C,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAC7E,OAAO,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAC1E,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AACnC,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AACnC,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAA;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAA;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO;AACL,4FAA4F;AAC5F,iBAAiB,GAClB,MAAM,gDAAgD,CAAA;AACvD,OAAO;AACL,iFAAiF;AACjF,qBAAqB,GACtB,MAAM,qCAAqC,CAAA;AAC5C,OAAO;AACL,iFAAiF;AACjF,0BAA0B,GAC3B,MAAM,qCAAqC,CAAA;AAE5C,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAC5F,OAAO,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAC1E,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AACnC,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AACnC,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAA;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAA;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA"}

package/dist/lib/Validator/Validator.d.ts

@@ -1,6 +1,6 @@
 import { type ValidateFunction } from 'ajv';
 import { type OpenApiVersion } from '../../configuration/index.js';
-import type { AnyObject, Filesystem, ThrowOnErrorOption, ValidateResult } from '../../types/index.js';
+import type { Filesystem, ThrowOnErrorOption, UnknownObject, ValidationOutcome } from '../../types/index.js';
 export declare class Validator {
     version: OpenApiVersion;
     static supportedVersions: ("2.0" | "3.0" | "3.1" | "3.2")[];
@@ -8,11 +8,12 @@ export declare class Validator {
     protected errors: string;
     protected specificationVersion: string;
     protected specificationType: string;
-    specification: AnyObject;
+    specification: UnknownObject;
+    private isMutableRecord;
     /**
      * Checks whether a specification is valid and all references can be resolved.
      */
-    validate(filesystem: Filesystem, options?: ThrowOnErrorOption): ValidateResult;
+    validate(filesystem: Filesystem, options?: ThrowOnErrorOption): ValidationOutcome;
     /**
      * Ajv JSON schema validator
      */

package/dist/lib/Validator/Validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Validator.d.ts","sourceRoot":"","sources":["../../../src/lib/Validator/Validator.ts"],"names":[],"mappings":"AAAA,OAAY,EAAE,KAAK,gBAAgB,EAAE,MAAM,KAAK,CAAA;AAKhD,OAAO,EAAiC,KAAK,cAAc,EAAmB,MAAM,iBAAiB,CAAA;AACrG,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAe9F,qBAAa,SAAS;IACb,OAAO,EAAE,cAAc,CAAA;IAE9B,OAAc,iBAAiB,oCAAkB;IAGjD,SAAS,CAAC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAK;IAE9D,SAAS,CAAC,MAAM,EAAE,MAAM,CAAA;IAExB,SAAS,CAAC,oBAAoB,EAAE,MAAM,CAAA;IAEtC,SAAS,CAAC,iBAAiB,EAAE,MAAM,CAAA;IAE5B,aAAa,EAAE,SAAS,CAAA;IAE/B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,cAAc;IAsF9E;;OAEG;IACH,eAAe,CAAC,OAAO,EAAE,cAAc,GAAG,gBAAgB;CAkC3D"}
+{"version":3,"file":"Validator.d.ts","sourceRoot":"","sources":["../../../src/lib/Validator/Validator.ts"],"names":[],"mappings":"AAAA,OAAY,EAAE,KAAK,gBAAgB,EAAE,MAAM,KAAK,CAAA;AAKhD,OAAO,EAAiC,KAAK,cAAc,EAAmB,MAAM,iBAAiB,CAAA;AACrG,OAAO,KAAK,EAAE,UAAU,EAAmB,kBAAkB,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AAetH,qBAAa,SAAS;IACb,OAAO,EAAE,cAAc,CAAA;IAE9B,OAAc,iBAAiB,oCAAkB;IAGjD,SAAS,CAAC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAK;IAE9D,SAAS,CAAC,MAAM,EAAE,MAAM,CAAA;IAExB,SAAS,CAAC,oBAAoB,EAAE,MAAM,CAAA;IAEtC,SAAS,CAAC,iBAAiB,EAAE,MAAM,CAAA;IAE5B,aAAa,EAAE,aAAa,CAAA;IAEnC,OAAO,CAAC,eAAe;IAIvB;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,iBAAiB;IAmGjF;;OAEG;IACH,eAAe,CAAC,OAAO,EAAE,cAAc,GAAG,gBAAgB;CAkC3D"}

package/dist/lib/Validator/Validator.js

@@ -24,6 +24,9 @@ export class Validator {
     specificationVersion;
     specificationType;
     specification;
+    isMutableRecord(value) {
+        return typeof value === 'object' && value !== null && !Array.isArray(value);
+    }
     /**
      * Checks whether a specification is valid and all references can be resolved.
      */
@@ -34,7 +37,9 @@ export class Validator {
         this.specification = specification;
         // TODO: defaulting info.version to keep parser compatible with the previous one
         // we should bubble this error up and not throw on it
-        if (this.specification?.info && !this.specification.info.version) {
+        if (this.isMutableRecord(this.specification) &&
+            this.isMutableRecord(this.specification.info) &&
+            typeof this.specification.info.version !== 'string') {
             this.specification.info.version = '0.0.1';
         }
         try {
@@ -82,8 +87,16 @@ export class Validator {
             const resolvedReferences = resolveReferences(filesystem, options);
             const semanticErrors = validatePathParameters(resolvedReferences.schema);
             const errors = [...resolvedReferences.errors, ...semanticErrors];
+            const valid = schemaResult && resolvedReferences.valid && semanticErrors.length === 0;
+            if (!valid) {
+                return {
+                    valid: false,
+                    errors,
+                    schema: resolvedReferences.schema,
+                };
+            }
             return {
-                valid: schemaResult && resolvedReferences.valid && semanticErrors.length === 0,
+                valid: true,
                 errors,
                 schema: resolvedReferences.schema,
             };

package/dist/types/index.d.ts

@@ -1,4 +1,7 @@
-import type { OpenAPI } from '@scalar/openapi-types';
+import type { Document as OpenApiDocumentV2 } from '@scalar/openapi-types/2.0';
+import type { Document as OpenApiDocumentV3 } from '@scalar/openapi-types/3.0';
+import type { Document as OpenApiDocumentV3_1 } from '@scalar/openapi-types/3.1';
+import type { Document as OpenApiDocumentV3_2 } from '@scalar/openapi-types/3.2';
 import type { ERRORS, OpenApiVersion } from '../configuration/index.js';
 /**
  * Merge types with each other
@@ -9,25 +12,42 @@ export type UnknownObject = Record<string, unknown>;
 /**
  * JSON, YAML or object representation of an OpenAPI API definition
  */
-export type AnyApiDefinitionFormat = string | AnyObject;
+export type AnyApiDefinitionFormat = string | UnknownObject | Filesystem;
+export type StrictOpenApiDocument = OpenApiDocumentV2 | OpenApiDocumentV3 | OpenApiDocumentV3_1 | OpenApiDocumentV3_2;
+export type OpenApiDocument = StrictOpenApiDocument;
 export type LoadResult = {
     filesystem: Filesystem;
-    specification: AnyObject;
+    specification: UnknownObject | null;
     errors?: ErrorObject[];
 };
 export type ValidateResult = {
-    valid: boolean;
-    specification?: OpenAPI.Document;
+    valid: true;
+    specification: StrictOpenApiDocument;
+    version: OpenApiVersion;
+    errors?: ErrorObject[];
+    schema: StrictOpenApiDocument;
+} | {
+    valid: false;
+    specification?: UnknownObject;
     version?: OpenApiVersion;
+    errors: ErrorObject[];
+    schema?: UnknownObject;
+};
+export type ValidationOutcome = {
+    valid: true;
     errors?: ErrorObject[];
-    schema?: OpenAPI.Document;
+    schema: StrictOpenApiDocument;
+} | {
+    valid: false;
+    errors: ErrorObject[];
+    schema?: UnknownObject;
 };
-export type UpgradeResult<T extends OpenAPI.Document = OpenAPI.Document> = {
+export type UpgradeResult<T extends OpenApiDocument = OpenApiDocument> = {
     specification: T;
     version: '3.1';
 };
 export type FilterResult = {
-    specification: AnyObject;
+    specification: UnknownObject;
 };
 export type DetailsResult = {
     version: OpenApiVersion;
@@ -36,8 +56,8 @@ export type DetailsResult = {
 };
 export type DereferenceResult = {
     version?: OpenApiVersion;
-    specification?: OpenAPI.Document;
-    schema?: OpenAPI.Document;
+    specification?: UnknownObject;
+    schema?: UnknownObject;
     errors?: ErrorObject[];
 };
 export type ErrorObject = {
@@ -58,7 +78,7 @@ export type FilesystemEntry = {
     isEntrypoint: boolean;
     references: string[];
     filename: string;
-    specification: AnyObject;
+    specification: UnknownObject;
 };
 /**
  * Options, that can apply to all commands
@@ -86,7 +106,7 @@ export type Queue<T extends readonly Task[] = readonly Task[]> = {
     /** The original input, can be a JSON or YAML string or an object */
     input: AnyApiDefinitionFormat;
     /** The current OpenAPI document, but as an object */
-    specification: AnyObject;
+    specification: UnknownObject;
     /** Global options */
     options?: OpenApiOptions;
     /** Queued tasks */
@@ -98,7 +118,7 @@ export type Queue<T extends readonly Task[] = readonly Task[]> = {
 export type Task = Commands[keyof Commands]['task'];
 type EmptyCommandChainResult = {
     filesystem: Filesystem;
-    specification: AnyObject;
+    specification: UnknownObject;
 };
 /**
  * Command chain magic

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAEpD,OAAO,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAG7D;;GAEG;AACH,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAA;AAEvC,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAE3C,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEnD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,SAAS,CAAA;AAEvD,MAAM,MAAM,UAAU,GAAG;IACvB,UAAU,EAAE,UAAU,CAAA;IACtB,aAAa,EAAE,SAAS,CAAA;IACxB,MAAM,CAAC,EAAE,WAAW,EAAE,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,OAAO,CAAA;IACd,aAAa,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAA;IAChC,OAAO,CAAC,EAAE,cAAc,CAAA;IACxB,MAAM,CAAC,EAAE,WAAW,EAAE,CAAA;IACtB,MAAM,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAA;CAC1B,CAAA;AAED,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI;IACzE,aAAa,EAAE,CAAC,CAAA;IAChB,OAAO,EAAE,KAAK,CAAA;CACf,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,aAAa,EAAE,SAAS,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,cAAc,CAAA;IACvB,iBAAiB,EAAE,MAAM,CAAA;IACzB,oBAAoB,EAAE,MAAM,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,CAAC,EAAE,cAAc,CAAA;IACxB,aAAa,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAA;IAChC,MAAM,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAA;IACzB,MAAM,CAAC,EAAE,WAAW,EAAE,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,OAAO,MAAM,GAAG,MAAM,CAAA;CACpC,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,eAAe,EAAE,CAAA;AAE1C;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,EAAE,MAAM,CAAA;IACX,YAAY,EAAE,OAAO,CAAA;IACrB,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,SAAS,CAAA;CACzB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,kBAAkB,CAAA;AAE/C,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA;AAED,OAAO,CAAC,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,QAAQ;KAAG;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,SAAS,IAAI,EAAE,GAAG,SAAS,IAAI,EAAE,IAAI;IAC/D,oEAAoE;IACpE,KAAK,EAAE,sBAAsB,CAAA;IAC7B,qDAAqD;IACrD,aAAa,EAAE,SAAS,CAAA;IACxB,qBAAqB;IACrB,OAAO,CAAC,EAAE,cAAc,CAAA;IACxB,mBAAmB;IACnB,KAAK,EAAE,CAAC,CAAA;CACT,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAA;AAEnD,KAAK,uBAAuB,GAAG;IAC7B,UAAU,EAAE,UAAU,CAAA;IACtB,aAAa,EAAE,SAAS,CAAA;CACzB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,GAC/E,KAAK,SAAS,IAAI,GAChB,IAAI,SAAS,IAAI,EAAE,GACjB,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,GAC5D,KAAK,GACP,KAAK,GACP,uBAAuB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,IAAI,iBAAiB,EAAE,MAAM,2BAA2B,CAAA;AAC9E,OAAO,KAAK,EAAE,QAAQ,IAAI,iBAAiB,EAAE,MAAM,2BAA2B,CAAA;AAC9E,OAAO,KAAK,EAAE,QAAQ,IAAI,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AAChF,OAAO,KAAK,EAAE,QAAQ,IAAI,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AAEhF,OAAO,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAG7D;;GAEG;AACH,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAA;AAEvC,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAE3C,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEnD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,aAAa,GAAG,UAAU,CAAA;AAExE,MAAM,MAAM,qBAAqB,GAAG,iBAAiB,GAAG,iBAAiB,GAAG,mBAAmB,GAAG,mBAAmB,CAAA;AAErH,MAAM,MAAM,eAAe,GAAG,qBAAqB,CAAA;AAEnD,MAAM,MAAM,UAAU,GAAG;IACvB,UAAU,EAAE,UAAU,CAAA;IACtB,aAAa,EAAE,aAAa,GAAG,IAAI,CAAA;IACnC,MAAM,CAAC,EAAE,WAAW,EAAE,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,cAAc,GACtB;IACE,KAAK,EAAE,IAAI,CAAA;IACX,aAAa,EAAE,qBAAqB,CAAA;IACpC,OAAO,EAAE,cAAc,CAAA;IACvB,MAAM,CAAC,EAAE,WAAW,EAAE,CAAA;IACtB,MAAM,EAAE,qBAAqB,CAAA;CAC9B,GACD;IACE,KAAK,EAAE,KAAK,CAAA;IACZ,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,OAAO,CAAC,EAAE,cAAc,CAAA;IACxB,MAAM,EAAE,WAAW,EAAE,CAAA;IACrB,MAAM,CAAC,EAAE,aAAa,CAAA;CACvB,CAAA;AAEL,MAAM,MAAM,iBAAiB,GACzB;IACE,KAAK,EAAE,IAAI,CAAA;IACX,MAAM,CAAC,EAAE,WAAW,EAAE,CAAA;IACtB,MAAM,EAAE,qBAAqB,CAAA;CAC9B,GACD;IACE,KAAK,EAAE,KAAK,CAAA;IACZ,MAAM,EAAE,WAAW,EAAE,CAAA;IACrB,MAAM,CAAC,EAAE,aAAa,CAAA;CACvB,CAAA;AAEL,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,eAAe,GAAG,eAAe,IAAI;IACvE,aAAa,EAAE,CAAC,CAAA;IAChB,OAAO,EAAE,KAAK,CAAA;CACf,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,aAAa,EAAE,aAAa,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,cAAc,CAAA;IACvB,iBAAiB,EAAE,MAAM,CAAA;IACzB,oBAAoB,EAAE,MAAM,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,CAAC,EAAE,cAAc,CAAA;IACxB,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,MAAM,CAAC,EAAE,aAAa,CAAA;IACtB,MAAM,CAAC,EAAE,WAAW,EAAE,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,OAAO,MAAM,GAAG,MAAM,CAAA;CACpC,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,eAAe,EAAE,CAAA;AAE1C;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,EAAE,MAAM,CAAA;IACX,YAAY,EAAE,OAAO,CAAA;IACrB,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,aAAa,CAAA;CAC7B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,kBAAkB,CAAA;AAE/C,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA;AAED,OAAO,CAAC,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,QAAQ;KAAG;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,SAAS,IAAI,EAAE,GAAG,SAAS,IAAI,EAAE,IAAI;IAC/D,oEAAoE;IACpE,KAAK,EAAE,sBAAsB,CAAA;IAC7B,qDAAqD;IACrD,aAAa,EAAE,aAAa,CAAA;IAC5B,qBAAqB;IACrB,OAAO,CAAC,EAAE,cAAc,CAAA;IACxB,mBAAmB;IACnB,KAAK,EAAE,CAAC,CAAA;CACT,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAA;AAEnD,KAAK,uBAAuB,GAAG;IAC7B,UAAU,EAAE,UAAU,CAAA;IACtB,aAAa,EAAE,aAAa,CAAA;CAC7B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,GAC/E,KAAK,SAAS,IAAI,GAChB,IAAI,SAAS,IAAI,EAAE,GACjB,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,GAC5D,KAAK,GACP,KAAK,GACP,uBAAuB,CAAA"}

package/dist/utils/filter.d.ts

@@ -1,5 +1,5 @@
-import type { AnyApiDefinitionFormat, AnyObject, FilterResult } from '../types/index.js';
-export type FilterCallback = (schema: AnyObject) => boolean;
+import type { AnyApiDefinitionFormat, UnknownObject, FilterResult } from '../types/index.js';
+export type FilterCallback = (schema: UnknownObject) => 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,eAAe,CAAA;AAKpF,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,aAAa,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAKxF,MAAM,MAAM,cAAc,GAAG,CAAC,MAAM,EAAE,aAAa,KAAK,OAAO,CAAA;AAE/D;;GAEG;AACH,wBAAgB,MAAM,CAAC,aAAa,EAAE,sBAAsB,EAAE,QAAQ,EAAE,cAAc,GAAG,YAAY,CAQpG"}

package/dist/utils/join/join.d.ts

@@ -1,4 +1,4 @@
-import type { OpenAPIV3_1 } from '@scalar/openapi-types';
+import type { Document as OpenApiDocumentV3_1 } from '@scalar/openapi-types/3.1';
 import type { UnknownObject } from '../../types/index.js';
 type Conflicts = {
     type: 'path';
@@ -15,7 +15,7 @@ type Conflicts = {
 };
 type JoinResult = {
     ok: true;
-    document: OpenAPIV3_1.Document;
+    document: OpenApiDocumentV3_1;
 } | {
     ok: false;
     conflicts: Conflicts[];

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

@@ -1 +1 @@
-{"version":3,"file":"join.d.ts","sourceRoot":"","sources":["../../../src/utils/join/join.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAyO5C,KAAK,SAAS,GACV;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAC9C;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACjD;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,aAAa,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAA;AAC9D,KAAK,UAAU,GAAG;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,SAAS,EAAE,SAAS,EAAE,CAAA;CAAE,CAAA;AAEtG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,eAAO,MAAM,IAAI,GAAU,QAAQ,aAAa,EAAE,EAAE,SAAS;IAAE,gBAAgB,EAAE,MAAM,EAAE,CAAA;CAAE,KAAG,OAAO,CAAC,UAAU,CAkE/G,CAAA"}
+{"version":3,"file":"join.d.ts","sourceRoot":"","sources":["../../../src/utils/join/join.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAEV,QAAQ,IAAI,mBAAmB,EAKhC,MAAM,2BAA2B,CAAA;AAElC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAyO5C,KAAK,SAAS,GACV;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAC9C;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACjD;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,aAAa,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAA;AAC9D,KAAK,UAAU,GAAG;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,EAAE,mBAAmB,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,SAAS,EAAE,SAAS,EAAE,CAAA;CAAE,CAAA;AAMrG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,eAAO,MAAM,IAAI,GAAU,QAAQ,aAAa,EAAE,EAAE,SAAS;IAAE,gBAAgB,EAAE,MAAM,EAAE,CAAA;CAAE,KAAG,OAAO,CAAC,UAAU,CAkE/G,CAAA"}

package/dist/utils/join/join.js

@@ -43,7 +43,7 @@ const withDefault = (value, defaultValue) => {
  * - If the same operation (e.g., "get") exists for the same path in multiple inputs,
  *   a conflict is recorded for that path and method.
  *
- * @param inputs - Array of OpenAPIV3_1.PathsObject to merge
+ * @param inputs - Array of OpenAPI 3.1 PathsObjects to merge
  * @returns An object containing the merged paths and a list of conflicts
  */
 const mergePaths = (inputs) => {
@@ -73,7 +73,7 @@ const mergePaths = (inputs) => {
  * Merges multiple arrays of OpenAPI TagObjects into a single array, ensuring uniqueness by tag name.
  * - If a tag with the same name appears in multiple arrays, only the first occurrence is included in the result.
  *
- * @param inputs - Array of arrays of OpenAPIV3_1.TagObject to merge
+ * @param inputs - Array of arrays of OpenAPI 3.1 TagObjects to merge
  * @returns An array of unique TagObjects (by name)
  */
 const mergeTags = (inputs) => {
@@ -93,7 +93,7 @@ const mergeTags = (inputs) => {
  * Merges multiple arrays of OpenAPI ServerObjects into a single array, ensuring uniqueness by server URL.
  * - If a server with the same URL appears in multiple arrays, only the first occurrence is included in the result.
  *
- * @param inputs - Array of arrays of OpenAPIV3_1.ServerObject to merge
+ * @param inputs - Array of arrays of OpenAPI 3.1 ServerObjects to merge
  * @returns An array of unique ServerObjects (by url)
  */
 const mergeServers = (inputs) => {
@@ -114,7 +114,7 @@ const mergeServers = (inputs) => {
  * - If a component with the same type and name appears in multiple inputs, only the first occurrence is included.
  * - Any conflicts (duplicate component names within the same type) are recorded in the `conflicts` array.
  *
- * @param inputs - Array of OpenAPIV3_1.ComponentsObject to merge
+ * @param inputs - Array of OpenAPI 3.1 ComponentsObjects to merge
  * @returns An object containing the merged components and an array of conflicts
  */
 const mergeComponents = (inputs) => {
@@ -203,6 +203,9 @@ const prefixComponents = async (inputs, prefixes) => {
         });
     }
 };
+const asOpenApiDocumentV3_1 = (document) => {
+    return document;
+};
 /**
  * Joins multiple OpenAPI documents into a single document.
  *
@@ -279,7 +282,7 @@ export const join = async (inputs, config) => {
     // Return the merged OpenAPI document
     return {
         ok: true,
-        document: {
+        document: asOpenApiDocumentV3_1({
             ...result,
             info,
             paths,
@@ -287,6 +290,6 @@ export const join = async (inputs, config) => {
             tags: withDefault(tags, undefined),
             servers: withDefault(servers, undefined),
             components: withDefault(components, undefined),
-        },
+        }),
     };
 };

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

@@ -1 +1 @@
-{"version":3,"file":"load.d.ts","sourceRoot":"","sources":["../../../src/utils/load/load.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,sBAAsB,EAGtB,UAAU,EACV,UAAU,EACV,kBAAkB,EACnB,MAAM,eAAe,CAAA;AAMtB,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,EAAE,CAAC,KAAK,CAAC,EAAE,GAAG,KAAK,OAAO,CAAA;IAC/B,GAAG,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAA;IACxB,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,KAAK,MAAM,CAAA;IACvD,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,MAAM,CAAA;IAC/B,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,MAAM,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,CAAC,EAAE,UAAU,EAAE,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,UAAU,CAAA;CACxB,GAAG,kBAAkB,CAAA;AAEtB;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,IAAI,CAAC,KAAK,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,CAyHpG"}
+{"version":3,"file":"load.d.ts","sourceRoot":"","sources":["../../../src/utils/load/load.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAe,UAAU,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAMpH,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,EAAE,CAAC,KAAK,CAAC,EAAE,GAAG,KAAK,OAAO,CAAA;IAC/B,GAAG,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAA;IACxB,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,KAAK,MAAM,CAAA;IACvD,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,MAAM,CAAA;IAC/B,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,MAAM,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,CAAC,EAAE,UAAU,EAAE,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,UAAU,CAAA;CACxB,GAAG,kBAAkB,CAAA;AAEtB;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,IAAI,CAAC,KAAK,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,CAuHpG"}

package/dist/utils/load/load.js

@@ -30,7 +30,7 @@ export async function load(value, options) {
     }
     // Check whether the value is an URL or file path
     const plugin = options?.plugins?.find((thisPlugin) => thisPlugin.check(value));
-    let content;
+    let content = normalize(value);
     if (plugin) {
         try {
             content = normalize(await plugin.get(value));
@@ -50,9 +50,6 @@ export async function load(value, options) {
             };
         }
     }
-    else {
-        content = normalize(value);
-    }
     // No content
     if (content === undefined) {
         if (options?.throwOnError) {

package/dist/utils/make-filesystem.d.ts

@@ -1,3 +1,3 @@
-import type { AnyObject, Filesystem, FilesystemEntry } from '../types/index.js';
-export declare function makeFilesystem(value: string | AnyObject | Filesystem, overwrites?: Partial<FilesystemEntry>): Filesystem;
+import type { Filesystem, FilesystemEntry, UnknownObject } from '../types/index.js';
+export declare function makeFilesystem(value: string | UnknownObject | Filesystem, overwrites?: Partial<FilesystemEntry>): Filesystem;
 //# sourceMappingURL=make-filesystem.d.ts.map

package/dist/utils/make-filesystem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"make-filesystem.d.ts","sourceRoot":"","sources":["../../src/utils/make-filesystem.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAK3E,wBAAgB,cAAc,CAC5B,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,EACtC,UAAU,GAAE,OAAO,CAAC,eAAe,CAAM,GACxC,UAAU,CAoBZ"}
+{"version":3,"file":"make-filesystem.d.ts","sourceRoot":"","sources":["../../src/utils/make-filesystem.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAK/E,wBAAgB,cAAc,CAC5B,KAAK,EAAE,MAAM,GAAG,aAAa,GAAG,UAAU,EAC1C,UAAU,GAAE,OAAO,CAAC,eAAe,CAAM,GACxC,UAAU,CAwBZ"}

package/dist/utils/make-filesystem.js

@@ -8,6 +8,9 @@ export function makeFilesystem(value, overwrites = {}) {
     }
     // Make an object
     const specification = normalize(value);
+    if (Array.isArray(specification)) {
+        return specification;
+    }
     // Create fake filesystem
     return [
         {