openclaw-openagent 1.0.1 → 1.0.3

package/dist/src/channel.d.ts

@@ -0,0 +1,269 @@
+/**
+ * OpenAgent Channel Adapter — OpenClaw channel plugin interface
+ *
+ * Assembles the v3 modular architecture:
+ *   auth/ → runtime/ → tim/ → messaging/ → tools
+ *
+ * Gateway lifecycle uses AccountRuntime with transaction-style
+ * start/stop and RuntimeRegistry enforcement.
+ */
+export declare const openagentPlugin: {
+    id: string;
+    meta: {
+        id: string;
+        label: string;
+        selectionLabel: string;
+        detailLabel: string;
+        docsPath: string;
+        docsLabel: string;
+        blurb: string;
+        aliases: string[];
+        order: number;
+        quickstartAllowFrom: boolean;
+    };
+    capabilities: {
+        chatTypes: string[];
+        media: boolean;
+        reactions: boolean;
+        threads: boolean;
+        polls: boolean;
+        nativeCommands: boolean;
+    };
+    reload: {
+        configPrefixes: string[];
+    };
+    config: {
+        listAccountIds: (cfgOrCtx: Record<string, unknown>) => string[];
+        resolveAccount: (cfg: Record<string, unknown>, accountId: string) => import("./auth/config.js").OpenagentAccountConfig;
+        defaultAccountId: (cfgOrCtx: Record<string, unknown>) => string;
+        setAccountEnabled: ({ cfg, enabled }: {
+            cfg: Record<string, unknown>;
+            enabled: boolean;
+        }) => {
+            channels: {
+                openagent: {
+                    enabled: boolean;
+                };
+            };
+        };
+        deleteAccount: ({ cfg }: {
+            cfg: Record<string, unknown>;
+        }) => {
+            channels: {
+                [x: string]: unknown;
+            };
+        };
+        isConfigured: (account: {
+            configured: boolean;
+        }) => boolean;
+        describeAccount: (account: {
+            accountId: string;
+            name: string;
+            enabled: boolean;
+            configured: boolean;
+            transport?: string;
+            status?: string;
+        }) => {
+            accountId: string;
+            name: string;
+            enabled: boolean;
+            configured: boolean;
+            tokenStatus: string;
+            transport: string;
+            claimStatus: string;
+        };
+    };
+    security: {
+        resolveDmPolicy: () => {
+            policy: string;
+            allowFrom: string[];
+            policyPath: string;
+            allowFromPath: string;
+            normalizeEntry: (raw: string) => string;
+        };
+    };
+    groups: {
+        resolveRequireMention: () => boolean;
+    };
+    threading: {
+        resolveReplyToMode: () => string;
+    };
+    messaging: {
+        normalizeTarget: (raw: string) => string | undefined;
+        targetResolver: {
+            looksLikeId: (raw: string) => boolean;
+            hint: string;
+        };
+    };
+    outbound: {
+        deliveryMode: string;
+        chunkerMode: string;
+        textChunkLimit: number;
+        sendText: ({ to, text }: {
+            cfg: unknown;
+            to: string;
+            text: string;
+            accountId?: string;
+        }) => Promise<{
+            channel: string;
+            ok: boolean;
+            messageId: string;
+            error: Error;
+        } | {
+            channel: string;
+            ok: boolean;
+            messageId: string;
+            error?: undefined;
+        }>;
+    };
+    status: {
+        defaultRuntime: {
+            accountId: string;
+            running: boolean;
+            lastStartAt: number | null;
+            lastStopAt: number | null;
+            lastError: string | null;
+        };
+        buildChannelSummary: ({ snapshot }: {
+            snapshot: Record<string, unknown>;
+        }) => {
+            configured: {};
+            running: {};
+            connected: {};
+            transport: {};
+            claimStatus: {};
+            claimUrl: {};
+            lastStartAt: {} | null;
+            lastStopAt: {} | null;
+            lastError: {} | null;
+            lastInboundAt: {} | null;
+            lastOutboundAt: {} | null;
+        };
+        probeAccount: () => Promise<{
+            ok: boolean;
+        }>;
+        buildAccountSnapshot: ({ account, runtime }: {
+            account: {
+                accountId: string;
+                name: string;
+                enabled: boolean;
+                configured: boolean;
+                transport?: string;
+                status?: string;
+                claimUrl?: string;
+            };
+            runtime?: {
+                running?: boolean;
+                lastStartAt?: number;
+                lastStopAt?: number;
+                lastError?: string;
+            };
+        }) => {
+            accountId: string;
+            name: string;
+            enabled: boolean;
+            configured: boolean;
+            tokenStatus: string;
+            transport: string;
+            claimStatus: string | undefined;
+            claimUrl: string;
+            running: boolean;
+            connected: boolean;
+            lastStartAt: number | null;
+            lastStopAt: number | null;
+            lastError: string | null;
+        };
+        sendText: () => Promise<{
+            ok: boolean;
+        }>;
+        sendMedia: () => Promise<{
+            ok: boolean;
+        }>;
+    };
+    gateway: {
+        startAccount: (ctx: {
+            account: {
+                accountId: string;
+                agentId: string;
+                apiBase: string;
+                accessApiBase?: string;
+                apiKey: string;
+                configured: boolean;
+                config: Record<string, unknown>;
+            };
+            cfg: Record<string, unknown>;
+            abortSignal?: AbortSignal;
+            log?: {
+                info?: (msg: string) => void;
+                warn?: (msg: string) => void;
+                error?: (msg: string) => void;
+            };
+            setStatus: (status: Record<string, unknown>) => void;
+        }) => Promise<void>;
+        stopAccount: (ctx: {
+            account: {
+                accountId: string;
+            };
+            setStatus: (status: Record<string, unknown>) => void;
+        }) => Promise<void>;
+    };
+    onboarding: {
+        channel: string;
+        getStatus: ({ cfg }: {
+            cfg: Record<string, unknown>;
+        }) => Promise<{
+            channel: string;
+            configured: boolean;
+            statusLines: string[];
+            selectionHint: string;
+            quickstartScore: number;
+        }>;
+        configure: ({ cfg, prompter }: {
+            cfg: Record<string, unknown>;
+            prompter: {
+                text: (opts: {
+                    message: string;
+                    validate: (v: string) => string | undefined;
+                }) => Promise<string>;
+            };
+        }) => Promise<{
+            cfg: {
+                channels: {
+                    openagent: {
+                        enabled: boolean;
+                        transport: string;
+                        api_base: string;
+                        access_api_base: string;
+                        accounts: {
+                            default: Record<string, unknown>;
+                        };
+                    };
+                };
+            };
+            accountId: string;
+        } | {
+            cfg: {
+                channels: {
+                    openagent: {
+                        enabled: boolean;
+                        accounts: {
+                            default: {
+                                agent_id: string;
+                                api_key: string;
+                                api_base: string;
+                            };
+                        };
+                    };
+                };
+            };
+            accountId: string;
+        }>;
+        disable: (cfg: Record<string, unknown>) => {
+            channels: {
+                openagent: {
+                    enabled: boolean;
+                };
+            };
+        };
+    };
+};