@cubos/agent-sdk 0.0.1136563

package/dist/admin/ai-providers.d.ts

@@ -0,0 +1,122 @@
+import type { Transport } from "../http.js";
+import type { Schemas } from "../schemas.js";
+export declare function aiProvidersApi(t: Transport, tenantSlug: string): {
+    /** Includes providers shared by the `_root` tenant, flagged `shared: true`. */
+    list: (signal?: AbortSignal) => Promise<{
+        account_id: string | null;
+        base_url: string | null;
+        created_at: string;
+        has_api_key: boolean;
+        id: string;
+        last_reconcile_error: string | null;
+        last_reconciled_at: string | null;
+        model_count: number;
+        shared: boolean;
+        slug: string;
+        token_sku_directions: {
+            [key: string]: import("../generated/schema.js").components["schemas"]["SkuDirection"];
+        };
+        type: import("../generated/schema.js").components["schemas"]["ProviderType"];
+    }[]>;
+    get: (slug: string, signal?: AbortSignal) => Promise<{
+        account_id: string | null;
+        base_url: string | null;
+        created_at: string;
+        has_api_key: boolean;
+        id: string;
+        last_reconcile_error: string | null;
+        last_reconciled_at: string | null;
+        model_count: number;
+        shared: boolean;
+        slug: string;
+        token_sku_directions: {
+            [key: string]: import("../generated/schema.js").components["schemas"]["SkuDirection"];
+        };
+        type: import("../generated/schema.js").components["schemas"]["ProviderType"];
+    }>;
+    create: (input: Schemas["CreateAiProviderInput"]) => Promise<{
+        account_id: string | null;
+        base_url: string | null;
+        created_at: string;
+        has_api_key: boolean;
+        id: string;
+        last_reconcile_error: string | null;
+        last_reconciled_at: string | null;
+        model_count: number;
+        shared: boolean;
+        slug: string;
+        token_sku_directions: {
+            [key: string]: import("../generated/schema.js").components["schemas"]["SkuDirection"];
+        };
+        type: import("../generated/schema.js").components["schemas"]["ProviderType"];
+    }>;
+    update: (currentSlug: string, input: Schemas["UpdateAiProviderInput"]) => Promise<{
+        account_id: string | null;
+        base_url: string | null;
+        created_at: string;
+        has_api_key: boolean;
+        id: string;
+        last_reconcile_error: string | null;
+        last_reconciled_at: string | null;
+        model_count: number;
+        shared: boolean;
+        slug: string;
+        token_sku_directions: {
+            [key: string]: import("../generated/schema.js").components["schemas"]["SkuDirection"];
+        };
+        type: import("../generated/schema.js").components["schemas"]["ProviderType"];
+    }>;
+    delete: (slug: string) => Promise<void>;
+    listModels: (slug: string, signal?: AbortSignal) => Promise<{
+        capabilities: import("../generated/schema.js").components["schemas"]["ModelCapabilities"];
+        context_window_tokens: number | null;
+        context_window_tokens_override: number | null;
+        disappeared_at: string | null;
+        display_name: string | null;
+        embedding_native_dimensions: number | null;
+        id: string;
+        last_reconciled_at: string;
+        max_input_tokens: number | null;
+        max_output_tokens: number | null;
+        model_id: string;
+        model_version: string | null;
+        pricing: {
+            [key: string]: number;
+        };
+        pricing_effective: {
+            [key: string]: number;
+        };
+        pricing_override: {
+            [key: string]: number;
+        };
+        pricing_skus: import("../generated/schema.js").components["schemas"]["SkuDisplayDto"][];
+        reasoning_options: null | import("../generated/schema.js").components["schemas"]["ReasoningOptions"];
+    }[]>;
+    /** Re-probes the upstream catalog. 409 while another reconcile is running. */
+    refreshModels: (slug: string) => Promise<{
+        capabilities: import("../generated/schema.js").components["schemas"]["ModelCapabilities"];
+        context_window_tokens: number | null;
+        context_window_tokens_override: number | null;
+        disappeared_at: string | null;
+        display_name: string | null;
+        embedding_native_dimensions: number | null;
+        id: string;
+        last_reconciled_at: string;
+        max_input_tokens: number | null;
+        max_output_tokens: number | null;
+        model_id: string;
+        model_version: string | null;
+        pricing: {
+            [key: string]: number;
+        };
+        pricing_effective: {
+            [key: string]: number;
+        };
+        pricing_override: {
+            [key: string]: number;
+        };
+        pricing_skus: import("../generated/schema.js").components["schemas"]["SkuDisplayDto"][];
+        reasoning_options: null | import("../generated/schema.js").components["schemas"]["ReasoningOptions"];
+    }[]>;
+    updateModel: (slug: string, modelId: string, input: Schemas["UpdateProviderModelInput"]) => Promise<void>;
+};

package/dist/admin/channels.d.ts

@@ -0,0 +1,261 @@
+import type { Transport } from "../http.js";
+import type { Schemas } from "../schemas.js";
+/** `Channel` and its Create/Update inputs are discriminated unions over `type`
+ * (telegram, whapi, whatsapp, external), so no per-type methods are needed. */
+export declare function channelsApi(t: Transport, tenantSlug: string): {
+    list: (signal?: AbortSignal) => Promise<(({
+        agent: import("../generated/schema.js").components["schemas"]["AgentRef"];
+        connection_secret_hint: string;
+        created_at: string;
+        default_user_role_slugs: string[];
+        disabled_at: string | null;
+        id: string;
+        last_connected_at: string | null;
+        slug: string;
+        user_onboarding_mode: string;
+    } & {
+        type: "external";
+    }) | ({
+        agent: import("../generated/schema.js").components["schemas"]["AgentRef"];
+        bot_display_name: string;
+        bot_id: number;
+        bot_username: string | null;
+        created_at: string;
+        default_user_role_slugs: string[];
+        disabled_at: string | null;
+        id: string;
+        slug: string;
+        user_onboarding_mode: string;
+    } & {
+        type: "telegram";
+    }) | ({
+        agent: import("../generated/schema.js").components["schemas"]["AgentRef"];
+        created_at: string;
+        default_user_role_slugs: string[];
+        disabled_at: string | null;
+        health_status: string | null;
+        id: string;
+        phone_number: string | null;
+        profile_name: string | null;
+        slug: string;
+        user_onboarding_mode: string;
+        whapi_channel_id: string | null;
+    } & {
+        type: "whapi";
+    }) | ({
+        agent: import("../generated/schema.js").components["schemas"]["AgentRef"];
+        created_at: string;
+        default_user_role_slugs: string[];
+        disabled_at: string | null;
+        id: string;
+        pairing_status: string;
+        phone_number: string | null;
+        push_name: string | null;
+        slug: string;
+        user_onboarding_mode: string;
+    } & {
+        type: "whatsapp";
+    }))[]>;
+    get: (slug: string, signal?: AbortSignal) => Promise<({
+        agent: import("../generated/schema.js").components["schemas"]["AgentRef"];
+        connection_secret_hint: string;
+        created_at: string;
+        default_user_role_slugs: string[];
+        disabled_at: string | null;
+        id: string;
+        last_connected_at: string | null;
+        slug: string;
+        user_onboarding_mode: string;
+    } & {
+        type: "external";
+    }) | ({
+        agent: import("../generated/schema.js").components["schemas"]["AgentRef"];
+        bot_display_name: string;
+        bot_id: number;
+        bot_username: string | null;
+        created_at: string;
+        default_user_role_slugs: string[];
+        disabled_at: string | null;
+        id: string;
+        slug: string;
+        user_onboarding_mode: string;
+    } & {
+        type: "telegram";
+    }) | ({
+        agent: import("../generated/schema.js").components["schemas"]["AgentRef"];
+        created_at: string;
+        default_user_role_slugs: string[];
+        disabled_at: string | null;
+        health_status: string | null;
+        id: string;
+        phone_number: string | null;
+        profile_name: string | null;
+        slug: string;
+        user_onboarding_mode: string;
+        whapi_channel_id: string | null;
+    } & {
+        type: "whapi";
+    }) | ({
+        agent: import("../generated/schema.js").components["schemas"]["AgentRef"];
+        created_at: string;
+        default_user_role_slugs: string[];
+        disabled_at: string | null;
+        id: string;
+        pairing_status: string;
+        phone_number: string | null;
+        push_name: string | null;
+        slug: string;
+        user_onboarding_mode: string;
+    } & {
+        type: "whatsapp";
+    })>;
+    create: (input: Schemas["CreateChannelInput"]) => Promise<({
+        agent: import("../generated/schema.js").components["schemas"]["AgentRef"];
+        bot_display_name: string;
+        bot_id: number;
+        bot_username: string | null;
+        created_at: string;
+        default_user_role_slugs: string[];
+        disabled_at: string | null;
+        id: string;
+        slug: string;
+        user_onboarding_mode: string;
+    } & {
+        type: "telegram";
+    }) | ({
+        agent: import("../generated/schema.js").components["schemas"]["AgentRef"];
+        created_at: string;
+        default_user_role_slugs: string[];
+        disabled_at: string | null;
+        health_status: string | null;
+        id: string;
+        phone_number: string | null;
+        profile_name: string | null;
+        slug: string;
+        user_onboarding_mode: string;
+        whapi_channel_id: string | null;
+    } & {
+        type: "whapi";
+    }) | ({
+        agent: import("../generated/schema.js").components["schemas"]["AgentRef"];
+        created_at: string;
+        default_user_role_slugs: string[];
+        disabled_at: string | null;
+        id: string;
+        pairing_status: string;
+        phone_number: string | null;
+        push_name: string | null;
+        slug: string;
+        user_onboarding_mode: string;
+    } & {
+        type: "whatsapp";
+    }) | ({
+        agent: import("../generated/schema.js").components["schemas"]["AgentRef"];
+        connection_secret_hint: string;
+        created_at: string;
+        default_user_role_slugs: string[];
+        disabled_at: string | null;
+        id: string;
+        last_connected_at: string | null;
+        slug: string;
+        user_onboarding_mode: string;
+    } & {
+        connection_secret: string;
+    } & {
+        type: "external";
+    })>;
+    update: (slug: string, input: Schemas["UpdateChannelInput"]) => Promise<({
+        agent: import("../generated/schema.js").components["schemas"]["AgentRef"];
+        connection_secret_hint: string;
+        created_at: string;
+        default_user_role_slugs: string[];
+        disabled_at: string | null;
+        id: string;
+        last_connected_at: string | null;
+        slug: string;
+        user_onboarding_mode: string;
+    } & {
+        type: "external";
+    }) | ({
+        agent: import("../generated/schema.js").components["schemas"]["AgentRef"];
+        bot_display_name: string;
+        bot_id: number;
+        bot_username: string | null;
+        created_at: string;
+        default_user_role_slugs: string[];
+        disabled_at: string | null;
+        id: string;
+        slug: string;
+        user_onboarding_mode: string;
+    } & {
+        type: "telegram";
+    }) | ({
+        agent: import("../generated/schema.js").components["schemas"]["AgentRef"];
+        created_at: string;
+        default_user_role_slugs: string[];
+        disabled_at: string | null;
+        health_status: string | null;
+        id: string;
+        phone_number: string | null;
+        profile_name: string | null;
+        slug: string;
+        user_onboarding_mode: string;
+        whapi_channel_id: string | null;
+    } & {
+        type: "whapi";
+    }) | ({
+        agent: import("../generated/schema.js").components["schemas"]["AgentRef"];
+        created_at: string;
+        default_user_role_slugs: string[];
+        disabled_at: string | null;
+        id: string;
+        pairing_status: string;
+        phone_number: string | null;
+        push_name: string | null;
+        slug: string;
+        user_onboarding_mode: string;
+    } & {
+        type: "whatsapp";
+    })>;
+    delete: (slug: string) => Promise<void>;
+    /** Invalidates the current connection secret and returns a new one. */
+    rotateSecret: (slug: string) => Promise<{
+        connection_secret: string;
+    }>;
+    /** The response components registered on the channel (external channels
+     * only carry them) — the catalog every conversation on the channel
+     * resolves at turn load. */
+    listComponentLibraries: (slug: string, signal?: AbortSignal) => Promise<{
+        libraries: string[];
+        tags: string[];
+    }>;
+    /** Replaces the channel's enabled libraries (send the complete list every
+     * time; empty clears it). External channels only — 409 on any other type.
+     * Running conversations pick the new catalog up on their next turn.
+     *
+     * Returns the slugs together with every tag they resolve to, so a runner can
+     * check the catalog against what its frontend actually renders. */
+    setComponentLibraries: (slug: string, libraries: string[]) => Promise<{
+        libraries: string[];
+        tags: string[];
+    }>;
+    listDeadLetters: (slug: string, signal?: AbortSignal) => Promise<{
+        attempts: number;
+        conversation_id: string | null;
+        error: string | null;
+        failed_at: string | null;
+        id: string;
+        identifier: string | null;
+        preview: string | null;
+        source: string;
+    }[]>;
+    pairWhatsapp: (slug: string, input: Schemas["WhatsappPairInput"]) => Promise<{
+        pair_code: string | null;
+        pair_code_expires_at: string | null;
+        pairing_status: string;
+        phone_number: string | null;
+        push_name: string | null;
+        qr_expires_at: string | null;
+        qr_payload: string | null;
+    }>;
+};

package/dist/admin/client-tools.d.ts

@@ -0,0 +1,74 @@
+import { type ClientToolsSession, type ServeClientToolsOptions } from "../client-tools.js";
+import type { Transport } from "../http.js";
+import type { Schemas } from "../schemas.js";
+/**
+ * Client tools: tools defined on a conversation with no server-side
+ * implementation. The agent calls one, its turn suspends, and whoever drives
+ * the API answers.
+ *
+ * This is the wire layer. For the usual case — "here are my functions, run
+ * them" — use `serveClientTools`, which drives this on your behalf.
+ */
+export declare function clientToolsApi(t: Transport, tenantSlug: string): {
+    /** Declares your functions on the conversation and runs them as the agent
+     * calls them, until you stop the session. This is the whole feature in one
+     * call; everything below is the wire it drives. */
+    serve: (convId: string, options: ServeClientToolsOptions) => ClientToolsSession;
+    list: (convId: string, signal?: AbortSignal) => Promise<{
+        created_at: string;
+        description: string;
+        destructive_hint: boolean | null;
+        id: string;
+        idempotent_hint: boolean | null;
+        input_schema: import("../generated/schema.js").components["schemas"]["Value"];
+        name: string;
+        output_schema: null | import("../generated/schema.js").components["schemas"]["Value"];
+        read_only_hint: boolean | null;
+        timeout_seconds: number;
+        updated_at: string;
+    }[]>;
+    /** Declares the whole set: entries are upserted, anything not listed is
+     * removed. The shape a reconnecting client wants — it converges instead of
+     * accumulating definitions from a previous session. */
+    replace: (convId: string, input: Schemas["ReplaceClientToolsInput"]) => Promise<{
+        created_at: string;
+        description: string;
+        destructive_hint: boolean | null;
+        id: string;
+        idempotent_hint: boolean | null;
+        input_schema: import("../generated/schema.js").components["schemas"]["Value"];
+        name: string;
+        output_schema: null | import("../generated/schema.js").components["schemas"]["Value"];
+        read_only_hint: boolean | null;
+        timeout_seconds: number;
+        updated_at: string;
+    }[]>;
+    /** Calls the agent is blocked on. Normally you learn about a call from the
+     * `client_tool_call` event on the conversation's SSE stream; this is the
+     * catch-up read for calls issued before you connected. */
+    listCalls: (convId: string, signal?: AbortSignal) => Promise<{
+        arguments: import("../generated/schema.js").components["schemas"]["Value"];
+        claim_expires_at: string | null;
+        claimed_by: string | null;
+        conversation_id: string;
+        created_at: string;
+        deadline_at: string;
+        tool_call_id: string;
+        tool_name: string;
+    }[]>;
+    /** Takes the exclusive lease, or renews it when `claimant` matches the
+     * holder. Rejects with 409 while someone else holds a live one. */
+    claim: (convId: string, toolCallId: string, input: Schemas["ClaimInput"]) => Promise<{
+        arguments: import("../generated/schema.js").components["schemas"]["Value"];
+        claim_expires_at: string | null;
+        claimed_by: string | null;
+        conversation_id: string;
+        created_at: string;
+        deadline_at: string;
+        tool_call_id: string;
+        tool_name: string;
+    }>;
+    releaseClaim: (convId: string, toolCallId: string, claimant: string) => Promise<void>;
+    /** Answers a call. Supply exactly one of `result`, `content` or `error`. */
+    submitResult: (convId: string, toolCallId: string, input: Schemas["SubmitResultInput"]) => Promise<void>;
+};

package/dist/admin/component-libraries.d.ts

@@ -0,0 +1,63 @@
+import type { Transport } from "../http.js";
+import type { Schemas } from "../schemas.js";
+/** Component libraries: the catalogs of interactive blocks an agent may put in a
+ * reply, authored here and enabled by slug on a conversation or an external
+ * channel.
+ *
+ * Authoring is deliberately an operator capability. A component's `summary`,
+ * `description` and `exampleMdx` are shown to the model verbatim, so writing one
+ * is writing prompt content — hence `component_libraries:write` on an api_key,
+ * never a browser. A client app holding an end-user token can only *enable* a
+ * library, which is the half that depends on which of its screens is open.
+ *
+ * Edits replace in place — no version snapshots, and every conversation with the
+ * library enabled sees the latest on its next turn, the same rule skills follow. */
+export declare function componentLibrariesApi(t: Transport, tenantSlug: string): {
+    /** Every library in the tenant with its tag names — enough to wire one up
+     * without fetching the full entries. */
+    list: (signal?: AbortSignal) => Promise<{
+        created_at: string;
+        description: string;
+        display_name: string;
+        id: string;
+        slug: string;
+        tags: string[];
+        updated_at: string;
+    }[]>;
+    /** One library with every component's full entry — the same text the agent
+     * receives from `component_read`. */
+    get: (slug: string, signal?: AbortSignal) => Promise<{
+        components: import("../generated/schema.js").components["schemas"]["LibraryComponent"][];
+        created_at: string;
+        description: string;
+        display_name: string;
+        id: string;
+        slug: string;
+        updated_at: string;
+    }>;
+    create: (input: Schemas["CreateComponentLibraryInput"]) => Promise<{
+        components: import("../generated/schema.js").components["schemas"]["LibraryComponent"][];
+        created_at: string;
+        description: string;
+        display_name: string;
+        id: string;
+        slug: string;
+        updated_at: string;
+    }>;
+    /** Patches in place; omitted fields stay. Supplying `components` replaces
+     * the whole set, so send it complete — half a library must never reach a
+     * prompt because two calls were in flight. */
+    update: (currentSlug: string, input: Schemas["UpdateComponentLibraryInput"]) => Promise<{
+        components: import("../generated/schema.js").components["schemas"]["LibraryComponent"][];
+        created_at: string;
+        description: string;
+        display_name: string;
+        id: string;
+        slug: string;
+        updated_at: string;
+    }>;
+    /** Deletes the library and every enablement of it. Messages already written
+     * keep their text: blocks are re-derived from content on read, and the read
+     * path consults no catalog. */
+    delete: (slug: string) => Promise<void>;
+};