@github/copilot-sdk 1.0.13-preview.3 → 1.0.13-preview.6

package/dist/runtimeArtifacts.js

@@ -0,0 +1,232 @@
+import {
+  chmodSync,
+  copyFileSync,
+  existsSync,
+  lstatSync,
+  mkdirSync,
+  mkdtempSync,
+  readdirSync,
+  renameSync,
+  rmSync,
+  statSync
+} from "node:fs";
+import { createHash } from "node:crypto";
+import { createRequire } from "node:module";
+import { homedir } from "node:os";
+import { dirname, join, relative, sep } from "node:path";
+import { COPILOT_CLI_USE_NPM_PACKAGE } from "./cliVersion.js";
+const require2 = createRequire(typeof __filename === "string" ? __filename : import.meta.url);
+const RUNTIME_PLATFORMS = [
+  "darwin-arm64",
+  "darwin-x64",
+  "linux-arm64",
+  "linux-x64",
+  "linuxmusl-arm64",
+  "linuxmusl-x64",
+  "win32-arm64",
+  "win32-x64"
+];
+const EXCLUDED_TOP_LEVEL = /* @__PURE__ */ new Set([
+  "app.js",
+  "assets",
+  "changelog.json",
+  "copilot",
+  "copilot.exe",
+  "foundry-local-sdk",
+  "index.js",
+  "LICENSE.md",
+  "napi-oop-runtime",
+  "npm-loader.js",
+  "package.json",
+  "pvrecorder",
+  "queries",
+  "README.md",
+  "sea-loader.js",
+  "webview"
+]);
+function validateFile(path, label) {
+  if (!existsSync(path)) {
+    throw new Error(`${label} not found at ${path}.`);
+  }
+  if (statSync(path).size === 0) {
+    throw new Error(`${label} at ${path} is empty.`);
+  }
+}
+function validateRuntimeBundle(wrapper, runtimeNode) {
+  validateFile(wrapper, "Copilot runtime wrapper");
+  validateFile(runtimeNode, "Copilot runtime.node");
+}
+function isExcluded(relativePath) {
+  const parts = relativePath.split(sep);
+  const topLevel = parts[0];
+  const fileName = parts.at(-1) ?? "";
+  return EXCLUDED_TOP_LEVEL.has(topLevel) || /^tree-sitter.*\.wasm$/.test(topLevel) || /^voice-.*\.js$/.test(topLevel) || fileName === "cli-native.node" || parts.includes("mediaremote-adapter") || fileName.startsWith("copilot-runtime-bin");
+}
+function collectRuntimeAssets(sources) {
+  const assets = [];
+  const visit = (directory) => {
+    for (const entry of readdirSync(directory, { withFileTypes: true })) {
+      const source = join(directory, entry.name);
+      const sourceRelative = relative(sources.packageRoot, source);
+      if (isExcluded(sourceRelative)) {
+        continue;
+      }
+      if (entry.isDirectory()) {
+        visit(source);
+        continue;
+      }
+      if (!entry.isFile() && !entry.isSymbolicLink()) {
+        continue;
+      }
+      const parts = sourceRelative.split(sep);
+      if (parts[0] === "prebuilds") {
+        if (parts[1] !== sources.platform || parts.length < 3) {
+          continue;
+        }
+      }
+      assets.push({ source, relativePath: sourceRelative });
+    }
+  };
+  visit(sources.packageRoot);
+  return assets.sort((left, right) => left.relativePath.localeCompare(right.relativePath));
+}
+function sourceFingerprint(assets) {
+  const hash = createHash("sha256");
+  for (const asset of assets) {
+    const stat = lstatSync(asset.source);
+    hash.update(asset.relativePath).update("\0");
+    hash.update(`${stat.size}:${stat.mtimeMs}`).update("\0");
+  }
+  return hash.digest("hex").slice(0, 20);
+}
+function makeExecutable(path) {
+  if (process.platform === "win32") {
+    return;
+  }
+  const mode = statSync(path).mode;
+  if ((mode & 73) === 0) {
+    chmodSync(path, mode | 73);
+  }
+}
+function defaultRuntimeCacheRoot(platform = process.platform, home = homedir(), environment = process.env) {
+  const cacheDirectory = platform === "win32" ? environment.LOCALAPPDATA ?? join(home, "AppData", "Local") : platform === "darwin" ? join(home, "Library", "Caches") : environment.XDG_CACHE_HOME ?? join(home, ".cache");
+  return join(cacheDirectory, "github-copilot-sdk", "runtime");
+}
+function materializeRuntimeBundle(sources, cacheRoot = defaultRuntimeCacheRoot(), cacheKey = `${sources.platform}-${sourceFingerprint(collectRuntimeAssets(sources))}`) {
+  const assets = collectRuntimeAssets(sources);
+  const wrapperName = sources.platform.startsWith("win32") ? "copilot-runtime.exe" : "copilot-runtime";
+  const prebuildDir = join("prebuilds", sources.platform);
+  const wrapperRelative = join(prebuildDir, wrapperName);
+  const runtimeNodeRelative = join(prebuildDir, "runtime.node");
+  const sourceWrapper = assets.find((asset) => asset.relativePath === wrapperRelative)?.source;
+  const sourceRuntimeNode = assets.find(
+    (asset) => asset.relativePath === runtimeNodeRelative
+  )?.source;
+  validateRuntimeBundle(sourceWrapper ?? "", sourceRuntimeNode ?? "");
+  const installDir = join(cacheRoot, cacheKey);
+  const installedWrapper = join(installDir, wrapperRelative);
+  const installedRuntimeNode = join(installDir, runtimeNodeRelative);
+  if (existsSync(installDir)) {
+    validateRuntimeBundle(installedWrapper, installedRuntimeNode);
+    makeExecutable(installedWrapper);
+    return installedWrapper;
+  }
+  mkdirSync(cacheRoot, { recursive: true });
+  const stagingDir = mkdtempSync(join(cacheRoot, ".runtime-"));
+  try {
+    for (const asset of assets) {
+      const destination = join(stagingDir, asset.relativePath);
+      mkdirSync(dirname(destination), { recursive: true });
+      copyFileSync(asset.source, destination);
+    }
+    const stagedWrapper = join(stagingDir, wrapperRelative);
+    makeExecutable(stagedWrapper);
+    renameSync(stagingDir, installDir);
+  } catch (error) {
+    if (!existsSync(installDir)) {
+      throw error;
+    }
+    validateRuntimeBundle(installedWrapper, installedRuntimeNode);
+  } finally {
+    rmSync(stagingDir, { recursive: true, force: true });
+  }
+  return installedWrapper;
+}
+function isMusl() {
+  if (process.platform !== "linux") {
+    return false;
+  }
+  const report = process.report?.getReport();
+  return report?.header?.glibcVersionRuntime === void 0;
+}
+function getRuntimePlatform(platform = process.platform, arch = process.arch, musl = isMusl()) {
+  if (arch !== "x64" && arch !== "arm64") {
+    throw new Error(`Unsupported Copilot CLI architecture: ${arch}.`);
+  }
+  if (platform === "linux") {
+    return `${musl ? "linuxmusl" : "linux"}-${arch}`;
+  }
+  if (platform === "darwin" || platform === "win32") {
+    return `${platform}-${arch}`;
+  }
+  throw new Error(`Unsupported Copilot CLI platform: ${platform}-${arch}.`);
+}
+function getRuntimeReleaseAssetName(version, platform) {
+  return `github-copilot-${version}-${platform}.tgz`;
+}
+function getRuntimePackageName(platform) {
+  return `@github/copilot-sdk-${platform}`;
+}
+function resolvePackageRoot(packageName, searchPaths = require2.resolve.paths(packageName) ?? []) {
+  return searchPaths.map((base) => join(base, ...packageName.split("/"))).find((candidate) => existsSync(join(candidate, "package.json")));
+}
+async function ensureRuntimeBundle(version, options = {}) {
+  const platform = options.platform ?? getRuntimePlatform();
+  if (COPILOT_CLI_USE_NPM_PACKAGE) {
+    const packageName2 = `@github/copilot-${platform}`;
+    const packageRoot2 = resolvePackageRoot(packageName2, options.packageSearchPaths);
+    if (!packageRoot2) {
+      throw new Error(`Could not resolve ${packageName2} for Copilot CLI ${version}.`);
+    }
+    validateFile(
+      join(packageRoot2, "prebuilds", platform, "runtime.node"),
+      "Copilot runtime.node"
+    );
+    return materializeRuntimeBundle(
+      { packageRoot: packageRoot2, platform },
+      options.cacheRoot,
+      `${version}-${platform}`
+    );
+  }
+  const packageName = getRuntimePackageName(platform);
+  const packageRoot = resolvePackageRoot(packageName, options.packageSearchPaths);
+  if (!packageRoot) {
+    throw new Error(
+      `Could not resolve ${packageName}. Reinstall @github/copilot-sdk so its platform package is installed.`
+    );
+  }
+  const wrapperName = platform.startsWith("win32") ? "copilot-runtime.exe" : "copilot-runtime";
+  const prebuildDir = join(packageRoot, "prebuilds", platform);
+  const wrapper = join(prebuildDir, wrapperName);
+  try {
+    validateRuntimeBundle(wrapper, join(prebuildDir, "runtime.node"));
+  } catch (error) {
+    throw new Error(
+      `${packageName} is missing required Copilot CLI runtime files. Reinstall @github/copilot-sdk.`,
+      { cause: error }
+    );
+  }
+  makeExecutable(wrapper);
+  return wrapper;
+}
+export {
+  RUNTIME_PLATFORMS,
+  defaultRuntimeCacheRoot,
+  ensureRuntimeBundle,
+  getRuntimePackageName,
+  getRuntimePlatform,
+  getRuntimeReleaseAssetName,
+  materializeRuntimeBundle,
+  resolvePackageRoot,
+  validateFile
+};

package/dist/types.d.ts

@@ -4,7 +4,7 @@
 import type { Canvas } from "./canvas.js";
 import type { SessionFsProvider } from "./sessionFsProvider.js";
 import type { CopilotRequestHandler } from "./copilotRequestHandler.js";
-import type { PermissionRequest as GeneratedPermissionRequest, PermissionRequestedData as GeneratedPermissionRequestedData, PermissionRequestedEvent as GeneratedPermissionRequestedEvent, ReasoningSummary, SessionLimitsConfig, SessionEvent as GeneratedSessionEvent } from "./generated/session-events.js";
+import type { AutoTier, PermissionRequest as GeneratedPermissionRequest, PermissionRequestedData as GeneratedPermissionRequestedData, PermissionRequestedEvent as GeneratedPermissionRequestedEvent, ReasoningSummary, SessionLimitsConfig, SessionEvent as GeneratedSessionEvent } from "./generated/session-events.js";
 import type { CopilotSession } from "./session.js";
 import type { FactoryJsonSchema, JsonValue } from "./factory.js";
 import type { GitHubTokenAcquireRequest, GitHubTokenAcquireResult, GitHubTelemetryNotification, ModelBillingTokenPrices, OpenCanvasInstance, RemoteSessionMode, CurrentToolMetadata } from "./generated/rpc.js";
@@ -34,7 +34,7 @@ export type { ModelBillingTokenPrices, ModelBillingTokenPricesLongContext, } fro
 export type SessionEvent = Exclude<GeneratedSessionEvent, {
     type: "permission.requested";
 }> | PermissionRequestedEvent;
-export type { ReasoningSummary } from "./generated/session-events.js";
+export type { AutoTier, ReasoningSummary } from "./generated/session-events.js";
 export type { SessionFsProvider } from "./sessionFsProvider.js";
 export { createSessionFsAdapter } from "./sessionFsProvider.js";
 export type { SessionFsFileInfo } from "./sessionFsProvider.js";
@@ -216,6 +216,33 @@ export declare const RuntimeConnection: {
  *   ambient behavior is unsafe (e.g. multi-user servers).
  */
 export type CopilotClientMode = "empty" | "copilot-cli";
+/**
+ * Identity of the integrating application, declared once on the `server.connect`
+ * handshake so the telemetry the runtime emits on this connection is attributed
+ * to a single, consistent surface rather than to the runtime's own build.
+ *
+ * All fields are optional; omit any of them (or the whole object) to keep the
+ * runtime's default attribution. Version fields are ignored by the runtime
+ * unless they look like a version string.
+ */
+export interface CopilotClientInfo {
+    /**
+     * Name of the application using the SDK, e.g. `"acme-developer-portal"`.
+     */
+    applicationName?: string;
+    /**
+     * Version of the application using the SDK, e.g. `"2.4.0"`.
+     */
+    applicationVersion?: string;
+    /**
+     * Optional name of a specific integration within the application, such as an extension or plugin.
+     */
+    integrationName?: string;
+    /**
+     * Optional version of the integration identified by `integrationName`.
+     */
+    integrationVersion?: string;
+}
 export interface CopilotClientOptions {
     /**
      * How to connect to the Copilot runtime. When omitted, defaults to
@@ -370,6 +397,15 @@ export interface CopilotClientOptions {
      * @default false
      */
     enableRemoteSessions?: boolean;
+    /**
+     * Identity of the integrating application, forwarded to the runtime on the
+     * `server.connect` handshake. Declaring it lets the telemetry the runtime
+     * emits on this connection be attributed to a single, consistent surface
+     * (e.g. the application and its Copilot integration) instead of the
+     * runtime's own build. All fields are optional; omit it to keep the default
+     * attribution.
+     */
+    clientInfo?: CopilotClientInfo;
 }
 /**
  * Configuration for creating a session
@@ -1705,6 +1741,16 @@ export interface FactoryMeta {
  * provider-level choices are conceptually per-provider rather than global.
  */
 export interface CapiSessionOptions {
+    /**
+     * Routing preference used when the session model is `auto`.
+     * Requires a runtime with Auto tier support and V2 Auto routing.
+     *
+     * When omitted on create, the runtime uses its default routing behavior.
+     * The runtime persists this preference across cold resume; an explicit tier
+     * on cold resume overrides the persisted value. For an already-resident
+     * session, omission preserves the current tier and a different tier is rejected.
+     */
+    autoTier?: AutoTier;
     /**
      * Whether to use the WebSocket transport for the CAPI Responses API.
      *
@@ -2375,6 +2421,11 @@ export interface SessionConfigBase {
      * only if {@link CopilotClientOptions.sessionFs} is configured.
      */
     createSessionFsProvider?: (session: CopilotSession) => SessionFsProvider;
+    /**
+     * Feature-flag values resolved by the host for this session.
+     * Re-supply them when resuming after a runtime restart.
+     */
+    featureFlags?: Record<string, boolean>;
 }
 /**
  * Configuration for creating a new session via {@link CopilotClient.createSession}.

package/package.json

@@ -1,92 +1,107 @@
 {
-  "name": "@github/copilot-sdk",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/github/copilot-sdk.git"
-  },
-  "version": "1.0.13-preview.3",
-  "description": "TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC",
-  "main": "./dist/cjs/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      },
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/cjs/index.js"
-      }
+    "name": "@github/copilot-sdk",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/github/copilot-sdk.git"
     },
-    "./extension": {
-      "import": {
-        "types": "./dist/extension.d.ts",
-        "default": "./dist/extension.js"
-      },
-      "require": {
-        "types": "./dist/extension.d.ts",
-        "default": "./dist/cjs/extension.js"
-      }
+    "version": "1.0.13-preview.6",
+    "copilotCliVersion": "1.0.83-3",
+    "description": "TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC",
+    "main": "./dist/cjs/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "import": {
+                "types": "./dist/index.d.ts",
+                "default": "./dist/index.js"
+            },
+            "require": {
+                "types": "./dist/index.d.ts",
+                "default": "./dist/cjs/index.js"
+            }
+        },
+        "./extension": {
+            "import": {
+                "types": "./dist/extension.d.ts",
+                "default": "./dist/extension.js"
+            },
+            "require": {
+                "types": "./dist/extension.d.ts",
+                "default": "./dist/cjs/extension.js"
+            }
+        }
+    },
+    "type": "module",
+    "scripts": {
+        "clean": "rimraf --glob dist *.tgz",
+        "build": "tsx esbuild-copilotsdk-nodejs.ts",
+        "pack:release": "tsx scripts/package-sdk.ts",
+        "verify:release-packages": "tsx scripts/verify-release-packages.ts",
+        "prepare:runtime": "tsx scripts/prepare-runtime.ts",
+        "test": "vitest run",
+        "test:watch": "vitest",
+        "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\" --ignore-path .prettierignore",
+        "format:check": "prettier --check \"src/**/*.ts\" \"test/**/*.ts\" --ignore-path .prettierignore",
+        "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\"",
+        "lint:fix": "eslint --fix \"src/**/*.ts\" \"test/**/*.ts\"",
+        "typecheck": "tsc --noEmit && tsc --noEmit -p tsconfig.test.json",
+        "generate": "cd ../scripts/codegen && npm run generate",
+        "set:cli-version": "node scripts/set-cli-version.js",
+        "update:protocol-version": "tsx scripts/update-protocol-version.ts",
+        "prepublishOnly": "npm run build",
+        "package": "npm run clean && npm run build && node scripts/set-version.js && npm run pack:release && npm version 0.0.0-dev --no-git-tag-version --allow-same-version"
+    },
+    "keywords": [
+        "github",
+        "copilot",
+        "sdk",
+        "jsonrpc",
+        "agent"
+    ],
+    "author": "GitHub",
+    "license": "MIT",
+    "dependencies": {
+        "koffi": "^3.1.0",
+        "vscode-jsonrpc": "^8.2.1",
+        "zod": "^4.3.6"
+    },
+    "devDependencies": {
+        "@platformatic/vfs": "^0.3.0",
+        "@types/node": "^25.2.0",
+        "@types/ws": "^8.18.1",
+        "@typescript-eslint/eslint-plugin": "^8.54.0",
+        "@typescript-eslint/parser": "^8.54.0",
+        "esbuild": "^0.28.1",
+        "eslint": "^9.0.0",
+        "glob": "^13.0.1",
+        "json-schema": "^0.4.0",
+        "json-schema-to-typescript": "^15.0.4",
+        "prettier": "^3.8.1",
+        "quicktype-core": "^23.2.6",
+        "rimraf": "^6.1.2",
+        "semver": "^7.7.3",
+        "tar": "^7.5.22",
+        "tsx": "^4.20.6",
+        "typescript": "^5.0.0",
+        "vitest": "^4.0.18",
+        "ws": "^8.21.0"
+    },
+    "engines": {
+        "node": "^20.19.0 || >=22.12.0"
+    },
+    "files": [
+        "dist/**/*",
+        "docs/**/*",
+        "README.md"
+    ],
+    "optionalDependencies": {
+        "@github/copilot-sdk-darwin-arm64": "1.0.13-preview.6",
+        "@github/copilot-sdk-darwin-x64": "1.0.13-preview.6",
+        "@github/copilot-sdk-linux-arm64": "1.0.13-preview.6",
+        "@github/copilot-sdk-linux-x64": "1.0.13-preview.6",
+        "@github/copilot-sdk-linuxmusl-arm64": "1.0.13-preview.6",
+        "@github/copilot-sdk-linuxmusl-x64": "1.0.13-preview.6",
+        "@github/copilot-sdk-win32-arm64": "1.0.13-preview.6",
+        "@github/copilot-sdk-win32-x64": "1.0.13-preview.6"
     }
-  },
-  "type": "module",
-  "scripts": {
-    "clean": "rimraf --glob dist *.tgz",
-    "build": "tsx esbuild-copilotsdk-nodejs.ts",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\" --ignore-path .prettierignore",
-    "format:check": "prettier --check \"src/**/*.ts\" \"test/**/*.ts\" --ignore-path .prettierignore",
-    "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\"",
-    "lint:fix": "eslint --fix \"src/**/*.ts\" \"test/**/*.ts\"",
-    "typecheck": "tsc --noEmit && tsc --noEmit -p tsconfig.test.json",
-    "generate": "cd ../scripts/codegen && npm run generate",
-    "update:protocol-version": "tsx scripts/update-protocol-version.ts",
-    "prepublishOnly": "npm run build",
-    "package": "npm run clean && npm run build && node scripts/set-version.js && npm pack && npm version 0.0.0-dev --no-git-tag-version --allow-same-version"
-  },
-  "keywords": [
-    "github",
-    "copilot",
-    "sdk",
-    "jsonrpc",
-    "agent"
-  ],
-  "author": "GitHub",
-  "license": "MIT",
-  "dependencies": {
-    "@github/copilot": "^1.0.83-0",
-    "koffi": "^3.1.0",
-    "vscode-jsonrpc": "^8.2.1",
-    "zod": "^4.3.6"
-  },
-  "devDependencies": {
-    "@platformatic/vfs": "^0.3.0",
-    "@types/node": "^25.2.0",
-    "@types/ws": "^8.18.1",
-    "@typescript-eslint/eslint-plugin": "^8.54.0",
-    "@typescript-eslint/parser": "^8.54.0",
-    "esbuild": "^0.28.1",
-    "eslint": "^9.0.0",
-    "glob": "^13.0.1",
-    "json-schema": "^0.4.0",
-    "json-schema-to-typescript": "^15.0.4",
-    "prettier": "^3.8.1",
-    "quicktype-core": "^23.2.6",
-    "rimraf": "^6.1.2",
-    "semver": "^7.7.3",
-    "tsx": "^4.20.6",
-    "typescript": "^5.0.0",
-    "vitest": "^4.0.18",
-    "ws": "^8.21.0"
-  },
-  "engines": {
-    "node": "^20.19.0 || >=22.12.0"
-  },
-  "files": [
-    "dist/**/*",
-    "docs/**/*",
-    "README.md"
-  ]
 }