@github/copilot-sdk 1.0.14 → 1.0.15-preview.1

package/dist/generated/rpc.js

@@ -197,7 +197,15 @@ function createServerRpc(connection) {
        *
        * @returns Outcome of a catalog.search call: either bounded inert candidates, or one typed refusal. Never a partial success.
        */
-      search: async (params) => connection.sendRequest("catalog.search", params)
+      search: async (params) => connection.sendRequest("catalog.search", params),
+      /**
+       * Terminates one retained catalog selection group. A selected outcome returns the native host a fresh single-use candidate handle plus the original searchId for a later explicit mcp.planInstall call; non-selected outcomes release the group without producing a planning input. Candidate state, cards, URLs, credentials and private identifiers remain inside the runtime. The model-facing catalog_select tool projects the result separately and never exposes the candidate handle or searchId.
+       *
+       * @param params Terminates one retained catalog selection group through an opaque reference previously returned by the model-safe search projection.
+       *
+       * @returns Typed outcome of catalog.select. Only the selected host result carries a fresh candidate handle; the model-facing projection removes both that handle and searchId.
+       */
+      select: async (params) => connection.sendRequest("catalog.select", params)
     },
     /** @experimental */
     plugins: {
@@ -428,7 +436,7 @@ function createServerRpc(connection) {
       /**
        * Registers an SDK client as the session filesystem provider.
        *
-       * @param params Initial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider.
+       * @param params Initial working directory, session-state path layout, and path conventions used to register the calling SDK client as the session filesystem provider. A registered provider is authoritative for path interpretation and filesystem facts used by workspace permission validation. Paths are interpreted lexically; home-relative paths (`~` and `~/...`) and Windows drive-relative paths such as `C:foo` are unsupported. Until provider-side canonicalization is supported, providers must not expose symlinks inside allowed roots that escape those roots.
        *
        * @returns Indicates whether the calling client was registered as the session filesystem provider.
        */
@@ -992,6 +1000,108 @@ function createSessionRpc(connection, sessionId) {
       }
     },
     /** @experimental */
+    workflow: {
+      /**
+       * Runs a registered dynamic workflow by name at the top level.
+       *
+       * @param params Parameters for invoking a registered workflow.
+       *
+       * @returns Complete current or terminal workflow run envelope.
+       */
+      run: async (params) => connection.sendRequest("session.workflow.run", { sessionId, ...params }),
+      /**
+       * Resumes a dynamic workflow run using its persisted name, arguments, journal, and accounting.
+       *
+       * @param params Parameters for resuming a workflow run from its persisted identity.
+       *
+       * @returns Resolved persisted workflow identity and resumed run envelope.
+       */
+      resume: async (params) => connection.sendRequest("session.workflow.resume", { sessionId, ...params }),
+      /**
+       * Gets the current or settled envelope for a dynamic workflow run.
+       *
+       * @param params Parameters for retrieving a workflow run.
+       *
+       * @returns Complete current or terminal workflow run envelope.
+       */
+      getRun: async (params) => connection.sendRequest("session.workflow.getRun", { sessionId, ...params }),
+      /**
+       * Lists durable dynamic workflow runs for this session in creation order.
+       *
+       * @param params Parameters for paging workflow runs.
+       *
+       * @returns A page of workflow runs in durable creation order.
+       */
+      listRuns: async (params) => connection.sendRequest("session.workflow.listRuns", { sessionId, ...params }),
+      /**
+       * Gets durable and live observability detail for one dynamic workflow run.
+       *
+       * @param params Parameters for retrieving a workflow run.
+       *
+       * @returns Full workflow run observability detail.
+       */
+      getRunDetail: async (params) => connection.sendRequest("session.workflow.getRunDetail", { sessionId, ...params }),
+      /**
+       * Pages durable progress for one dynamic workflow run.
+       *
+       * @param params Parameters for paging workflow progress.
+       *
+       * @returns A bidirectional page of workflow progress.
+       */
+      getRunProgress: async (params) => connection.sendRequest("session.workflow.getRunProgress", { sessionId, ...params }),
+      /**
+       * Requests cancellation of a dynamic workflow run and returns its run envelope.
+       *
+       * @param params Parameters for cancelling a workflow run.
+       *
+       * @returns Complete current or terminal workflow run envelope.
+       */
+      cancel: async (params) => connection.sendRequest("session.workflow.cancel", { sessionId, ...params }),
+      /**
+       * Pauses a running dynamic workflow and returns its settled run envelope.
+       *
+       * @param params Parameters for pausing a running workflow.
+       *
+       * @returns Complete current or terminal workflow run envelope.
+       */
+      pause: async (params) => connection.sendRequest("session.workflow.pause", { sessionId, ...params }),
+      /**
+       * Records a batch of ordered dynamic workflow progress lines.
+       *
+       * @param params Parameters for recording workflow progress.
+       *
+       * @returns Acknowledgement that a workflow request was accepted.
+       */
+      log: async (params) => connection.sendRequest("session.workflow.log", { sessionId, ...params }),
+      /**
+       * Runs one dynamic-workflow-scoped subagent and returns its result.
+       *
+       * @param params Parameters for one workflow-scoped subagent call.
+       *
+       * @returns Result of one workflow-scoped subagent call.
+       */
+      agent: async (params) => connection.sendRequest("session.workflow.agent", { sessionId, ...params }),
+      /** @experimental */
+      journal: {
+        /**
+         * Reads a memoized dynamic workflow journal entry.
+         *
+         * @param params Parameters for reading a workflow journal entry.
+         *
+         * @returns Result of reading a workflow journal entry.
+         */
+        get: async (params) => connection.sendRequest("session.workflow.journal.get", { sessionId, ...params }),
+        /**
+         * Stores a memoized dynamic workflow journal entry.
+         *
+         * @param params Parameters for storing a workflow journal entry.
+         *
+         * @returns Acknowledgement that a workflow request was accepted.
+         */
+        put: async (params) => connection.sendRequest("session.workflow.journal.put", { sessionId, ...params })
+      }
+    },
+    /** @experimental */
     model: {
       /**
        * Gets the session's authoritative model snapshot, including the committed Auto preference and any newer unclaimed Auto preference waiting for a future user turn.
@@ -1697,13 +1807,168 @@ 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.
+       *
+       * @returns Enterprise managed-settings resolution: the effective managed settings the session applied and which channels contributed, so SDK clients can show users what is enterprise-managed. Fires whenever managed policy is (re)applied — at session start, on resume, and on account switch. This is an ephemeral live snapshot (delivered to subscribers but not persisted to the session event log), because at session start it resolves before `session.start` is emitted. Device values take precedence over server values, then the policy helper, per ordinary key, while permissions compose restrictively across device, server, policy-helper, and SDK-client layers. The account-scoped `getManagedSettings()` API does not include session-local client injection. Marked experimental while the managed-settings surface stabilizes.
+       */
+      get: async () => connection.sendRequest("session.managedSettings.get", { sessionId })
+    },
+    /** @experimental */
     plugins: {
       /**
-       * Lists plugins installed for the session.
+       * Lists globally installed, live, built-in, and enterprise-managed desired plugins using the live session's authoritative account, working directory, and retained managed policy.
        *
        * @returns Plugins installed for the session, with their enabled state and version metadata.
        */
       list: async () => connection.sendRequest("session.plugins.list", { sessionId }),
+      /**
+       * Installs a plugin using the live session's authoritative account, working directory, and retained managed policy.
+       *
+       * @param params Plugin source resolved relative to the session's authoritative working directory.
+       *
+       * @returns Result of installing a plugin.
+       */
+      install: async (params) => connection.sendRequest("session.plugins.install", { sessionId, ...params }),
+      /**
+       * Uninstalls a plugin when permitted by the live session's retained managed policy.
+       *
+       * @param params Name (or spec) of the plugin to uninstall.
+       */
+      uninstall: async (params) => connection.sendRequest("session.plugins.uninstall", { sessionId, ...params }),
+      /**
+       * Updates an installed plugin using the live session's authoritative account, working directory, and retained managed policy.
+       *
+       * @param params Name (or spec) of the plugin to update.
+       *
+       * @returns Result of updating a single plugin.
+       */
+      update: async (params) => connection.sendRequest("session.plugins.update", { sessionId, ...params }),
+      /**
+       * Enables installed plugins when permitted by the live session's retained managed policy.
+       *
+       * @param params Plugin names (or specs) to enable in the session's authoritative working directory.
+       */
+      enable: async (params) => connection.sendRequest("session.plugins.enable", { sessionId, ...params }),
+      /**
+       * Disables installed plugins when permitted by the live session's retained managed policy.
+       *
+       * @param params Plugin names (or specs) to disable in the session's authoritative working directory.
+       */
+      disable: async (params) => connection.sendRequest("session.plugins.disable", { sessionId, ...params }),
+      /** @experimental */
+      marketplaces: {
+        /**
+         * Lists registered and enterprise-managed desired marketplaces using the live session's retained policy.
+         *
+         * @returns All registered marketplaces, including built-in defaults.
+         */
+        list: async () => connection.sendRequest("session.plugins.marketplaces.list", { sessionId }),
+        /**
+         * Adds a marketplace when permitted by the live session's retained managed policy.
+         *
+         * @param params Marketplace source and optional working directory for relative-path resolution.
+         *
+         * @returns Result of registering a new marketplace.
+         */
+        add: async (params) => connection.sendRequest("session.plugins.marketplaces.add", { sessionId, ...params }),
+        /**
+         * Removes a marketplace when permitted by the live session's retained managed policy.
+         *
+         * @param params Name of the marketplace to remove and an optional force flag.
+         *
+         * @returns Outcome of the remove attempt, including dependent-plugin info when applicable.
+         */
+        remove: async (params) => connection.sendRequest("session.plugins.marketplaces.remove", { sessionId, ...params }),
+        /**
+         * Browses a marketplace resolved through the live session's working directory and retained managed policy.
+         *
+         * @param params Name of the marketplace whose plugin catalog to fetch.
+         *
+         * @returns Plugins advertised by the marketplace.
+         */
+        browse: async (params) => connection.sendRequest("session.plugins.marketplaces.browse", { sessionId, ...params }),
+        /**
+         * Refreshes marketplaces resolved through the live session's working directory and retained managed policy.
+         *
+         * @param params Optional marketplace name; omit to refresh all.
+         *
+         * @returns Result of refreshing one or more marketplace catalogs.
+         */
+        refresh: async (params) => connection.sendRequest("session.plugins.marketplaces.refresh", { sessionId, ...params })
+      },
       /**
        * Reloads the session's plugin set, refreshing MCP servers, custom agents, hooks, and skills cache so SDK-driven changes via `server.plugins.*` take effect immediately.
        *
@@ -1728,7 +1993,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: {
@@ -2054,9 +2327,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.
        */
@@ -2072,9 +2345,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 }),
         /**
@@ -2412,6 +2685,22 @@ function createSessionRpc(connection, sessionId) {
        * @returns Result of editing a queued message.
        */
       updateText: async (params) => connection.sendRequest("session.queue.updateText", { sessionId, ...params }),
+      /**
+       * Atomically withdraws an unchanged, unconsumed user message from the local queued or steering lane. A client retaining the original draft may restore it only when removed is true. Does not interrupt the running turn.
+       *
+       * @param params Conditional withdrawal of a single user message, before the runtime claims it for delivery.
+       *
+       * @returns Result of removing a queued item.
+       */
+      withdrawMessage: async (params) => connection.sendRequest("session.queue.withdrawMessage", { sessionId, ...params }),
+      /**
+       * Atomically appends text and attachments to an unchanged, unconsumed local steering message. Returns updated=false if delivery or withdrawal already claimed the message.
+       *
+       * @param params Append to one pending steering message without changing its identity or delivery position.
+       *
+       * @returns Result of editing a queued message.
+       */
+      appendSteering: async (params) => connection.sendRequest("session.queue.appendSteering", { sessionId, ...params }),
       /**
        * Duplicates an addressable queued item immediately after its source.
        *
@@ -2666,6 +2955,31 @@ function createInternalSessionRpc(connection, sessionId) {
       pauseAtCheckpoint: async (params) => connection.sendRequest("session.factory.pauseAtCheckpoint", { sessionId, ...params })
     },
     /** @experimental */
+    workflow: {
+      /**
+       * Internal tool-originated dynamic workflow invocation.
+       *
+       * @param params Internal parameters for invoking a registered workflow from a tool.
+       *
+       * @returns Complete current or terminal workflow run envelope.
+       */
+      runFromTool: async (params) => connection.sendRequest("session.workflow.runFromTool", { sessionId, ...params }),
+      /**
+       * Internal tool-originated dynamic workflow resume.
+       *
+       * @param params Internal parameters for resuming a workflow run from a tool.
+       *
+       * @returns Resolved persisted workflow identity and resumed run envelope.
+       */
+      resumeFromTool: async (params) => connection.sendRequest("session.workflow.resumeFromTool", { sessionId, ...params }),
+      /**
+       * Atomically pauses an owned dynamic workflow attempt at a durable checkpoint.
+       *
+       * @param params Parameters for an owned durable pause checkpoint.
+       */
+      pauseAtCheckpoint: async (params) => connection.sendRequest("session.workflow.pauseAtCheckpoint", { sessionId, ...params })
+    },
+    /** @experimental */
     model: {
       /**
        * Resolves and applies organization-managed and repository model overlays.
@@ -2708,6 +3022,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.
@@ -2861,6 +3192,16 @@ function registerClientSessionApiHandlers(connection, getHandlers) {
     if (!handler) throw new Error(`No factory handler registered for session: ${params.sessionId}`);
     return handler.abort(params);
   });
+  connection.onRequest("workflow.execute", async (params) => {
+    const handler = getHandlers(params.sessionId).workflow;
+    if (!handler) throw new Error(`No workflow handler registered for session: ${params.sessionId}`);
+    return handler.execute(params);
+  });
+  connection.onRequest("workflow.abort", async (params) => {
+    const handler = getHandlers(params.sessionId).workflow;
+    if (!handler) throw new Error(`No workflow handler registered for session: ${params.sessionId}`);
+    return handler.abort(params);
+  });
   connection.onRequest("tasks.cancel", async (params) => {
     const handler = getHandlers(params.sessionId).tasks;
     if (!handler) throw new Error(`No tasks handler registered for session: ${params.sessionId}`);