@nocobase/plugin-notification-manager 2.1.0-beta.9 → 2.1.0

package/dist/server/manager.d.ts

@@ -8,19 +8,66 @@
  */
 import { Registry } from '@nocobase/utils';
 import PluginNotificationManagerServer from './plugin';
-import type { NotificationChannelConstructor, RegisterServerTypeFnParams, SendOptions, SendUserOptions, WriteLogOptions } from './types';
+import type { NotificationQueueMessage, NotificationChannelConstructor, RegisterServerTypeFnParams, ReceiversOptions, SendOptions, SendUserOptions, WriteLogOptions } from './types';
 export declare class NotificationManager implements NotificationManager {
+    private static readonly SLOW_SEND_THRESHOLD_MS;
     private plugin;
     channelTypes: Registry<{
         Channel: NotificationChannelConstructor;
+        useQueue: boolean;
     }>;
     constructor({ plugin }: {
         plugin: PluginNotificationManagerServer;
     });
-    registerType({ type, Channel }: RegisterServerTypeFnParams): void;
-    createSendingRecord: (options: WriteLogOptions) => Promise<any>;
+    registerType({ type, Channel, useQueue }: RegisterServerTypeFnParams): void;
+    createSendingRecord: (options: WriteLogOptions) => Promise<import("@nocobase/database").Model<any, any>>;
+    private toQueueMessage;
+    private getQueuedResult;
+    private getDirectResult;
+    private getDeferredResult;
+    private shouldUseQueue;
+    private enqueue;
+    private dispatchAfterCommit;
     findChannel(name: string): Promise<any>;
-    send(params: SendOptions): Promise<any>;
-    sendToUsers(options: SendUserOptions): Promise<any[]>;
+    private getReceiverMeta;
+    send(params: SendOptions): Promise<{
+        status: "success" | "failure";
+        reason: string;
+        triggerFrom: string;
+        channelName: string;
+        receivers: ReceiversOptions;
+        queued: boolean;
+    } | {
+        status: "success";
+        triggerFrom: string;
+        channelName: string;
+        receivers: ReceiversOptions;
+    } | {
+        status: "failure";
+        reason: string;
+        triggerFrom: string;
+        channelName: string;
+        receivers: ReceiversOptions;
+    }>;
+    sendNow(params: NotificationQueueMessage): Promise<any>;
+    sendToUsers(options: SendUserOptions): Promise<({
+        status: "success" | "failure";
+        reason: string;
+        triggerFrom: string;
+        channelName: string;
+        receivers: ReceiversOptions;
+        queued: boolean;
+    } | {
+        status: "success";
+        triggerFrom: string;
+        channelName: string;
+        receivers: ReceiversOptions;
+    } | {
+        status: "failure";
+        reason: string;
+        triggerFrom: string;
+        channelName: string;
+        receivers: ReceiversOptions;
+    })[]>;
 }
 export default NotificationManager;

package/dist/server/manager.js

@@ -31,65 +31,215 @@ __export(manager_exports, {
 });
 module.exports = __toCommonJS(manager_exports);
 var import_utils = require("@nocobase/utils");
+var import_uuid = require("uuid");
 var import_constant = require("../constant");
 var import_compile = require("./utils/compile");
 class NotificationManager {
+  static SLOW_SEND_THRESHOLD_MS = 500;
   plugin;
   channelTypes = new import_utils.Registry();
   constructor({ plugin }) {
     this.plugin = plugin;
   }
-  registerType({ type, Channel }) {
-    this.channelTypes.register(type, { Channel });
+  registerType({ type, Channel, useQueue = true }) {
+    this.channelTypes.register(type, { Channel, useQueue });
   }
   createSendingRecord = async (options) => {
-    const logsRepo = this.plugin.app.db.getRepository(import_constant.COLLECTION_NAME.logs);
-    return logsRepo.create({ values: options });
+    const LogsModel = this.plugin.app.db.getModel(import_constant.COLLECTION_NAME.logs);
+    return LogsModel.create(
+      {
+        id: (0, import_uuid.v4)(),
+        ...options
+      },
+      {
+        hooks: false,
+        validate: false
+      }
+    );
   };
+  toQueueMessage(params) {
+    const { transaction, ...message } = params;
+    return message;
+  }
+  getQueuedResult(params) {
+    return {
+      status: "success",
+      triggerFrom: params.triggerFrom,
+      channelName: params.channelName,
+      receivers: params.receivers,
+      queued: true
+    };
+  }
+  getDirectResult(params, result) {
+    return {
+      status: result.status,
+      reason: result.reason,
+      triggerFrom: params.triggerFrom,
+      channelName: params.channelName,
+      receivers: params.receivers,
+      queued: false
+    };
+  }
+  getDeferredResult(params) {
+    return {
+      status: "success",
+      triggerFrom: params.triggerFrom,
+      channelName: params.channelName,
+      receivers: params.receivers
+    };
+  }
+  async shouldUseQueue(channelName) {
+    const channel = await this.findChannel(channelName);
+    if (!channel) {
+      return true;
+    }
+    const channelType = this.channelTypes.get(channel.notificationType);
+    return (channelType == null ? void 0 : channelType.useQueue) ?? true;
+  }
+  async enqueue(message) {
+    await this.plugin.app.eventQueue.publish(this.plugin.sendQueueChannel, message);
+  }
+  async dispatchAfterCommit(message) {
+    const useQueue = await this.shouldUseQueue(message.channelName);
+    if (useQueue) {
+      await this.enqueue(message);
+      return;
+    }
+    await this.sendNow(message);
+  }
   async findChannel(name) {
-    const repository = this.plugin.app.db.getRepository(import_constant.COLLECTION_NAME.channels);
-    const instance = await repository.findOne({ filterByTk: name });
-    if (!instance) {
-      return null;
+    return await this.plugin.getChannel(name);
+  }
+  getReceiverMeta(receivers) {
+    if (!receivers) {
+      return {};
+    }
+    if (receivers.type === "userId") {
+      return {
+        receiverType: receivers.type,
+        receiverCount: receivers.value.length
+      };
     }
-    return this.plugin.app.environment.renderJsonTemplate(instance.toJSON());
+    return {
+      receiverType: receivers.type
+    };
   }
   async send(params) {
-    this.plugin.logger.info("receive sending message request", params);
+    const queueMessage = this.toQueueMessage(params);
+    const transaction = params.transaction;
+    if (transaction == null ? void 0 : transaction.afterCommit) {
+      transaction.afterCommit(() => {
+        return this.dispatchAfterCommit(queueMessage).catch((error) => {
+          this.plugin.logger.error("notification dispatch failed after transaction committed", {
+            channelName: params.channelName,
+            triggerFrom: params.triggerFrom,
+            reason: error instanceof Error ? `${error.name}: ${error.message}` : JSON.stringify(error)
+          });
+        });
+      });
+      return this.getDeferredResult(params);
+    }
+    const useQueue = await this.shouldUseQueue(params.channelName);
+    if (!useQueue) {
+      const result = await this.sendNow(queueMessage);
+      return this.getDirectResult(params, result);
+    }
+    try {
+      await this.enqueue(queueMessage);
+      return this.getQueuedResult(params);
+    } catch (error) {
+      const reason = error instanceof Error ? `${error.name}: ${error.message}` : JSON.stringify(error);
+      this.plugin.logger.error("notification queue publish failed", {
+        channelName: params.channelName,
+        triggerFrom: params.triggerFrom,
+        reason
+      });
+      return {
+        status: "failure",
+        reason,
+        triggerFrom: params.triggerFrom,
+        channelName: params.channelName,
+        receivers: params.receivers
+      };
+    }
+  }
+  async sendNow(params) {
+    const startedAt = Date.now();
+    const receiverMeta = this.getReceiverMeta(params.receivers);
+    const compileStartedAt = Date.now();
     const message = (0, import_compile.compile)(params.message ?? {}, params.data ?? {});
+    const compileMs = Date.now() - compileStartedAt;
     const messageData = { ...params.receivers ? { receivers: params.receivers } : {}, ...message };
     const logData = {
       triggerFrom: params.triggerFrom,
       channelName: params.channelName,
       message: messageData
     };
+    let findChannelMs = 0;
+    let channelSendMs = 0;
     try {
+      const findChannelStartedAt = Date.now();
       const channel = await this.findChannel(params.channelName);
+      findChannelMs = Date.now() - findChannelStartedAt;
       if (channel) {
         const Channel = this.channelTypes.get(channel.notificationType).Channel;
         const instance = new Channel(this.plugin.app);
         logData.channelTitle = channel.title;
         logData.notificationType = channel.notificationType;
         logData.receivers = params.receivers;
-        const result = await instance.send({ message, channel, receivers: params.receivers });
+        const channelSendStartedAt = Date.now();
+        const result = await instance.send({
+          message,
+          channel,
+          receivers: params.receivers
+        });
+        channelSendMs = Date.now() - channelSendStartedAt;
         logData.status = result.status;
         logData.reason = result.reason;
       } else {
         logData.status = "failure";
         logData.reason = "channel not found";
       }
-      this.createSendingRecord(logData);
+      await this.createSendingRecord(logData);
+      const totalMs = Date.now() - startedAt;
+      if (totalMs >= NotificationManager.SLOW_SEND_THRESHOLD_MS) {
+        this.plugin.logger.warn("notification send is slow", {
+          channelName: params.channelName,
+          triggerFrom: params.triggerFrom,
+          status: logData.status,
+          notificationType: logData.notificationType,
+          compileMs,
+          findChannelMs,
+          channelSendMs,
+          totalMs,
+          ...receiverMeta
+        });
+      }
       return logData;
     } catch (error) {
       logData.status = "failure";
-      this.plugin.logger.error(`notification send failed, options: ${JSON.stringify(error)}`);
-      logData.reason = JSON.stringify(error);
-      this.createSendingRecord(logData);
+      const totalMs = Date.now() - startedAt;
+      const reason = error instanceof Error ? `${error.name}: ${error.message}` : JSON.stringify(error);
+      this.plugin.logger.error("notification send failed", {
+        channelName: params.channelName,
+        triggerFrom: params.triggerFrom,
+        compileMs,
+        findChannelMs,
+        channelSendMs,
+        totalMs,
+        reason,
+        ...receiverMeta
+      });
+      logData.reason = reason;
+      await this.createSendingRecord(logData);
       return logData;
     }
   }
   async sendToUsers(options) {
-    this.plugin.logger.info(`notificationManager.sendToUsers options: ${JSON.stringify(options)}`);
+    this.plugin.logger.debug("notificationManager.sendToUsers", {
+      channelCount: options.channels.length,
+      userCount: options.userIds.length
+    });
     const { userIds, channels, message, data = {} } = options;
     return await Promise.all(
       channels.map(
@@ -98,7 +248,8 @@ class NotificationManager {
           message,
           data,
           triggerFrom: "sendToUsers",
-          receivers: { value: userIds, type: "userId" }
+          receivers: { value: userIds, type: "userId" },
+          transaction: options.transaction
         })
       )
     );

package/dist/server/plugin.d.ts

@@ -6,18 +6,65 @@
  * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
+import type { Cache } from '@nocobase/cache';
 import type { Logger } from '@nocobase/logger';
+import { Transactionable } from '@nocobase/database';
 import { Plugin } from '@nocobase/server';
 import { RegisterServerTypeFnParams, SendOptions, SendUserOptions } from './types';
 export declare class PluginNotificationManagerServer extends Plugin {
+    private static readonly CHANNELS_CACHE_KEY;
     private manager;
     logger: Logger;
+    cache: Cache;
+    get sendQueueChannel(): string;
+    private ensureCache;
+    parseChannel(instance: any): any;
+    loadChannels(options?: Transactionable): Promise<void>;
+    getChannel(name: string): Promise<any>;
     get channelTypes(): import("@nocobase/utils").Registry<{
         Channel: import("./types").NotificationChannelConstructor;
+        useQueue: boolean;
     }>;
     registerChannelType(params: RegisterServerTypeFnParams): void;
-    send(options: SendOptions): Promise<any>;
-    sendToUsers(options: SendUserOptions): Promise<any[]>;
+    send(options: SendOptions): Promise<{
+        status: "success" | "failure";
+        reason: string;
+        triggerFrom: string;
+        channelName: string;
+        receivers: import("./types").ReceiversOptions;
+        queued: boolean;
+    } | {
+        status: "success";
+        triggerFrom: string;
+        channelName: string;
+        receivers: import("./types").ReceiversOptions;
+    } | {
+        status: "failure";
+        reason: string;
+        triggerFrom: string;
+        channelName: string;
+        receivers: import("./types").ReceiversOptions;
+    }>;
+    sendNow(options: SendOptions): Promise<any>;
+    sendToUsers(options: SendUserOptions): Promise<({
+        status: "success" | "failure";
+        reason: string;
+        triggerFrom: string;
+        channelName: string;
+        receivers: import("./types").ReceiversOptions;
+        queued: boolean;
+    } | {
+        status: "success";
+        triggerFrom: string;
+        channelName: string;
+        receivers: import("./types").ReceiversOptions;
+    } | {
+        status: "failure";
+        reason: string;
+        triggerFrom: string;
+        channelName: string;
+        receivers: import("./types").ReceiversOptions;
+    })[]>;
     afterAdd(): Promise<void>;
     beforeLoad(): Promise<void>;
     load(): Promise<void>;

package/dist/server/plugin.js

@@ -41,10 +41,50 @@ __export(plugin_exports, {
 });
 module.exports = __toCommonJS(plugin_exports);
 var import_server = require("@nocobase/server");
+var import_constant = require("../constant");
 var import_manager = __toESM(require("./manager"));
 class PluginNotificationManagerServer extends import_server.Plugin {
+  static CHANNELS_CACHE_KEY = "channels";
   manager;
   logger;
+  cache;
+  get sendQueueChannel() {
+    return `${this.name}.send`;
+  }
+  async ensureCache() {
+    if (!this.cache) {
+      this.cache = await this.app.cacheManager.createCache({
+        name: this.name,
+        prefix: this.name
+      });
+    }
+    return this.cache;
+  }
+  parseChannel(instance) {
+    return this.app.environment.renderJsonTemplate(instance.toJSON());
+  }
+  async loadChannels(options) {
+    const cache = await this.ensureCache();
+    const repository = this.app.db.getRepository(import_constant.COLLECTION_NAME.channels);
+    const channels = await repository.find({
+      transaction: options == null ? void 0 : options.transaction
+    });
+    const channelsCache = {};
+    for (const channel of channels) {
+      channelsCache[channel.get("name")] = this.parseChannel(channel);
+    }
+    await cache.set(PluginNotificationManagerServer.CHANNELS_CACHE_KEY, channelsCache);
+  }
+  async getChannel(name) {
+    const cache = await this.ensureCache();
+    const channels = await cache.get(PluginNotificationManagerServer.CHANNELS_CACHE_KEY) || void 0;
+    if (!channels) {
+      await this.loadChannels();
+      const reloadedChannels = await cache.get(PluginNotificationManagerServer.CHANNELS_CACHE_KEY);
+      return (reloadedChannels == null ? void 0 : reloadedChannels[name]) || null;
+    }
+    return channels[name] || null;
+  }
   get channelTypes() {
     return this.manager.channelTypes;
   }
@@ -54,6 +94,10 @@ class PluginNotificationManagerServer extends import_server.Plugin {
   async send(options) {
     return await this.manager.send(options);
   }
+  async sendNow(options) {
+    const { transaction, ...message } = options;
+    return await this.manager.sendNow(message);
+  }
   async sendToUsers(options) {
     return await this.manager.sendToUsers(options);
   }
@@ -69,8 +113,8 @@ class PluginNotificationManagerServer extends import_server.Plugin {
     this.app.resourceManager.registerActionHandler("messages:send", async (ctx, next) => {
       var _a, _b;
       const sendOptions = (_b = (_a = ctx.action) == null ? void 0 : _a.params) == null ? void 0 : _b.values;
-      this.manager.send(sendOptions);
-      next();
+      await this.manager.send(sendOptions);
+      await next();
     });
     this.app.acl.registerSnippet({
       name: "pm.notification.channels",
@@ -80,16 +124,35 @@ class PluginNotificationManagerServer extends import_server.Plugin {
       name: "pm.notification.logs",
       actions: ["notificationSendLogs:*"]
     });
+    this.app.on("afterStart", async () => {
+      await this.loadChannels();
+    });
   }
   async load() {
+    const Channel = this.app.db.getModel(import_constant.COLLECTION_NAME.channels);
+    Channel.afterSave(async (_model, { transaction }) => {
+      await this.loadChannels({ transaction });
+    });
+    Channel.afterDestroy(async (_model, { transaction }) => {
+      await this.loadChannels({ transaction });
+    });
+    this.app.eventQueue.subscribe(this.sendQueueChannel, {
+      concurrency: 1,
+      idle: () => true,
+      process: async (message) => {
+        await this.manager.sendNow(message);
+      }
+    });
   }
   async install() {
   }
   async afterEnable() {
   }
   async afterDisable() {
+    this.app.eventQueue.unsubscribe(this.sendQueueChannel);
   }
   async remove() {
+    this.app.eventQueue.unsubscribe(this.sendQueueChannel);
   }
 }
 var plugin_default = PluginNotificationManagerServer;

package/dist/server/types.d.ts

@@ -6,6 +6,7 @@
  * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
+import { Transactionable } from '@nocobase/database';
 import { Application } from '@nocobase/server';
 import { BaseNotificationChannel } from './base-notification-channel';
 /**
@@ -33,9 +34,10 @@ export type SendFnType<Message> = (args: {
     message: Message;
     channel: ChannelOptions;
     receivers?: ReceiversOptions;
+    transaction?: Transactionable['transaction'];
 }) => Promise<{
     message: Message;
-    status: 'success' | 'fail';
+    status: 'success' | 'failure';
     reason?: string;
 }>;
 export type ReceiversOptions = {
@@ -46,14 +48,15 @@ export type ReceiversOptions = {
     type: 'channel-self-defined';
     channelType: string;
 };
-export interface SendOptions {
+export interface SendOptions extends Transactionable {
     channelName: string;
     message: Record<string, any>;
     triggerFrom: string;
     receivers?: ReceiversOptions;
     data?: Record<string, any>;
 }
-export interface SendUserOptions {
+export type NotificationQueueMessage = Omit<SendOptions, 'transaction'>;
+export interface SendUserOptions extends Transactionable {
     userIds: number[];
     channels: string[];
     message: Record<string, any>;
@@ -63,4 +66,5 @@ export type NotificationChannelConstructor = new (app: Application) => BaseNotif
 export type RegisterServerTypeFnParams = {
     type: string;
     Channel: NotificationChannelConstructor;
+    useQueue?: boolean;
 };

package/package.json

@@ -6,7 +6,7 @@
   "description.ru-RU": "Предоставляет единый сервис управления, включающий конфигурирование каналов, логирование и другие функции, поддерживает настройку различных каналов уведомлений, включая внутренние сообщения и электронную почту.",
   "displayName.zh-CN": "通知管理",
   "description.zh-CN": "提供统一的管理服务，涵盖渠道配置、日志记录等功能，支持多种通知渠道的配置，包括站内信和电子邮件等。",
-  "version": "2.1.0-beta.9",
+  "version": "2.1.0",
   "homepage": "https://docs.nocobase.com/handbook/notification-manager",
   "homepage.ru-RU": "https://docs-ru.nocobase.com/handbook/notification-manager",
   "homepage.zh-CN": "https://docs-cn.nocobase.com/handbook/notification-manager",
@@ -25,6 +25,7 @@
   "peerDependencies": {
     "@nocobase/actions": "2.x",
     "@nocobase/client": "2.x",
+    "@nocobase/client-v2": "2.x",
     "@nocobase/database": "2.x",
     "@nocobase/plugin-workflow": ">=0.17.0-alpha.3",
     "@nocobase/server": "2.x",
@@ -35,5 +36,5 @@
     "Notification"
   ],
   "license": "Apache-2.0",
-  "gitHead": "c3a2875e4cbbb43b1f2361e6f9f5f84a7d3f3c3c"
+  "gitHead": "9373212dd0f22cd985be1e23674d6b454944b9ee"
 }

package/dist/client/035b24990a46d186.js

@@ -1,10 +0,0 @@
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
- * For more information, please refer to: https://www.nocobase.com/agreement.
- */
-
-"use strict";(self.webpackChunk_nocobase_plugin_notification_manager=self.webpackChunk_nocobase_plugin_notification_manager||[]).push([["969"],{358:function(e,t,o){o.r(t),o.d(t,{LogManager:function(){return f}});var n,r,i=o(772),p=o(721),a=o(156),c=o.n(a),l=o(712),s=o(807),m=o(551),d=o(655),u=o(296),y={id:{"x-component":"CollectionField","x-decorator":"FormItem","x-disabled":!0,"x-read-pretty":!0},channelName:{"x-component":"CollectionField","x-decorator":"FormItem","x-read-pretty":!0},channelTitle:{"x-component":"CollectionField","x-decorator":"FormItem","x-read-pretty":!0},notificationType:{"x-component":"CollectionField","x-decorator":"FormItem","x-read-pretty":!0},triggerFrom:{"x-component":"CollectionField","x-decorator":"FormItem","x-read-pretty":!0},status:{"x-component":"CollectionField","x-decorator":"FormItem","x-read-pretty":!0},message:{"x-component":"CollectionField","x-decorator":"FormItem","x-read-pretty":!0},reason:{"x-component":"CollectionField","x-decorator":"FormItem","x-read-pretty":!0,"x-reactions":[{dependencies:["status"],fulfill:{state:{visible:'{{$deps[0] === "failure"}}'}}}]},createdAt:{"x-component":"CollectionField","x-decorator":"FormItem","x-read-pretty":!0,"x-component-props":{dateFormat:"YYYY-MM-DD",showTime:!0,timeFormat:"HH:mm:ss"}}},x={type:"void","x-uid":"t8tkmt2b9dd",name:u.O.logs,"x-decorator":"TableBlockProvider","x-decorator-props":{collection:s.Z.name,action:"list",params:{sort:["-createdAt"]},showIndex:!0,dragSort:!1},properties:{actions:{type:"void","x-component":"ActionBar","x-component-props":{style:{marginBottom:16}},properties:{refresh:{title:"{{t('Refresh')}}","x-action":"refresh","x-component":"Action","x-use-component-props":"useRefreshActionProps","x-component-props":{icon:"ReloadOutlined"}},filter:{"x-action":"filter","x-component":"Filter.Action",title:"{{t('Filter')}}","x-use-component-props":"useFilterActionProps","x-component-props":{icon:"FilterOutlined",nonfilterable:["receiver","reason"]},"x-align":"left"}}},table:{type:"array","x-component":"TableV2","x-use-component-props":"useTableBlockProps","x-component-props":{rowKey:"id"},properties:{createdAt:{type:"void","x-component":"TableV2.Column","x-component-props":{width:100},title:'{{t("Created at")}}',properties:{createdAt:{type:"string","x-component":"CollectionField","x-pattern":"readPretty","x-component-props":{dateFormat:"YYYY-MM-DD",showTime:!0,timeFormat:"HH:mm:ss"}}}},triggerFrom:{type:"void","x-component":"TableV2.Column","x-component-props":{width:100},title:'{{t("Trigger from")}}',properties:{triggerFrom:{type:"string","x-component":"CollectionField","x-read-pretty":!0,"x-component-props":{ellipsis:!0}}}},channelTitle:{type:"void","x-component":"TableV2.Column","x-component-props":{width:100},title:'{{t("Channel display name")}}',properties:{channelTitle:{type:"string","x-component":"CollectionField","x-read-pretty":!0,"x-component-props":{ellipsis:!0}}}},notificationType:{title:'{{t("Notification type")}}',type:"void","x-component":"TableV2.Column",properties:{notificationType:{type:"string","x-component":"CollectionField","x-read-pretty":!0}}},status:{type:"void","x-component":"TableV2.Column","x-component-props":{width:100},title:'{{t("Status")}}',properties:{status:{type:"string","x-component":"CollectionField","x-pattern":"readPretty"}}},reason:{type:"void","x-component":"TableV2.Column","x-component-props":{width:200},title:'{{t("Failed reason")}}',properties:{reason:{type:"string","x-component":"CollectionField","x-read-pretty":!0,"x-component-props":{ellipsis:!0}}}},actions:{type:"void",title:'{{t("Actions")}}',"x-component":"TableV2.Column",properties:{view:{type:"void",title:'{{t("View")}}',"x-component":"Action.Link","x-component-props":{openMode:"drawer"},properties:{drawer:{type:"void",title:'{{t("Log detail")}}',"x-component":"Action.Drawer",properties:{detail:{type:"void","x-component":"FormV2","x-use-component-props":"useEditFormProps","x-decorator":"BlockItemCard",properties:(n=function(e){for(var t=1;t<arguments.length;t++){var o=null!=arguments[t]?arguments[t]:{},n=Object.keys(o);"function"==typeof Object.getOwnPropertySymbols&&(n=n.concat(Object.getOwnPropertySymbols(o).filter(function(e){return Object.getOwnPropertyDescriptor(o,e).enumerable}))),n.forEach(function(t){var n;n=o[t],t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n})}return e}({},y),r=r={footer:{type:"void","x-component":"Action.Drawer.Footer"}},Object.getOwnPropertyDescriptors?Object.defineProperties(n,Object.getOwnPropertyDescriptors(r)):(function(e,t){var o=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);o.push.apply(o,n)}return o})(Object(r)).forEach(function(e){Object.defineProperty(n,e,Object.getOwnPropertyDescriptor(r,e))}),n)}}}}}}}}}}},f=function(){var e=(0,m.oG)().t,t=(0,i.useSchemaComponentContext)(),o=(0,d.aT)(),n=(0,a.useMemo)(function(){var e,o;return e=function(e){for(var t=1;t<arguments.length;t++){var o=null!=arguments[t]?arguments[t]:{},n=Object.keys(o);"function"==typeof Object.getOwnPropertySymbols&&(n=n.concat(Object.getOwnPropertySymbols(o).filter(function(e){return Object.getOwnPropertyDescriptor(o,e).enumerable}))),n.forEach(function(t){var n;n=o[t],t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n})}return e}({},t),o=o={designable:!1},Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(o)):(function(e,t){var o=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);o.push.apply(o,n)}return o})(Object(o)).forEach(function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(o,t))}),e},[t]);return c().createElement(i.ExtendCollectionsProvider,{collections:[s.Z,l.Z]},c().createElement(i.SchemaComponentContext.Provider,{value:n},c().createElement(p.Card,{bordered:!1},c().createElement(i.SchemaComponent,{schema:x,scope:{t:e,useEditFormProps:d.fC,notificationTypeOptions:o}}))))};f.displayName="LogManager"},712:function(e,t,o){t.Z={name:o(296).O.channels,migrationRules:["overwrite","schema-only"],filterTargetKey:"name",autoGenId:!1,createdAt:!0,createdBy:!0,updatedAt:!0,updatedBy:!0,fields:[{name:"name",type:"uid",prefix:"s_",primaryKey:!0,interface:"input",uiSchema:{type:"string",title:'{{t("Channel name")}}',"x-component":"Input",required:!0,description:"{{t('Randomly generated and can not be modified. Support letters, numbers and underscores, must start with an letter.')}}"}},{name:"title",type:"string",interface:"input",uiSchema:{type:"string","x-component":"Input",title:'{{t("Channel display name")}}',required:!0}},{name:"options",type:"json",interface:"json",uiSchema:{type:"object","x-component":"ConfigForm"}},{name:"meta",type:"json",interface:"json"},{interface:"input",type:"string",name:"notificationType",uiSchema:{type:"string",title:'{{t("Notification type")}}',"x-component":"Select",enum:"{{notificationTypeOptions}}",required:!0}},{name:"description",type:"text",interface:"textarea",uiSchema:{type:"string","x-component":"Input.TextArea",title:'{{t("Description")}}'}}]}},807:function(e,t,o){t.Z={name:o(296).O.logs,migrationRules:["schema-only"],title:"MessageLogs",fields:[{name:"id",type:"uuid",primaryKey:!0,allowNull:!1,interface:"uuid",uiSchema:{type:"string",title:'{{t("ID")}}',"x-component":"Input","x-read-pretty":!0}},{name:"channelName",type:"string",interface:"input",uiSchema:{type:"string",title:'{{t("Channel name")}}',"x-component":"Input"}},{name:"channelTitle",type:"string",interface:"input",uiSchema:{type:"string","x-component":"Input",title:'{{t("Channel display name")}}'}},{name:"triggerFrom",type:"string",interface:"input",uiSchema:{type:"string","x-component":"Input",title:'{{t("Trigger from")}}'}},{name:"notificationType",type:"string",interface:"input",uiSchema:{type:"string",title:'{{t("Notification type")}}',"x-component":"Select",enum:"{{notificationTypeOptions}}",required:!0}},{name:"status",type:"string",interface:"select",uiSchema:{type:"string","x-component":"Select",enum:[{label:'{{t("Success")}}',value:"success",color:"green"},{label:'{{t("Failure")}}',value:"failure",color:"red"}],title:'{{t("Status")}}'}},{name:"message",type:"json",interface:"json",uiSchema:{"x-component":"Input.JSON",title:'{{t("Message")}}',"x-component-props":{autoSize:{minRows:5}},autoSize:{minRows:5}}},{name:"reason",type:"text",interface:"input",uiSchema:{type:"string","x-component":"Input",title:'{{t("Failed reason")}}'}},{name:"createdAt",type:"date",interface:"createdAt",field:"createdAt",uiSchema:{type:"datetime",title:'{{t("Created at")}}',"x-component":"DatePicker","x-component-props":{},"x-read-pretty":!0}},{name:"updatedAt",type:"date",interface:"updatedAt",field:"updatedAt",uiSchema:{type:"datetime",title:'{{t("Last updated at")}}',"x-component":"DatePicker","x-component-props":{},"x-read-pretty":!0}}]}}}]);

package/dist/client/b1941306dc0db9f3.js

@@ -1,10 +0,0 @@
-/**
- * This file is part of the NocoBase (R) project.
- * Copyright (c) 2020-2024 NocoBase Co., Ltd.
- * Authors: NocoBase Team.
- *
- * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
- * For more information, please refer to: https://www.nocobase.com/agreement.
- */
-
-"use strict";(self.webpackChunk_nocobase_plugin_notification_manager=self.webpackChunk_nocobase_plugin_notification_manager||[]).push([["843"],{709:function(e,t,n){n.r(t),n.d(t,{ChannelManager:function(){return S}});var o=n(482),r=n(772),i=n(721),c=n(156),a=n.n(c),p=n(712),l=n(807),s=n(551),u=n(765),m=n(655),d=n(875),y=n(296);function f(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{},o=Object.keys(n);"function"==typeof Object.getOwnPropertySymbols&&(o=o.concat(Object.getOwnPropertySymbols(n).filter(function(e){return Object.getOwnPropertyDescriptor(n,e).enumerable}))),o.forEach(function(t){var o;o=n[t],t in e?Object.defineProperty(e,t,{value:o,enumerable:!0,configurable:!0,writable:!0}):e[t]=o})}return e}function x(e,t){return t=null!=t?t:{},Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):(function(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);n.push.apply(n,o)}return n})(Object(t)).forEach(function(n){Object.defineProperty(e,n,Object.getOwnPropertyDescriptor(t,n))}),e}var b={type:"object",properties:{drawer:{type:"void","x-component":"Action.Drawer","x-decorator":"FormV2","x-use-decorator-props":"useCreateFormProps",title:'{{t("Add new")}}',properties:x(f({},{name:{"x-component":"CollectionField","x-decorator":"FormItem"},title:{"x-component":"CollectionField","x-decorator":"FormItem"},description:{"x-component":"CollectionField","x-decorator":"FormItem"},options:{"x-component":"CollectionField"}}),{footer:{type:"void","x-component":"Action.Drawer.Footer",properties:{cancel:{title:'{{t("Cancel")}}',"x-component":"Action","x-use-component-props":"useCloseActionProps"},submit:{title:'{{t("Submit")}}',"x-component":"Action","x-use-component-props":"useCreateActionProps"}}}})}}},h={type:"void",name:(0,d.uid)(),"x-decorator":"TableBlockProvider","x-decorator-props":{collection:y.O.channels,action:"list",dragSort:!1,params:{sort:["createdAt"],pageSize:20}},properties:{actions:{type:"void","x-component":"ActionBar","x-component-props":{style:{marginBottom:16}},properties:{refresh:{title:"{{t('Refresh')}}","x-action":"refresh","x-component":"Action","x-use-component-props":"useRefreshActionProps","x-component-props":{icon:"ReloadOutlined"}},create:{type:"void",title:'{{t("Add new")}}',"x-component":"AddNew","x-component-props":{type:"primary"}},filter:{"x-action":"filter",type:"object","x-component":"Filter.Action",title:"{{t('Filter')}}","x-use-component-props":"useFilterActionProps","x-component-props":{icon:"FilterOutlined"},"x-align":"left"}}},table:{type:"array","x-component":"TableV2","x-use-component-props":"useTableBlockProps","x-component-props":{rowKey:"name"},properties:{title:{type:"void","x-component":"TableV2.Column",title:'{{t("Channel display name")}}',"x-component-props":{width:100},properties:{title:{type:"string","x-component":"CollectionField","x-read-pretty":!0,"x-component-props":{ellipsis:!0}}}},name:{type:"void","x-component":"TableV2.Column",title:'{{t("Channel name")}}',"x-component-props":{width:100},properties:{name:{type:"string","x-component":"CollectionField","x-read-pretty":!0,"x-component-props":{ellipsis:!0}}}},description:{type:"void","x-component":"TableV2.Column",title:'{{t("Description")}}',"x-component-props":{width:200},properties:{description:{type:"boolean","x-component":"CollectionField","x-read-pretty":!0,"x-component-props":{ellipsis:!0}}}},notificationType:{title:'{{t("Notification type")}}',type:"void","x-component":"TableV2.Column","x-component-props":{width:200},properties:{notificationType:{type:"string","x-component":"CollectionField","x-read-pretty":!0}}},actions:{type:"void",title:'{{t("Actions")}}',"x-component":"TableV2.Column",properties:{edit:{type:"void",title:'{{t("Edit")}}',"x-component":"Action.Link","x-component-props":{openMode:"drawer"},"x-use-component-props":"useRecordEditActionProps","x-decorator":"Space",properties:{drawer:{type:"void",title:'{{t("Edit")}}',"x-component":"Action.Drawer","x-decorator":"FormV2","x-use-decorator-props":"useEditFormProps",properties:x(f({},{name:{"x-component":"CollectionField","x-decorator":"FormItem","x-disabled":!0},title:{"x-component":"CollectionField","x-decorator":"FormItem"},description:{"x-component":"CollectionField","x-decorator":"FormItem"},options:{"x-component":"CollectionField"}}),{footer:{type:"void","x-component":"Action.Drawer.Footer",properties:{cancel:{title:'{{t("Cancel")}}',"x-component":"Action","x-use-component-props":"useCloseActionProps"},submit:{title:"Submit","x-component":"Action","x-use-component-props":"useEditActionProps"}}}})}}},delete:{type:"void",title:'{{t("Delete")}}',"x-decorator":"Space","x-component":"Action.Link","x-use-component-props":"useRecordDeleteActionProps","x-component-props":{confirm:{title:"{{t('Delete record')}}",content:"{{t('Are you sure you want to delete it?')}}"}}}}}}}}},g=n(505),v=(0,g.observer)(function(){var e,t,n=(0,g.useForm)(),o=(0,r.useCollectionRecord)(),i=n.values.notificationType||(null==o||null==(e=o.data)?void 0:e.notificationType),p=(0,c.useContext)(u.wi).channelTypes.find(function(e){return e.type===i});return(null==(t=p.components)?void 0:t.ChannelConfigForm)?a().createElement(p.components.ChannelConfigForm,null):null},{displayName:"ConfigForm"});function C(e,t){(null==t||t>e.length)&&(t=e.length);for(var n=0,o=Array(t);n<t;n++)o[n]=e[n];return o}function P(e,t,n,o,r,i,c){try{var a=e[i](c),p=a.value}catch(e){n(e);return}a.done?t(p):Promise.resolve(p).then(o,r)}var w=function(){var e=(0,r.useActionContext)().setVisible;return{run:function(){var t;return(t=function(){return function(e,t){var n,o,r,i,c={label:0,sent:function(){if(1&r[0])throw r[1];return r[1]},trys:[],ops:[]};return i={next:a(0),throw:a(1),return:a(2)},"function"==typeof Symbol&&(i[Symbol.iterator]=function(){return this}),i;function a(i){return function(a){var p=[i,a];if(n)throw TypeError("Generator is already executing.");for(;c;)try{if(n=1,o&&(r=2&p[0]?o.return:p[0]?o.throw||((r=o.return)&&r.call(o),0):o.next)&&!(r=r.call(o,p[1])).done)return r;switch(o=0,r&&(p=[2&p[0],r.value]),p[0]){case 0:case 1:r=p;break;case 4:return c.label++,{value:p[1],done:!1};case 5:c.label++,o=p[1],p=[0];continue;case 7:p=c.ops.pop(),c.trys.pop();continue;default:if(!(r=(r=c.trys).length>0&&r[r.length-1])&&(6===p[0]||2===p[0])){c=0;continue}if(3===p[0]&&(!r||p[1]>r[0]&&p[1]<r[3])){c.label=p[1];break}if(6===p[0]&&c.label<r[1]){c.label=r[1],r=p;break}if(r&&c.label<r[2]){c.label=r[2],c.ops.push(p);break}r[2]&&c.ops.pop(),c.trys.pop();continue}p=t.call(e,c)}catch(e){p=[6,e],o=0}finally{n=r=0}if(5&p[0])throw p[1];return{value:p[0]?p[1]:void 0,done:!0}}}}(this,function(t){return e(!1),[2]})},function(){var e=this,n=arguments;return new Promise(function(o,r){var i=t.apply(e,n);function c(e){P(i,o,r,c,a,"next",e)}function a(e){P(i,o,r,c,a,"throw",e)}c(void 0)})})()}}},A=function(){var e,t=(0,s.oG)().t,n=(e=(0,c.useState)(!1),function(e){if(Array.isArray(e))return e}(e)||function(e,t){var n,o,r=null==e?null:"undefined"!=typeof Symbol&&e[Symbol.iterator]||e["@@iterator"];if(null!=r){var i=[],c=!0,a=!1;try{for(r=r.call(e);!(c=(n=r.next()).done)&&(i.push(n.value),i.length!==t);c=!0);}catch(e){a=!0,o=e}finally{try{c||null==r.return||r.return()}finally{if(a)throw o}}return i}}(e,2)||function(e,t){if(e){if("string"==typeof e)return C(e,2);var n=Object.prototype.toString.call(e).slice(8,-1);if("Object"===n&&e.constructor&&(n=e.constructor.name),"Map"===n||"Set"===n)return Array.from(n);if("Arguments"===n||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n))return C(e,t)}}(e,2)||function(){throw TypeError("Invalid attempt to destructure non-iterable instance.\\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()),p=n[0],l=n[1],d=(0,u.tZ)(),y=d.NotificationTypeNameProvider,f=(d.name,d.setName),x=(0,r.useAPIClient)(),h=(0,u.CZ)().filter(function(e){var t;return(null==(t=e.meta)?void 0:t.creatable)!==!1}),g=0===h.length?[{key:"__empty__",label:a().createElement(i.Empty,{image:i.Empty.PRESENTED_IMAGE_SIMPLE,description:a().createElement(a().Fragment,null,t("No channel enabled yet"),a().createElement("br",null)," ",a().createElement("a",{target:"_blank",href:"zh-CN"===x.auth.locale?"https://docs-cn.nocobase.com/handbook/notification-manager":"https://docs.nocobase.com/handbook/notification-manager",rel:"noreferrer"},t("View documentation")))})}]:h.map(function(e){return{key:e.type,label:e.title,onClick:function(){l(!0),f(e.type)}}});return a().createElement(r.ActionContextProvider,{value:{visible:p,setVisible:l}},a().createElement(y,null,a().createElement(i.Dropdown,{menu:{items:g}},a().createElement(i.Button,{icon:a().createElement(o.PlusOutlined,null),type:"primary"},t("Add new")," ",a().createElement(o.DownOutlined,null))),a().createElement(r.SchemaComponent,{scope:{useCloseAction:w,useCreateActionProps:m.cD,useEditActionProps:m.G8,useCloseActionProps:m.Uy,useEditFormProps:m.fC,useCreateFormProps:m.Uc},schema:b})))},O=function(){return(0,r.useAsyncData)().data,!1},S=function(){var e=(0,s.oG)().t,t=(0,m.aT)(),n=(0,r.useSchemaComponentContext)(),o=(0,c.useMemo)(function(){var e,t;return e=function(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{},o=Object.keys(n);"function"==typeof Object.getOwnPropertySymbols&&(o=o.concat(Object.getOwnPropertySymbols(n).filter(function(e){return Object.getOwnPropertyDescriptor(n,e).enumerable}))),o.forEach(function(t){var o;o=n[t],t in e?Object.defineProperty(e,t,{value:o,enumerable:!0,configurable:!0,writable:!0}):e[t]=o})}return e}({},n),t=t={designable:!1},Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):(function(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);n.push.apply(n,o)}return n})(Object(t)).forEach(function(n){Object.defineProperty(e,n,Object.getOwnPropertyDescriptor(t,n))}),e},[n]);return a().createElement(r.ExtendCollectionsProvider,{collections:[p.Z,l.Z]},a().createElement(r.SchemaComponentContext.Provider,{value:o},a().createElement(u.wi.Provider,{value:{channelTypes:t}},a().createElement(i.Card,{bordered:!1},a().createElement(r.SchemaComponent,{schema:h,components:{AddNew:A,ConfigForm:v},scope:{useCanNotDelete:O,t:e,notificationTypeOptions:t,useCreateActionProps:m.cD,useEditActionProps:m.G8,useCloseActionProps:m.Uy,useEditFormProps:m.fC,useCreateFormProps:m.Uc,useRecordDeleteActionProps:m.$l,useRecordEditActionProps:m.Bj}})))))};S.displayName="ChannelManager"},712:function(e,t,n){t.Z={name:n(296).O.channels,migrationRules:["overwrite","schema-only"],filterTargetKey:"name",autoGenId:!1,createdAt:!0,createdBy:!0,updatedAt:!0,updatedBy:!0,fields:[{name:"name",type:"uid",prefix:"s_",primaryKey:!0,interface:"input",uiSchema:{type:"string",title:'{{t("Channel name")}}',"x-component":"Input",required:!0,description:"{{t('Randomly generated and can not be modified. Support letters, numbers and underscores, must start with an letter.')}}"}},{name:"title",type:"string",interface:"input",uiSchema:{type:"string","x-component":"Input",title:'{{t("Channel display name")}}',required:!0}},{name:"options",type:"json",interface:"json",uiSchema:{type:"object","x-component":"ConfigForm"}},{name:"meta",type:"json",interface:"json"},{interface:"input",type:"string",name:"notificationType",uiSchema:{type:"string",title:'{{t("Notification type")}}',"x-component":"Select",enum:"{{notificationTypeOptions}}",required:!0}},{name:"description",type:"text",interface:"textarea",uiSchema:{type:"string","x-component":"Input.TextArea",title:'{{t("Description")}}'}}]}},807:function(e,t,n){t.Z={name:n(296).O.logs,migrationRules:["schema-only"],title:"MessageLogs",fields:[{name:"id",type:"uuid",primaryKey:!0,allowNull:!1,interface:"uuid",uiSchema:{type:"string",title:'{{t("ID")}}',"x-component":"Input","x-read-pretty":!0}},{name:"channelName",type:"string",interface:"input",uiSchema:{type:"string",title:'{{t("Channel name")}}',"x-component":"Input"}},{name:"channelTitle",type:"string",interface:"input",uiSchema:{type:"string","x-component":"Input",title:'{{t("Channel display name")}}'}},{name:"triggerFrom",type:"string",interface:"input",uiSchema:{type:"string","x-component":"Input",title:'{{t("Trigger from")}}'}},{name:"notificationType",type:"string",interface:"input",uiSchema:{type:"string",title:'{{t("Notification type")}}',"x-component":"Select",enum:"{{notificationTypeOptions}}",required:!0}},{name:"status",type:"string",interface:"select",uiSchema:{type:"string","x-component":"Select",enum:[{label:'{{t("Success")}}',value:"success",color:"green"},{label:'{{t("Failure")}}',value:"failure",color:"red"}],title:'{{t("Status")}}'}},{name:"message",type:"json",interface:"json",uiSchema:{"x-component":"Input.JSON",title:'{{t("Message")}}',"x-component-props":{autoSize:{minRows:5}},autoSize:{minRows:5}}},{name:"reason",type:"text",interface:"input",uiSchema:{type:"string","x-component":"Input",title:'{{t("Failed reason")}}'}},{name:"createdAt",type:"date",interface:"createdAt",field:"createdAt",uiSchema:{type:"datetime",title:'{{t("Created at")}}',"x-component":"DatePicker","x-component-props":{},"x-read-pretty":!0}},{name:"updatedAt",type:"date",interface:"updatedAt",field:"updatedAt",uiSchema:{type:"datetime",title:'{{t("Last updated at")}}',"x-component":"DatePicker","x-component-props":{},"x-read-pretty":!0}}]}}}]);