@qfei-design/make-app-approval 0.0.0-stage → 0.1.0

package/package.ai.json

@@ -0,0 +1,85 @@
+{
+  "packageName": "@qfei-design/make-app-approval",
+  "minimumRuntimeVersion": "0.1.0",
+  "published": false,
+  "readOrder": [
+    "package.ai.json",
+    "README.md",
+    "PUBLIC_API.md",
+    "docs/host-integration.md",
+    "recipes.json",
+    "capabilities.json",
+    "docs/implementation-plan.md",
+    "examples/host-integration.tsx",
+    "examples/antd-components.tsx",
+    "examples/detail-integration.tsx"
+  ],
+  "runtime": {
+    "coreIsDomFree": true,
+    "ssrSupported": true,
+    "clientOnly": false,
+    "entries": {
+      "core": "Node / browser",
+      "react": "SSR-safe status component",
+      "list": "browser mount; CanvasTable dynamically imported",
+      "detail": "host container and field renderers; no Canvas dependency"
+    }
+  },
+  "imports": {
+    "core": "@qfei-design/make-app-approval",
+    "react": "@qfei-design/make-app-approval/react",
+    "list": "@qfei-design/make-app-approval/list",
+    "detail": "@qfei-design/make-app-approval/detail",
+    "styles": "@qfei-design/make-app-approval/styles.css"
+  },
+  "primaryExports": [
+    "getApprovalStatusDisplay",
+    "hasApprovalDefinition",
+    "isApprovalSystemField",
+    "getRecordApprovalWriteRestriction",
+    "ApprovalStatus",
+    "MyApprovalsPage",
+    "ApprovalTaskDetail",
+    "getApprovalWithdrawalCommentError"
+  ],
+  "pendingCapabilities": [
+    "approval-history",
+    "mobile-approval-pages",
+    "live-bpm-integration"
+  ],
+  "hostResponsibilities": [
+    "导航、路由、登录、应用/身份/环境上下文及 scopeKey",
+    "必传 components：Input / Select / DatePicker / Button / Tabs，适配组件库事件并继承宿主主题",
+    "提供 provider.loadPage，复用 UI -> App Service 请求层并透传 AbortSignal",
+    "将最终后端接口转换成 ApprovalListQuery / ApprovalPage；不在前端归类或拼接分页",
+    "提供 onOpenApproval；办理成功更新 refreshKey 并刷新关联业务页面",
+    "安装 CanvasTable，导入 CSS，提供后端支持的 statusOptions",
+    "业务字段控件与普通编辑入口守卫由宿主接线，后端最终授权"
+  ],
+  "rules": [
+    "本项目是独立 npm 包，不是完整 Make App",
+    "只使用公开入口，CSS 在宿主入口导入一次",
+    "页签归类、筛选和分页由后端完成，不在包内判断本人已办是否结束",
+    "普通入口禁编不等同于任务节点操作授权",
+    "不保存 Token，不直接调用 Make 后端，不复制宿主私有组件",
+    "当前版本尚未发布，先构建打包文件进行宿主验证",
+    "MyApprovalsPage 已实现，只从 /list 使用；详情与节点授权动作从 /detail 使用；历史/移动仍未实现",
+    "CanvasTable 是可选 peer：列表 UI 必须安装，纯 Service 无需安装",
+    "宿主接入前先读 docs/host-integration.md 和可类型检查示例",
+    "scopeKey 变化隔离身份和应用；refreshKey 变化刷新数据；只改变回调不自动重查",
+    "真实 BPM 接口未联调，demo 中的模拟查询不得复制到生产",
+    "列表使用 CanvasTable virtualOptions + data:load 滚动加载，不显示翻页控件",
+    "provider 的 page 从 1 开始，Canvas 的 page 从 0 开始，由包转换；pageSize 是每批条数",
+    "首批接口返回 total 后启用虚拟模式，按原请求身份原子提交行与总数；失败和取消均释放 pending",
+    "滚动请求合并 120ms，最多并发 2 页，缓存约 300 行，宿主无需实现这些机制",
+    "基础控件由宿主注入，包固定查询/重置/校验/刷新等逻辑，不使用原生 HTML 控件兜底",
+    "适配组件类型保持稳定；事件回传值，日期为 YYYY-MM-DD，清空为空字符串，Tabs 仅渲染一份活动内容",
+    "Antd/dayjs 仅用于演示与适配示例，不是库运行时或 peer 依赖；其他组件库实现相同合同",
+    "包 CSS 只控制布局和表格/状态区域，不覆盖宿主基础控件样式",
+    "任务详情只按 fieldPermission 和 actions 展示/提交；宿主提供完整字段元数据和字段渲染器，禁止普通 IAM 截断审批字段或通过普通 CRUD 办理任务",
+    "同意/拒绝/退回统一只校验可编辑且必填字段；validateFields 不得补入只读、隐藏或非必填字段",
+    "renderLayout 由宿主摆放 title/actions/content；actions 在关闭 X 左侧，意见在 content 内随正文滚动，footer 兼容保留且始终为空；history 只为可选内容槽，真实流程表接口仍待提供",
+    "审批意见退回/拒绝必填，同意选填；SUBMIT 沿用 commentPolicy。必填字段名称后显示红色星号，意见标识随动作切换",
+    "CANCELLED 已由后端确认为撤回业务状态；撤回意见 trim 后必填且最多 1024 字。包提供类型、校验与状态，宿主提供入口、意见控件、请求和刷新；不猜测流程发起人或停用后的流程 key。"
+  ]
+}

package/package.json

@@ -1,6 +1,119 @@
 {
   "name": "@qfei-design/make-app-approval",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Make App 审批公共组件与普通记录编辑限制。",
+  "license": "UNLICENSED",
+  "type": "module",
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    },
+    "./react": {
+      "types": "./dist/react/index.d.ts",
+      "import": "./dist/react.mjs",
+      "require": "./dist/react.cjs"
+    },
+    "./list": {
+      "types": "./dist/list/index.d.ts",
+      "import": "./dist/list.mjs",
+      "require": "./dist/list.cjs"
+    },
+    "./detail": {
+      "types": "./dist/detail/index.d.ts",
+      "import": "./dist/detail.mjs",
+      "require": "./dist/detail.cjs"
+    },
+    "./styles.css": {
+      "types": "./dist/styles.css.d.ts",
+      "default": "./dist/styles.css"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "PUBLIC_API.md",
+    "package.ai.json",
+    "recipes.json",
+    "capabilities.json",
+    "docs/implementation-plan.md",
+    "docs/host-integration.md",
+    "docs/publishing.md",
+    "examples/host-integration.tsx",
+    "examples/antd-components.tsx",
+    "examples/detail-integration.tsx"
+  ],
+  "scripts": {
+    "test": "vitest run",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "build": "vite build && tsc -p tsconfig.build.json && node scripts/copy-styles.mjs && node scripts/smoke-dist.mjs",
+    "verify": "pnpm run ci:check && pnpm test && pnpm typecheck && pnpm build",
+    "dev": "vite --config vite.demo.config.ts",
+    "build:demo": "vite build --config vite.demo.config.ts",
+    "ci:init": "qfei-release ci-init",
+    "ci:check": "qfei-release ci-check",
+    "release:init": "qfei-release release-init",
+    "release:check": "qfei-release release-check",
+    "publish:alpha": "qfei-release publish --channel alpha",
+    "publish:beta": "qfei-release publish --channel beta",
+    "publish:latest": "qfei-release publish-latest",
+    "sprint:init": "qfei-release sprint-init"
+  },
+  "qfeiRelease": {
+    "masterBranch": "master",
+    "ciMode": "mr-verify-manual-prerelease",
+    "packageManager": "pnpm",
+    "verifyScripts": [
+      "test",
+      "typecheck",
+      "build"
+    ],
+    "latestPublishTargets": [
+      "internal",
+      "npmjs"
+    ],
+    "prereleasePublishTargets": [
+      "internal"
+    ],
+    "npmjs": {
+      "registry": "https://registry.npmjs.org/",
+      "access": "public",
+      "tokenEnv": "NPMJS_TOKEN"
+    }
+  },
+  "peerDependencies": {
+    "@qfei-design/canvas-table": "^1.3.1",
+    "react": "^18.2.0 || ^19.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@qfei-design/canvas-table": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@qfei-design/canvas-table": "1.3.1",
+    "@qfei/component-release-tools": "^0.5.2",
+    "@types/node": "^22.10.0",
+    "@types/react": "^19.0.0",
+    "@types/react-dom": "^19.0.0",
+    "antd": "6.3.2",
+    "dayjs": "1.11.20",
+    "jsdom": "29.1.1",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "typescript": "^5.6.0",
+    "vite": "^7.0.0",
+    "vitest": "^4.1.5"
+  },
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "packageManager": "pnpm@10.20.0"
+}

package/recipes.json

@@ -0,0 +1,114 @@
+{
+  "packageName": "@qfei-design/make-app-approval",
+  "recipes": [
+    {
+      "id": "my-approvals-list",
+      "summary": "包统一审批列表功能与 CanvasTable，宿主提供基础组件、数据和详情回调",
+      "use": [
+        "@qfei-design/make-app-approval/list",
+        "@qfei-design/make-app-approval/styles.css"
+      ],
+      "hostProvides": [
+        "CanvasTable ^1.3.1",
+        "components: ApprovalUIComponents（Input、Select、DatePicker、Button、Tabs）",
+        "scopeKey",
+        "provider.loadPage(query, { signal }) -> { rows, total }",
+        "onOpenApproval(row)",
+        "办理成功后变化的 refreshKey",
+        "后端支持的 statusOptions"
+      ],
+      "packageProvides": [
+        "页签与筛选的固定功能、布局、CanvasTable 五列及序号/详情入口",
+        "虚拟滚动、分批加载、刷新、加载/空/失败重试、结构校验",
+        "请求身份、取消、旧响应隔离、合并调度、有限并发和有界缓存",
+        "容器/表格主题变量、安全诊断日志、键盘文字入口，不覆盖宿主控件样式"
+      ],
+      "examplePath": "examples/host-integration.tsx",
+      "readNext": [
+        "docs/host-integration.md",
+        "PUBLIC_API.md",
+        "examples/antd-components.tsx"
+      ]
+    },
+    {
+      "id": "approval-status",
+      "summary": "按平台原始状态码统一展示",
+      "use": [
+        "@qfei-design/make-app-approval/react",
+        "@qfei-design/make-app-approval/styles.css"
+      ],
+      "hostProvides": [
+        "原始业务流程状态；绑定记录状态缺失时显式传 UNKNOWN"
+      ]
+    },
+    {
+      "id": "ordinary-record-edit-guard",
+      "summary": "普通业务页面统一禁编",
+      "use": [
+        "@qfei-design/make-app-approval"
+      ],
+      "hostProvides": [
+        "后端记录元数据和有效审批标识",
+        "原操作/字段/行级权限",
+        "保存前最新状态检查与后端最终写入授权"
+      ]
+    },
+    {
+      "id": "packed-app-integration",
+      "summary": "独立项目打包后由应用消费",
+      "use": [
+        "corepack pnpm run verify",
+        "corepack pnpm pack"
+      ],
+      "hostProvides": [
+        "App 仓库内 apps/vendor 打包文件",
+        "UI 与 Service 使用同一版本；正式发布后换为版本依赖"
+      ]
+    },
+    {
+      "id": "approval-task-detail",
+      "summary": "按当前任务节点配置展示字段与办理动作",
+      "use": [
+        "@qfei-design/make-app-approval/detail",
+        "@qfei-design/make-app-approval/styles.css"
+      ],
+      "hostProvides": [
+        "scopeKey、processInstanceId、taskId 和宿主详情容器",
+        "provider.loadDetail 补齐完整字段元数据并保留任务授权；submitAction 走任务接口",
+        "Button、Select、TextArea 和 renderField；validateFields 仅校验包提供的可编辑必填字段",
+        "onActionSuccess 刷新列表和业务详情；后端执行最终授权",
+        "renderLayout 将 actions 放在关闭 X 左侧，意见已包含于 content，不设固定底栏；history 可选，真实历史仍待接口"
+      ],
+      "packageProvides": [
+        "可见/只读/可编辑字段策略与提交字段白名单",
+        "配置动作按钮、审批意见和退回节点校验、确认操作",
+        "提交前重读权限、防重复提交、错误恢复、身份与任务隔离",
+        "统一三种动作的可编辑必填校验、申请信息布局、正文内滚动意见与标题/动作/正文布局槽",
+        "必填字段红色星号；审批意见退回/拒绝必填，同意选填"
+      ],
+      "examplePath": "examples/detail-integration.tsx"
+    },
+    {
+      "id": "applicant-withdrawal",
+      "summary": "申请人撤回由宿主业务详情发起，复用包的意见校验和状态展示",
+      "use": [
+        "@qfei-design/make-app-approval"
+      ],
+      "hostProvides": [
+        "已确认的发起人身份、业务记录和原流程 bpmKey",
+        "宿主意见输入框及确认按钮，提交 trim 后的 comment",
+        "UI → Service → Workflow 请求，后端最终校验",
+        "成功后刷新详情和列表，不自行清除异步同步中的锁，不自动重发"
+      ],
+      "packageProvides": [
+        "CANCELLED → 已撤回",
+        "getApprovalWithdrawalCommentError 检查 trim 后必填和 1024 字上限",
+        "ApprovalWithdrawalInput / ApprovalWithdrawalResult 类型"
+      ],
+      "readNext": [
+        "PUBLIC_API.md",
+        "docs/host-integration.md"
+      ]
+    }
+  ]
+}