openxiangda 1.0.21 → 1.0.22

package/openxiangda-skills/references/notifications.md

@@ -0,0 +1,80 @@
+# Notification Resources
+
+Use notification resources when a page, workflow, or automation needs reusable message templates.
+
+AI generation rule: declare notification resources first, then call `sdk.notification` in code pages or `ctx.notification` in JS_CODE. Do not hardcode `/api/notification-config/*` or store channel credentials in source.
+
+## Resource Files
+
+Place JSON under `src/resources/notifications/`.
+
+```json
+{
+  "templates": [
+    {
+      "code": "reservation_reminder",
+      "name": "预约提醒",
+      "content": "{{title}}",
+      "variables": ["title", "instrumentName", "startTime"],
+      "channelsConfig": {
+        "inapp": {
+          "enabled": true,
+          "content": "{{instrumentName}} 将于 {{startTime}} 开始"
+        },
+        "dingding": {
+          "enabled": true,
+          "content": "{{title}}"
+        }
+      }
+    }
+  ],
+  "typeConfigs": [
+    {
+      "notificationType": "reservation_reminder",
+      "templateCode": "reservation_reminder",
+      "enabled": true,
+      "priority": 0
+    }
+  ]
+}
+```
+
+For form-level notifications, add `level: "form"` and `formCode` to both the template and type config. Prefer `formCode`; the CLI resolves `formUuid` per profile.
+
+Allowed channels: `inapp`, `email`, `dingding`, `wechat`, `thirdparty_todo`.
+
+Do not include `token`, `secret`, `password`, `authorization`, `auth`, `credential`, or `headers` fields. Platform admins configure channel credentials outside resources.
+
+## Runtime Calls
+
+Code pages:
+
+```ts
+await sdk.notification.sendByType({
+  notificationType: "reservation_reminder",
+  recipientId: userId,
+  payload: {
+    title: "预约提醒",
+    instrumentName,
+    startTime,
+  },
+});
+```
+
+Automation or workflow JS_CODE:
+
+```ts
+export default async function notify(ctx) {
+  await ctx.notification.sendByType({
+    notificationType: "reservation_reminder",
+    recipientId: ctx.operator.userId,
+    payload: {
+      title: "预约提醒",
+      instrumentName: ctx.formData.current.instrument_name,
+      startTime: ctx.formData.current.start_time,
+    },
+  });
+}
+```
+
+Use `work_notification` for simple declarative notifications. Use JS_CODE only for dynamic recipients, conditional sending, or payload assembly.

package/openxiangda-skills/references/openxiangda-api.md

@@ -205,6 +205,51 @@ Requires Bearer token. Deletes a menu item.
 
 Requires Bearer token. Updates menu sorting and parent relationships in batch.
 
+## Notifications
+
+### POST `/apps/:appType/notifications/send-by-type`
+
+Requires Bearer token. Sends a notification in the current app scope.
+
+```json
+{
+  "notificationType": "reservation_reminder",
+  "recipientId": "user-id",
+  "payload": {
+    "title": "预约提醒"
+  },
+  "channels": ["inapp"]
+}
+```
+
+### POST `/apps/:appType/notifications/batch-send-by-type`
+
+Requires Bearer token. Sends one notification type to multiple recipients.
+
+### GET `/apps/:appType/notifications/templates`
+
+Requires Bearer token. Lists app/form notification templates.
+
+### PUT `/apps/:appType/notifications/templates/:code`
+
+Requires app admin permission. Upserts an app/form notification template by code.
+
+### POST `/apps/:appType/notifications/templates/preview`
+
+Requires Bearer token. Body uses `templateCode` or `templateId` plus `payload`.
+
+### GET `/apps/:appType/notifications/type-configs`
+
+Requires Bearer token. Lists notification type bindings.
+
+### GET `/apps/:appType/notifications/type-configs/:notificationType`
+
+Requires Bearer token. Resolves the active binding by notification type and optional `formUuid`.
+
+### PUT `/apps/:appType/notifications/type-configs/:notificationType`
+
+Requires app admin permission. Upserts a binding with `templateCode` or `templateId`.
+
 ### GET `/apps/:appType/workflows`
 
 Requires Bearer token. Lists workflow definitions in the app. Supports `formUuid`, `isPublished`, `page`, and `pageSize` query parameters.

package/openxiangda-skills/references/pages/page-sdk.md

@@ -7,6 +7,7 @@ Guidelines:
 - Do not hardcode `/openxiangda-api` calls inside end-user page components unless the page is explicitly an admin tool.
 - Prefer SDK modules for form data, user context, permissions, and platform navigation.
 - Use `sdk.connector.invoke`, `sdk.connector.call("connector.api")`, or `sdk.connector.download` for external services. The SDK calls the platform runtime connector endpoint; it must not call third-party domains directly.
+- Use `sdk.notification.sendByType` and `batchSendByType` for reusable business messages. Custom notification types must be declared in `src/resources/notifications/` and published with `openxiangda resource publish`.
 - For the current user's department hierarchy, use `sdk.department.getCurrentUserParentDepartments()`; do not hardcode `GET /department/:id/parentDepartments` in page code.
 - Keep API calls behind small local functions so generated UI stays testable.
 - Treat user context and tenant context as runtime-provided values.

package/openxiangda-skills/skills/openxiangda-page/SKILL.md

@@ -42,6 +42,7 @@ Read these references only when editing page code:
 - `../../references/pages/workspace-structure.md`
 - `../../references/pages/app-shell.md` — formal backend / PC portal / mobile portal entry pattern. Read before creating any user-facing main entry or admin console.
 - `../../references/pages/page-sdk.md`
+- `../../references/notifications.md` — notification resources and `sdk.notification` usage. Read before adding reminders, alerts, or message templates to a page.
 - `../../references/pages/publish-flow.md`
 - `../../references/style-system.md` — three-layer style architecture, CSS namespace, and the no-hardcoded-color rule. Read before writing any page CSS or Tailwind class.
 - `../../references/architecture-patterns.md` — CRUD data flow, `DataManagementList` pattern, and recommended `src/pages/<pageCode>/` layout. Read before scaffolding a new page or list view.
@@ -54,6 +55,7 @@ Read these references only when editing page code:
 - Formal user-facing entries such as admin consoles, PC portals, and mobile portals must be app-shell code pages. Declare `entry: { mode: "app-shell", hidePlatformNav: true, defaultRoute: "<home-route>" }` in `page.config.ts`.
 - Store live `pageId`, `routeKey`, and `legacyFormUuid` under the current profile only.
 - Use `openxiangda/runtime` for platform data access instead of hardcoding backend URLs in page code.
+- For reminders, alerts, and business messages, declare `src/resources/notifications/` first and call `sdk.notification`; do not hardcode notification API URLs.
 - Named imports from `@ant-design/icons` are supported by the `openxiangda` workspace build proxy, which enumerates icon module exports at runtime.
 - Publish through `openxiangda workspace publish --profile <name>` unless there is a specific repair reason to call `page publish` directly.
 - Do not create custom code pages by writing platform schema directly. The source is React workspace code plus `page.config.ts`.

package/openxiangda-skills/skills/openxiangda-workflow-automation/SKILL.md

@@ -76,6 +76,7 @@ Inside the TypeScript script, prefer `export default async function (ctx) {}` or
 
 - Context: `ctx.triggerEvent`, `ctx.formData`, `ctx.workflowData`, `ctx.operator`, `ctx.app`, `ctx.variables`, and `ctx.node`.
 - Data/process methods: `ctx.methods.queryOneData`, `queryManyData`, `updateOneData`, `updateDataByFormInstanceId`, `updateManyData`, `createOneData`, `terminateProcess`, and `getAllParentDepartments`.
+- Notification bridge: `ctx.notification.sendByType`, `batchSendByType`, `findConfig`, and `previewTemplate`. Declare templates in `src/resources/notifications/` before using custom `notificationType`.
 - Platform API bridge: `ctx.platform.api.get/post/put/patch/delete/request` for `/openxiangda-api/v1`.
 - Node runtime helpers: `require`, `process`, `Buffer`, `ctx.utils`, `ctx.utils.http`, and `ctx.console`.
 
@@ -102,5 +103,6 @@ Use `automation disable` before risky edits. Published automations create a draf
 
 - Workflow v3 JSON: `../../references/workflow-v3.md`
 - Automation v3 JSON and triggers: `../../references/automation-v3.md`
+- Notification resources and runtime calls: `../../references/notifications.md`
 - API fields: `../../references/openxiangda-api.md`
 - Profile-isolated IDs: `../../references/workspace-state.md`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openxiangda",
-  "version": "1.0.21",
+  "version": "1.0.22",
   "description": "OpenXiangda CLI, workspace build tools, runtime SDK, and form components.",
   "private": false,
   "bin": {

package/packages/sdk/dist/runtime/index.cjs

@@ -65,6 +65,9 @@ var resolveAppType = (context, explicitAppType) => {
   return appType;
 };
 var buildAppPath = (context, explicitAppType, suffix) => `/${resolveAppType(context, explicitAppType)}${suffix}`;
+var buildOpenXiangdaAppPath = (context, explicitAppType, suffix) => `/openxiangda-api/v1/apps/${encodePathSegment(
+  resolveAppType(context, explicitAppType)
+)}${suffix}`;
 var encodePathSegment = (value) => encodeURIComponent(String(value));
 var getHeaderValue = (headers, name) => {
   if (!headers) {
@@ -1077,7 +1080,11 @@ var createPageSdk = (context) => {
   };
   const notification = {
     sendByType: (params) => request({
-      path: "/api/notification-config/send-by-type",
+      path: buildOpenXiangdaAppPath(
+        context,
+        params.appType,
+        "/notifications/send-by-type"
+      ),
       method: "post",
       body: {
         ...params,
@@ -1085,7 +1092,32 @@ var createPageSdk = (context) => {
       }
     }),
     batchSendByType: (params) => request({
-      path: "/api/notification-config/batch-send-by-type",
+      path: buildOpenXiangdaAppPath(
+        context,
+        params.appType,
+        "/notifications/batch-send-by-type"
+      ),
+      method: "post",
+      body: {
+        ...params,
+        appType: resolveAppType(context, params.appType)
+      }
+    }),
+    findConfig: (notificationType, params = {}) => request({
+      path: buildOpenXiangdaAppPath(
+        context,
+        params.appType,
+        `/notifications/type-configs/${encodePathSegment(notificationType)}`
+      ),
+      method: "get",
+      query: params.formUuid ? { formUuid: params.formUuid } : void 0
+    }),
+    previewTemplate: (params) => request({
+      path: buildOpenXiangdaAppPath(
+        context,
+        params.appType,
+        "/notifications/templates/preview"
+      ),
       method: "post",
       body: {
         ...params,