@scalar/api-client 2.43.0 → 3.0.0

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

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