@emotion-machine/claw-messenger 0.1.0

package/src/types/openclaw.d.ts

@@ -0,0 +1,311 @@
+/**
+ * Type declarations for openclaw/plugin-sdk.
+ *
+ * These are derived from the runtime shapes in openclaw's compiled JS.
+ * Since openclaw doesn't ship .d.ts files, we declare the subset we need.
+ */
+declare module "openclaw/plugin-sdk" {
+  import { z } from "zod";
+
+  // ── Config ──
+
+  export interface OpenclawConfig {
+    channels?: Record<string, any>;
+    session?: { store?: any };
+    [key: string]: any;
+  }
+
+  // ── Channel Plugin ──
+
+  export interface ChannelPlugin<T = any> {
+    id: string;
+    meta: {
+      label: string;
+      blurb: string;
+      docsPath: string;
+      docsLabel?: string;
+      systemImage?: string;
+      quickstartAllowFrom?: boolean;
+      aliases?: string[];
+      showConfigured?: boolean;
+      order?: number;
+      selectionLabel?: string;
+      detailLabel?: string;
+      selectionDocsPrefix?: string;
+      selectionDocsOmitLabel?: boolean;
+      selectionExtras?: string[];
+    };
+    pairing?: {
+      idLabel: string;
+      normalizeAllowEntry?: (entry: string) => string;
+      notifyApproval?: (ctx: { cfg: OpenclawConfig; id: string }) => Promise<void>;
+    };
+    onboarding?: any;
+    capabilities: {
+      chatTypes: ("direct" | "group" | "channel" | "thread")[];
+      reactions?: boolean;
+      threads?: boolean;
+      media?: boolean;
+      nativeCommands?: boolean;
+      blockStreaming?: boolean;
+      polls?: boolean;
+    };
+    reload?: { configPrefixes: string[] };
+    configSchema?: any;
+    config: {
+      listAccountIds: (cfg: OpenclawConfig) => string[];
+      resolveAccount: (cfg: OpenclawConfig, accountId: string) => T;
+      defaultAccountId: (cfg: OpenclawConfig) => string;
+      setAccountEnabled: (ctx: { cfg: OpenclawConfig; accountId: string; enabled: boolean }) => OpenclawConfig;
+      deleteAccount: (ctx: { cfg: OpenclawConfig; accountId: string }) => OpenclawConfig;
+      isConfigured: (account: T) => boolean;
+      describeAccount: (account: T) => Record<string, any>;
+      resolveAllowFrom: (ctx: { cfg: OpenclawConfig; accountId: string }) => string[];
+      formatAllowFrom: (ctx: { allowFrom: string[] }) => string[];
+    };
+    security?: {
+      resolveDmPolicy?: (ctx: { cfg: OpenclawConfig; accountId?: string; account: T }) => {
+        policy: string;
+        allowFrom: string[];
+        policyPath?: string;
+        allowFromPath?: string;
+        approveHint?: string;
+        normalizeEntry?: (raw: string) => string;
+      };
+      collectWarnings?: (ctx: { account: T; cfg: OpenclawConfig }) => string[];
+    };
+    groups?: {
+      resolveRequireMention?: (ctx: any) => boolean;
+      resolveToolPolicy?: (cfg: OpenclawConfig, accountId: string, groupId: string) => string | undefined;
+    };
+    threading?: any;
+    messaging: {
+      normalizeTarget: (target: string) => string | null;
+      targetResolver: {
+        looksLikeId: (raw: string) => boolean;
+        hint: string;
+      };
+    };
+    directory?: any;
+    resolver?: any;
+    actions?: any;
+    setup?: {
+      resolveAccountId?: (ctx: { accountId?: string }) => string;
+      applyAccountName?: (ctx: { cfg: OpenclawConfig; accountId: string; name?: string }) => OpenclawConfig;
+      validateInput?: (ctx: { accountId: string; input: any }) => string | null;
+      applyAccountConfig?: (ctx: { cfg: OpenclawConfig; accountId: string; input: any }) => OpenclawConfig;
+    };
+    outbound?: {
+      deliveryMode: "direct" | "buffered" | "coalesced";
+      chunker?: ((text: string, limit: number) => string[]) | null;
+      chunkerMode?: "plain" | "markdown" | "text";
+      textChunkLimit?: number;
+      sendText?: (ctx: {
+        to: string;
+        text: string;
+        accountId?: string;
+        cfg?: OpenclawConfig;
+        deps?: any;
+        replyToId?: string;
+        threadId?: string;
+      }) => Promise<{ channel: string; [key: string]: any }>;
+      sendMedia?: (ctx: {
+        to: string;
+        text: string;
+        mediaUrl: string;
+        accountId?: string;
+        cfg?: OpenclawConfig;
+        deps?: any;
+        replyToId?: string;
+        threadId?: string;
+      }) => Promise<{ channel: string; [key: string]: any }>;
+      sendPayload?: (ctx: any) => Promise<{ channel: string; [key: string]: any }>;
+    };
+    status?: {
+      defaultRuntime?: any;
+      collectStatusIssues?: (ctx: any) => any;
+      buildChannelSummary?: (ctx: any) => any;
+      probeAccount?: (ctx: { account: T; timeoutMs: number }) => Promise<any>;
+      auditAccount?: (ctx: any) => Promise<any>;
+      buildAccountSnapshot?: (ctx: { account: T; cfg?: OpenclawConfig; runtime?: any; probe?: any }) => any;
+      resolveAccountState?: (ctx: any) => string;
+    };
+    gateway?: {
+      startAccount?: (ctx: {
+        account: T;
+        cfg: OpenclawConfig;
+        runtime: PluginRuntime;
+        abortSignal: AbortSignal;
+        log?: any;
+        setStatus?: (state: any) => void;
+      }) => Promise<any>;
+      logoutAccount?: (ctx: { accountId: string; cfg: OpenclawConfig }) => Promise<any>;
+    };
+    streaming?: any;
+    agentPrompt?: any;
+  }
+
+  // ── Plugin Runtime ──
+
+  export interface PluginRuntime {
+    version: string;
+    config: {
+      loadConfig(): OpenclawConfig;
+      writeConfigFile(cfg: OpenclawConfig): Promise<void>;
+    };
+    system: {
+      enqueueSystemEvent(event: any): void;
+      [key: string]: any;
+    };
+    media: {
+      loadWebMedia(url: string): Promise<any>;
+      detectMime(buffer: Buffer): string | undefined;
+      [key: string]: any;
+    };
+    channel: {
+      text: {
+        chunkText(text: string, limit: number): string[];
+        chunkMarkdownText(text: string, limit: number): string[];
+        chunkMarkdownTextWithMode(text: string, limit: number, mode: string): string[];
+        resolveChunkMode(cfg: OpenclawConfig, channel: string): string;
+        resolveTextChunkLimit?(cfg: OpenclawConfig, channel: string, accountId?: string, opts?: any): number;
+        hasControlCommand(text: string, cfg: OpenclawConfig): boolean;
+        [key: string]: any;
+      };
+      reply: {
+        dispatchReplyWithBufferedBlockDispatcher(ctx: any): Promise<any>;
+        resolveEffectiveMessagesConfig(cfg: OpenclawConfig, agentId?: string): any;
+        formatInboundEnvelope(ctx: any): string;
+        finalizeInboundContext(ctx: any): any;
+        resolveEnvelopeFormatOptions(cfg: OpenclawConfig): any;
+        [key: string]: any;
+      };
+      routing: {
+        resolveAgentRoute(ctx: {
+          cfg: OpenclawConfig;
+          channel: string;
+          accountId: string;
+          peer: { kind: "dm" | "group" | "channel"; id: string };
+        }): { sessionKey: string; accountId: string; agentId?: string; mainSessionKey?: string; [key: string]: any };
+      };
+      pairing: {
+        buildPairingReply(ctx: { channel: string; idLine: string; code: string }): string;
+        readAllowFromStore(channel: string): Promise<string[]>;
+        upsertPairingRequest(ctx: { channel: string; id: string; meta?: { name?: string } }): Promise<{ code: string; created: boolean }>;
+      };
+      media: {
+        fetchRemoteMedia(ctx: { url: string }): Promise<{ buffer: Buffer; contentType?: string }>;
+        saveMediaBuffer(buffer: Uint8Array, contentType: string | undefined, direction: "inbound" | "outbound", maxBytes: number): Promise<{ path: string; contentType?: string }>;
+      };
+      session: {
+        resolveStorePath(store: any, opts?: { agentId?: string }): string;
+        readSessionUpdatedAt(path: string, sessionKey: string): number | null;
+        recordSessionMetaFromInbound(ctx: any): Promise<void>;
+        recordInboundSession(ctx: any): void;
+        updateLastRoute(ctx: any): void;
+      };
+      activity: {
+        record(ctx: any): void;
+        get(ctx: any): any;
+      };
+      [key: string]: any;
+    };
+    logging: {
+      shouldLogVerbose(): boolean;
+      getChildLogger(bindings: string, opts?: any): any;
+    };
+    state: {
+      resolveStateDir(cfg: OpenclawConfig): string;
+    };
+    [key: string]: any;
+  }
+
+  // ── Plugin API ──
+
+  export interface OpenclawPluginApi {
+    id: string;
+    name: string;
+    version: string;
+    description: string;
+    source: string;
+    config: OpenclawConfig;
+    pluginConfig: any;
+    runtime: PluginRuntime;
+    logger: any;
+    registerChannel(registration: { plugin: ChannelPlugin }): void;
+    registerProvider(provider: any): void;
+    registerTool(tool: any, opts?: any): void;
+    registerHook(events: string | string[], handler: any, opts?: any): void;
+    registerHttpHandler(handler: any): void;
+    registerHttpRoute(params: { path: string; handler: any }): void;
+    registerGatewayMethod(method: string, handler: any): void;
+    registerCli(registrar: any, opts?: any): void;
+    registerService(service: any): void;
+    registerCommand(command: any): void;
+    resolvePath(input: string): string;
+    on(hookName: string, handler: any, opts?: any): void;
+  }
+
+  // ── Helpers ──
+
+  export const DEFAULT_ACCOUNT_ID: string;
+  export const PAIRING_APPROVED_MESSAGE: string;
+
+  export function normalizeAccountId(accountId?: string | null): string;
+  export function normalizeE164(input: string): string | null;
+  export function buildChannelConfigSchema(schema: any): any;
+  export function emptyPluginConfigSchema(): any;
+  export function getChatChannelMeta(channel: string): any;
+  export function formatPairingApproveHint(channel: string): string;
+
+  export function setAccountEnabledInConfigSection(ctx: {
+    cfg: OpenclawConfig;
+    sectionKey: string;
+    accountId: string;
+    enabled: boolean;
+    allowTopLevel?: boolean;
+  }): OpenclawConfig;
+
+  export function deleteAccountFromConfigSection(ctx: {
+    cfg: OpenclawConfig;
+    sectionKey: string;
+    accountId: string;
+    clearBaseFields?: string[];
+  }): OpenclawConfig;
+
+  export function registerPluginHttpRoute(params: {
+    path: string;
+    pluginId?: string;
+    accountId?: string;
+    source?: string;
+    log?: (msg: string) => void;
+    handler: (req: any, res: any) => Promise<void> | void;
+    registry?: any;
+    fallbackPath?: string;
+  }): () => void;
+
+  export function normalizePluginHttpPath(path?: string, fallback?: string): string | null;
+
+  // ── Ack Reactions ──
+
+  export function resolveAckReaction(cfg: OpenclawConfig, agentId?: string): string | undefined;
+
+  export function shouldAckReaction(params: {
+    scope: string;
+    isDirect: boolean;
+    isGroup: boolean;
+    isMentionableGroup?: boolean;
+    requireMention?: boolean;
+    canDetectMention?: boolean;
+    effectiveWasMentioned?: boolean;
+    shouldBypassMention?: boolean;
+  }): boolean;
+
+  // Config schemas
+  export const IMessageConfigSchema: any;
+  export const TelegramConfigSchema: any;
+  export const DiscordConfigSchema: any;
+  export const SlackConfigSchema: any;
+  export const SignalConfigSchema: any;
+  export const WhatsAppConfigSchema: any;
+}