@scalar/api-client 2.3.8 → 2.3.10

package/dist/store/active-entities.d.ts

@@ -25,8 +25,8 @@ export type EnvVariable = {
  */
 export declare const createActiveEntitiesStore: ({ collections, requestExamples, requests, router, servers, workspaces, }: CreateActiveEntitiesStoreParams) => {
     activeCollection: import("vue").ComputedRef<{
-        type: "collection";
         uid: string & import("zod").BRAND<"collection">;
+        type: "collection";
         children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
         openapi: string;
         info: {
@@ -54,6 +54,7 @@ export declare const createActiveEntitiesStore: ({ collections, requestExamples,
         requests: (string & import("zod").BRAND<"operation">)[];
         tags: (string & import("zod").BRAND<"tag">)[];
         watchMode: boolean;
+        useCollectionSecurity: boolean;
         watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
         externalDocs?: {
             url: string;
@@ -68,12 +69,12 @@ export declare const createActiveEntitiesStore: ({ collections, requestExamples,
                 default: string;
                 description?: string | undefined;
             }>;
-            description?: string | undefined;
             color?: string | undefined;
+            description?: string | undefined;
         }> | undefined;
         'x-scalar-secrets'?: Record<string, {
-            example?: string | undefined;
             description?: string | undefined;
+            example?: string | undefined;
         }> | undefined;
         selectedServerUid?: (string & import("zod").BRAND<"server">) | undefined;
         documentUrl?: string | undefined;
@@ -81,9 +82,37 @@ export declare const createActiveEntitiesStore: ({ collections, requestExamples,
     } | undefined>;
     activeCookieId: import("vue").ComputedRef<string & import("zod").BRAND<"cookie">>;
     activeExample: import("vue").ComputedRef<{
-        type: "requestExample";
         uid: string & import("zod").BRAND<"example">;
         name: string;
+        type: "requestExample";
+        body: {
+            activeBody: "formData" | "binary" | "raw";
+            formData?: {
+                value: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | string[] | undefined;
+                    maximum?: number | undefined;
+                    description?: string | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    examples?: string[] | undefined;
+                    format?: string | undefined;
+                    enum?: string[] | undefined;
+                    file?: any;
+                    nullable?: boolean | undefined;
+                }[];
+                encoding: "form-data" | "urlencoded";
+            } | undefined;
+            binary?: Blob | undefined;
+            raw?: {
+                value: string;
+                encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
+                mimeType?: string | undefined;
+            } | undefined;
+        };
         parameters: {
             path: {
                 value: string;
@@ -92,99 +121,71 @@ export declare const createActiveEntitiesStore: ({ collections, requestExamples,
                 minimum?: number | undefined;
                 type?: string | string[] | undefined;
                 maximum?: number | undefined;
+                description?: string | undefined;
                 default?: any;
                 required?: boolean | undefined;
-                description?: string | undefined;
-                enum?: string[] | undefined;
                 examples?: string[] | undefined;
                 format?: string | undefined;
+                enum?: string[] | undefined;
                 file?: any;
                 nullable?: boolean | undefined;
             }[];
-            cookies: {
+            query: {
                 value: string;
                 key: string;
                 enabled: boolean;
                 minimum?: number | undefined;
                 type?: string | string[] | undefined;
                 maximum?: number | undefined;
+                description?: string | undefined;
                 default?: any;
                 required?: boolean | undefined;
-                description?: string | undefined;
-                enum?: string[] | undefined;
                 examples?: string[] | undefined;
                 format?: string | undefined;
+                enum?: string[] | undefined;
                 file?: any;
                 nullable?: boolean | undefined;
             }[];
-            query: {
+            headers: {
                 value: string;
                 key: string;
                 enabled: boolean;
                 minimum?: number | undefined;
                 type?: string | string[] | undefined;
                 maximum?: number | undefined;
+                description?: string | undefined;
                 default?: any;
                 required?: boolean | undefined;
-                description?: string | undefined;
-                enum?: string[] | undefined;
                 examples?: string[] | undefined;
                 format?: string | undefined;
+                enum?: string[] | undefined;
                 file?: any;
                 nullable?: boolean | undefined;
             }[];
-            headers: {
+            cookies: {
                 value: string;
                 key: string;
                 enabled: boolean;
                 minimum?: number | undefined;
                 type?: string | string[] | undefined;
                 maximum?: number | undefined;
+                description?: string | undefined;
                 default?: any;
                 required?: boolean | undefined;
-                description?: string | undefined;
-                enum?: string[] | undefined;
                 examples?: string[] | undefined;
                 format?: string | undefined;
+                enum?: string[] | undefined;
                 file?: any;
                 nullable?: boolean | undefined;
             }[];
         };
-        body: {
-            activeBody: "binary" | "formData" | "raw";
-            binary?: Blob | undefined;
-            formData?: {
-                value: {
-                    value: string;
-                    key: string;
-                    enabled: boolean;
-                    minimum?: number | undefined;
-                    type?: string | string[] | undefined;
-                    maximum?: number | undefined;
-                    default?: any;
-                    required?: boolean | undefined;
-                    description?: string | undefined;
-                    enum?: string[] | undefined;
-                    examples?: string[] | undefined;
-                    format?: string | undefined;
-                    file?: any;
-                    nullable?: boolean | undefined;
-                }[];
-                encoding: "form-data" | "urlencoded";
-            } | undefined;
-            raw?: {
-                value: string;
-                encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
-                mimeType?: string | undefined;
-            } | undefined;
-        };
         requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
         serverVariables?: Record<string, string[]> | undefined;
     } | undefined>;
     activeRequest: import("vue").ComputedRef<{
+        uid: string & import("zod").BRAND<"operation">;
         path: string;
         type: "request";
-        uid: string & import("zod").BRAND<"operation">;
         selectedSecuritySchemeUids: ((string & import("zod").BRAND<"securityScheme">) | (string & import("zod").BRAND<"securityScheme">)[])[];
         selectedServerUid: (string & import("zod").BRAND<"server">) | null;
         servers: (string & import("zod").BRAND<"server">)[];
@@ -203,12 +204,12 @@ export declare const createActiveEntitiesStore: ({ collections, requestExamples,
         deprecated?: boolean | undefined;
         operationId?: string | undefined;
         parameters?: {
-            required: boolean;
             name: string;
-            in: "path" | "cookie" | "query" | "header";
+            required: boolean;
+            in: "cookie" | "path" | "query" | "header";
             deprecated: boolean;
-            example?: unknown;
             description?: string | undefined;
+            example?: unknown;
             schema?: unknown;
             content?: unknown;
             style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
@@ -233,9 +234,9 @@ export declare const createActiveEntitiesStore: ({ collections, requestExamples,
         readonly settings: string;
     }>;
     activeEnvironment: import("vue").ComputedRef<{
-        value: string;
         uid: string & import("zod").BRAND<"environment">;
         name: string;
+        value: string;
         color: string;
         isDefault?: boolean | undefined;
     }>;
@@ -243,36 +244,38 @@ export declare const createActiveEntitiesStore: ({ collections, requestExamples,
         uid: string & import("zod").BRAND<"server">;
         url: string;
         description?: string | undefined;
-        variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
-            enum?: [string, ...string[]];
-            value?: string;
+        variables?: Record<string, {
+            value?: string | undefined;
+            description?: string | undefined;
+            default?: string | undefined;
+            enum?: string[] | undefined;
         }> | undefined;
     } | undefined>;
     activeWorkspace: import("vue").ComputedRef<{
         uid: string & import("zod").BRAND<"workspace">;
         name: string;
         description: string;
+        cookies: (string & import("zod").BRAND<"cookie">)[];
         collections: (string & import("zod").BRAND<"collection">)[];
         environments: Record<string, string>;
         activeEnvironmentId: string;
-        cookies: (string & import("zod").BRAND<"cookie">)[];
         themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
         selectedHttpClient: {
             targetKey: string;
             clientKey: string;
         };
         hotKeyConfig?: {
-            modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
-            hotKeys?: Partial<Record<"" | "/" | "0" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
+            modifiers: ("default" | "Meta" | "Control" | "Shift" | "Alt")[];
+            hotKeys?: Partial<Record<"" | "0" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "/" | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
                 event: "addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar";
-                modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
+                modifiers?: ("default" | "Meta" | "Control" | "Shift" | "Alt")[] | undefined;
             }>> | undefined;
         } | undefined;
         proxyUrl?: string | undefined;
     } | undefined>;
     activeWorkspaceCollections: import("vue").ComputedRef<{
-        type: "collection";
         uid: string & import("zod").BRAND<"collection">;
+        type: "collection";
         children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
         openapi: string;
         info: {
@@ -300,6 +303,7 @@ export declare const createActiveEntitiesStore: ({ collections, requestExamples,
         requests: (string & import("zod").BRAND<"operation">)[];
         tags: (string & import("zod").BRAND<"tag">)[];
         watchMode: boolean;
+        useCollectionSecurity: boolean;
         watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
         externalDocs?: {
             url: string;
@@ -314,12 +318,12 @@ export declare const createActiveEntitiesStore: ({ collections, requestExamples,
                 default: string;
                 description?: string | undefined;
             }>;
-            description?: string | undefined;
             color?: string | undefined;
+            description?: string | undefined;
         }> | undefined;
         'x-scalar-secrets'?: Record<string, {
-            example?: string | undefined;
             description?: string | undefined;
+            example?: string | undefined;
         }> | undefined;
         selectedServerUid?: (string & import("zod").BRAND<"server">) | undefined;
         documentUrl?: string | undefined;
@@ -329,9 +333,11 @@ export declare const createActiveEntitiesStore: ({ collections, requestExamples,
         uid: string & import("zod").BRAND<"server">;
         url: string;
         description?: string | undefined;
-        variables?: Record<string, Omit<import("@scalar/openapi-types").OpenAPIV3_1.ServerVariableObject, "enum"> & {
-            enum?: [string, ...string[]];
-            value?: string;
+        variables?: Record<string, {
+            value?: string | undefined;
+            description?: string | undefined;
+            default?: string | undefined;
+            enum?: string[] | undefined;
         }> | undefined;
     } | undefined)[]>;
     activeEnvVariables: import("vue").ComputedRef<EnvVariable[]>;

package/dist/store/active-entities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"active-entities.d.ts","sourceRoot":"","sources":["../../src/store/active-entities.ts"],"names":[],"mappings":"AAEA,OAAO,EAAqB,KAAK,WAAW,EAAE,MAAM,wCAAwC,CAAA;AAC5F,OAAO,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAA;AAClG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAA;AAErE,OAAO,EAAE,KAAK,YAAY,EAAoB,MAAM,KAAK,CAAA;AACzD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAGxC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mCAAmC,CAAA;AAE/D,KAAK,+BAA+B,GAAG;IACrC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IACvC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IACzC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAC/C,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IACrC,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,GAAG,CAAA;IACV,MAAM,EAAE,QAAQ,GAAG,YAAY,CAAA;CAChC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,6EAOnC,+BAA+B;;;;;;;;;uBA8Nk2Y,CAAC;mBAAqC,CAAC;0BAA4C,CAAC;mBAAqC,CAAC;oBAAoB,CAAC;mBAAqC,CAAC;qBAAuC,CAAC;;mBAA4D,CAAC;oBAAoB,CAAC;0BAAmD,CAAC;mBAAqC,CAAC;;;;;;;;;;;;;;uBAA2hB,CAAC;;;;;;;;;2BAAuY,CAAC;;uBAAqD,CAAC;iBAAmC,CAAC;;;mBAAmG,CAAC;uBAAyC,CAAC;;;;;;;;;;;;;;;;uBAAyvjB,CAAC;oBAAsC,CAAC;uBAAoD,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;2BAA8C,CAAC;oBAAsC,CAAC;wBAA4C,CAAC;sBAA0C,CAAC;oBAAsC,CAAC;wBAA2B,CAAC;;;;;;uBAA4J,CAAC;oBAAsC,CAAC;uBAAoD,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;2BAA8C,CAAC;oBAAsC,CAAC;wBAA4C,CAAC;sBAA0C,CAAC;oBAAsC,CAAC;wBAA2B,CAAC;;;;;;uBAA0J,CAAC;oBAAsC,CAAC;uBAAoD,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;2BAA8C,CAAC;oBAAsC,CAAC;wBAA4C,CAAC;sBAA0C,CAAC;oBAAsC,CAAC;wBAA2B,CAAC;;;;;;uBAA4J,CAAC;oBAAsC,CAAC;uBAAoD,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;2BAA8C,CAAC;oBAAsC,CAAC;wBAA4C,CAAC;sBAA0C,CAAC;oBAAsC,CAAC;wBAA2B,CAAC;;;;;kBAAwH,CAAC;oBAAoC,CAAC;;;;;2BAA8I,CAAC;wBAA0C,CAAC;2BAAwD,CAAC;2BAA6C,CAAC;4BAA+B,CAAC;+BAAkD,CAAC;wBAA0C,CAAC;4BAAgD,CAAC;0BAA8C,CAAC;wBAA0C,CAAC;4BAA+B,CAAC;;;;eAA4H,CAAC;;;wBAA2I,CAAC;;;;;;;;;;;;;;;;;;;uBAAjjkB,CAAC;;;;;;;;;;;;;mBAAsc,CAAC;uBAA8B,CAAC;kBAAoC,CAAC;mBAA0B,CAAC;iBAAwB,CAAC;oBAA0H,CAAC;qBAAgD,CAAC;uBAA8B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBApI72iB,CAAC;iBAAsC,CAAC;;;;;;;;;;;;;;;;;;mBAoI8gB,CAAC;;yBAAw5B,CAAC;;;;;;;;;;;;;uBAAk6V,CAAC;mBAAqC,CAAC;0BAA4C,CAAC;mBAAqC,CAAC;oBAAoB,CAAC;mBAAqC,CAAC;qBAAuC,CAAC;;mBAA4D,CAAC;oBAAoB,CAAC;0BAAmD,CAAC;mBAAqC,CAAC;;;;;;;;;;;;;;uBAA2hB,CAAC;;;;;;;;;2BAAuY,CAAC;;uBAAqD,CAAC;iBAAmC,CAAC;;;mBAAmG,CAAC;uBAAyC,CAAC;;;;;;;;;;;gBApIv4b,CAAC;iBAAsC,CAAC;;;;;CAgHzD,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,UAAU,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAC9E,eAAO,MAAM,sBAAsB,EAAe,YAAY,CAAC,mBAAmB,CAAC,CAAA;AAEnF;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,QAAO,mBAMpC,CAAA"}
+{"version":3,"file":"active-entities.d.ts","sourceRoot":"","sources":["../../src/store/active-entities.ts"],"names":[],"mappings":"AAEA,OAAO,EAAqB,KAAK,WAAW,EAAE,MAAM,wCAAwC,CAAA;AAC5F,OAAO,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAA;AAClG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAA;AAErE,OAAO,EAAE,KAAK,YAAY,EAAoB,MAAM,KAAK,CAAA;AACzD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAGxC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mCAAmC,CAAA;AAE/D,KAAK,+BAA+B,GAAG;IACrC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IACvC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IACzC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAC/C,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IACrC,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,GAAG,CAAA;IACV,MAAM,EAAE,QAAQ,GAAG,YAAY,CAAA;CAChC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,6EAOnC,+BAA+B;;;;;;;;;uBA8N61Z,CAAC;mBAAqC,CAAC;0BAA4C,CAAC;mBAAqC,CAAC;oBAAoB,CAAC;mBAAqC,CAAC;qBAAuC,CAAC;;mBAA4D,CAAC;oBAAoB,CAAC;0BAAmD,CAAC;mBAAqC,CAAC;;;;;;;;;;;;;;;uBAA+jB,CAAC;;;;;;;;;2BAAuY,CAAC;;iBAA+C,CAAC;uBAAyC,CAAC;;;uBAAuG,CAAC;mBAAqC,CAAC;;;;;;;;;;;;;oBAAkqiB,CAAC;;;;;2BAA8I,CAAC;wBAA0C,CAAC;2BAAwD,CAAC;+BAAiD,CAAC;2BAA6C,CAAC;4BAA+B,CAAC;4BAA+C,CAAC;0BAA8C,CAAC;wBAA0C,CAAC;wBAA4C,CAAC;4BAA+B,CAAC;;;;kBAA+H,CAAC;eAA+B,CAAC;;;wBAA2I,CAAC;;;;;;;;uBAA2L,CAAC;oBAAsC,CAAC;uBAAoD,CAAC;2BAA6C,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;wBAA2C,CAAC;sBAA0C,CAAC;oBAAsC,CAAC;oBAAwC,CAAC;wBAA2B,CAAC;;;;;;uBAA0J,CAAC;oBAAsC,CAAC;uBAAoD,CAAC;2BAA6C,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;wBAA2C,CAAC;sBAA0C,CAAC;oBAAsC,CAAC;oBAAwC,CAAC;wBAA2B,CAAC;;;;;;uBAA4J,CAAC;oBAAsC,CAAC;uBAAoD,CAAC;2BAA6C,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;wBAA2C,CAAC;sBAA0C,CAAC;oBAAsC,CAAC;oBAAwC,CAAC;wBAA2B,CAAC;;;;;;uBAA4J,CAAC;oBAAsC,CAAC;uBAAoD,CAAC;2BAA6C,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;wBAA2C,CAAC;sBAA0C,CAAC;oBAAsC,CAAC;oBAAwC,CAAC;wBAA2B,CAAC;;;;;;;;;;;;;;;;;;;uBAA1jkB,CAAC;;;;;;;;;;;;;uBAA0c,CAAC;mBAAqC,CAAC;kBAAyB,CAAC;mBAA0B,CAAC;iBAAwB,CAAC;oBAA0H,CAAC;qBAAgD,CAAC;uBAA8B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA/C52iB,CAAC;uBACH,CAAC;mBAGd,CAAA;gBAAkC,CAAC;;;;;;;;;;;;;;;;;;mBA2CiiB,CAAC;;yBAAw5B,CAAC;;;;;;;;;;;;;uBAA65W,CAAC;mBAAqC,CAAC;0BAA4C,CAAC;mBAAqC,CAAC;oBAAoB,CAAC;mBAAqC,CAAC;qBAAuC,CAAC;;mBAA4D,CAAC;oBAAoB,CAAC;0BAAmD,CAAC;mBAAqC,CAAC;;;;;;;;;;;;;;;uBAA+jB,CAAC;;;;;;;;;2BAAuY,CAAC;;iBAA+C,CAAC;uBAAyC,CAAC;;;uBAAuG,CAAC;mBAAqC,CAAC;;;;;;;;;;;iBA/Cr6c,CAAC;uBACH,CAAC;mBAGd,CAAA;gBAAkC,CAAC;;;;;CAuBtC,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,UAAU,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAC9E,eAAO,MAAM,sBAAsB,EAAe,YAAY,CAAC,mBAAmB,CAAC,CAAA;AAEnF;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,QAAO,mBAMpC,CAAA"}

package/dist/store/collections.d.ts

@@ -4,8 +4,8 @@ import type { Workspace } from '@scalar/oas-utils/entities/workspace';
 /** Initiate the workspace collections */
 export declare function createStoreCollections(useLocalStorage: boolean): {
     collections: Record<string, {
-        type: "collection";
         uid: string & import("zod").BRAND<"collection">;
+        type: "collection";
         children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
         openapi: string;
         info: {
@@ -33,6 +33,7 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
         requests: (string & import("zod").BRAND<"operation">)[];
         tags: (string & import("zod").BRAND<"tag">)[];
         watchMode: boolean;
+        useCollectionSecurity: boolean;
         watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
         externalDocs?: {
             url: string;
@@ -47,12 +48,12 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
                 default: string;
                 description?: string | undefined;
             }>;
-            description?: string | undefined;
             color?: string | undefined;
+            description?: string | undefined;
         }> | undefined;
         'x-scalar-secrets'?: Record<string, {
-            example?: string | undefined;
             description?: string | undefined;
+            example?: string | undefined;
         }> | undefined;
         selectedServerUid?: (string & import("zod").BRAND<"server">) | undefined;
         documentUrl?: string | undefined;
@@ -60,8 +61,8 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
     }>;
     collectionMutators: {
         add: (item: {
-            type: "collection";
             uid: string & import("zod").BRAND<"collection">;
+            type: "collection";
             children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
             openapi: string;
             info: {
@@ -89,6 +90,7 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
             requests: (string & import("zod").BRAND<"operation">)[];
             tags: (string & import("zod").BRAND<"tag">)[];
             watchMode: boolean;
+            useCollectionSecurity: boolean;
             watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
@@ -103,12 +105,12 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
                     default: string;
                     description?: string | undefined;
                 }>;
-                description?: string | undefined;
                 color?: string | undefined;
+                description?: string | undefined;
             }> | undefined;
             'x-scalar-secrets'?: Record<string, {
-                example?: string | undefined;
                 description?: string | undefined;
+                example?: string | undefined;
             }> | undefined;
             selectedServerUid?: (string & import("zod").BRAND<"server">) | undefined;
             documentUrl?: string | undefined;
@@ -116,8 +118,8 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
         }) => void;
         delete: (uid: (string & import("zod").BRAND<"collection">) | null | undefined) => void;
         set: (item: {
-            type: "collection";
             uid: string & import("zod").BRAND<"collection">;
+            type: "collection";
             children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
             openapi: string;
             info: {
@@ -145,6 +147,7 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
             requests: (string & import("zod").BRAND<"operation">)[];
             tags: (string & import("zod").BRAND<"tag">)[];
             watchMode: boolean;
+            useCollectionSecurity: boolean;
             watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
@@ -159,20 +162,20 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
                     default: string;
                     description?: string | undefined;
                 }>;
-                description?: string | undefined;
                 color?: string | undefined;
+                description?: string | undefined;
             }> | undefined;
             'x-scalar-secrets'?: Record<string, {
-                example?: string | undefined;
                 description?: string | undefined;
+                example?: string | undefined;
             }> | undefined;
             selectedServerUid?: (string & import("zod").BRAND<"server">) | undefined;
             documentUrl?: string | undefined;
             integration?: string | null | undefined;
         }) => void;
-        edit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: (string & import("zod").BRAND<"collection">) | null | undefined, path: P, value: P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? {
-            type: "collection";
+        edit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: (string & import("zod").BRAND<"collection">) | null | undefined, path: P, value: P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? {
             uid: string & import("zod").BRAND<"collection">;
+            type: "collection";
             children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
             openapi: string;
             info: {
@@ -200,6 +203,7 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
             requests: (string & import("zod").BRAND<"operation">)[];
             tags: (string & import("zod").BRAND<"tag">)[];
             watchMode: boolean;
+            useCollectionSecurity: boolean;
             watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
@@ -214,19 +218,19 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
                     default: string;
                     description?: string | undefined;
                 }>;
-                description?: string | undefined;
                 color?: string | undefined;
+                description?: string | undefined;
             }> | undefined;
             'x-scalar-secrets'?: Record<string, {
-                example?: string | undefined;
                 description?: string | undefined;
+                example?: string | undefined;
             }> | undefined;
             selectedServerUid?: (string & import("zod").BRAND<"server">) | undefined;
             documentUrl?: string | undefined;
             integration?: string | null | undefined;
-        }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
-            type: "collection";
+        }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
             uid: string & import("zod").BRAND<"collection">;
+            type: "collection";
             children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
             openapi: string;
             info: {
@@ -254,6 +258,7 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
             requests: (string & import("zod").BRAND<"operation">)[];
             tags: (string & import("zod").BRAND<"tag">)[];
             watchMode: boolean;
+            useCollectionSecurity: boolean;
             watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
@@ -268,19 +273,19 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
                     default: string;
                     description?: string | undefined;
                 }>;
-                description?: string | undefined;
                 color?: string | undefined;
+                description?: string | undefined;
             }> | undefined;
             'x-scalar-secrets'?: Record<string, {
-                example?: string | undefined;
                 description?: string | undefined;
+                example?: string | undefined;
             }> | undefined;
             selectedServerUid?: (string & import("zod").BRAND<"server">) | undefined;
             documentUrl?: string | undefined;
             integration?: string | null | undefined;
         }[K]> ? import("@scalar/object-utils/nested").PathValue<{
-            type: "collection";
             uid: string & import("zod").BRAND<"collection">;
+            type: "collection";
             children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
             openapi: string;
             info: {
@@ -308,6 +313,7 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
             requests: (string & import("zod").BRAND<"operation">)[];
             tags: (string & import("zod").BRAND<"tag">)[];
             watchMode: boolean;
+            useCollectionSecurity: boolean;
             watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
@@ -322,20 +328,20 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
                     default: string;
                     description?: string | undefined;
                 }>;
-                description?: string | undefined;
                 color?: string | undefined;
+                description?: string | undefined;
             }> | undefined;
             'x-scalar-secrets'?: Record<string, {
-                example?: string | undefined;
                 description?: string | undefined;
+                example?: string | undefined;
             }> | undefined;
             selectedServerUid?: (string & import("zod").BRAND<"server">) | undefined;
             documentUrl?: string | undefined;
             integration?: string | null | undefined;
         }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
-        untrackedEdit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string & import("zod").BRAND<"collection">, path: P, value: P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? {
-            type: "collection";
+        untrackedEdit: <P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string & import("zod").BRAND<"collection">, path: P, value: P extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? {
             uid: string & import("zod").BRAND<"collection">;
+            type: "collection";
             children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
             openapi: string;
             info: {
@@ -363,6 +369,7 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
             requests: (string & import("zod").BRAND<"operation">)[];
             tags: (string & import("zod").BRAND<"tag">)[];
             watchMode: boolean;
+            useCollectionSecurity: boolean;
             watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
@@ -377,19 +384,19 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
                     default: string;
                     description?: string | undefined;
                 }>;
-                description?: string | undefined;
                 color?: string | undefined;
+                description?: string | undefined;
             }> | undefined;
             'x-scalar-secrets'?: Record<string, {
-                example?: string | undefined;
                 description?: string | undefined;
+                example?: string | undefined;
             }> | undefined;
             selectedServerUid?: (string & import("zod").BRAND<"server">) | undefined;
             documentUrl?: string | undefined;
             integration?: string | null | undefined;
-        }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
-            type: "collection";
+        }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "servers" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
             uid: string & import("zod").BRAND<"collection">;
+            type: "collection";
             children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
             openapi: string;
             info: {
@@ -417,6 +424,7 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
             requests: (string & import("zod").BRAND<"operation">)[];
             tags: (string & import("zod").BRAND<"tag">)[];
             watchMode: boolean;
+            useCollectionSecurity: boolean;
             watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
@@ -431,19 +439,19 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
                     default: string;
                     description?: string | undefined;
                 }>;
-                description?: string | undefined;
                 color?: string | undefined;
+                description?: string | undefined;
             }> | undefined;
             'x-scalar-secrets'?: Record<string, {
-                example?: string | undefined;
                 description?: string | undefined;
+                example?: string | undefined;
             }> | undefined;
             selectedServerUid?: (string & import("zod").BRAND<"server">) | undefined;
             documentUrl?: string | undefined;
             integration?: string | null | undefined;
         }[K]> ? import("@scalar/object-utils/nested").PathValue<{
-            type: "collection";
             uid: string & import("zod").BRAND<"collection">;
+            type: "collection";
             children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
             openapi: string;
             info: {
@@ -471,6 +479,7 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
             requests: (string & import("zod").BRAND<"operation">)[];
             tags: (string & import("zod").BRAND<"tag">)[];
             watchMode: boolean;
+            useCollectionSecurity: boolean;
             watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
             externalDocs?: {
                 url: string;
@@ -485,12 +494,12 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
                     default: string;
                     description?: string | undefined;
                 }>;
-                description?: string | undefined;
                 color?: string | undefined;
+                description?: string | undefined;
             }> | undefined;
             'x-scalar-secrets'?: Record<string, {
-                example?: string | undefined;
                 description?: string | undefined;
+                example?: string | undefined;
             }> | undefined;
             selectedServerUid?: (string & import("zod").BRAND<"server">) | undefined;
             documentUrl?: string | undefined;
@@ -504,8 +513,8 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
 /** Extended mutators and data for collections that required workspace access */
 export declare function extendedCollectionDataFactory({ requests, requestMutators, requestExamples, requestExampleMutators, workspaces, workspaceMutators, collections, collectionMutators, tagMutators, serverMutators, }: StoreContext): {
     addCollection: (payload: CollectionPayload, workspaceUid: Workspace["uid"]) => {
-        type: "collection";
         uid: string & import("zod").BRAND<"collection">;
+        type: "collection";
         children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
         openapi: string;
         info: {
@@ -533,6 +542,7 @@ export declare function extendedCollectionDataFactory({ requests, requestMutator
         requests: (string & import("zod").BRAND<"operation">)[];
         tags: (string & import("zod").BRAND<"tag">)[];
         watchMode: boolean;
+        useCollectionSecurity: boolean;
         watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
         externalDocs?: {
             url: string;
@@ -547,12 +557,12 @@ export declare function extendedCollectionDataFactory({ requests, requestMutator
                 default: string;
                 description?: string | undefined;
             }>;
-            description?: string | undefined;
             color?: string | undefined;
+            description?: string | undefined;
         }> | undefined;
         'x-scalar-secrets'?: Record<string, {
-            example?: string | undefined;
             description?: string | undefined;
+            example?: string | undefined;
         }> | undefined;
         selectedServerUid?: (string & import("zod").BRAND<"server">) | undefined;
         documentUrl?: string | undefined;