@github/copilot-sdk 0.1.33-preview.2 → 0.1.33-preview.4

package/dist/client.d.ts

@@ -47,6 +47,7 @@ export declare class CopilotClient {
     private isExternalServer;
     private forceStopping;
     private onListModels?;
+    private onGetTraceContext?;
     private modelsCache;
     private modelsCacheLock;
     private sessionLifecycleHandlers;
@@ -422,6 +423,7 @@ export declare class CopilotClient {
     private handleSessionLifecycleNotification;
     private handleUserInputRequest;
     private handleHooksInvoke;
+    private handleSystemMessageTransform;
     /**
      * Handles a v2-style tool.call RPC request from the server.
      * Looks up the session and tool handler, executes it, and returns the result

package/dist/client.js

@@ -1,6 +1,7 @@
 import { spawn } from "node:child_process";
 import { randomUUID } from "node:crypto";
 import { existsSync } from "node:fs";
+import { createRequire } from "node:module";
 import { Socket } from "node:net";
 import { dirname, join } from "node:path";
 import { fileURLToPath } from "node:url";
@@ -12,6 +13,7 @@ import {
 import { createServerRpc } from "./generated/rpc.js";
 import { getSdkProtocolVersion } from "./sdkProtocolVersion.js";
 import { CopilotSession, NO_RESULT_PERMISSION_V2_ERROR } from "./session.js";
+import { getTraceContext } from "./telemetry.js";
 const MIN_PROTOCOL_VERSION = 2;
 function isZodSchema(value) {
   return value != null && typeof value === "object" && "toJSONSchema" in value && typeof value.toJSONSchema === "function";
@@ -23,6 +25,30 @@ function toJsonSchema(parameters) {
   }
   return parameters;
 }
+function extractTransformCallbacks(systemMessage) {
+  if (!systemMessage || systemMessage.mode !== "customize" || !systemMessage.sections) {
+    return { wirePayload: systemMessage, transformCallbacks: void 0 };
+  }
+  const transformCallbacks = /* @__PURE__ */ new Map();
+  const wireSections = {};
+  for (const [sectionId, override] of Object.entries(systemMessage.sections)) {
+    if (!override) continue;
+    if (typeof override.action === "function") {
+      transformCallbacks.set(sectionId, override.action);
+      wireSections[sectionId] = { action: "transform" };
+    } else {
+      wireSections[sectionId] = { action: override.action, content: override.content };
+    }
+  }
+  if (transformCallbacks.size === 0) {
+    return { wirePayload: systemMessage, transformCallbacks: void 0 };
+  }
+  const wirePayload = {
+    ...systemMessage,
+    sections: wireSections
+  };
+  return { wirePayload, transformCallbacks };
+}
 function getNodeExecPath() {
   if (process.versions.bun) {
     return "node";
@@ -30,9 +56,22 @@ function getNodeExecPath() {
   return process.execPath;
 }
 function getBundledCliPath() {
-  const sdkUrl = import.meta.resolve("@github/copilot/sdk");
-  const sdkPath = fileURLToPath(sdkUrl);
-  return join(dirname(dirname(sdkPath)), "index.js");
+  if (typeof import.meta.resolve === "function") {
+    const sdkUrl = import.meta.resolve("@github/copilot/sdk");
+    const sdkPath = fileURLToPath(sdkUrl);
+    return join(dirname(dirname(sdkPath)), "index.js");
+  }
+  const req = createRequire(__filename);
+  const searchPaths = req.resolve.paths("@github/copilot") ?? [];
+  for (const base of searchPaths) {
+    const candidate = join(base, "@github", "copilot", "index.js");
+    if (existsSync(candidate)) {
+      return candidate;
+    }
+  }
+  throw new Error(
+    `Could not find @github/copilot package. Searched ${searchPaths.length} paths. Ensure it is installed, or pass cliPath/cliUrl to CopilotClient.`
+  );
 }
 class CopilotClient {
   cliProcess = null;
@@ -48,6 +87,7 @@ class CopilotClient {
   isExternalServer = false;
   forceStopping = false;
   onListModels;
+  onGetTraceContext;
   modelsCache = null;
   modelsCacheLock = Promise.resolve();
   sessionLifecycleHandlers = /* @__PURE__ */ new Set();
@@ -114,6 +154,7 @@ class CopilotClient {
       this.isExternalServer = true;
     }
     this.onListModels = options.onListModels;
+    this.onGetTraceContext = options.onGetTraceContext;
     this.options = {
       cliPath: options.cliUrl ? void 0 : options.cliPath || getBundledCliPath(),
       cliArgs: options.cliArgs ?? [],
@@ -129,7 +170,8 @@ class CopilotClient {
       env: options.env ?? process.env,
       githubToken: options.githubToken,
       // Default useLoggedInUser to false when githubToken is provided, otherwise true
-      useLoggedInUser: options.useLoggedInUser ?? (options.githubToken ? false : true)
+      useLoggedInUser: options.useLoggedInUser ?? (options.githubToken ? false : true),
+      telemetry: options.telemetry
     };
   }
   /**
@@ -382,7 +424,12 @@ class CopilotClient {
       }
     }
     const sessionId = config.sessionId ?? randomUUID();
-    const session = new CopilotSession(sessionId, this.connection);
+    const session = new CopilotSession(
+      sessionId,
+      this.connection,
+      void 0,
+      this.onGetTraceContext
+    );
     session.registerTools(config.tools);
     session.registerPermissionHandler(config.onPermissionRequest);
     if (config.onUserInputRequest) {
@@ -391,12 +438,19 @@ class CopilotClient {
     if (config.hooks) {
       session.registerHooks(config.hooks);
     }
+    const { wirePayload: wireSystemMessage, transformCallbacks } = extractTransformCallbacks(
+      config.systemMessage
+    );
+    if (transformCallbacks) {
+      session.registerTransformCallbacks(transformCallbacks);
+    }
     if (config.onEvent) {
       session.on(config.onEvent);
     }
     this.sessions.set(sessionId, session);
     try {
       const response = await this.connection.sendRequest("session.create", {
+        ...await getTraceContext(this.onGetTraceContext),
         model: config.model,
         sessionId,
         clientName: config.clientName,
@@ -408,7 +462,7 @@ class CopilotClient {
           overridesBuiltInTool: tool.overridesBuiltInTool,
           skipPermission: tool.skipPermission
         })),
-        systemMessage: config.systemMessage,
+        systemMessage: wireSystemMessage,
         availableTools: config.availableTools,
         excludedTools: config.excludedTools,
         provider: config.provider,
@@ -471,7 +525,12 @@ class CopilotClient {
         throw new Error("Client not connected. Call start() first.");
       }
     }
-    const session = new CopilotSession(sessionId, this.connection);
+    const session = new CopilotSession(
+      sessionId,
+      this.connection,
+      void 0,
+      this.onGetTraceContext
+    );
     session.registerTools(config.tools);
     session.registerPermissionHandler(config.onPermissionRequest);
     if (config.onUserInputRequest) {
@@ -480,17 +539,24 @@ class CopilotClient {
     if (config.hooks) {
       session.registerHooks(config.hooks);
     }
+    const { wirePayload: wireSystemMessage, transformCallbacks } = extractTransformCallbacks(
+      config.systemMessage
+    );
+    if (transformCallbacks) {
+      session.registerTransformCallbacks(transformCallbacks);
+    }
     if (config.onEvent) {
       session.on(config.onEvent);
     }
     this.sessions.set(sessionId, session);
     try {
       const response = await this.connection.sendRequest("session.resume", {
+        ...await getTraceContext(this.onGetTraceContext),
         sessionId,
         clientName: config.clientName,
         model: config.model,
         reasoningEffort: config.reasoningEffort,
-        systemMessage: config.systemMessage,
+        systemMessage: wireSystemMessage,
         availableTools: config.availableTools,
         excludedTools: config.excludedTools,
         tools: config.tools?.map((tool) => ({
@@ -829,6 +895,22 @@ class CopilotClient {
           "Path to Copilot CLI is required. Please provide it via the cliPath option, or use cliUrl to rely on a remote CLI."
         );
       }
+      if (this.options.telemetry) {
+        const t = this.options.telemetry;
+        envWithoutNodeDebug.COPILOT_OTEL_ENABLED = "true";
+        if (t.otlpEndpoint !== void 0)
+          envWithoutNodeDebug.OTEL_EXPORTER_OTLP_ENDPOINT = t.otlpEndpoint;
+        if (t.filePath !== void 0)
+          envWithoutNodeDebug.COPILOT_OTEL_FILE_EXPORTER_PATH = t.filePath;
+        if (t.exporterType !== void 0)
+          envWithoutNodeDebug.COPILOT_OTEL_EXPORTER_TYPE = t.exporterType;
+        if (t.sourceName !== void 0)
+          envWithoutNodeDebug.COPILOT_OTEL_SOURCE_NAME = t.sourceName;
+        if (t.captureContent !== void 0)
+          envWithoutNodeDebug.OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT = String(
+            t.captureContent
+          );
+      }
       if (!existsSync(this.options.cliPath)) {
         throw new Error(
           `Copilot CLI not found at ${this.options.cliPath}. Ensure @github/copilot is installed.`
@@ -1032,6 +1114,10 @@ stderr: ${stderrOutput}`
       "hooks.invoke",
       async (params) => await this.handleHooksInvoke(params)
     );
+    this.connection.onRequest(
+      "systemMessage.transform",
+      async (params) => await this.handleSystemMessageTransform(params)
+    );
     this.connection.onClose(() => {
       this.state = "disconnected";
     });
@@ -1095,6 +1181,16 @@ stderr: ${stderrOutput}`
     const output = await session._handleHooksInvoke(params.hookType, params.input);
     return { output };
   }
+  async handleSystemMessageTransform(params) {
+    if (!params || typeof params.sessionId !== "string" || !params.sections || typeof params.sections !== "object") {
+      throw new Error("Invalid systemMessage.transform payload");
+    }
+    const session = this.sessions.get(params.sessionId);
+    if (!session) {
+      throw new Error(`Session not found: ${params.sessionId}`);
+    }
+    return await session._handleSystemMessageTransform(params.sections);
+  }
   // ========================================================================
   // Protocol v2 backward-compatibility adapters
   // ========================================================================
@@ -1123,11 +1219,15 @@ stderr: ${stderrOutput}`
       };
     }
     try {
+      const traceparent = params.traceparent;
+      const tracestate = params.tracestate;
       const invocation = {
         sessionId: params.sessionId,
         toolCallId: params.toolCallId,
         toolName: params.toolName,
-        arguments: params.arguments
+        arguments: params.arguments,
+        traceparent,
+        tracestate
       };
       const result = await handler(params.arguments, invocation);
       return { result: this.normalizeToolResultV2(result) };