@github/copilot-sdk 1.0.11-preview.2 → 1.0.12-preview.0

package/dist/client.js

@@ -3,7 +3,7 @@ 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 { dirname, isAbsolute, join } from "node:path";
 import { fileURLToPath } from "node:url";
 import {
   createMessageConnection,
@@ -194,9 +194,9 @@ function getBundledCliPath() {
   if (typeof import.meta.resolve === "function") {
     for (const packageName of packageNames) {
       try {
-        const sdkUrl = import.meta.resolve(`${packageName}/sdk`);
-        const sdkPath = fileURLToPath(sdkUrl);
-        return join(dirname(dirname(sdkPath)), "index.js");
+        const packageEntryUrl = import.meta.resolve(packageName);
+        const packageEntryPath = fileURLToPath(packageEntryUrl);
+        return join(dirname(packageEntryPath), "index.js");
       } catch {
       }
     }
@@ -268,6 +268,7 @@ class CopilotClient {
   /** Connection-level session filesystem config, set via constructor option. */
   sessionFsConfig = null;
   requestHandler = null;
+  builtinPluginDirectories = [];
   onGitHubTelemetry;
   clientGlobalHandlers = {};
   /**
@@ -396,6 +397,16 @@ class CopilotClient {
     if (options.sessionFs) {
       this.validateSessionFsConfig(options.sessionFs);
     }
+    if (options.builtinPluginDirectories) {
+      for (const path of options.builtinPluginDirectories) {
+        if (!isAbsolute(path)) {
+          throw new Error(
+            `builtinPluginDirectories must contain only absolute paths: ${path}`
+          );
+        }
+      }
+      this.builtinPluginDirectories = [...options.builtinPluginDirectories];
+    }
     if (conn.kind === "uri") {
       const { host, port } = this.parseCliUrl(conn.url);
       this.actualHost = host;
@@ -550,6 +561,16 @@ class CopilotClient {
       }
       await this.connectToServer();
       await this.verifyProtocolVersion();
+      if (this.builtinPluginDirectories.length > 0) {
+        try {
+          await this.connection.sendRequest("plugins.builtin.set", {
+            paths: this.builtinPluginDirectories
+          });
+        } catch (error) {
+          await this.forceStop();
+          throw error;
+        }
+      }
       if (this.sessionFsConfig) {
         await this.connection.sendRequest("sessionFs.setProvider", {
           initialCwd: this.sessionFsConfig.initialCwd,
@@ -1075,7 +1096,7 @@ class CopilotClient {
         canvasProvider: config.canvasProvider,
         commands: config.commands?.map((cmd) => ({
           name: cmd.name,
-          description: cmd.description
+          description: cmd.description ?? ""
         })),
         systemMessage: wireSystemMessage,
         availableTools: toolFilterOptions.availableTools,
@@ -1198,10 +1219,10 @@ class CopilotClient {
     return this.resumeSessionInternal(sessionId, config);
   }
   /** @internal */
-  async resumeSessionForExtension(sessionId, config, factories) {
-    return this.resumeSessionInternal(sessionId, config, factories);
+  async resumeSessionForExtension(sessionId, config, factories, extensionOptions) {
+    return this.resumeSessionInternal(sessionId, config, factories, extensionOptions);
   }
-  async resumeSessionInternal(sessionId, config, factories) {
+  async resumeSessionInternal(sessionId, config, factories, extensionOptions) {
     if (!this.connection) {
       await this.start();
     }
@@ -1298,7 +1319,7 @@ class CopilotClient {
         canvasProvider: config.canvasProvider,
         commands: config.commands?.map((cmd) => ({
           name: cmd.name,
-          description: cmd.description
+          description: cmd.description ?? ""
         })),
         provider: bearerWireProvider,
         capi: config.capi,
@@ -1350,12 +1371,30 @@ class CopilotClient {
         openCanvases: config.openCanvases,
         expAssignments: config.expAssignments,
         enableManagedSettings: config.enableManagedSettings,
-        managedSettings: config.managedSettings
+        managedSettings: config.managedSettings,
+        ...extensionOptions?.requestedEnvironmentVariables ? {
+          requestedEnvironmentVariables: extensionOptions.requestedEnvironmentVariables
+        } : {}
       });
+      if (extensionOptions?.requestedEnvironmentVariables) {
+        const requested = new Set(extensionOptions.requestedEnvironmentVariables);
+        const { grantedEnvironmentVariables } = response;
+        for (const [name, value] of Object.entries(grantedEnvironmentVariables ?? {})) {
+          if (requested.has(name)) {
+            process.env[name] = value;
+          }
+        }
+      }
       const { workspacePath, capabilities, openCanvases } = response;
       session["_workspacePath"] = workspacePath;
       session.setCapabilities(capabilities);
       session.setOpenCanvases(openCanvases ?? []);
+      if (config.mcpServers) {
+        await this.connection.sendRequest("session.mcp.reloadWithConfig", {
+          sessionId,
+          config: { mcpServers: toWireMcpServers(config.mcpServers) }
+        });
+      }
       if (config.onMcpAuthRequest) {
         await this.connection.sendRequest("session.eventLog.registerInterest", {
           sessionId,

package/dist/extension.d.ts

@@ -4,6 +4,35 @@ import type { FactoryHandle } from "./factory.js";
 export { Canvas, CanvasError, createCanvas, type CanvasAction, type CanvasDeclaration, type CanvasHostContext, type CanvasJsonSchema, type CanvasOptions, } from "./canvas.js";
 export type JoinSessionConfig = Omit<ResumeSessionConfig, "onPermissionRequest" | "extensionSdkPath"> & {
     onPermissionRequest?: PermissionHandler;
+    /**
+     * Names of sensitive environment variables this extension needs, such as
+     * `"GITHUB_TOKEN"`.
+     *
+     * The Copilot CLI strips sensitive variables from every extension process
+     * before it starts, so an extension that needs one must ask for it by name.
+     * The CLI prompts the user with the extension's name and the exact list of
+     * variables requested. On approval the granted values are written into this
+     * process's `process.env` before {@link joinSession} resolves, so they are
+     * readable afterwards. On denial the join rejects and the extension does not
+     * load, so its tools never reach the model.
+     *
+     * An approval is remembered against the exact set of names the user saw, so
+     * asking for an additional variable later prompts again. Names that are unset
+     * or that the CLI does not filter from extensions are not prompted for. An
+     * empty list means the same as omitting the option: nothing is requested.
+     *
+     * Requires a Copilot CLI that supports extension environment access; older
+     * CLIs ignore the request and grant nothing.
+     *
+     * @example
+     * ```typescript
+     * const session = await joinSession({
+     *     requestedEnvironmentVariables: ["GITHUB_TOKEN"],
+     * });
+     * const token = process.env.GITHUB_TOKEN;
+     * ```
+     */
+    requestedEnvironmentVariables?: string[];
     /**
      * Factory handles to register when the extension joins the session.
      *

package/dist/extension.js

@@ -23,6 +23,7 @@ async function joinSession(config = {}) {
   const {
     extensionSdkPath: _stripped,
     factories,
+    requestedEnvironmentVariables,
     ...rest
   } = config;
   void _stripped;
@@ -33,7 +34,8 @@ async function joinSession(config = {}) {
       onPermissionRequest: config.onPermissionRequest ?? defaultJoinSessionPermissionHandler,
       suppressResumeEvent: config.suppressResumeEvent ?? true
     },
-    factories
+    factories,
+    requestedEnvironmentVariables?.length ? { requestedEnvironmentVariables } : void 0
   );
 }
 export {

package/dist/factory.d.ts

@@ -17,12 +17,16 @@ export type JsonValue = null | boolean | number | string | JsonValue[] | {
     [key: string]: JsonValue;
 };
 /**
- * Conservative JSON shape language accepted for structured factory agent output.
+ * Conservative JSON shape language accepted by the Agent Factories surface, for
+ * both structured factory agent output and a factory's declared `argsSchema`.
  *
- * This is a best-effort structural guard used to decide whether a subagent's
- * structured output should be accepted or retried — **not** a full JSON Schema
+ * This is a best-effort structural guard — used to decide whether a subagent's
+ * structured output should be accepted or retried, and whether a caller's
+ * factory `args` match the declared shape — **not** a full JSON Schema
  * validator. Only these keywords are honored: `type`, `required`, `enum`,
- * `const`, recursive `properties`/`items`, and `anyOf`/`oneOf`/`allOf`.
+ * `const`, recursive `properties`/`items`, and `anyOf`/`oneOf`/`allOf`. A `type`
+ * is one of `null`, `boolean`, `integer`, `number`, `string`, `array`, or
+ * `object`, or a non-empty array of those (for example `["object", "null"]`).
  *
  * Everything else is **ignored, not enforced**. In particular, string
  * constraints (`pattern`, `minLength`, `maxLength`, `format`), numeric ranges