@motrix/mdxp 0.1.1 → 0.2.0

package/README.md

@@ -33,7 +33,8 @@ top of it.
 - **Transport-agnostic.** Works over anything that implements
   `MessageReader`/`MessageWriter`.
 - **Platform RAL entry points.** `./node` and `./browser` install the matching
-  `vscode-jsonrpc` runtime abstraction layer for you.
+  `vscode-jsonrpc` runtime abstraction layer and re-export its transport classes,
+  so you import everything — connection helper and reader/writer — from one place.
 - **Agent-ready.** A built-in tool registry emits a JSON-Schema tool catalog you
   can feed straight into an LLM function-calling API.
 - **Forward-compatible.** Unknown methods and fields are ignored, not rejected.
@@ -46,10 +47,11 @@ npm install @motrix/mdxp
 ```
 
 Runtime dependency: [`vscode-jsonrpc`](https://www.npmjs.com/package/vscode-jsonrpc)
-`^9`, a direct dependency installed alongside this package. The examples below
-also import reader/writer classes straight from `vscode-jsonrpc/node` and
-`vscode-jsonrpc/browser`; if you do the same, declare `vscode-jsonrpc` in your
-own dependencies rather than relying on hoisting. ESM-only; requires
+`^9`, installed alongside this package. Its transport classes (reader/writer)
+and the primitives that surface in this package's API — `MessageReader`,
+`MessageConnection`, `CancellationToken`, `CancellationTokenSource`, … — are
+re-exported from `@motrix/mdxp` (see [Entry points](#entry-points)), so you
+rarely need to import `vscode-jsonrpc` directly. ESM-only; requires
 Node.js ≥ 18 or a modern bundler.
 
 ### Entry points
@@ -63,16 +65,21 @@ Node.js ≥ 18 or a modern bundler.
 `vscode-jsonrpc` v9 requires a runtime abstraction layer (RAL) to be installed
 before a connection can be created. Importing `@motrix/mdxp/node` or
 `@motrix/mdxp/browser` installs the right one into the **same** `vscode-jsonrpc`
-instance this package uses, and re-exports the entire public API — so a host
-imports everything from a single place.
+instance this package uses, and re-exports the entire public API **plus that
+platform's transport classes** (`StreamMessageReader`/`Writer` for Node,
+`BrowserMessageReader`/`Writer` for the browser) — so a host imports everything,
+including its reader/writer, from a single place.
 
 ## Quick start
 
 ### Node host (over stdio)
 
 ```ts
-import { createMdxpConnection } from '@motrix/mdxp/node'
-import { StreamMessageReader, StreamMessageWriter } from 'vscode-jsonrpc/node'
+import {
+  createMdxpConnection,
+  StreamMessageReader,
+  StreamMessageWriter,
+} from '@motrix/mdxp/node'
 
 const conn = createMdxpConnection(
   new StreamMessageReader(process.stdin),
@@ -91,9 +98,12 @@ conn.listen()
 ### Browser host
 
 ```ts
-// Installs the browser RAL, then re-exports the full API.
-import { createMdxpConnection } from '@motrix/mdxp/browser'
-import { BrowserMessageReader, BrowserMessageWriter } from 'vscode-jsonrpc/browser'
+// Installs the browser RAL and re-exports the full API + transport classes.
+import {
+  createMdxpConnection,
+  BrowserMessageReader,
+  BrowserMessageWriter,
+} from '@motrix/mdxp/browser'
 
 // e.g. a MessagePort / Worker; adapt your WebSocket to reader/writer as needed.
 const conn = createMdxpConnection(
@@ -245,7 +255,7 @@ conn.onNotification('$/task/error', (p) => {
 handler observes `token.isCancellationRequested`.
 
 ```ts
-import { CancellationTokenSource } from 'vscode-jsonrpc'
+import { CancellationTokenSource } from '@motrix/mdxp'
 
 const cts = new CancellationTokenSource()
 const pending = conn.sendRequest('url/resolve', { url }, cts.token)
@@ -321,6 +331,7 @@ const tools = toAgentToolCatalog()
 | `toAgentToolCatalog()` | function | The `agentFacing` subset as JSON-Schema tools. |
 | `SERVER_INITIATED_METHODS` | const | Methods the server calls on the client (`url/probe`, `url/resolve`). |
 | `*Schema` | Zod schema | Every wire shape, for runtime validation. |
+| `MessageReader` · `MessageWriter` · `MessageConnection` · `CancellationToken` · `CancellationTokenSource` · `Disposable` | re-export | `vscode-jsonrpc` primitives used across the API. Platform transport classes (`StreamMessageReader`/`Writer`, `BrowserMessageReader`/`Writer`) are re-exported from `./node` and `./browser`. |
 
 ### Methods
 

package/README.zh-CN.md

@@ -28,7 +28,8 @@
   调用处无需任何 cast。
 - **transport-agnostic**：只要实现了 `MessageReader`/`MessageWriter`，任何双工流都能用。
 - **平台 RAL 入口**：`./node` 与 `./browser` 会替你装好对应的 `vscode-jsonrpc`
-  runtime abstraction layer。
+  runtime abstraction layer，并 re-export 它的 transport class —— 连接封装与
+  reader/writer 都从同一处 import。
 - **面向 agent**：内置的 tool registry 可产出一份 JSON-Schema tool catalog，
   能直接对接 LLM 的 function-calling API。
 - **forward-compatible**：遇到未知的 method 或字段选择忽略，而非 reject。
@@ -41,10 +42,11 @@ npm install @motrix/mdxp
 ```
 
 运行时依赖：[`vscode-jsonrpc`](https://www.npmjs.com/package/vscode-jsonrpc)
-`^9`，是本包的直接 `dependency`，会随本包一并装上。下面的示例还直接从
-`vscode-jsonrpc/node` 和 `vscode-jsonrpc/browser` import reader/writer 类；若你也
-这样用，请在自己的 dependencies 里显式声明 `vscode-jsonrpc`，不要依赖 hoisting。
-仅 ESM；需要 Node.js ≥ 18 或现代 bundler。
+`^9`，随本包一并装上。它的 transport class（reader/writer），以及在本包 API 中出现的
+那些 primitive —— `MessageReader`、`MessageConnection`、`CancellationToken`、
+`CancellationTokenSource` 等 —— 都已从 `@motrix/mdxp` re-export（见
+[入口点](#入口点)），因此你几乎无需直接 import `vscode-jsonrpc`。仅 ESM；需要
+Node.js ≥ 18 或现代 bundler。
 
 ### 入口点
 
@@ -56,16 +58,20 @@ npm install @motrix/mdxp
 
 `vscode-jsonrpc` v9 要求先装好一层 runtime abstraction layer（RAL），才能创建连接。
 import `@motrix/mdxp/node` 或 `@motrix/mdxp/browser` 会把对应的 RAL 装进本包所用的
-**同一个** `vscode-jsonrpc` 实例，并 re-export 完整的公开 API —— 于是 host 只需从
-一个入口 import 一切。
+**同一个** `vscode-jsonrpc` 实例，并 re-export 完整的公开 API，**外加该平台的
+transport class**（Node 的 `StreamMessageReader`/`Writer`、浏览器的
+`BrowserMessageReader`/`Writer`）—— 于是 host 连同 reader/writer 都只需从一个入口 import。
 
 ## 快速开始
 
 ### Node host（走 stdio）
 
 ```ts
-import { createMdxpConnection } from '@motrix/mdxp/node'
-import { StreamMessageReader, StreamMessageWriter } from 'vscode-jsonrpc/node'
+import {
+  createMdxpConnection,
+  StreamMessageReader,
+  StreamMessageWriter,
+} from '@motrix/mdxp/node'
 
 const conn = createMdxpConnection(
   new StreamMessageReader(process.stdin),
@@ -84,9 +90,12 @@ conn.listen()
 ### 浏览器 host
 
 ```ts
-// 装好 browser RAL，并 re-export 全量 API。
-import { createMdxpConnection } from '@motrix/mdxp/browser'
-import { BrowserMessageReader, BrowserMessageWriter } from 'vscode-jsonrpc/browser'
+// 装好 browser RAL，并 re-export 全量 API + transport class。
+import {
+  createMdxpConnection,
+  BrowserMessageReader,
+  BrowserMessageWriter,
+} from '@motrix/mdxp/browser'
 
 // 例如一个 MessagePort / Worker；若用 WebSocket，需自行适配成 reader/writer。
 const conn = createMdxpConnection(
@@ -232,7 +241,7 @@ conn.onNotification('$/task/error', (p) => {
 `token.isCancellationRequested` 即可响应。
 
 ```ts
-import { CancellationTokenSource } from 'vscode-jsonrpc'
+import { CancellationTokenSource } from '@motrix/mdxp'
 
 const cts = new CancellationTokenSource()
 const pending = conn.sendRequest('url/resolve', { url }, cts.token)
@@ -306,6 +315,7 @@ const tools = toAgentToolCatalog()
 | `toAgentToolCatalog()` | function | 取 `agentFacing` 子集，转成 JSON-Schema tools。 |
 | `SERVER_INITIATED_METHODS` | const | 由 server 向 client 发起的 method（`url/probe`、`url/resolve`）。 |
 | `*Schema` | Zod schema | 全部 wire 形态，供运行时校验。 |
+| `MessageReader` · `MessageWriter` · `MessageConnection` · `CancellationToken` · `CancellationTokenSource` · `Disposable` | re-export | 本包 API 中用到的 `vscode-jsonrpc` primitive。平台 transport class（`StreamMessageReader`/`Writer`、`BrowserMessageReader`/`Writer`）从 `./node` 与 `./browser` re-export。 |
 
 ### Methods
 

package/dist/browser.d.ts

@@ -1,3 +1,4 @@
 import 'vscode-jsonrpc/browser';
+export { BrowserMessageReader, BrowserMessageWriter, } from 'vscode-jsonrpc/browser';
 export * from './index.js';
 //# sourceMappingURL=browser.d.ts.map

package/dist/browser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAWA,OAAO,wBAAwB,CAAA;AAE/B,cAAc,YAAY,CAAA"}
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAWA,OAAO,wBAAwB,CAAA;AAM/B,OAAO,EACL,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,wBAAwB,CAAA;AAC/B,cAAc,YAAY,CAAA"}

package/dist/browser.js

@@ -10,5 +10,10 @@
 // `@motrix/mdxp/browser` once at startup. The full public API is re-exported, so
 // `import { createMdxpConnection } from '@motrix/mdxp/browser'` also works.
 import 'vscode-jsonrpc/browser';
+// Browser transport classes, re-exported so a browser host imports its
+// reader/writer from the same place as `createMdxpConnection` — no separate
+// `vscode-jsonrpc` import, and guaranteed to be the instance this package
+// installed the RAL into.
+export { BrowserMessageReader, BrowserMessageWriter, } from 'vscode-jsonrpc/browser';
 export * from './index.js';
 //# sourceMappingURL=browser.js.map

package/dist/browser.js.map

@@ -1 +1 @@
-{"version":3,"file":"browser.js","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAC1B,EAAE;AACF,8EAA8E;AAC9E,0EAA0E;AAC1E,gFAAgF;AAChF,8EAA8E;AAC9E,mCAAmC;AACnC,EAAE;AACF,uEAAuE;AACvE,iFAAiF;AACjF,4EAA4E;AAC5E,OAAO,wBAAwB,CAAA;AAE/B,cAAc,YAAY,CAAA"}
+{"version":3,"file":"browser.js","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAC1B,EAAE;AACF,8EAA8E;AAC9E,0EAA0E;AAC1E,gFAAgF;AAChF,8EAA8E;AAC9E,mCAAmC;AACnC,EAAE;AACF,uEAAuE;AACvE,iFAAiF;AACjF,4EAA4E;AAC5E,OAAO,wBAAwB,CAAA;AAE/B,uEAAuE;AACvE,4EAA4E;AAC5E,0EAA0E;AAC1E,0BAA0B;AAC1B,OAAO,EACL,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,wBAAwB,CAAA;AAC/B,cAAc,YAAY,CAAA"}

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+export type { Disposable, MessageConnection, MessageReader, MessageWriter, } from 'vscode-jsonrpc';
+export { CancellationToken, CancellationTokenSource } from 'vscode-jsonrpc';
 export type { MdxpConnection, MdxpNotificationMap, MdxpRequestMap, } from './connection.js';
 export { createMdxpConnection } from './connection.js';
 export type { ErrorCode, MdxpError, MdxpErrorData } from './errors.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,YAAY,EACV,cAAc,EACd,mBAAmB,EACnB,cAAc,GACf,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAA;AACtD,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AACtE,OAAO,EACL,UAAU,EACV,aAAa,EACb,eAAe,EACf,aAAa,GACd,MAAM,aAAa,CAAA;AACpB,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AACxD,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAGrD,cAAc,oBAAoB,CAAA;AAClC,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAGxD,OAAO,EACL,wBAAwB,EACxB,KAAK,EACL,kBAAkB,GACnB,MAAM,YAAY,CAAA;AAEnB,mBAAmB,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAOA,YAAY,EACV,UAAU,EACV,iBAAiB,EACjB,aAAa,EACb,aAAa,GACd,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAE,iBAAiB,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAA;AAC3E,YAAY,EACV,cAAc,EACd,mBAAmB,EACnB,cAAc,GACf,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAA;AACtD,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AACtE,OAAO,EACL,UAAU,EACV,aAAa,EACb,eAAe,EACf,aAAa,GACd,MAAM,aAAa,CAAA;AACpB,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AACxD,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAGrD,cAAc,oBAAoB,CAAA;AAClC,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAGxD,OAAO,EACL,wBAAwB,EACxB,KAAK,EACL,kBAAkB,GACnB,MAAM,YAAY,CAAA;AAEnB,mBAAmB,YAAY,CAAA"}

package/dist/index.js

@@ -1,5 +1,6 @@
 // MDXP — Motrix Download eXchange Protocol
 // Public API surface for both Motrix desktop and the browser extension.
+export { CancellationToken, CancellationTokenSource } from 'vscode-jsonrpc';
 export { createMdxpConnection } from './connection.js';
 export { ErrorCodes, isMotrixError, isProtocolError, makeMdxpError, } from './errors.js';
 export { Methods, Notifications } from './methods.js';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,2CAA2C;AAC3C,wEAAwE;AAOxE,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAA;AAEtD,OAAO,EACL,UAAU,EACV,aAAa,EACb,eAAe,EACf,aAAa,GACd,MAAM,aAAa,CAAA;AAEpB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAErD,qDAAqD;AACrD,cAAc,oBAAoB,CAAA;AAGlC,wCAAwC;AACxC,OAAO,EACL,wBAAwB,EACxB,KAAK,EACL,kBAAkB,GACnB,MAAM,YAAY,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,2CAA2C;AAC3C,wEAAwE;AAYxE,OAAO,EAAE,iBAAiB,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAA;AAM3E,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAA;AAEtD,OAAO,EACL,UAAU,EACV,aAAa,EACb,eAAe,EACf,aAAa,GACd,MAAM,aAAa,CAAA;AAEpB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAErD,qDAAqD;AACrD,cAAc,oBAAoB,CAAA;AAGlC,wCAAwC;AACxC,OAAO,EACL,wBAAwB,EACxB,KAAK,EACL,kBAAkB,GACnB,MAAM,YAAY,CAAA"}

package/dist/node.d.ts

@@ -1,3 +1,4 @@
 import 'vscode-jsonrpc/node';
+export { IPCMessageReader, IPCMessageWriter, PortMessageReader, PortMessageWriter, SocketMessageReader, SocketMessageWriter, StreamMessageReader, StreamMessageWriter, } from 'vscode-jsonrpc/node';
 export * from './index.js';
 //# sourceMappingURL=node.d.ts.map

package/dist/node.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../src/node.ts"],"names":[],"mappings":"AAYA,OAAO,qBAAqB,CAAA;AAE5B,cAAc,YAAY,CAAA"}
+{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../src/node.ts"],"names":[],"mappings":"AAYA,OAAO,qBAAqB,CAAA;AAK5B,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,qBAAqB,CAAA;AAC5B,cAAc,YAAY,CAAA"}

package/dist/node.js

@@ -11,5 +11,9 @@
 // once at bootstrap. The full public API is re-exported for convenience, so
 // `import { createMdxpConnection } from '@motrix/mdxp/node'` also works.
 import 'vscode-jsonrpc/node';
+// Node transport classes, re-exported so a Node host imports its reader/writer
+// from the same place as `createMdxpConnection` — no separate `vscode-jsonrpc`
+// import, and guaranteed to be the instance this package installed the RAL into.
+export { IPCMessageReader, IPCMessageWriter, PortMessageReader, PortMessageWriter, SocketMessageReader, SocketMessageWriter, StreamMessageReader, StreamMessageWriter, } from 'vscode-jsonrpc/node';
 export * from './index.js';
 //# sourceMappingURL=node.js.map

package/dist/node.js.map

@@ -1 +1 @@
-{"version":3,"file":"node.js","sourceRoot":"","sources":["../src/node.ts"],"names":[],"mappings":"AAAA,uBAAuB;AACvB,EAAE;AACF,8EAA8E;AAC9E,0EAA0E;AAC1E,gFAAgF;AAChF,2EAA2E;AAC3E,gFAAgF;AAChF,4BAA4B;AAC5B,EAAE;AACF,mFAAmF;AACnF,4EAA4E;AAC5E,yEAAyE;AACzE,OAAO,qBAAqB,CAAA;AAE5B,cAAc,YAAY,CAAA"}
+{"version":3,"file":"node.js","sourceRoot":"","sources":["../src/node.ts"],"names":[],"mappings":"AAAA,uBAAuB;AACvB,EAAE;AACF,8EAA8E;AAC9E,0EAA0E;AAC1E,gFAAgF;AAChF,2EAA2E;AAC3E,gFAAgF;AAChF,4BAA4B;AAC5B,EAAE;AACF,mFAAmF;AACnF,4EAA4E;AAC5E,yEAAyE;AACzE,OAAO,qBAAqB,CAAA;AAE5B,+EAA+E;AAC/E,+EAA+E;AAC/E,iFAAiF;AACjF,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,qBAAqB,CAAA;AAC5B,cAAc,YAAY,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@motrix/mdxp",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Motrix Download eXchange Protocol — JSON-RPC 2.0 wire types and connection helpers",
   "license": "MIT",
   "author": "Motrix",

package/src/browser.ts

@@ -11,4 +11,12 @@
 // `import { createMdxpConnection } from '@motrix/mdxp/browser'` also works.
 import 'vscode-jsonrpc/browser'
 
+// Browser transport classes, re-exported so a browser host imports its
+// reader/writer from the same place as `createMdxpConnection` — no separate
+// `vscode-jsonrpc` import, and guaranteed to be the instance this package
+// installed the RAL into.
+export {
+  BrowserMessageReader,
+  BrowserMessageWriter,
+} from 'vscode-jsonrpc/browser'
 export * from './index.js'

package/src/index.ts

@@ -1,6 +1,17 @@
 // MDXP — Motrix Download eXchange Protocol
 // Public API surface for both Motrix desktop and the browser extension.
 
+// vscode-jsonrpc primitives that appear in this package's public API surface,
+// re-exported so consumers import them from `@motrix/mdxp` instead of reaching
+// for a second package. Platform transport classes (StreamMessageReader,
+// BrowserMessageReader, …) are re-exported from `./node` and `./browser`.
+export type {
+  Disposable,
+  MessageConnection,
+  MessageReader,
+  MessageWriter,
+} from 'vscode-jsonrpc'
+export { CancellationToken, CancellationTokenSource } from 'vscode-jsonrpc'
 export type {
   MdxpConnection,
   MdxpNotificationMap,

package/src/node.ts

@@ -12,4 +12,17 @@
 // `import { createMdxpConnection } from '@motrix/mdxp/node'` also works.
 import 'vscode-jsonrpc/node'
 
+// Node transport classes, re-exported so a Node host imports its reader/writer
+// from the same place as `createMdxpConnection` — no separate `vscode-jsonrpc`
+// import, and guaranteed to be the instance this package installed the RAL into.
+export {
+  IPCMessageReader,
+  IPCMessageWriter,
+  PortMessageReader,
+  PortMessageWriter,
+  SocketMessageReader,
+  SocketMessageWriter,
+  StreamMessageReader,
+  StreamMessageWriter,
+} from 'vscode-jsonrpc/node'
 export * from './index.js'