@sendbird/cli 0.0.0-stage → 0.3.0-alpha.1

package/dist/discovery.d.ts

@@ -0,0 +1,700 @@
+import type { Command } from "commander";
+import { type Definition } from "./catalog.js";
+import { CliError } from "./core.js";
+import { type OperationEffect } from "./presentation.js";
+export declare const introspectionNames: string[];
+export declare function commandNodes(root: Command): {
+    path: string;
+    command: Command;
+}[];
+export declare function definitionFor(path: string): Definition | undefined;
+export declare function transportFor(path: string): "local" | "sdk" | "dashboard";
+export declare function effectFor(path: string): "offline" | "read" | "mutation" | "sdk-read" | "stream" | "local/auth mutation";
+export declare function agentGuide(): {
+    protocol_version: number;
+    version: string;
+    entrypoint: string;
+    purpose: string;
+    first_rules: string[];
+    onboarding: {
+        skill: string;
+        guide: string;
+        purpose: string;
+        hosts: string[];
+    };
+    skill_registration: {
+        inspect: string[];
+        read_now: string[];
+        install: {
+            claude: string[];
+            codex: string[];
+        };
+        note: string;
+    };
+    value_meanings: string;
+    offline_discovery: string;
+    project_marker: {
+        file: string;
+        purpose: string;
+        inspect: string[];
+        create: string[];
+        first_step: string[];
+        precedence: string;
+    };
+    discovery: {
+        argv: string[];
+        purpose: string;
+    }[];
+    authentication: {
+        dashboard: {
+            credential: string;
+            check: string[];
+            login: string[];
+            note: string;
+        };
+        sdk: {
+            credential: string;
+            required: string[];
+            token_file: string[];
+            staging: string[];
+            note: string;
+        };
+    };
+    contract: {
+        stdout: string;
+        stderr: string;
+        input: string;
+        mutations: string;
+        retry: string;
+        context: string;
+        placeholders: string;
+    };
+    known_limits: string[];
+};
+export declare function compactCommands(root: Command, opts: {
+    search?: string;
+    transport?: string;
+    limit?: string;
+    offset?: string;
+}): Promise<{
+    next?: string[][] | undefined;
+    version: string;
+    total: number;
+    offset: number;
+    limit: number;
+    next_offset: number | null;
+    commands: {
+        match?: {
+            match_type: string;
+            matched_terms: string[];
+        } | undefined;
+        command: string;
+        description: string;
+        transport: string;
+        effect: string;
+        inspect: string[];
+    }[];
+}>;
+export declare function exampleArgv(d: Definition): {
+    note: string;
+    private_body_file?: Record<string, unknown> | undefined;
+    argv: string[];
+    shell: string;
+    input: {
+        command: string;
+        params: {
+            [x: string]: unknown;
+        };
+        query: {
+            [x: string]: unknown;
+        };
+        body: Record<string, unknown>;
+        context: {
+            "org-id"?: string | undefined;
+            "app-id": string;
+        } | {
+            "org-id": string;
+        } | {
+            "org-id"?: undefined;
+        };
+    };
+};
+export declare function describeCommand(root: Command, path: string): {
+    protocol_version: number;
+    version: string;
+    command: string;
+    description: string;
+    transport: string;
+    effect: string;
+    authentication: string;
+    required: string[];
+    flags: {
+        flag: string | undefined;
+        syntax: string;
+        description: string;
+        takes_value: boolean;
+    }[];
+    arguments: {
+        name: string;
+        required: boolean;
+        variadic: boolean;
+        description: string;
+    }[];
+    constraints: string[];
+    input: {
+        params: {
+            required: string[];
+        };
+        query: {
+            required: string[];
+        };
+        body: {
+            required: string[];
+        };
+    };
+    output: {
+        type: string;
+        required: string[];
+        properties: {
+            ok: {
+                const: boolean;
+            };
+            command: {
+                type: string;
+            };
+            effect: {
+                const: OperationEffect;
+            };
+            status: {
+                enum: string[];
+            };
+            target: {
+                type: string;
+                properties: {
+                    app_id: {
+                        type: string;
+                    };
+                    org_id: {
+                        type: string;
+                    };
+                    channel_url: {
+                        type: string;
+                    };
+                    channel_type: {
+                        enum: string[];
+                    };
+                    user_id: {
+                        type: string;
+                    };
+                    actor_user_id: {
+                        type: string;
+                    };
+                    message_id: {
+                        type: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            result: {
+                anyOf: Record<string, unknown>[];
+            };
+            response: {
+                enum: string[];
+            };
+        };
+        additionalProperties: boolean;
+    } | {
+        anyOf: ({
+            type: string;
+            required: string[];
+            properties: {
+                ok: {
+                    const: boolean;
+                };
+                command: {
+                    type: string;
+                };
+                effect: {
+                    const: OperationEffect;
+                };
+                status: {
+                    enum: string[];
+                };
+                target: {
+                    type: string;
+                    properties: {
+                        app_id: {
+                            type: string;
+                        };
+                        org_id: {
+                            type: string;
+                        };
+                        channel_url: {
+                            type: string;
+                        };
+                        channel_type: {
+                            enum: string[];
+                        };
+                        user_id: {
+                            type: string;
+                        };
+                        actor_user_id: {
+                            type: string;
+                        };
+                        message_id: {
+                            type: string;
+                        };
+                    };
+                    additionalProperties: boolean;
+                };
+                result: {
+                    anyOf: Record<string, unknown>[];
+                };
+                response: {
+                    enum: string[];
+                };
+            };
+            additionalProperties: boolean;
+        } | {
+            type: string;
+            required: string[];
+            properties: {
+                ok: {
+                    const: boolean;
+                };
+                type: {
+                    const: string;
+                };
+                command: {
+                    type: string;
+                };
+                event: {
+                    type: string;
+                    additionalProperties: boolean;
+                };
+            };
+            additionalProperties: boolean;
+        })[];
+    } | {
+        type: string;
+        required: string[];
+        properties: {
+            version: {
+                type: string;
+            };
+            query: {
+                type: string;
+            };
+            total: {
+                type: string;
+            };
+            offset: {
+                type: string;
+            };
+            limit: {
+                type: string;
+            };
+            next_offset: {
+                type: string[];
+            };
+            results: {
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+            id?: undefined;
+            title?: undefined;
+            source?: undefined;
+            source_url?: undefined;
+            sha256?: undefined;
+            content?: undefined;
+        };
+    } | {
+        type: string;
+        required: string[];
+        properties: {
+            version: {
+                type: string;
+            };
+            id: {
+                type: string;
+            };
+            title: {
+                type: string;
+            };
+            source: {
+                type: string;
+            };
+            source_url: {
+                type: string;
+            };
+            sha256: {
+                type: string;
+            };
+            content: {
+                type: string;
+                description: string;
+            };
+            query?: undefined;
+            total?: undefined;
+            offset?: undefined;
+            limit?: undefined;
+            next_offset?: undefined;
+            results?: undefined;
+        };
+    };
+    value_semantics: {
+        version: number;
+        path_root: string;
+        wildcard: string;
+        unknown_values: string;
+        input: string;
+        fields: ({
+            kind: "enum";
+            values: {
+                value: number;
+                name: string;
+                label: string;
+                description: string;
+            }[];
+            path: string;
+            vocabulary: "guest_user_policy" | "unread_badge" | "profanity_mode" | "domain_mode" | "image_mode" | "image_likelihood" | "profanity_action" | "character_cap" | "message_rate";
+        } | {
+            kind: "enum";
+            values: {
+                value: number;
+                name: string;
+                label: string;
+                description: string;
+            }[];
+            path: string;
+            vocabulary: "guest_user_policy" | "unread_badge" | "profanity_mode" | "domain_mode" | "image_mode" | "image_likelihood" | "profanity_action" | "character_cap" | "message_rate";
+        } | {
+            kind: "enum";
+            values: {
+                value: number;
+                name: string;
+                label: string;
+                description: string;
+            }[];
+            path: string;
+            vocabulary: "guest_user_policy" | "unread_badge" | "profanity_mode" | "domain_mode" | "image_mode" | "image_likelihood" | "profanity_action" | "character_cap" | "message_rate";
+        } | {
+            kind: "enum";
+            values: {
+                value: number;
+                name: string;
+                label: string;
+                description: string;
+            }[];
+            path: string;
+            vocabulary: "guest_user_policy" | "unread_badge" | "profanity_mode" | "domain_mode" | "image_mode" | "image_likelihood" | "profanity_action" | "character_cap" | "message_rate";
+        } | {
+            kind: "enum";
+            values: {
+                value: number;
+                name: string;
+                label: string;
+                description: string;
+            }[];
+            path: string;
+            vocabulary: "guest_user_policy" | "unread_badge" | "profanity_mode" | "domain_mode" | "image_mode" | "image_likelihood" | "profanity_action" | "character_cap" | "message_rate";
+        } | {
+            kind: "enum";
+            values: {
+                value: number;
+                name: string;
+                label: string;
+                description: string;
+            }[];
+            path: string;
+            vocabulary: "guest_user_policy" | "unread_badge" | "profanity_mode" | "domain_mode" | "image_mode" | "image_likelihood" | "profanity_action" | "character_cap" | "message_rate";
+        } | {
+            kind: "enum";
+            values: {
+                value: number;
+                name: string;
+                label: string;
+                description: string;
+            }[];
+            path: string;
+            vocabulary: "guest_user_policy" | "unread_badge" | "profanity_mode" | "domain_mode" | "image_mode" | "image_likelihood" | "profanity_action" | "character_cap" | "message_rate";
+        } | {
+            kind: "sentinel";
+            values: {
+                value: number;
+                name: string;
+                label: string;
+                description: string;
+            }[];
+            path: string;
+            vocabulary: "guest_user_policy" | "unread_badge" | "profanity_mode" | "domain_mode" | "image_mode" | "image_likelihood" | "profanity_action" | "character_cap" | "message_rate";
+        } | {
+            kind: "sentinel";
+            values: {
+                value: number;
+                name: string;
+                label: string;
+                description: string;
+            }[];
+            path: string;
+            vocabulary: "guest_user_policy" | "unread_badge" | "profanity_mode" | "domain_mode" | "image_mode" | "image_likelihood" | "profanity_action" | "character_cap" | "message_rate";
+        })[];
+    } | undefined;
+    result_schema: Record<string, unknown> | {
+        type: string;
+        required: string[];
+        properties: {
+            ok: {
+                const: boolean;
+            };
+            command: {
+                type: string;
+            };
+            effect: {
+                const: OperationEffect;
+            };
+            status: {
+                enum: string[];
+            };
+            target: {
+                type: string;
+                properties: {
+                    app_id: {
+                        type: string;
+                    };
+                    org_id: {
+                        type: string;
+                    };
+                    channel_url: {
+                        type: string;
+                    };
+                    channel_type: {
+                        enum: string[];
+                    };
+                    user_id: {
+                        type: string;
+                    };
+                    actor_user_id: {
+                        type: string;
+                    };
+                    message_id: {
+                        type: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            result: {
+                anyOf: Record<string, unknown>[];
+            };
+            response: {
+                enum: string[];
+            };
+        };
+        additionalProperties: boolean;
+    } | {
+        anyOf: ({
+            type: string;
+            required: string[];
+            properties: {
+                ok: {
+                    const: boolean;
+                };
+                command: {
+                    type: string;
+                };
+                effect: {
+                    const: OperationEffect;
+                };
+                status: {
+                    enum: string[];
+                };
+                target: {
+                    type: string;
+                    properties: {
+                        app_id: {
+                            type: string;
+                        };
+                        org_id: {
+                            type: string;
+                        };
+                        channel_url: {
+                            type: string;
+                        };
+                        channel_type: {
+                            enum: string[];
+                        };
+                        user_id: {
+                            type: string;
+                        };
+                        actor_user_id: {
+                            type: string;
+                        };
+                        message_id: {
+                            type: string;
+                        };
+                    };
+                    additionalProperties: boolean;
+                };
+                result: {
+                    anyOf: Record<string, unknown>[];
+                };
+                response: {
+                    enum: string[];
+                };
+            };
+            additionalProperties: boolean;
+        } | {
+            type: string;
+            required: string[];
+            properties: {
+                ok: {
+                    const: boolean;
+                };
+                type: {
+                    const: string;
+                };
+                command: {
+                    type: string;
+                };
+                event: {
+                    type: string;
+                    additionalProperties: boolean;
+                };
+            };
+            additionalProperties: boolean;
+        })[];
+    } | {
+        type: string;
+        required: string[];
+        properties: {
+            version: {
+                type: string;
+            };
+            query: {
+                type: string;
+            };
+            total: {
+                type: string;
+            };
+            offset: {
+                type: string;
+            };
+            limit: {
+                type: string;
+            };
+            next_offset: {
+                type: string[];
+            };
+            results: {
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+            id?: undefined;
+            title?: undefined;
+            source?: undefined;
+            source_url?: undefined;
+            sha256?: undefined;
+            content?: undefined;
+        };
+    } | {
+        type: string;
+        required: string[];
+        properties: {
+            version: {
+                type: string;
+            };
+            id: {
+                type: string;
+            };
+            title: {
+                type: string;
+            };
+            source: {
+                type: string;
+            };
+            source_url: {
+                type: string;
+            };
+            sha256: {
+                type: string;
+            };
+            content: {
+                type: string;
+                description: string;
+            };
+            query?: undefined;
+            total?: undefined;
+            offset?: undefined;
+            limit?: undefined;
+            next_offset?: undefined;
+            results?: undefined;
+        };
+    };
+    example: {
+        note: string;
+        private_body_file?: Record<string, unknown> | undefined;
+        argv: string[];
+        shell: string;
+        input: {
+            command: string;
+            params: {
+                [x: string]: unknown;
+            };
+            query: {
+                [x: string]: unknown;
+            };
+            body: Record<string, unknown>;
+            context: {
+                "org-id"?: string | undefined;
+                "app-id": string;
+            } | {
+                "org-id": string;
+            } | {
+                "org-id"?: undefined;
+            };
+        };
+    } | {
+        argv: string[];
+        shell: string;
+    } | {
+        shell: string;
+        argv?: undefined;
+    };
+    recovery: string[];
+};
+export declare function invocationCommand(root: Command, args: string[]): Command;
+export declare function commandPath(command: Command): string;
+export declare function recovery(error: CliError, command: Command, root: Command): {
+    next: {
+        argv: string[];
+        reason: string;
+    }[];
+    recovery?: {
+        rule: string;
+        strategy: "manual";
+        target: import("./recovery.js").RecoverySnapshot;
+        verification: "not_checked";
+        automatic_retry: false;
+        safe_to_retry: false;
+        reads: {
+            argv: string[];
+            reason: string;
+        }[];
+        compare_fields: string[];
+        note: string;
+        decisions: {
+            matching: string;
+            missing: string;
+            different: string;
+            unreadable: string;
+        };
+    } | undefined;
+    mutation_state?: import("./recovery.js").MutationState | undefined;
+    command: string | undefined;
+    automatic_retry: boolean;
+    outcome_unknown: boolean;
+};