create-windy 0.1.0

package/template/packages/modules/src/system-permissions.ts

@@ -0,0 +1,142 @@
+import type { ModuleManifest } from "./manifest.js";
+
+const systemResourceLabels = {
+  admin: "管理面准入",
+  user: "用户管理",
+  role: "角色与权限",
+  department: "部门组织",
+  menu: "菜单管理",
+  dict: "字典管理",
+  feature: "功能开关",
+  search: "全局搜索",
+  settings: "全局设置",
+  config: "配置版本",
+  watermark: "水印设置",
+  profile: "个人设置",
+  license: "许可证管理",
+  audit: "审计日志",
+  agent: "智能代理",
+  ops: "运维总览",
+  scheduler: "定时任务",
+  notification: "通知管理",
+  "bulk-data": "批量数据",
+  storage: "文件存储",
+  workflow: "审批任务",
+} as const;
+
+type SystemResource = keyof typeof systemResourceLabels;
+type SystemAction =
+  | "access"
+  | "read"
+  | "create"
+  | "approve"
+  | "export"
+  | "reveal"
+  | "manage";
+
+function permission(
+  resource: SystemResource,
+  action: SystemAction,
+  accessRisk:
+    | "sensitive-disclosure"
+    | "governed-export"
+    | undefined = undefined,
+) {
+  return {
+    key: `system.${resource}.${action}`,
+    label:
+      action === "access"
+        ? "进入"
+        : action === "read"
+          ? "查看"
+          : action === "create"
+            ? "新建"
+            : action === "approve"
+              ? "处理"
+              : action === "reveal"
+                ? "查看明文"
+                : action === "export"
+                  ? "治理导出"
+                  : "管理",
+    module: "system",
+    moduleLabel: "系统基础设施",
+    resource,
+    resourceLabel: systemResourceLabels[resource],
+    action,
+    accessRisk,
+  };
+}
+
+export const systemPermissions: ModuleManifest["permissions"] = [
+  permission("admin", "access"),
+  permission("user", "read"),
+  // @windy-module system.data-governance begin
+  permission("user", "reveal", "sensitive-disclosure"),
+  permission("user", "export", "governed-export"),
+  // @windy-module system.data-governance end
+  permission("user", "manage"),
+  permission("role", "read"),
+  permission("role", "manage"),
+  permission("department", "read"),
+  permission("department", "create"),
+  permission("department", "manage"),
+  permission("menu", "read"),
+  permission("menu", "manage"),
+  permission("dict", "read"),
+  permission("dict", "manage"),
+  permission("feature", "read"),
+  permission("feature", "manage"),
+  // @windy-module system.search begin
+  permission("search", "read"),
+  permission("search", "manage"),
+  // @windy-module system.search end
+  // @windy-module system.settings begin
+  permission("settings", "read"),
+  permission("settings", "manage"),
+  // @windy-module system.settings end
+  // @windy-module system.configuration begin
+  permission("config", "read"),
+  permission("config", "manage"),
+  // @windy-module system.configuration end
+  // @windy-module system.settings begin
+  permission("watermark", "read"),
+  permission("watermark", "manage"),
+  // @windy-module system.settings end
+  permission("profile", "read"),
+  permission("profile", "manage"),
+  // @windy-module system.license begin
+  permission("license", "read"),
+  permission("license", "manage"),
+  // @windy-module system.license end
+  // @windy-module system.audit begin
+  permission("audit", "read"),
+  // @windy-module system.audit end
+  // @windy-module system.agent begin
+  permission("agent", "read"),
+  // @windy-module system.agent end
+  // @windy-module system.operations begin
+  permission("ops", "read"),
+  // @windy-module system.operations end
+  // @windy-module system.scheduler begin
+  permission("scheduler", "read"),
+  permission("scheduler", "manage"),
+  // @windy-module system.scheduler end
+  // @windy-module system.notification begin
+  permission("notification", "read"),
+  permission("notification", "manage"),
+  // @windy-module system.notification end
+  // @windy-module system.bulk-data begin
+  permission("bulk-data", "manage"),
+  // @windy-module system.bulk-data end
+  // @windy-module system.storage begin
+  permission("storage", "read"),
+  permission("storage", "create"),
+  permission("storage", "manage"),
+  // @windy-module system.storage end
+  // @windy-module system.workflow begin
+  permission("workflow", "read"),
+  permission("workflow", "create"),
+  permission("workflow", "approve"),
+  permission("workflow", "manage"),
+  // @windy-module system.workflow end
+];

package/template/packages/modules/user/module.ts

@@ -0,0 +1,72 @@
+import type { ModuleManifest } from "../index.js";
+
+/**
+ * Example user module manifest.
+ *
+ * In a real implementation this file would also export routes, policies and
+ * services specific to the user domain.  For now it only returns a minimal
+ * manifest used by the module registry.
+ */
+export default function userModule(): ModuleManifest {
+  return {
+    name: "user",
+    version: "0.1.0",
+    label: "用户管理",
+    description: "用户账号、角色授权和个人基础资料。",
+    menus: [
+      {
+        key: "system.user",
+        title: "用户管理",
+        type: "menu",
+        order: 10,
+        visible: true,
+        path: "/users",
+        icon: "users",
+        permissionKey: "user.account.read",
+      },
+    ],
+    adminRoutes: [
+      {
+        key: "user.account",
+        path: "/users",
+        title: "用户管理",
+        surface: "sidebar",
+        permissionKey: "user.account.read",
+      },
+    ],
+    permissions: [
+      {
+        key: "user.account.read",
+        label: "查看用户",
+        module: "user",
+        moduleLabel: "用户管理",
+        resource: "account",
+        resourceLabel: "用户账户",
+        action: "read",
+      },
+      {
+        key: "user.account.manage",
+        label: "管理用户",
+        module: "user",
+        moduleLabel: "用户管理",
+        resource: "account",
+        resourceLabel: "用户账户",
+        action: "manage",
+      },
+    ],
+    apiPermissions: [
+      {
+        method: "GET",
+        path: "/api/users",
+        permissionKey: "user.account.read",
+      },
+    ],
+    features: [],
+    migrations: [],
+    schemaExports: [],
+    tasks: [],
+    tools: [],
+    providers: [],
+    auditActions: ["crud.create", "crud.update", "crud.delete"],
+  };
+}

package/template/packages/shared/index.ts

@@ -0,0 +1,16 @@
+export * from "./src/audit.js";
+export * from "./src/database.js";
+export * from "./src/data-governance.js";
+export * from "./src/feature.js";
+export * from "./src/license.js";
+export * from "./src/module-configuration.js";
+export * from "./src/correlation.js";
+export * from "./src/notification.js";
+export * from "./src/platform-settings.js";
+export * from "./src/profile.js";
+export * from "./src/primitives.js";
+export * from "./src/rbac.js";
+export * from "./src/ruoyi.js";
+export * from "./src/scheduler.js";
+export * from "./src/search-provider.js";
+export * from "./src/workflow.js";

package/template/packages/shared/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@windy/shared",
+  "version": "0.1.0",
+  "private": true,
+  "type": "module",
+  "exports": {
+    ".": "./index.ts"
+  }
+}

package/template/packages/shared/src/audit.test.ts

@@ -0,0 +1,17 @@
+import { describe, expect, test } from "bun:test";
+import { AUDIT_ACTION_DEFINITIONS } from "./audit.js";
+
+describe("审计动作目录", () => {
+  test("稳定动作 key 提供中文名称和说明", () => {
+    expect(
+      AUDIT_ACTION_DEFINITIONS.find(({ key }) => key === "feature.update"),
+    ).toEqual({
+      key: "feature.update",
+      label: "功能开关更新",
+      description: "更新功能开关状态、可见性或 License 适用范围。",
+    });
+    expect(new Set(AUDIT_ACTION_DEFINITIONS.map(({ key }) => key)).size).toBe(
+      AUDIT_ACTION_DEFINITIONS.length,
+    );
+  });
+});

package/template/packages/shared/src/audit.ts

@@ -0,0 +1,237 @@
+import type { EntityId, ISODateTime } from "./primitives.js";
+
+export const AUDIT_ACTION_DEFINITIONS = [
+  { key: "auth.login", label: "账号登录", description: "用户登录平台。" },
+  { key: "auth.logout", label: "账号退出", description: "用户退出平台。" },
+  {
+    key: "auth.password.update",
+    label: "密码更新",
+    description: "用户或管理员更新账号密码。",
+  },
+  {
+    key: "auth.session.revoke",
+    label: "会话撤销",
+    description: "管理员强制结束登录会话。",
+  },
+  {
+    key: "user.profile.update",
+    label: "个人资料更新",
+    description: "用户更新自己的个人资料。",
+  },
+  { key: "crud.create", label: "数据新增", description: "新增业务记录。" },
+  { key: "crud.update", label: "数据更新", description: "修改业务记录。" },
+  { key: "crud.delete", label: "数据删除", description: "删除业务记录。" },
+  { key: "crud.restore", label: "数据恢复", description: "恢复已删除记录。" },
+  { key: "data.import", label: "数据导入", description: "同步导入数据。" },
+  { key: "data.export", label: "数据导出", description: "同步导出数据。" },
+  {
+    key: "data.search",
+    label: "数据搜索",
+    description: "用户主动提交搜索条件并查询业务数据。",
+  },
+  {
+    key: "data.plaintext.read",
+    label: "敏感数据明文查看",
+    description: "单条查看经服务端授权的敏感字段明文。",
+  },
+  {
+    key: "data.plaintext.batch-read",
+    label: "敏感数据批量明文查询",
+    description: "批量查询经服务端授权且受数据范围约束的敏感字段明文。",
+  },
+  {
+    key: "data.governed-export.request",
+    label: "敏感数据导出申请",
+    description: "提交受策略、范围和可选审批约束的敏感数据导出申请。",
+  },
+  {
+    key: "data.governed-export.generate",
+    label: "敏感数据导出生成",
+    description: "后台生成带服务端水印的受治理导出文件。",
+  },
+  {
+    key: "data.governed-export.download",
+    label: "敏感数据导出下载",
+    description: "下载已完成且仍满足授权边界的受治理导出文件。",
+  },
+  {
+    key: "data.governed-export.cancel",
+    label: "敏感数据导出取消",
+    description: "取消本人尚未完成的受治理导出任务。",
+  },
+  {
+    key: "search.query",
+    label: "全局检索查询",
+    description: "提交全局检索；只记录摘要、长度和 Provider，不记录查询词。",
+  },
+  {
+    key: "search.result.access",
+    label: "检索结果访问",
+    description: "访问已脱敏的全局检索结果。",
+  },
+  {
+    key: "data.bulk-import.create",
+    label: "创建批量导入",
+    description: "创建后台批量导入任务。",
+  },
+  {
+    key: "data.bulk-export.create",
+    label: "创建批量导出",
+    description: "创建后台批量导出任务。",
+  },
+  {
+    key: "data.bulk-artifact.download",
+    label: "下载批量任务文件",
+    description: "下载批量任务结果或失败明细。",
+  },
+  {
+    key: "file.upload.create",
+    label: "创建文件上传",
+    description: "创建受控文件上传会话。",
+  },
+  {
+    key: "file.upload.complete",
+    label: "完成文件上传",
+    description: "校验并完成文件上传。",
+  },
+  {
+    key: "file.upload.abort",
+    label: "终止文件上传",
+    description: "终止上传并清理已提交分片。",
+  },
+  {
+    key: "file.download",
+    label: "文件下载",
+    description: "通过授权边界下载文件。",
+  },
+  {
+    key: "config.update",
+    label: "全局配置更新",
+    description: "更新平台全局配置。",
+  },
+  {
+    key: "config.rollback",
+    label: "配置版本回滚",
+    description: "基于历史版本创建并应用新的配置版本。",
+  },
+  {
+    key: "license.verify",
+    label: "License 校验",
+    description: "校验 License 有效性。",
+  },
+  {
+    key: "license.update",
+    label: "License 更新",
+    description: "安装或更新 License。",
+  },
+  {
+    key: "feature.update",
+    label: "功能开关更新",
+    description: "更新功能开关状态、可见性或 License 适用范围。",
+  },
+  {
+    key: "menu.structure.update",
+    label: "菜单结构更新",
+    description: "调整菜单父级、顺序或可见性。",
+  },
+  {
+    key: "notification.publish",
+    label: "通知发布",
+    description: "发布站内通知。",
+  },
+  {
+    key: "notification.read",
+    label: "通知已读",
+    description: "用户阅读站内通知。",
+  },
+  {
+    key: "notification.archive",
+    label: "通知归档",
+    description: "归档已发布通知。",
+  },
+  {
+    key: "workflow.create",
+    label: "创建审批任务",
+    description: "创建最小审批任务。",
+  },
+  {
+    key: "workflow.claim",
+    label: "领取审批任务",
+    description: "候选角色领取审批任务。",
+  },
+  {
+    key: "workflow.transfer",
+    label: "转交审批任务",
+    description: "当前领取人或管理员转交审批任务。",
+  },
+  {
+    key: "workflow.decide",
+    label: "提交审批决定",
+    description: "当前领取人批准或驳回审批任务。",
+  },
+  {
+    key: "workflow.cancel",
+    label: "取消审批任务",
+    description: "发起人或管理员取消审批任务。",
+  },
+  {
+    key: "workflow.timeout",
+    label: "审批任务超时",
+    description: "后台服务将到期审批任务置为超时。",
+  },
+  { key: "task.trigger", label: "任务触发", description: "人工触发后台任务。" },
+  { key: "task.read", label: "任务查看", description: "查看任务状态或历史。" },
+  { key: "task.execute", label: "任务执行", description: "后台任务实际执行。" },
+  { key: "task.recover", label: "任务恢复", description: "人工恢复异常任务。" },
+  {
+    key: "agent.tool.execute",
+    label: "Agent 工具执行",
+    description: "Agent 调用受控平台工具。",
+  },
+  {
+    key: "security.denied",
+    label: "安全拒绝",
+    description: "权限或安全策略拒绝请求。",
+  },
+  {
+    key: "system.error",
+    label: "系统错误",
+    description: "平台记录系统级异常。",
+  },
+] as const;
+
+export type AuditActionType = (typeof AUDIT_ACTION_DEFINITIONS)[number]["key"];
+
+export type AuditOutcome = "attempted" | "success" | "failure" | "denied";
+
+export interface AuditActor {
+  id: EntityId;
+  type: "user" | "service" | "system";
+  name: string;
+  roleCodes?: string[];
+  ip?: string;
+  userAgent?: string;
+}
+
+export interface AuditTarget {
+  type: string;
+  id?: EntityId;
+  label?: string;
+}
+
+export interface AuditEvent {
+  id: EntityId;
+  action: AuditActionType;
+  outcome: AuditOutcome;
+  actor: AuditActor;
+  target?: AuditTarget;
+  module?: string;
+  requestId?: string;
+  message?: string;
+  metadata?: Record<string, unknown>;
+  occurredAt: ISODateTime;
+}
+
+export interface AuditLogWriter {
+  write(event: AuditEvent): Promise<void>;
+}

package/template/packages/shared/src/correlation.test.ts

@@ -0,0 +1,10 @@
+import { describe, expect, test } from "bun:test";
+import { correlationId } from "./correlation.js";
+
+describe("correlationId", () => {
+  test("保留有界安全标识并拒绝日志注入内容", () => {
+    expect(correlationId("request-01", () => "generated")).toBe("request-01");
+    expect(correlationId("bad\nvalue", () => "generated")).toBe("generated");
+    expect(correlationId("x".repeat(129), () => "generated")).toBe("generated");
+  });
+});

package/template/packages/shared/src/correlation.ts

@@ -0,0 +1,11 @@
+const CORRELATION_ID_PATTERN = /^[A-Za-z0-9._-]{1,128}$/;
+
+export function correlationId(
+  value: string | null | undefined,
+  factory: () => string = () => crypto.randomUUID(),
+): string {
+  const candidate = value?.trim();
+  return candidate && CORRELATION_ID_PATTERN.test(candidate)
+    ? candidate
+    : factory();
+}

package/template/packages/shared/src/data-governance.test.ts

@@ -0,0 +1,44 @@
+import { describe, expect, test } from "bun:test";
+import {
+  maskGovernedValue,
+  type GovernedFieldPolicy,
+} from "./data-governance.js";
+
+describe("敏感字段掩码结果", () => {
+  test("部分掩码结果不携带原始值", () => {
+    const policy: GovernedFieldPolicy = {
+      fieldKey: "phone",
+      classification: "sensitive",
+      mask: { kind: "partial", prefix: 3, suffix: 4 },
+    };
+
+    const result = maskGovernedValue("13800138000", policy);
+
+    expect(result).toEqual({
+      kind: "masked",
+      classification: "sensitive",
+      display: "138****8000",
+    });
+    expect(result).not.toHaveProperty("value");
+  });
+
+  test("短值不会因为保留位数而完整暴露", () => {
+    const result = maskGovernedValue("1234", {
+      fieldKey: "code",
+      classification: "secret",
+      mask: { kind: "partial", prefix: 3, suffix: 2 },
+    });
+
+    expect(result).toMatchObject({ kind: "masked", display: "****" });
+  });
+
+  test("omit 策略只返回字段分类", () => {
+    expect(
+      maskGovernedValue("never-return", {
+        fieldKey: "secret",
+        classification: "secret",
+        mask: { kind: "omit" },
+      }),
+    ).toEqual({ kind: "hidden", classification: "secret" });
+  });
+});

package/template/packages/shared/src/data-governance.ts

@@ -0,0 +1,89 @@
+import type { FeatureKey } from "./feature.js";
+
+export type FieldClassification =
+  | "public"
+  | "internal"
+  | "personal"
+  | "sensitive"
+  | "secret";
+
+export type FieldMaskStrategy =
+  | { kind: "redact"; replacement?: string }
+  | { kind: "partial"; prefix: number; suffix: number }
+  | { kind: "omit" };
+
+export interface GovernedFieldPolicy {
+  fieldKey: string;
+  classification: FieldClassification;
+  mask: FieldMaskStrategy;
+}
+
+export interface RoleDisplayStrategy {
+  /** 普通读取对已治理字段只能返回掩码结果。 */
+  read: "masked";
+  /** 明文仍须由 Server 有效权限签发一次性访问上下文。 */
+  reveal: "plaintext";
+  unauthorized: "hidden";
+}
+
+export interface DataGovernancePolicyDefinition {
+  key: string;
+  resourceType: string;
+  version: string;
+  featureKey: FeatureKey;
+  readPermissionKey: string;
+  revealPermissionKey: string;
+  exportPermissionKey: string;
+  display: RoleDisplayStrategy;
+  fields: GovernedFieldPolicy[];
+}
+
+export type MaskResult<T> =
+  | {
+      kind: "plaintext";
+      classification: FieldClassification;
+      value: T;
+      grantId: string;
+    }
+  | {
+      kind: "masked";
+      classification: FieldClassification;
+      display: string;
+    }
+  | {
+      kind: "hidden";
+      classification: FieldClassification;
+    };
+
+export type MaskedValue = Extract<MaskResult<never>, { kind: "masked" }>;
+
+export function maskGovernedValue(
+  value: unknown,
+  policy: GovernedFieldPolicy,
+): MaskedValue | Extract<MaskResult<never>, { kind: "hidden" }> {
+  if (policy.mask.kind === "omit") {
+    return { kind: "hidden", classification: policy.classification };
+  }
+  const text = value === undefined || value === null ? "" : String(value);
+  if (policy.mask.kind === "redact") {
+    return {
+      kind: "masked",
+      classification: policy.classification,
+      display: text ? policy.mask.replacement || "[已脱敏]" : "",
+    };
+  }
+  const prefix = Math.max(0, policy.mask.prefix);
+  const suffix = Math.max(0, policy.mask.suffix);
+  if (!text || text.length <= prefix + suffix) {
+    return {
+      kind: "masked",
+      classification: policy.classification,
+      display: text ? "*".repeat(text.length) : "",
+    };
+  }
+  return {
+    kind: "masked",
+    classification: policy.classification,
+    display: `${text.slice(0, prefix)}${"*".repeat(text.length - prefix - suffix)}${suffix ? text.slice(-suffix) : ""}`,
+  };
+}