@scalar/api-client 2.0.64 → 2.1.1

package/dist/store/request-example.d.ts

@@ -0,0 +1,1111 @@
+import type { StoreContext } from '../store/store-context';
+import { type Request, type RequestExample } from '@scalar/oas-utils/entities/spec';
+/** Create top level examples storage for the workspace */
+export declare function createStoreRequestExamples(useLocalStorage: boolean): {
+    requestExamples: Record<string, {
+        type: "requestExample";
+        uid: string;
+        name: string;
+        body: {
+            activeBody: "formData" | "raw" | "binary";
+            formData?: {
+                value: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                encoding: "form-data" | "urlencoded";
+            } | undefined;
+            raw?: {
+                value: string;
+                encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
+            } | undefined;
+            binary?: Blob | undefined;
+        };
+        requestUid: string;
+        parameters: {
+            path: {
+                value: string;
+                key: string;
+                enabled: boolean;
+                minimum?: number | undefined;
+                type?: string | undefined;
+                maximum?: number | undefined;
+                default?: any;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                enum?: string[] | undefined;
+                format?: string | undefined;
+                file?: any;
+                refUid?: string | undefined;
+                nullable?: boolean | undefined;
+            }[];
+            cookies: {
+                value: string;
+                key: string;
+                enabled: boolean;
+                minimum?: number | undefined;
+                type?: string | undefined;
+                maximum?: number | undefined;
+                default?: any;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                enum?: string[] | undefined;
+                format?: string | undefined;
+                file?: any;
+                refUid?: string | undefined;
+                nullable?: boolean | undefined;
+            }[];
+            query: {
+                value: string;
+                key: string;
+                enabled: boolean;
+                minimum?: number | undefined;
+                type?: string | undefined;
+                maximum?: number | undefined;
+                default?: any;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                enum?: string[] | undefined;
+                format?: string | undefined;
+                file?: any;
+                refUid?: string | undefined;
+                nullable?: boolean | undefined;
+            }[];
+            headers: {
+                value: string;
+                key: string;
+                enabled: boolean;
+                minimum?: number | undefined;
+                type?: string | undefined;
+                maximum?: number | undefined;
+                default?: any;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                enum?: string[] | undefined;
+                format?: string | undefined;
+                file?: any;
+                refUid?: string | undefined;
+                nullable?: boolean | undefined;
+            }[];
+        };
+        serverVariables?: Record<string, string[]> | undefined;
+    }>;
+    requestExampleMutators: {
+        add: (item: {
+            type: "requestExample";
+            uid: string;
+            name: string;
+            body: {
+                activeBody: "formData" | "raw" | "binary";
+                formData?: {
+                    value: {
+                        value: string;
+                        key: string;
+                        enabled: boolean;
+                        minimum?: number | undefined;
+                        type?: string | undefined;
+                        maximum?: number | undefined;
+                        default?: any;
+                        required?: boolean | undefined;
+                        description?: string | undefined;
+                        enum?: string[] | undefined;
+                        format?: string | undefined;
+                        file?: any;
+                        refUid?: string | undefined;
+                        nullable?: boolean | undefined;
+                    }[];
+                    encoding: "form-data" | "urlencoded";
+                } | undefined;
+                raw?: {
+                    value: string;
+                    encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
+                } | undefined;
+                binary?: Blob | undefined;
+            };
+            requestUid: string;
+            parameters: {
+                path: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                cookies: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                query: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                headers: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+            };
+            serverVariables?: Record<string, string[]> | undefined;
+        }) => void;
+        delete: (uid: string) => void;
+        set: (item: {
+            type: "requestExample";
+            uid: string;
+            name: string;
+            body: {
+                activeBody: "formData" | "raw" | "binary";
+                formData?: {
+                    value: {
+                        value: string;
+                        key: string;
+                        enabled: boolean;
+                        minimum?: number | undefined;
+                        type?: string | undefined;
+                        maximum?: number | undefined;
+                        default?: any;
+                        required?: boolean | undefined;
+                        description?: string | undefined;
+                        enum?: string[] | undefined;
+                        format?: string | undefined;
+                        file?: any;
+                        refUid?: string | undefined;
+                        nullable?: boolean | undefined;
+                    }[];
+                    encoding: "form-data" | "urlencoded";
+                } | undefined;
+                raw?: {
+                    value: string;
+                    encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
+                } | undefined;
+                binary?: Blob | undefined;
+            };
+            requestUid: string;
+            parameters: {
+                path: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                cookies: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                query: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                headers: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+            };
+            serverVariables?: Record<string, string[]> | undefined;
+        }) => void;
+        edit: <P extends "body" | "type" | "name" | "uid" | "parameters" | "requestUid" | "serverVariables" | "body.binary" | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.type` | `body.formData.value.${number}.description` | `body.formData.value.${number}.value` | `body.formData.value.${number}.required` | `body.formData.value.${number}.file` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.format` | `body.formData.value.${number}.refUid` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | "body.binary.slice" | "body.binary.text" | "body.binary.type" | "body.binary.size" | "body.binary.arrayBuffer" | "body.binary.stream" | "parameters.cookies" | "parameters.path" | "parameters.query" | "parameters.headers" | `parameters.cookies.${number}` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.refUid` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.type` | `parameters.path.${number}.description` | `parameters.path.${number}.value` | `parameters.path.${number}.required` | `parameters.path.${number}.file` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.format` | `parameters.path.${number}.refUid` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.type` | `parameters.query.${number}.description` | `parameters.query.${number}.value` | `parameters.query.${number}.required` | `parameters.query.${number}.file` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.format` | `parameters.query.${number}.refUid` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.type` | `parameters.headers.${number}.description` | `parameters.headers.${number}.value` | `parameters.headers.${number}.required` | `parameters.headers.${number}.file` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.format` | `parameters.headers.${number}.refUid` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `serverVariables.${string}`>(uid: string, path: P, value: P extends "body" | "type" | "name" | "uid" | "parameters" | "requestUid" | "serverVariables" ? {
+            type: "requestExample";
+            uid: string;
+            name: string;
+            body: {
+                activeBody: "formData" | "raw" | "binary";
+                formData?: {
+                    value: {
+                        value: string;
+                        key: string;
+                        enabled: boolean;
+                        minimum?: number | undefined;
+                        type?: string | undefined;
+                        maximum?: number | undefined;
+                        default?: any;
+                        required?: boolean | undefined;
+                        description?: string | undefined;
+                        enum?: string[] | undefined;
+                        format?: string | undefined;
+                        file?: any;
+                        refUid?: string | undefined;
+                        nullable?: boolean | undefined;
+                    }[];
+                    encoding: "form-data" | "urlencoded";
+                } | undefined;
+                raw?: {
+                    value: string;
+                    encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
+                } | undefined;
+                binary?: Blob | undefined;
+            };
+            requestUid: string;
+            parameters: {
+                path: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                cookies: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                query: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                headers: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+            };
+            serverVariables?: Record<string, string[]> | undefined;
+        }[P] : P extends `${infer K}.${infer R}` ? K extends "body" | "type" | "name" | "uid" | "parameters" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
+            type: "requestExample";
+            uid: string;
+            name: string;
+            body: {
+                activeBody: "formData" | "raw" | "binary";
+                formData?: {
+                    value: {
+                        value: string;
+                        key: string;
+                        enabled: boolean;
+                        minimum?: number | undefined;
+                        type?: string | undefined;
+                        maximum?: number | undefined;
+                        default?: any;
+                        required?: boolean | undefined;
+                        description?: string | undefined;
+                        enum?: string[] | undefined;
+                        format?: string | undefined;
+                        file?: any;
+                        refUid?: string | undefined;
+                        nullable?: boolean | undefined;
+                    }[];
+                    encoding: "form-data" | "urlencoded";
+                } | undefined;
+                raw?: {
+                    value: string;
+                    encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
+                } | undefined;
+                binary?: Blob | undefined;
+            };
+            requestUid: string;
+            parameters: {
+                path: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                cookies: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                query: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                headers: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+            };
+            serverVariables?: Record<string, string[]> | undefined;
+        }[K]> ? import("@scalar/object-utils/nested").PathValue<{
+            type: "requestExample";
+            uid: string;
+            name: string;
+            body: {
+                activeBody: "formData" | "raw" | "binary";
+                formData?: {
+                    value: {
+                        value: string;
+                        key: string;
+                        enabled: boolean;
+                        minimum?: number | undefined;
+                        type?: string | undefined;
+                        maximum?: number | undefined;
+                        default?: any;
+                        required?: boolean | undefined;
+                        description?: string | undefined;
+                        enum?: string[] | undefined;
+                        format?: string | undefined;
+                        file?: any;
+                        refUid?: string | undefined;
+                        nullable?: boolean | undefined;
+                    }[];
+                    encoding: "form-data" | "urlencoded";
+                } | undefined;
+                raw?: {
+                    value: string;
+                    encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
+                } | undefined;
+                binary?: Blob | undefined;
+            };
+            requestUid: string;
+            parameters: {
+                path: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                cookies: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                query: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                headers: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+            };
+            serverVariables?: Record<string, string[]> | undefined;
+        }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
+        untrackedEdit: <P extends "body" | "type" | "name" | "uid" | "parameters" | "requestUid" | "serverVariables" | "body.binary" | "body.raw" | "body.formData" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.type` | `body.formData.value.${number}.description` | `body.formData.value.${number}.value` | `body.formData.value.${number}.required` | `body.formData.value.${number}.file` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.format` | `body.formData.value.${number}.refUid` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | `body.formData.value.${number}.enum.${number}` | "body.binary.slice" | "body.binary.text" | "body.binary.type" | "body.binary.size" | "body.binary.arrayBuffer" | "body.binary.stream" | "parameters.cookies" | "parameters.path" | "parameters.query" | "parameters.headers" | `parameters.cookies.${number}` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.refUid` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.type` | `parameters.path.${number}.description` | `parameters.path.${number}.value` | `parameters.path.${number}.required` | `parameters.path.${number}.file` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.format` | `parameters.path.${number}.refUid` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.type` | `parameters.query.${number}.description` | `parameters.query.${number}.value` | `parameters.query.${number}.required` | `parameters.query.${number}.file` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.format` | `parameters.query.${number}.refUid` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.query.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.type` | `parameters.headers.${number}.description` | `parameters.headers.${number}.value` | `parameters.headers.${number}.required` | `parameters.headers.${number}.file` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.format` | `parameters.headers.${number}.refUid` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.headers.${number}.enum.${number}` | `serverVariables.${string}`>(uid: string, path: P, value: P extends "body" | "type" | "name" | "uid" | "parameters" | "requestUid" | "serverVariables" ? {
+            type: "requestExample";
+            uid: string;
+            name: string;
+            body: {
+                activeBody: "formData" | "raw" | "binary";
+                formData?: {
+                    value: {
+                        value: string;
+                        key: string;
+                        enabled: boolean;
+                        minimum?: number | undefined;
+                        type?: string | undefined;
+                        maximum?: number | undefined;
+                        default?: any;
+                        required?: boolean | undefined;
+                        description?: string | undefined;
+                        enum?: string[] | undefined;
+                        format?: string | undefined;
+                        file?: any;
+                        refUid?: string | undefined;
+                        nullable?: boolean | undefined;
+                    }[];
+                    encoding: "form-data" | "urlencoded";
+                } | undefined;
+                raw?: {
+                    value: string;
+                    encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
+                } | undefined;
+                binary?: Blob | undefined;
+            };
+            requestUid: string;
+            parameters: {
+                path: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                cookies: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                query: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                headers: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+            };
+            serverVariables?: Record<string, string[]> | undefined;
+        }[P] : P extends `${infer K}.${infer R}` ? K extends "body" | "type" | "name" | "uid" | "parameters" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
+            type: "requestExample";
+            uid: string;
+            name: string;
+            body: {
+                activeBody: "formData" | "raw" | "binary";
+                formData?: {
+                    value: {
+                        value: string;
+                        key: string;
+                        enabled: boolean;
+                        minimum?: number | undefined;
+                        type?: string | undefined;
+                        maximum?: number | undefined;
+                        default?: any;
+                        required?: boolean | undefined;
+                        description?: string | undefined;
+                        enum?: string[] | undefined;
+                        format?: string | undefined;
+                        file?: any;
+                        refUid?: string | undefined;
+                        nullable?: boolean | undefined;
+                    }[];
+                    encoding: "form-data" | "urlencoded";
+                } | undefined;
+                raw?: {
+                    value: string;
+                    encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
+                } | undefined;
+                binary?: Blob | undefined;
+            };
+            requestUid: string;
+            parameters: {
+                path: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                cookies: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                query: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                headers: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+            };
+            serverVariables?: Record<string, string[]> | undefined;
+        }[K]> ? import("@scalar/object-utils/nested").PathValue<{
+            type: "requestExample";
+            uid: string;
+            name: string;
+            body: {
+                activeBody: "formData" | "raw" | "binary";
+                formData?: {
+                    value: {
+                        value: string;
+                        key: string;
+                        enabled: boolean;
+                        minimum?: number | undefined;
+                        type?: string | undefined;
+                        maximum?: number | undefined;
+                        default?: any;
+                        required?: boolean | undefined;
+                        description?: string | undefined;
+                        enum?: string[] | undefined;
+                        format?: string | undefined;
+                        file?: any;
+                        refUid?: string | undefined;
+                        nullable?: boolean | undefined;
+                    }[];
+                    encoding: "form-data" | "urlencoded";
+                } | undefined;
+                raw?: {
+                    value: string;
+                    encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
+                } | undefined;
+                binary?: Blob | undefined;
+            };
+            requestUid: string;
+            parameters: {
+                path: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                cookies: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                query: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                headers: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+            };
+            serverVariables?: Record<string, string[]> | undefined;
+        }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
+        undo: (uid: string) => void;
+        redo: (uid: string) => void;
+        loadLocalStorage: (instances: {
+            type: "requestExample";
+            uid: string;
+            name: string;
+            body: {
+                activeBody: "formData" | "raw" | "binary";
+                formData?: {
+                    value: {
+                        value: string;
+                        key: string;
+                        enabled: boolean;
+                        minimum?: number | undefined;
+                        type?: string | undefined;
+                        maximum?: number | undefined;
+                        default?: any;
+                        required?: boolean | undefined;
+                        description?: string | undefined;
+                        enum?: string[] | undefined;
+                        format?: string | undefined;
+                        file?: any;
+                        refUid?: string | undefined;
+                        nullable?: boolean | undefined;
+                    }[];
+                    encoding: "form-data" | "urlencoded";
+                } | undefined;
+                raw?: {
+                    value: string;
+                    encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
+                } | undefined;
+                binary?: Blob | undefined;
+            };
+            requestUid: string;
+            parameters: {
+                path: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                cookies: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                query: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                headers: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+            };
+            serverVariables?: Record<string, string[]> | undefined;
+        }[]) => void;
+    };
+};
+/** Extended example data that needs store context */
+export declare function extendedExampleDataFactory({ requestExamples, requestExampleMutators, requestMutators, requests, }: StoreContext): {
+    addRequestExample: (request: Request, _name?: string) => {
+        type: "requestExample";
+        uid: string;
+        name: string;
+        body: {
+            activeBody: "formData" | "raw" | "binary";
+            formData?: {
+                value: {
+                    value: string;
+                    key: string;
+                    enabled: boolean;
+                    minimum?: number | undefined;
+                    type?: string | undefined;
+                    maximum?: number | undefined;
+                    default?: any;
+                    required?: boolean | undefined;
+                    description?: string | undefined;
+                    enum?: string[] | undefined;
+                    format?: string | undefined;
+                    file?: any;
+                    refUid?: string | undefined;
+                    nullable?: boolean | undefined;
+                }[];
+                encoding: "form-data" | "urlencoded";
+            } | undefined;
+            raw?: {
+                value: string;
+                encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
+            } | undefined;
+            binary?: Blob | undefined;
+        };
+        requestUid: string;
+        parameters: {
+            path: {
+                value: string;
+                key: string;
+                enabled: boolean;
+                minimum?: number | undefined;
+                type?: string | undefined;
+                maximum?: number | undefined;
+                default?: any;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                enum?: string[] | undefined;
+                format?: string | undefined;
+                file?: any;
+                refUid?: string | undefined;
+                nullable?: boolean | undefined;
+            }[];
+            cookies: {
+                value: string;
+                key: string;
+                enabled: boolean;
+                minimum?: number | undefined;
+                type?: string | undefined;
+                maximum?: number | undefined;
+                default?: any;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                enum?: string[] | undefined;
+                format?: string | undefined;
+                file?: any;
+                refUid?: string | undefined;
+                nullable?: boolean | undefined;
+            }[];
+            query: {
+                value: string;
+                key: string;
+                enabled: boolean;
+                minimum?: number | undefined;
+                type?: string | undefined;
+                maximum?: number | undefined;
+                default?: any;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                enum?: string[] | undefined;
+                format?: string | undefined;
+                file?: any;
+                refUid?: string | undefined;
+                nullable?: boolean | undefined;
+            }[];
+            headers: {
+                value: string;
+                key: string;
+                enabled: boolean;
+                minimum?: number | undefined;
+                type?: string | undefined;
+                maximum?: number | undefined;
+                default?: any;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                enum?: string[] | undefined;
+                format?: string | undefined;
+                file?: any;
+                refUid?: string | undefined;
+                nullable?: boolean | undefined;
+            }[];
+        };
+        serverVariables?: Record<string, string[]> | undefined;
+    };
+    deleteRequestExample: (requestExample: RequestExample) => void;
+};
+//# sourceMappingURL=request-example.d.ts.map