@pactor-app/vite-plugin 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Pactor Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,97 @@
+# @pactor-app/vite-plugin
+
+[Pactor](https://github.com/426-330/pactor) 的 Vite 插件：把 `.page.yaml` / `.fragment.yaml` DSL 文件在构建期转换为 JS 模块（Parse → Validate → Compile），支持 HMR。校验复用 @pactor-app/schema 的 `validatePageDsl`。
+
+## 安装
+
+```bash
+npm install @pactor-app/vite-plugin
+# 或
+pnpm add @pactor-app/vite-plugin
+```
+
+`vite >= 5` 为 peer dependency。
+
+## 用法
+
+```ts
+// vite.config.ts
+import { defineConfig } from 'vite';
+import pactor from '@pactor-app/vite-plugin';
+
+export default defineConfig({
+  plugins: [pactor()],
+});
+```
+
+之后即可直接 import YAML DSL 文件：
+
+```ts
+import page from './user-list.page.yaml';
+import { dslVersion } from './user-list.page.yaml';
+
+console.log(page.page.id, dslVersion);
+```
+
+约定：
+
+- 默认仅匹配 `*.page.yaml/.yml` 与 `*.fragment.yaml/.yml`（不误伤普通 yaml 配置）。
+- `*.page.*` 走 `validatePageDsl` 完整 Schema 校验；`*.fragment.*` 做结构宽松检查（存在 `dsl` 与 `body`）。
+- 校验失败或 YAML 语法错误（带行列位置）使构建报错，错误信息含文件标识与每条 `path: message (keyword)`。
+- dev 时修改 DSL 文件触发热更新；无模块记录时全量刷新。
+
+## 选项
+
+```ts
+pactor({
+  // 自定义匹配规则（覆盖默认后缀约定）
+  include: /\.dsl\.yaml$/,
+  // 关闭构建期 Schema 校验（默认 true），仅编译
+  validate: false,
+});
+```
+
+自定义 `include` 时，文件名含 `.fragment.` 的按 FragmentDsl 处理，其余按 PageDsl 处理。
+
+## TypeScript 模块声明
+
+在业务工程中添加 `dsl-modules.d.ts`，让 TS 识别 YAML 模块：
+
+```ts
+declare module '*.page.yaml' {
+  import type { PageDsl } from '@pactor-app/core';
+  const page: PageDsl;
+  export const dslVersion: string;
+  export default page;
+}
+
+declare module '*.fragment.yaml' {
+  import type { FragmentDsl } from '@pactor-app/core';
+  const fragment: FragmentDsl;
+  export const dslVersion: string;
+  export default fragment;
+}
+```
+
+## 与 StaticDslLoader 组合
+
+构建期 import 的 DSL 可喂给 @pactor-app/resource 的 `StaticDslLoader`（examples / 单测 / 本地 DSL 开发）：
+
+```ts
+import { StaticDslLoader } from '@pactor-app/resource';
+import userListPage from './user-list.page.yaml';
+
+const loader = new StaticDslLoader({
+  pages: { 'user-list': userListPage },
+});
+```
+
+注意：主推荐模式仍是 Runtime API 动态加载（`HttpDslResourceLoader` + 服务端 DSL 端点），本插件适用于本地开发、示例与测试场景。
+
+## 文档
+
+完整文档见 <https://github.com/426-330/pactor/tree/main/docs>（`pnpm docs:dev` 本地启动文档站）。
+
+## License
+
+[MIT](../../LICENSE)

package/dist/index.cjs

@@ -0,0 +1,104 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  default: () => index_default,
+  pactor: () => pactor
+});
+module.exports = __toCommonJS(index_exports);
+var import_yaml = require("yaml");
+var import_schema = require("@pactor-app/schema");
+var DEFAULT_INCLUDE = /\.(page|fragment)\.(yaml|yml)$/;
+var FRAGMENT_RE = /\.fragment\.(yaml|yml)$/;
+function toIncludeList(include) {
+  if (include === void 0) return [DEFAULT_INCLUDE];
+  return Array.isArray(include) ? include : [include];
+}
+function pactor(options = {}) {
+  const includeList = toIncludeList(options.include);
+  const shouldValidate = options.validate !== false;
+  const matches = (id) => includeList.some((re) => re.test(id));
+  return {
+    name: "pactor",
+    enforce: "pre",
+    transform(code, id) {
+      if (!matches(id)) return null;
+      const doc = (0, import_yaml.parseDocument)(code);
+      if (doc.errors.length > 0) {
+        const details = doc.errors.map((error) => {
+          const pos = error.linePos?.[0];
+          const where = pos ? `\u884C ${pos.line} \u5217 ${pos.col}` : "\u672A\u77E5\u4F4D\u7F6E";
+          return `${where}: ${error.message}`;
+        }).join("\n  ");
+        this.error(`[pactor] YAML \u8BED\u6CD5\u9519\u8BEF ${id}:
+  ${details}`);
+      }
+      const data = doc.toJS();
+      const isFragment = FRAGMENT_RE.test(id);
+      if (isFragment) {
+        if (shouldValidate) {
+          const fragment = data;
+          if (fragment === null || typeof fragment !== "object" || fragment.dsl === void 0 || fragment.body === void 0) {
+            this.error(
+              `[pactor] Fragment DSL \u7ED3\u6784\u4E0D\u5B8C\u6574 ${id}:
+  /: \u5FC5\u987B\u5B58\u5728 dsl \u4E0E body \u5B57\u6BB5 (required)`
+            );
+          }
+        }
+        const json2 = JSON.stringify(data);
+        return {
+          code: `const fragment = ${json2};
+export const dslVersion = fragment.dsl;
+export default fragment;
+`,
+          map: null
+        };
+      }
+      if (shouldValidate) {
+        const result = (0, import_schema.validatePageDsl)(data);
+        if (!result.valid) {
+          const details = result.errors.map((error) => `${error.path}: ${error.message} (${error.keyword})`).join("\n  ");
+          this.error(`[pactor] Page DSL \u6821\u9A8C\u5931\u8D25 ${id}:
+  ${details}`);
+        }
+      }
+      const json = JSON.stringify(data);
+      return {
+        code: `const page = ${json};
+export const dslVersion = page.dsl;
+export default page;
+`,
+        map: null
+      };
+    },
+    handleHotUpdate({ file, server, modules }) {
+      if (!matches(file)) return void 0;
+      if (modules.length > 0) return modules;
+      server.ws.send({ type: "full-reload" });
+      return [];
+    }
+  };
+}
+var index_default = pactor;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  pactor
+});

package/dist/index.d.cts

@@ -0,0 +1,22 @@
+import { Plugin } from 'vite';
+
+/** 插件选项 */
+interface PactorPluginOptions {
+    /**
+     * 自定义匹配规则（覆盖默认的 `.page./.fragment.` 后缀约定）。
+     * 自定义规则下文件名含 `.fragment.` 的按 FragmentDsl 处理，其余按 PageDsl 处理。
+     */
+    include?: RegExp | RegExp[];
+    /** 是否执行 Schema 校验（默认 true；false 时仅编译不校验） */
+    validate?: boolean;
+}
+/**
+ * 创建 Pactor Vite 插件。
+ *
+ * 转换管线：YAML 解析（语法错误带位置）→ page 走 `validatePageDsl` 完整校验 /
+ * fragment 宽松检查（存在 `dsl` 与 `body`）→ 输出
+ * `export default <DSL 对象>` 与 `export const dslVersion`。
+ */
+declare function pactor(options?: PactorPluginOptions): Plugin;
+
+export { type PactorPluginOptions, pactor as default, pactor };

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+import { Plugin } from 'vite';
+
+/** 插件选项 */
+interface PactorPluginOptions {
+    /**
+     * 自定义匹配规则（覆盖默认的 `.page./.fragment.` 后缀约定）。
+     * 自定义规则下文件名含 `.fragment.` 的按 FragmentDsl 处理，其余按 PageDsl 处理。
+     */
+    include?: RegExp | RegExp[];
+    /** 是否执行 Schema 校验（默认 true；false 时仅编译不校验） */
+    validate?: boolean;
+}
+/**
+ * 创建 Pactor Vite 插件。
+ *
+ * 转换管线：YAML 解析（语法错误带位置）→ page 走 `validatePageDsl` 完整校验 /
+ * fragment 宽松检查（存在 `dsl` 与 `body`）→ 输出
+ * `export default <DSL 对象>` 与 `export const dslVersion`。
+ */
+declare function pactor(options?: PactorPluginOptions): Plugin;
+
+export { type PactorPluginOptions, pactor as default, pactor };

package/dist/index.js

@@ -0,0 +1,79 @@
+// src/index.ts
+import { parseDocument } from "yaml";
+import { validatePageDsl } from "@pactor-app/schema";
+var DEFAULT_INCLUDE = /\.(page|fragment)\.(yaml|yml)$/;
+var FRAGMENT_RE = /\.fragment\.(yaml|yml)$/;
+function toIncludeList(include) {
+  if (include === void 0) return [DEFAULT_INCLUDE];
+  return Array.isArray(include) ? include : [include];
+}
+function pactor(options = {}) {
+  const includeList = toIncludeList(options.include);
+  const shouldValidate = options.validate !== false;
+  const matches = (id) => includeList.some((re) => re.test(id));
+  return {
+    name: "pactor",
+    enforce: "pre",
+    transform(code, id) {
+      if (!matches(id)) return null;
+      const doc = parseDocument(code);
+      if (doc.errors.length > 0) {
+        const details = doc.errors.map((error) => {
+          const pos = error.linePos?.[0];
+          const where = pos ? `\u884C ${pos.line} \u5217 ${pos.col}` : "\u672A\u77E5\u4F4D\u7F6E";
+          return `${where}: ${error.message}`;
+        }).join("\n  ");
+        this.error(`[pactor] YAML \u8BED\u6CD5\u9519\u8BEF ${id}:
+  ${details}`);
+      }
+      const data = doc.toJS();
+      const isFragment = FRAGMENT_RE.test(id);
+      if (isFragment) {
+        if (shouldValidate) {
+          const fragment = data;
+          if (fragment === null || typeof fragment !== "object" || fragment.dsl === void 0 || fragment.body === void 0) {
+            this.error(
+              `[pactor] Fragment DSL \u7ED3\u6784\u4E0D\u5B8C\u6574 ${id}:
+  /: \u5FC5\u987B\u5B58\u5728 dsl \u4E0E body \u5B57\u6BB5 (required)`
+            );
+          }
+        }
+        const json2 = JSON.stringify(data);
+        return {
+          code: `const fragment = ${json2};
+export const dslVersion = fragment.dsl;
+export default fragment;
+`,
+          map: null
+        };
+      }
+      if (shouldValidate) {
+        const result = validatePageDsl(data);
+        if (!result.valid) {
+          const details = result.errors.map((error) => `${error.path}: ${error.message} (${error.keyword})`).join("\n  ");
+          this.error(`[pactor] Page DSL \u6821\u9A8C\u5931\u8D25 ${id}:
+  ${details}`);
+        }
+      }
+      const json = JSON.stringify(data);
+      return {
+        code: `const page = ${json};
+export const dslVersion = page.dsl;
+export default page;
+`,
+        map: null
+      };
+    },
+    handleHotUpdate({ file, server, modules }) {
+      if (!matches(file)) return void 0;
+      if (modules.length > 0) return modules;
+      server.ws.send({ type: "full-reload" });
+      return [];
+    }
+  };
+}
+var index_default = pactor;
+export {
+  index_default as default,
+  pactor
+};

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@pactor-app/vite-plugin",
+  "version": "0.1.0",
+  "description": "Pactor Vite plugin: import .page.yaml / .fragment.yaml DSL files as JS modules with build-time validation and HMR",
+  "keywords": [
+    "pactor",
+    "dsl",
+    "server-driven-ui",
+    "vite",
+    "vite-plugin",
+    "yaml"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/426-330/pactor.git",
+    "directory": "packages/vite-plugin"
+  },
+  "homepage": "https://github.com/426-330/pactor/tree/main/packages/vite-plugin",
+  "bugs": "https://github.com/426-330/pactor/issues",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "yaml": "^2.9.0",
+    "@pactor-app/core": "0.1.0",
+    "@pactor-app/schema": "0.1.0"
+  },
+  "peerDependencies": {
+    "vite": ">=5"
+  },
+  "devDependencies": {
+    "vite": "^8.2.1"
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  }
+}