@github/copilot-sdk 1.0.7-preview.0 → 1.0.7-preview.1

package/dist/ffiRuntimeHost.js

@@ -0,0 +1,248 @@
+import { existsSync } from "node:fs";
+import koffi from "koffi";
+import { dirname, join, resolve } from "node:path";
+import { PassThrough, Writable } from "node:stream";
+const SYMBOL_PREFIX = "copilot_runtime_";
+const KEEP_ALIVE_INTERVAL_MS = 1 << 30;
+let loadedLibraryPath;
+let loadedLibrary;
+function loadLibrary(libraryPath) {
+  if (loadedLibrary) {
+    if (loadedLibraryPath !== libraryPath) {
+      throw new Error(
+        `An in-process FFI runtime library is already loaded from '${loadedLibraryPath}'; loading a different library from '${libraryPath}' in the same process is not supported.`
+      );
+    }
+    return loadedLibrary;
+  }
+  const lib = koffi.load(libraryPath);
+  const outboundCallbackType = koffi.pointer(
+    koffi.proto(
+      `void ${SYMBOL_PREFIX}outbound(void *userData, uint8 *bytesPtr, size_t bytesLen)`
+    )
+  );
+  loadedLibrary = {
+    hostStart: lib.func(`${SYMBOL_PREFIX}host_start`, "uint32", [
+      "uint8*",
+      "size_t",
+      "uint8*",
+      "size_t"
+    ]),
+    hostShutdown: lib.func(`${SYMBOL_PREFIX}host_shutdown`, "bool", ["uint32"]),
+    connectionOpen: lib.func(`${SYMBOL_PREFIX}connection_open`, "uint32", [
+      "uint32",
+      outboundCallbackType,
+      "void*",
+      "uint8*",
+      "size_t",
+      "uint8*",
+      "size_t",
+      "uint8*",
+      "size_t"
+    ]),
+    connectionWrite: lib.func(`${SYMBOL_PREFIX}connection_write`, "bool", [
+      "uint32",
+      "uint8*",
+      "size_t"
+    ]),
+    connectionClose: lib.func(`${SYMBOL_PREFIX}connection_close`, "bool", ["uint32"]),
+    outboundCallbackType
+  };
+  loadedLibraryPath = libraryPath;
+  return loadedLibrary;
+}
+function buildArgvJson(cliEntrypoint) {
+  const argv = cliEntrypoint.toLowerCase().endsWith(".js") ? ["node", cliEntrypoint, "--embedded-host", "--no-auto-update"] : [cliEntrypoint, "--embedded-host", "--no-auto-update"];
+  return Buffer.from(JSON.stringify(argv), "utf8");
+}
+function buildEnvJson(environment) {
+  if (!environment) {
+    return null;
+  }
+  const obj = {};
+  for (const [key, value] of Object.entries(environment)) {
+    if (value !== void 0) {
+      obj[key] = value;
+    }
+  }
+  if (Object.keys(obj).length === 0) {
+    return null;
+  }
+  return Buffer.from(JSON.stringify(obj), "utf8");
+}
+class FfiRuntimeHost {
+  constructor(libraryPath, cliEntrypoint, environment) {
+    this.libraryPath = libraryPath;
+    this.cliEntrypoint = cliEntrypoint;
+    this.environment = environment;
+    this.lib = loadLibrary(libraryPath);
+    this.receiveStream = new PassThrough();
+    this.sendStream = new Writable({
+      // connection_write enqueues the frame into the runtime's inbound channel and
+      // returns immediately, so a synchronous FFI call is sufficient here.
+      write: (chunk, _encoding, callback) => {
+        try {
+          this.writeFrame(chunk);
+          callback();
+        } catch (error) {
+          callback(error);
+        }
+      }
+    });
+  }
+  libraryPath;
+  cliEntrypoint;
+  environment;
+  lib;
+  serverId = 0;
+  connectionId = 0;
+  disposed = false;
+  outboundCallback;
+  keepAliveTimer;
+  /** The stream JSON-RPC reads server→client frames from. */
+  receiveStream;
+  /** The stream JSON-RPC writes client→server frames to. */
+  sendStream;
+  /**
+   * Resolves the cdylib next to the given CLI entrypoint and prepares the FFI host.
+   * The cdylib is resolved as `prebuilds/<prebuildsFolder>/runtime.node` relative to
+   * the entrypoint directory (the napi-rs `<node-platform>-<arch>` layout, e.g.
+   * `linux-x64`). Throws if it cannot be found.
+   */
+  static create(cliEntrypoint, prebuildsFolder, environment) {
+    const fullEntrypoint = resolve(cliEntrypoint);
+    const distDir = dirname(fullEntrypoint);
+    const libraryPath = join(distDir, "prebuilds", prebuildsFolder, "runtime.node");
+    if (!existsSync(libraryPath)) {
+      throw new Error(`FFI runtime library not found. Looked for '${libraryPath}'.`);
+    }
+    return new FfiRuntimeHost(libraryPath, fullEntrypoint, environment);
+  }
+  /**
+   * Starts the in-process runtime: spawns the CLI worker via the native host,
+   * waits for readiness, and opens the FFI JSON-RPC connection.
+   */
+  async start() {
+    const argvJson = buildArgvJson(this.cliEntrypoint);
+    const envJson = buildEnvJson(this.environment);
+    this.serverId = await new Promise((resolvePromise, rejectPromise) => {
+      this.lib.hostStart.async(
+        argvJson,
+        argvJson.length,
+        envJson,
+        envJson ? envJson.length : 0,
+        (error, result) => {
+          if (error) {
+            rejectPromise(error);
+          } else {
+            resolvePromise(result);
+          }
+        }
+      );
+    });
+    if (!this.serverId) {
+      throw new Error(
+        `copilot_runtime_host_start failed (library '${this.libraryPath}', entrypoint '${this.cliEntrypoint}').`
+      );
+    }
+    this.outboundCallback = koffi.register(
+      (_userData, bytesPtr, bytesLen) => this.feedInbound(bytesPtr, bytesLen),
+      this.lib.outboundCallbackType
+    );
+    this.connectionId = this.lib.connectionOpen(
+      this.serverId,
+      this.outboundCallback,
+      null,
+      null,
+      0,
+      null,
+      0,
+      null,
+      0
+    );
+    if (!this.connectionId) {
+      this.unregisterCallback();
+      this.lib.hostShutdown(this.serverId);
+      this.serverId = 0;
+      throw new Error("copilot_runtime_connection_open failed.");
+    }
+    this.keepAliveTimer = setInterval(() => {
+    }, KEEP_ALIVE_INTERVAL_MS);
+  }
+  writeFrame(frame) {
+    if (this.disposed || !this.connectionId) {
+      throw new Error("The in-process runtime connection is closed.");
+    }
+    const ok = this.lib.connectionWrite(this.connectionId, frame, frame.length);
+    if (!ok) {
+      throw new Error("Failed to write a frame to the in-process runtime connection.");
+    }
+  }
+  /**
+   * Native outbound (server→client) callback. koffi delivers it on the JS event loop
+   * via a threadsafe function, so the frame is decoded and written straight to
+   * {@link receiveStream}. The native pointer is only valid for this call, so the
+   * bytes are copied out before returning.
+   */
+  feedInbound(bytesPtr, bytesLen) {
+    try {
+      if (this.disposed || this.receiveStream.writableEnded) {
+        return;
+      }
+      const length = Number(bytesLen);
+      if (!bytesPtr || length <= 0) {
+        return;
+      }
+      const bytes = koffi.decode(
+        bytesPtr,
+        koffi.array("uint8", length, "Typed")
+      );
+      this.receiveStream.write(Buffer.from(bytes));
+    } catch (error) {
+      console.error(
+        `In-process FFI inbound callback failed: ${error instanceof Error ? error.stack ?? error.message : String(error)}`
+      );
+    }
+  }
+  unregisterCallback() {
+    if (this.outboundCallback === void 0) {
+      return;
+    }
+    const callback = this.outboundCallback;
+    this.outboundCallback = void 0;
+    try {
+      koffi.unregister(callback);
+    } catch {
+    }
+  }
+  /** Closes the FFI connection, shuts down the native host, and releases resources. */
+  dispose() {
+    if (this.disposed) {
+      return;
+    }
+    this.disposed = true;
+    if (this.keepAliveTimer !== void 0) {
+      clearInterval(this.keepAliveTimer);
+      this.keepAliveTimer = void 0;
+    }
+    try {
+      if (this.connectionId) {
+        this.lib.connectionClose(this.connectionId);
+        this.connectionId = 0;
+      }
+    } catch {
+    }
+    try {
+      if (this.serverId) {
+        this.lib.hostShutdown(this.serverId);
+        this.serverId = 0;
+      }
+    } catch {
+    }
+    this.receiveStream.end();
+    this.unregisterCallback();
+  }
+}
+export {
+  FfiRuntimeHost
+};

package/dist/generated/rpc.d.ts

@@ -5791,24 +5791,27 @@ export interface McpAppsListToolsResult {
     }[];
 }
 /**
- * MCP server and resource URI to fetch.
+ * @deprecated
+ * Deprecated/obsolete MCP Apps alias for `McpResourcesReadRequest`; use `session.mcp.resources.read` instead.
  *
  * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
  * via the `definition` "McpAppsReadResourceRequest".
  */
 /** @experimental */
+/** @deprecated */
 export interface McpAppsReadResourceRequest {
     /**
      * Name of the MCP server hosting the resource
      */
     serverName: string;
     /**
-     * Resource URI (typically ui://...)
+     * Resource URI
      */
     uri: string;
 }
 /**
- * Resource contents returned by the MCP server.
+ * @deprecated
+ * Deprecated/obsolete MCP Apps alias for `McpResourcesReadResult`; use `session.mcp.resources.read` instead.
  *
  * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
  * via the `definition` "McpAppsReadResourceResult".
@@ -5821,7 +5824,8 @@ export interface McpAppsReadResourceResult {
     contents: McpAppsResourceContent[];
 }
 /**
- * MCP Apps resource content with URI, optional MIME type, text or base64 blob, and resource metadata.
+ * @deprecated
+ * Deprecated/obsolete MCP Apps alias for `McpResourceContent`; use `session.mcp.resources.read` instead.
  *
  * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
  * via the `definition` "McpAppsResourceContent".
@@ -5829,7 +5833,7 @@ export interface McpAppsReadResourceResult {
 /** @experimental */
 export interface McpAppsResourceContent {
     /**
-     * The resource URI (typically ui://...)
+     * The resource URI
      */
     uri: string;
     /**
@@ -5845,7 +5849,7 @@ export interface McpAppsResourceContent {
      */
     blob?: string;
     /**
-     * Resource-level metadata (CSP, permissions, etc.)
+     * Resource-level metadata
      */
     _meta?: {
         [k: string]: unknown | undefined;
@@ -6491,6 +6495,289 @@ export interface McpRemoveGitHubResult {
      */
     removed: boolean;
 }
+/**
+ * An MCP resource descriptor (spec `Resource`): URI, name, and optional title, description, MIME type, size, icons, annotations, and metadata. Server-provided fields outside the standard descriptor shape are exposed under `additionalProperties`.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "McpResource".
+ */
+/** @experimental */
+export interface McpResource {
+    /**
+     * The resource URI (e.g. ui://... or file:///...)
+     */
+    uri: string;
+    /**
+     * The programmatic name of the resource
+     */
+    name: string;
+    /**
+     * Optional human-readable display title
+     */
+    title?: string;
+    /**
+     * Optional description of what this resource represents
+     */
+    description?: string;
+    /**
+     * MIME type of the resource, if known
+     */
+    mimeType?: string;
+    /**
+     * Resource size in bytes, when known
+     */
+    size?: number;
+    /**
+     * Icons associated with this resource
+     */
+    icons?: McpResourceIcon[];
+    annotations?: McpResourceAnnotations;
+    /**
+     * Resource-level metadata
+     */
+    _meta?: {
+        [k: string]: unknown | undefined;
+    };
+    /**
+     * Server-provided non-standard descriptor fields preserved from the MCP response
+     */
+    additionalProperties?: {
+        [k: string]: unknown | undefined;
+    };
+}
+/**
+ * A resource icon descriptor plus preserved non-standard icon fields.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "McpResourceIcon".
+ */
+/** @experimental */
+export interface McpResourceIcon {
+    /**
+     * Icon URI
+     */
+    src: string;
+    /**
+     * Icon MIME type, when known
+     */
+    mimeType?: string;
+    /**
+     * Icon sizes hint
+     */
+    sizes?: string;
+    /**
+     * Theme hint for this icon
+     */
+    theme?: string;
+    /**
+     * Server-provided non-standard icon fields preserved from the MCP response
+     */
+    additionalProperties?: {
+        [k: string]: unknown | undefined;
+    };
+}
+/**
+ * Standard MCP resource annotations plus preserved non-standard annotation fields.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "McpResourceAnnotations".
+ */
+/** @experimental */
+export interface McpResourceAnnotations {
+    /**
+     * Intended audience roles for this resource
+     */
+    audience?: string[];
+    /**
+     * Priority hint for model/client use
+     */
+    priority?: number;
+    /**
+     * Last-modified timestamp hint
+     */
+    lastModified?: string;
+    /**
+     * Server-provided non-standard annotation fields preserved from the MCP response
+     */
+    additionalProperties?: {
+        [k: string]: unknown | undefined;
+    };
+}
+/**
+ * MCP resource content with URI, optional MIME type, text or base64 blob, and resource metadata.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "McpResourceContent".
+ */
+/** @experimental */
+export interface McpResourceContent {
+    /**
+     * The resource URI
+     */
+    uri: string;
+    /**
+     * MIME type of the content
+     */
+    mimeType?: string;
+    /**
+     * Text content (e.g. HTML)
+     */
+    text?: string;
+    /**
+     * Base64-encoded binary content
+     */
+    blob?: string;
+    /**
+     * Resource-level metadata (CSP, permissions, etc.)
+     */
+    _meta?: {
+        [k: string]: unknown | undefined;
+    };
+}
+/**
+ * MCP server whose resources to enumerate.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "McpResourcesListRequest".
+ */
+/** @experimental */
+export interface McpResourcesListRequest {
+    /**
+     * Name of the MCP server whose resources to enumerate
+     */
+    serverName: string;
+    /**
+     * Opaque MCP pagination cursor from a prior `nextCursor` value
+     */
+    cursor?: string;
+}
+/**
+ * One page of resources advertised by the named MCP server.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "McpResourcesListResult".
+ */
+/** @experimental */
+export interface McpResourcesListResult {
+    /**
+     * Resources advertised by the server (proxied MCP `resources/list`)
+     */
+    resources: McpResource[];
+    /**
+     * Opaque cursor for the next page, if the server has more resources
+     */
+    nextCursor?: string;
+}
+/**
+ * MCP server whose resource templates to enumerate.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "McpResourcesListTemplatesRequest".
+ */
+/** @experimental */
+export interface McpResourcesListTemplatesRequest {
+    /**
+     * Name of the MCP server whose resource templates to enumerate
+     */
+    serverName: string;
+    /**
+     * Opaque MCP pagination cursor from a prior `nextCursor` value
+     */
+    cursor?: string;
+}
+/**
+ * One page of resource templates advertised by the named MCP server.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "McpResourcesListTemplatesResult".
+ */
+/** @experimental */
+export interface McpResourcesListTemplatesResult {
+    /**
+     * Resource templates advertised by the server (proxied MCP `resources/templates/list`)
+     */
+    resourceTemplates: McpResourceTemplate[];
+    /**
+     * Opaque cursor for the next page, if the server has more resource templates
+     */
+    nextCursor?: string;
+}
+/**
+ * An MCP resource template descriptor (spec `ResourceTemplate`): an RFC 6570 URI template, name, and optional title, description, MIME type, icons, annotations, and metadata. Server-provided fields outside the standard descriptor shape are exposed under `additionalProperties`.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "McpResourceTemplate".
+ */
+/** @experimental */
+export interface McpResourceTemplate {
+    /**
+     * An RFC 6570 URI template for constructing resource URIs
+     */
+    uriTemplate: string;
+    /**
+     * The programmatic name of the resource template
+     */
+    name: string;
+    /**
+     * Optional human-readable display title
+     */
+    title?: string;
+    /**
+     * Optional description of what this template is for
+     */
+    description?: string;
+    /**
+     * MIME type for resources matching this template, if uniform
+     */
+    mimeType?: string;
+    /**
+     * Icons associated with resources matching this template
+     */
+    icons?: McpResourceIcon[];
+    annotations?: McpResourceAnnotations;
+    /**
+     * Resource-template-level metadata
+     */
+    _meta?: {
+        [k: string]: unknown | undefined;
+    };
+    /**
+     * Server-provided non-standard descriptor fields preserved from the MCP response
+     */
+    additionalProperties?: {
+        [k: string]: unknown | undefined;
+    };
+}
+/**
+ * MCP server and resource URI to fetch.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "McpResourcesReadRequest".
+ */
+/** @experimental */
+export interface McpResourcesReadRequest {
+    /**
+     * Name of the MCP server hosting the resource
+     */
+    serverName: string;
+    /**
+     * Resource URI
+     */
+    uri: string;
+}
+/**
+ * Resource contents returned by the MCP server.
+ *
+ * This interface was referenced by `_RpcSchemaRoot`'s JSON-Schema
+ * via the `definition` "McpResourcesReadResult".
+ */
+/** @experimental */
+export interface McpResourcesReadResult {
+    /**
+     * Resource contents returned by the server
+     */
+    contents: McpResourceContent[];
+}
 /**
  * Server name and optional replacement configuration for an individual MCP server restart. Omit `config` for a config-free restart-by-name of an already-configured server.
  *
@@ -16100,11 +16387,13 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
         /** @experimental */
         apps: {
             /**
-             * Fetch an MCP resource (typically a `ui://` MCP App bundle, per SEP-1865) from a connected server. Requires the `mcp-apps` session capability.
+             * Deprecated/obsolete alias for `session.mcp.resources.read`; retained for backwards compatibility with earlier MCP Apps host integrations.
              *
-             * @param params MCP server and resource URI to fetch.
+             * @param params Deprecated/obsolete MCP Apps alias for `McpResourcesReadRequest`; use `session.mcp.resources.read` instead.
              *
-             * @returns Resource contents returned by the MCP server.
+             * @returns Deprecated/obsolete MCP Apps alias for `McpResourcesReadResult`; use `session.mcp.resources.read` instead.
+             *
+             * @deprecated
              */
             readResource: (params: McpAppsReadResourceRequest) => Promise<McpAppsReadResourceResult>;
             /**
@@ -16144,6 +16433,33 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
              */
             diagnose: (params: McpAppsDiagnoseRequest) => Promise<McpAppsDiagnoseResult>;
         };
+        /** @experimental */
+        resources: {
+            /**
+             * Fetch an MCP resource from a connected server by URI (proxies MCP `resources/read`).
+             *
+             * @param params MCP server and resource URI to fetch.
+             *
+             * @returns Resource contents returned by the MCP server.
+             */
+            read: (params: McpResourcesReadRequest) => Promise<McpResourcesReadResult>;
+            /**
+             * Enumerate one page of resources a connected MCP server exposes (proxies MCP `resources/list`). Pass `cursor` to continue from a prior result's `nextCursor`.
+             *
+             * @param params MCP server whose resources to enumerate.
+             *
+             * @returns One page of resources advertised by the named MCP server.
+             */
+            list: (params: McpResourcesListRequest) => Promise<McpResourcesListResult>;
+            /**
+             * Enumerate one page of resource templates a connected MCP server exposes (proxies MCP `resources/templates/list`). Pass `cursor` to continue from a prior result's `nextCursor`.
+             *
+             * @param params MCP server whose resource templates to enumerate.
+             *
+             * @returns One page of resource templates advertised by the named MCP server.
+             */
+            listTemplates: (params: McpResourcesListTemplatesRequest) => Promise<McpResourcesListTemplatesResult>;
+        };
     };
     /** @experimental */
     plugins: {

package/dist/generated/rpc.js

@@ -1203,11 +1203,13 @@ function createSessionRpc(connection, sessionId) {
       /** @experimental */
       apps: {
         /**
-         * Fetch an MCP resource (typically a `ui://` MCP App bundle, per SEP-1865) from a connected server. Requires the `mcp-apps` session capability.
+         * Deprecated/obsolete alias for `session.mcp.resources.read`; retained for backwards compatibility with earlier MCP Apps host integrations.
          *
-         * @param params MCP server and resource URI to fetch.
+         * @param params Deprecated/obsolete MCP Apps alias for `McpResourcesReadRequest`; use `session.mcp.resources.read` instead.
          *
-         * @returns Resource contents returned by the MCP server.
+         * @returns Deprecated/obsolete MCP Apps alias for `McpResourcesReadResult`; use `session.mcp.resources.read` instead.
+         *
+         * @deprecated
          */
         readResource: async (params) => connection.sendRequest("session.mcp.apps.readResource", { sessionId, ...params }),
         /**
@@ -1246,6 +1248,33 @@ function createSessionRpc(connection, sessionId) {
          * @returns Diagnostic snapshot of MCP Apps wiring for the named server.
          */
         diagnose: async (params) => connection.sendRequest("session.mcp.apps.diagnose", { sessionId, ...params })
+      },
+      /** @experimental */
+      resources: {
+        /**
+         * Fetch an MCP resource from a connected server by URI (proxies MCP `resources/read`).
+         *
+         * @param params MCP server and resource URI to fetch.
+         *
+         * @returns Resource contents returned by the MCP server.
+         */
+        read: async (params) => connection.sendRequest("session.mcp.resources.read", { sessionId, ...params }),
+        /**
+         * Enumerate one page of resources a connected MCP server exposes (proxies MCP `resources/list`). Pass `cursor` to continue from a prior result's `nextCursor`.
+         *
+         * @param params MCP server whose resources to enumerate.
+         *
+         * @returns One page of resources advertised by the named MCP server.
+         */
+        list: async (params) => connection.sendRequest("session.mcp.resources.list", { sessionId, ...params }),
+        /**
+         * Enumerate one page of resource templates a connected MCP server exposes (proxies MCP `resources/templates/list`). Pass `cursor` to continue from a prior result's `nextCursor`.
+         *
+         * @param params MCP server whose resource templates to enumerate.
+         *
+         * @returns One page of resource templates advertised by the named MCP server.
+         */
+        listTemplates: async (params) => connection.sendRequest("session.mcp.resources.listTemplates", { sessionId, ...params })
       }
     },
     /** @experimental */