create-windy 0.3.0 → 0.3.1

package/template/packages/modules/src/composition-fixtures.test-support.ts

@@ -0,0 +1,164 @@
+import type { ModuleManifest } from "./manifest.js";
+import { featureKey } from "@southwind-ai/shared";
+
+export function fixture(
+  name: string,
+  dependencies: string[] = [],
+): ModuleManifest {
+  const featureKey = `${name}.feature`;
+  const readPermission = `${name}.read`;
+  const managePermission = `${name}.manage`;
+  return {
+    name,
+    version: "0.1.0",
+    label: name,
+    description: `${name} module`,
+    dependencies,
+    menus: [
+      {
+        key: `${name}.page`,
+        title: name,
+        type: "menu",
+        order: 1,
+        visible: true,
+        path: `/${name}`,
+        permissionKey: readPermission,
+        featureKey,
+      },
+    ],
+    adminRoutes: [
+      {
+        key: `${name}.page`,
+        path: `/${name}`,
+        title: name,
+        surface: "sidebar",
+        permissionKey: readPermission,
+        featureKey,
+      },
+    ],
+    permissions: [
+      permission(name, readPermission, "read"),
+      permission(name, managePermission, "manage"),
+    ],
+    apiPermissions: [
+      {
+        method: "GET",
+        path: `/api/${name}`,
+        permissionKey: readPermission,
+        featureKey,
+      },
+    ],
+    features: [
+      {
+        key: featureKey,
+        label: name,
+        module: name,
+        visible: "visible",
+        enabled: true,
+        stage: "stable",
+      },
+    ],
+    migrations: [],
+    schemaExports: [
+      {
+        key: `${name}.schema`,
+        exportName: `${name}Table`,
+        migrationIds: [`${name}.001`],
+      },
+    ],
+    jsonSchemas: [
+      {
+        key: `${name}.tool.input.v1`,
+        schema: { type: "object" },
+      },
+      {
+        key: `${name}.tool.output.v1`,
+        schema: { type: "object" },
+      },
+    ],
+    tasks: [
+      {
+        key: `${name}.task`,
+        label: name,
+        description: name,
+        permissionKey: managePermission,
+        featureKey,
+        intervalSeconds: 60,
+        maxAttempts: 3,
+        retryDelaySeconds: 10,
+      },
+    ],
+    tools: [
+      {
+        key: `${name}.tool`,
+        label: name,
+        description: name,
+        inputSchemaKey: `${name}.tool.input.v1`,
+        outputSchemaKey: `${name}.tool.output.v1`,
+        operation: "query",
+        permissionKey: readPermission,
+        featureKey,
+        auditAction: "agent.tool.execute",
+        scopeMode: "request",
+        dataClassification: "internal",
+        idempotency: "none",
+        approval: "none",
+        limits: {
+          maxDurationSeconds: 10,
+          maxInputBytes: 4096,
+          maxOutputBytes: 4096,
+        },
+      },
+    ],
+    providers: [
+      {
+        key: `${name}.provider`,
+        kind: "fixture",
+        contractVersion: "1",
+        permissionKey: readPermission,
+        featureKey,
+      },
+    ],
+    auditActions: ["agent.tool.execute"],
+  };
+}
+
+export function dataPolicy(): NonNullable<
+  ModuleManifest["dataPolicies"]
+>[number] {
+  return {
+    key: "system.user.fields",
+    resourceType: "system.user",
+    version: "1",
+    featureKey: featureKey("system.feature"),
+    readPermissionKey: "system.read",
+    revealPermissionKey: "system.reveal",
+    exportPermissionKey: "system.export",
+    display: {
+      read: "masked",
+      reveal: "plaintext",
+      unauthorized: "hidden",
+    },
+    fields: [
+      {
+        fieldKey: "phone",
+        classification: "sensitive",
+        mask: { kind: "partial", prefix: 3, suffix: 4 },
+      },
+    ],
+  };
+}
+
+export function permission(
+  module: string,
+  key: string,
+  action: "read" | "manage",
+): ModuleManifest["permissions"][number] {
+  return {
+    key,
+    label: action,
+    module,
+    resource: "fixture",
+    action,
+  };
+}

package/template/packages/modules/src/composition.test.ts

@@ -1,6 +1,10 @@
 import { describe, expect, test } from "bun:test";
 import { featureKey, licenseVersionKey } from "@southwind-ai/shared";
-import type { ModuleManifest } from "./manifest.js";
+import {
+  dataPolicy,
+  fixture,
+  permission,
+} from "./composition-fixtures.test-support.js";
 import { validateModuleComposition } from "./composition.js";
 
 describe("Module Composition 契约", () => {
@@ -223,160 +227,3 @@ describe("Module Composition 契约", () => {
     );
   });
 });
-
-function fixture(name: string, dependencies: string[] = []): ModuleManifest {
-  const featureKey = `${name}.feature`;
-  const readPermission = `${name}.read`;
-  const managePermission = `${name}.manage`;
-  return {
-    name,
-    version: "0.1.0",
-    label: name,
-    description: `${name} module`,
-    dependencies,
-    menus: [
-      {
-        key: `${name}.page`,
-        title: name,
-        type: "menu",
-        order: 1,
-        visible: true,
-        path: `/${name}`,
-        permissionKey: readPermission,
-        featureKey,
-      },
-    ],
-    adminRoutes: [
-      {
-        key: `${name}.page`,
-        path: `/${name}`,
-        title: name,
-        surface: "sidebar",
-        permissionKey: readPermission,
-        featureKey,
-      },
-    ],
-    permissions: [
-      permission(name, readPermission, "read"),
-      permission(name, managePermission, "manage"),
-    ],
-    apiPermissions: [
-      {
-        method: "GET",
-        path: `/api/${name}`,
-        permissionKey: readPermission,
-        featureKey,
-      },
-    ],
-    features: [
-      {
-        key: featureKey,
-        label: name,
-        module: name,
-        visible: "visible",
-        enabled: true,
-        stage: "stable",
-      },
-    ],
-    migrations: [],
-    schemaExports: [
-      {
-        key: `${name}.schema`,
-        exportName: `${name}Table`,
-        migrationIds: [`${name}.001`],
-      },
-    ],
-    jsonSchemas: [
-      {
-        key: `${name}.tool.input.v1`,
-        schema: { type: "object" },
-      },
-      {
-        key: `${name}.tool.output.v1`,
-        schema: { type: "object" },
-      },
-    ],
-    tasks: [
-      {
-        key: `${name}.task`,
-        label: name,
-        description: name,
-        permissionKey: managePermission,
-        featureKey,
-        intervalSeconds: 60,
-        maxAttempts: 3,
-        retryDelaySeconds: 10,
-      },
-    ],
-    tools: [
-      {
-        key: `${name}.tool`,
-        label: name,
-        description: name,
-        inputSchemaKey: `${name}.tool.input.v1`,
-        outputSchemaKey: `${name}.tool.output.v1`,
-        operation: "query",
-        permissionKey: readPermission,
-        featureKey,
-        auditAction: "agent.tool.execute",
-        scopeMode: "request",
-        dataClassification: "internal",
-        idempotency: "none",
-        approval: "none",
-        limits: {
-          maxDurationSeconds: 10,
-          maxInputBytes: 4096,
-          maxOutputBytes: 4096,
-        },
-      },
-    ],
-    providers: [
-      {
-        key: `${name}.provider`,
-        kind: "fixture",
-        contractVersion: "1",
-        permissionKey: readPermission,
-        featureKey,
-      },
-    ],
-    auditActions: ["agent.tool.execute"],
-  };
-}
-
-function dataPolicy(): NonNullable<ModuleManifest["dataPolicies"]>[number] {
-  return {
-    key: "system.user.fields",
-    resourceType: "system.user",
-    version: "1",
-    featureKey: featureKey("system.feature"),
-    readPermissionKey: "system.read",
-    revealPermissionKey: "system.reveal",
-    exportPermissionKey: "system.export",
-    display: {
-      read: "masked",
-      reveal: "plaintext",
-      unauthorized: "hidden",
-    },
-    fields: [
-      {
-        fieldKey: "phone",
-        classification: "sensitive",
-        mask: { kind: "partial", prefix: 3, suffix: 4 },
-      },
-    ],
-  };
-}
-
-function permission(
-  module: string,
-  key: string,
-  action: "read" | "manage",
-): ModuleManifest["permissions"][number] {
-  return {
-    key,
-    label: action,
-    module,
-    resource: "fixture",
-    action,
-  };
-}

package/template/packages/modules/src/system-api-operational.ts

@@ -0,0 +1,234 @@
+import type { ApiPermissionBinding } from "@southwind-ai/shared";
+// oxlint-disable-next-line no-unused-vars -- 可选模块全部裁剪后该导入仍需保留类型稳定的生成源码。
+import { binding } from "./system-api-binding.js";
+
+export function systemOperationalApiPermissionBindings(): ApiPermissionBinding[] {
+  return [
+    // @windy-module system.storage begin
+    binding(
+      "POST",
+      "/api/system/storage/uploads",
+      "system.storage.create",
+      "system.storage",
+    ),
+    binding(
+      "GET",
+      "/api/system/storage/uploads/:id",
+      "system.storage.create",
+      "system.storage",
+    ),
+    binding(
+      "PUT",
+      "/api/system/storage/uploads/:id/parts/:partNumber",
+      "system.storage.create",
+      "system.storage",
+    ),
+    binding(
+      "POST",
+      "/api/system/storage/uploads/:id/complete",
+      "system.storage.create",
+      "system.storage",
+    ),
+    binding(
+      "DELETE",
+      "/api/system/storage/uploads/:id",
+      "system.storage.create",
+      "system.storage",
+    ),
+    binding(
+      "GET",
+      "/api/system/storage/files/:id",
+      "system.storage.read",
+      "system.storage",
+    ),
+    binding(
+      "GET",
+      "/api/platform/files/:id",
+      "system.settings.read",
+      "system.settings",
+      true,
+    ),
+    // @windy-module system.storage end
+    // @windy-module system.operations begin
+    binding("GET", "/api/system/operations", "system.ops.read", "system.ops"),
+    // @windy-module system.operations end
+    // @windy-module system.notification begin
+    binding(
+      "GET",
+      "/api/notifications",
+      "system.notification.read",
+      "system.notification",
+    ),
+    binding(
+      "GET",
+      "/api/notifications/preferences",
+      "system.notification.read",
+      "system.notification",
+    ),
+    binding(
+      "PUT",
+      "/api/notifications/preferences",
+      "system.notification.read",
+      "system.notification",
+    ),
+    binding(
+      "POST",
+      "/api/notifications/:id/read",
+      "system.notification.read",
+      "system.notification",
+    ),
+    binding(
+      "PUT",
+      "/api/notifications/:id/favorite",
+      "system.notification.read",
+      "system.notification",
+    ),
+    binding(
+      "DELETE",
+      "/api/notifications/:id/favorite",
+      "system.notification.read",
+      "system.notification",
+    ),
+    binding(
+      "GET",
+      "/api/system/notifications/audience-options",
+      "system.notification.manage",
+      "system.notification",
+    ),
+    binding(
+      "GET",
+      "/api/system/notifications/:id/deliveries",
+      "system.notification.manage",
+      "system.notification",
+    ),
+    binding(
+      "GET",
+      "/api/system/notifications",
+      "system.notification.manage",
+      "system.notification",
+    ),
+    binding(
+      "POST",
+      "/api/system/notifications",
+      "system.notification.manage",
+      "system.notification",
+    ),
+    binding(
+      "PUT",
+      "/api/system/notifications/:id",
+      "system.notification.update",
+      "system.notification",
+    ),
+    binding(
+      "GET",
+      "/api/system/notifications/:id/revisions",
+      "system.notification.manage",
+      "system.notification",
+    ),
+    binding(
+      "DELETE",
+      "/api/system/notifications/:id",
+      "system.notification.manage",
+      "system.notification",
+    ),
+    // @windy-module system.notification end
+    // @windy-module system.workflow begin
+    binding(
+      "GET",
+      "/api/workflow/work-items",
+      "system.workflow.read",
+      "system.workflow",
+    ),
+    binding(
+      "GET",
+      "/api/workflow/work-items/:id",
+      "system.workflow.read",
+      "system.workflow",
+    ),
+    binding(
+      "GET",
+      "/api/workflow/work-items/:id/history",
+      "system.workflow.read",
+      "system.workflow",
+    ),
+    binding(
+      "POST",
+      "/api/workflow/work-items",
+      "system.workflow.create",
+      "system.workflow",
+    ),
+    ...["claim", "transfer", "approve", "reject", "cancel"].map((command) =>
+      binding(
+        "POST",
+        `/api/workflow/work-items/:id/${command}`,
+        "system.workflow.approve",
+        "system.workflow",
+      ),
+    ),
+    // @windy-module system.workflow end
+    // @windy-module system.scheduler begin
+    binding(
+      "GET",
+      "/api/system/scheduled-tasks",
+      "system.scheduler.read",
+      "system.scheduler",
+    ),
+    binding(
+      "GET",
+      "/api/system/scheduled-task-runs",
+      "system.scheduler.read",
+      "system.scheduler",
+    ),
+    binding(
+      "GET",
+      "/api/system/operations/scheduler",
+      "system.scheduler.read",
+      "system.scheduler",
+    ),
+    binding(
+      "POST",
+      "/api/system/scheduled-tasks/:id/trigger",
+      "system.scheduler.manage",
+      "system.scheduler",
+    ),
+    binding(
+      "POST",
+      "/api/system/scheduled-tasks/:id/runs/:runId/recover",
+      "system.scheduler.manage",
+      "system.scheduler",
+    ),
+    // @windy-module system.scheduler end
+    // @windy-module system.bulk-data begin
+    binding(
+      "GET",
+      "/api/system/bulk-data/jobs",
+      "system.dict.read",
+      "system.bulk-data",
+    ),
+    binding(
+      "GET",
+      "/api/system/bulk-data/jobs/:id",
+      "system.dict.read",
+      "system.bulk-data",
+    ),
+    binding(
+      "GET",
+      "/api/system/bulk-data/jobs/:id/artifacts/:kind",
+      "system.dict.read",
+      "system.bulk-data",
+    ),
+    binding(
+      "POST",
+      "/api/system/bulk-data/dictionaries/import",
+      "system.dict.manage",
+      "system.bulk-data",
+    ),
+    binding(
+      "POST",
+      "/api/system/bulk-data/dictionaries/export",
+      "system.dict.read",
+      "system.bulk-data",
+    ),
+    // @windy-module system.bulk-data end
+  ];
+}