@github/copilot-sdk 1.0.5 → 1.0.6-preview.0

package/dist/cjs/client.js

@@ -280,7 +280,8 @@ class CopilotClient {
   /** Connection-level session filesystem config, set via constructor option. */
   sessionFsConfig = null;
   requestHandler = null;
-  llmInferenceHandlers = {};
+  onGitHubTelemetry;
+  clientGlobalHandlers = {};
   /**
    * Typed server-scoped RPC methods.
    * @throws Error if the client is not connected
@@ -381,7 +382,8 @@ class CopilotClient {
     this.onGetTraceContext = options.onGetTraceContext;
     this.sessionFsConfig = options.sessionFs ?? null;
     this.requestHandler = options.requestHandler ?? null;
-    this.setupLlmInference();
+    this.onGitHubTelemetry = options.onGitHubTelemetry;
+    this.setupClientGlobalHandlers();
     const effectiveEnv = options.env ?? process.env;
     this.resolvedEnv = effectiveEnv;
     this.resolvedCliPath = conn.kind === "stdio" || conn.kind === "tcp" ? conn.path ?? effectiveEnv.COPILOT_CLI_PATH ?? getBundledCliPath() : void 0;
@@ -461,19 +463,29 @@ class CopilotClient {
     }
     session.clientSessionApis.sessionFs = (0, import_sessionFsProvider.createSessionFsAdapter)(provider);
   }
-  setupLlmInference() {
-    if (!this.requestHandler) {
-      return;
-    }
-    this.llmInferenceHandlers = {
-      llmInference: (0, import_copilotRequestHandler.createCopilotRequestAdapter)(this.requestHandler, () => {
+  setupClientGlobalHandlers() {
+    const handlers = {};
+    if (this.requestHandler) {
+      handlers.llmInference = (0, import_copilotRequestHandler.createCopilotRequestAdapter)(this.requestHandler, () => {
         if (!this.connection) {
           return void 0;
         }
         this._rpc ??= (0, import_rpc.createServerRpc)(this.connection);
         return this._rpc;
-      })
-    };
+      });
+    }
+    if (this.onGitHubTelemetry) {
+      const onGitHubTelemetry = this.onGitHubTelemetry;
+      handlers.gitHubTelemetry = {
+        event: async (notification) => {
+          try {
+            await onGitHubTelemetry(notification);
+          } catch {
+          }
+        }
+      };
+    }
+    this.clientGlobalHandlers = handlers;
   }
   /**
    * Starts the CLI server and establishes a connection.
@@ -1017,6 +1029,7 @@ class CopilotClient {
         workingDirectory: config.workingDirectory,
         streaming: config.streaming,
         includeSubAgentStreamingEvents: config.includeSubAgentStreamingEvents ?? true,
+        ...this.onGitHubTelemetry != null ? { enableGitHubTelemetryForwarding: true } : {},
         mcpServers: toWireMcpServers(config.mcpServers),
         mcpOAuthTokenStorage: config.mcpOAuthTokenStorage,
         envValueMode: "direct",
@@ -1214,6 +1227,7 @@ class CopilotClient {
         enableSkills: config.enableSkills,
         streaming: config.streaming,
         includeSubAgentStreamingEvents: config.includeSubAgentStreamingEvents ?? true,
+        ...this.onGitHubTelemetry != null ? { enableGitHubTelemetryForwarding: true } : {},
         mcpServers: toWireMcpServers(config.mcpServers),
         mcpOAuthTokenStorage: config.mcpOAuthTokenStorage,
         envValueMode: "direct",
@@ -1879,7 +1893,7 @@ stderr: ${stderrOutput}`
       if (!session) throw new Error(`No session found for sessionId: ${sessionId}`);
       return session.clientSessionApis;
     });
-    (0, import_rpc.registerClientGlobalApiHandlers)(this.connection, this.llmInferenceHandlers);
+    (0, import_rpc.registerClientGlobalApiHandlers)(this.connection, this.clientGlobalHandlers);
     this.connection.onClose(() => {
       this.state = "disconnected";
     });

package/dist/cjs/generated/rpc.js

@@ -2086,10 +2086,10 @@ function registerClientGlobalApiHandlers(connection, handlers) {
     if (!handler) throw new Error("No llmInference client-global handler registered");
     return handler.httpRequestChunk(params);
   });
-  connection.onRequest("gitHubTelemetry.event", async (params) => {
+  connection.onNotification("gitHubTelemetry.event", async (params) => {
     const handler = handlers.gitHubTelemetry;
-    if (!handler) throw new Error("No gitHubTelemetry client-global handler registered");
-    return handler.event(params);
+    if (!handler) return;
+    await handler.event(params);
   });
 }
 // Annotate the CommonJS export names for ESM import in node:

package/dist/client.d.ts

@@ -36,7 +36,8 @@ export declare class CopilotClient {
     /** Connection-level session filesystem config, set via constructor option. */
     private sessionFsConfig;
     private requestHandler;
-    private llmInferenceHandlers;
+    private onGitHubTelemetry?;
+    private clientGlobalHandlers;
     /**
      * Typed server-scoped RPC methods.
      * @throws Error if the client is not connected
@@ -80,7 +81,7 @@ export declare class CopilotClient {
     private parseCliUrl;
     private validateSessionFsConfig;
     private setupSessionFs;
-    private setupLlmInference;
+    private setupClientGlobalHandlers;
     /**
      * Starts the CLI server and establishes a connection.
      *

package/dist/client.js

@@ -267,7 +267,8 @@ class CopilotClient {
   /** Connection-level session filesystem config, set via constructor option. */
   sessionFsConfig = null;
   requestHandler = null;
-  llmInferenceHandlers = {};
+  onGitHubTelemetry;
+  clientGlobalHandlers = {};
   /**
    * Typed server-scoped RPC methods.
    * @throws Error if the client is not connected
@@ -368,7 +369,8 @@ class CopilotClient {
     this.onGetTraceContext = options.onGetTraceContext;
     this.sessionFsConfig = options.sessionFs ?? null;
     this.requestHandler = options.requestHandler ?? null;
-    this.setupLlmInference();
+    this.onGitHubTelemetry = options.onGitHubTelemetry;
+    this.setupClientGlobalHandlers();
     const effectiveEnv = options.env ?? process.env;
     this.resolvedEnv = effectiveEnv;
     this.resolvedCliPath = conn.kind === "stdio" || conn.kind === "tcp" ? conn.path ?? effectiveEnv.COPILOT_CLI_PATH ?? getBundledCliPath() : void 0;
@@ -448,19 +450,29 @@ class CopilotClient {
     }
     session.clientSessionApis.sessionFs = createSessionFsAdapter(provider);
   }
-  setupLlmInference() {
-    if (!this.requestHandler) {
-      return;
-    }
-    this.llmInferenceHandlers = {
-      llmInference: createCopilotRequestAdapter(this.requestHandler, () => {
+  setupClientGlobalHandlers() {
+    const handlers = {};
+    if (this.requestHandler) {
+      handlers.llmInference = createCopilotRequestAdapter(this.requestHandler, () => {
         if (!this.connection) {
           return void 0;
         }
         this._rpc ??= createServerRpc(this.connection);
         return this._rpc;
-      })
-    };
+      });
+    }
+    if (this.onGitHubTelemetry) {
+      const onGitHubTelemetry = this.onGitHubTelemetry;
+      handlers.gitHubTelemetry = {
+        event: async (notification) => {
+          try {
+            await onGitHubTelemetry(notification);
+          } catch {
+          }
+        }
+      };
+    }
+    this.clientGlobalHandlers = handlers;
   }
   /**
    * Starts the CLI server and establishes a connection.
@@ -1004,6 +1016,7 @@ class CopilotClient {
         workingDirectory: config.workingDirectory,
         streaming: config.streaming,
         includeSubAgentStreamingEvents: config.includeSubAgentStreamingEvents ?? true,
+        ...this.onGitHubTelemetry != null ? { enableGitHubTelemetryForwarding: true } : {},
         mcpServers: toWireMcpServers(config.mcpServers),
         mcpOAuthTokenStorage: config.mcpOAuthTokenStorage,
         envValueMode: "direct",
@@ -1201,6 +1214,7 @@ class CopilotClient {
         enableSkills: config.enableSkills,
         streaming: config.streaming,
         includeSubAgentStreamingEvents: config.includeSubAgentStreamingEvents ?? true,
+        ...this.onGitHubTelemetry != null ? { enableGitHubTelemetryForwarding: true } : {},
         mcpServers: toWireMcpServers(config.mcpServers),
         mcpOAuthTokenStorage: config.mcpOAuthTokenStorage,
         envValueMode: "direct",
@@ -1866,7 +1880,7 @@ stderr: ${stderrOutput}`
       if (!session) throw new Error(`No session found for sessionId: ${sessionId}`);
       return session.clientSessionApis;
     });
-    registerClientGlobalApiHandlers(this.connection, this.llmInferenceHandlers);
+    registerClientGlobalApiHandlers(this.connection, this.clientGlobalHandlers);
     this.connection.onClose(() => {
       this.state = "disconnected";
     });

package/dist/generated/rpc.js

@@ -2058,10 +2058,10 @@ function registerClientGlobalApiHandlers(connection, handlers) {
     if (!handler) throw new Error("No llmInference client-global handler registered");
     return handler.httpRequestChunk(params);
   });
-  connection.onRequest("gitHubTelemetry.event", async (params) => {
+  connection.onNotification("gitHubTelemetry.event", async (params) => {
     const handler = handlers.gitHubTelemetry;
-    if (!handler) throw new Error("No gitHubTelemetry client-global handler registered");
-    return handler.event(params);
+    if (!handler) return;
+    await handler.event(params);
   });
 }
 export {

package/dist/index.d.ts

@@ -10,4 +10,4 @@ export { CopilotSession, type AssistantMessageEvent } from "./session.js";
 export { Canvas, CanvasError, createCanvas, type CanvasAction, type CanvasDeclaration, type CanvasHostContext, type CanvasHostContextCapabilities, type CanvasJsonSchema, type CanvasOptions, } from "./canvas.js";
 export { defineTool, approveAll, convertMcpCallToolResult, createSessionFsAdapter, CopilotRequestHandler, CopilotWebSocketHandler, CopilotWebSocketCloseStatus, CopilotWebSocketForwarder, SYSTEM_MESSAGE_SECTIONS, } from "./types.js";
 export type * from "./generated/session-events.js";
-export type { CommandContext, CommandDefinition, CommandHandler, CloudSessionOptions, CloudSessionRepository, AutoModeSwitchHandler, AutoModeSwitchRequest, AutoModeSwitchResponse, CopilotClientMode, CopilotClientOptions, StdioRuntimeConnection, TcpRuntimeConnection, UriRuntimeConnection, CustomAgentConfig, ElicitationFieldValue, ElicitationHandler, ElicitationParams, ElicitationContext, ElicitationResult, ElicitationSchema, ElicitationSchemaField, ExitPlanModeHandler, ExitPlanModeRequest, ExitPlanModeResult, ExtensionInfo, ForegroundSessionInfo, GetAuthStatusResponse, GetStatusResponse, InfiniteSessionConfig, LargeToolOutputConfig, MemoryConfiguration, UiInputOptions, MCPStdioServerConfig, MCPHTTPServerConfig, MCPServerConfig, DefaultAgentConfig, BearerTokenProvider, MessageOptions, ModelBilling, ModelBillingTokenPrices, ModelBillingTokenPricesLongContext, CapiSessionOptions, ModelCapabilities, ModelCapabilitiesOverride, ModelInfo, ModelPolicy, NamedProviderConfig, PermissionHandler, PermissionRequest, PermissionRequestResult, ProviderConfig, ProviderModelConfig, ProviderTokenArgs, RemoteSessionMode, ResumeSessionConfig, SectionOverride, SectionOverrideAction, SectionTransformFn, SessionCapabilities, SessionConfig, SessionConfigBase, SessionEvent, SessionEventHandler, SessionEventPayload, SessionEventType, SessionLifecycleEvent, SessionLifecycleEventMetadata, SessionLifecycleEventType, SessionLifecycleHandler, SessionCreatedEvent, SessionDeletedEvent, SessionUpdatedEvent, SessionForegroundEvent, SessionBackgroundEvent, SessionContext, SessionListFilter, SessionMetadata, SessionUiApi, SessionFsConfig, SessionFsProvider, SessionFsFileInfo, SessionFsSqliteQueryResult, SessionFsSqliteQueryType, SessionFsSqliteProvider, CopilotRequestContext, SystemMessageAppendConfig, SystemMessageConfig, SystemMessageCustomizeConfig, SystemMessageReplaceConfig, SystemMessageSection, TelemetryConfig, TraceContext, TraceContextProvider, Tool, ToolHandler, ToolInvocation, ToolTelemetry, ToolResultObject, TypedSessionEventHandler, TypedSessionLifecycleHandler, ZodSchema, } from "./types.js";
+export type { CommandContext, CommandDefinition, CommandHandler, CloudSessionOptions, CloudSessionRepository, AutoModeSwitchHandler, AutoModeSwitchRequest, AutoModeSwitchResponse, CopilotClientMode, CopilotClientOptions, StdioRuntimeConnection, TcpRuntimeConnection, UriRuntimeConnection, CustomAgentConfig, ElicitationFieldValue, ElicitationHandler, ElicitationParams, ElicitationContext, ElicitationResult, ElicitationSchema, ElicitationSchemaField, ExitPlanModeHandler, ExitPlanModeRequest, ExitPlanModeResult, ExtensionInfo, ForegroundSessionInfo, GetAuthStatusResponse, GetStatusResponse, GitHubTelemetryNotification, GitHubTelemetryEvent, GitHubTelemetryClientInfo, InfiniteSessionConfig, LargeToolOutputConfig, MemoryConfiguration, UiInputOptions, MCPStdioServerConfig, MCPHTTPServerConfig, MCPServerConfig, DefaultAgentConfig, BearerTokenProvider, MessageOptions, ModelBilling, ModelBillingTokenPrices, ModelBillingTokenPricesLongContext, CapiSessionOptions, ModelCapabilities, ModelCapabilitiesOverride, ModelInfo, ModelPolicy, NamedProviderConfig, PermissionHandler, PermissionRequest, PermissionRequestResult, ProviderConfig, ProviderModelConfig, ProviderTokenArgs, RemoteSessionMode, ResumeSessionConfig, SectionOverride, SectionOverrideAction, SectionTransformFn, SessionCapabilities, SessionConfig, SessionConfigBase, SessionEvent, SessionEventHandler, SessionEventPayload, SessionEventType, SessionLifecycleEvent, SessionLifecycleEventMetadata, SessionLifecycleEventType, SessionLifecycleHandler, SessionCreatedEvent, SessionDeletedEvent, SessionUpdatedEvent, SessionForegroundEvent, SessionBackgroundEvent, SessionContext, SessionListFilter, SessionMetadata, SessionUiApi, SessionFsConfig, SessionFsProvider, SessionFsFileInfo, SessionFsSqliteQueryResult, SessionFsSqliteQueryType, SessionFsSqliteProvider, CopilotRequestContext, SystemMessageAppendConfig, SystemMessageConfig, SystemMessageCustomizeConfig, SystemMessageReplaceConfig, SystemMessageSection, TelemetryConfig, TraceContext, TraceContextProvider, Tool, ToolHandler, ToolInvocation, ToolTelemetry, ToolResultObject, TypedSessionEventHandler, TypedSessionLifecycleHandler, ZodSchema, } from "./types.js";

package/dist/types.d.ts

@@ -6,9 +6,10 @@ import type { SessionFsProvider } from "./sessionFsProvider.js";
 import type { CopilotRequestHandler } from "./copilotRequestHandler.js";
 import type { ReasoningSummary, SessionLimitsConfig, SessionEvent as GeneratedSessionEvent } from "./generated/session-events.js";
 import type { CopilotSession } from "./session.js";
-import type { ModelBillingTokenPrices, OpenCanvasInstance, RemoteSessionMode } from "./generated/rpc.js";
+import type { GitHubTelemetryNotification, ModelBillingTokenPrices, OpenCanvasInstance, RemoteSessionMode } from "./generated/rpc.js";
 import type { ToolSet } from "./toolSet.js";
 export type { RemoteSessionMode } from "./generated/rpc.js";
+export type { GitHubTelemetryNotification, GitHubTelemetryEvent, GitHubTelemetryClientInfo, } from "./generated/rpc.js";
 export type { ModelBillingTokenPrices, ModelBillingTokenPricesLongContext, } from "./generated/rpc.js";
 export type SessionEvent = GeneratedSessionEvent;
 export type { ReasoningSummary } from "./generated/session-events.js";
@@ -270,6 +271,17 @@ export interface CopilotClientOptions {
      * @experimental
      */
     requestHandler?: CopilotRequestHandler;
+    /**
+     * Experimental. Receives GitHub telemetry events the runtime forwards to
+     * this connection. When set, the client opts each session it creates or
+     * resumes into telemetry forwarding and dispatches each
+     * `gitHubTelemetry.event` notification to this connection-global handler;
+     * each {@link GitHubTelemetryNotification} carries its originating
+     * `sessionId`.
+     *
+     * @experimental
+     */
+    onGitHubTelemetry?: (notification: GitHubTelemetryNotification) => void | Promise<void>;
     /**
      * Server-wide idle timeout for sessions in seconds.
      * Sessions without activity for this duration are automatically cleaned up.

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/github/copilot-sdk.git"
   },
-  "version": "1.0.5",
+  "version": "1.0.6-preview.0",
   "description": "TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC",
   "main": "./dist/cjs/index.js",
   "types": "./dist/index.d.ts",