@ozaiya/openclaw-channel 0.1.0

package/types/openclaw-plugin-sdk.d.ts

@@ -0,0 +1,109 @@
+/**
+ * Minimal type stubs for openclaw/plugin-sdk.
+ *
+ * These stubs cover only the APIs used by this package so that tsc can
+ * type-check and build without installing the full openclaw package (133 MB).
+ * The real types are provided at runtime by the openclaw peer dependency.
+ */
+declare module "openclaw/plugin-sdk" {
+  /** OpenClaw global config object passed to plugin callbacks. */
+  export interface OpenClawConfig {
+    channels?: Record<string, unknown>;
+    [key: string]: unknown;
+  }
+
+  /** Agent tool exposed by a channel plugin. */
+  export interface ChannelAgentTool {
+    label: string;
+    name: string;
+    ownerOnly?: boolean;
+    description: string;
+    parameters: unknown;
+    execute: (
+      toolCallId: string,
+      args: unknown,
+    ) => Promise<{ content: Array<{ type: string; text: string }> }>;
+  }
+
+  /** Factory that returns agent tools given config. */
+  export type ChannelAgentToolFactory = (ctx: {
+    cfg: OpenClawConfig;
+  }) => ChannelAgentTool[];
+
+  /**
+   * Channel plugin interface (structural, permissive).
+   * Full type-checking is provided by the real openclaw package at runtime.
+   */
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+  export interface ChannelPlugin<_T = unknown> {}
+
+  /** OpenClaw PluginRuntime — channel dispatch APIs available after registration. */
+  export interface PluginRuntime {
+    channel: {
+      routing: {
+        resolveAgentRoute(opts: {
+          cfg: OpenClawConfig;
+          channel: string;
+          accountId: string;
+          peer: { kind: string; id: string };
+        }): { agentId: string; sessionKey: string; accountId: string };
+      };
+      session: {
+        resolveStorePath(
+          a: undefined,
+          b: { agentId: string },
+        ): unknown;
+        readSessionUpdatedAt(opts: {
+          storePath: unknown;
+          sessionKey: string;
+        }): unknown;
+        recordInboundSession(opts: {
+          storePath: unknown;
+          sessionKey: string;
+          ctx: unknown;
+          onRecordError: (err: unknown) => void;
+        }): Promise<void>;
+      };
+      reply: {
+        resolveEnvelopeFormatOptions(cfg: OpenClawConfig): unknown;
+        formatAgentEnvelope(opts: {
+          channel: string;
+          from: string;
+          timestamp: number;
+          previousTimestamp: unknown;
+          envelope: unknown;
+          body: string;
+        }): string;
+        finalizeInboundContext(ctx: Record<string, unknown>): unknown;
+        dispatchReplyWithBufferedBlockDispatcher(opts: {
+          ctx: unknown;
+          cfg: OpenClawConfig;
+          dispatcherOptions: {
+            deliver: (payload: { text?: string }, info: unknown) => Promise<void>;
+            onError: (err: unknown) => void;
+          };
+        }): Promise<void>;
+      };
+    };
+  }
+
+  /** API passed to plugin.register() by OpenClaw. */
+  export interface OpenClawPluginApi {
+    runtime: PluginRuntime;
+    registerChannel(opts: { plugin: unknown }): void;
+  }
+
+  /** Register an HTTP route handled by this plugin. Returns an unregister function. */
+  export function registerPluginHttpRoute(opts: {
+    path: string;
+    auth: string;
+    replaceExisting?: boolean;
+    pluginId: string;
+    source: string;
+    log?: (msg: string) => void;
+    handler: unknown;
+  }): () => void;
+
+  /** Returns an empty Zod/TypeBox schema for plugins with no config. */
+  export function emptyPluginConfigSchema(): unknown;
+}