openxiangda 1.0.21 → 1.0.24

package/templates/sy-lowcode-app-workspace/examples/best-practices/src/shared/hooks/useTicketOps.ts

@@ -0,0 +1,96 @@
+import { useCallback, useEffect, useMemo, useState } from "react";
+import type { PageSdk } from "openxiangda/runtime";
+
+import {
+  getTicketUiPermissions,
+  type TicketAction,
+  type TicketOperator,
+  type TicketRecord,
+  type TicketSearchState,
+} from "@/domain/service-ticket";
+import {
+  queryTickets,
+  transitionTicket,
+  type TicketQueryResult,
+} from "@/shared/services/service-ticket";
+
+const initialResult: TicketQueryResult = { records: [], total: 0 };
+
+export function useTicketOps(sdk: PageSdk, operator: TicketOperator) {
+  const [search, setSearch] = useState<TicketSearchState>({});
+  const [page, setPage] = useState(1);
+  const [pageSize, setPageSize] = useState(20);
+  const [result, setResult] = useState<TicketQueryResult>(initialResult);
+  const [loading, setLoading] = useState(false);
+  const [refreshing, setRefreshing] = useState(false);
+  const [submittingAction, setSubmittingAction] = useState<TicketAction | null>(null);
+  const [error, setError] = useState<string | null>(null);
+
+  const load = useCallback(
+    async (mode: "loading" | "refreshing" = "loading") => {
+      if (mode === "loading") setLoading(true);
+      else setRefreshing(true);
+      setError(null);
+      try {
+        const next = await queryTickets(sdk, {
+          currentPage: page,
+          pageSize,
+          search,
+        });
+        setResult(next);
+      } catch (nextError) {
+        setError(nextError instanceof Error ? nextError.message : "加载失败");
+      } finally {
+        setLoading(false);
+        setRefreshing(false);
+      }
+    },
+    [page, pageSize, sdk, search],
+  );
+
+  useEffect(() => {
+    void load("loading");
+  }, [load]);
+
+  const runAction = useCallback(
+    async (ticket: TicketRecord, action: TicketAction, comment?: string) => {
+      setSubmittingAction(action);
+      setError(null);
+      try {
+        await transitionTicket(sdk, ticket, action, operator, comment);
+        await load("refreshing");
+      } catch (nextError) {
+        setError(nextError instanceof Error ? nextError.message : "操作失败");
+      } finally {
+        setSubmittingAction(null);
+      }
+    },
+    [load, operator, sdk],
+  );
+
+  const recordsWithPermissions = useMemo(
+    () =>
+      result.records.map((ticket) => ({
+        ticket,
+        permissions: getTicketUiPermissions(ticket, operator),
+      })),
+    [operator, result.records],
+  );
+
+  return {
+    search,
+    setSearch,
+    page,
+    setPage,
+    pageSize,
+    setPageSize,
+    total: result.total,
+    recordsWithPermissions,
+    loading,
+    refreshing,
+    submittingAction,
+    error,
+    reload: () => load("refreshing"),
+    runAction,
+  };
+}

package/templates/sy-lowcode-app-workspace/examples/best-practices/src/shared/services/role-governance.ts

@@ -0,0 +1,48 @@
+import type { PageSdk } from "openxiangda/runtime";
+
+import { buildRoleCode, type AppRoleRecord } from "@/domain/role-governance";
+
+export const APP_ROLE_FORM_UUID = "FORM_APP_ROLE";
+
+export async function queryEnabledBusinessRoles(sdk: PageSdk) {
+  const response = await sdk.form.advancedSearch<AppRoleRecord>({
+    formUuid: APP_ROLE_FORM_UUID,
+    currentPage: 1,
+    pageSize: 100,
+    filters: {
+      id: "enabled_roles",
+      logic: "AND",
+      rules: [
+        {
+          id: "enabled_EQ",
+          key: "enabled",
+          componentName: "RadioField",
+          operator: "EQ",
+          value: "enabled",
+        },
+      ],
+      conditions: [],
+    } as never,
+  });
+  return response.result?.data || [];
+}
+
+export async function syncBusinessRoleToPlatform(sdk: PageSdk, role: AppRoleRecord) {
+  const roleCode = buildRoleCode(role);
+  const platformRole = await sdk.role.create({
+    code: roleCode,
+    name: role.roleName,
+    scope: "app",
+    description: "由业务角色维护表同步",
+  });
+  const roleId = platformRole.result?.id;
+  if (!roleId) return platformRole;
+
+  for (const member of role.members || []) {
+    await sdk.role.assignRoles({
+      userId: member.value,
+      roleIds: [roleId],
+    });
+  }
+  return platformRole;
+}

package/templates/sy-lowcode-app-workspace/examples/best-practices/src/shared/services/service-ticket.ts

@@ -0,0 +1,113 @@
+import type { PageSdk } from "openxiangda/runtime";
+
+import {
+  assertTicketTransition,
+  buildTicketFilterGroup,
+  type TicketAction,
+  type TicketActionLog,
+  type TicketOperator,
+  type TicketRecord,
+  type TicketSearchState,
+} from "@/domain/service-ticket";
+
+export const SERVICE_TICKET_FORM_UUID = "FORM_SERVICE_TICKET";
+export const TICKET_ACTION_LOG_FORM_UUID = "FORM_TICKET_ACTION_LOG";
+
+export interface TicketQueryInput {
+  currentPage: number;
+  pageSize: number;
+  search: TicketSearchState;
+}
+
+export interface TicketQueryResult {
+  records: TicketRecord[];
+  total: number;
+}
+
+export async function queryTickets(
+  sdk: PageSdk,
+  input: TicketQueryInput,
+): Promise<TicketQueryResult> {
+  const response = await sdk.form.advancedSearch<TicketRecord>({
+    formUuid: SERVICE_TICKET_FORM_UUID,
+    currentPage: input.currentPage,
+    pageSize: input.pageSize,
+    filters: buildTicketFilterGroup(input.search) as never,
+    order: [{ id: "modifiedTime", isAsc: "n" }],
+  });
+
+  return {
+    records: response.result?.data || [],
+    total: response.result?.totalCount || 0,
+  };
+}
+
+export async function transitionTicket(
+  sdk: PageSdk,
+  ticket: TicketRecord,
+  action: TicketAction,
+  operator: TicketOperator,
+  comment?: string,
+) {
+  const nextStatus = assertTicketTransition(ticket, action, operator);
+  const operatedAt = new Date().toISOString();
+
+  await sdk.form.update({
+    formUuid: SERVICE_TICKET_FORM_UUID,
+    formInstanceId: ticket.formInstanceId,
+    data: {
+      status: nextStatus,
+      lastActionAt: operatedAt,
+      ownerUserId: ticket.ownerUserId,
+      ownerDeptId: ticket.ownerDeptId,
+      collegeId: ticket.collegeId,
+      classId: ticket.classId,
+    },
+  } as never);
+
+  const log: TicketActionLog = {
+    ticketId: ticket.formInstanceId,
+    action,
+    fromStatus: ticket.status,
+    toStatus: nextStatus,
+    operatorId: operator.userId,
+    operatorName: operator.userName,
+    comment,
+    operatedAt,
+  };
+
+  await sdk.form.create({
+    formUuid: TICKET_ACTION_LOG_FORM_UUID,
+    data: log,
+  } as never);
+
+  return { nextStatus, operatedAt };
+}
+
+export async function queryTicketActionLogs(
+  sdk: PageSdk,
+  ticketId: string,
+): Promise<TicketActionLog[]> {
+  const response = await sdk.form.advancedSearch<TicketActionLog>({
+    formUuid: TICKET_ACTION_LOG_FORM_UUID,
+    currentPage: 1,
+    pageSize: 50,
+    filters: {
+      id: "ticket_log_filters",
+      logic: "AND",
+      rules: [
+        {
+          id: "ticketId_EQ",
+          key: "ticketId",
+          componentName: "TextField",
+          operator: "EQ",
+          value: ticketId,
+        },
+      ],
+      conditions: [],
+    } as never,
+    order: [{ id: "createdAt", isAsc: "n" }],
+  });
+
+  return response.result?.data || [];
+}

package/templates/sy-lowcode-app-workspace/package.json

@@ -12,6 +12,7 @@
     "build-js-code": "node scripts/build-js-code.mjs",
     "build:js-code": "node scripts/build-js-code.mjs",
     "typecheck:js-code": "tsc -p tsconfig.js-code-nodes.json --noEmit",
+    "examples:check": "tsc -p tsconfig.examples.json --noEmit",
     "sync-schema": "lowcode-workspace sync-schema",
     "publish:oss": "lowcode-workspace publish-oss",
     "register": "lowcode-workspace register",

package/templates/sy-lowcode-app-workspace/src/dev/App.tsx

@@ -1,4 +1,4 @@
-import { Card, Space, Typography } from "antd";
+import { Card, Divider, Space, Typography } from "antd";
 
 const { Paragraph, Text, Title } = Typography;
 
@@ -19,6 +19,16 @@ export default function App() {
             Publish from this workspace with{" "}
             <Text code>openxiangda workspace publish --profile &lt;name&gt;</Text>.
           </Paragraph>
+          <Divider style={{ margin: "4px 0" }} />
+          <Paragraph style={{ margin: 0 }}>
+            Best-practice templates live under{" "}
+            <Text code>examples/best-practices</Text>. They are not published by
+            default. Copy selected modules into <Text code>src</Text> when you
+            want to use them.
+          </Paragraph>
+          <Paragraph style={{ margin: 0 }}>
+            Validate the cookbook with <Text code>pnpm examples:check</Text>.
+          </Paragraph>
         </Space>
       </Card>
     </main>

package/templates/sy-lowcode-app-workspace/tsconfig.examples.json

@@ -0,0 +1,24 @@
+{
+  "extends": "./tsconfig.app.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["examples/best-practices/src/*", "src/*"],
+      "openxiangda": [
+        "../../packages/sdk/src/components/index.ts",
+        "node_modules/openxiangda"
+      ],
+      "openxiangda/runtime": [
+        "../../packages/sdk/src/runtime/index.ts",
+        "node_modules/openxiangda/runtime"
+      ]
+    }
+  },
+  "include": [
+    "examples/best-practices/src/**/*.ts",
+    "examples/best-practices/src/**/*.tsx",
+    "examples/best-practices/**/*.json",
+    "src/types/**/*.ts",
+    "src/shared/form-schema.ts"
+  ]
+}