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

package/README.md

@@ -14,10 +14,14 @@ verified `github/copilot-cli` release assets when the SDK is published, so
 starting the SDK performs no runtime download. Set `COPILOT_CLI_PATH` to use an
 existing installation instead.
 
-The checked-in release pin is `copilotCliVersion` in `package.json`. Run
-`npm run set:cli-version -- <version>` to update it and regenerate the compiled
-metadata in `src/cliVersion.ts`. Packaging verifies release assets against the
-release's `SHA256SUMS.txt`.
+The checked-in `copilotCliVersion` in `package.json` and compiled metadata in
+`src/cliVersion.ts` use a development placeholder. The public SDK snapshot
+replaces both with the CLI version published for that snapshot.
+
+Do not change these pins for runtime-repository development. If they contain
+`0.0.0-dev`, use the same-checkout runtime; release snapshot export owns replacing
+development placeholders with a published CLI version. See
+[checkout preparation](../CONTRIBUTING.md#testing-an-unreleased-runtime-api).
 
 `npm run pack:release` builds the main package and all platform packages. Set
 `COPILOT_CLI_DOWNLOAD_BASE_URL` to use a release mirror while packaging.
@@ -26,6 +30,12 @@ containing validated runtime npm package roots named for all eight platforms.
 This keeps `COPILOT_CLI_USE_NPM_PACKAGE` false and embeds those runtime files in
 the self-contained SDK platform packages.
 
+In the runtime repository, packaging uses the prepared same-checkout runtime.
+Set `COPILOT_SDK_RUNTIME_PLATFORMS` to the available target (for example,
+`linux-x64`) for both `pack:release` and `verify:release-packages`. SDK CI checks
+that target only; public release workflows leave this unset to package and
+verify all eight platforms.
+
 ## Installation
 
 ```bash
@@ -34,7 +44,11 @@ npm install @github/copilot-sdk
 
 ## Run the Sample
 
-Try the interactive chat sample (from the repo root):
+Try the interactive chat sample from the SDK root (`src/sdk` when nested).
+In the runtime repository, first run `pnpm run build:cli` from the runtime root
+to prepare the same-checkout executable, then return to `src/sdk`.
+Building the Node SDK alone does not build the runtime. For dependency
+prerequisites, see [development setup](#development).
 
 ```bash
 cd nodejs
@@ -1274,19 +1288,28 @@ try {
 
 ## Development
 
-From the repository root:
+Follow [SDK development setup](../CONTRIBUTING.md#developing-an-sdk) first,
+including the harness and corrections-script dependencies. From the SDK root
+(`src/sdk` in the runtime repository, or the standalone repository root):
 
 ```bash
-cd test/harness
-npm ci
+npm run build:nodejs
+npm run test:nodejs
+npm run check:nodejs
 ```
 
+In the runtime layout, these build/test commands refresh the projection and
+prepare the checked-out runtime for tests. For focused unit tests after
+installing Node dependencies:
+
 ```bash
-cd nodejs
-npm ci
-npm test
+npm --prefix nodejs run test:unit
 ```
 
+For native Vitest selectors on E2Es, use the
+[prepared-runtime instructions](../CONTRIBUTING.md#testing-an-unreleased-runtime-api);
+the SDK facade does not forward selectors.
+
 ## License
 
 MIT

package/dist/cjs/cliVersion.js

@@ -22,7 +22,7 @@ __export(cliVersion_exports, {
   COPILOT_CLI_VERSION: () => COPILOT_CLI_VERSION
 });
 module.exports = __toCommonJS(cliVersion_exports);
-const COPILOT_CLI_VERSION = "1.0.87-0";
+const COPILOT_CLI_VERSION = "1.0.89-1";
 const COPILOT_CLI_USE_NPM_PACKAGE = false;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/cjs/client.js

@@ -1337,11 +1337,14 @@ class CopilotClient {
   async resumeSession(sessionId, config) {
     return this.resumeSessionInternal(sessionId, config);
   }
-  /** @internal */
-  async resumeSessionForExtension(sessionId, config, factories, extensionOptions) {
-    return this.resumeSessionInternal(sessionId, config, factories, extensionOptions);
+  async resumeSessionForExtension(sessionId, config, contributions = {}, extensionOptions) {
+    return this.resumeSessionInternal(sessionId, config, contributions, extensionOptions);
   }
-  async resumeSessionInternal(sessionId, config, factories, extensionOptions) {
+  async resumeSessionInternal(sessionId, config, contributions = {}, extensionOptions) {
+    const { factories, workflows } = Array.isArray(contributions) ? { factories: contributions, workflows: void 0 } : contributions;
+    if (factories !== void 0 && workflows !== void 0) {
+      throw new Error("Session configuration cannot include both factories and workflows");
+    }
     if (config.gitHubToken !== void 0 && config.gitHubTokenProvider !== void 0) {
       throw new Error("gitHubToken and gitHubTokenProvider are mutually exclusive");
     }
@@ -1362,6 +1365,7 @@ class CopilotClient {
     session.registerCanvases(config.canvases);
     session.registerCommands(config.commands);
     session.registerFactories(factories);
+    session.registerWorkflows(workflows);
     const {
       wireProvider: bearerWireProvider,
       wireProviders: bearerWireProviders,
@@ -1443,6 +1447,7 @@ class CopilotClient {
         toolSearch: config.toolSearch,
         canvases: config.canvases?.map((canvas) => canvas.declaration),
         factories: factories?.map((factory) => factory.meta),
+        workflows: workflows?.map((workflow) => workflow.meta),
         requestCanvasRenderer: config.requestCanvasRenderer,
         requestExtensions: config.requestExtensions,
         extensionSdkPath: config.extensionSdkPath,

package/dist/cjs/extension.js

@@ -21,9 +21,12 @@ __export(extension_exports, {
   Canvas: () => import_canvas.Canvas,
   CanvasError: () => import_canvas.CanvasError,
   FactoryResumeError: () => import_factory.FactoryResumeError,
+  WorkflowResumeError: () => import_workflow.WorkflowResumeError,
   createCanvas: () => import_canvas.createCanvas,
   defineFactory: () => import_factory.defineFactory,
+  defineWorkflow: () => import_workflow.defineWorkflow,
   isFactoryRunTerminal: () => import_factory.isFactoryRunTerminal,
+  isWorkflowRunTerminal: () => import_workflow.isWorkflowRunTerminal,
   joinSession: () => joinSession
 });
 module.exports = __toCommonJS(extension_exports);
@@ -31,6 +34,7 @@ var import_client = require("./client.js");
 var import_types = require("./types.js");
 var import_canvas = require("./canvas.js");
 var import_factory = require("./factory.js");
+var import_workflow = require("./workflow.js");
 async function joinSession(config = {}) {
   const sessionId = process.env.SESSION_ID;
   if (!sessionId) {
@@ -42,10 +46,14 @@ async function joinSession(config = {}) {
   const {
     extensionSdkPath: _stripped,
     factories,
+    workflows,
     requestedEnvironmentVariables,
     ...rest
   } = config;
   void _stripped;
+  if (factories !== void 0 && workflows !== void 0) {
+    throw new Error("joinSession cannot register both factories and workflows");
+  }
   return client.resumeSessionForExtension(
     sessionId,
     {
@@ -53,7 +61,7 @@ async function joinSession(config = {}) {
       onPermissionRequest: config.onPermissionRequest ?? import_types.defaultJoinSessionPermissionHandler,
       suppressResumeEvent: config.suppressResumeEvent ?? true
     },
-    factories,
+    { factories, workflows },
     requestedEnvironmentVariables?.length ? { requestedEnvironmentVariables } : void 0
   );
 }
@@ -62,8 +70,11 @@ async function joinSession(config = {}) {
   Canvas,
   CanvasError,
   FactoryResumeError,
+  WorkflowResumeError,
   createCanvas,
   defineFactory,
+  defineWorkflow,
   isFactoryRunTerminal,
+  isWorkflowRunTerminal,
   joinSession
 });

package/dist/cjs/generated/rpc.js

@@ -1835,6 +1835,77 @@ function createSessionRpc(connection, sessionId) {
       }
     },
     /** @experimental */
+    connectors: {
+      /**
+       * Returns feature availability and bounded polling limits for the EXPERIMENTAL session connector API. This method never performs a Connector service request.
+       *
+       * @returns Feature detection and hard polling limits for the EXPERIMENTAL session connector API.
+       */
+      getCapabilities: async () => connection.sendRequest("session.connectors.getCapabilities", { sessionId }),
+      /**
+       * Returns authoritative session Connector state from current availability, pinned account selection, cached catalog, and live MCP projection without performing a Connector service request.
+       *
+       * @returns Authoritative session connector state. Account IDs are opaque routing identifiers and credentials are never included.
+       */
+      getStatus: async () => connection.sendRequest("session.connectors.getStatus", { sessionId }),
+      /**
+       * Returns the cached Connector catalog for the pinned opaque account selection, fetching it only when this session has no cached catalog.
+       *
+       * @param params Pins a Connector operation to one host-owned GitHub account through its opaque selection ID. Provider tokens are never accepted.
+       *
+       * @returns Validated Connector catalog snapshot cached by the session.
+       */
+      list: async (params) => connection.sendRequest("session.connectors.list", { sessionId, ...params }),
+      /**
+       * Refreshes and validates the Connector catalog for the pinned opaque account selection.
+       *
+       * @param params Pins a Connector operation to one host-owned GitHub account through its opaque selection ID. Provider tokens are never accepted.
+       *
+       * @returns Validated Connector catalog snapshot cached by the session.
+       */
+      refresh: async (params) => connection.sendRequest("session.connectors.refresh", { sessionId, ...params }),
+      /**
+       * Initiates an idempotent Connector connection request without opening a browser. Returns connected when the service is immediately authoritative, consent_required with a validated URL, or pending with an opaque continuation ID.
+       *
+       * @param params Selects one Connector and the pinned host-owned account used for its service and MCP authorization.
+       *
+       * @returns Typed result of initiating or continuing a Connector connection.
+       */
+      connect: async (params) => connection.sendRequest("session.connectors.connect", { sessionId, ...params }),
+      /**
+       * Re-initiates an idempotent Connector connection request without browser or UI effects, with the same typed outcomes as connect.
+       *
+       * @param params Selects one Connector and the pinned host-owned account used for its service and MCP authorization.
+       *
+       * @returns Typed result of initiating or continuing a Connector connection.
+       */
+      reconnect: async (params) => connection.sendRequest("session.connectors.reconnect", { sessionId, ...params }),
+      /**
+       * Continues a pending Connector connection with caller-supplied attempt, interval, and deadline bounds. The runtime never opens the returned consent URL.
+       *
+       * @param params Explicitly bounded continuation of a pending Connector connection.
+       *
+       * @returns Typed result of initiating or continuing a Connector connection.
+       */
+      continueConnection: async (params) => connection.sendRequest("session.connectors.continueConnection", { sessionId, ...params }),
+      /**
+       * Disconnects one Connector for the pinned opaque account selection, refreshes the authoritative catalog, and removes its session-owned MCP projection.
+       *
+       * @param params Selects one Connector and the pinned host-owned account used for its service and MCP authorization.
+       *
+       * @returns Authoritative result after disconnect and MCP reconciliation.
+       */
+      disconnect: async (params) => connection.sendRequest("session.connectors.disconnect", { sessionId, ...params }),
+      /**
+       * Reconciles the authoritative cached or freshly requested Connector catalog into the session Connector MCP projection and returns live status.
+       *
+       * @param params Requests authoritative Connector-to-MCP reconciliation for the pinned account.
+       *
+       * @returns Authoritative session connector state. Account IDs are opaque routing identifiers and credentials are never included.
+       */
+      reconcile: async (params) => connection.sendRequest("session.connectors.reconcile", { sessionId, ...params })
+    },
+    /** @experimental */
     managedSettings: {
       /**
        * Waits for the live session's in-flight managed-settings application, then returns the retained effective snapshot used by runtime enforcement and by `session.managed_settings_resolved`. It does not perform another account, device, or server resolution, and rejects when resolution has not produced a snapshot.
@@ -1950,7 +2021,15 @@ function createSessionRpc(connection, sessionId) {
        *
        * @returns The selectable model entries synthesized for the models added by this call.
        */
-      add: async (params) => connection.sendRequest("session.provider.add", { sessionId, ...params })
+      add: async (params) => connection.sendRequest("session.provider.add", { sessionId, ...params }),
+      /**
+       * Atomically updates the session's BYOK provider and model registry by applying the supplied snapshot, replacing existing entries, updating models, or removing entries absent from the snapshot.
+       *
+       * @param params Authoritative BYOK provider and model registry snapshot to apply atomically to the session.
+       *
+       * @returns The selectable model entries and selection ids synthesized for the synchronized BYOK models.
+       */
+      sync: async (params) => connection.sendRequest("session.provider.sync", { sessionId, ...params })
     },
     /** @experimental */
     options: {
@@ -2276,9 +2355,9 @@ function createSessionRpc(connection, sessionId) {
        */
       setRequired: async (params) => connection.sendRequest("session.permissions.setRequired", { sessionId, ...params }),
       /**
-       * Clears session-scoped tool permission approvals.
+       * Clears session-scoped tool approvals and, for full resets, exact session-approved paths.
        *
-       * @param params Clears session-scoped tool permission approvals, and optionally the location-scoped ones.
+       * @param params Clears session-scoped tool approvals and optionally clears location-scoped approvals and exact session-approved paths.
        *
        * @returns Indicates whether the operation succeeded.
        */
@@ -2294,9 +2373,9 @@ function createSessionRpc(connection, sessionId) {
       /** @experimental */
       paths: {
         /**
-         * Returns the session's allowed directories and primary working directory.
+         * Returns the session's recursive directory grants, exact session-approved paths, and primary working directory.
          *
-         * @returns Snapshot of the session's allow-listed directories and primary working directory.
+         * @returns Snapshot of the session's recursive directory grants, exact session-approved paths, and primary working directory.
          */
         list: async () => connection.sendRequest("session.permissions.paths.list", { sessionId }),
         /**
@@ -2971,6 +3050,23 @@ function createInternalSessionRpc(connection, sessionId) {
       unregisterExternalClient: async (params) => connection.sendRequest("session.mcp.unregisterExternalClient", { sessionId, ...params })
     },
     /** @experimental */
+    connectors: {
+      /**
+       * Reconciles the authoritative Connector catalog into the session MCP projection during startup with a bounded deadline and fail-closed cleanup.
+       *
+       * @param params Pins a Connector operation to one host-owned GitHub account through its opaque selection ID. Provider tokens are never accepted.
+       *
+       * @returns Authoritative session connector state. Account IDs are opaque routing identifiers and credentials are never included.
+       */
+      reconcileForStartup: async (params) => connection.sendRequest("session.connectors.reconcileForStartup", { sessionId, ...params }),
+      /**
+       * Removes the runtime-owned Connector MCP projection without changing service-side connections.
+       *
+       * @returns Authoritative session connector state. Account IDs are opaque routing identifiers and credentials are never included.
+       */
+      withdrawProjection: async () => connection.sendRequest("session.connectors.withdrawProjection", { sessionId })
+    },
+    /** @experimental */
     commands: {
       /**
        * Finalizes persistence associated with a client-applied slash-command effect.

package/dist/cjs/index.js

@@ -33,6 +33,7 @@ __export(index_exports, {
   SYSTEM_MESSAGE_SECTIONS: () => import_types2.SYSTEM_MESSAGE_SECTIONS,
   SessionFsSqliteTransactionFailure: () => import_types2.SessionFsSqliteTransactionFailure,
   ToolSet: () => import_toolSet.ToolSet,
+  WorkflowResumeError: () => import_workflow.WorkflowResumeError,
   approveAll: () => import_types2.approveAll,
   convertMcpCallToolResult: () => import_types2.convertMcpCallToolResult,
   createAttributedPermissionResult: () => import_types2.createAttributedPermissionResult,
@@ -40,7 +41,9 @@ __export(index_exports, {
   createSessionFsAdapter: () => import_types2.createSessionFsAdapter,
   defineFactory: () => import_factory.defineFactory,
   defineTool: () => import_types2.defineTool,
-  isFactoryRunTerminal: () => import_factory.isFactoryRunTerminal
+  defineWorkflow: () => import_workflow.defineWorkflow,
+  isFactoryRunTerminal: () => import_factory.isFactoryRunTerminal,
+  isWorkflowRunTerminal: () => import_workflow.isWorkflowRunTerminal
 });
 module.exports = __toCommonJS(index_exports);
 var import_client = require("./client.js");
@@ -48,6 +51,7 @@ var import_types = require("./types.js");
 var import_toolSet = require("./toolSet.js");
 var import_session = require("./session.js");
 var import_factory = require("./factory.js");
+var import_workflow = require("./workflow.js");
 var import_canvas = require("./canvas.js");
 var import_types2 = require("./types.js");
 // Annotate the CommonJS export names for ESM import in node:
@@ -67,6 +71,7 @@ var import_types2 = require("./types.js");
   SYSTEM_MESSAGE_SECTIONS,
   SessionFsSqliteTransactionFailure,
   ToolSet,
+  WorkflowResumeError,
   approveAll,
   convertMcpCallToolResult,
   createAttributedPermissionResult,
@@ -74,5 +79,7 @@ var import_types2 = require("./types.js");
   createSessionFsAdapter,
   defineFactory,
   defineTool,
-  isFactoryRunTerminal
+  defineWorkflow,
+  isFactoryRunTerminal,
+  isWorkflowRunTerminal
 });