@scalar/oas-utils 0.2.3 → 0.2.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @scalar/oas-utils
 
+## 0.2.4
+
+### Patch Changes
+
+- c20c7d0: feat: security schemes and requirements
+
 ## 0.2.3
 
 ### Patch Changes

package/dist/entities/workspace/collection/collection.d.ts

@@ -14,14 +14,22 @@ declare const exteralDocumentationSchema: z.ZodObject<{
     url: string;
     description?: string | undefined;
 }, {
-    url?: string | undefined;
     description?: string | undefined;
+    url?: string | undefined;
 }>;
 export type ExternalDocumentation = z.infer<typeof exteralDocumentationSchema>;
 declare const collectionSchema: z.ZodObject<{
     uid: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     spec: z.ZodDefault<z.ZodOptional<z.ZodObject<{
         openapi: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodLiteral<"3.1.0">, z.ZodLiteral<"4.0.0">]>>>;
+        /**
+         * A declaration of which security mechanisms can be used across the API. The list of
+         * values includes alternative security requirement objects that can be used. Only
+         * one of the security requirement objects need to be satisfied to authorize a request.
+         * Individual operations can override this definition. To make security optional, an empty
+         * security requirement ({}) can be included in the array.
+         */
+        security: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>>, "many">>>;
         /** OAS info */
         info: z.ZodOptional<z.ZodObject<{
             /** REQUIRED. The title of the API. */
@@ -77,8 +85,8 @@ declare const collectionSchema: z.ZodObject<{
         }, "strip", z.ZodTypeAny, {
             title: string;
             version: string;
-            summary?: string | undefined;
             description?: string | undefined;
+            summary?: string | undefined;
             termsOfService?: string | undefined;
             contact?: {
                 name?: string | undefined;
@@ -91,9 +99,9 @@ declare const collectionSchema: z.ZodObject<{
                 url?: string | undefined;
             } | undefined;
         }, {
+            description?: string | undefined;
             title?: string | undefined;
             summary?: string | undefined;
-            description?: string | undefined;
             termsOfService?: string | undefined;
             contact?: {
                 name?: string | undefined;
@@ -125,8 +133,8 @@ declare const collectionSchema: z.ZodObject<{
                 url: string;
                 description?: string | undefined;
             }, {
-                url?: string | undefined;
                 description?: string | undefined;
+                url?: string | undefined;
             }>>;
         }, "strip", z.ZodTypeAny, {
             name: string;
@@ -136,11 +144,11 @@ declare const collectionSchema: z.ZodObject<{
                 description?: string | undefined;
             } | undefined;
         }, {
-            name?: string | undefined;
             description?: string | undefined;
+            name?: string | undefined;
             externalDocs?: {
-                url?: string | undefined;
                 description?: string | undefined;
+                url?: string | undefined;
             } | undefined;
         }>, "many">>;
         externalDocs: z.ZodOptional<z.ZodObject<{
@@ -152,11 +160,12 @@ declare const collectionSchema: z.ZodObject<{
             url: string;
             description?: string | undefined;
         }, {
-            url?: string | undefined;
             description?: string | undefined;
+            url?: string | undefined;
         }>>;
     }, "strip", z.ZodTypeAny, {
         openapi: string;
+        security: Record<string, string[]>[];
         serverUids: string[];
         tags: {
             name: string;
@@ -173,8 +182,8 @@ declare const collectionSchema: z.ZodObject<{
         info?: {
             title: string;
             version: string;
-            summary?: string | undefined;
             description?: string | undefined;
+            summary?: string | undefined;
             termsOfService?: string | undefined;
             contact?: {
                 name?: string | undefined;
@@ -189,14 +198,15 @@ declare const collectionSchema: z.ZodObject<{
         } | undefined;
     }, {
         externalDocs?: {
-            url?: string | undefined;
             description?: string | undefined;
+            url?: string | undefined;
         } | undefined;
         openapi?: string | undefined;
+        security?: Record<string, string[] | undefined>[] | undefined;
         info?: {
+            description?: string | undefined;
             title?: string | undefined;
             summary?: string | undefined;
-            description?: string | undefined;
             termsOfService?: string | undefined;
             contact?: {
                 name?: string | undefined;
@@ -212,14 +222,28 @@ declare const collectionSchema: z.ZodObject<{
         } | undefined;
         serverUids?: string[] | undefined;
         tags?: {
-            name?: string | undefined;
             description?: string | undefined;
+            name?: string | undefined;
             externalDocs?: {
-                url?: string | undefined;
                 description?: string | undefined;
+                url?: string | undefined;
             } | undefined;
         }[] | undefined;
     }>>>;
+    /**
+     * The currently selected security scheme key
+     * TODO eventually we will need to maintain one per request + collection but this will do for now
+     */
+    selectedSecuritySchemes: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        uid: z.ZodString;
+        flowKey: z.ZodOptional<z.ZodEnum<["implicit", "clientCredentials", "password", "authorizationCode"]>>;
+    }, "strip", z.ZodTypeAny, {
+        uid: string;
+        flowKey?: "implicit" | "password" | "clientCredentials" | "authorizationCode" | undefined;
+    }, {
+        uid: string;
+        flowKey?: "implicit" | "password" | "clientCredentials" | "authorizationCode" | undefined;
+    }>, "many">>;
     /** The currently selected server */
     selectedServerUid: z.ZodDefault<z.ZodString>;
     /**  List of uids that correspond to collection requests or folders */
@@ -228,6 +252,7 @@ declare const collectionSchema: z.ZodObject<{
     uid: string;
     spec: {
         openapi: string;
+        security: Record<string, string[]>[];
         serverUids: string[];
         tags: {
             name: string;
@@ -244,8 +269,8 @@ declare const collectionSchema: z.ZodObject<{
         info?: {
             title: string;
             version: string;
-            summary?: string | undefined;
             description?: string | undefined;
+            summary?: string | undefined;
             termsOfService?: string | undefined;
             contact?: {
                 name?: string | undefined;
@@ -259,20 +284,25 @@ declare const collectionSchema: z.ZodObject<{
             } | undefined;
         } | undefined;
     };
+    selectedSecuritySchemes: {
+        uid: string;
+        flowKey?: "implicit" | "password" | "clientCredentials" | "authorizationCode" | undefined;
+    }[];
     selectedServerUid: string;
     childUids: string[];
 }, {
     uid?: string | undefined;
     spec?: {
         externalDocs?: {
-            url?: string | undefined;
             description?: string | undefined;
+            url?: string | undefined;
         } | undefined;
         openapi?: string | undefined;
+        security?: Record<string, string[] | undefined>[] | undefined;
         info?: {
+            description?: string | undefined;
             title?: string | undefined;
             summary?: string | undefined;
-            description?: string | undefined;
             termsOfService?: string | undefined;
             contact?: {
                 name?: string | undefined;
@@ -288,14 +318,18 @@ declare const collectionSchema: z.ZodObject<{
         } | undefined;
         serverUids?: string[] | undefined;
         tags?: {
-            name?: string | undefined;
             description?: string | undefined;
+            name?: string | undefined;
             externalDocs?: {
-                url?: string | undefined;
                 description?: string | undefined;
+                url?: string | undefined;
             } | undefined;
         }[] | undefined;
     } | undefined;
+    selectedSecuritySchemes?: {
+        uid: string;
+        flowKey?: "implicit" | "password" | "clientCredentials" | "authorizationCode" | undefined;
+    }[] | undefined;
     selectedServerUid?: string | undefined;
     childUids?: string[] | undefined;
 }>;

package/dist/entities/workspace/collection/collection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../../../../src/entities/workspace/collection/collection.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AA6DvB;;;;;GAKG;AACH,QAAA,MAAM,0BAA0B;IAC9B,6GAA6G;;IAE7G,yFAAyF;;;;;;;;EAEzF,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAgC9E,QAAA,MAAM,gBAAgB;;;;QATpB,eAAe;;YAtDf,sCAAsC;;YAEtC,kCAAkC;;YAElC,4FAA4F;;YAE5F,oFAAoF;;YAEpF,mDAAmD;;gBAxBnD,+DAA+D;;gBAE/D,sFAAsF;;gBAEtF,0GAA0G;;;;;;;;;;;YAsB1G,mDAAmD;;gBA5CnD,mDAAmD;;gBAEnD,2GAA2G;;gBAE3G;;;mBAGG;;;;;;;;;;;YAuCH;;;eAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAyCH,wDAAwD;;QAExD,eAAe;;YAjBf,qCAAqC;;YAErC,6FAA6F;;YAE7F,sDAAsD;;gBAnBtD,6GAA6G;;gBAE7G,yFAAyF;;;;;;;;;;;;;;;;;;;;;;;;;YAFzF,6GAA6G;;YAE7G,yFAAyF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAsCzF,oCAAoC;;IAEpC,sEAAsE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEtE,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AACzD,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAEhE,8BAA8B;AAC9B,eAAO,MAAM,gBAAgB,YAAa,iBAAiB,KAAG,UACd,CAAA"}
+{"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../../../../src/entities/workspace/collection/collection.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AA+DvB;;;;;GAKG;AACH,QAAA,MAAM,0BAA0B;IAC9B,6GAA6G;;IAE7G,yFAAyF;;;;;;;;EAEzF,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAwC9E,QAAA,MAAM,gBAAgB;;;;QAjBpB;;;;;;WAMG;;QAEH,eAAe;;YA9Df,sCAAsC;;YAEtC,kCAAkC;;YAElC,4FAA4F;;YAE5F,oFAAoF;;YAEpF,mDAAmD;;gBAxBnD,+DAA+D;;gBAE/D,sFAAsF;;gBAEtF,0GAA0G;;;;;;;;;;;YAsB1G,mDAAmD;;gBA5CnD,mDAAmD;;gBAEnD,2GAA2G;;gBAE3G;;;mBAGG;;;;;;;;;;;YAuCH;;;eAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAiDH,wDAAwD;;QAExD,eAAe;;YAzBf,qCAAqC;;YAErC,6FAA6F;;YAE7F,sDAAsD;;gBAnBtD,6GAA6G;;gBAE7G,yFAAyF;;;;;;;;;;;;;;;;;;;;;;;;;YAFzF,6GAA6G;;YAE7G,yFAAyF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA8CzF;;;OAGG;;;;;;;;;;;IAiBH,oCAAoC;;IAEpC,sEAAsE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEtE,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AACzD,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAEhE,8BAA8B;AAC9B,eAAO,MAAM,gBAAgB,YAAa,iBAAiB,KAAG,UACd,CAAA"}

package/dist/entities/workspace/collection/collection.js

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { securityRequirement } from '../security/security-requirement.js';
 import { nanoidSchema } from '../shared/utility.js';
 import { deepMerge } from '../../../helpers/deepMerge.js';
 
@@ -90,6 +91,14 @@ const specSchema = z.object({
         .union([z.string(), z.literal('3.1.0'), z.literal('4.0.0')])
         .optional()
         .default('3.1.0'),
+    /**
+     * A declaration of which security mechanisms can be used across the API. The list of
+     * values includes alternative security requirement objects that can be used. Only
+     * one of the security requirement objects need to be satisfied to authorize a request.
+     * Individual operations can override this definition. To make security optional, an empty
+     * security requirement ({}) can be included in the array.
+     */
+    security: z.array(securityRequirement).optional().default([]),
     /** OAS info */
     info: infoSchema.optional(),
     /** Uids which refer to servers on the workspace base */
@@ -101,6 +110,24 @@ const specSchema = z.object({
 const collectionSchema = z.object({
     uid: nanoidSchema,
     spec: specSchema.optional().default({}),
+    /**
+     * The currently selected security scheme key
+     * TODO eventually we will need to maintain one per request + collection but this will do for now
+     */
+    selectedSecuritySchemes: z
+        .array(z.object({
+        uid: z.string(),
+        // Wasn't sure how to extract the keys from another schema so hard coded these for now
+        flowKey: z
+            .enum([
+            'implicit',
+            'clientCredentials',
+            'password',
+            'authorizationCode',
+        ])
+            .optional(),
+    }))
+        .default([]),
     /** The currently selected server */
     selectedServerUid: z.string().default(''),
     /**  List of uids that correspond to collection requests or folders */

package/dist/entities/workspace/cookie/cookie.d.ts

@@ -36,8 +36,8 @@ declare const cookieSchema: z.ZodObject<{
     secure: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     value: string;
-    name: string;
     uid: string;
+    name: string;
     sameSite: "Lax" | "Strict" | "None";
     path?: string | undefined;
     domain?: string | undefined;
@@ -69,8 +69,8 @@ export type CookiePayload = z.input<typeof cookieSchema>;
 /** Create cookie helper */
 export declare const createCookie: (payload: CookiePayload) => {
     value: string;
-    name: string;
     uid: string;
+    name: string;
     sameSite: "Lax" | "Strict" | "None";
     path?: string | undefined;
     domain?: string | undefined;

package/dist/entities/workspace/environment/environment.d.ts

@@ -16,8 +16,8 @@ declare const environmentSchema: z.ZodObject<{
     }>, "many">>>;
     isDefault: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
-    name: string;
     uid: string;
+    name: string;
     color: string;
     raw: string;
     parsed: {
@@ -26,8 +26,8 @@ declare const environmentSchema: z.ZodObject<{
     }[];
     isDefault?: boolean | undefined;
 }, {
-    name?: string | undefined;
     uid?: string | undefined;
+    name?: string | undefined;
     color?: string | undefined;
     raw?: string | undefined;
     parsed?: {
@@ -41,8 +41,8 @@ export type Environment = z.infer<typeof environmentSchema>;
 export type EnvironmentPayload = z.input<typeof environmentSchema>;
 /** Create environment helper */
 export declare const createEnvironment: (payload: EnvironmentPayload) => {
-    name: string;
     uid: string;
+    name: string;
     color: string;
     raw: string;
     parsed: {

package/dist/entities/workspace/folder/folder.d.ts

@@ -12,14 +12,14 @@ declare const folderSchema: z.ZodObject<{
      */
     childUids: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
 }, "strip", z.ZodTypeAny, {
-    name: string;
     uid: string;
+    name: string;
     childUids: string[];
     description?: string | undefined;
 }, {
-    name?: string | undefined;
-    description?: string | undefined;
     uid?: string | undefined;
+    description?: string | undefined;
+    name?: string | undefined;
     childUids?: string[] | undefined;
 }>;
 /** Folders will correspond to the x- */
@@ -27,8 +27,8 @@ export type Folder = z.infer<typeof folderSchema>;
 export type FolderPayload = z.input<typeof folderSchema>;
 /** Create folder helper */
 export declare const createFolder: (payload: FolderPayload) => {
-    name: string;
     uid: string;
+    name: string;
     childUids: string[];
     description?: string | undefined;
 };

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

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

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

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

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

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

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

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+/**
+ * Security Requirement
+ * Lists the required security schemes to execute this operation OR the whole collection/spec.
+ * The name used for each property MUST correspond to a security scheme declared in the Security
+ * Schemes under the Components Object.
+ *
+ * The key (name) here will be matched to the key of the securityScheme for linking
+ *
+ * @see https://spec.openapis.org/oas/latest.html#security-requirement-object
+ */
+export declare const securityRequirement: z.ZodRecord<z.ZodString, z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>>;
+//# sourceMappingURL=security-requirement.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"security-requirement.d.ts","sourceRoot":"","sources":["../../../../src/entities/workspace/security/security-requirement.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB;;;;;;;;;GASG;AACH,eAAO,MAAM,mBAAmB,wFAG/B,CAAA"}

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

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+
+/**
+ * Security Requirement
+ * Lists the required security schemes to execute this operation OR the whole collection/spec.
+ * The name used for each property MUST correspond to a security scheme declared in the Security
+ * Schemes under the Components Object.
+ *
+ * The key (name) here will be matched to the key of the securityScheme for linking
+ *
+ * @see https://spec.openapis.org/oas/latest.html#security-requirement-object
+ */
+const securityRequirement = z.record(z.string(), z.array(z.string()).optional().default([]));
+
+export { securityRequirement };