@scalar/oas-utils 0.2.48 → 0.2.50

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @scalar/oas-utils
 
+## 0.2.50
+
+### Patch Changes
+
+- 9057781: fix: add missing securityDefinitions check on import
+
+## 0.2.49
+
+### Patch Changes
+
+- cd8ba1c: feat: added setting of initial security schemes in the client
+
 ## 0.2.48
 
 ### Patch Changes

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

@@ -1,5 +1,6 @@
 import { type Collection, type Request, type RequestExample, type Server, type Tag } from '../entities/spec/index.js';
 import { type SecurityScheme } from '../entities/spec/security.js';
+import type { AuthenticationState } from '@scalar/types/legacy';
 import type { UnknownObject } from '@scalar/types/utils';
 /**
  * Import an OpenAPI spec file and convert it to workspace entities
@@ -9,7 +10,7 @@ import type { UnknownObject } from '@scalar/types/utils';
  * created and used at various levels we will index via the uids to create
  * the relationships
  */
-export declare function importSpecToWorkspace(spec: string | UnknownObject): Promise<{
+export declare function importSpecToWorkspace(spec: string | UnknownObject, preferredSecurityScheme?: AuthenticationState['preferredSecurityScheme']): Promise<{
     error: false;
     collection: Collection;
     requests: Request[];

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,EACL,KAAK,UAAU,EACf,KAAK,OAAO,EACZ,KAAK,cAAc,EAGnB,KAAK,MAAM,EACX,KAAK,GAAG,EAOT,MAAM,iBAAiB,CAAA;AACxB,OAAO,EACL,KAAK,cAAc,EAGpB,MAAM,0BAA0B,CAAA;AAKjC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAiCxD;;;;;;;GAOG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,MAAM,GAAG,aAAa,GAC3B,OAAO,CACN;IACE,KAAK,EAAE,KAAK,CAAA;IACZ,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB,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,CAwOA"}
+{"version":3,"file":"import-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/import-spec.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,UAAU,EACf,KAAK,OAAO,EACZ,KAAK,cAAc,EAGnB,KAAK,MAAM,EACX,KAAK,GAAG,EAOT,MAAM,iBAAiB,CAAA;AACxB,OAAO,EACL,KAAK,cAAc,EAGpB,MAAM,0BAA0B,CAAA;AAKjC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAA;AAC/D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAiCxD;;;;;;;GAOG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,MAAM,GAAG,aAAa,EAC5B,uBAAuB,CAAC,EAAE,mBAAmB,CAAC,yBAAyB,CAAC,GACvE,OAAO,CACN;IACE,KAAK,EAAE,KAAK,CAAA;IACZ,UAAU,EAAE,UAAU,CAAA;IACtB,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB,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,CAkQA"}

package/dist/transforms/import-spec.js

@@ -40,7 +40,7 @@ const convertOauth2Flows = (security, nameKey) => {
  * created and used at various levels we will index via the uids to create
  * the relationships
  */
-async function importSpecToWorkspace(spec) {
+async function importSpecToWorkspace(spec, preferredSecurityScheme) {
     const { filesystem } = await load(spec);
     const { specification } = upgrade(filesystem);
     const { schema: _schema, errors = [] } = await dereference(specification);
@@ -66,7 +66,7 @@ async function importSpecToWorkspace(spec) {
     const tagNames = new Set();
     // ---------------------------------------------------------------------------
     // SECURITY HANDLING
-    const security = schema.components?.securitySchemes ?? {};
+    const security = schema.components?.securitySchemes ?? schema?.securityDefinitions ?? {};
     const securitySchemes = Object.entries(security)
         .map?.(([nameKey, s]) => {
         const scheme = schemaModel(
@@ -107,12 +107,32 @@ async function importSpecToWorkspace(spec) {
                 // 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: removed, ...operationWithoutSecurity } = operation;
+                const { security: operationSecurity, ...operationWithoutSecurity } = operation;
+                // Grab the security requirements for this operation
+                const securityRequirements = (operationSecurity ??
+                    schema.security ??
+                    []).flatMap((s) => {
+                    const keys = Object.keys(s);
+                    if (keys.length)
+                        return keys[0];
+                    else
+                        return [];
+                });
+                let selectedSecuritySchemeUids = [];
+                // Set the initially selected security scheme
+                if (securityRequirements.length) {
+                    const name = preferredSecurityScheme &&
+                        securityRequirements.includes(preferredSecurityScheme ?? '')
+                        ? preferredSecurityScheme
+                        : securityRequirements[0];
+                    const uid = securitySchemeMap[name];
+                    selectedSecuritySchemeUids = [uid];
+                }
                 const requestPayload = {
                     ...operationWithoutSecurity,
                     method,
                     path: pathString,
-                    selectedSecuritySchemeUids: [],
+                    selectedSecuritySchemeUids,
                     // Merge path and operation level parameters
                     parameters: [
                         ...(path?.parameters ?? []),
@@ -122,8 +142,8 @@ async function importSpecToWorkspace(spec) {
                 };
                 // Add list of UIDs to associate security schemes
                 // As per the spec if there is operation level security we ignore the top level requirements
-                if (operation.security?.length)
-                    requestPayload.security = operation.security?.map((s) => {
+                if (operationSecurity?.length)
+                    requestPayload.security = operationSecurity.map((s) => {
                         const keys = Object.keys(s);
                         // Handle the case of {} for optional
                         if (keys.length) {

package/package.json

@@ -16,7 +16,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.2.48",
+  "version": "0.2.50",
   "engines": {
     "node": ">=18"
   },