@scalar/oas-utils 0.2.3 → 0.2.4

package/dist/transforms/import-spec.js

@@ -70,6 +70,7 @@ const importSpecToWorkspace = async (spec) => {
                 tags: operation.tags || ['default'],
                 description: operation.description,
                 operationId: operation.operationId,
+                security: operation.security,
                 summary: operation.summary,
                 externalDocs: operation.externalDocs,
                 requestBody: operation.requestBody,
@@ -110,14 +111,26 @@ const importSpecToWorkspace = async (spec) => {
             },
         ];
     const servers = unparsedServers.map((server) => createServer(server));
+    // Select initial security
+    const firstSecurityKey = Object.keys(parsedSpec.components?.securitySchemes ?? {})?.[0];
+    const firstScheme = parsedSpec.components?.securitySchemes?.[firstSecurityKey ?? ''];
+    // In the case of oauth2 we need to select the flow as well
+    const flowKey = firstScheme?.type === 'oauth2'
+        ? Object.keys(firstScheme.flows ?? {})[0]
+        : undefined;
+    const selectedSecuritySchemes = firstSecurityKey
+        ? [{ uid: firstSecurityKey, ...(flowKey ? { flowKey } : {}) }]
+        : [];
     const collection = createCollection({
         spec: {
             openapi: parsedSpec.openapi,
             info: schema?.info,
+            security: parsedSpec.security,
             externalDocs: schema?.externalDocs,
             serverUids: servers.map(({ uid }) => uid),
             tags,
         },
+        selectedSecuritySchemes,
         selectedServerUid: servers[0].uid,
         // We default to having all the requests in the root folder
         childUids: folders.map(({ uid }) => uid),

package/package.json

@@ -16,7 +16,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.2.3",
+  "version": "0.2.4",
   "engines": {
     "node": ">=18"
   },
@@ -59,9 +59,9 @@
       "import": "./dist/entities/workspace/server/index.js",
       "types": "./dist/entities/workspace/server/index.d.ts"
     },
-    "./entities/workspace/security-schemes": {
-      "import": "./dist/entities/workspace/security-schemes/index.js",
-      "types": "./dist/entities/workspace/security-schemes/index.d.ts"
+    "./entities/workspace/security": {
+      "import": "./dist/entities/workspace/security/index.js",
+      "types": "./dist/entities/workspace/security/index.d.ts"
     },
     "./entities/workspace/folder": {
       "import": "./dist/entities/workspace/folder/index.js",

package/dist/entities/workspace/security-schemes/index.d.ts

@@ -1,2 +0,0 @@
-export * from './security-schemes.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/entities/workspace/security-schemes/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/entities/workspace/security-schemes/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA"}

package/dist/entities/workspace/security-schemes/index.js

@@ -1 +0,0 @@
-export { createSecurityScheme } from './security-schemes.js';

package/dist/entities/workspace/security-schemes/security-schemes.d.ts

@@ -1,19 +0,0 @@
-import { z } from 'zod';
-declare const securityScheme: z.ZodObject<{
-    /** REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2",
-     * "openIdConnect". */
-    type: z.ZodDefault<z.ZodOptional<z.ZodEnum<["apiKey", "http", "mutualTLS", "oauth2"]>>>;
-}, "strip", z.ZodTypeAny, {
-    type: "apiKey" | "http" | "mutualTLS" | "oauth2";
-}, {
-    type?: "apiKey" | "http" | "mutualTLS" | "oauth2" | undefined;
-}>;
-/** Folders will correspond to the x- */
-export type SecurityScheme = z.infer<typeof securityScheme>;
-export type SecuritySchemePayload = z.input<typeof securityScheme>;
-/** Create Security Scheme with defaults */
-export declare const createSecurityScheme: (payload: SecuritySchemePayload) => {
-    type: "apiKey" | "http" | "mutualTLS" | "oauth2";
-};
-export {};
-//# sourceMappingURL=security-schemes.d.ts.map

package/dist/entities/workspace/security-schemes/security-schemes.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"security-schemes.d.ts","sourceRoot":"","sources":["../../../../src/entities/workspace/security-schemes/security-schemes.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,QAAA,MAAM,cAAc;IAClB;0BACsB;;;;;;EAKtB,CAAA;AAEF,wCAAwC;AACxC,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAC3D,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAElE,2CAA2C;AAC3C,eAAO,MAAM,oBAAoB,YAAa,qBAAqB;;CACrB,CAAA"}

package/dist/entities/workspace/security-schemes/security-schemes.js

@@ -1,15 +0,0 @@
-import { z } from 'zod';
-import { deepMerge } from '../../../helpers/deepMerge.js';
-
-const securityScheme = z.object({
-    /** REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "mutualTLS", "oauth2",
-     * "openIdConnect". */
-    type: z
-        .enum(['apiKey', 'http', 'mutualTLS', 'oauth2'])
-        .optional()
-        .default('apiKey'),
-});
-/** Create Security Scheme with defaults */
-const createSecurityScheme = (payload) => deepMerge(securityScheme.parse({}), payload);
-
-export { createSecurityScheme };

package/dist/helpers/objectMerge.d.ts

@@ -1,5 +0,0 @@
-/**
- * Overwrite a target object a new replacement object handling removed keys
- **/
-export declare function objectMerge<A extends object, B extends object>(target: A, replacement: B): B;
-//# sourceMappingURL=objectMerge.d.ts.map

package/dist/helpers/objectMerge.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"objectMerge.d.ts","sourceRoot":"","sources":["../../src/helpers/objectMerge.ts"],"names":[],"mappings":"AACA;;IAEI;AACJ,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,EAC5D,MAAM,EAAE,CAAC,EACT,WAAW,EAAE,CAAC,KAYf"}