@scalar/api-client 2.0.63 → 2.1.0

package/dist/store/collections.d.ts

@@ -0,0 +1,705 @@
+import type { StoreContext } from '../store/store-context';
+import { type Collection, type CollectionPayload } from '@scalar/oas-utils/entities/spec';
+import type { Workspace } from '@scalar/oas-utils/entities/workspace';
+/** Initiate the workspace collections */
+export declare function createStoreCollections(useLocalStorage: boolean): {
+    collections: Record<string, {
+        type: "collection";
+        uid: string;
+        children: string[];
+        openapi: string;
+        security: Record<string, string[]>[];
+        securitySchemes: string[];
+        selectedServerUid: string;
+        servers: string[];
+        requests: string[];
+        tags: string[];
+        auth: Record<string, {
+            type: "apiKey";
+            value: string;
+            name: string;
+        } | {
+            type: "http";
+            username: string;
+            password: string;
+            token: string;
+        } | {
+            type: "oauth-implicit";
+            token: string;
+        } | {
+            type: "oauth-password";
+            username: string;
+            password: string;
+            token: string;
+            clientSecret: string;
+        } | {
+            type: "oauth-clientCredentials";
+            token: string;
+            clientSecret: string;
+        } | {
+            type: "oauth-authorizationCode";
+            token: string;
+            clientSecret: string;
+        }>;
+        externalDocs?: {
+            url: string;
+            description?: string | undefined;
+        } | undefined;
+        jsonSchemaDialect?: string | undefined;
+        info?: {
+            title: string;
+            version: string;
+            description?: string | undefined;
+            summary?: string | undefined;
+            termsOfService?: string | undefined;
+            contact?: {
+                name?: string | undefined;
+                url?: string | undefined;
+                email?: string | undefined;
+            } | undefined;
+            license?: {
+                name: string;
+                identifier?: string | undefined;
+                url?: string | undefined;
+            } | undefined;
+        } | undefined;
+        components?: Record<string, unknown> | undefined;
+        webhooks?: Record<string, unknown> | undefined;
+    }>;
+    collectionMutators: {
+        add: (item: {
+            type: "collection";
+            uid: string;
+            children: string[];
+            openapi: string;
+            security: Record<string, string[]>[];
+            securitySchemes: string[];
+            selectedServerUid: string;
+            servers: string[];
+            requests: string[];
+            tags: string[];
+            auth: Record<string, {
+                type: "apiKey";
+                value: string;
+                name: string;
+            } | {
+                type: "http";
+                username: string;
+                password: string;
+                token: string;
+            } | {
+                type: "oauth-implicit";
+                token: string;
+            } | {
+                type: "oauth-password";
+                username: string;
+                password: string;
+                token: string;
+                clientSecret: string;
+            } | {
+                type: "oauth-clientCredentials";
+                token: string;
+                clientSecret: string;
+            } | {
+                type: "oauth-authorizationCode";
+                token: string;
+                clientSecret: string;
+            }>;
+            externalDocs?: {
+                url: string;
+                description?: string | undefined;
+            } | undefined;
+            jsonSchemaDialect?: string | undefined;
+            info?: {
+                title: string;
+                version: string;
+                description?: string | undefined;
+                summary?: string | undefined;
+                termsOfService?: string | undefined;
+                contact?: {
+                    name?: string | undefined;
+                    url?: string | undefined;
+                    email?: string | undefined;
+                } | undefined;
+                license?: {
+                    name: string;
+                    identifier?: string | undefined;
+                    url?: string | undefined;
+                } | undefined;
+            } | undefined;
+            components?: Record<string, unknown> | undefined;
+            webhooks?: Record<string, unknown> | undefined;
+        }) => void;
+        delete: (uid: string) => void;
+        set: (item: {
+            type: "collection";
+            uid: string;
+            children: string[];
+            openapi: string;
+            security: Record<string, string[]>[];
+            securitySchemes: string[];
+            selectedServerUid: string;
+            servers: string[];
+            requests: string[];
+            tags: string[];
+            auth: Record<string, {
+                type: "apiKey";
+                value: string;
+                name: string;
+            } | {
+                type: "http";
+                username: string;
+                password: string;
+                token: string;
+            } | {
+                type: "oauth-implicit";
+                token: string;
+            } | {
+                type: "oauth-password";
+                username: string;
+                password: string;
+                token: string;
+                clientSecret: string;
+            } | {
+                type: "oauth-clientCredentials";
+                token: string;
+                clientSecret: string;
+            } | {
+                type: "oauth-authorizationCode";
+                token: string;
+                clientSecret: string;
+            }>;
+            externalDocs?: {
+                url: string;
+                description?: string | undefined;
+            } | undefined;
+            jsonSchemaDialect?: string | undefined;
+            info?: {
+                title: string;
+                version: string;
+                description?: string | undefined;
+                summary?: string | undefined;
+                termsOfService?: string | undefined;
+                contact?: {
+                    name?: string | undefined;
+                    url?: string | undefined;
+                    email?: string | undefined;
+                } | undefined;
+                license?: {
+                    name: string;
+                    identifier?: string | undefined;
+                    url?: string | undefined;
+                } | undefined;
+            } | undefined;
+            components?: Record<string, unknown> | undefined;
+            webhooks?: Record<string, unknown> | undefined;
+        }) => void;
+        edit: <P extends "type" | "children" | "tags" | "requests" | "servers" | "securitySchemes" | "components" | "openapi" | "info" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "uid" | "selectedServerUid" | "auth" | `children.${number}` | `tags.${number}` | `requests.${number}` | `servers.${number}` | `securitySchemes.${number}` | `components.${string}` | "info.summary" | "info.title" | "info.description" | "info.termsOfService" | "info.contact" | "info.license" | "info.version" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `webhooks.${string}` | `auth.${string}`>(uid: string, path: P, value: P extends "type" | "children" | "tags" | "requests" | "servers" | "securitySchemes" | "components" | "openapi" | "info" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "uid" | "selectedServerUid" | "auth" ? {
+            type: "collection";
+            uid: string;
+            children: string[];
+            openapi: string;
+            security: Record<string, string[]>[];
+            securitySchemes: string[];
+            selectedServerUid: string;
+            servers: string[];
+            requests: string[];
+            tags: string[];
+            auth: Record<string, {
+                type: "apiKey";
+                value: string;
+                name: string;
+            } | {
+                type: "http";
+                username: string;
+                password: string;
+                token: string;
+            } | {
+                type: "oauth-implicit";
+                token: string;
+            } | {
+                type: "oauth-password";
+                username: string;
+                password: string;
+                token: string;
+                clientSecret: string;
+            } | {
+                type: "oauth-clientCredentials";
+                token: string;
+                clientSecret: string;
+            } | {
+                type: "oauth-authorizationCode";
+                token: string;
+                clientSecret: string;
+            }>;
+            externalDocs?: {
+                url: string;
+                description?: string | undefined;
+            } | undefined;
+            jsonSchemaDialect?: string | undefined;
+            info?: {
+                title: string;
+                version: string;
+                description?: string | undefined;
+                summary?: string | undefined;
+                termsOfService?: string | undefined;
+                contact?: {
+                    name?: string | undefined;
+                    url?: string | undefined;
+                    email?: string | undefined;
+                } | undefined;
+                license?: {
+                    name: string;
+                    identifier?: string | undefined;
+                    url?: string | undefined;
+                } | undefined;
+            } | undefined;
+            components?: Record<string, unknown> | undefined;
+            webhooks?: Record<string, unknown> | undefined;
+        }[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "children" | "tags" | "requests" | "servers" | "securitySchemes" | "components" | "openapi" | "info" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "uid" | "selectedServerUid" | "auth" ? R extends import("@scalar/object-utils/nested").Path<{
+            type: "collection";
+            uid: string;
+            children: string[];
+            openapi: string;
+            security: Record<string, string[]>[];
+            securitySchemes: string[];
+            selectedServerUid: string;
+            servers: string[];
+            requests: string[];
+            tags: string[];
+            auth: Record<string, {
+                type: "apiKey";
+                value: string;
+                name: string;
+            } | {
+                type: "http";
+                username: string;
+                password: string;
+                token: string;
+            } | {
+                type: "oauth-implicit";
+                token: string;
+            } | {
+                type: "oauth-password";
+                username: string;
+                password: string;
+                token: string;
+                clientSecret: string;
+            } | {
+                type: "oauth-clientCredentials";
+                token: string;
+                clientSecret: string;
+            } | {
+                type: "oauth-authorizationCode";
+                token: string;
+                clientSecret: string;
+            }>;
+            externalDocs?: {
+                url: string;
+                description?: string | undefined;
+            } | undefined;
+            jsonSchemaDialect?: string | undefined;
+            info?: {
+                title: string;
+                version: string;
+                description?: string | undefined;
+                summary?: string | undefined;
+                termsOfService?: string | undefined;
+                contact?: {
+                    name?: string | undefined;
+                    url?: string | undefined;
+                    email?: string | undefined;
+                } | undefined;
+                license?: {
+                    name: string;
+                    identifier?: string | undefined;
+                    url?: string | undefined;
+                } | undefined;
+            } | undefined;
+            components?: Record<string, unknown> | undefined;
+            webhooks?: Record<string, unknown> | undefined;
+        }[K]> ? import("@scalar/object-utils/nested").PathValue<{
+            type: "collection";
+            uid: string;
+            children: string[];
+            openapi: string;
+            security: Record<string, string[]>[];
+            securitySchemes: string[];
+            selectedServerUid: string;
+            servers: string[];
+            requests: string[];
+            tags: string[];
+            auth: Record<string, {
+                type: "apiKey";
+                value: string;
+                name: string;
+            } | {
+                type: "http";
+                username: string;
+                password: string;
+                token: string;
+            } | {
+                type: "oauth-implicit";
+                token: string;
+            } | {
+                type: "oauth-password";
+                username: string;
+                password: string;
+                token: string;
+                clientSecret: string;
+            } | {
+                type: "oauth-clientCredentials";
+                token: string;
+                clientSecret: string;
+            } | {
+                type: "oauth-authorizationCode";
+                token: string;
+                clientSecret: string;
+            }>;
+            externalDocs?: {
+                url: string;
+                description?: string | undefined;
+            } | undefined;
+            jsonSchemaDialect?: string | undefined;
+            info?: {
+                title: string;
+                version: string;
+                description?: string | undefined;
+                summary?: string | undefined;
+                termsOfService?: string | undefined;
+                contact?: {
+                    name?: string | undefined;
+                    url?: string | undefined;
+                    email?: string | undefined;
+                } | undefined;
+                license?: {
+                    name: string;
+                    identifier?: string | undefined;
+                    url?: string | undefined;
+                } | undefined;
+            } | undefined;
+            components?: Record<string, unknown> | undefined;
+            webhooks?: Record<string, unknown> | undefined;
+        }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
+        untrackedEdit: <P extends "type" | "children" | "tags" | "requests" | "servers" | "securitySchemes" | "components" | "openapi" | "info" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "uid" | "selectedServerUid" | "auth" | `children.${number}` | `tags.${number}` | `requests.${number}` | `servers.${number}` | `securitySchemes.${number}` | `components.${string}` | "info.summary" | "info.title" | "info.description" | "info.termsOfService" | "info.contact" | "info.license" | "info.version" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `webhooks.${string}` | `auth.${string}`>(uid: string, path: P, value: P extends "type" | "children" | "tags" | "requests" | "servers" | "securitySchemes" | "components" | "openapi" | "info" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "uid" | "selectedServerUid" | "auth" ? {
+            type: "collection";
+            uid: string;
+            children: string[];
+            openapi: string;
+            security: Record<string, string[]>[];
+            securitySchemes: string[];
+            selectedServerUid: string;
+            servers: string[];
+            requests: string[];
+            tags: string[];
+            auth: Record<string, {
+                type: "apiKey";
+                value: string;
+                name: string;
+            } | {
+                type: "http";
+                username: string;
+                password: string;
+                token: string;
+            } | {
+                type: "oauth-implicit";
+                token: string;
+            } | {
+                type: "oauth-password";
+                username: string;
+                password: string;
+                token: string;
+                clientSecret: string;
+            } | {
+                type: "oauth-clientCredentials";
+                token: string;
+                clientSecret: string;
+            } | {
+                type: "oauth-authorizationCode";
+                token: string;
+                clientSecret: string;
+            }>;
+            externalDocs?: {
+                url: string;
+                description?: string | undefined;
+            } | undefined;
+            jsonSchemaDialect?: string | undefined;
+            info?: {
+                title: string;
+                version: string;
+                description?: string | undefined;
+                summary?: string | undefined;
+                termsOfService?: string | undefined;
+                contact?: {
+                    name?: string | undefined;
+                    url?: string | undefined;
+                    email?: string | undefined;
+                } | undefined;
+                license?: {
+                    name: string;
+                    identifier?: string | undefined;
+                    url?: string | undefined;
+                } | undefined;
+            } | undefined;
+            components?: Record<string, unknown> | undefined;
+            webhooks?: Record<string, unknown> | undefined;
+        }[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "children" | "tags" | "requests" | "servers" | "securitySchemes" | "components" | "openapi" | "info" | "security" | "externalDocs" | "webhooks" | "jsonSchemaDialect" | "uid" | "selectedServerUid" | "auth" ? R extends import("@scalar/object-utils/nested").Path<{
+            type: "collection";
+            uid: string;
+            children: string[];
+            openapi: string;
+            security: Record<string, string[]>[];
+            securitySchemes: string[];
+            selectedServerUid: string;
+            servers: string[];
+            requests: string[];
+            tags: string[];
+            auth: Record<string, {
+                type: "apiKey";
+                value: string;
+                name: string;
+            } | {
+                type: "http";
+                username: string;
+                password: string;
+                token: string;
+            } | {
+                type: "oauth-implicit";
+                token: string;
+            } | {
+                type: "oauth-password";
+                username: string;
+                password: string;
+                token: string;
+                clientSecret: string;
+            } | {
+                type: "oauth-clientCredentials";
+                token: string;
+                clientSecret: string;
+            } | {
+                type: "oauth-authorizationCode";
+                token: string;
+                clientSecret: string;
+            }>;
+            externalDocs?: {
+                url: string;
+                description?: string | undefined;
+            } | undefined;
+            jsonSchemaDialect?: string | undefined;
+            info?: {
+                title: string;
+                version: string;
+                description?: string | undefined;
+                summary?: string | undefined;
+                termsOfService?: string | undefined;
+                contact?: {
+                    name?: string | undefined;
+                    url?: string | undefined;
+                    email?: string | undefined;
+                } | undefined;
+                license?: {
+                    name: string;
+                    identifier?: string | undefined;
+                    url?: string | undefined;
+                } | undefined;
+            } | undefined;
+            components?: Record<string, unknown> | undefined;
+            webhooks?: Record<string, unknown> | undefined;
+        }[K]> ? import("@scalar/object-utils/nested").PathValue<{
+            type: "collection";
+            uid: string;
+            children: string[];
+            openapi: string;
+            security: Record<string, string[]>[];
+            securitySchemes: string[];
+            selectedServerUid: string;
+            servers: string[];
+            requests: string[];
+            tags: string[];
+            auth: Record<string, {
+                type: "apiKey";
+                value: string;
+                name: string;
+            } | {
+                type: "http";
+                username: string;
+                password: string;
+                token: string;
+            } | {
+                type: "oauth-implicit";
+                token: string;
+            } | {
+                type: "oauth-password";
+                username: string;
+                password: string;
+                token: string;
+                clientSecret: string;
+            } | {
+                type: "oauth-clientCredentials";
+                token: string;
+                clientSecret: string;
+            } | {
+                type: "oauth-authorizationCode";
+                token: string;
+                clientSecret: string;
+            }>;
+            externalDocs?: {
+                url: string;
+                description?: string | undefined;
+            } | undefined;
+            jsonSchemaDialect?: string | undefined;
+            info?: {
+                title: string;
+                version: string;
+                description?: string | undefined;
+                summary?: string | undefined;
+                termsOfService?: string | undefined;
+                contact?: {
+                    name?: string | undefined;
+                    url?: string | undefined;
+                    email?: string | undefined;
+                } | undefined;
+                license?: {
+                    name: string;
+                    identifier?: string | undefined;
+                    url?: string | undefined;
+                } | undefined;
+            } | undefined;
+            components?: Record<string, unknown> | undefined;
+            webhooks?: Record<string, unknown> | 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: "collection";
+            uid: string;
+            children: string[];
+            openapi: string;
+            security: Record<string, string[]>[];
+            securitySchemes: string[];
+            selectedServerUid: string;
+            servers: string[];
+            requests: string[];
+            tags: string[];
+            auth: Record<string, {
+                type: "apiKey";
+                value: string;
+                name: string;
+            } | {
+                type: "http";
+                username: string;
+                password: string;
+                token: string;
+            } | {
+                type: "oauth-implicit";
+                token: string;
+            } | {
+                type: "oauth-password";
+                username: string;
+                password: string;
+                token: string;
+                clientSecret: string;
+            } | {
+                type: "oauth-clientCredentials";
+                token: string;
+                clientSecret: string;
+            } | {
+                type: "oauth-authorizationCode";
+                token: string;
+                clientSecret: string;
+            }>;
+            externalDocs?: {
+                url: string;
+                description?: string | undefined;
+            } | undefined;
+            jsonSchemaDialect?: string | undefined;
+            info?: {
+                title: string;
+                version: string;
+                description?: string | undefined;
+                summary?: string | undefined;
+                termsOfService?: string | undefined;
+                contact?: {
+                    name?: string | undefined;
+                    url?: string | undefined;
+                    email?: string | undefined;
+                } | undefined;
+                license?: {
+                    name: string;
+                    identifier?: string | undefined;
+                    url?: string | undefined;
+                } | undefined;
+            } | undefined;
+            components?: Record<string, unknown> | undefined;
+            webhooks?: Record<string, unknown> | undefined;
+        }[]) => void;
+    };
+};
+/** Extended mutators and data for collections that required workspace access */
+export declare function extendedCollectionDataFactory({ requests, requestMutators, requestExamples, requestExampleMutators, workspaces, workspaceMutators, collections, collectionMutators, tagMutators, }: StoreContext): {
+    addCollection: (payload: CollectionPayload, workspaceUid: string) => {
+        type: "collection";
+        uid: string;
+        children: string[];
+        openapi: string;
+        security: Record<string, string[]>[];
+        securitySchemes: string[];
+        selectedServerUid: string;
+        servers: string[];
+        requests: string[];
+        tags: string[];
+        auth: Record<string, {
+            type: "apiKey";
+            value: string;
+            name: string;
+        } | {
+            type: "http";
+            username: string;
+            password: string;
+            token: string;
+        } | {
+            type: "oauth-implicit";
+            token: string;
+        } | {
+            type: "oauth-password";
+            username: string;
+            password: string;
+            token: string;
+            clientSecret: string;
+        } | {
+            type: "oauth-clientCredentials";
+            token: string;
+            clientSecret: string;
+        } | {
+            type: "oauth-authorizationCode";
+            token: string;
+            clientSecret: string;
+        }>;
+        externalDocs?: {
+            url: string;
+            description?: string | undefined;
+        } | undefined;
+        jsonSchemaDialect?: string | undefined;
+        info?: {
+            title: string;
+            version: string;
+            description?: string | undefined;
+            summary?: string | undefined;
+            termsOfService?: string | undefined;
+            contact?: {
+                name?: string | undefined;
+                url?: string | undefined;
+                email?: string | undefined;
+            } | undefined;
+            license?: {
+                name: string;
+                identifier?: string | undefined;
+                url?: string | undefined;
+            } | undefined;
+        } | undefined;
+        components?: Record<string, unknown> | undefined;
+        webhooks?: Record<string, unknown> | undefined;
+    };
+    deleteCollection: (collection: Collection, workspace: Workspace) => void;
+};
+//# sourceMappingURL=collections.d.ts.map