@scalar/oas-utils 0.2.105 → 0.2.106

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @scalar/oas-utils
 
+## 0.2.106
+
+### Patch Changes
+
+- ed92564: feat: allow preferredSecurityScheme to pre-select a scheme not in the requirements
+
 ## 0.2.105
 
 ### Patch Changes

package/dist/transforms/import-spec.d.ts

@@ -16,7 +16,7 @@ export declare const parseSchema: (spec: string | UnknownObject, { shouldLoad }?
     errors: import("@scalar/openapi-parser").ErrorObject[];
 }>;
 /** Converts selected security requirements to uids */
-export declare const getSelectedSecuritySchemeUids: (securityRequirements: SelectedSecuritySchemeUids, authentication: ReferenceConfiguration["authentication"] | undefined, securitySchemeMap: Record<string, string>) => SelectedSecuritySchemeUids;
+export declare const getSelectedSecuritySchemeUids: (securityRequirements: SelectedSecuritySchemeUids, preferredSecurityNames: SelectedSecuritySchemeUids | undefined, securitySchemeMap: Record<string, string>) => SelectedSecuritySchemeUids;
 export type ImportSpecToWorkspaceArgs = Pick<CollectionPayload, 'documentUrl' | 'watchMode'> & Pick<ReferenceConfiguration, 'authentication' | 'baseServerURL' | 'servers'> & {
     /** Sets the preferred security scheme on the collection instead of the requests */
     setCollectionSecurity?: boolean;

package/dist/transforms/import-spec.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"import-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/import-spec.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAA;AAC3E,OAAO,EACL,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,OAAO,EACZ,KAAK,cAAc,EAGnB,KAAK,MAAM,EACX,KAAK,GAAG,EAMT,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAEL,KAAK,cAAc,EAGpB,MAAM,0BAA0B,CAAA;AAWjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAGxD,mFAAmF;AACnF,eAAO,MAAM,WAAW,SAChB,MAAM,GAAG,aAAa;;;IAuC1B;;;OAGG;YAC8C,WAAW,CAAC,QAAQ;;EAGxE,CAAA;AAED,sDAAsD;AACtD,eAAO,MAAM,6BAA6B,yBAClB,0BAA0B,kBAChC,sBAAsB,CAAC,gBAAgB,CAAC,GAAG,SAAS,qBACjD,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KACxC,0BAgCF,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAC1C,iBAAiB,EACjB,aAAa,GAAG,WAAW,CAC5B,GACC,IAAI,CACF,sBAAsB,EACtB,gBAAgB,GAAG,eAAe,GAAG,SAAS,CAC/C,GAAG;IACF,mFAAmF;IACnF,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAEH;;;;;;;;;;;;GAYG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,MAAM,GAAG,aAAa,EAC5B,EACE,cAAc,EACd,aAAa,EACb,WAAW,EACX,OAAO,EAAE,iBAAiB,EAC1B,qBAA6B,EAC7B,UAAU,EACV,SAAiB,GAClB,GAAE,yBAA8B,GAChC,OAAO,CACN;IACE,KAAK,EAAE,KAAK,CAAA;IACZ,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAA;IAC5B,QAAQ,EAAE,cAAc,EAAE,CAAA;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,IAAI,EAAE,GAAG,EAAE,CAAA;IACX,eAAe,EAAE,cAAc,EAAE,CAAA;CAClC,GACD;IAAE,KAAK,EAAE,IAAI,CAAC;IAAC,cAAc,EAAE,MAAM,EAAE,CAAA;CAAE,CAC5C,CA6UA;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAC3C,OAAO,EAAE,WAAW,CAAC,YAAY,EAAE,GAAG,SAAS,EAC/C,EAAE,aAAa,EAAE,GAAE,IAAI,CAAC,sBAAsB,EAAE,eAAe,CAAM,GACpE,MAAM,EAAE,CA8CV"}
+{"version":3,"file":"import-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/import-spec.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAA;AAC3E,OAAO,EACL,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,OAAO,EACZ,KAAK,cAAc,EAGnB,KAAK,MAAM,EACX,KAAK,GAAG,EAMT,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAEL,KAAK,cAAc,EAGpB,MAAM,0BAA0B,CAAA;AAWjC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAGxD,mFAAmF;AACnF,eAAO,MAAM,WAAW,SAChB,MAAM,GAAG,aAAa;;;IAuC1B;;;OAGG;YAC8C,WAAW,CAAC,QAAQ;;EAGxE,CAAA;AAED,sDAAsD;AACtD,eAAO,MAAM,6BAA6B,yBAClB,0BAA0B,0BACxB,0BAA0B,iCAC/B,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KACxC,0BAeF,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAC1C,iBAAiB,EACjB,aAAa,GAAG,WAAW,CAC5B,GACC,IAAI,CACF,sBAAsB,EACtB,gBAAgB,GAAG,eAAe,GAAG,SAAS,CAC/C,GAAG;IACF,mFAAmF;IACnF,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAC/B,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB,CAAA;AAEH;;;;;;;;;;;;GAYG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,MAAM,GAAG,aAAa,EAC5B,EACE,cAAc,EACd,aAAa,EACb,WAAW,EACX,OAAO,EAAE,iBAAiB,EAC1B,qBAA6B,EAC7B,UAAU,EACV,SAAiB,GAClB,GAAE,yBAA8B,GAChC,OAAO,CACN;IACE,KAAK,EAAE,KAAK,CAAA;IACZ,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAA;IAC5B,QAAQ,EAAE,cAAc,EAAE,CAAA;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,IAAI,EAAE,GAAG,EAAE,CAAA;IACX,eAAe,EAAE,cAAc,EAAE,CAAA;CAClC,GACD;IAAE,KAAK,EAAE,IAAI,CAAC;IAAC,cAAc,EAAE,MAAM,EAAE,CAAA;CAAE,CAC5C,CAuWA;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAC3C,OAAO,EAAE,WAAW,CAAC,YAAY,EAAE,GAAG,SAAS,EAC/C,EAAE,aAAa,EAAE,GAAE,IAAI,CAAC,sBAAsB,EAAE,eAAe,CAAM,GACpE,MAAM,EAAE,CA8CV"}

package/dist/transforms/import-spec.js

@@ -51,29 +51,13 @@ 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)
+    const uids = names.map((name) => Array.isArray(name)
         ? name.map((k) => securitySchemeMap[k])
         : securitySchemeMap[name]);
     return uids;
@@ -212,9 +196,25 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
                 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]));
+                }
+                else
+                    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,
@@ -307,13 +307,20 @@ 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,

package/package.json

@@ -16,7 +16,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.2.105",
+  "version": "0.2.106",
   "engines": {
     "node": ">=18"
   },
@@ -126,10 +126,10 @@
     "nanoid": "^5.0.9",
     "yaml": "^2.4.5",
     "zod": "^3.23.8",
+    "@scalar/openapi-types": "0.1.7",
     "@scalar/object-utils": "1.1.13",
-    "@scalar/themes": "0.9.67",
     "@scalar/types": "0.0.33",
-    "@scalar/openapi-types": "0.1.7"
+    "@scalar/themes": "0.9.67"
   },
   "devDependencies": {
     "type-fest": "^4.20.0",
@@ -137,8 +137,8 @@
     "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.7",
+    "@scalar/openapi-types": "0.1.7"
   },
   "scripts": {
     "build": "scalar-build-rollup",