@dlient/api-bridge 3.0.0

package/dist/index.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @dlient/api-bridge - 渲染进程「插件实例 API」共享桥。
+ *
+ * 这是插件与宿主之间唯一需要共享实例的模块：PluginApiContext + useDientApi。
+ * 必须作为 MF shared（singleton）由宿主提供，否则插件的 useDientApi 读到的是
+ * 插件自己打包的一份 Context，读不到宿主 PluginView 注入的值。
+ *
+ * 注意：本包必须保持极简 —— 只依赖 react 的命名导出（createContext/useContext），
+ * 不允许引入 JSX / 其它 CJS 依赖，否则会被 vite-plugin-federation 的 shared 预构建
+ * 打包出引用未定义 `require$$0` 的产物（见 package-ui.md 加载注意事项）。
+ */
+/** request / listen 的选项：plugin 缺省 = 自调用本插件 worker；data 为大块数据（transfer 零拷贝） */
+export interface RequestOptions {
+    plugin?: string;
+    data?: ArrayBuffer;
+}
+/** listen 返回的取消控制器（abort() 通知 worker 发 cancel） */
+export interface ListenController {
+    abort(): void;
+    readonly signal: {
+        readonly aborted: boolean;
+        addEventListener(cb: () => void): () => void;
+    };
+}
+export interface PluginApi {
+    /** 单响应请求：plugin 缺省连自己的 worker，传 { plugin } 跨插件直连目标 worker */
+    request: <T = unknown>(method: string, args?: unknown[], opts?: RequestOptions) => Promise<T>;
+    /** 流式请求：listener 逐块回调，返回 { abort, signal } 取消控制器 */
+    listen: (method: string, args: unknown[], listener: (chunk: unknown, data?: ArrayBuffer) => void, opts?: RequestOptions) => ListenController;
+    /** 推送订阅（worker push → 渲染层） */
+    onEvent: (name: string, cb: (data: unknown) => void) => () => void;
+}
+export declare const PluginApiContext: import("react").Context<PluginApi | null>;
+/** 插件组件访问「绑定本视图」的实例 API（连自己的 worker） */
+export declare function useDientApi(): PluginApi;

package/dist/index.mjs

@@ -0,0 +1,11 @@
+import { createContext, useContext } from 'react';
+
+const PluginApiContext = createContext(null);
+function useDientApi() {
+  const api = useContext(PluginApiContext);
+  if (!api) throw new Error("useDientApi must be used inside <PluginView>");
+  return api;
+}
+
+export { PluginApiContext, useDientApi };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../src/index.ts"],"sourcesContent":["/**\n * @dlient/api-bridge - 渲染进程「插件实例 API」共享桥。\n *\n * 这是插件与宿主之间唯一需要共享实例的模块：PluginApiContext + useDientApi。\n * 必须作为 MF shared（singleton）由宿主提供，否则插件的 useDientApi 读到的是\n * 插件自己打包的一份 Context，读不到宿主 PluginView 注入的值。\n *\n * 注意：本包必须保持极简 —— 只依赖 react 的命名导出（createContext/useContext），\n * 不允许引入 JSX / 其它 CJS 依赖，否则会被 vite-plugin-federation 的 shared 预构建\n * 打包出引用未定义 `require$$0` 的产物（见 package-ui.md 加载注意事项）。\n */\n\nimport { createContext, useContext } from 'react'\n\n/** request / listen 的选项：plugin 缺省 = 自调用本插件 worker；data 为大块数据（transfer 零拷贝） */\nexport interface RequestOptions {\n  plugin?: string\n  data?: ArrayBuffer\n}\n\n/** listen 返回的取消控制器（abort() 通知 worker 发 cancel） */\nexport interface ListenController {\n  abort(): void\n  readonly signal: {\n    readonly aborted: boolean\n    addEventListener(cb: () => void): () => void\n  }\n}\n\nexport interface PluginApi {\n  /** 单响应请求：plugin 缺省连自己的 worker，传 { plugin } 跨插件直连目标 worker */\n  request: <T = unknown>(method: string, args?: unknown[], opts?: RequestOptions) => Promise<T>\n  /** 流式请求：listener 逐块回调，返回 { abort, signal } 取消控制器 */\n  listen: (\n    method: string,\n    args: unknown[],\n    listener: (chunk: unknown, data?: ArrayBuffer) => void,\n    opts?: RequestOptions,\n  ) => ListenController\n  /** 推送订阅（worker push → 渲染层） */\n  onEvent: (name: string, cb: (data: unknown) => void) => () => void\n}\n\nexport const PluginApiContext = createContext<PluginApi | null>(null)\n\n/** 插件组件访问「绑定本视图」的实例 API（连自己的 worker） */\nexport function useDientApi(): PluginApi {\n  const api = useContext(PluginApiContext)\n  if (!api) throw new Error('useDientApi must be used inside <PluginView>')\n  return api\n}\n"],"names":[],"mappings":";;AA2CO,MAAM,gBAAA,GAAmB,cAAgC,IAAI;AAG7D,SAAS,WAAA,GAAyB;AACvC,EAAA,MAAM,GAAA,GAAM,WAAW,gBAAgB,CAAA;AACvC,EAAA,IAAI,CAAC,GAAA,EAAK,MAAM,IAAI,MAAM,8CAA8C,CAAA;AACxE,EAAA,OAAO,GAAA;AACT;;;;"}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@dlient/api-bridge",
+  "version": "3.0.0",
+  "private": false,
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "vite build && tsc -p tsconfig.json"
+  },
+  "peerDependencies": {
+    "react": "^18.2.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.2.0",
+    "typescript": "^5.4.0",
+    "vite": "^5.1.6"
+  }
+}