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

package/dist/types.d.ts

@@ -4,14 +4,16 @@
 import type { Canvas } from "./canvas.js";
 import type { SessionFsProvider } from "./sessionFsProvider.js";
 import type { CopilotRequestHandler } from "./copilotRequestHandler.js";
+import type { InstallationConfirmationHandler } from "./installationConfirmation.js";
+export type { InstallationConfirmationHandler } from "./installationConfirmation.js";
 import type { AttachmentExtensionContext as GeneratedExtensionContextAttachment, 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 { ExtensionLaunchProviderHandler as GeneratedExtensionLaunchProvider, GitHubTokenAcquireRequest, GitHubTokenAcquireResult, GitHubTelemetryNotification, ModelBillingTokenPrices, OpenCanvasInstance, RemoteSessionMode, CurrentToolMetadata } from "./generated/rpc.js";
+import type { JsonValue } from "./workflow.js";
+import type { ExtensionLaunchProviderHandler as GeneratedExtensionLaunchProvider, GitHubTokenAcquireRequest, GitHubTokenAcquireResult, GitHubTelemetryNotification, ModelBillingTokenPrices, DiagnosticsConfiguration, OpenCanvasInstance, RemoteSessionMode, CurrentToolMetadata } from "./generated/rpc.js";
 import type { ToolSet } from "./toolSet.js";
 export type { RemoteSessionMode } from "./generated/rpc.js";
 export type { CurrentToolMetadata } from "./generated/rpc.js";
-export type { ExtensionLaunchProfile, ExtensionLaunchProviderResolveRequest, ExtensionLaunchProviderResolveResult, GitHubTokenAcquireReason, GitHubTokenAcquireResult, GitHubTelemetryNotification, GitHubTelemetryEvent, GitHubTelemetryClientInfo, } from "./generated/rpc.js";
+export type { ConnectorAccountRequest, ConnectorAvailability, ConnectorCapabilities, ConnectorCatalogEntry, ConnectorCatalogResult, ConnectorCatalogStatus, ConnectorConnectRequest, ConnectorConnectResult, ConnectorContinueRequest, ConnectorDisconnectResult, ConnectorMcpStatus, ConnectorReconcileRequest, ConnectorRuntimeStatus, ConnectorStatus, ExtensionLaunchProfile, ExtensionLaunchProviderResolveRequest, ExtensionLaunchProviderResolveResult, GitHubTokenAcquireReason, GitHubTokenAcquireResult, GitHubTelemetryNotification, GitHubTelemetryEvent, GitHubTelemetryClientInfo, InstallationConfirmationRequest, InstallationConfirmationResponse, InstallationDecision, InstallationReview, McpInstallationReview, } from "./generated/rpc.js";
 /**
  * Arguments passed to a session's {@link GitHubTokenProvider}.
  *
@@ -290,6 +292,12 @@ export interface CopilotClientOptions {
      * @experimental
      */
     extensionLaunchProvider?: ExtensionLaunchProvider;
+    /**
+     * Connection-global human review for experimental installation operations.
+     * Does not register or enable installation capabilities on the runtime.
+     * @experimental
+     */
+    installationConfirmationHandler?: InstallationConfirmationHandler;
     /**
      * Log level for the Copilot runtime. When omitted, the runtime uses its
      * own default (currently `"info"`).
@@ -1622,6 +1630,8 @@ export interface McpAuthStaticClientConfig {
     grantType?: "client_credentials";
     /** Whether this is a public OAuth client. */
     publicClient?: boolean;
+    /** Configured OAuth scope string used when the server challenge omits scope. */
+    scope?: string;
 }
 /** MCP OAuth request that the SDK host can satisfy with a host-acquired token. */
 export interface McpAuthRequest {
@@ -1690,69 +1700,6 @@ export interface CanvasProviderIdentity {
     /** Optional display name surfaced as the canvas extension name. */
     name?: string;
 }
-/**
- * Static resource ceilings declared by a factory before it runs.
- *
- * @experimental Part of the experimental Agent Factories surface and may
- * change or be removed in future SDK or CLI releases.
- */
-export interface FactoryLimits {
-    /** Maximum number of factory subagents that may run concurrently. Must be positive when present. */
-    maxConcurrentSubagents?: number;
-    /** Maximum total number of factory subagents that may be spawned. Must be positive when present. */
-    maxTotalSubagents?: number;
-    /** Maximum AI credits consumed by factory subagents and descendants. This post-paid ceiling is soft. */
-    maxAiCredits?: number;
-    /**
-     * Maximum accumulated active-execution time, in seconds. Active execution includes the entire extension body,
-     * subprocess waits, queued-agent waits, and sleeps. The limit is armed from the remaining headroom when a run
-     * resumes; time between attempts is not counted. Must be finite and positive when present.
-     */
-    timeoutSeconds?: number;
-}
-/**
- * Registration metadata for an extension-authored factory.
- *
- * @experimental Part of the experimental Agent Factories surface and may
- * change or be removed in future SDK or CLI releases.
- */
-export interface FactoryMeta {
-    /** Stable factory name used for invocation. */
-    name: string;
-    /** Human-readable factory description. */
-    description: string;
-    /** Display metadata for the progress phases the factory may report. */
-    phases: Array<{
-        title: string;
-        detail?: string;
-    }>;
-    /**
-     * Optional declared shape of the arguments this factory expects as `ctx.args`.
-     *
-     * Declaring one is strongly recommended for any factory that reads `ctx.args`.
-     * When the model invokes the factory through the `run_factory` tool, the CLI
-     * validates `args` against this declaration **before** the run starts, so a
-     * malformed call is rejected with a correction hint and retried without ever
-     * creating a run row, prompting the user for permission, or spending credits. A
-     * factory that declares nothing is never validated: a malformed call starts,
-     * takes an approval, spends credits, and then fails inside the factory body.
-     * `factories_manage` with `operation: "inspect"` reports the declared shape so an
-     * agent can read it before invoking.
-     *
-     * This covers the model's `run_factory` path only. `session.factory.run(...)` is
-     * not validated against the declaration, so a factory should still check
-     * `ctx.args` rather than assume the declared shape held.
-     *
-     * Enforcement covers structure — types, required properties, and enum/const
-     * values. Finer constraints such as `minLength`, `pattern`, and
-     * `additionalProperties` are recorded in the declaration but not enforced. See
-     * {@link FactoryJsonSchema} for the accepted subset. A declaration outside that
-     * subset is rejected at registration.
-     */
-    argsSchema?: FactoryJsonSchema;
-    /** Optional resource ceilings presented to the user before execution. */
-    limits?: FactoryLimits;
-}
 /**
  * Provider-scoped options for the Copilot API (CAPI).
  *
@@ -1922,6 +1869,16 @@ export interface SessionConfigBase {
      * the session to the long-context tier; omit or use "default" otherwise.
      */
     contextTier?: ContextTier;
+    /**
+     * Enables session-scoped MCP diagnostic capture at the requested level.
+     *
+     * Diagnostics are off by default. At `"debug"` and `"trace"` levels, entries
+     * can contain MCP payloads, tool arguments, paths, and server stderr. Do not
+     * upload entries as telemetry or export them without deliberate host action.
+     * Omit this option when resuming a resident session to preserve its current
+     * diagnostic level.
+     */
+    diagnostics?: DiagnosticsConfiguration;
     /** Per-property overrides for model capabilities, deep-merged over runtime defaults. */
     modelCapabilities?: ModelCapabilitiesOverride;
     /**
@@ -2465,6 +2422,14 @@ export interface SessionConfig extends SessionConfigBase {
      * Optional custom session ID. If not provided, the server generates one.
      */
     sessionId?: string;
+    /**
+     * Invalidates the process-wide custom-instruction discovery cache before
+     * creating this session. Use when instruction files changed in the same runtime.
+     * Other sessions in this runtime may observe updated instructions on later turns
+     * or discovery. This does not watch files or enable disabled instruction loading.
+     * @default false
+     */
+    refreshCustomInstructions?: boolean;
     /**
      * Creates a remote session in the cloud instead of a local session.
      * The optional repository is associated with the cloud session.

package/dist/workflow.d.ts

@@ -1,8 +1,11 @@
 import type { WorkflowGetRunProgressRequest, WorkflowListRunsRequest, WorkflowListRunsResult, WorkflowProgressPage, WorkflowRunDetail, WorkflowRunResult, WorkflowRunStatus, WorkflowRunSummary } from "./generated/rpc.js";
 import type { ContextTier } from "./generated/session-events.js";
 import type { CopilotSession } from "./session.js";
-import type { JsonValue } from "./factory.js";
 export type { WorkflowRunResult };
+/** A value that can be represented losslessly on the SDK JSON wire. */
+export type JsonValue = null | boolean | number | string | JsonValue[] | {
+    [key: string]: JsonValue;
+};
 export type { WorkflowAgentSummary, WorkflowPhaseStatus, WorkflowPhaseObservation, WorkflowProgressLine, WorkflowProgressPage, WorkflowRunDetail, WorkflowRunStatus, WorkflowRunSummary, } from "./generated/rpc.js";
 /**
  * Options for paging durable workflow runs.
@@ -311,7 +314,7 @@ export interface SessionWorkflowApi {
      * snapshot: resuming the same durable run can later change the envelope
      * returned by {@link SessionWorkflowApi.getRun}.
      *
-     * This watches the runtime's `factory.run_updated` compatibility event and
+     * This watches the runtime's `workflow.run_updated` event and
      * periodically re-reads the durable envelope so a missed event cannot
      * leave the wait hanging. Pass a `signal` to stop waiting; aborting rejects
      * and has no effect on the run itself, which keeps executing. Use

package/docs/extensions.md

@@ -78,5 +78,4 @@ An approved extension can pass a granted value to anything it starts, so ask onl
 
 - `examples.md` — Practical code examples for tools, hooks, events, and complete extensions
 - `workflows.md` — Authoring, running, resuming, and observing Dynamic Workflows
-- `factories.md`: Authoring, running, resuming, and observing Agent Factories
 - `agent-author.md` — Step-by-step workflow for agents authoring extensions programmatically

package/docs/workflows.md

@@ -2,8 +2,6 @@
 
 Dynamic Workflows are extension-authored, session-scoped workflows that coordinate subagents and durable steps. The API is experimental.
 
-Use Dynamic Workflows for new extension-authored orchestration. Existing Agent Factory extensions remain supported during the transition, but one `joinSession` call must register either `workflows` or `factories`, never both.
-
 ## Define and register a workflow
 
 Use `defineWorkflow` and pass the returned handle to `joinSession`:
@@ -242,7 +240,7 @@ if (settled.status === "completed") {
 }
 ```
 
-It watches the runtime's `factory.run_updated` compatibility event and re-reads the durable envelope on each invalidation, collapsing a burst of events into a single in-flight read. A low-frequency periodic re-read runs alongside the subscription, so a dropped or missing invalidation degrades into a slightly late resolution rather than an unbounded wait. Pass a `signal` to stop waiting:
+It watches `workflow.run_updated` and re-reads the durable envelope on each invalidation, collapsing a burst of events into a single in-flight read. A low-frequency periodic re-read runs alongside the subscription, so a dropped or missing invalidation degrades into a slightly late resolution rather than an unbounded wait. Pass a `signal` to stop waiting:
 
 ```ts
 const controller = new AbortController();
@@ -252,6 +250,6 @@ const settled = await session.workflow.waitForRun(runId, { signal: controller.si
 
 Aborting rejects the wait and has no effect on the run, which keeps executing—use `pause(runId)` or `cancel(runId)` to stop it. The resolved object is a snapshot of that settled attempt. If its status is `paused`, a later resume updates the durable envelope under the same run ID. Call `getRun(runId)` to read the latest envelope. `isWorkflowRunTerminal(status)` exposes the same current-attempt settlement test for callers driving their own loop.
 
-Listen for the ephemeral `factory.run_updated` compatibility event. Its `{ runId, revision }` payload is an invalidation signal. Re-read the desired API when a newer monotonic revision arrives.
+Listen for the ephemeral `workflow.run_updated` event. Its `{ runId, revision }` payload is an invalidation signal. Re-read the desired API when a newer monotonic revision arrives.
 
 Revisions cover durable lifecycle, accounting, phase, agent, and progress changes. Continuous read-time fields can change without a new revision. These include `observedAt`, active-time calculations, live counts, and a live agent's status or prompt-safe activity text. Workflow prompts are never exposed by these APIs. A run is visible only through the session that owns it.

package/package.json

@@ -4,8 +4,8 @@
         "type": "git",
         "url": "https://github.com/github/copilot-sdk.git"
     },
-    "version": "1.0.15-preview.2",
-    "copilotCliVersion": "1.0.89-1",
+    "version": "1.0.15-preview.4",
+    "copilotCliVersion": "1.0.89-7",
     "description": "TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC",
     "main": "./dist/cjs/index.js",
     "types": "./dist/index.d.ts",
@@ -101,13 +101,13 @@
         "README.md"
     ],
     "optionalDependencies": {
-        "@github/copilot-sdk-darwin-arm64": "1.0.15-preview.2",
-        "@github/copilot-sdk-darwin-x64": "1.0.15-preview.2",
-        "@github/copilot-sdk-linux-arm64": "1.0.15-preview.2",
-        "@github/copilot-sdk-linux-x64": "1.0.15-preview.2",
-        "@github/copilot-sdk-linuxmusl-arm64": "1.0.15-preview.2",
-        "@github/copilot-sdk-linuxmusl-x64": "1.0.15-preview.2",
-        "@github/copilot-sdk-win32-arm64": "1.0.15-preview.2",
-        "@github/copilot-sdk-win32-x64": "1.0.15-preview.2"
+        "@github/copilot-sdk-darwin-arm64": "1.0.15-preview.4",
+        "@github/copilot-sdk-darwin-x64": "1.0.15-preview.4",
+        "@github/copilot-sdk-linux-arm64": "1.0.15-preview.4",
+        "@github/copilot-sdk-linux-x64": "1.0.15-preview.4",
+        "@github/copilot-sdk-linuxmusl-arm64": "1.0.15-preview.4",
+        "@github/copilot-sdk-linuxmusl-x64": "1.0.15-preview.4",
+        "@github/copilot-sdk-win32-arm64": "1.0.15-preview.4",
+        "@github/copilot-sdk-win32-x64": "1.0.15-preview.4"
     }
 }

package/dist/cjs/factory.js

@@ -1,134 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var factory_exports = {};
-__export(factory_exports, {
-  FACTORY_AGENT_OPTION_KEYS: () => FACTORY_AGENT_OPTION_KEYS,
-  FactoryResumeError: () => FactoryResumeError,
-  defineFactory: () => defineFactory,
-  getFactoryDefinition: () => getFactoryDefinition,
-  isFactoryRunTerminal: () => isFactoryRunTerminal
-});
-module.exports = __toCommonJS(factory_exports);
-const FACTORY_TERMINAL_STATUSES = /* @__PURE__ */ new Set([
-  "completed",
-  "halted",
-  "paused",
-  "cancelled",
-  "error"
-]);
-function isFactoryRunTerminal(status) {
-  return FACTORY_TERMINAL_STATUSES.has(status);
-}
-const FACTORY_AGENT_OPTION_KEYS = [
-  "label",
-  "schema",
-  "model",
-  "reasoningEffort",
-  "contextTier",
-  "agent"
-];
-class FactoryResumeError extends Error {
-  constructor(code, message) {
-    super(message);
-    this.code = code;
-    this.name = "FactoryResumeError";
-  }
-  code;
-}
-const factoryHandles = /* @__PURE__ */ new WeakMap();
-const MAX_FACTORY_TIMEOUT_SECONDS = 2147483647e-3;
-const NANO_AIU_PER_AIU = 1e9;
-function deepFreeze(value) {
-  if (value !== null && typeof value === "object" && !Object.isFrozen(value)) {
-    Object.freeze(value);
-    for (const nested of Object.values(value)) {
-      deepFreeze(nested);
-    }
-  }
-  return value;
-}
-function validateLimits(meta) {
-  const limits = meta.limits;
-  if (!limits) {
-    return;
-  }
-  for (const field of ["maxConcurrentSubagents", "maxTotalSubagents"]) {
-    const value = limits[field];
-    if (value !== void 0 && (!Number.isInteger(value) || value <= 0)) {
-      throw new Error(`Factory limit "${field}" must be a positive integer`);
-    }
-  }
-  if (limits.timeoutSeconds !== void 0 && (!Number.isFinite(limits.timeoutSeconds) || limits.timeoutSeconds <= 0)) {
-    throw new Error(
-      'Factory limit "timeoutSeconds" must be a positive, finite number of seconds'
-    );
-  }
-  if (limits.timeoutSeconds !== void 0 && limits.timeoutSeconds > MAX_FACTORY_TIMEOUT_SECONDS) {
-    throw new Error(
-      `Factory limit "timeoutSeconds" must not exceed ${MAX_FACTORY_TIMEOUT_SECONDS} seconds`
-    );
-  }
-  if (limits.maxAiCredits !== void 0) {
-    const maxNanoAiu = Math.round(limits.maxAiCredits * NANO_AIU_PER_AIU);
-    if (!Number.isFinite(limits.maxAiCredits) || limits.maxAiCredits <= 0 || !Number.isSafeInteger(maxNanoAiu) || maxNanoAiu < 1) {
-      throw new Error(
-        'Factory limit "maxAiCredits" must be a positive, finite number that rounds to a safe positive integer nano-AIU ceiling'
-      );
-    }
-  }
-}
-function validatePhases(meta) {
-  const titles = /* @__PURE__ */ new Set();
-  for (const phase of meta.phases) {
-    if (phase.title.trim().length === 0) {
-      throw new Error("Factory phase titles must not be empty");
-    }
-    if (titles.has(phase.title)) {
-      throw new Error(`Factory phase title "${phase.title}" is declared more than once`);
-    }
-    titles.add(phase.title);
-  }
-}
-function defineFactory(definition) {
-  const meta = deepFreeze(structuredClone(definition.meta));
-  validateLimits(meta);
-  validatePhases(meta);
-  const stored = {
-    meta,
-    run: definition.run
-  };
-  const handle = Object.freeze({ meta });
-  factoryHandles.set(handle, stored);
-  return handle;
-}
-function getFactoryDefinition(handle) {
-  const definition = factoryHandles.get(handle);
-  if (!definition) {
-    throw new Error("Invalid factory handle");
-  }
-  return definition;
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  FACTORY_AGENT_OPTION_KEYS,
-  FactoryResumeError,
-  defineFactory,
-  getFactoryDefinition,
-  isFactoryRunTerminal
-});