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; 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 | 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 | 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 | undefined; }) => void; edit:

(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 | 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 | 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 | undefined; }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void; untrackedEdit:

(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 | 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 | 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 | 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 | undefined; }; deleteRequestExample: (requestExample: RequestExample) => void; }; //# sourceMappingURL=request-example.d.ts.map