sakuya-types 0.1.0

package/index.ts

@@ -0,0 +1,101 @@
+import type { AgentTool } from "@mariozechner/pi-agent-core";
+export { Type } from "@mariozechner/pi-ai";
+
+// ── Message types ──────────────────────────────────────────────
+
+export type SourceType = string;
+
+export type TriggerType = "direct" | "mention" | "reply" | "scheduled" | "passive";
+
+export interface SenderInfo {
+  id: string;
+  name?: string;
+  username?: string;
+  isBot?: boolean;
+}
+
+export interface AttachmentRef {
+  type: "image" | "document";
+  path: string;
+  mimeType?: string;
+  size?: number;
+  fileName?: string;
+}
+
+export interface InboundMessage {
+  id: string;
+  source: SourceType;
+  channelKey: string;
+  sender: SenderInfo;
+  text?: string;
+  command?: { name: string; args: string };
+  attachments: AttachmentRef[];
+  replyToMessageId?: string;
+  raw?: Record<string, unknown>;
+  receivedAt: string;
+  trigger: TriggerType;
+}
+
+// ── Adapter types ──────────────────────────────────────────────
+
+export interface AdapterMessageHandler {
+  onInbound: (message: InboundMessage) => Promise<void>;
+}
+
+export interface Adapter {
+  readonly name: string;
+  start(): Promise<void>;
+  stop(): Promise<void>;
+  canHandleChannel(channelKey: string): boolean;
+  canHandleFile?(path: string): boolean;
+  sendMessage(channelKey: string, text: string, replyToMessageId?: string): Promise<string>;
+  sendFile?(channelKey: string, filePath: string, caption?: string): Promise<string>;
+  setReaction?(channelKey: string, messageId: string, emoji: string): Promise<string>;
+  fetchImageContent?(channelKey: string, path: string): Promise<{ data: string; mimeType: string }>;
+}
+
+// ── Tool types ─────────────────────────────────────────────────
+
+/** Context available to tool factories at runtime */
+export interface ToolContext {
+  currentChannelKey: string;
+  workspaceDir: string;
+  currentMessageId?: string;
+}
+
+// ── Extension types ────────────────────────────────────────────
+
+/** Tool factory: called per agent run with the current ToolContext */
+export type ToolFactory = (ctx: ToolContext) => AgentTool;
+
+/** Adapter factory: receives messageHandler, returns an Adapter */
+export type AdapterFactory = (handler: AdapterMessageHandler) => Adapter;
+
+/**
+ * Context passed to extension activate()
+ */
+export interface ExtensionContext {
+  /** Register an adapter factory. The handler is injected automatically at startup. */
+  registerAdapter(factory: AdapterFactory): void;
+  /**
+   * Register a tool factory.
+   * The factory is called every time an agent session starts to create fresh tool instances.
+   */
+  registerTool(factory: ToolFactory): void;
+  /** Absolute path to the directory containing the extension file */
+  extensionDir: string;
+  /** Sakuya workspace directory (~/.sakuya) */
+  workspaceDir: string;
+}
+
+/**
+ * Every extension module must default-export an object implementing this interface.
+ */
+export interface SakuyaExtension {
+  /** Unique extension identifier for logging */
+  name: string;
+  /** Lifecycle hook: called when extension is loaded during daemon startup */
+  activate(ctx: ExtensionContext): void | Promise<void>;
+  /** Lifecycle hook: called during daemon shutdown for cleanup */
+  deactivate?(): void | Promise<void>;
+}

package/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "sakuya-types",
+  "version": "0.1.0",
+  "description": "Type definitions for Sakuya extensions",
+  "type": "module",
+  "main": "index.ts",
+  "types": "index.ts",
+  "files": [
+    "index.ts"
+  ],
+  "peerDependencies": {
+    "@mariozechner/pi-agent-core": ">=0.61.0"
+  },
+  "license": "ISC"
+}