@scalar/openapi-parser 0.10.0 → 0.10.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @scalar/openapi-parser
 
+## 0.10.2
+
+### Patch Changes
+
+- 3791738: fix(openapi-parser): correct schema upgrade for "format: binary"
+
+## 0.10.1
+
+### Patch Changes
+
+- c263aaf: feat: better deal with empty OpenAPI documents
+
 ## 0.10.0
 
 ### Minor Changes

package/dist/utils/betterAjvErrors/utils.js

@@ -23,8 +23,7 @@ const getSiblings =
 const concatAll =
   /* ::<T> */
 
-
-    (xs /*: $ReadOnlyArray<T> */) =>
+  (xs /*: $ReadOnlyArray<T> */) =>
     (ys /* : $ReadOnlyArray<T> */) /* : $ReadOnlyArray<T> */ =>
       ys.reduce((zs, z) => zs.concat(z), xs);
 

package/dist/utils/details.d.ts

@@ -1,6 +1,7 @@
-import type { AnyObject, DetailsResult } from '../types';
+import type { UnknownObject } from '@scalar/types/utils';
+import type { DetailsResult } from '../types';
 /**
  * Get versions of the OpenAPI document.
  */
-export declare function details(specification: AnyObject): DetailsResult;
+export declare function details(specification: UnknownObject): DetailsResult;
 //# sourceMappingURL=details.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"details.d.ts","sourceRoot":"","sources":["../../src/utils/details.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExD;;GAEG;AACH,wBAAgB,OAAO,CAAC,aAAa,EAAE,SAAS,GAAG,aAAa,CAmB/D"}
+{"version":3,"file":"details.d.ts","sourceRoot":"","sources":["../../src/utils/details.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAGxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAE7C;;GAEG;AACH,wBAAgB,OAAO,CAAC,aAAa,EAAE,aAAa,GAAG,aAAa,CA2BnE"}

package/dist/utils/details.js

@@ -4,6 +4,13 @@ import { OpenApiVersions } from '../configuration/index.js';
  * Get versions of the OpenAPI document.
  */
 function details(specification) {
+    if (specification === null) {
+        return {
+            version: undefined,
+            specificationType: undefined,
+            specificationVersion: undefined,
+        };
+    }
     for (const version of new Set(OpenApiVersions)) {
         const specificationType = version === '2.0' ? 'swagger' : 'openapi';
         const value = specification[specificationType];

package/dist/utils/normalize.d.ts

@@ -1,8 +1,9 @@
-import type { AnyObject, Filesystem } from '../types';
+import type { UnknownObject } from '@scalar/types/utils';
+import type { Filesystem } from '../types';
 /**
  * Normalize the OpenAPI document (YAML, JSON, object) to a JavaScript object.
  *
  * Doesn’t modify the object if it’s a `Filesystem` (multiple files) already.
  */
-export declare function normalize(specification: string | AnyObject | Filesystem): AnyObject | Filesystem;
+export declare function normalize(specification: string | UnknownObject | Filesystem): UnknownObject | Filesystem;
 //# sourceMappingURL=normalize.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"normalize.d.ts","sourceRoot":"","sources":["../../src/utils/normalize.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAGrD;;;;GAIG;AACH,wBAAgB,SAAS,CACvB,aAAa,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,GAC7C,SAAS,GAAG,UAAU,CAgBxB"}
+{"version":3,"file":"normalize.d.ts","sourceRoot":"","sources":["../../src/utils/normalize.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAGxD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAG1C;;;;GAIG;AACH,wBAAgB,SAAS,CACvB,aAAa,EAAE,MAAM,GAAG,aAAa,GAAG,UAAU,GACjD,aAAa,GAAG,UAAU,CAwB5B"}

package/dist/utils/normalize.js

@@ -7,10 +7,13 @@ import { isFilesystem } from './isFilesystem.js';
  * Doesn’t modify the object if it’s a `Filesystem` (multiple files) already.
  */
 function normalize(specification) {
-    if (isFilesystem(specification)) {
-        return specification;
+    if (specification === null) {
+        return {};
     }
     if (typeof specification === 'string') {
+        if (specification.trim() === '') {
+            return {};
+        }
         try {
             return JSON.parse(specification);
         }
@@ -20,6 +23,9 @@ function normalize(specification) {
             });
         }
     }
+    if (isFilesystem(specification)) {
+        return specification;
+    }
     return specification;
 }
 

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;AAExD,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAMpE;;GAEG;AACH,wBAAgB,OAAO,CACrB,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,GACrC,aAAa,CAAC,WAAW,CAAC,QAAQ,CAAC,CAcrC"}
+{"version":3,"file":"upgrade.d.ts","sourceRoot":"","sources":["../../src/utils/upgrade.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAMpE;;GAEG;AACH,wBAAgB,OAAO,CACrB,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,GACrC,aAAa,CAAC,WAAW,CAAC,QAAQ,CAAC,CAoBrC"}

package/dist/utils/upgrade.js

@@ -7,6 +7,12 @@ import { upgradeFromTwoToThree } from './upgradeFromTwoToThree.js';
  * Upgrade specification to OpenAPI 3.1.0
  */
 function upgrade(value) {
+    if (!value) {
+        return {
+            specification: null,
+            version: '3.1',
+        };
+    }
     const upgraders = [upgradeFromTwoToThree, upgradeFromThreeToThreeOne];
     // TODO: Run upgrade over the whole filesystem
     const result = upgraders.reduce((currentSpecification, upgrader) => upgrader(currentSpecification), getEntrypoint(makeFilesystem(value)).specification);

package/dist/utils/upgradeFromThreeToThreeOne.d.ts

@@ -1,10 +1,31 @@
-import type { AnyObject } from '../types';
+import type { OpenAPIV3_1 } from '@scalar/openapi-types';
+import type { UnknownObject } from '@scalar/types/utils';
 /**
- * Upgrade from OpenAPI 3.0.x to 3.1.0
+ * Upgrade from OpenAPI 3.0.x to 3.1.1
  *
  * https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0
  */
-export declare function upgradeFromThreeToThreeOne(originalSpecification: AnyObject): AnyObject;
+export declare function upgradeFromThreeToThreeOne(originalSpecification: UnknownObject): (Omit<Omit<import("@scalar/openapi-types").OpenAPIV3.Document<{}>, "paths" | "components">, keyof {
+    [customExtension: `x-${string}`]: any;
+    [key: string]: any;
+}> & {
+    openapi?: "3.1.0" | "3.1.1";
+    swagger?: undefined;
+    info?: OpenAPIV3_1.InfoObject;
+    jsonSchemaDialect?: string;
+    servers?: OpenAPIV3_1.ServerObject[];
+} & Pick<{
+    paths?: OpenAPIV3_1.PathsObject<{}, {}>;
+    webhooks?: Record<string, OpenAPIV3_1.PathItemObject | OpenAPIV3_1.ReferenceObject>;
+    components?: OpenAPIV3_1.ComponentsObject;
+}, "paths"> & Omit<Partial<{
+    paths?: OpenAPIV3_1.PathsObject<{}, {}>;
+    webhooks?: Record<string, OpenAPIV3_1.PathItemObject | OpenAPIV3_1.ReferenceObject>;
+    components?: OpenAPIV3_1.ComponentsObject;
+}>, "paths"> & {
+    [customExtension: `x-${string}`]: any;
+    [key: string]: any;
+}) | UnknownObject;
 /** Determine if the current path is within a schema */
 export declare function isSchemaPath(path: string[]): boolean;
 //# sourceMappingURL=upgradeFromThreeToThreeOne.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"upgradeFromThreeToThreeOne.d.ts","sourceRoot":"","sources":["../../src/utils/upgradeFromThreeToThreeOne.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AAGzC;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,qBAAqB,EAAE,SAAS,aA6G1E;AAED,uDAAuD;AACvD,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAsBpD"}
+{"version":3,"file":"upgradeFromThreeToThreeOne.d.ts","sourceRoot":"","sources":["../../src/utils/upgradeFromThreeToThreeOne.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAIxD;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,qBAAqB,EAAE,aAAa;;;;;;;;;;;;;;;;;;;;mBAmIrC;AAED,uDAAuD;AACvD,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAsBpD"}

package/dist/utils/upgradeFromThreeToThreeOne.js

@@ -1,14 +1,16 @@
 import { traverse } from './traverse.js';
 
 /**
- * Upgrade from OpenAPI 3.0.x to 3.1.0
+ * Upgrade from OpenAPI 3.0.x to 3.1.1
  *
  * https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0
  */
 function upgradeFromThreeToThreeOne(originalSpecification) {
     let specification = originalSpecification;
     // Version
-    if (specification.openapi?.startsWith('3.0')) {
+    if (specification !== null &&
+        typeof specification.openapi === 'string' &&
+        specification.openapi.startsWith('3.0')) {
         specification.openapi = '3.1.1';
     }
     else {
@@ -61,25 +63,38 @@ function upgradeFromThreeToThreeOne(originalSpecification) {
         return schema;
     });
     // Multipart file uploads with a binary file
-    specification = traverse(specification, (schema) => {
+    specification = traverse(specification, (schema, path) => {
         if (schema.type === 'object' && schema.properties !== undefined) {
-            // Types
-            const entries = Object.entries(schema.properties);
-            for (const [_, value] of entries) {
-                if (typeof value === 'object' &&
-                    value.type === 'string' &&
-                    value.format === 'binary') {
-                    value.contentEncoding = 'application/octet-stream';
-                    delete value.format;
+            // Check if this is a multipart request body schema
+            const parentPath = path.slice(0, -1);
+            const isMultipart = parentPath.some((segment, index) => {
+                return (segment === 'content' && path[index + 1] === 'multipart/form-data');
+            });
+            if (isMultipart) {
+                // Types
+                const entries = Object.entries(schema.properties);
+                for (const [_, value] of entries) {
+                    if (typeof value === 'object' &&
+                        value.type === 'string' &&
+                        value.format === 'binary') {
+                        value.contentMediaType = 'application/octet-stream';
+                        delete value.format;
+                    }
                 }
             }
         }
         return schema;
     });
     // Uploading a binary file in a POST request
-    specification = traverse(specification, (schema) => {
+    specification = traverse(specification, (schema, path) => {
+        if (path.includes('content') && path.includes('application/octet-stream')) {
+            return {};
+        }
         if (schema.type === 'string' && schema.format === 'binary') {
-            return undefined;
+            return {
+                type: 'string',
+                contentMediaType: 'application/octet-stream',
+            };
         }
         return schema;
     });

package/dist/utils/upgradeFromTwoToThree.d.ts

@@ -1,8 +1,9 @@
-import type { AnyObject } from '../types';
+import type { OpenAPIV3 } from '@scalar/openapi-types';
+import type { UnknownObject } from '@scalar/types/utils';
 /**
  * Upgrade Swagger 2.0 to OpenAPI 3.0
  *
  * https://swagger.io/blog/news/whats-new-in-openapi-3-0/
  */
-export declare function upgradeFromTwoToThree(specification: AnyObject): AnyObject;
+export declare function upgradeFromTwoToThree(originalSpecification: UnknownObject): OpenAPIV3.Document<{}> | UnknownObject;
 //# sourceMappingURL=upgradeFromTwoToThree.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"upgradeFromTwoToThree.d.ts","sourceRoot":"","sources":["../../src/utils/upgradeFromTwoToThree.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AAGzC;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,SAAS,aA4O7D"}
+{"version":3,"file":"upgradeFromTwoToThree.d.ts","sourceRoot":"","sources":["../../src/utils/upgradeFromTwoToThree.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAa,SAAS,EAAE,MAAM,uBAAuB,CAAA;AACjE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAIxD;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,qBAAqB,EAAE,aAAa,0CAkQzE"}

package/dist/utils/upgradeFromTwoToThree.js

@@ -5,9 +5,12 @@ import { traverse } from './traverse.js';
  *
  * https://swagger.io/blog/news/whats-new-in-openapi-3-0/
  */
-function upgradeFromTwoToThree(specification) {
+function upgradeFromTwoToThree(originalSpecification) {
+    let specification = originalSpecification;
     // Version
-    if (specification.swagger?.startsWith('2.0')) {
+    if (specification !== null &&
+        typeof specification.swagger === 'string' &&
+        specification.swagger?.startsWith('2.0')) {
         specification.openapi = '3.0.4';
         delete specification.swagger;
     }
@@ -18,7 +21,7 @@ function upgradeFromTwoToThree(specification) {
     console.warn(`[upgradeFromTwoToThree] The upgrade from Swagger 2.0 to OpenAPI 3.0 documents is experimental and lacks features.`);
     // Servers
     if (specification.host) {
-        const schemes = specification.schemes?.length
+        const schemes = Array.isArray(specification.schemes) && specification.schemes?.length
             ? specification.schemes
             : ['http'];
         specification.servers = schemes.map((scheme) => ({
@@ -30,10 +33,9 @@ function upgradeFromTwoToThree(specification) {
     }
     // Schemas
     if (specification.definitions) {
-        if (typeof specification.components !== 'object') {
-            specification.components = {};
-        }
-        specification.components.schemas = specification.definitions;
+        specification.components = Object.assign({}, specification.components, {
+            schemas: specification.definitions,
+        });
         delete specification.definitions;
         // Rewrite $refs to definitions
         specification = traverse(specification, (schema) => {
@@ -44,7 +46,7 @@ function upgradeFromTwoToThree(specification) {
         });
     }
     // Paths
-    if (specification.paths) {
+    if (typeof specification.paths === 'object') {
         for (const path in specification.paths) {
             if (Object.hasOwn(specification.paths, path)) {
                 const pathItem = specification.paths[path];
@@ -145,24 +147,28 @@ function upgradeFromTwoToThree(specification) {
         if (typeof specification.components !== 'object') {
             specification.components = {};
         }
-        specification.components.securitySchemes = {};
+        // Assert that components is of type OpenAPIV3.ComponentsObject
+        specification.components =
+            specification.components;
+        Object.assign(specification.components, { securitySchemes: {} });
         for (const [key, securityScheme] of Object.entries(specification.securityDefinitions)) {
             if (typeof securityScheme === 'object') {
                 if ('type' in securityScheme && securityScheme.type === 'oauth2') {
                     const { flow, authorizationUrl, tokenUrl, scopes } = securityScheme;
-                    specification.components.securitySchemes[key] = {
-                        type: 'oauth2',
-                        flows: {
-                            [flow]: {
-                                ...(authorizationUrl && { authorizationUrl }),
-                                ...(tokenUrl && { tokenUrl }),
-                                ...(scopes && { scopes }),
+                    // Assert that securitySchemes is of type OpenAPIV3.SecuritySchemeObject
+                    Object.assign(specification.components
+                        .securitySchemes, {
+                        [key]: {
+                            type: 'oauth2',
+                            flows: {
+                                [flow]: Object.assign({}, authorizationUrl && { authorizationUrl }, tokenUrl && { tokenUrl }, scopes && { scopes }),
                             },
                         },
-                    };
+                    });
                 }
                 else {
-                    specification.components.securitySchemes[key] = securityScheme;
+                    Object.assign(specification.components
+                        .securitySchemes, { [key]: securityScheme });
                 }
             }
         }

package/package.json

@@ -7,7 +7,7 @@
   "bugs": "https://github.com/scalar/scalar/issues/new/choose",
   "repository": {
     "type": "git",
-    "url": "https://github.com/scalar/scalar.git",
+    "url": "git+https://github.com/scalar/scalar.git",
     "directory": "packages/openapi-parser"
   },
   "keywords": [
@@ -17,7 +17,7 @@
     "parser",
     "typescript"
   ],
-  "version": "0.10.0",
+  "version": "0.10.2",
   "engines": {
     "node": ">=18"
   },
@@ -59,13 +59,14 @@
     "@apidevtools/swagger-parser": "^10.1.0",
     "@babel/code-frame": "^7.24.7",
     "@google-cloud/storage": "^7.12.1",
-    "@types/node": "^20.14.10",
+    "@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/openapi-types": "0.1.5",
     "@scalar/build-tooling": "0.1.12",
-    "@scalar/openapi-types": "0.1.5"
+    "@scalar/types": "0.0.25"
   },
   "scripts": {
     "build": "scalar-build-rollup",