@scalar/openapi-parser 0.10.13 → 0.10.15

package/dist/utils/resolveReferences.d.ts

@@ -15,6 +15,12 @@ export type ResolveReferencesOptions = ThrowOnErrorOption & {
         schema: AnyObject;
         ref: string;
     }) => void;
+    /**
+     * Whether to resolve internal references.
+     *
+     * @default true
+     */
+    resolveInternalRefs?: boolean;
 };
 /**
  * Takes a specification and resolves all references.

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,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAehH,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,CA0BzB"}
+{"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,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAehH,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;IAClE;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC9B,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,CA0BzB"}

package/dist/utils/resolveReferences.js

@@ -21,7 +21,7 @@ errors = []) {
     const filesystem = makeFilesystem(clonedInput);
     // Get the main file
     const entrypoint = getEntrypoint(filesystem);
-    const finalInput = file?.specification ?? entrypoint.specification;
+    const finalInput = file?.content ?? entrypoint.content;
     // Recursively resolve all references
     dereference(finalInput, filesystem, file ?? entrypoint, new WeakSet(), errors, options);
     // Remove duplicats (according to message) from errors
@@ -46,9 +46,18 @@ errors, options) {
     }
     resolvedSchemas.add(schema);
     function resolveExternal(externalFile) {
-        dereference(externalFile.specification, filesystem, externalFile, resolvedSchemas, errors, options);
+        dereference(externalFile.content, filesystem, externalFile, resolvedSchemas, errors, options);
         return externalFile;
     }
+    // Skip internal reference resolution if resolveInternalRefs is false
+    const skipReference = 
+    // Only if the option is set …
+    options?.resolveInternalRefs === false &&
+        // and it’s obviously internal
+        schema.$ref?.startsWith('#');
+    if (skipReference) {
+        return;
+    }
     while (schema.$ref !== undefined) {
         // Find the referenced content
         const resolved = resolveUri(schema.$ref, options, entrypoint, filesystem, resolveExternal, errors);
@@ -83,9 +92,9 @@ errors, options) {
 function resolveUri(
 // 'foobar.json#/foo/bar'
 uri, options, 
-// { filename: './foobar.json '}
+// { uri: './foobar.json '}
 file, 
-// [ { filename: './foobar.json '} ]
+// [ { uri: './foobar.json '} ]
 filesystem, 
 // a function to resolve references in external file
 resolve, errors) {
@@ -103,11 +112,12 @@ resolve, errors) {
     // Understand the URI
     const [prefix, path] = uri.split('#', 2);
     /** Check whether the file is pointing to itself */
-    const isDifferentFile = prefix !== file.filename;
+    const isDifferentFile = prefix !== file.uri;
     // External references
     if (prefix && isDifferentFile) {
+        const absoluteUri = file.references[prefix] ?? prefix;
         const externalReference = filesystem.find((entry) => {
-            return entry.filename === prefix;
+            return entry.uri && entry.uri === absoluteUri;
         });
         if (!externalReference) {
             if (options?.throwOnError) {
@@ -121,7 +131,7 @@ resolve, errors) {
         }
         // $ref: 'other-file.yaml'
         if (path === undefined) {
-            return externalReference.specification;
+            return externalReference.content;
         }
         // $ref: 'other-file.yaml#/foo/bar'
         // resolve refs first before accessing properties directly
@@ -129,11 +139,11 @@ resolve, errors) {
     }
     // Pointers
     const segments = getSegmentsFromPath(path);
-    // Try to find the URI
+    // Internal references
     try {
         return segments.reduce((acc, key) => {
             return acc[key];
-        }, file.specification);
+        }, file.content);
     }
     catch (_error) {
         if (options?.throwOnError) {

package/dist/utils/upgrade.js

@@ -15,7 +15,7 @@ function upgrade(value) {
     }
     const upgraders = [upgradeFromTwoToThree, upgradeFromThreeToThreeOne];
     // TODO: Run upgrade over the whole filesystem
-    const result = upgraders.reduce((currentSpecification, upgrader) => upgrader(currentSpecification), getEntrypoint(makeFilesystem(value)).specification);
+    const result = upgraders.reduce((currentSpecification, upgrader) => upgrader(currentSpecification), getEntrypoint(makeFilesystem(value)).content);
     return {
         specification: result,
         // TODO: Make dynamic

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.13",
+  "version": "0.10.15",
   "engines": {
     "node": ">=18"
   },
@@ -64,9 +64,10 @@
     "json-to-ast": "^2.1.0",
     "just-diff": "^6.0.2",
     "tinybench": "^2.8.0",
+    "vite": "^5.4.10",
+    "@scalar/openapi-types": "0.2.0",
     "@scalar/build-tooling": "0.1.17",
-    "@scalar/types": "0.1.5",
-    "@scalar/openapi-types": "0.2.0"
+    "@scalar/types": "0.1.8"
   },
   "scripts": {
     "build": "scalar-build-rollup",