fastclaw-cli 0.1.0

package/dist/sdk.d.ts

@@ -0,0 +1,312 @@
+interface ApiResponse<T = unknown> {
+    code: number;
+    message: string;
+    data?: T;
+}
+interface App {
+    id: string;
+    name: string;
+    url?: string;
+    description?: string;
+    owner_email?: string;
+    api_token: string;
+    bot_domain_template?: string;
+    status: "active" | "disabled";
+    created_at: string;
+    updated_at: string;
+}
+interface CreateAppRequest {
+    name: string;
+    url?: string;
+    description?: string;
+    owner_email?: string;
+    bot_domain_template?: string;
+}
+interface UpdateAppRequest {
+    name?: string;
+    url?: string;
+    description?: string;
+    owner_email?: string;
+    bot_domain_template?: string;
+    status?: "active" | "disabled";
+}
+type BotStatus = "created" | "running" | "stopped" | "error";
+interface Bot {
+    id: string;
+    app_id: string;
+    user_id: string;
+    name: string;
+    slug: string;
+    access_token: string;
+    status: BotStatus;
+    config?: Record<string, unknown>;
+    endpoint: string;
+    expires_at?: string;
+    created_at: string;
+    updated_at: string;
+    access_url?: string;
+    deployment_status?: {
+        status: "ready" | "updating" | "error";
+        ready_replicas: number;
+        desired_replicas: number;
+    };
+    image?: string;
+    latest_image?: string;
+    image_up_to_date?: boolean;
+}
+interface CreateBotRequest {
+    user_id: string;
+    name: string;
+    slug?: string;
+    config?: Record<string, unknown>;
+    expires_at?: string;
+}
+interface UpdateBotRequest {
+    name?: string;
+    slug?: string;
+    config?: Record<string, unknown>;
+    expires_at?: string;
+}
+interface BotStatusResponse {
+    id: string;
+    name: string;
+    status: BotStatus;
+    ready: boolean;
+    endpoint: string;
+}
+interface BotConnectResponse {
+    id: string;
+    name: string;
+    status: BotStatus;
+    ready: boolean;
+    token: string;
+    endpoint: string;
+    ws_url: string;
+    webchat_url: string;
+}
+interface ResetTokenResponse {
+    id: string;
+    access_token: string;
+    access_url: string;
+    message: string;
+}
+interface ProviderModel {
+    id: string;
+    name: string;
+    reasoning?: boolean;
+    input?: string[];
+    context_window?: number;
+    max_tokens?: number;
+}
+interface ModelProvider {
+    name: string;
+    baseUrl?: string;
+    apiKey?: string;
+    auth?: string;
+    api?: string;
+    models: ProviderModel[];
+}
+interface ModelDefaults {
+    primary_model?: string;
+    fallback_model?: string;
+    max_concurrent?: number;
+}
+interface AddChannelRequest {
+    channel: string;
+    account?: string;
+    botToken?: string;
+    token?: string;
+    appToken?: string;
+    appId?: string;
+    appSecret?: string;
+    appPassword?: string;
+    channelSecret?: string;
+    dmPolicy?: string;
+    groupPolicy?: string;
+    allowFrom?: string[];
+    enabled?: boolean;
+    extra?: Record<string, unknown>;
+}
+interface ChannelResponse {
+    message: string;
+    channel: string;
+    account?: string;
+}
+type ChannelsMap = Record<string, Record<string, Record<string, unknown>>>;
+interface PairingRequest {
+    code?: string;
+    user_id?: string;
+    channel?: string;
+    status?: string;
+}
+interface PairingApproveRequest {
+    code: string;
+}
+interface PairingRevokeRequest {
+    user_id: string;
+}
+interface PairedUsersResponse {
+    channel: string;
+    users: string[];
+}
+interface DeviceInfo {
+    request_id: string;
+    device_id: string;
+    role: string;
+    platform: string;
+    client_id: string;
+    client_mode: string;
+    ip: string;
+    age: string;
+    revoked: boolean;
+    connected: boolean;
+    status: "pending" | "paired" | "revoked";
+}
+interface DeviceListResponse {
+    bot_id: string;
+    devices: DeviceInfo[];
+}
+interface SkillInfo {
+    name: string;
+}
+interface SetSkillRequest {
+    content: string;
+}
+interface UpgradeRequest {
+    image?: string;
+}
+interface UpgradeResponse {
+    status: "upgraded" | "skipped";
+    image: string;
+    previous_image?: string;
+}
+interface BulkUpgradeResponse {
+    image: string;
+    total: number;
+    upgraded: number;
+    failed: number;
+    skipped: number;
+    results: Array<{
+        bot_id: string;
+        status: "upgraded" | "failed" | "skipped";
+        message: string;
+    }>;
+}
+
+interface ClientOptions {
+    url: string;
+    adminToken?: string;
+    appToken?: string;
+}
+declare class FastClawClient {
+    private baseUrl;
+    private adminToken?;
+    private appToken?;
+    constructor(opts: ClientOptions);
+    private request;
+    createApp(req: CreateAppRequest): Promise<App>;
+    listApps(): Promise<App[]>;
+    getApp(id: string): Promise<App>;
+    updateApp(id: string, req: UpdateAppRequest): Promise<App>;
+    deleteApp(id: string): Promise<{
+        message: string;
+    }>;
+    rotateAppToken(id: string): Promise<{
+        api_token: string;
+    }>;
+    upgradeBot(id: string, req?: UpgradeRequest): Promise<UpgradeResponse>;
+    upgradeAllBots(req?: UpgradeRequest): Promise<BulkUpgradeResponse>;
+    createBot(req: CreateBotRequest): Promise<Bot>;
+    listBots(userId: string): Promise<Bot[]>;
+    getBot(id: string): Promise<Bot>;
+    updateBot(id: string, req: UpdateBotRequest): Promise<Bot>;
+    deleteBot(id: string): Promise<{
+        message: string;
+    }>;
+    startBot(id: string): Promise<Bot>;
+    stopBot(id: string): Promise<Bot>;
+    restartBot(id: string): Promise<Bot>;
+    getBotStatus(id: string): Promise<BotStatusResponse>;
+    getBotConnect(id: string): Promise<BotConnectResponse>;
+    resetBotToken(id: string): Promise<ResetTokenResponse>;
+    listProviders(botId: string): Promise<Record<string, ModelProvider>>;
+    addProvider(botId: string, provider: ModelProvider): Promise<ModelProvider>;
+    getProvider(botId: string, name: string): Promise<ModelProvider>;
+    updateProvider(botId: string, name: string, provider: ModelProvider): Promise<ModelProvider>;
+    deleteProvider(botId: string, name: string): Promise<void>;
+    getDefaults(botId: string): Promise<ModelDefaults>;
+    setDefaults(botId: string, defaults: ModelDefaults): Promise<ModelDefaults>;
+    addChannel(botId: string, req: AddChannelRequest): Promise<ChannelResponse>;
+    listChannels(botId: string): Promise<ChannelsMap>;
+    removeChannel(botId: string, channel: string, account?: string): Promise<ChannelResponse>;
+    listPairing(botId: string, channel: string): Promise<unknown[]>;
+    approvePairing(botId: string, channel: string, req: PairingApproveRequest): Promise<unknown>;
+    revokePairing(botId: string, channel: string, req: PairingRevokeRequest): Promise<unknown>;
+    listPairedUsers(botId: string, channel: string): Promise<PairedUsersResponse>;
+    listDevices(botId: string, opts?: {
+        status?: string;
+        client_mode?: string;
+    }): Promise<DeviceListResponse>;
+    approveDevice(botId: string, requestId: string): Promise<unknown>;
+    revokeDevice(botId: string, deviceId: string, role?: string): Promise<unknown>;
+    listSkills(botId: string): Promise<SkillInfo[]>;
+    setSkill(botId: string, name: string, req: SetSkillRequest): Promise<unknown>;
+    deleteSkill(botId: string, name: string): Promise<unknown>;
+    waitForReady(botId: string, timeoutMs?: number, intervalMs?: number): Promise<BotStatusResponse>;
+    health(): Promise<boolean>;
+}
+
+interface FastClawConfig {
+    url?: string;
+    admin_token?: string;
+    app_token?: string;
+    default_user_id?: string;
+    default_bot_id?: string;
+}
+declare function loadConfig(): FastClawConfig;
+declare function saveConfig(config: FastClawConfig): void;
+declare function updateConfig(updates: Partial<FastClawConfig>): FastClawConfig;
+interface ResolvedConfig {
+    url: string;
+    adminToken?: string;
+    appToken?: string;
+    userId: string;
+    botId?: string;
+    json: boolean;
+}
+/**
+ * Resolve config with priority: CLI flags > env vars > config file > defaults.
+ * Used by CLI commands. SDK users construct FastClawClient directly.
+ */
+declare function resolveConfig(opts: {
+    url?: string;
+    adminToken?: string;
+    appToken?: string;
+    userId?: string;
+    botId?: string;
+    json?: boolean;
+}): ResolvedConfig;
+declare function getConfigPath(): string;
+
+declare const DEFAULT_URL = "https://claw.yesy.dev";
+declare const API_BASE = "/bot/api/v1";
+declare const MODEL_PRESETS: Record<string, Omit<ModelProvider, "apiKey">>;
+declare const PROVIDER_DEFAULTS: Record<string, string>;
+declare const CHANNEL_FIELDS: Record<string, {
+    required: string[];
+    optional: string[];
+}>;
+declare const DM_POLICIES: readonly ["open", "pairing", "allowlist", "disabled"];
+declare const GROUP_POLICIES: readonly ["open", "allowlist", "disabled"];
+
+declare class ApiError extends Error {
+    statusCode: number;
+    apiCode: number;
+    constructor(statusCode: number, apiCode: number, message: string);
+}
+
+declare function isValidSlug(slug: string): boolean;
+declare function isValidUrl(url: string): boolean;
+declare function slugify(name: string): string;
+
+export { API_BASE, type AddChannelRequest, ApiError, type ApiResponse, type App, type Bot, type BotConnectResponse, type BotStatus, type BotStatusResponse, type BulkUpgradeResponse, CHANNEL_FIELDS, type ChannelResponse, type ChannelsMap, type ClientOptions, type CreateAppRequest, type CreateBotRequest, DEFAULT_URL, DM_POLICIES, type DeviceInfo, type DeviceListResponse, FastClawClient, type FastClawConfig, GROUP_POLICIES, MODEL_PRESETS, type ModelDefaults, type ModelProvider, PROVIDER_DEFAULTS, type PairedUsersResponse, type PairingApproveRequest, type PairingRequest, type PairingRevokeRequest, type ProviderModel, type ResetTokenResponse, type ResolvedConfig, type SetSkillRequest, type SkillInfo, type UpdateAppRequest, type UpdateBotRequest, type UpgradeRequest, type UpgradeResponse, getConfigPath, isValidSlug, isValidUrl, loadConfig, resolveConfig, saveConfig, slugify, updateConfig };