@scalar/oas-utils 0.2.105 → 0.2.107

package/dist/transforms/import-spec.js

@@ -51,31 +51,11 @@ const parseSchema = async (spec, { shouldLoad = true } = {}) => {
     };
 };
 /** Converts selected security requirements to uids */
-const getSelectedSecuritySchemeUids = (securityRequirements, authentication, securitySchemeMap) => {
-    // Filter the preferred security schemes to only include the ones that are in the security requirements
-    const preferredSecurityNames = [
-        authentication?.preferredSecurityScheme ?? [],
-    ]
-        .flat()
-        .filter((name) => {
-        // Match up complex security requirements, array to array
-        if (Array.isArray(name)) {
-            // We match every element in the array
-            return securityRequirements.some((r) => Array.isArray(r) &&
-                r.length === name.length &&
-                r.every((v, i) => v === name[i]));
-        }
-        else
-            return securityRequirements.includes(name);
-    });
+const getSelectedSecuritySchemeUids = (securityRequirements, preferredSecurityNames = [], securitySchemeMap) => {
     // Set the first security requirement if no preferred security schemes are set
-    if (!preferredSecurityNames.length && securityRequirements[0]) {
-        preferredSecurityNames.push(securityRequirements[0]);
-    }
+    const names = securityRequirements[0] && !preferredSecurityNames.length ? [securityRequirements[0]] : preferredSecurityNames;
     // Map names to uids
-    const uids = preferredSecurityNames.map((name) => Array.isArray(name)
-        ? name.map((k) => securitySchemeMap[k])
-        : securitySchemeMap[name]);
+    const uids = names.map((name) => Array.isArray(name) ? name.map((k) => securitySchemeMap[k]) : securitySchemeMap[name]);
     return uids;
 };
 /**
@@ -195,26 +175,31 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
         const methods = Object.keys(path).filter(isHttpMethod);
         methods.forEach((method) => {
             const operation = path[method];
-            const operationServers = serverSchema
-                .array()
-                .parse(operation.servers ?? []);
+            const operationServers = serverSchema.array().parse(operation.servers ?? []);
             servers.push(...operationServers);
             // We will save a list of all tags to ensure they exists at the top level
             // TODO: make sure we add any loose requests with no tags to the collection children
             operation.tags?.forEach((t) => tagNames.add(t));
             // Remove security here and add it correctly below
             const { security: operationSecurity, ...operationWithoutSecurity } = operation;
-            const securityRequirements = (operationSecurity ??
-                schema.security ??
-                [])
+            const securityRequirements = (operationSecurity ?? schema.security ?? [])
                 .map((s) => {
                 const keys = Object.keys(s);
                 return keys.length > 1 ? keys : keys[0];
             })
                 .filter(isDefined);
+            // Filter the preferred security schemes to only include the ones that are in the security requirements
+            const preferredSecurityNames = [authentication?.preferredSecurityScheme ?? []].flat().filter((name) => {
+                // Match up complex security requirements, array to array
+                if (Array.isArray(name)) {
+                    // We match every element in the array
+                    return securityRequirements.some((r) => Array.isArray(r) && r.length === name.length && r.every((v, i) => v === name[i]));
+                }
+                return securityRequirements.includes(name);
+            });
             // Set the initially selected security scheme
             const selectedSecuritySchemeUids = securityRequirements.length && !setCollectionSecurity
-                ? getSelectedSecuritySchemeUids(securityRequirements, authentication, securitySchemeMap)
+                ? getSelectedSecuritySchemeUids(securityRequirements, preferredSecurityNames, securitySchemeMap)
                 : [];
             const requestPayload = {
                 ...operationWithoutSecurity,
@@ -223,10 +208,7 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
                 security: operationSecurity,
                 selectedSecuritySchemeUids,
                 // Merge path and operation level parameters
-                parameters: [
-                    ...(path?.parameters ?? []),
-                    ...(operation.parameters ?? []),
-                ],
+                parameters: [...(path?.parameters ?? []), ...(operation.parameters ?? [])],
                 servers: [...pathServers, ...operationServers].map((s) => s.uid),
             };
             // Remove any examples from the request payload as they conflict with our examples property and are not valid
@@ -246,8 +228,7 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
                             [key]: s[key],
                         };
                     }
-                    else
-                        return s;
+                    return s;
                 });
             // Save parse the request
             const request = schemaModel(requestPayload, requestSchema, false);
@@ -307,13 +288,17 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
     // ---------------------------------------------------------------------------
     // Generate Collection
     // Grab the security requirements for this operation
-    const securityRequirements = (schema.security ?? []).map((s) => {
+    const securityRequirements = (schema.security ?? [])
+        .map((s) => {
         const keys = Object.keys(s);
         return keys.length > 1 ? keys : keys[0];
-    });
+    })
+        .filter(isDefined);
+    // Here we do not filter these as we let the preferredSecurityScheme override the requirements
+    const preferredSecurityNames = [authentication?.preferredSecurityScheme ?? []].flat();
     // Set the initially selected security scheme
-    const selectedSecuritySchemeUids = securityRequirements.length && setCollectionSecurity
-        ? getSelectedSecuritySchemeUids(securityRequirements, authentication, securitySchemeMap)
+    const selectedSecuritySchemeUids = (securityRequirements.length || preferredSecurityNames?.length) && setCollectionSecurity
+        ? getSelectedSecuritySchemeUids(securityRequirements, preferredSecurityNames, securitySchemeMap)
         : [];
     const collection = collectionSchema.parse({
         ...schema,
@@ -377,7 +362,7 @@ function getServersFromOpenApiDocument(servers, { baseServerURL } = {}) {
             return parsedSchema;
         }
         catch (error) {
-            console.warn(`Oops, that’s an invalid server configuration.`);
+            console.warn('Oops, that’s an invalid server configuration.');
             console.warn('Server:', server);
             console.warn('Error:', error);
             // Return undefined to remove the server

package/package.json

@@ -16,7 +16,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.2.105",
+  "version": "0.2.107",
   "engines": {
     "node": ">=18"
   },
@@ -127,18 +127,18 @@
     "yaml": "^2.4.5",
     "zod": "^3.23.8",
     "@scalar/object-utils": "1.1.13",
-    "@scalar/themes": "0.9.67",
-    "@scalar/types": "0.0.33",
-    "@scalar/openapi-types": "0.1.7"
+    "@scalar/openapi-types": "0.1.8",
+    "@scalar/themes": "0.9.68",
+    "@scalar/types": "0.0.34"
   },
   "devDependencies": {
     "type-fest": "^4.20.0",
     "vite": "^5.4.10",
     "vitest": "^1.6.0",
     "zod-to-ts": "github:amritk/zod-to-ts#build",
-    "@scalar/build-tooling": "0.1.13",
-    "@scalar/openapi-types": "0.1.7",
-    "@scalar/openapi-parser": "0.10.7"
+    "@scalar/openapi-parser": "0.10.8",
+    "@scalar/openapi-types": "0.1.8",
+    "@scalar/build-tooling": "0.1.14"
   },
   "scripts": {
     "build": "scalar-build-rollup",