@scalar/openapi-parser 0.10.12 → 0.10.14

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @scalar/openapi-parser
 
+## 0.10.14
+
+### Patch Changes
+
+- cf5bf65: fix: migrate file type, basic auth, parameters and responses headers correctly
+
+## 0.10.13
+
+### Patch Changes
+
+- d5a687f: fix: byte format is ignored when upgrading from OpenAPI 3.0 to OpenAPI 3.1
+
 ## 0.10.12
 
 ### Patch Changes

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,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAIxD;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,qBAAqB,EAAE,aAAa;;;;;;;;;;;;;;;;;;;;mBAwH9E;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,CAAC,qBAAqB,EAAE,aAAa;;;;;;;;;;;;;;;;;;;;mBAuI9E;AAED,uDAAuD;AACvD,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAsBpD"}

package/dist/utils/upgradeFromThreeToThreeOne.js

@@ -104,6 +104,18 @@ function upgradeFromThreeToThreeOne(originalSpecification) {
         }
         return schema;
     });
+    specification = traverse(specification, (schema, path) => {
+        if (schema.type === 'string' && schema.format === 'byte') {
+            const parentPath = path.slice(0, -1);
+            const contentMediaType = parentPath.find((_, index) => path[index - 1] === 'content');
+            return {
+                type: 'string',
+                contentEncoding: 'base64',
+                contentMediaType,
+            };
+        }
+        return schema;
+    });
     // Declaring $schema Dialects to protect against change
     // if (typeof specification.$schema === 'undefined') {
     //   specification.$schema = 'http://json-schema.org/draft-07/schema#'

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

@@ -1 +1 @@
-{"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,0CAmOzE"}
+{"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,0CA+PzE"}

package/dist/utils/upgradeFromTwoToThree.js

@@ -44,6 +44,13 @@ function upgradeFromTwoToThree(originalSpecification) {
             return schema;
         });
     }
+    specification = traverse(specification, (schema) => {
+        if (schema.type === 'file') {
+            schema.type = 'string';
+            schema.format = 'binary';
+        }
+        return schema;
+    });
     // Paths
     if (typeof specification.paths === 'object') {
         for (const path in specification.paths) {
@@ -109,12 +116,21 @@ function upgradeFromTwoToThree(originalSpecification) {
                                 // Remove formData parameters from the parameters array
                                 operationItem.parameters = operationItem.parameters.filter((parameter) => parameter.in !== 'formData');
                             }
+                            operationItem.parameters = operationItem.parameters.map((parameter) => transformParameterObject(parameter));
                         }
                         // Responses
                         if (operationItem.responses) {
                             for (const response in operationItem.responses) {
                                 if (Object.hasOwn(operationItem.responses, response)) {
                                     const responseItem = operationItem.responses[response];
+                                    if (responseItem.headers) {
+                                        responseItem.headers = Object.entries(responseItem.headers).reduce((acc, [name, header]) => {
+                                            return {
+                                                [name]: transformParameterObject(header),
+                                                ...acc,
+                                            };
+                                        }, {});
+                                    }
                                     if (responseItem.schema) {
                                         const produces = specification.produces ?? operationItem.produces ?? ['application/json'];
                                         if (typeof responseItem.content !== 'object') {
@@ -162,6 +178,14 @@ function upgradeFromTwoToThree(originalSpecification) {
                         },
                     });
                 }
+                else if ('type' in securityScheme && securityScheme.type === 'basic') {
+                    Object.assign(specification.components.securitySchemes, {
+                        [key]: {
+                            type: 'http',
+                            scheme: 'basic',
+                        },
+                    });
+                }
                 else {
                     Object.assign(specification.components.securitySchemes, {
                         [key]: securityScheme,
@@ -173,5 +197,39 @@ function upgradeFromTwoToThree(originalSpecification) {
     }
     return specification;
 }
+function transformItemsObject(obj) {
+    const schemaProperties = [
+        'type',
+        'format',
+        'items',
+        'maximum',
+        'exclusiveMaximum',
+        'minimum',
+        'exclusiveMinimum',
+        'maxLength',
+        'minLength',
+        'pattern',
+        'maxItems',
+        'minItems',
+        'uniqueItems',
+        'enum',
+        'multipleOf',
+    ];
+    return schemaProperties.reduce((acc, property) => {
+        if (Object.hasOwn(obj, property)) {
+            acc[property] = obj[property];
+            delete obj[property];
+        }
+        return acc;
+    }, {});
+}
+function transformParameterObject(parameter) {
+    delete parameter.collectionFormat;
+    delete parameter.default;
+    return {
+        schema: transformItemsObject(parameter),
+        ...parameter,
+    };
+}
 
 export { upgradeFromTwoToThree };

package/package.json

@@ -17,7 +17,7 @@
     "parser",
     "typescript"
   ],
-  "version": "0.10.12",
+  "version": "0.10.14",
   "engines": {
     "node": ">=18"
   },
@@ -64,9 +64,9 @@
     "json-to-ast": "^2.1.0",
     "just-diff": "^6.0.2",
     "tinybench": "^2.8.0",
-    "@scalar/types": "0.1.2",
     "@scalar/build-tooling": "0.1.17",
-    "@scalar/openapi-types": "0.1.9"
+    "@scalar/types": "0.1.6",
+    "@scalar/openapi-types": "0.2.0"
   },
   "scripts": {
     "build": "scalar-build-rollup",