@qiqb/message-domain 0.0.0-stage → 0.1.3

package/build/services/MessageController.d.ts

@@ -0,0 +1,108 @@
+import type { PageInfo, WebResp } from '../types/index.js';
+/** 提醒方式与消息级别相互独立，发布方按主题配置生成新消息的展示快照。 */
+export type MessageReminderMode = 'FULLSCREEN' | 'CAROUSEL' | 'FLOATING';
+export type MessageLevel = 'NORMAL' | 'IMPORTANT' | 'SEVERE';
+export interface MessageTopic {
+    id: string;
+    code: string;
+    name: string;
+    sourceSystem: string;
+    enabled: boolean;
+    /** 模式由服务端注册并返回选项，保留 string 以支持宿主扩展订阅策略。 */
+    subscriptionMode: string;
+    /** 旧主题响应可能缺少该字段，页面兼容为 FLOATING（浮动通知）。 */
+    reminderMode?: MessageReminderMode;
+    /** 与提醒方式自由组合，旧主题兼容为 NORMAL（普通）。 */
+    messageLevel?: MessageLevel;
+    description?: string;
+}
+export interface MessageCondition {
+    field: string;
+    operator: string;
+    values: string[];
+}
+export type SubscriptionScope = 'PERSONAL' | 'ROLE';
+export interface MessageSubscription {
+    id: string;
+    name: string;
+    topicCode: string;
+    topicName?: string;
+    subjectType: 'ACCOUNT' | 'ROLE';
+    subjectId?: string;
+    subjectName?: string;
+    enabled: boolean;
+    conditions: MessageCondition[];
+    channels: string[];
+}
+export interface MessageOption {
+    code: string;
+    name: string;
+}
+export interface MessageRole {
+    id: string;
+    name: string;
+    /** 平台角色投影不一定提供编码，显示时以名称为准。 */
+    code?: string;
+}
+export interface SubscriptionMetadata {
+    subjectTypes: MessageOption[];
+    operators: MessageOption[];
+    channels: MessageOption[];
+}
+export interface InboxMessage {
+    id: string;
+    /** 部分投影只提供 id；读取收件标识时统一 receiptId || id。 */
+    receiptId?: string;
+    messageId: string;
+    topicCode: string;
+    topicName?: string;
+    sourceSystem: string;
+    title: string;
+    content: string;
+    businessId?: string;
+    businessType?: string;
+    targetPath?: string;
+    readAt?: string;
+    createTime?: string;
+    occurredAt?: string;
+    expiresAt?: string;
+    /** 保存发布时的提醒方式；主题后续修改不应改变历史消息的展示快照。 */
+    reminderMode?: MessageReminderMode;
+    /** 保存发布时的消息级别；旧消息可能尚未返回该字段。 */
+    messageLevel?: MessageLevel;
+}
+export declare function showMessageError(error: unknown, fallback: string): void;
+export declare const pageMessageTopics: (params: Record<string, unknown>) => Promise<WebResp<PageInfo<MessageTopic>>>;
+export declare const getMessageTopics: () => Promise<WebResp<MessageTopic[]>>;
+export declare const getMessageSubscriptionModes: () => Promise<WebResp<MessageOption[]>>;
+export declare const saveMessageTopic: (data: Omit<MessageTopic, "id"> & {
+    id?: string;
+}) => Promise<WebResp<MessageTopic>>;
+export declare const removeMessageTopic: (id: string) => Promise<WebResp<void>>;
+/** 按主题当前订阅策略补齐账户订阅，服务端保留已有订阅的启停状态。 */
+export declare const syncMessageTopicSubscriptions: (id: string) => Promise<WebResp<{
+    createdCount: number;
+}>>;
+export declare const pageMessageSubscriptions: (params: Record<string, unknown> & {
+    scope: SubscriptionScope;
+}) => Promise<WebResp<PageInfo<MessageSubscription>>>;
+export declare const saveMessageSubscription: (data: Omit<MessageSubscription, "id"> & {
+    id?: string;
+}) => Promise<WebResp<MessageSubscription>>;
+export declare const removeMessageSubscription: (id: string) => Promise<WebResp<void>>;
+export declare const setMessageSubscriptionEnabled: (id: string, enabled: boolean) => Promise<WebResp<void>>;
+export declare const getMessageRoles: (keyword?: string) => Promise<WebResp<MessageRole[]>>;
+export declare const getSubscriptionMetadata: () => Promise<WebResp<SubscriptionMetadata>>;
+export declare const pageInboxMessages: (params: Record<string, unknown>) => Promise<WebResp<PageInfo<InboxMessage>>>;
+export declare const getInboxMessage: (id: string) => Promise<WebResp<InboxMessage>>;
+/** 全局提醒只读取当前账号未读、未过期的收件记录，不会自动更改阅读状态。 */
+export declare const getMessageReminders: (params: {
+    current: number;
+    pageSize: number;
+}) => Promise<WebResp<PageInfo<InboxMessage>>>;
+export declare const getUnreadMessageCount: () => Promise<WebResp<{
+    count: number;
+}>>;
+export declare const markInboxMessageRead: (id: string) => Promise<WebResp<void>>;
+/** 业务消息只能指向站内绝对路径，拒绝协议相对地址、反斜线和控制字符。 */
+export declare function isInternalMessagePath(path?: string): path is string;

package/build/services/MessageController.js

@@ -0,0 +1,42 @@
+import { message } from 'antd';
+import { getMessageDomainRuntime, request } from '../runtime/index.js';
+/** 页面集中处理失败反馈，避免宿主全局提示和本模块提示重复弹出。 */
+async function messageRequest(path, method, data) {
+    const response = await request(`${getMessageDomainRuntime().apiPrefix}${path}`, {
+        method,
+        skipErrorHandler: true,
+        ...(method === 'GET' ? { params: data } : { data }),
+    });
+    if (!response.success)
+        throw new Error(response.message || '消息服务请求失败');
+    return response;
+}
+export function showMessageError(error, fallback) {
+    message.error(error instanceof Error && error.message ? error.message : fallback);
+}
+export const pageMessageTopics = (params) => messageRequest('/topic/page', 'POST', params);
+export const getMessageTopics = () => messageRequest('/topic/options', 'GET');
+export const getMessageSubscriptionModes = () => messageRequest('/topic/subscription_modes', 'GET');
+export const saveMessageTopic = (data) => messageRequest('/topic/save', 'POST', data);
+export const removeMessageTopic = (id) => messageRequest('/topic/remove', 'POST', { id });
+/** 按主题当前订阅策略补齐账户订阅，服务端保留已有订阅的启停状态。 */
+export const syncMessageTopicSubscriptions = (id) => messageRequest('/topic/sync_subscriptions', 'POST', { id });
+export const pageMessageSubscriptions = (params) => messageRequest('/subscription/page', 'POST', params);
+export const saveMessageSubscription = (data) => messageRequest('/subscription/save', 'POST', data);
+export const removeMessageSubscription = (id) => messageRequest('/subscription/remove', 'POST', { id });
+export const setMessageSubscriptionEnabled = (id, enabled) => messageRequest('/subscription/set_enabled', 'POST', { id, enabled });
+export const getMessageRoles = (keyword) => messageRequest('/subscription/roles', 'GET', { keyword });
+export const getSubscriptionMetadata = () => messageRequest('/subscription/metadata', 'GET');
+export const pageInboxMessages = (params) => messageRequest('/inbox/page', 'POST', params);
+export const getInboxMessage = (id) => messageRequest('/inbox/detail_info', 'GET', { id });
+/** 全局提醒只读取当前账号未读、未过期的收件记录，不会自动更改阅读状态。 */
+export const getMessageReminders = (params) => messageRequest('/inbox/reminders', 'GET', params);
+export const getUnreadMessageCount = () => messageRequest('/inbox/unread_count', 'GET');
+export const markInboxMessageRead = (id) => messageRequest('/inbox/mark_read', 'POST', { id });
+/** 业务消息只能指向站内绝对路径，拒绝协议相对地址、反斜线和控制字符。 */
+export function isInternalMessagePath(path) {
+    return (!!path &&
+        path.startsWith('/') &&
+        !path.startsWith('//') &&
+        !/[\\\u0000-\u001f\u007f]/.test(path));
+}

package/build/types/index.d.ts

@@ -0,0 +1,12 @@
+/** 消息领域自有的标准响应投影，避免依赖任一业务宿主的 shared 包。 */
+export interface PageInfo<D> {
+    current?: number;
+    size?: number;
+    total: number;
+    records?: D[];
+}
+export interface WebResp<T> {
+    success: boolean;
+    message?: string;
+    data?: T;
+}

package/build/types/index.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,97 @@
 {
   "name": "@qiqb/message-domain",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.3",
+  "description": "与宿主框架无关的 QIQB 消息主题、订阅、收件箱与全局提醒领域包",
+  "sideEffects": [
+    "**/*.less"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./build/index.d.ts",
+      "default": "./build/index.js"
+    },
+    "./runtime": {
+      "types": "./build/runtime/index.d.ts",
+      "default": "./build/runtime/index.js"
+    },
+    "./routes": {
+      "types": "./build/routes.d.ts",
+      "import": {
+        "types": "./build/routes.d.ts",
+        "default": "./build/routes.js"
+      },
+      "require": {
+        "types": "./build/routes.d.cts",
+        "default": "./build/routes.cjs"
+      },
+      "default": "./build/routes.js"
+    },
+    "./types": {
+      "types": "./build/types/index.d.ts",
+      "default": "./build/types/index.js"
+    },
+    "./pages/*": {
+      "types": "./build/pages/*.d.ts",
+      "default": "./build/pages/*.js"
+    },
+    "./services/*": {
+      "types": "./build/services/*.d.ts",
+      "default": "./build/services/*.js"
+    },
+    "./components/*": {
+      "types": "./build/components/*.d.ts",
+      "default": "./build/components/*.js"
+    },
+    "./runtime/*": {
+      "types": "./build/runtime/*.d.ts",
+      "default": "./build/runtime/*.js"
+    },
+    "./styles/*": "./build/*.less",
+    "./package.json": "./package.json"
+  },
+  "main": "./build/index.js",
+  "types": "./build/index.d.ts",
+  "files": [
+    "build",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "node scripts/build.mjs",
+    "lint": "tsc -p tsconfig.json --noEmit",
+    "pack:local": "npm pack --pack-destination /private/tmp",
+    "publish:local": "node ../scripts/publish-platform-domain.mjs --package message-domain --target local",
+    "publish:nexus": "node ../scripts/publish-platform-domain.mjs --package message-domain --target nexus",
+    "publish:private": "node ../scripts/publish-platform-domain.mjs --package message-domain --target all",
+    "test:reminders": "node scripts/reminder-regression.cjs",
+    "test:routes": "node scripts/routes-entry-regression.cjs",
+    "test:runtime": "node scripts/runtime-regression.cjs",
+    "test:presentation": "node scripts/presentation-regression.cjs",
+    "test:display": "node scripts/display-regression.cjs",
+    "test:navigation": "node scripts/navigation-regression.cjs",
+    "test:realtime": "node scripts/realtime-regression.cjs",
+    "publish:official": "node ../scripts/publish-platform-domain.mjs --package message-domain --target official"
+  },
+  "devDependencies": {
+    "@ant-design/icons": "^6.2.2",
+    "@ant-design/pro-components": "3.1.12-0",
+    "@types/node": "^20.0.0",
+    "@types/react": "^18.0.33",
+    "@types/react-dom": "^18.0.11",
+    "antd": "^6.3.7",
+    "react": "18.3.1",
+    "react-dom": "18.3.1",
+    "typescript": "^5.6.0"
+  },
+  "peerDependencies": {
+    "@ant-design/icons": ">=5.0.0 <7.0.0",
+    "@ant-design/pro-components": ">=2.8.0 <4.0.0",
+    "antd": ">=5.0.0 <7.0.0",
+    "react": ">=18.0.0 <20.0.0",
+    "react-dom": ">=18.0.0 <20.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}