@scalar/oas-utils 0.2.100 → 0.2.102

package/dist/transforms/import-spec.js

@@ -4,12 +4,12 @@ import { schemaModel } from '../helpers/schema-model.js';
 import { keysOf } from '@scalar/object-utils/arrays';
 import { load, upgrade, dereference } from '@scalar/openapi-parser';
 import { serverSchema } from '../entities/spec/server.js';
+import { isDefined } from '../helpers/is-defined.js';
 import { requestSchema } from '../entities/spec/requests.js';
 import { tagSchema } from '../entities/spec/spec-objects.js';
 import { createExampleFromRequest } from '../entities/spec/request-examples.js';
 import { collectionSchema } from '../entities/spec/collection.js';
 import { concatenateUrlAndPath } from '../helpers/concatenateUrlAndPath.js';
-import { isDefined } from '../helpers/is-defined.js';
 
 /** Takes a string or object and parses it into an openapi spec compliant schema */
 const parseSchema = async (spec, { shouldLoad = true } = {}) => {
@@ -50,6 +50,17 @@ const parseSchema = async (spec, { shouldLoad = true } = {}) => {
         errors: [...loadErrors, ...derefErrors],
     };
 };
+/** Converts selected security requirements to uids */
+const getSelectedSecuritySchemeUids = (securityRequirements, authentication, securitySchemeMap) => {
+    const name = authentication?.preferredSecurityScheme &&
+        securityRequirements.includes(authentication.preferredSecurityScheme)
+        ? authentication.preferredSecurityScheme
+        : securityRequirements[0];
+    const uids = Array.isArray(name)
+        ? name.map((k) => securitySchemeMap[k])
+        : securitySchemeMap[name];
+    return [uids];
+};
 /**
  * Imports an OpenAPI document and converts it to workspace entities (Collection, Request, Server, etc.)
  *
@@ -169,26 +180,18 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
             operation.tags?.forEach((t) => tagNames.add(t));
             // Remove security here and add it correctly below
             const { security: operationSecurity, ...operationWithoutSecurity } = operation;
-            // Grab the security requirements for this operation
             const securityRequirements = (operationSecurity ??
                 schema.security ??
-                []).flatMap((s) => {
+                [])
+                .map((s) => {
                 const keys = Object.keys(s);
-                if (keys.length)
-                    return keys[0];
-                else
-                    return [];
-            });
-            let selectedSecuritySchemeUids = [];
+                return keys.length > 1 ? keys : keys[0];
+            })
+                .filter(isDefined);
             // Set the initially selected security scheme
-            if (securityRequirements.length && !setCollectionSecurity) {
-                const name = authentication?.preferredSecurityScheme &&
-                    securityRequirements.includes(authentication.preferredSecurityScheme ?? '')
-                    ? authentication.preferredSecurityScheme
-                    : securityRequirements[0];
-                const uid = securitySchemeMap[name];
-                selectedSecuritySchemeUids = [uid];
-            }
+            const selectedSecuritySchemeUids = securityRequirements.length && !setCollectionSecurity
+                ? getSelectedSecuritySchemeUids(securityRequirements, authentication, securitySchemeMap)
+                : [];
             const requestPayload = {
                 ...operationWithoutSecurity,
                 method,
@@ -256,7 +259,7 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
     });
     // Add the request UIDs to the tag children (or collection root)
     requests.forEach((r) => {
-        if (r.tags) {
+        if (r.tags?.length) {
             r.tags.forEach((t) => {
                 tagMap[t].children.push(r.uid);
             });
@@ -278,14 +281,15 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
     });
     // ---------------------------------------------------------------------------
     // Generate Collection
-    const securityKeys = Object.keys(schema.security?.[0] ?? security ?? {});
-    let selectedSecuritySchemeUids = [];
-    /** Selected security scheme UIDs for the collection, defaults to the first key */
-    if (setCollectionSecurity && securityKeys.length) {
-        const preferred = authentication?.preferredSecurityScheme || securityKeys[0];
-        const uid = securitySchemeMap[preferred];
-        selectedSecuritySchemeUids = [uid];
-    }
+    // Grab the security requirements for this operation
+    const securityRequirements = (schema.security ?? []).map((s) => {
+        const keys = Object.keys(s);
+        return keys.length > 1 ? keys : keys[0];
+    });
+    // Set the initially selected security scheme
+    const selectedSecuritySchemeUids = securityRequirements.length && setCollectionSecurity
+        ? getSelectedSecuritySchemeUids(securityRequirements, authentication, securitySchemeMap)
+        : [];
     const collection = collectionSchema.parse({
         ...schema,
         watchMode,
@@ -357,4 +361,4 @@ function getServersFromOpenApiDocument(servers, { baseServerURL } = {}) {
         .filter(isDefined);
 }
 
-export { getServersFromOpenApiDocument, importSpecToWorkspace, parseSchema };
+export { getSelectedSecuritySchemeUids, getServersFromOpenApiDocument, importSpecToWorkspace, parseSchema };

package/dist/transforms/index.js

@@ -1,2 +1,2 @@
-export { getServersFromOpenApiDocument, importSpecToWorkspace, parseSchema } from './import-spec.js';
+export { getSelectedSecuritySchemeUids, getServersFromOpenApiDocument, importSpecToWorkspace, parseSchema } from './import-spec.js';
 export { exportSpecFromWorkspace } from './export-spec.js';

package/package.json

@@ -16,7 +16,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.2.100",
+  "version": "0.2.102",
   "engines": {
     "node": ">=18"
   },
@@ -38,6 +38,11 @@
       "types": "./dist/migrations/index.d.ts",
       "default": "./dist/migrations/index.js"
     },
+    "./migrations/v-2.5.0": {
+      "import": "./dist/migrations/v-2.5.0/index.js",
+      "types": "./dist/migrations/v-2.5.0/index.d.ts",
+      "default": "./dist/migrations/v-2.5.0/index.js"
+    },
     "./migrations/v-2.4.0": {
       "import": "./dist/migrations/v-2.4.0/index.js",
       "types": "./dist/migrations/v-2.4.0/index.d.ts",
@@ -122,9 +127,9 @@
     "yaml": "^2.4.5",
     "zod": "^3.23.8",
     "@scalar/object-utils": "1.1.12",
-    "@scalar/themes": "0.9.62",
-    "@scalar/types": "0.0.28",
-    "@scalar/openapi-types": "0.1.6"
+    "@scalar/themes": "0.9.64",
+    "@scalar/openapi-types": "0.1.7",
+    "@scalar/types": "0.0.30"
   },
   "devDependencies": {
     "type-fest": "^4.20.0",
@@ -133,7 +138,7 @@
     "zod-to-ts": "github:amritk/zod-to-ts#build",
     "@scalar/build-tooling": "0.1.12",
     "@scalar/openapi-parser": "0.10.4",
-    "@scalar/openapi-types": "0.1.6"
+    "@scalar/openapi-types": "0.1.7"
   },
   "scripts": {
     "build": "scalar-build-rollup",