@scalar/openapi-parser 0.10.1 → 0.10.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @scalar/openapi-parser
 
+## 0.10.3
+
+### Patch Changes
+
+- 8dce84f: Call `onDereference` after dereference process
+
+## 0.10.2
+
+### Patch Changes
+
+- 3791738: fix(openapi-parser): correct schema upgrade for "format: binary"
+
 ## 0.10.1
 
 ### Patch 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/resolveReferences.d.ts

@@ -6,6 +6,11 @@ export type ResolveReferencesResult = {
     schema: OpenAPI.Document;
 };
 export type ResolveReferencesOptions = ThrowOnErrorOption & {
+    /**
+     * Fired when dereferenced a schema.
+     *
+     * Note that for object schemas, its properties may not be dereferenced when the hook is called.
+     */
     onDereference?: (data: {
         schema: AnyObject;
         ref: string;

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

@@ -1 +1 @@
-{"version":3,"file":"resolveReferences.d.ts","sourceRoot":"","sources":["../../src/utils/resolveReferences.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAGpD,OAAO,KAAK,EACV,SAAS,EACT,WAAW,EACX,UAAU,EACV,eAAe,EACf,kBAAkB,EACnB,MAAM,UAAU,CAAA;AAejB,MAAM,MAAM,uBAAuB,GAAG;IACpC,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,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE;QAAE,MAAM,EAAE,SAAS,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAA;CACnE,CAAA;AAOD;;GAEG;AACH,wBAAgB,iBAAiB,CAE/B,KAAK,EAAE,SAAS,GAAG,UAAU,EAE7B,OAAO,CAAC,EAAE,wBAAwB,EAElC,IAAI,CAAC,EAAE,eAAe,EAEtB,MAAM,CAAC,EAAE,WAAW,EAAE,GACrB,uBAAuB,CAqGzB"}
+{"version":3,"file":"resolveReferences.d.ts","sourceRoot":"","sources":["../../src/utils/resolveReferences.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAGpD,OAAO,KAAK,EACV,SAAS,EACT,WAAW,EACX,UAAU,EACV,eAAe,EACf,kBAAkB,EACnB,MAAM,UAAU,CAAA;AAejB,MAAM,MAAM,uBAAuB,GAAG;IACpC,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,CAAA;KAAE,KAAK,IAAI,CAAA;CACnE,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,CAqCzB"}

package/dist/utils/resolveReferences.js

@@ -14,66 +14,64 @@ options,
 // Fallback to the entrypoint
 file, 
 // Errors that occurred during the process
-errors) {
-    // Initialize errors
-    if (errors === undefined) {
-        errors = [];
-    }
+errors = []) {
     // Detach from input
     const clonedInput = structuredClone(input);
     // Make it a filesystem, even if it’s just one file
     const filesystem = makeFilesystem(clonedInput);
     // Get the main file
     const entrypoint = getEntrypoint(filesystem);
+    const finalInput = file?.specification ?? entrypoint.specification;
     // Recursively resolve all references
-    resolve(file?.specification ?? entrypoint.specification, filesystem, file ?? entrypoint);
+    dereference(finalInput, filesystem, file ?? entrypoint, new WeakSet(), errors, options);
     // Remove duplicats (according to message) from errors
     errors = errors.filter((error, index, self) => index ===
         self.findIndex((t) => t.message === error.message && t.code === error.code));
     // Return the resolved specification
     return {
         valid: errors.length === 0,
-        errors: errors,
-        schema: (file ?? getEntrypoint(filesystem))
-            .specification,
+        errors,
+        schema: finalInput,
     };
-    /**
-     * Resolves the circular reference to an object and deletes the $ref properties.
-     */
-    function resolve(schema, resolveFilesystem, resolveFile, 
-    // references to resolved object
-    resolved = new WeakSet()) {
-        let result = { errors: [] };
-        if (schema === null || resolved.has(schema))
-            return result;
-        resolved.add(schema);
-        function resolveExternal(externalFile) {
-            resolve(externalFile.specification, resolveFilesystem, externalFile, resolved);
-            return externalFile;
-        }
-        // Ignore parts without a reference
-        while (schema.$ref !== undefined) {
-            // Find the referenced content
-            const target = resolveUri(schema.$ref, options, resolveFile, resolveFilesystem, resolveExternal, errors);
-            // invalid
-            if (typeof target !== 'object' || target === null)
-                break;
-            options?.onDereference?.({ schema, ref: schema.$ref });
-            // Get rid of the reference
-            delete schema.$ref;
-            for (const key of Object.keys(target)) {
-                if (schema[key] === undefined) {
-                    schema[key] = target[key];
-                }
+}
+/**
+ * Resolves the circular reference to an object and deletes the $ref properties (in-place).
+ */
+function dereference(schema, filesystem, entrypoint, 
+// references to resolved object
+resolvedSchemas, 
+// error output
+errors, options) {
+    if (schema === null || resolvedSchemas.has(schema))
+        return;
+    resolvedSchemas.add(schema);
+    function resolveExternal(externalFile) {
+        dereference(externalFile.specification, filesystem, externalFile, resolvedSchemas, errors, options);
+        return externalFile;
+    }
+    while (schema.$ref !== undefined) {
+        // Find the referenced content
+        const resolved = resolveUri(schema.$ref, options, entrypoint, filesystem, resolveExternal, errors);
+        // invalid
+        if (typeof resolved !== 'object' || resolved === null)
+            break;
+        const dereferencedRef = schema.$ref;
+        // Get rid of the reference
+        delete schema.$ref;
+        for (const key of Object.keys(resolved)) {
+            if (schema[key] === undefined) {
+                schema[key] = resolved[key];
             }
         }
-        // Iterate over the whole object
-        for (const value of Object.values(schema)) {
-            if (typeof value === 'object' && value !== null) {
-                result = resolve(value, resolveFilesystem, resolveFile, resolved);
-            }
+        if (dereferencedRef) {
+            options?.onDereference?.({ schema, ref: dereferencedRef });
+        }
+    }
+    // Iterate over the whole object
+    for (const value of Object.values(schema)) {
+        if (typeof value === 'object' && value !== null) {
+            dereference(value, filesystem, entrypoint, resolvedSchemas, errors, options);
         }
-        return result;
     }
 }
 /**

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,CACxC,qBAAqB,EAAE,aAAa;;;;;;;;;;;;;;;;;;;;mBAkHrC;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

@@ -63,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/package.json

@@ -17,7 +17,7 @@
     "parser",
     "typescript"
   ],
-  "version": "0.10.1",
+  "version": "0.10.3",
   "engines": {
     "node": ">=18"
   },
@@ -59,14 +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/types": "0.0.25",
     "@scalar/build-tooling": "0.1.12",
-    "@scalar/openapi-types": "0.1.5",
-    "@scalar/types": "0.0.25"
+    "@scalar/openapi-types": "0.1.5"
   },
   "scripts": {
     "build": "scalar-build-rollup",