@mbws/plugin-sdk 0.1.1 → 0.2.1

package/dist/contract.js

@@ -12,6 +12,9 @@
 function injectedPluginCode() {
     return typeof __MBWS_PLUGIN_CODE__ !== "undefined" ? __MBWS_PLUGIN_CODE__ : undefined;
 }
+function injectedDevContractBase() {
+    return typeof __MBWS_DEV_CONTRACT_BASE__ !== "undefined" ? __MBWS_DEV_CONTRACT_BASE__ : undefined;
+}
 /** manifest.id 按 baseURI 记忆化——同一页面重复调用不再多发 manifest 请求 */
 const manifestIdCache = new Map();
 /** 从本工程根读 manifest.id（dev server / 解包产物内 manifest.json 均在 baseURI 根） */
@@ -38,11 +41,12 @@ async function readManifestId() {
 /** 按插件编号拉关联任务的最新契约。非 2xx 抛带状态码与后端 message 的 Error。 */
 export async function fetchContract(opts = {}) {
     const pluginCode = opts.pluginCode ?? injectedPluginCode() ?? (await readManifestId());
-    const baseUrl = (opts.baseUrl ?? "").replace(/\/+$/, "");
+    // URL 前缀：dev 注入值优先（同源走插件中间件，免 CORS），否则 baseUrl（缺省同源相对）
+    const prefix = injectedDevContractBase() ?? (opts.baseUrl ?? "").replace(/\/+$/, "");
     const headers = {};
     if (opts.devKey)
         headers["X-Dev-Key"] = opts.devKey;
-    const response = await fetch(`${baseUrl}/api/plugin-dev-tasks/contract/by-plugin/${encodeURIComponent(pluginCode)}`, { headers, signal: opts.signal });
+    const response = await fetch(`${prefix}/api/plugin-dev-tasks/contract/by-plugin/${encodeURIComponent(pluginCode)}`, { headers, signal: opts.signal });
     if (!response.ok) {
         let message = `契约拉取失败（HTTP ${response.status}）`;
         try {

package/dist/vite.d.ts

@@ -0,0 +1,12 @@
+import type { Plugin } from "vite";
+import { type MbwsUserConfig } from "./config.js";
+export interface MbwsVitePluginOptions {
+    /** mbws.config.ts 的配置（defineConfig 回传值）——静态合同与动态开发配置同住 */
+    config: MbwsUserConfig;
+}
+/**
+ * mbws vite 插件。dev 预览下契约拉取同源化：SDK fetchContract 读到注入的
+ * `__MBWS_DEV_CONTRACT_BASE__` 后改打 `/__mbws__/api/...`，由本插件的中间件
+ * 转发到真实后端——插件 dev 端口不在后端 CORS 白名单的问题由此消解。
+ */
+export declare function mbwsVitePlugin(opts: MbwsVitePluginOptions): Plugin;

package/dist/vite.js

@@ -0,0 +1,155 @@
+/**
+ * 插件工程的 vite 插件——把平台机械（manifest 派生 / define 注入 / dev 虚拟供给与
+ * 后端转发）收敛进 SDK，工程 vite.config.ts 只留 `mbwsVitePlugin({ config })` 一行。
+ *
+ * 承担四件事（对齐原脚手架模板内联版语义）：
+ * - define 注入插件编号（build/serve 都注入），serve 额外注入 dev 契约前缀；
+ * - 缺省补 base: "./"（产物在 OSS 子目录 / registry 代理路径下托管）、双入口
+ *   rollupOptions.input（panel.html / viewer.html）与 build.outDir（解包形态目录，
+ *   与 manifest 同目录——缺省 dist/ 根会两处分离破坏 CI 打包约定），用户已设项不覆盖；
+ * - dev 虚拟供给 /manifest.json（buildManifest 派生，与 build 产物同源）；
+ * - dev 转发 /__mbws__/api/* 到后端（Node 全局 fetch，不走 server.proxy——
+ *   用户自己的 proxy 配置自由，互不干扰）；
+ * - build 后往 dist/<id>@<version>/ 写 manifest.json（产物直出解包形态目录）。
+ *
+ * vite 只进 devDependencies 供类型与测试（type-only import），SDK 产物不依赖 vite。
+ */
+import fs from "node:fs";
+import path from "node:path";
+import { buildManifest } from "./config.js";
+/** dev 契约拉取的专属命名空间：同源走插件中间件转发，免 CORS */
+const DEV_CONTRACT_BASE = "/__mbws__";
+/** 后端缺省地址：插件开发者缺省连线上（拉线上 spec），本地联调走 env 或 apiBaseUrl */
+const DEFAULT_API_BASE = "https://union.mobiwusi.com";
+/** dev 转发目标：config.apiBaseUrl > shell env > 线上（发包即线上，地址不是工程配置项） */
+function resolveApiBase(config) {
+    return (config.apiBaseUrl ?? process.env.MBWS_API_BASE_URL ?? DEFAULT_API_BASE).replace(/\/+$/, "");
+}
+/** 读请求体（POST 等带 body 的转发用；GET/HEAD 直接跳过） */
+function readRequestBody(req) {
+    return new Promise((resolve, reject) => {
+        const chunks = [];
+        req.on("data", (chunk) => chunks.push(chunk));
+        req.on("end", () => resolve(Buffer.concat(chunks)));
+        req.on("error", reject);
+    });
+}
+/**
+ * mbws vite 插件。dev 预览下契约拉取同源化：SDK fetchContract 读到注入的
+ * `__MBWS_DEV_CONTRACT_BASE__` 后改打 `/__mbws__/api/...`，由本插件的中间件
+ * 转发到真实后端——插件 dev 端口不在后端 CORS 白名单的问题由此消解。
+ */
+export function mbwsVitePlugin(opts) {
+    const { config } = opts;
+    // 工程 root：config 钩子里记（用户显式 root 优先），closeBundle 写产物时用
+    let projectRoot = process.cwd();
+    // manifest 是纯派生物，构建/供给共用同一序列化姿势（尾换行对齐文件写习惯）
+    const manifestJson = () => `${JSON.stringify(buildManifest(config), null, 2)}\n`;
+    // 解包形态目录 <id>@<version>/：静态产物与 manifest 同目录（CI 的 tar -C 按它整目录打包）
+    const distDir = () => path.resolve(projectRoot, `dist/${config.id}@${config.version}`);
+    return {
+        name: "mbws-plugin",
+        config(userConfig, { command }) {
+            projectRoot = userConfig.root ?? process.cwd();
+            const define = {
+                __MBWS_PLUGIN_CODE__: JSON.stringify(config.id),
+            };
+            // dev 专用前缀只在 serve 注入——build 产物绝不含 /__mbws__（宿主内无此路由）
+            if (command === "serve") {
+                define.__MBWS_DEV_CONTRACT_BASE__ = JSON.stringify(DEV_CONTRACT_BASE);
+            }
+            // 增量配置（vite 浅合并，不覆盖用户已设项）
+            const incremental = { define };
+            // 相对 base：产物在 OSS 子目录 / registry 代理路径下托管，资源引用必须是 ./ 相对路径
+            if (!userConfig.base)
+                incremental.base = "./";
+            // 构建缺省（用户已设项不覆盖）：
+            // - outDir 必须钉到解包形态目录——vite 缺省吐 dist/ 根会与 closeBundle 写的
+            //   manifest.json 分离，CI 的 tar 只打包到孤零零的 manifest（解包形态约定被破坏）
+            // - 只打包宿主要装载的两个入口；根 index.html 欢迎页是 dev 导航，不进产物
+            const buildDefaults = {};
+            if (!userConfig.build?.outDir)
+                buildDefaults.outDir = distDir();
+            if (!userConfig.build?.rollupOptions?.input) {
+                buildDefaults.rollupOptions = {
+                    input: [path.resolve(projectRoot, "panel.html"), path.resolve(projectRoot, "viewer.html")],
+                };
+            }
+            if (Object.keys(buildDefaults).length > 0)
+                incremental.build = buildDefaults;
+            // 依赖预构建不消费顶层 define，漏了 SDK 里的注入读取在 dev 侧失效。
+            // vite 8 依赖优化换 Rolldown：esbuildOptions 已废弃（启动即告警）；rolldown 的
+            // define 在 transform 子对象下（rolldown InputOptions.transform.define）
+            if (command === "serve") {
+                incremental.optimizeDeps = {
+                    rolldownOptions: {
+                        transform: { define: { __MBWS_PLUGIN_CODE__: JSON.stringify(config.id) } },
+                    },
+                };
+            }
+            return incremental;
+        },
+        configureServer(server) {
+            server.middlewares.use((req, res, next) => {
+                const pathname = (req.url ?? "").split("?")[0];
+                if (pathname === "/manifest.json") {
+                    // dev 虚拟供给：SDK fetchContract 的 manifest 兜底读取在 dev/产物两形态行为一致
+                    res.setHeader("content-type", "application/json");
+                    res.end(manifestJson());
+                    return;
+                }
+                if (pathname.startsWith(`${DEV_CONTRACT_BASE}/api`)) {
+                    // 转发异步进行，失败交 next（connect 约定）；返回 promise 供测试 await
+                    return forwardApi(config, req, res).catch(next);
+                }
+                next();
+                return undefined;
+            });
+        },
+        closeBundle() {
+            // 产物直出解包形态目录 <id>@<version>/，桌面 MBWS_DEV_PLUGIN_DIR 指向 dist 即装载
+            const outDir = distDir();
+            // mkdir 容错：在线构建场景 outDir 被平台覆盖，本目录可能不存在（写失败会炸构建）
+            fs.mkdirSync(outDir, { recursive: true });
+            fs.writeFileSync(path.join(outDir, "manifest.json"), manifestJson());
+        },
+    };
+}
+/** /__mbws__/<rest> → <apiBase>/<rest>：方法/头透传，响应状态码/content-type/body 透传 */
+async function forwardApi(config, req, res) {
+    const pathname = (req.url ?? "").split("?")[0];
+    const rest = pathname.slice(DEV_CONTRACT_BASE.length);
+    try {
+        // 头透传（host/connection 是逐跳头，指向 dev server 自身，不能带给后端）
+        const headers = {};
+        for (const [key, value] of Object.entries(req.headers)) {
+            if (value === undefined || key === "host" || key === "connection")
+                continue;
+            headers[key] = Array.isArray(value) ? value.join(", ") : String(value);
+        }
+        const method = req.method ?? "GET";
+        const body = method === "GET" || method === "HEAD"
+            ? undefined
+            : (await readRequestBody(req));
+        // 查询串原样保留（/api/x?k=v 转发不丢参）
+        const search = (req.url ?? "").slice(pathname.length);
+        const upstream = await fetch(`${resolveApiBase(config)}${rest}${search}`, {
+            method,
+            headers,
+            body,
+        });
+        res.statusCode = upstream.status;
+        const contentType = upstream.headers.get("content-type");
+        if (contentType)
+            res.setHeader("content-type", contentType);
+        res.end(Buffer.from(await upstream.arrayBuffer()));
+    }
+    catch (error) {
+        // 转发失败按网关错误处理：JSON 错误体对齐后端统一错误格式
+        res.statusCode = 502;
+        res.setHeader("content-type", "application/json");
+        res.end(JSON.stringify({
+            message: `mbws dev forward failed: ${error instanceof Error ? error.message : String(error)}`,
+        }));
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mbws/plugin-sdk",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "description": "Moye 插件开发 SDK——panel/viewer 与宿主的类型定义与运行时端口适配",
   "license": "MIT",
   "type": "module",
@@ -10,6 +10,10 @@
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
+    },
+    "./vite": {
+      "types": "./dist/vite.d.ts",
+      "default": "./dist/vite.js"
     }
   },
   "publishConfig": {
@@ -21,8 +25,12 @@
   "dependencies": {
     "zod": "^4.4.3"
   },
+  "devDependencies": {
+    "vite": "^8.0.14"
+  },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
+    "test": "vitest run",
     "pack:sdk": "pnpm build && pnpm pack"
   }
 }