@github/copilot-sdk 0.0.1 → 0.1.10-preview.0

package/dist/generated/session-events.d.ts

@@ -0,0 +1,384 @@
+/**
+ * AUTO-GENERATED FILE - DO NOT EDIT
+ *
+ * Generated from: @github/copilot/session-events.schema.json
+ * Generated by: scripts/generate-session-types.ts
+ * Generated at: 2026-01-08T23:59:19.905Z
+ *
+ * To update these types:
+ * 1. Update the schema in copilot-agent-runtime
+ * 2. Run: npm run generate:session-types
+ */
+export type SessionEvent = {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "session.start";
+    data: {
+        sessionId: string;
+        version: number;
+        producer: string;
+        copilotVersion: string;
+        startTime: string;
+        selectedModel?: string;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "session.resume";
+    data: {
+        resumeTime: string;
+        eventCount: number;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "session.error";
+    data: {
+        errorType: string;
+        message: string;
+        stack?: string;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral: true;
+    type: "session.idle";
+    data: {};
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "session.info";
+    data: {
+        infoType: string;
+        message: string;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "session.model_change";
+    data: {
+        previousModel?: string;
+        newModel: string;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "session.handoff";
+    data: {
+        handoffTime: string;
+        sourceType: "remote" | "local";
+        repository?: {
+            owner: string;
+            name: string;
+            branch?: string;
+        };
+        context?: string;
+        summary?: string;
+        remoteSessionId?: string;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "session.truncation";
+    data: {
+        tokenLimit: number;
+        preTruncationTokensInMessages: number;
+        preTruncationMessagesLength: number;
+        postTruncationTokensInMessages: number;
+        postTruncationMessagesLength: number;
+        tokensRemovedDuringTruncation: number;
+        messagesRemovedDuringTruncation: number;
+        performedBy: string;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "user.message";
+    data: {
+        content: string;
+        transformedContent?: string;
+        attachments?: {
+            type: "file" | "directory";
+            path: string;
+            displayName: string;
+        }[];
+        source?: string;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "assistant.turn_start";
+    data: {
+        turnId: string;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral: true;
+    type: "assistant.intent";
+    data: {
+        intent: string;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "assistant.reasoning";
+    data: {
+        reasoningId: string;
+        content: string;
+        chunkContent?: string;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: true;
+    type: "assistant.reasoning_delta";
+    data: {
+        reasoningId: string;
+        deltaContent: string;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "assistant.message";
+    data: {
+        messageId: string;
+        content: string;
+        chunkContent?: string;
+        totalResponseSizeBytes?: number;
+        toolRequests?: {
+            toolCallId: string;
+            name: string;
+            arguments?: unknown;
+        }[];
+        parentToolCallId?: string;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: true;
+    type: "assistant.message_delta";
+    data: {
+        messageId: string;
+        deltaContent: string;
+        totalResponseSizeBytes?: number;
+        parentToolCallId?: string;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "assistant.turn_end";
+    data: {
+        turnId: string;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral: true;
+    type: "assistant.usage";
+    data: {
+        model?: string;
+        inputTokens?: number;
+        outputTokens?: number;
+        cacheReadTokens?: number;
+        cacheWriteTokens?: number;
+        cost?: number;
+        duration?: number;
+        initiator?: string;
+        apiCallId?: string;
+        providerCallId?: string;
+        quotaSnapshots?: {
+            [k: string]: {
+                isUnlimitedEntitlement: boolean;
+                entitlementRequests: number;
+                usedRequests: number;
+                usageAllowedWithExhaustedQuota: boolean;
+                overage: number;
+                overageAllowedWithExhaustedQuota: boolean;
+                remainingPercentage: number;
+                resetDate?: string;
+            };
+        };
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "abort";
+    data: {
+        reason: string;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "tool.user_requested";
+    data: {
+        toolCallId: string;
+        toolName: string;
+        arguments?: unknown;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "tool.execution_start";
+    data: {
+        toolCallId: string;
+        toolName: string;
+        arguments?: unknown;
+        parentToolCallId?: string;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral: true;
+    type: "tool.execution_partial_result";
+    data: {
+        toolCallId: string;
+        partialOutput: string;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "tool.execution_complete";
+    data: {
+        toolCallId: string;
+        success: boolean;
+        isUserRequested?: boolean;
+        result?: {
+            content: string;
+        };
+        error?: {
+            message: string;
+            code?: string;
+        };
+        toolTelemetry?: {
+            [k: string]: unknown;
+        };
+        parentToolCallId?: string;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "custom_agent.started";
+    data: {
+        toolCallId: string;
+        agentName: string;
+        agentDisplayName: string;
+        agentDescription: string;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "custom_agent.completed";
+    data: {
+        toolCallId: string;
+        agentName: string;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "custom_agent.failed";
+    data: {
+        toolCallId: string;
+        agentName: string;
+        error: string;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "custom_agent.selected";
+    data: {
+        agentName: string;
+        agentDisplayName: string;
+        tools: string[] | null;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "hook.start";
+    data: {
+        hookInvocationId: string;
+        hookType: string;
+        input?: unknown;
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "hook.end";
+    data: {
+        hookInvocationId: string;
+        hookType: string;
+        output?: unknown;
+        success: boolean;
+        error?: {
+            message: string;
+            stack?: string;
+        };
+    };
+} | {
+    id: string;
+    timestamp: string;
+    parentId: string | null;
+    ephemeral?: boolean;
+    type: "system.message";
+    data: {
+        content: string;
+        role: "system" | "developer";
+        name?: string;
+        metadata?: {
+            promptVersion?: string;
+            variables?: {
+                [k: string]: unknown;
+            };
+        };
+    };
+};

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Copilot SDK - TypeScript/Node.js Client
+ *
+ * JSON-RPC based SDK for programmatic control of GitHub Copilot CLI
+ */
+export { CopilotClient } from "./client.js";
+export { CopilotSession } from "./session.js";
+export { defineTool } from "./types.js";
+export type { ConnectionState, CopilotClientOptions, MessageOptions, ResumeSessionConfig, SessionConfig, SessionEvent, SessionEventHandler, SessionMetadata, SystemMessageAppendConfig, SystemMessageConfig, SystemMessageReplaceConfig, Tool, ToolHandler, ToolInvocation, ToolResultObject, ZodSchema, } from "./types.js";

package/dist/index.js

@@ -0,0 +1,8 @@
+import { CopilotClient } from "./client.js";
+import { CopilotSession } from "./session.js";
+import { defineTool } from "./types.js";
+export {
+  CopilotClient,
+  CopilotSession,
+  defineTool
+};

package/dist/session.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Copilot Session - represents a single conversation session with the CLI
+ */
+import type { MessageConnection } from "vscode-jsonrpc/node";
+import type { MessageOptions, SessionEvent, SessionEventHandler, Tool, ToolHandler } from "./types.js";
+export declare class CopilotSession {
+    readonly sessionId: string;
+    private connection;
+    private eventHandlers;
+    private toolHandlers;
+    constructor(sessionId: string, connection: MessageConnection);
+    /**
+     * Send a message to this session
+     */
+    send(options: MessageOptions): Promise<string>;
+    /**
+     * Subscribe to events from this session
+     * @returns Unsubscribe function
+     */
+    on(handler: SessionEventHandler): () => void;
+    /**
+     * Internal: dispatch an event to all handlers
+     */
+    _dispatchEvent(event: SessionEvent): void;
+    registerTools(tools?: Tool[]): void;
+    getToolHandler(name: string): ToolHandler | undefined;
+    /**
+     * Get all events/messages from this session
+     */
+    getMessages(): Promise<SessionEvent[]>;
+    /**
+     * Destroy this session and free resources
+     */
+    destroy(): Promise<void>;
+    /**
+     * Abort the currently processing message in this session
+     */
+    abort(): Promise<void>;
+}

package/dist/session.js

@@ -0,0 +1,83 @@
+class CopilotSession {
+  constructor(sessionId, connection) {
+    this.sessionId = sessionId;
+    this.connection = connection;
+  }
+  eventHandlers = /* @__PURE__ */ new Set();
+  toolHandlers = /* @__PURE__ */ new Map();
+  /**
+   * Send a message to this session
+   */
+  async send(options) {
+    const response = await this.connection.sendRequest("session.send", {
+      sessionId: this.sessionId,
+      prompt: options.prompt,
+      attachments: options.attachments,
+      mode: options.mode
+    });
+    return response.messageId;
+  }
+  /**
+   * Subscribe to events from this session
+   * @returns Unsubscribe function
+   */
+  on(handler) {
+    this.eventHandlers.add(handler);
+    return () => {
+      this.eventHandlers.delete(handler);
+    };
+  }
+  /**
+   * Internal: dispatch an event to all handlers
+   */
+  _dispatchEvent(event) {
+    for (const handler of this.eventHandlers) {
+      try {
+        handler(event);
+      } catch (_error) {
+      }
+    }
+  }
+  registerTools(tools) {
+    this.toolHandlers.clear();
+    if (!tools) {
+      return;
+    }
+    for (const tool of tools) {
+      this.toolHandlers.set(tool.name, tool.handler);
+    }
+  }
+  getToolHandler(name) {
+    return this.toolHandlers.get(name);
+  }
+  /**
+   * Get all events/messages from this session
+   */
+  async getMessages() {
+    const response = await this.connection.sendRequest("session.getMessages", {
+      sessionId: this.sessionId
+    });
+    return response.events;
+  }
+  /**
+   * Destroy this session and free resources
+   */
+  async destroy() {
+    await this.connection.sendRequest("session.destroy", {
+      sessionId: this.sessionId
+    });
+    this.eventHandlers.clear();
+    this.toolHandlers.clear();
+  }
+  /**
+   * Abort the currently processing message in this session
+   */
+  async abort() {
+    await this.connection.sendRequest("session.abort", {
+      sessionId: this.sessionId
+    });
+  }
+}
+export {
+  CopilotSession
+};