mirror of
https://gitee.com/nocobase/nocobase.git
synced 2025-05-05 05:29:26 +08:00
feat: notification manager and email channel notification (#4926)
* feat: init plugin * feat: core fix schema * feat: mail init plugin * feat: core change plugin name * feat: notificationType初步可以正常工作 * feat: 动态表单可以正常渲染 * feat: 修改notification type从form或record获取 * feat: 修复关联字段无法正常渲染问题 * fix: change node version * feat: delete useless code * feat: change Notification Sever to class * feat: change plugin name * feat: change plugin name * feat: add nodemailer * feat: change message name * feat: change field name * feat: temp change collection name * feat: 初步能加载所有messageLog, 筛选还不起作用 * feat: messageLog可以显示, 但是messageId还不显示 * feat: fix bugs * feat: fefactor message create form * feat: temp * feat: use mail config * feat: add plugin preset * feat: use array items * feat: fix message config bug * feat: use next yarn.lock * feat: change dependencies to devDependencies * feat: not improt name from package.json * fix: fix import error * fix: resolve confict in yarn.lock * feat: update messageLog to Log * feat: add workflow * feat: add variables support * feat: use raw textarea * feat: temp * feat: temp * chore: fix variable input null value bug. Add content custom form * feat: upgrade plugin * feat: upgrade plugin * feat: upgrade plugin * feat: remove channel options title * chore: fix some problem * feat: temp * feat: make field vertical * feat: make form vertical * feat: add locale support * feat: refactor notification server registration to use notificationManager * feat: add notification manager locales * chore: remove useless file * feat: update channel ID field type to string * refactor: add logs locale support * refactor: remove unused NotificationPluginStorer class * feat: update mail channel title localization * feat: register snippet for notification messages and allow sending messages for logged-in users * refactor: update mail server to write logs for successful and failed email deliveries * refactor: update mail server to write logs for successful and failed email deliveries * refactor: optimize notification sending process and add logging for successful and failed deliveries * refactor: update logger messages for notification delivery status * feat: add channel collection to LogManager component * refactor: update mail server to write logs for successful and failed email deliveries * refactor: change message send api access right * refactor: add id field to channel form schema and update channel collection UI * refactor: update messageLog collection to use UUID for primary key * refactor: update mail server to write logs for successful and failed email deliveries * refactor: update mail server configuration form schema and UI * refactor: update mail server configuration form schema and UI * refactor: update channel collection name and form schema * refactor: update mail server to write logs for successful and failed email deliveries * refactor: update NotificationInstruction to use options instead of res and error for job result * refactor: rename mail plugin package to use SMTP in the name * refactor: update mail plugin package name to include SMTP * refactor: update channel collection name and form schema * refactor: update channel collection name and form schema * refactor: update channel collection name and form schema * fix: filterTargetKey * refactor: update channel sort key * refactor: update channel collection name and form schema * refactor: update localization strings for email notifications * chore: add register type unit test * refactor: remove unused imports in registerType.test.ts * refactor: remove unused imports in NotificationInstruction.tsx * feat: add 'notification-manager' to the list of required plugins * refactor: update notification sending logic in NotificationInstruction.ts * feat: notification-core: add plugin context * feat: add receiverType field to MessageConfigForm * feat: add receiverType field to MessageConfigForm * feat: add receiverType field to MessageConfigForm * feat: refactor ReceiverConfigForm component structure * feat: add description to channel name field * feat: update channel schema with ellipsis for long values * feat: update channel schema with ellipsis for long values, use tablev2 and formv2 * refactor: improve workflow execute logs * feat: update channel schema with ellipsis for long values, use tablev2 and formv2 * feat: update channel schema with refresh and filter actions * feat: update nocobase presets with workflow notification and notification manager plugins * feat: remove unused channelId property from SendOptions interface * feat: update @nocobase/plugin-notification-manager dependency to version >=0.17.0-alpha.3 * feat: update package descriptions and display names for notification plugins * feat: update MessageConfigForm to use variableOptions for ReceiverInputComponent * chore: update plugin versions to 1.4.0-alpha * feat: update channel schema to include channelTitle property * feat: update notification manager plugin locale and form components * feat: update mail-server.ts to support sending emails to multiple receivers, cc, and bcc * feat: update channel manager component to handle empty channel types * feat: update channel manager component to handle empty channel types * feat: update channel manager component to handle empty channel types * feat: update rowKey fallback value in useTableBlockProps * feat: temp * refactor: update mail-server.ts and tsconfig.json * refactor: update mail-server.ts and tsconfig.json * refactor: update tsconfig.json to enable strictNullChecks and disallow JavaScript files feat: Add 'workflow-notification' plugin to the list of presets in server/index.ts * refactor: update localization files for channel display name and failed reason * chore: improve UI * refactor: update localization files for message * refactor: update delete action confirmation message * refactor: update constant for notification logs collection name * refactor: update channel schema for action buttons and delete confirmation * refactor: update provider name retrieval in MessageConfigForm * refactor: update localization files for message * refactor: update sendParams in NotificationInstruction * refactor: update channel type constant to 'smtp-mail' * refactor: remove unused code related to delete action in channel manager * refactor: remove unused code related to delete action in channel manager * refactor: update channel collection name constant * refactor: update log detail visibility condition * refactor: rename ContentConfigForm to MessageConfigForm * refactor: update register and send api * feat: update channel registerType function params * refactor: update channel type key in ConfigForm component (cherry picked from commit a00c75a8fb972938a22b959cfcd5cc8e9decfc21) * refactor: remove unused import in ConfigForm component * fix: improve code * refactor: fix channelTypes reference in PluginNotificationManagerClient * refactor: add permission for notificationChannels in PluginNotificationManagerServer * fix: improve code * fix: improve code * fix: improve code * fix: improve code * fix: improve code * fix: acl * fix: build error --------- Co-authored-by: chenos <chenlinxh@gmail.com>
This commit is contained in:
Sheldon Guo
GitHub
parent
49bbdc13f3
commit
ff116acc42
@ -136,6 +136,6 @@ export const useResourceContext = () => {
|
||||
resource,
|
||||
collection,
|
||||
association,
|
||||
targetKey: association?.targetKey || collection?.targetKey || 'id',
|
||||
targetKey: association?.targetKey || collection?.filterTargetKey || collection?.targetKey || 'id',
|
||||
};
|
||||
};
|
||||
|
||||
@ -844,5 +844,6 @@
|
||||
"The current dependency version of the plugin does not match the version of the application and may not work properly. Are you sure you want to continue enabling the plugin?": "The current dependency version of the plugin does not match the version of the application and may not work properly. Are you sure you want to continue enabling the plugin?",
|
||||
"Skip getting the total number of table records during paging to speed up loading. It is recommended to enable this option for data tables with a large amount of data": "Skip getting the total number of table records during paging to speed up loading. It is recommended to enable this option for data tables with a large amount of data",
|
||||
"Enable secondary confirmation": "Enable secondary confirmation",
|
||||
"Notification": "Notification",
|
||||
"Ellipsis overflow content": "Ellipsis overflow content"
|
||||
}
|
||||
|
||||
@ -902,6 +902,7 @@
|
||||
"Collections": "数据表",
|
||||
"Collection fields": "数据表字段",
|
||||
"Authentication": "用户认证",
|
||||
"Notification": "通知",
|
||||
"Logging and monitoring": "日志与监控",
|
||||
"Home page": "主页",
|
||||
"Handbook": "用户手册",
|
||||
|
||||
@ -55,7 +55,7 @@ export const useTableBlockProps = () => {
|
||||
loading: ctx?.service?.loading,
|
||||
showIndex: ctx.showIndex,
|
||||
dragSort: ctx.dragSort && ctx.dragSortBy,
|
||||
rowKey: ctx.rowKey || 'id',
|
||||
rowKey: ctx.rowKey || fieldSchema?.['x-component-props']?.rowKey || 'id',
|
||||
pagination: fieldSchema?.['x-component-props']?.pagination === false ? false : field.componentProps.pagination,
|
||||
onRowSelectionChange: useCallback((selectedRowKeys, selectedRowData) => {
|
||||
ctx.field.data = ctx?.field?.data || {};
|
||||
|
||||
@ -100,6 +100,7 @@ const LocalPlugins = () => {
|
||||
'Workflow',
|
||||
'Users & permissions',
|
||||
'Authentication',
|
||||
'Notification',
|
||||
'System management',
|
||||
'Logging and monitoring',
|
||||
'Others',
|
||||
|
||||
@ -1,4 +1,3 @@
|
||||
|
||||
import React from 'react';
|
||||
import { mockApp } from '@nocobase/client/demo-utils';
|
||||
import { SchemaComponent, Plugin, ISchema } from '@nocobase/client';
|
||||
@ -27,14 +26,15 @@ const schema: ISchema = {
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
};
|
||||
|
||||
const Demo = () => {
|
||||
return <SchemaComponent schema={schema} />;
|
||||
};
|
||||
|
||||
class DemoPlugin extends Plugin {
|
||||
async load() {
|
||||
this.app.router.add('root', { path: '/', Component: Demo })
|
||||
this.app.router.add('root', { path: '/', Component: Demo });
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@ -0,0 +1,2 @@
|
||||
/node_modules
|
||||
/src
|
||||
@ -0,0 +1 @@
|
||||
# @nocobase/plugin-notification-email
|
||||
2
packages/plugins/@nocobase/plugin-notification-email/client.d.ts
vendored
Normal file
2
packages/plugins/@nocobase/plugin-notification-email/client.d.ts
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
export * from './dist/client';
|
||||
export { default } from './dist/client';
|
||||
@ -0,0 +1 @@
|
||||
module.exports = require('./dist/client/index.js');
|
||||
@ -0,0 +1,22 @@
|
||||
{
|
||||
"name": "@nocobase/plugin-notification-email",
|
||||
"version": "1.4.0-alpha",
|
||||
"displayName": "Notification: Email",
|
||||
"displayName.zh-CN": "通知：电子邮件",
|
||||
"description": "Used for sending email notifications with built-in SMTP transport.",
|
||||
"description.zh-CN": "通过电子邮件渠道发送通知，目前只支持 SMTP 传输方式。",
|
||||
"main": "dist/server/index.js",
|
||||
"devDependencies": {
|
||||
"nodemailer": "^6.x",
|
||||
"@types/nodemailer": "^6.x"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@nocobase/client": "1.x",
|
||||
"@nocobase/plugin-notification-manager": "1.x",
|
||||
"@nocobase/server": "1.x",
|
||||
"@nocobase/test": "1.x"
|
||||
},
|
||||
"keywords": [
|
||||
"Notification"
|
||||
]
|
||||
}
|
||||
2
packages/plugins/@nocobase/plugin-notification-email/server.d.ts
vendored
Normal file
2
packages/plugins/@nocobase/plugin-notification-email/server.d.ts
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
export * from './dist/server';
|
||||
export { default } from './dist/server';
|
||||
@ -0,0 +1 @@
|
||||
module.exports = require('./dist/server/index.js');
|
||||
@ -0,0 +1,183 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { SchemaComponent } from '@nocobase/client';
|
||||
import React from 'react';
|
||||
import { useNotifyMailTranslation } from './hooks/useTranslation';
|
||||
export const ChannelConfigForm = () => {
|
||||
const { t } = useNotifyMailTranslation();
|
||||
return (
|
||||
<SchemaComponent
|
||||
scope={{ t }}
|
||||
schema={{
|
||||
type: 'object',
|
||||
properties: {
|
||||
transport: {
|
||||
'x-decorator': 'FormItem',
|
||||
type: 'string',
|
||||
title: '{{t("Transport")}}',
|
||||
'x-component': 'Select',
|
||||
enum: [{ value: 'smtp', label: 'SMTP' }],
|
||||
default: 'smtp',
|
||||
required: true,
|
||||
},
|
||||
server: {
|
||||
type: 'void',
|
||||
'x-component': 'Grid',
|
||||
properties: {
|
||||
row: {
|
||||
type: 'void',
|
||||
'x-component': 'Grid.Row',
|
||||
properties: {
|
||||
col1: {
|
||||
type: 'void',
|
||||
'x-component': 'Grid.Col',
|
||||
'x-component-props': {
|
||||
width: 50,
|
||||
},
|
||||
properties: {
|
||||
host: {
|
||||
'x-decorator': 'FormItem',
|
||||
type: 'string',
|
||||
title: '{{t("Host")}}',
|
||||
description: '{{t("SMTP server host")}}',
|
||||
'x-component': 'Input',
|
||||
'x-component-props': {
|
||||
placeholder: 'smtp.example.com',
|
||||
},
|
||||
required: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
col2: {
|
||||
type: 'void',
|
||||
'x-component': 'Grid.Col',
|
||||
'x-component-props': {
|
||||
width: 16,
|
||||
},
|
||||
properties: {
|
||||
port: {
|
||||
'x-decorator': 'FormItem',
|
||||
type: 'number',
|
||||
title: '{{t("Port")}}',
|
||||
'x-component': 'InputNumber',
|
||||
'x-component-props': {
|
||||
min: 1,
|
||||
max: 65535,
|
||||
step: 1,
|
||||
},
|
||||
default: 465,
|
||||
required: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
col3: {
|
||||
type: 'void',
|
||||
'x-component': 'Grid.Col',
|
||||
'x-component-props': {
|
||||
width: 16,
|
||||
},
|
||||
properties: {
|
||||
secure: {
|
||||
'x-decorator': 'FormItem',
|
||||
type: 'boolean',
|
||||
title: '{{t("Secure")}}',
|
||||
'x-component': 'Checkbox',
|
||||
default: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
auth: {
|
||||
type: 'void',
|
||||
'x-component': 'Grid',
|
||||
properties: {
|
||||
row1: {
|
||||
type: 'void',
|
||||
'x-component': 'Grid.Row',
|
||||
properties: {
|
||||
col1: {
|
||||
type: 'void',
|
||||
'x-component': 'Grid.Col',
|
||||
'x-component-props': {},
|
||||
properties: {
|
||||
account: {
|
||||
'x-decorator': 'FormItem',
|
||||
type: 'boolean',
|
||||
title: '{{t("Account")}}',
|
||||
'x-component': 'Input',
|
||||
'x-component-props': {
|
||||
placeholder: 'example@domain.com',
|
||||
},
|
||||
required: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
col2: {
|
||||
type: 'void',
|
||||
'x-component': 'Grid.Col',
|
||||
'x-component-props': {},
|
||||
properties: {
|
||||
password: {
|
||||
'x-decorator': 'FormItem',
|
||||
type: 'boolean',
|
||||
title: '{{t("Password")}}',
|
||||
'x-component': 'Password',
|
||||
required: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
row2: {
|
||||
type: 'void',
|
||||
'x-component': 'Grid.Row',
|
||||
properties: {
|
||||
col1: {
|
||||
type: 'void',
|
||||
'x-component': 'Grid.Col',
|
||||
'x-component-props': {
|
||||
width: 50,
|
||||
flex: 'none',
|
||||
},
|
||||
properties: {
|
||||
from: {
|
||||
type: 'string',
|
||||
required: true,
|
||||
title: `{{t("From")}}`,
|
||||
description: `{{t("The email address that will be used as the sender")}}`,
|
||||
'x-decorator': 'FormItem',
|
||||
'x-component': 'Input',
|
||||
'x-component-props': {
|
||||
// useTypedConstant: ['string'],
|
||||
placeholder: `noreply <example@domain.com>`,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
col2: {
|
||||
type: 'void',
|
||||
'x-component': 'Grid.Col',
|
||||
'x-component-props': {
|
||||
width: 50,
|
||||
flex: 'none',
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
}}
|
||||
/>
|
||||
);
|
||||
};
|
||||
@ -0,0 +1,228 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import React from 'react';
|
||||
import { SchemaComponent, css } from '@nocobase/client';
|
||||
import { useNotifyMailTranslation } from './hooks/useTranslation';
|
||||
const emailsClass = css`
|
||||
width: 100%;
|
||||
|
||||
.ant-space-item:nth-child(2) {
|
||||
flex-grow: 1;
|
||||
}
|
||||
`;
|
||||
export const MessageConfigForm = ({ variableOptions }) => {
|
||||
const { t } = useNotifyMailTranslation();
|
||||
return (
|
||||
<SchemaComponent
|
||||
scope={{ t }}
|
||||
schema={{
|
||||
type: 'void',
|
||||
properties: {
|
||||
to: {
|
||||
type: 'array',
|
||||
required: true,
|
||||
title: `{{t("To")}}`,
|
||||
'x-decorator': 'FormItem',
|
||||
'x-component': 'ArrayItems',
|
||||
items: {
|
||||
type: 'void',
|
||||
'x-component': 'Space',
|
||||
'x-component-props': {
|
||||
className: emailsClass,
|
||||
},
|
||||
properties: {
|
||||
sort: {
|
||||
type: 'void',
|
||||
'x-decorator': 'FormItem',
|
||||
'x-component': 'ArrayItems.SortHandle',
|
||||
},
|
||||
input: {
|
||||
type: 'string',
|
||||
'x-decorator': 'FormItem',
|
||||
'x-component': 'Variable.Input',
|
||||
'x-component-props': {
|
||||
scope: variableOptions,
|
||||
useTypedConstant: ['string'],
|
||||
placeholder: `{{t("Email address")}}`,
|
||||
},
|
||||
},
|
||||
remove: {
|
||||
type: 'void',
|
||||
'x-decorator': 'FormItem',
|
||||
'x-component': 'ArrayItems.Remove',
|
||||
},
|
||||
},
|
||||
},
|
||||
properties: {
|
||||
add: {
|
||||
type: 'void',
|
||||
title: `{{t("Add email address")}}`,
|
||||
'x-component': 'ArrayItems.Addition',
|
||||
},
|
||||
},
|
||||
},
|
||||
cc: {
|
||||
type: 'array',
|
||||
title: `{{t("CC")}}`,
|
||||
'x-decorator': 'FormItem',
|
||||
'x-component': 'ArrayItems',
|
||||
items: {
|
||||
type: 'void',
|
||||
'x-component': 'Space',
|
||||
'x-component-props': {
|
||||
className: emailsClass,
|
||||
},
|
||||
properties: {
|
||||
sort: {
|
||||
type: 'void',
|
||||
'x-decorator': 'FormItem',
|
||||
'x-component': 'ArrayItems.SortHandle',
|
||||
},
|
||||
input: {
|
||||
type: 'string',
|
||||
'x-decorator': 'FormItem',
|
||||
'x-component': 'Variable.Input',
|
||||
'x-component-props': {
|
||||
scope: variableOptions,
|
||||
useTypedConstant: ['string'],
|
||||
placeholder: `{{t("Email address")}}`,
|
||||
},
|
||||
},
|
||||
remove: {
|
||||
type: 'void',
|
||||
'x-decorator': 'FormItem',
|
||||
'x-component': 'ArrayItems.Remove',
|
||||
},
|
||||
},
|
||||
},
|
||||
properties: {
|
||||
add: {
|
||||
type: 'void',
|
||||
title: `{{t("Add email address")}}`,
|
||||
'x-component': 'ArrayItems.Addition',
|
||||
},
|
||||
},
|
||||
},
|
||||
bcc: {
|
||||
type: 'array',
|
||||
title: `{{t("BCC")}}`,
|
||||
'x-decorator': 'FormItem',
|
||||
'x-component': 'ArrayItems',
|
||||
items: {
|
||||
type: 'void',
|
||||
'x-component': 'Space',
|
||||
'x-component-props': {
|
||||
className: emailsClass,
|
||||
},
|
||||
properties: {
|
||||
sort: {
|
||||
type: 'void',
|
||||
'x-decorator': 'FormItem',
|
||||
'x-component': 'ArrayItems.SortHandle',
|
||||
},
|
||||
input: {
|
||||
type: 'string',
|
||||
'x-decorator': 'FormItem',
|
||||
'x-component': 'Variable.Input',
|
||||
'x-component-props': {
|
||||
scope: variableOptions,
|
||||
useTypedConstant: ['string'],
|
||||
placeholder: `{{t("Email address")}}`,
|
||||
},
|
||||
},
|
||||
remove: {
|
||||
type: 'void',
|
||||
'x-decorator': 'FormItem',
|
||||
'x-component': 'ArrayItems.Remove',
|
||||
},
|
||||
},
|
||||
},
|
||||
properties: {
|
||||
add: {
|
||||
type: 'void',
|
||||
title: `{{t("Add email address")}}`,
|
||||
'x-component': 'ArrayItems.Addition',
|
||||
},
|
||||
},
|
||||
},
|
||||
subject: {
|
||||
type: 'string',
|
||||
required: true,
|
||||
title: `{{t("Subject")}}`,
|
||||
'x-decorator': 'FormItem',
|
||||
'x-component': 'Variable.TextArea',
|
||||
'x-component-props': {
|
||||
scope: variableOptions,
|
||||
},
|
||||
},
|
||||
contentType: {
|
||||
type: 'string',
|
||||
title: `{{t("Content type")}}`,
|
||||
'x-decorator': 'FormItem',
|
||||
'x-component': 'Radio.Group',
|
||||
enum: [
|
||||
{ label: 'HTML', value: 'html' },
|
||||
{ label: `{{t("Plain text")}}`, value: 'text' },
|
||||
],
|
||||
default: 'html',
|
||||
},
|
||||
html: {
|
||||
type: 'string',
|
||||
required: true,
|
||||
title: `{{t("Content")}}`,
|
||||
'x-decorator': 'FormItem',
|
||||
'x-component': 'Variable.RawTextArea',
|
||||
'x-component-props': {
|
||||
scope: variableOptions,
|
||||
placeholder: 'Hi,',
|
||||
autoSize: {
|
||||
minRows: 10,
|
||||
},
|
||||
},
|
||||
'x-reactions': [
|
||||
{
|
||||
dependencies: ['contentType'],
|
||||
fulfill: {
|
||||
state: {
|
||||
visible: '{{$deps[0] === "html"}}',
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
text: {
|
||||
type: 'string',
|
||||
required: true,
|
||||
title: `{{t("Content")}}`,
|
||||
'x-decorator': 'FormItem',
|
||||
'x-component': 'Variable.RawTextArea',
|
||||
'x-component-props': {
|
||||
scope: variableOptions,
|
||||
placeholder: 'Hi,',
|
||||
autoSize: {
|
||||
minRows: 10,
|
||||
},
|
||||
},
|
||||
'x-reactions': [
|
||||
{
|
||||
dependencies: ['contentType'],
|
||||
fulfill: {
|
||||
state: {
|
||||
visible: '{{$deps[0] === "text"}}',
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
}}
|
||||
/>
|
||||
);
|
||||
};
|
||||
249
packages/plugins/@nocobase/plugin-notification-email/src/client/client.d.ts
vendored
Normal file
249
packages/plugins/@nocobase/plugin-notification-email/src/client/client.d.ts
vendored
Normal file
@ -0,0 +1,249 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
// CSS modules
|
||||
type CSSModuleClasses = { readonly [key: string]: string };
|
||||
|
||||
declare module '*.module.css' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
declare module '*.module.scss' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
declare module '*.module.sass' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
declare module '*.module.less' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
declare module '*.module.styl' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
declare module '*.module.stylus' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
declare module '*.module.pcss' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
declare module '*.module.sss' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
|
||||
// CSS
|
||||
declare module '*.css' { }
|
||||
declare module '*.scss' { }
|
||||
declare module '*.sass' { }
|
||||
declare module '*.less' { }
|
||||
declare module '*.styl' { }
|
||||
declare module '*.stylus' { }
|
||||
declare module '*.pcss' { }
|
||||
declare module '*.sss' { }
|
||||
|
||||
// Built-in asset types
|
||||
// see `src/node/constants.ts`
|
||||
|
||||
// images
|
||||
declare module '*.apng' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.png' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.jpg' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.jpeg' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.jfif' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.pjpeg' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.pjp' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.gif' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.svg' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.ico' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.webp' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.avif' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
|
||||
// media
|
||||
declare module '*.mp4' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.webm' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.ogg' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.mp3' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.wav' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.flac' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.aac' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.opus' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.mov' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.m4a' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.vtt' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
|
||||
// fonts
|
||||
declare module '*.woff' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.woff2' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.eot' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.ttf' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.otf' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
|
||||
// other
|
||||
declare module '*.webmanifest' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.pdf' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.txt' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
|
||||
// wasm?init
|
||||
declare module '*.wasm?init' {
|
||||
const initWasm: (options?: WebAssembly.Imports) => Promise<WebAssembly.Instance>;
|
||||
export default initWasm;
|
||||
}
|
||||
|
||||
// web worker
|
||||
declare module '*?worker' {
|
||||
const workerConstructor: {
|
||||
new(options?: { name?: string }): Worker;
|
||||
};
|
||||
export default workerConstructor;
|
||||
}
|
||||
|
||||
declare module '*?worker&inline' {
|
||||
const workerConstructor: {
|
||||
new(options?: { name?: string }): Worker;
|
||||
};
|
||||
export default workerConstructor;
|
||||
}
|
||||
|
||||
declare module '*?worker&url' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
|
||||
declare module '*?sharedworker' {
|
||||
const sharedWorkerConstructor: {
|
||||
new(options?: { name?: string }): SharedWorker;
|
||||
};
|
||||
export default sharedWorkerConstructor;
|
||||
}
|
||||
|
||||
declare module '*?sharedworker&inline' {
|
||||
const sharedWorkerConstructor: {
|
||||
new(options?: { name?: string }): SharedWorker;
|
||||
};
|
||||
export default sharedWorkerConstructor;
|
||||
}
|
||||
|
||||
declare module '*?sharedworker&url' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
|
||||
declare module '*?raw' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
|
||||
declare module '*?url' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
|
||||
declare module '*?inline' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
@ -0,0 +1,17 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { NAMESPACE } from '../../constant';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
|
||||
export function useNotifyMailTranslation() {
|
||||
return useTranslation([NAMESPACE, 'client'], {
|
||||
nsMode: 'fallback',
|
||||
});
|
||||
}
|
||||
@ -0,0 +1,33 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { Plugin } from '@nocobase/client';
|
||||
import PluginNotificationManagerClient from '@nocobase/plugin-notification-manager/client';
|
||||
import { tval } from '@nocobase/utils/client';
|
||||
import { channelType, NAMESPACE } from '../constant';
|
||||
import { ChannelConfigForm } from './ConfigForm';
|
||||
import { MessageConfigForm } from './MessageConfigForm';
|
||||
export class PluginNotificationMailClient extends Plugin {
|
||||
async afterAdd() {}
|
||||
|
||||
async beforeLoad() {}
|
||||
async load() {
|
||||
const notification = this.pm.get(PluginNotificationManagerClient);
|
||||
notification.registerChannelType({
|
||||
title: tval('Email', { ns: NAMESPACE }),
|
||||
type: channelType,
|
||||
components: {
|
||||
ChannelConfigForm: ChannelConfigForm,
|
||||
MessageConfigForm: MessageConfigForm,
|
||||
},
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
export default PluginNotificationMailClient;
|
||||
@ -0,0 +1,11 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
export const channelType = 'email';
|
||||
export const NAMESPACE = '@nocobase/plugin-notification-email';
|
||||
@ -0,0 +1,11 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
export * from './server';
|
||||
export { default } from './server';
|
||||
@ -0,0 +1,22 @@
|
||||
{
|
||||
"Email": "Email",
|
||||
"From": "From",
|
||||
"To": "To",
|
||||
"CC": "CC",
|
||||
"BCC": "BCC",
|
||||
"Add email address": "Add email address",
|
||||
"Subject": "Subject",
|
||||
"Content": "Content",
|
||||
"Host": "Host",
|
||||
"Port": "Port",
|
||||
"Secure": "Secure",
|
||||
"Account": "Account",
|
||||
"Password" : "Password",
|
||||
"Configure": "Configure",
|
||||
"The email address that will be used as the sender": "The email address that will be used as the sender",
|
||||
"SMTP mail": "SMTP mail",
|
||||
"SMTP server host": "SMTP server host",
|
||||
"Content type": "Content type",
|
||||
"Plain text": "Plain text",
|
||||
"Transport": "Transport"
|
||||
}
|
||||
@ -0,0 +1,22 @@
|
||||
{
|
||||
"Email": "邮件",
|
||||
"From": "发件人",
|
||||
"To": "收件人",
|
||||
"CC": "抄送",
|
||||
"BCC": "密送",
|
||||
"Add email address": "新增邮件地址",
|
||||
"Subject": "主题",
|
||||
"Content": "内容",
|
||||
"Host": "主机",
|
||||
"Port": "端口",
|
||||
"Secure": "安全模式",
|
||||
"Account": "账号",
|
||||
"Password" : "密码",
|
||||
"Configure": "编辑",
|
||||
"The email address that will be used as the sender": "发件人邮件地址",
|
||||
"SMTP mail": "SMTP 邮件",
|
||||
"SMTP server host": "SMTP 服务器主机",
|
||||
"Content type": "内容格式",
|
||||
"Plain text": "纯文本",
|
||||
"Transport": "传输方式"
|
||||
}
|
||||
@ -0,0 +1,10 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
export { default } from './plugin';
|
||||
@ -0,0 +1,70 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { BaseNotificationChannel } from '@nocobase/plugin-notification-manager';
|
||||
import * as nodemailer from 'nodemailer';
|
||||
import { Transporter } from 'nodemailer';
|
||||
type Message = {
|
||||
to: string[];
|
||||
cc?: string[];
|
||||
bcc?: string[];
|
||||
subject: string;
|
||||
} & (
|
||||
| {
|
||||
contentType: 'html';
|
||||
html: string;
|
||||
}
|
||||
| {
|
||||
contentType: 'text';
|
||||
text: string;
|
||||
}
|
||||
);
|
||||
|
||||
export class MailNotificationChannel extends BaseNotificationChannel {
|
||||
transpoter: Transporter;
|
||||
async send(args): Promise<any> {
|
||||
const { message, channel } = args;
|
||||
const { host, port, secure, account, password, from } = channel.options;
|
||||
try {
|
||||
const transpoter: Transporter = nodemailer.createTransport({
|
||||
host,
|
||||
port,
|
||||
secure,
|
||||
auth: {
|
||||
user: account,
|
||||
pass: password,
|
||||
},
|
||||
});
|
||||
const { subject, cc, bcc, to, contentType } = message;
|
||||
const payload = {
|
||||
to: to.map((item) => item?.trim()).filter(Boolean),
|
||||
cc: cc
|
||||
? cc
|
||||
.flat()
|
||||
.map((item) => item?.trim())
|
||||
.filter(Boolean)
|
||||
: undefined,
|
||||
bcc: bcc
|
||||
? bcc
|
||||
.flat()
|
||||
.map((item) => item?.trim())
|
||||
.filter(Boolean)
|
||||
: undefined,
|
||||
subject,
|
||||
from,
|
||||
...(contentType === 'html' ? { html: message.html } : { text: message.text }),
|
||||
};
|
||||
|
||||
const result = await transpoter.sendMail(payload);
|
||||
return { status: 'success', message };
|
||||
} catch (error) {
|
||||
throw { status: 'failure', reason: error.message, message };
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,34 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import PluginNotificationManagerServer from '@nocobase/plugin-notification-manager';
|
||||
import { Plugin } from '@nocobase/server';
|
||||
import { channelType } from '../constant';
|
||||
import { MailNotificationChannel } from './mail-server';
|
||||
|
||||
export class PluginNotificationsMailServer extends Plugin {
|
||||
async afterAdd() {}
|
||||
|
||||
async beforeLoad() {}
|
||||
|
||||
async load() {
|
||||
const notificationServer = this.pm.get(PluginNotificationManagerServer) as PluginNotificationManagerServer;
|
||||
notificationServer.registerChannelType({ type: channelType, Channel: MailNotificationChannel });
|
||||
}
|
||||
|
||||
async install() {}
|
||||
|
||||
async afterEnable() {}
|
||||
|
||||
async afterDisable() {}
|
||||
|
||||
async remove() {}
|
||||
}
|
||||
|
||||
export default PluginNotificationsMailServer;
|
||||
@ -0,0 +1,7 @@
|
||||
{
|
||||
"extends": ["../../../../tsconfig.json"],
|
||||
"compilerOptions": {
|
||||
"strictNullChecks": true,
|
||||
"allowJs": false
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,2 @@
|
||||
/node_modules
|
||||
/src
|
||||
@ -0,0 +1 @@
|
||||
# @nocobase/plugin-notification-core
|
||||
2
packages/plugins/@nocobase/plugin-notification-manager/client.d.ts
vendored
Normal file
2
packages/plugins/@nocobase/plugin-notification-manager/client.d.ts
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
export * from './dist/client';
|
||||
export { default } from './dist/client';
|
||||
@ -0,0 +1 @@
|
||||
module.exports = require('./dist/client/index.js');
|
||||
@ -0,0 +1,34 @@
|
||||
{
|
||||
"name": "@nocobase/plugin-notification-manager",
|
||||
"displayName": "Notification manager",
|
||||
"description": "Provides a unified management service that includes channel configuration, logging, and other features, supporting the configuration of various notification channels, including in-app message and email.",
|
||||
"displayName.zh-CN": "通知管理",
|
||||
"description.zh-CN": "提供统一的管理服务，涵盖渠道配置、日志记录等功能，支持多种通知渠道的配置，包括站内信和电子邮件等。",
|
||||
"version": "1.4.0-alpha",
|
||||
"main": "dist/server/index.js",
|
||||
"dependencies": {
|
||||
},
|
||||
"devDependencies": {
|
||||
"@ant-design/icons": "5.x",
|
||||
"@formily/antd-v5": "^1.x",
|
||||
"@formily/react": "2.x",
|
||||
"@formily/shared": "2.x",
|
||||
"@types/cron": "^2.0.1",
|
||||
"antd": "5.x",
|
||||
"cron": "^2.3.1",
|
||||
"react": "^18.2.0",
|
||||
"react-i18next": "^11.15.1"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@nocobase/actions": "1.x",
|
||||
"@nocobase/client": "1.x",
|
||||
"@nocobase/database": "1.x",
|
||||
"@nocobase/server": "1.x",
|
||||
"@nocobase/test": "1.x",
|
||||
"@nocobase/utils": "1.x",
|
||||
"@nocobase/plugin-workflow": ">=0.17.0-alpha.3"
|
||||
},
|
||||
"keywords": [
|
||||
"Notification"
|
||||
]
|
||||
}
|
||||
2
packages/plugins/@nocobase/plugin-notification-manager/server.d.ts
vendored
Normal file
2
packages/plugins/@nocobase/plugin-notification-manager/server.d.ts
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
export * from './dist/server';
|
||||
export { default } from './dist/server';
|
||||
@ -0,0 +1 @@
|
||||
module.exports = require('./dist/server/index.js');
|
||||
@ -0,0 +1,30 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import React, { useMemo } from 'react';
|
||||
import { Card, Table, Space } from 'antd';
|
||||
import { useAPIClient, useRequest } from '@nocobase/client';
|
||||
import { COLLECTION_NAME } from '../constant';
|
||||
|
||||
export function ManagementList() {
|
||||
const apiClient = useAPIClient();
|
||||
const resource = useMemo(() => {
|
||||
return apiClient.resource(COLLECTION_NAME.channels);
|
||||
}, [apiClient]);
|
||||
const { data, loading } = useRequest(resource.list);
|
||||
console.log('data', data);
|
||||
return (
|
||||
<div>
|
||||
<Card bordered={false}>
|
||||
<Space style={{ float: 'right', marginBottom: 16 }}></Space>
|
||||
<Table></Table>
|
||||
</Card>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@ -0,0 +1,32 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
import NotificationManager from '../notification-manager';
|
||||
|
||||
describe('registerType', () => {
|
||||
let plugin: NotificationManager;
|
||||
beforeEach(() => {
|
||||
plugin = new NotificationManager();
|
||||
});
|
||||
|
||||
it('should register a new type', () => {
|
||||
const ChannelConfigForm = () => null;
|
||||
const MessageConfigForm = () => null;
|
||||
const newChannelType = {
|
||||
type: 'newType',
|
||||
title: 'New Type',
|
||||
components: {
|
||||
ChannelConfigForm,
|
||||
MessageConfigForm,
|
||||
},
|
||||
};
|
||||
|
||||
plugin.registerChannelType(newChannelType);
|
||||
expect(plugin.channelTypes.get('newType')).toEqual(newChannelType);
|
||||
});
|
||||
});
|
||||
249
packages/plugins/@nocobase/plugin-notification-manager/src/client/client.d.ts
vendored
Normal file
249
packages/plugins/@nocobase/plugin-notification-manager/src/client/client.d.ts
vendored
Normal file
@ -0,0 +1,249 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
// CSS modules
|
||||
type CSSModuleClasses = { readonly [key: string]: string };
|
||||
|
||||
declare module '*.module.css' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
declare module '*.module.scss' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
declare module '*.module.sass' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
declare module '*.module.less' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
declare module '*.module.styl' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
declare module '*.module.stylus' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
declare module '*.module.pcss' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
declare module '*.module.sss' {
|
||||
const classes: CSSModuleClasses;
|
||||
export default classes;
|
||||
}
|
||||
|
||||
// CSS
|
||||
declare module '*.css' { }
|
||||
declare module '*.scss' { }
|
||||
declare module '*.sass' { }
|
||||
declare module '*.less' { }
|
||||
declare module '*.styl' { }
|
||||
declare module '*.stylus' { }
|
||||
declare module '*.pcss' { }
|
||||
declare module '*.sss' { }
|
||||
|
||||
// Built-in asset types
|
||||
// see `src/node/constants.ts`
|
||||
|
||||
// images
|
||||
declare module '*.apng' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.png' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.jpg' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.jpeg' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.jfif' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.pjpeg' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.pjp' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.gif' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.svg' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.ico' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.webp' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.avif' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
|
||||
// media
|
||||
declare module '*.mp4' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.webm' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.ogg' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.mp3' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.wav' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.flac' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.aac' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.opus' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.mov' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.m4a' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.vtt' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
|
||||
// fonts
|
||||
declare module '*.woff' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.woff2' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.eot' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.ttf' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.otf' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
|
||||
// other
|
||||
declare module '*.webmanifest' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.pdf' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
declare module '*.txt' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
|
||||
// wasm?init
|
||||
declare module '*.wasm?init' {
|
||||
const initWasm: (options?: WebAssembly.Imports) => Promise<WebAssembly.Instance>;
|
||||
export default initWasm;
|
||||
}
|
||||
|
||||
// web worker
|
||||
declare module '*?worker' {
|
||||
const workerConstructor: {
|
||||
new(options?: { name?: string }): Worker;
|
||||
};
|
||||
export default workerConstructor;
|
||||
}
|
||||
|
||||
declare module '*?worker&inline' {
|
||||
const workerConstructor: {
|
||||
new(options?: { name?: string }): Worker;
|
||||
};
|
||||
export default workerConstructor;
|
||||
}
|
||||
|
||||
declare module '*?worker&url' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
|
||||
declare module '*?sharedworker' {
|
||||
const sharedWorkerConstructor: {
|
||||
new(options?: { name?: string }): SharedWorker;
|
||||
};
|
||||
export default sharedWorkerConstructor;
|
||||
}
|
||||
|
||||
declare module '*?sharedworker&inline' {
|
||||
const sharedWorkerConstructor: {
|
||||
new(options?: { name?: string }): SharedWorker;
|
||||
};
|
||||
export default sharedWorkerConstructor;
|
||||
}
|
||||
|
||||
declare module '*?sharedworker&url' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
|
||||
declare module '*?raw' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
|
||||
declare module '*?url' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
|
||||
declare module '*?inline' {
|
||||
const src: string;
|
||||
export default src;
|
||||
}
|
||||
@ -0,0 +1,34 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { Schema } from '@formily/react';
|
||||
import { usePlugin } from '@nocobase/client';
|
||||
import { createContext } from 'react';
|
||||
import PluginNotificationManagerClient from '..';
|
||||
import { useNotificationTranslation } from '../locale';
|
||||
import { RegisterChannelOptions } from '../manager/channel/types';
|
||||
|
||||
export const ChannelTypeMapContext = createContext<{
|
||||
typeMap: Record<string, RegisterChannelOptions>;
|
||||
}>({ typeMap: {} });
|
||||
ChannelTypeMapContext.displayName = 'ChannelTypesContext';
|
||||
|
||||
export const useChannelTypeMap = () => {
|
||||
const { t } = useNotificationTranslation();
|
||||
const plugin = usePlugin(PluginNotificationManagerClient);
|
||||
const notificationTypeMap: Record<string, RegisterChannelOptions> = {};
|
||||
for (const [key, val] of plugin.channelTypes.getEntities()) {
|
||||
const type = {
|
||||
...val,
|
||||
title: Schema.compile(val.title, { t }) as string,
|
||||
};
|
||||
notificationTypeMap[val.type] = type;
|
||||
}
|
||||
return notificationTypeMap;
|
||||
};
|
||||
@ -0,0 +1,88 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import React, { createContext, useContext, useMemo } from 'react';
|
||||
import {
|
||||
ActionProps,
|
||||
useActionContext,
|
||||
useCollection,
|
||||
useCollectionRecordData,
|
||||
useDataBlockRequest,
|
||||
useDataBlockResource,
|
||||
} from '@nocobase/client';
|
||||
import { App as AntdApp } from 'antd';
|
||||
import { createForm } from '@formily/core';
|
||||
import { useForm } from '@formily/react';
|
||||
|
||||
export { ChannelTypeMapContext, useChannelTypeMap } from './channel';
|
||||
|
||||
export const useSubmitActionProps = () => {
|
||||
const { setVisible } = useActionContext();
|
||||
const { message } = AntdApp.useApp();
|
||||
const form = useForm();
|
||||
const resource = useDataBlockResource();
|
||||
const { runAsync } = useDataBlockRequest();
|
||||
const collection = useCollection();
|
||||
return {
|
||||
type: 'primary',
|
||||
async onClick() {
|
||||
await form.submit();
|
||||
const values = form.values;
|
||||
if (values[collection.filterTargetKey]) {
|
||||
await resource.update({
|
||||
values,
|
||||
filterByTk: values[collection.filterTargetKey],
|
||||
});
|
||||
} else {
|
||||
await resource.create({
|
||||
values,
|
||||
});
|
||||
}
|
||||
await runAsync();
|
||||
message.success('Saved successfully!');
|
||||
setVisible(false);
|
||||
},
|
||||
};
|
||||
};
|
||||
|
||||
export const useEditFormProps = () => {
|
||||
const recordData = useCollectionRecordData();
|
||||
const form = useMemo(
|
||||
() =>
|
||||
createForm({
|
||||
initialValues: recordData,
|
||||
}),
|
||||
[],
|
||||
);
|
||||
|
||||
return {
|
||||
form,
|
||||
};
|
||||
};
|
||||
|
||||
export const useCloseActionProps = () => {
|
||||
const { setVisible } = useActionContext();
|
||||
return {
|
||||
type: 'default',
|
||||
onClick() {
|
||||
setVisible(false);
|
||||
},
|
||||
};
|
||||
};
|
||||
|
||||
export const NotificationVariableContext = createContext([]);
|
||||
|
||||
export const useNotificationVariableOptions = () => {
|
||||
const scope = useContext(NotificationVariableContext);
|
||||
return { scope };
|
||||
};
|
||||
|
||||
export const NotificationVariableProvider = ({ value, children }) => {
|
||||
return <NotificationVariableContext.Provider value={value}>{children}</NotificationVariableContext.Provider>;
|
||||
};
|
||||
@ -0,0 +1,59 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { Plugin } from '@nocobase/client';
|
||||
import { lang as t } from './locale';
|
||||
import { ChannelManager } from './manager/channel/components';
|
||||
import { RegisterChannelOptions } from './manager/channel/types';
|
||||
import { LogManager } from './manager/log/components/Manager';
|
||||
import NotificationManager from './notification-manager';
|
||||
|
||||
const NAMESPACE = 'notification-manager';
|
||||
export class PluginNotificationManagerClient extends Plugin {
|
||||
private manager: NotificationManager;
|
||||
|
||||
get channelTypes() {
|
||||
return this.manager.channelTypes;
|
||||
}
|
||||
|
||||
registerChannelType(options: RegisterChannelOptions) {
|
||||
this.manager.registerChannelType(options);
|
||||
}
|
||||
|
||||
async afterAdd() {}
|
||||
|
||||
async beforeLoad() {
|
||||
this.manager = new NotificationManager();
|
||||
}
|
||||
|
||||
// You can get and modify the app instance here
|
||||
async load() {
|
||||
this.app.pluginSettingsManager.add(NAMESPACE, {
|
||||
title: t('Notification manager'),
|
||||
icon: 'NotificationOutlined',
|
||||
aclSnippet: 'pm.notification',
|
||||
});
|
||||
this.app.pluginSettingsManager.add(`${NAMESPACE}.channels`, {
|
||||
title: t('Channels'),
|
||||
Component: ChannelManager,
|
||||
aclSnippet: 'pm.notification.channels',
|
||||
sort: 1,
|
||||
});
|
||||
this.app.pluginSettingsManager.add(`${NAMESPACE}.logs`, {
|
||||
title: t('Logs'),
|
||||
Component: LogManager,
|
||||
aclSnippet: 'pm.notification.logs',
|
||||
sort: 3,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
export { NotificationVariableContext, NotificationVariableProvider, useNotificationVariableOptions } from './hooks';
|
||||
export { MessageConfigForm } from './manager/message/components/MessageConfigForm';
|
||||
export default PluginNotificationManagerClient;
|
||||
@ -0,0 +1,27 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { i18n } from '@nocobase/client';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
|
||||
export const NAMESPACE = '@nocobase/plugin-notification-manager';
|
||||
|
||||
export function lang(key: string) {
|
||||
return i18n.t(key, { ns: NAMESPACE });
|
||||
}
|
||||
|
||||
export function generateNTemplate(key: string) {
|
||||
return `{{t('${key}', { ns: '${NAMESPACE}', nsMode: 'fallback' })}}`;
|
||||
}
|
||||
|
||||
export function useNotificationTranslation() {
|
||||
return useTranslation([NAMESPACE,'client', 'data-source-manager'], {
|
||||
nsMode: 'fallback',
|
||||
});
|
||||
}
|
||||
@ -0,0 +1,25 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { observer, useForm } from '@formily/react';
|
||||
import { useCollectionRecord } from '@nocobase/client';
|
||||
import React, { useContext } from 'react';
|
||||
import { NotificationTypesContext } from '../context';
|
||||
|
||||
export const ConfigForm = observer(
|
||||
() => {
|
||||
const form = useForm();
|
||||
const record = useCollectionRecord<Record<string, any>>();
|
||||
const notificationType = form.values.notificationType || record?.data?.notificationType;
|
||||
const { channelTypes } = useContext(NotificationTypesContext);
|
||||
const channel = channelTypes.find((channelType) => channelType.type === notificationType);
|
||||
return channel.components?.ChannelConfigForm ? <channel.components.ChannelConfigForm /> : null;
|
||||
},
|
||||
{ displayName: 'ConfigForm' },
|
||||
);
|
||||
@ -0,0 +1,151 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { DownOutlined, PlusOutlined } from '@ant-design/icons';
|
||||
import {
|
||||
ActionContextProvider,
|
||||
ExtendCollectionsProvider,
|
||||
SchemaComponent,
|
||||
SchemaComponentContext,
|
||||
useAPIClient,
|
||||
useActionContext,
|
||||
useAsyncData,
|
||||
useSchemaComponentContext,
|
||||
} from '@nocobase/client';
|
||||
import { Button, Dropdown, Empty } from 'antd';
|
||||
import React, { useState } from 'react';
|
||||
import channelCollection from '../../../../collections/channel';
|
||||
import messageLogCollection from '../../../../collections/messageLog';
|
||||
import { useNotificationTranslation } from '../../../locale';
|
||||
import { NotificationTypesContext, useChannelTypes, useNotificationTypeNameProvider } from '../context';
|
||||
import {
|
||||
useCloseActionProps,
|
||||
useCreateActionProps,
|
||||
useCreateFormProps,
|
||||
useEditActionProps,
|
||||
useEditFormProps,
|
||||
useNotificationTypes,
|
||||
} from '../hooks';
|
||||
import { channelsSchema, createFormSchema } from '../schemas';
|
||||
import { ConfigForm } from './ConfigForm';
|
||||
const useCloseAction = () => {
|
||||
const { setVisible } = useActionContext();
|
||||
return {
|
||||
async run() {
|
||||
setVisible(false);
|
||||
},
|
||||
};
|
||||
};
|
||||
|
||||
const AddNew = () => {
|
||||
const { t } = useNotificationTranslation();
|
||||
const [visible, setVisible] = useState(false);
|
||||
const { NotificationTypeNameProvider, name, setName } = useNotificationTypeNameProvider();
|
||||
const api = useAPIClient();
|
||||
const channelTypes = useChannelTypes();
|
||||
const items =
|
||||
channelTypes.length === 0
|
||||
? [
|
||||
{
|
||||
key: '__empty__',
|
||||
label: (
|
||||
<Empty
|
||||
image={Empty.PRESENTED_IMAGE_SIMPLE}
|
||||
description={
|
||||
<>
|
||||
{t('No channel enabled yet')}
|
||||
<br />{' '}
|
||||
<a
|
||||
target="_blank"
|
||||
href={
|
||||
api.auth.locale === 'zh-CN'
|
||||
? 'https://docs-cn.nocobase.com/handbook/notification-manager'
|
||||
: 'https://docs.nocobase.com/handbook/notification-manager'
|
||||
}
|
||||
rel="noreferrer"
|
||||
>
|
||||
{t('View documentation')}
|
||||
</a>
|
||||
</>
|
||||
}
|
||||
/>
|
||||
),
|
||||
},
|
||||
]
|
||||
: channelTypes.map((item) => ({
|
||||
key: item.type,
|
||||
label: item.title,
|
||||
onClick: () => {
|
||||
setVisible(true);
|
||||
setName(item.type);
|
||||
},
|
||||
}));
|
||||
|
||||
return (
|
||||
<ActionContextProvider value={{ visible, setVisible }}>
|
||||
<NotificationTypeNameProvider>
|
||||
<Dropdown menu={{ items }}>
|
||||
<Button icon={<PlusOutlined />} type={'primary'}>
|
||||
{t('Add new')} <DownOutlined />
|
||||
</Button>
|
||||
</Dropdown>
|
||||
<SchemaComponent
|
||||
scope={{
|
||||
useCloseAction,
|
||||
useCreateActionProps,
|
||||
useEditActionProps,
|
||||
useCloseActionProps,
|
||||
useEditFormProps,
|
||||
useCreateFormProps,
|
||||
}}
|
||||
schema={createFormSchema}
|
||||
// components={{ ConfigForm: getConfigForm(typeName) }}
|
||||
/>
|
||||
</NotificationTypeNameProvider>
|
||||
</ActionContextProvider>
|
||||
);
|
||||
};
|
||||
|
||||
// Disable delete button when there is only one authenticator
|
||||
const useCanNotDelete = () => {
|
||||
const { data } = useAsyncData();
|
||||
// return data?.meta?.count === 1;
|
||||
return false;
|
||||
};
|
||||
|
||||
export const ChannelManager = () => {
|
||||
const { t } = useNotificationTranslation();
|
||||
const notificationTypes = useNotificationTypes();
|
||||
const scCtx = useSchemaComponentContext();
|
||||
|
||||
return (
|
||||
<ExtendCollectionsProvider collections={[channelCollection, messageLogCollection]}>
|
||||
<SchemaComponentContext.Provider value={{ ...scCtx, designable: false }}>
|
||||
<NotificationTypesContext.Provider value={{ channelTypes: notificationTypes }}>
|
||||
<SchemaComponent
|
||||
schema={channelsSchema}
|
||||
components={{ AddNew, ConfigForm }}
|
||||
scope={{
|
||||
useCanNotDelete,
|
||||
t,
|
||||
notificationTypeOptions: notificationTypes,
|
||||
useCreateActionProps,
|
||||
useEditActionProps,
|
||||
useCloseActionProps,
|
||||
useEditFormProps,
|
||||
useCreateFormProps,
|
||||
}}
|
||||
/>
|
||||
</NotificationTypesContext.Provider>
|
||||
</SchemaComponentContext.Provider>
|
||||
</ExtendCollectionsProvider>
|
||||
);
|
||||
};
|
||||
|
||||
ChannelManager.displayName = 'ChannelManager';
|
||||
@ -0,0 +1,34 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import React, { createContext, useContext, useState } from 'react';
|
||||
import { RegisterChannelOptions } from './types';
|
||||
export const NotificationTypeNameContext = createContext<{
|
||||
name: string;
|
||||
setName: (name: string) => void;
|
||||
}>({ name: '', setName: () => {} });
|
||||
NotificationTypeNameContext.displayName = 'ChannelTypeContext';
|
||||
|
||||
export const NotificationTypesContext = createContext<{
|
||||
channelTypes: Array<RegisterChannelOptions>;
|
||||
}>({ channelTypes: [] });
|
||||
NotificationTypesContext.displayName = 'ChannelTypesContext';
|
||||
|
||||
export const useChannelTypes = () => {
|
||||
const { channelTypes: types } = useContext(NotificationTypesContext);
|
||||
return types;
|
||||
};
|
||||
|
||||
export function useNotificationTypeNameProvider() {
|
||||
const [name, setName] = useState('');
|
||||
const NotificationTypeNameProvider = ({ children }) => (
|
||||
<NotificationTypeNameContext.Provider value={{ name, setName }}>{children}</NotificationTypeNameContext.Provider>
|
||||
);
|
||||
return { name, setName, NotificationTypeNameProvider };
|
||||
}
|
||||
@ -0,0 +1,201 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { createForm } from '@formily/core';
|
||||
import { Schema, useForm } from '@formily/react';
|
||||
import { uid } from '@formily/shared';
|
||||
import {
|
||||
ActionProps,
|
||||
useActionContext,
|
||||
useBlockRequestContext,
|
||||
useCollection,
|
||||
useCollectionRecordData,
|
||||
useDataBlockRequest,
|
||||
useDataBlockResource,
|
||||
usePlugin,
|
||||
} from '@nocobase/client';
|
||||
import { App as AntdApp } from 'antd';
|
||||
import React, { createContext, useContext, useMemo } from 'react';
|
||||
import { PluginNotificationManagerClient } from '../..';
|
||||
import { useNotificationTranslation } from '../../locale';
|
||||
import { NotificationTypeNameContext } from './context';
|
||||
import { RegisterChannelOptions } from './types';
|
||||
|
||||
export const useCreateActionProps = () => {
|
||||
const { setVisible, setSubmitted } = useActionContext();
|
||||
const { message } = AntdApp.useApp();
|
||||
const form = useForm();
|
||||
const resource = useDataBlockResource();
|
||||
const { service } = useBlockRequestContext();
|
||||
const collection = useCollection();
|
||||
return {
|
||||
type: 'primary',
|
||||
async onClick(e?, callBack?) {
|
||||
await form.submit();
|
||||
const values = form.values;
|
||||
await resource.create({
|
||||
values,
|
||||
});
|
||||
const { count = 0, page = 0, pageSize = 0 } = service?.data?.meta || {};
|
||||
if (count % pageSize === 1 && page !== 1) {
|
||||
service.run({
|
||||
...service?.params?.[0],
|
||||
page: page - 1,
|
||||
});
|
||||
}
|
||||
if (callBack) {
|
||||
callBack?.();
|
||||
}
|
||||
setSubmitted?.(true);
|
||||
setVisible?.(false);
|
||||
},
|
||||
};
|
||||
};
|
||||
|
||||
export const useEditActionProps = () => {
|
||||
const { setVisible, setSubmitted } = useActionContext();
|
||||
const { message } = AntdApp.useApp();
|
||||
const form = useForm();
|
||||
const resource = useDataBlockResource();
|
||||
const { service } = useBlockRequestContext();
|
||||
const collection = useCollection();
|
||||
return {
|
||||
type: 'primary',
|
||||
async onClick(e?, callBack?) {
|
||||
await form.submit();
|
||||
const values = form.values;
|
||||
await resource.update({
|
||||
values,
|
||||
filterByTk: values[collection.filterTargetKey],
|
||||
});
|
||||
const { count = 0, page = 0, pageSize = 0 } = service?.data?.meta || {};
|
||||
if (count % pageSize === 1 && page !== 1) {
|
||||
service.run({
|
||||
...service?.params?.[0],
|
||||
page: page - 1,
|
||||
});
|
||||
}
|
||||
if (callBack) {
|
||||
callBack?.();
|
||||
}
|
||||
setSubmitted?.(true);
|
||||
setVisible?.(false);
|
||||
},
|
||||
};
|
||||
};
|
||||
|
||||
export const useEditFormProps = () => {
|
||||
const recordData = useCollectionRecordData();
|
||||
const form = useMemo(
|
||||
() =>
|
||||
createForm({
|
||||
initialValues: recordData,
|
||||
}),
|
||||
[],
|
||||
);
|
||||
|
||||
return {
|
||||
form,
|
||||
};
|
||||
};
|
||||
|
||||
export const useCreateFormProps = () => {
|
||||
const ctx = useActionContext();
|
||||
const { name } = useContext(NotificationTypeNameContext);
|
||||
const form = useMemo(
|
||||
() =>
|
||||
createForm({
|
||||
values: {
|
||||
name: `s_${uid()}`,
|
||||
notificationType: name,
|
||||
},
|
||||
}),
|
||||
[name],
|
||||
);
|
||||
|
||||
return {
|
||||
form,
|
||||
};
|
||||
};
|
||||
export const useCloseActionProps = () => {
|
||||
const { setVisible } = useActionContext();
|
||||
return {
|
||||
type: 'default',
|
||||
onClick() {
|
||||
setVisible(false);
|
||||
},
|
||||
};
|
||||
};
|
||||
|
||||
export function useDeleteActionProps(): ActionProps {
|
||||
const { t } = useNotificationTranslation();
|
||||
const { message } = AntdApp.useApp();
|
||||
const record = useCollectionRecordData();
|
||||
const resource = useDataBlockResource();
|
||||
const { runAsync } = useDataBlockRequest();
|
||||
const collection = useCollection();
|
||||
return {
|
||||
confirm: {
|
||||
title: t('Delete'),
|
||||
content: t('Are you sure you want to delete it?'),
|
||||
},
|
||||
async onClick() {
|
||||
await resource.destroy({
|
||||
filterByTk: record[collection.filterTargetKey],
|
||||
});
|
||||
await runAsync();
|
||||
message.success(t('Deleted successfully!'));
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
export const NotificationVariableContext = createContext([]);
|
||||
|
||||
export const useNotificationVariableOptions = () => {
|
||||
const scope = useContext(NotificationVariableContext);
|
||||
return { scope };
|
||||
};
|
||||
|
||||
export const NotificationVariableProvider = ({ value, children }) => {
|
||||
return <NotificationVariableContext.Provider value={value}>{children}</NotificationVariableContext.Provider>;
|
||||
};
|
||||
|
||||
export const useNotificationTypes = () => {
|
||||
const { t } = useNotificationTranslation();
|
||||
const plugin = usePlugin(PluginNotificationManagerClient);
|
||||
const notificationTypes: Array<RegisterChannelOptions> = [];
|
||||
for (const [key, val] of plugin.channelTypes.getEntities()) {
|
||||
const title = Schema.compile(val.title, { t }) as string;
|
||||
const type = {
|
||||
...val,
|
||||
name: val.type,
|
||||
key: val.type,
|
||||
value: val.type,
|
||||
title,
|
||||
label: title,
|
||||
};
|
||||
notificationTypes.push(type);
|
||||
}
|
||||
return notificationTypes;
|
||||
};
|
||||
|
||||
export const useIsEditable = () => {
|
||||
const recordData = useCollectionRecordData();
|
||||
const form = useMemo(
|
||||
() =>
|
||||
createForm({
|
||||
initialValues: recordData,
|
||||
}),
|
||||
[],
|
||||
);
|
||||
|
||||
return {
|
||||
form,
|
||||
};
|
||||
};
|
||||
@ -0,0 +1,45 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
export const formProperties = {
|
||||
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',
|
||||
},
|
||||
};
|
||||
|
||||
export const updateFormProperties = {
|
||||
name: {
|
||||
'x-component': 'CollectionField',
|
||||
'x-decorator': 'FormItem',
|
||||
'x-disabled': true,
|
||||
},
|
||||
title: {
|
||||
'x-component': 'CollectionField',
|
||||
'x-decorator': 'FormItem',
|
||||
},
|
||||
description: {
|
||||
'x-component': 'CollectionField',
|
||||
'x-decorator': 'FormItem',
|
||||
},
|
||||
options: {
|
||||
'x-component': 'CollectionField',
|
||||
},
|
||||
};
|
||||
@ -0,0 +1,228 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { ISchema } from '@formily/react';
|
||||
import { uid } from '@formily/shared';
|
||||
import { COLLECTION_NAME } from '../../../../constant';
|
||||
import { formProperties, updateFormProperties } from './form';
|
||||
|
||||
export const createFormSchema: ISchema = {
|
||||
type: 'object',
|
||||
properties: {
|
||||
drawer: {
|
||||
type: 'void',
|
||||
'x-component': 'Action.Drawer',
|
||||
'x-decorator': 'FormV2',
|
||||
'x-use-decorator-props': 'useCreateFormProps',
|
||||
title: '{{t("Add new")}}',
|
||||
properties: {
|
||||
...formProperties,
|
||||
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',
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
export const channelsSchema: ISchema = {
|
||||
type: 'void',
|
||||
name: uid(),
|
||||
'x-decorator': 'TableBlockProvider',
|
||||
'x-decorator-props': {
|
||||
collection: COLLECTION_NAME.channels,
|
||||
action: 'list',
|
||||
dragSort: false,
|
||||
params: {
|
||||
sort: ['createdAt'],
|
||||
pageSize: 20,
|
||||
},
|
||||
},
|
||||
'x-component': 'CardItem',
|
||||
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")}}',
|
||||
properties: {
|
||||
title: {
|
||||
type: 'string',
|
||||
'x-component': 'CollectionField',
|
||||
'x-read-pretty': true,
|
||||
'x-component-props': {
|
||||
ellipsis: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
name: {
|
||||
type: 'void',
|
||||
'x-component': 'TableV2.Column',
|
||||
title: '{{t("Channel name")}}',
|
||||
properties: {
|
||||
name: {
|
||||
type: 'string',
|
||||
'x-component': 'CollectionField',
|
||||
'x-read-pretty': true,
|
||||
'x-component-props': {
|
||||
ellipsis: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
description: {
|
||||
type: 'void',
|
||||
'x-component': 'TableV2.Column',
|
||||
title: '{{t("Description")}}',
|
||||
properties: {
|
||||
description: {
|
||||
type: 'boolean',
|
||||
'x-component': 'CollectionField',
|
||||
'x-read-pretty': true,
|
||||
'x-component-props': {
|
||||
ellipsis: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
notificationType: {
|
||||
title: '{{t("Notification type")}}',
|
||||
type: 'void',
|
||||
'x-component': 'TableV2.Column',
|
||||
properties: {
|
||||
notificationType: {
|
||||
type: 'string',
|
||||
'x-component': 'CollectionField',
|
||||
'x-read-pretty': true,
|
||||
},
|
||||
},
|
||||
},
|
||||
actions: {
|
||||
type: 'void',
|
||||
title: '{{t("Actions")}}',
|
||||
'x-component': 'TableV2.Column',
|
||||
'x-decorator': 'TableV2.Column.ActionBar',
|
||||
properties: {
|
||||
edit: {
|
||||
type: 'void',
|
||||
title: 'Edit',
|
||||
'x-component': 'Action.Link',
|
||||
'x-component-props': {
|
||||
openMode: 'drawer',
|
||||
icon: 'EditOutlined',
|
||||
},
|
||||
'x-decorator': 'Space',
|
||||
properties: {
|
||||
drawer: {
|
||||
type: 'void',
|
||||
title: '{{t("Edit")}}',
|
||||
'x-component': 'Action.Drawer',
|
||||
'x-decorator': 'FormV2',
|
||||
'x-use-decorator-props': 'useEditFormProps',
|
||||
properties: {
|
||||
...updateFormProperties,
|
||||
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': 'useDestroyActionProps',
|
||||
'x-component-props': {
|
||||
confirm: {
|
||||
title: "{{t('Delete record')}}",
|
||||
content: "{{t('Are you sure you want to delete it?')}}",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
@ -0,0 +1,28 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { Registry } from '@nocobase/utils/client';
|
||||
import { ComponentType } from 'react';
|
||||
|
||||
export type RegisterChannelOptions = {
|
||||
title: string;
|
||||
type: string;
|
||||
components: {
|
||||
ChannelConfigForm: ComponentType;
|
||||
MessageConfigForm?: ComponentType<{ variableOptions: any }>;
|
||||
};
|
||||
meta?: {
|
||||
creatable?: boolean;
|
||||
eidtable?: boolean;
|
||||
deletable?: boolean;
|
||||
};
|
||||
};
|
||||
|
||||
export type ChannelTypes = Registry<RegisterChannelOptions>;
|
||||
export type NotificationType = 'mail' | 'SMS' | 'in-app';
|
||||
@ -0,0 +1,38 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import React from 'react';
|
||||
import { Card } from 'antd';
|
||||
import { messageLogsManagerSchema } from '../schemas';
|
||||
import { SchemaComponent, SchemaComponentContext, useSchemaComponentContext } from '@nocobase/client';
|
||||
import { ExtendCollectionsProvider } from '@nocobase/client';
|
||||
import { useNotificationTranslation } from '../../../locale';
|
||||
import messageLogCollection from '../../../../collections/messageLog';
|
||||
import channelCollection from '../../../../collections/channel';
|
||||
import { useEditFormProps, useNotificationTypes } from '../../channel/hooks';
|
||||
|
||||
export const LogManager = () => {
|
||||
const { t } = useNotificationTranslation();
|
||||
const scCtx = useSchemaComponentContext();
|
||||
const notificationTypes = useNotificationTypes();
|
||||
return (
|
||||
<ExtendCollectionsProvider collections={[messageLogCollection, channelCollection]}>
|
||||
<SchemaComponentContext.Provider value={{ ...scCtx, designable: false }}>
|
||||
<Card bordered={false}>
|
||||
<SchemaComponent
|
||||
schema={messageLogsManagerSchema}
|
||||
scope={{ t, useEditFormProps, notificationTypeOptions: notificationTypes }}
|
||||
/>
|
||||
</Card>
|
||||
</SchemaComponentContext.Provider>
|
||||
</ExtendCollectionsProvider>
|
||||
);
|
||||
};
|
||||
|
||||
LogManager.displayName = 'LogManager';
|
||||
@ -0,0 +1,8 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
@ -0,0 +1,9 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
@ -0,0 +1,291 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { ISchema } from '@formily/react';
|
||||
import collection from '../../../../collections/messageLog';
|
||||
import { COLLECTION_NAME } from '../../../../constant';
|
||||
|
||||
export const detailFromProperties = {
|
||||
id: {
|
||||
'x-component': 'CollectionField',
|
||||
'x-decorator': 'FormItem',
|
||||
'x-disabled': true,
|
||||
'x-read-pretty': true,
|
||||
},
|
||||
channelName: {
|
||||
'x-component': 'CollectionField',
|
||||
'x-decorator': 'FormItem',
|
||||
'x-read-pretty': true,
|
||||
},
|
||||
channelTitle: {
|
||||
'x-component': 'CollectionField',
|
||||
'x-decorator': 'FormItem',
|
||||
'x-read-pretty': true,
|
||||
},
|
||||
notificationType: {
|
||||
'x-component': 'CollectionField',
|
||||
'x-decorator': 'FormItem',
|
||||
'x-read-pretty': true,
|
||||
},
|
||||
triggerFrom: {
|
||||
'x-component': 'CollectionField',
|
||||
'x-decorator': 'FormItem',
|
||||
'x-read-pretty': true,
|
||||
},
|
||||
status: {
|
||||
'x-component': 'CollectionField',
|
||||
'x-decorator': 'FormItem',
|
||||
'x-read-pretty': true,
|
||||
},
|
||||
message: {
|
||||
'x-component': 'CollectionField',
|
||||
'x-decorator': 'FormItem',
|
||||
'x-read-pretty': true,
|
||||
},
|
||||
reason: {
|
||||
'x-component': 'CollectionField',
|
||||
'x-decorator': 'FormItem',
|
||||
'x-read-pretty': true,
|
||||
'x-reactions': [
|
||||
{
|
||||
dependencies: ['status'],
|
||||
fulfill: {
|
||||
state: {
|
||||
visible: '{{$deps[0] === "failure"}}',
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
createdAt: {
|
||||
'x-component': 'CollectionField',
|
||||
'x-decorator': 'FormItem',
|
||||
'x-read-pretty': true,
|
||||
'x-component-props': {
|
||||
dateFormat: 'YYYY-MM-DD',
|
||||
showTime: true,
|
||||
timeFormat: 'HH:mm:ss',
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
export const messageLogsManagerSchema: ISchema = {
|
||||
type: 'void',
|
||||
'x-uid': 't8tkmt2b9dd',
|
||||
name: COLLECTION_NAME.logs,
|
||||
'x-decorator': 'TableBlockProvider',
|
||||
'x-decorator-props': {
|
||||
collection: collection.name,
|
||||
action: 'list',
|
||||
params: {
|
||||
sort: ['-createdAt'],
|
||||
},
|
||||
showIndex: true,
|
||||
dragSort: false,
|
||||
},
|
||||
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: true,
|
||||
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': true,
|
||||
'x-component-props': {
|
||||
ellipsis: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
// channelName: {
|
||||
// type: 'void',
|
||||
// 'x-component': 'TableV2.Column',
|
||||
// 'x-component-props': {
|
||||
// width: 100,
|
||||
// },
|
||||
// title: '{{t("Channel name")}}',
|
||||
// properties: {
|
||||
// channelName: {
|
||||
// type: 'string',
|
||||
// 'x-component': 'CollectionField',
|
||||
// 'x-read-pretty': true,
|
||||
// 'x-component-props': {
|
||||
// ellipsis: true,
|
||||
// },
|
||||
// },
|
||||
// },
|
||||
// },
|
||||
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': true,
|
||||
'x-component-props': {
|
||||
ellipsis: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
notificationType: {
|
||||
title: '{{t("Notification type")}}',
|
||||
type: 'void',
|
||||
'x-component': 'TableV2.Column',
|
||||
properties: {
|
||||
notificationType: {
|
||||
type: 'string',
|
||||
'x-component': 'CollectionField',
|
||||
'x-read-pretty': true,
|
||||
},
|
||||
},
|
||||
},
|
||||
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': true,
|
||||
'x-component-props': {
|
||||
ellipsis: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
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',
|
||||
icon: 'EditOutlined',
|
||||
},
|
||||
properties: {
|
||||
drawer: {
|
||||
type: 'void',
|
||||
title: '{{t("Log detail")}}',
|
||||
'x-component': 'Action.Drawer',
|
||||
properties: {
|
||||
detail: {
|
||||
type: 'void',
|
||||
'x-component': 'FormV2',
|
||||
'x-use-component-props': 'useEditFormProps',
|
||||
properties: {
|
||||
...detailFromProperties,
|
||||
footer: {
|
||||
type: 'void',
|
||||
'x-component': 'Action.Drawer.Footer',
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
@ -0,0 +1,28 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
export enum MessageFieldNames {
|
||||
templateType = 'templateType',
|
||||
content = 'content',
|
||||
}
|
||||
|
||||
export enum MessageScopeNames {
|
||||
ChannelOptions = 'channelOptions',
|
||||
useSendAction = 'useSendAction',
|
||||
}
|
||||
|
||||
export enum MessageComponentNames {
|
||||
AddNew = 'AddNew',
|
||||
ReceiverConfigForm = 'ReceiverConfigForm',
|
||||
MessageInput = 'MessageInput',
|
||||
}
|
||||
|
||||
export enum MessageActionNames {
|
||||
useSendAction = 'useSendAction',
|
||||
}
|
||||
@ -0,0 +1,49 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { Card } from 'antd';
|
||||
import { messageManagerSchema } from '../schemas';
|
||||
import {
|
||||
SchemaComponent,
|
||||
SchemaComponentContext,
|
||||
useSchemaComponentContext,
|
||||
ExtendCollectionsProvider,
|
||||
} from '@nocobase/client';
|
||||
import React from 'react';
|
||||
import { useNotificationTranslation } from '../../../locale';
|
||||
import channelCollection from '../../../../collections/channel';
|
||||
import messageLogCollection from '../../../../collections/messageLog';
|
||||
import { MessageComponentNames, MessageScopeNames } from '../types';
|
||||
import MessageInput from './MessageInput';
|
||||
import { LogManager } from '../../log/components/Manager';
|
||||
import { useSendAction } from './useSendAction';
|
||||
import { useSubmitActionProps, useEditFormProps } from '../../../hooks';
|
||||
|
||||
export const MessageManager = () => {
|
||||
const { t } = useNotificationTranslation();
|
||||
const scCtx = useSchemaComponentContext();
|
||||
return (
|
||||
<ExtendCollectionsProvider collections={[channelCollection, messageLogCollection]}>
|
||||
<SchemaComponentContext.Provider value={{ ...scCtx, designable: false }}>
|
||||
<Card bordered={false}>
|
||||
<SchemaComponent
|
||||
schema={messageManagerSchema}
|
||||
scope={{ t, [MessageScopeNames.useSendAction]: useSendAction, useSubmitActionProps, useEditFormProps }}
|
||||
components={{
|
||||
[MessageComponentNames.MessageInput]: MessageInput,
|
||||
[MessageComponentNames.MessageLogManager]: LogManager,
|
||||
}}
|
||||
/>
|
||||
</Card>
|
||||
</SchemaComponentContext.Provider>
|
||||
</ExtendCollectionsProvider>
|
||||
);
|
||||
};
|
||||
|
||||
MessageManager.displayName = 'MessageManager';
|
||||
@ -0,0 +1,105 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import React, { useState, useContext, useEffect } from 'react';
|
||||
import { ArrayItems } from '@formily/antd-v5';
|
||||
import { SchemaComponent, css } from '@nocobase/client';
|
||||
import { onFieldValueChange } from '@formily/core';
|
||||
import { observer, useField, useForm, useFormEffects } from '@formily/react';
|
||||
|
||||
import { useAPIClient, Variable } from '@nocobase/client';
|
||||
import { useChannelTypeMap } from '../../../../hooks';
|
||||
import { useNotificationTranslation } from '../../../../locale';
|
||||
import { COLLECTION_NAME } from '../../../../../constant';
|
||||
import { UsersAddition } from '../ReceiverConfigForm/Users/UsersAddition';
|
||||
import { UsersSelect } from '../ReceiverConfigForm/Users/Select';
|
||||
export const MessageConfigForm = observer<{ variableOptions: any }>(
|
||||
({ variableOptions }) => {
|
||||
const field = useField();
|
||||
const form = useForm();
|
||||
const { channelName, receiverType } = field.form.values;
|
||||
const [providerName, setProviderName] = useState(null);
|
||||
const { t } = useNotificationTranslation();
|
||||
const api = useAPIClient();
|
||||
useEffect(() => {
|
||||
const onChannelChange = async () => {
|
||||
if (!channelName) {
|
||||
setProviderName(null);
|
||||
return;
|
||||
}
|
||||
const { data } = await api.request({
|
||||
url: `/${COLLECTION_NAME.channels}:get`,
|
||||
method: 'get',
|
||||
params: {
|
||||
filterByTk: channelName,
|
||||
},
|
||||
});
|
||||
setProviderName(data?.data?.notificationType);
|
||||
};
|
||||
onChannelChange();
|
||||
}, [channelName, api]);
|
||||
|
||||
useFormEffects(() => {
|
||||
onFieldValueChange('receiverType', (value) => {
|
||||
field.form.values.receivers = [];
|
||||
});
|
||||
});
|
||||
|
||||
// useEffect(() => {
|
||||
// field.form.values.receivers = [];
|
||||
// }, [field.form.values, receiverType]);
|
||||
const providerMap = useChannelTypeMap();
|
||||
const { MessageConfigForm = () => null } = (providerName ? providerMap[providerName] : {}).components || {};
|
||||
|
||||
const ReceiverInputComponent = receiverType === 'user' ? 'UsersSelect' : 'VariableInput';
|
||||
const ReceiverAddition = receiverType === 'user' ? UsersAddition : ArrayItems.Addition;
|
||||
const createMessageFormSchema = {
|
||||
type: 'void',
|
||||
properties: {
|
||||
channelName: {
|
||||
type: 'string',
|
||||
title: '{{t("Channel")}}',
|
||||
required: true,
|
||||
'x-decorator': 'FormItem',
|
||||
'x-component': 'RemoteSelect',
|
||||
'x-component-props': {
|
||||
multiple: false,
|
||||
manual: false,
|
||||
fieldNames: {
|
||||
label: 'title',
|
||||
value: 'name',
|
||||
},
|
||||
service: {
|
||||
resource: COLLECTION_NAME.channels,
|
||||
action: 'list',
|
||||
},
|
||||
style: {
|
||||
width: '100%',
|
||||
},
|
||||
},
|
||||
},
|
||||
message: {
|
||||
type: 'void',
|
||||
'x-component': 'MessageConfigForm',
|
||||
'x-component-props': {
|
||||
variableOptions,
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
return (
|
||||
<SchemaComponent
|
||||
schema={createMessageFormSchema}
|
||||
components={{ MessageConfigForm, ReceiverAddition, UsersSelect, ArrayItems, VariableInput: Variable.Input }}
|
||||
scope={{ t }}
|
||||
/>
|
||||
);
|
||||
},
|
||||
{ displayName: 'MessageConfigForm' },
|
||||
);
|
||||
@ -0,0 +1,71 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import React, { useState, useRef, useCallback, useEffect } from 'react';
|
||||
import { Input } from 'antd';
|
||||
import type { TextAreaRef } from 'antd/es/input/TextArea';
|
||||
import { Variable, useVariableOptions, useDatetimeVariable } from '@nocobase/client';
|
||||
import { ObjectField, useField, Field, observer } from '@formily/react';
|
||||
import { ObjectField as ObjectFieldType } from '@formily/core';
|
||||
|
||||
const MessageInput = observer(
|
||||
() => {
|
||||
const inputRef = useRef<TextAreaRef>(null);
|
||||
const [curPos, setCurPos] = useState(null);
|
||||
|
||||
const field = useField<ObjectFieldType>();
|
||||
// useEffect(() => {
|
||||
// const inputEle = inputRef?.current?.resizableTextArea?.textArea;
|
||||
// if (curPos && inputEle) {
|
||||
// inputEle.setSelectionRange(curPos, curPos);
|
||||
// }
|
||||
// }, [curPos]);
|
||||
|
||||
const { datetimeSettings } = useDatetimeVariable({ noDisabled: true });
|
||||
// const onInsert = useCallback(
|
||||
// function (paths: string[]) {
|
||||
// const variable: string[] = paths.filter((key) => Boolean(key.trim()));
|
||||
// const { current } = inputRef;
|
||||
// const inputEle = current?.resizableTextArea?.textArea;
|
||||
// if (!inputEle || !variable) {
|
||||
// return;
|
||||
// }
|
||||
// current.focus();
|
||||
// const templateVar = `{{${paths.join('.')}}}`;
|
||||
// const startPos = inputEle.selectionStart || 0;
|
||||
// const newVal = value.substring(0, startPos) + templateVar + value.substring(startPos, value.length);
|
||||
// const newPos = startPos + templateVar.length;
|
||||
// setValue(newVal);
|
||||
// setCurPos(newPos);
|
||||
// },
|
||||
// [value],
|
||||
// );
|
||||
|
||||
return (
|
||||
<div style={{ position: 'relative', paddingTop: '20px' }}>
|
||||
<Field
|
||||
name={'body'}
|
||||
component={[
|
||||
Variable.TextArea,
|
||||
{ scope: [datetimeSettings], autoSize: { minRows: 3 }, style: { paddingBottom: '40px' } },
|
||||
]}
|
||||
></Field>
|
||||
</div>
|
||||
);
|
||||
},
|
||||
{
|
||||
displayName: 'MessageInput',
|
||||
},
|
||||
);
|
||||
|
||||
const Message = () => {
|
||||
return <MessageInput />;
|
||||
};
|
||||
|
||||
export default Message;
|
||||
@ -0,0 +1,88 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
/**
|
||||
* This file is part of the NocoBase (R) project.
|
||||
* Copyright (c) 2020-2024 NocoBase Co., Ltd.
|
||||
* Authors: NocoBase Team.
|
||||
*
|
||||
* This program is offered under a commercial license.
|
||||
* For more information, see <https://www.nocobase.com/agreement>
|
||||
*/
|
||||
|
||||
import React from 'react';
|
||||
import { RemoteSelect, SchemaComponent, Variable, useCollectionFilterOptions, useToken } from '@nocobase/client';
|
||||
import { FilterDynamicComponent, useWorkflowVariableOptions } from '@nocobase/plugin-workflow/client';
|
||||
import { useField } from '@formily/react';
|
||||
|
||||
function isUserKeyField(field) {
|
||||
if (field.isForeignKey) {
|
||||
return field.target === 'users';
|
||||
}
|
||||
return field.collectionName === 'users' && field.name === 'id';
|
||||
}
|
||||
|
||||
export function UsersSelect(props) {
|
||||
const valueType = typeof props.value;
|
||||
|
||||
return valueType === 'object' && props.value ? <UsersQuery {...props} /> : <InternalUsersSelect {...props} />;
|
||||
}
|
||||
|
||||
function InternalUsersSelect({ value, onChange }) {
|
||||
const scope = useWorkflowVariableOptions({ types: [isUserKeyField] });
|
||||
|
||||
return (
|
||||
<Variable.Input scope={scope} value={value} onChange={onChange}>
|
||||
<RemoteSelect
|
||||
fieldNames={{
|
||||
label: 'nickname',
|
||||
value: 'id',
|
||||
}}
|
||||
service={{
|
||||
resource: 'users',
|
||||
}}
|
||||
manual={false}
|
||||
value={value}
|
||||
onChange={onChange}
|
||||
/>
|
||||
</Variable.Input>
|
||||
);
|
||||
}
|
||||
|
||||
function UsersQuery(props) {
|
||||
const field = useField<any>();
|
||||
const options = useCollectionFilterOptions('users');
|
||||
const { token } = useToken();
|
||||
|
||||
return (
|
||||
<div
|
||||
style={{
|
||||
border: `1px dashed ${token.colorBorder}`,
|
||||
padding: token.paddingSM,
|
||||
}}
|
||||
>
|
||||
<SchemaComponent
|
||||
basePath={field.address}
|
||||
schema={{
|
||||
type: 'void',
|
||||
properties: {
|
||||
filter: {
|
||||
type: 'object',
|
||||
'x-component': 'Filter',
|
||||
'x-component-props': {
|
||||
options,
|
||||
dynamicComponent: FilterDynamicComponent,
|
||||
},
|
||||
},
|
||||
},
|
||||
}}
|
||||
/>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@ -0,0 +1,67 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { useField } from '@formily/react';
|
||||
import { ArrayField as ArrayFieldModel } from '@formily/core';
|
||||
import { Button, Popover, Radio, Space, Spin, Tag, Tooltip, Typography } from 'antd';
|
||||
import { PlusOutlined, QuestionCircleOutlined } from '@ant-design/icons';
|
||||
import React, { useCallback, useState } from 'react';
|
||||
import { useWorkflowExecuted } from '@nocobase/plugin-workflow/client';
|
||||
import { useNotificationTranslation } from '../../../../../locale';
|
||||
|
||||
export function UsersAddition() {
|
||||
const disabled = useWorkflowExecuted();
|
||||
/*
|
||||
waiting for improvement
|
||||
const array = ArrayItems.useArray();
|
||||
*/
|
||||
const [open, setOpen] = useState(false);
|
||||
const { t } = useNotificationTranslation();
|
||||
const field = useField<ArrayFieldModel>();
|
||||
/*
|
||||
waiting for improvement
|
||||
const array = ArrayItems.useArray();
|
||||
*/
|
||||
const { receivers } = field.form.values;
|
||||
const onAddSelect = useCallback(() => {
|
||||
receivers.push('');
|
||||
setOpen(false);
|
||||
}, [receivers]);
|
||||
const onAddQuery = useCallback(() => {
|
||||
receivers.push({ filter: {} });
|
||||
setOpen(false);
|
||||
}, [receivers]);
|
||||
|
||||
const button = (
|
||||
<Button icon={<PlusOutlined />} type="dashed" block disabled={disabled} className="ant-formily-array-base-addition">
|
||||
{t('Add user')}
|
||||
</Button>
|
||||
);
|
||||
|
||||
return disabled ? (
|
||||
button
|
||||
) : (
|
||||
<Popover
|
||||
open={open}
|
||||
onOpenChange={setOpen}
|
||||
content={
|
||||
<Space direction="vertical" size="small">
|
||||
<Button type="text" onClick={onAddSelect}>
|
||||
{t('Select users')}
|
||||
</Button>
|
||||
<Button type="text" onClick={onAddQuery}>
|
||||
{t('Query users')}
|
||||
</Button>
|
||||
</Space>
|
||||
}
|
||||
>
|
||||
{button}
|
||||
</Popover>
|
||||
);
|
||||
}
|
||||
@ -0,0 +1,8 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
@ -0,0 +1,26 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { useCollectionRecord, useResourceActionContext, useAPIClient } from '@nocobase/client';
|
||||
export function useSendAction() {
|
||||
const { data }: any = useCollectionRecord();
|
||||
|
||||
const apiClient = useAPIClient();
|
||||
return {
|
||||
async run() {
|
||||
await apiClient.request({
|
||||
url: 'messages:send',
|
||||
method: 'post',
|
||||
data: {
|
||||
id: data.id,
|
||||
},
|
||||
});
|
||||
},
|
||||
};
|
||||
}
|
||||
@ -0,0 +1,35 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
export const formProperties = {
|
||||
title: {
|
||||
'x-component': 'CollectionField',
|
||||
'x-decorator': 'FormItem',
|
||||
'x-collection-field': 'messages.title',
|
||||
},
|
||||
channel: {
|
||||
'x-component': 'CollectionField',
|
||||
'x-decorator': 'FormItem',
|
||||
'x-collection-field': 'messages.channel',
|
||||
'x-component-props': {
|
||||
fieldNames: {
|
||||
value: 'id',
|
||||
label: 'title',
|
||||
},
|
||||
},
|
||||
},
|
||||
receiveOption: {
|
||||
'x-component': 'CollectionField',
|
||||
'x-collection-field': 'messages.receiveOption',
|
||||
},
|
||||
content: {
|
||||
'x-component': 'CollectionField',
|
||||
'x-collection-field': 'messages.message',
|
||||
},
|
||||
};
|
||||
@ -0,0 +1,241 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { ISchema } from '@formily/react';
|
||||
import { COLLECTION_NAME } from '../../../../constant';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import { message } from 'antd';
|
||||
import { formProperties } from './form';
|
||||
import { MessageScopeNames, MessageComponentNames } from '../types';
|
||||
export const messageManagerSchema: ISchema = {
|
||||
type: 'void',
|
||||
name: COLLECTION_NAME.messages,
|
||||
'x-decorator': 'TableBlockProvider',
|
||||
'x-acl-action': `${COLLECTION_NAME.messages}:list`,
|
||||
'x-use-decorator-props': 'useTableBlockDecoratorProps',
|
||||
'x-decorator-props': {
|
||||
collection: `${COLLECTION_NAME.messages}`,
|
||||
action: 'list',
|
||||
request: {
|
||||
resource: COLLECTION_NAME.messages,
|
||||
action: 'list',
|
||||
params: {
|
||||
pageSize: 20,
|
||||
},
|
||||
},
|
||||
},
|
||||
properties: {
|
||||
actions: {
|
||||
type: 'void',
|
||||
'x-component': 'ActionBar',
|
||||
'x-component-props': {
|
||||
style: {
|
||||
marginBottom: 16,
|
||||
},
|
||||
},
|
||||
properties: {
|
||||
create: {
|
||||
type: 'void',
|
||||
'x-uid': 'create',
|
||||
title: '{{t("Add new")}}',
|
||||
'x-component': 'Action',
|
||||
'x-component-props': {
|
||||
type: 'primary',
|
||||
icon: 'PlusOutlined',
|
||||
},
|
||||
properties: {
|
||||
drawer: {
|
||||
type: 'void',
|
||||
'x-component': 'Action.Drawer',
|
||||
properties: {
|
||||
mwjr03qwm35: {
|
||||
type: 'void',
|
||||
'x-component': 'FormV2',
|
||||
'x-use-component-props': 'useEditFormProps',
|
||||
properties: {
|
||||
...formProperties,
|
||||
footer: {
|
||||
type: 'void',
|
||||
'x-component': 'Action.Drawer.Footer',
|
||||
properties: {
|
||||
submit: {
|
||||
title: '{{t("Submit")}}',
|
||||
'x-component': 'Action',
|
||||
'x-action': 'submit',
|
||||
'x-use-component-props': 'useSubmitActionProps',
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
table: {
|
||||
type: 'array',
|
||||
'x-uid': 'table_messages',
|
||||
'x-component': 'TableV2',
|
||||
'x-use-component-props': 'useTableBlockProps',
|
||||
'x-component-props': {
|
||||
rowKey: 'id',
|
||||
rowSelection: {
|
||||
type: 'checkbox',
|
||||
},
|
||||
},
|
||||
properties: {
|
||||
id: {
|
||||
type: 'void',
|
||||
'x-decorator': 'TableV2.Column.Decorator',
|
||||
'x-component': 'TableV2.Column',
|
||||
properties: {
|
||||
id: {
|
||||
type: 'number',
|
||||
'x-component': 'CollectionField',
|
||||
'x-collection-field': `${COLLECTION_NAME.messages}.id`,
|
||||
'x-read-pretty': true,
|
||||
},
|
||||
},
|
||||
},
|
||||
title: {
|
||||
type: 'void',
|
||||
'x-decorator': 'TableV2.Column.Decorator',
|
||||
'x-component': 'TableV2.Column',
|
||||
properties: {
|
||||
title: {
|
||||
type: 'string',
|
||||
'x-component': 'CollectionField',
|
||||
'x-collection-field': `${COLLECTION_NAME.messages}.title`,
|
||||
'x-read-pretty': true,
|
||||
},
|
||||
},
|
||||
},
|
||||
actions: {
|
||||
type: 'void',
|
||||
title: '{{t("Actions")}}',
|
||||
'x-component': 'TableV2.Column',
|
||||
'x-action-column': 'actions',
|
||||
'x-decorator': 'TableV2.Column.ActionBar',
|
||||
properties: {
|
||||
actions: {
|
||||
type: 'void',
|
||||
'x-component': 'Space',
|
||||
'x-component-props': {
|
||||
split: '|',
|
||||
},
|
||||
properties: {
|
||||
send: {
|
||||
type: 'void',
|
||||
title: '{{ t("Send") }}',
|
||||
'x-component': 'Action.Link',
|
||||
'x-component-props': {
|
||||
confirm: {
|
||||
title: "{{t('Send Message')}}",
|
||||
content: "{{t('Are you sure you want to Send it?')}}",
|
||||
},
|
||||
useAction: `{{${MessageScopeNames.useSendAction}}}`,
|
||||
},
|
||||
},
|
||||
|
||||
logs: {
|
||||
type: 'void',
|
||||
title: '{{t("Logs")}}',
|
||||
'x-component': 'Action.Link',
|
||||
'x-component-props': {
|
||||
type: 'primary',
|
||||
},
|
||||
'x-action-context': {
|
||||
dataSource: 'main',
|
||||
collection: `${COLLECTION_NAME.messages}`,
|
||||
},
|
||||
'x-decorator': 'ACLActionProvider',
|
||||
properties: {
|
||||
drawer: {
|
||||
type: 'void',
|
||||
'x-component': 'Action.Drawer',
|
||||
title: '{{t("Logs")}}',
|
||||
properties: {
|
||||
logs: {
|
||||
type: 'void',
|
||||
'x-component': `${MessageComponentNames.MessageLogManager}`,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
update: {
|
||||
type: 'void',
|
||||
title: '{{t("Configure")}}',
|
||||
'x-component': 'Action.Link',
|
||||
'x-component-props': {
|
||||
type: 'primary',
|
||||
},
|
||||
properties: {
|
||||
drawer: {
|
||||
type: 'void',
|
||||
'x-component': 'Action.Drawer',
|
||||
title: '{{t("Configure")}}',
|
||||
properties: {
|
||||
form: {
|
||||
type: 'void',
|
||||
'x-component': 'FormV2',
|
||||
'x-use-component-props': 'useEditFormProps',
|
||||
properties: {
|
||||
...formProperties,
|
||||
footer: {
|
||||
type: 'void',
|
||||
'x-component': 'Action.Drawer.Footer',
|
||||
properties: {
|
||||
submit: {
|
||||
title: '{{t("Submit")}}',
|
||||
'x-component': 'Action',
|
||||
'x-use-component-props': 'useSubmitActionProps',
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
r82c1dijim3: {
|
||||
title: '{{ t("Delete") }}',
|
||||
'x-action': 'destroy',
|
||||
'x-component': 'Action.Link',
|
||||
'x-use-component-props': 'useDestroyActionProps',
|
||||
'x-toolbar': 'ActionSchemaToolbar',
|
||||
'x-settings': 'actionSettings:delete',
|
||||
'x-component-props': {
|
||||
icon: 'DeleteOutlined',
|
||||
confirm: {
|
||||
title: "{{t('Delete record')}}",
|
||||
content: "{{t('Are you sure you want to delete it?')}}",
|
||||
},
|
||||
refreshDataBlockRequest: true,
|
||||
},
|
||||
'x-decorator': 'ACLActionProvider',
|
||||
'x-designer-props': {
|
||||
linkageAction: true,
|
||||
},
|
||||
type: 'void',
|
||||
'x-uid': 'r82c1dijim3',
|
||||
'x-async': false,
|
||||
'x-index': 2,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
@ -0,0 +1,29 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
export enum MessageFieldNames {
|
||||
templateType = 'templateType',
|
||||
content = 'content',
|
||||
}
|
||||
|
||||
export enum MessageScopeNames {
|
||||
ChannelOptions = 'channelOptions',
|
||||
useSendAction = 'useSendAction',
|
||||
}
|
||||
|
||||
export enum MessageComponentNames {
|
||||
AddNew = 'AddNew',
|
||||
ReceiverConfigForm = 'ReceiverConfigForm',
|
||||
MessageInput = 'MessageInput',
|
||||
MessageLogManager = 'MessageLogManager',
|
||||
}
|
||||
|
||||
export enum MessageActionNames {
|
||||
useSendAction = 'useSendAction',
|
||||
}
|
||||
@ -0,0 +1,18 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { Registry } from '@nocobase/utils/client';
|
||||
import { RegisterChannelOptions } from './manager/channel/types';
|
||||
|
||||
export default class NotificationManager {
|
||||
channelTypes = new Registry<RegisterChannelOptions>();
|
||||
registerChannelType(options: RegisterChannelOptions) {
|
||||
this.channelTypes.register(options.type, options);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,126 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { COLLECTION_NAME } from '../constant';
|
||||
import { CollectionOptions } from '@nocobase/client';
|
||||
|
||||
const channelCollection: CollectionOptions = {
|
||||
name: COLLECTION_NAME.channels,
|
||||
autoGenId: false,
|
||||
filterTargetKey: 'name',
|
||||
fields: [
|
||||
{
|
||||
name: 'name',
|
||||
type: 'uid',
|
||||
primaryKey: true,
|
||||
interface: 'input',
|
||||
uiSchema: {
|
||||
type: 'string',
|
||||
title: '{{t("Channel name")}}',
|
||||
'x-component': 'Input',
|
||||
'x-read-pretty': true,
|
||||
required: true,
|
||||
description:
|
||||
"{{t('Randomly generated and can 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: true,
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'options',
|
||||
type: 'json',
|
||||
interface: 'json',
|
||||
uiSchema: {
|
||||
type: 'object',
|
||||
'x-component': 'ConfigForm',
|
||||
},
|
||||
},
|
||||
{
|
||||
interface: 'input',
|
||||
type: 'string',
|
||||
name: 'notificationType',
|
||||
uiSchema: {
|
||||
type: 'string',
|
||||
title: '{{t("Notification type")}}',
|
||||
'x-component': 'Select',
|
||||
enum: '{{notificationTypeOptions}}',
|
||||
required: true,
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'description',
|
||||
type: 'text',
|
||||
interface: 'textarea',
|
||||
uiSchema: {
|
||||
type: 'string',
|
||||
'x-component': 'Input.TextArea',
|
||||
title: '{{t("Description")}}',
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'CreatedAt',
|
||||
type: 'date',
|
||||
interface: 'createdAt',
|
||||
field: 'createdAt',
|
||||
uiSchema: {
|
||||
type: 'datetime',
|
||||
title: '{{t("Created at")}}',
|
||||
'x-component': 'DatePicker',
|
||||
'x-component-props': {},
|
||||
'x-read-pretty': true,
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'createdBy',
|
||||
type: 'belongsTo',
|
||||
interface: 'createdBy',
|
||||
description: null,
|
||||
parentKey: null,
|
||||
reverseKey: null,
|
||||
target: 'users',
|
||||
foreignKey: 'createdById',
|
||||
uiSchema: {
|
||||
type: 'object',
|
||||
title: '{{t("Created by")}}',
|
||||
'x-component': 'AssociationField',
|
||||
'x-component-props': {
|
||||
fieldNames: {
|
||||
value: 'id',
|
||||
label: 'nickname',
|
||||
},
|
||||
},
|
||||
'x-read-pretty': true,
|
||||
},
|
||||
targetKey: 'id',
|
||||
},
|
||||
{
|
||||
name: 'updatedAt',
|
||||
type: 'date',
|
||||
interface: 'updatedAt',
|
||||
field: 'updatedAt',
|
||||
uiSchema: {
|
||||
type: 'string',
|
||||
title: '{{t("Last updated at")}}',
|
||||
'x-component': 'DatePicker',
|
||||
'x-component-props': {},
|
||||
'x-read-pretty': true,
|
||||
},
|
||||
},
|
||||
],
|
||||
};
|
||||
export default channelCollection;
|
||||
@ -0,0 +1,136 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { CollectionOptions } from '@nocobase/client';
|
||||
import { COLLECTION_NAME } from '../constant';
|
||||
|
||||
const collectionOption: CollectionOptions = {
|
||||
name: COLLECTION_NAME.logs,
|
||||
title: 'MessageLogs',
|
||||
fields: [
|
||||
{
|
||||
name: 'id',
|
||||
type: 'uuid',
|
||||
primaryKey: true,
|
||||
allowNull: false,
|
||||
interface: 'uuid',
|
||||
uiSchema: {
|
||||
type: 'string',
|
||||
title: '{{t("ID")}}',
|
||||
'x-component': 'Input',
|
||||
'x-read-pretty': true,
|
||||
},
|
||||
},
|
||||
{
|
||||
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: true,
|
||||
},
|
||||
},
|
||||
{
|
||||
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: 'string',
|
||||
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': true,
|
||||
},
|
||||
},
|
||||
{
|
||||
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': true,
|
||||
},
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
export default collectionOption;
|
||||
@ -0,0 +1,15 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
export enum COLLECTION_NAME {
|
||||
templates = 'templates',
|
||||
channels = 'notificationChannels',
|
||||
messages = 'messages',
|
||||
logs = 'notificationSendLogs',
|
||||
}
|
||||
@ -0,0 +1,13 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
export { default } from './server';
|
||||
export { BaseNotificationChannel } from './server/base-notification-channel';
|
||||
|
||||
export * from './server';
|
||||
@ -0,0 +1,39 @@
|
||||
{
|
||||
"Notification Management": "Notification Management",
|
||||
"Notification": "Notification",
|
||||
"Channels": "Channels",
|
||||
"Channel": "Channel",
|
||||
"Channel title": "Channel title",
|
||||
"Channel name": "Channel name",
|
||||
"Channel display name": "Channel display name",
|
||||
"Content": "Content",
|
||||
"Receivers":"Receivers",
|
||||
"Receiver": "Receiver",
|
||||
"Add new receiver": "Add new receiver",
|
||||
"Templates": "Templates",
|
||||
"Logs": "Logs",
|
||||
"Title": "Title",
|
||||
"Description": "Description",
|
||||
"Notification type": "Notification type",
|
||||
"Actions": "Actions",
|
||||
"Configure": "Configure",
|
||||
"Add new": "Add new",
|
||||
"Trigger From": "Trigger From",
|
||||
"Status": "Status",
|
||||
"Created At": "Created At",
|
||||
"Delete record": "Delete record",
|
||||
"Are you sure you want to delete it?": "Are you sure you want to delete it?",
|
||||
"Deleted successfully!": "Deleted successfully!",
|
||||
"Add user": "Add user",
|
||||
"Select users": "Select users",
|
||||
"Query users": "Query users",
|
||||
"Receiver type": "Receiver type",
|
||||
"No channel enabled yet": "No channel enabled yet",
|
||||
"Success": "Success",
|
||||
"Fail": "Fail",
|
||||
"Reason": "Reason",
|
||||
"Failed reason": "Failed reason",
|
||||
"Log detail": "Log detail",
|
||||
"Message": "Message",
|
||||
"Notification manager": "Notification manager"
|
||||
}
|
||||
@ -0,0 +1,41 @@
|
||||
{
|
||||
"Notification Management": "通知管理",
|
||||
"Notification": "通知",
|
||||
"Channels": "渠道",
|
||||
"Channel": "渠道",
|
||||
"Channel title": "渠道名称",
|
||||
"Content": "内容",
|
||||
"Receivers":"接收人",
|
||||
"Receiver": "接收人",
|
||||
"Add new receiver": "新增接收人",
|
||||
"Templates": "模板",
|
||||
"Logs": "日志",
|
||||
"Title": "标题",
|
||||
"Description": "描述",
|
||||
"Notification type": "通知类型",
|
||||
"Actions": "操作",
|
||||
"Channel name": "渠道标识",
|
||||
"Channel display name": "渠道名称",
|
||||
"Configure": "编辑",
|
||||
"Add new": "新增",
|
||||
"Trigger from": "触发来源",
|
||||
"Status": "状态",
|
||||
"Created at": "发送时间",
|
||||
"Delete record": "删除记录",
|
||||
"Are you sure you want to delete it?": "确定要删除吗？",
|
||||
"Deleted successfully!": "删除成功！",
|
||||
"Add user": "添加用户",
|
||||
"Select users": "选择用户",
|
||||
"Query users": "查询用户",
|
||||
"Receiver type": "接收人类型",
|
||||
"Manual input": "手动输入",
|
||||
"Select user": "选择用户",
|
||||
"No channel enabled yet": "暂无启用的渠道",
|
||||
"Success": "成功",
|
||||
"Failure": "失败",
|
||||
"Reason": "原因",
|
||||
"Failed reason": "失败原因",
|
||||
"Log detail": "日志详情",
|
||||
"Message": "消息内容",
|
||||
"Notification manager": "通知管理"
|
||||
}
|
||||
@ -0,0 +1,79 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { uid } from '@formily/shared';
|
||||
import { createMockServer } from '@nocobase/test';
|
||||
import channelCollection from '../../collections/channel';
|
||||
import { COLLECTION_NAME } from '../../constant';
|
||||
import NotificationManager from '../manager';
|
||||
|
||||
describe('notification manager server', () => {
|
||||
let app;
|
||||
let agent;
|
||||
let db;
|
||||
let notificationManager;
|
||||
|
||||
const testChannelData = {
|
||||
name: `s_${uid()}`,
|
||||
notificationType: `test_${uid()}`,
|
||||
options: { test: uid() },
|
||||
title: 'test channel',
|
||||
description: 'test channel',
|
||||
};
|
||||
|
||||
beforeEach(async () => {
|
||||
app = await createMockServer({ plugins: ['notification-manager'] });
|
||||
agent = app.agent();
|
||||
db = app.db;
|
||||
|
||||
db.collection(channelCollection);
|
||||
await db.sync();
|
||||
await app.load();
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
await app.destroy();
|
||||
});
|
||||
|
||||
test('create channel', async () => {
|
||||
class TestNotificationMailServer {
|
||||
async send({ message, channel }) {
|
||||
console.log('senddddd', message, channel);
|
||||
expect(channel.options.test).toEqual(1);
|
||||
}
|
||||
}
|
||||
notificationManager = new NotificationManager({
|
||||
plugin: {
|
||||
app,
|
||||
//@ts-ignore
|
||||
logger: {
|
||||
info: (log) => log,
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
notificationManager.registerType(testChannelData.notificationType, {
|
||||
Channel: TestNotificationMailServer,
|
||||
});
|
||||
|
||||
const { body } = await agent.resource(COLLECTION_NAME.channels).create({
|
||||
values: {
|
||||
...testChannelData,
|
||||
},
|
||||
});
|
||||
const channelsRepo = app.db.getRepository(COLLECTION_NAME.channels);
|
||||
const channel = await channelsRepo.findOne({ filterByTk: testChannelData.name });
|
||||
expect(body.data.title).toEqual(testChannelData.title);
|
||||
// const res = await notificationManager.send({
|
||||
// channelName: testChannelData.name,
|
||||
// message: { content: 'test message' },
|
||||
// });
|
||||
// console.log('aaaa', res);
|
||||
});
|
||||
});
|
||||
@ -0,0 +1,19 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { Application } from '@nocobase/server';
|
||||
import { ChannelOptions } from './types';
|
||||
|
||||
export abstract class BaseNotificationChannel<Message = any> {
|
||||
constructor(protected app: Application) {}
|
||||
abstract send(params: {
|
||||
channel: ChannelOptions;
|
||||
message: Message;
|
||||
}): Promise<{ message: Message; status: 'success' | 'fail'; reason?: string }>;
|
||||
}
|
||||
@ -0,0 +1,13 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { defineCollection } from '@nocobase/database';
|
||||
import collectionOption from '../../collections/channel';
|
||||
|
||||
export default defineCollection(collectionOption);
|
||||
@ -0,0 +1,13 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { defineCollection } from '@nocobase/database';
|
||||
import collectionOption from '../../collections/messageLog';
|
||||
|
||||
export default defineCollection(collectionOption);
|
||||
@ -0,0 +1,13 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
export { BaseNotificationChannel } from './base-notification-channel';
|
||||
export { default } from './plugin';
|
||||
|
||||
export * from './types';
|
||||
@ -0,0 +1,88 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { Registry } from '@nocobase/utils';
|
||||
import { COLLECTION_NAME } from '../constant';
|
||||
import PluginNotificationManagerServer from './plugin';
|
||||
import type { NotificationChannelConstructor, RegisterServerTypeFnParams, SendOptions, WriteLogOptions } from './types';
|
||||
|
||||
export class NotificationManager implements NotificationManager {
|
||||
private plugin: PluginNotificationManagerServer;
|
||||
private notificationTypes = new Registry<{ Channel: NotificationChannelConstructor }>();
|
||||
|
||||
constructor({ plugin }: { plugin: PluginNotificationManagerServer }) {
|
||||
this.plugin = plugin;
|
||||
}
|
||||
|
||||
registerType({ type, Channel }: RegisterServerTypeFnParams) {
|
||||
this.notificationTypes.register(type, { Channel });
|
||||
}
|
||||
|
||||
createSendingRecord = async (options: WriteLogOptions) => {
|
||||
const logsRepo = this.plugin.app.db.getRepository(COLLECTION_NAME.logs);
|
||||
return logsRepo.create({ values: options });
|
||||
};
|
||||
|
||||
async parseReceivers(receiverType, receiversConfig, processor, node) {
|
||||
const configAssignees = processor
|
||||
.getParsedValue(node.config.assignees ?? [], node.id)
|
||||
.flat()
|
||||
.filter(Boolean);
|
||||
const assignees = new Set();
|
||||
const UserRepo = processor.options.plugin.app.db.getRepository('users');
|
||||
for (const item of configAssignees) {
|
||||
if (typeof item === 'object') {
|
||||
const result = await UserRepo.find({
|
||||
...item,
|
||||
fields: ['id'],
|
||||
transaction: processor.transaction,
|
||||
});
|
||||
result.forEach((item) => assignees.add(item.id));
|
||||
} else {
|
||||
assignees.add(item);
|
||||
}
|
||||
}
|
||||
|
||||
return [...assignees];
|
||||
}
|
||||
|
||||
async send(params: SendOptions) {
|
||||
this.plugin.logger.info('receive sending message request', params);
|
||||
const channelsRepo = this.plugin.app.db.getRepository(COLLECTION_NAME.channels);
|
||||
const logData: any = {
|
||||
triggerFrom: params.triggerFrom,
|
||||
channelName: params.channelName,
|
||||
message: params.message,
|
||||
};
|
||||
try {
|
||||
const channel = await channelsRepo.findOne({ filterByTk: params.channelName });
|
||||
if (channel) {
|
||||
const Channel = this.notificationTypes.get(channel.notificationType).Channel;
|
||||
const instance = new Channel(this.plugin.app);
|
||||
logData.channelTitle = channel.title;
|
||||
logData.notificationType = channel.notificationType;
|
||||
const result = await instance.send({ message: params.message, channel });
|
||||
logData.status = result.status;
|
||||
logData.reason = result.reason;
|
||||
} else {
|
||||
logData.status = 'failure';
|
||||
logData.reason = 'channel not found';
|
||||
}
|
||||
this.createSendingRecord(logData);
|
||||
return logData;
|
||||
} catch (error) {
|
||||
logData.status = 'failure';
|
||||
logData.reason = error.reason;
|
||||
this.createSendingRecord(logData);
|
||||
return logData;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export default NotificationManager;
|
||||
@ -0,0 +1,61 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import type { Logger } from '@nocobase/logger';
|
||||
import { Plugin } from '@nocobase/server';
|
||||
import NotificationManager from './manager';
|
||||
import { RegisterServerTypeFnParams, SendOptions } from './types';
|
||||
export class PluginNotificationManagerServer extends Plugin {
|
||||
private manager: NotificationManager;
|
||||
logger: Logger;
|
||||
|
||||
registerChannelType(params: RegisterServerTypeFnParams) {
|
||||
this.manager.registerType(params);
|
||||
}
|
||||
async send(options: SendOptions) {
|
||||
return await this.manager.send(options);
|
||||
}
|
||||
|
||||
async afterAdd() {
|
||||
this.logger = this.createLogger({
|
||||
dirname: 'notification-manager',
|
||||
filename: '%DATE%.log',
|
||||
transports: ['dailyRotateFile'],
|
||||
});
|
||||
this.manager = new NotificationManager({ plugin: this });
|
||||
}
|
||||
|
||||
async beforeLoad() {
|
||||
this.app.resourceManager.registerActionHandler('messages:send', async (ctx, next) => {
|
||||
const sendOptions = ctx.action?.params?.values as SendOptions;
|
||||
this.manager.send(sendOptions);
|
||||
next();
|
||||
});
|
||||
this.app.acl.registerSnippet({
|
||||
name: 'pm.notification.channels',
|
||||
actions: ['notificationChannels:*'],
|
||||
});
|
||||
this.app.acl.registerSnippet({
|
||||
name: 'pm.notification.logs',
|
||||
actions: ['notificationSendLogs:*'],
|
||||
});
|
||||
}
|
||||
|
||||
async load() {}
|
||||
|
||||
async install() {}
|
||||
|
||||
async afterEnable() {}
|
||||
|
||||
async afterDisable() {}
|
||||
|
||||
async remove() {}
|
||||
}
|
||||
|
||||
export default PluginNotificationManagerServer;
|
||||
@ -0,0 +1,48 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { Application } from '@nocobase/server';
|
||||
import { BaseNotificationChannel } from './base-notification-channel';
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
export interface ChannelOptions {
|
||||
name: string;
|
||||
options: Record<string, any>;
|
||||
notificationType: string;
|
||||
}
|
||||
|
||||
export type WriteLogOptions = {
|
||||
status: 'success' | 'failure';
|
||||
message: Record<string, any>;
|
||||
triggerFrom: string;
|
||||
reason?: string;
|
||||
channelName: string;
|
||||
channelTitle: string;
|
||||
};
|
||||
|
||||
export type SendFnType<Message> = (args: {
|
||||
message: Message;
|
||||
channel: ChannelOptions;
|
||||
}) => Promise<{ message: Message; status: 'success' | 'fail'; reason?: string }>;
|
||||
|
||||
export interface SendOptions {
|
||||
channelName: string;
|
||||
message: Record<string, any>;
|
||||
triggerFrom: string;
|
||||
}
|
||||
|
||||
export type NotificationChannelConstructor = new (app: Application) => BaseNotificationChannel;
|
||||
export type RegisterServerTypeFnParams = { type: string; Channel: NotificationChannelConstructor };
|
||||
@ -0,0 +1,2 @@
|
||||
/node_modules
|
||||
/src
|
||||
661
packages/plugins/@nocobase/plugin-workflow-notification/LICENSE
Normal file
661
packages/plugins/@nocobase/plugin-workflow-notification/LICENSE
Normal file
@ -0,0 +1,661 @@
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
our General Public Licenses are intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU Affero General Public License from time to time. Such new versions
|
||||
will be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU Affero General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU Affero General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU Affero General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Affero General Public License as published
|
||||
by the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU AGPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
@ -0,0 +1,9 @@
|
||||
# Workflow Mailer
|
||||
|
||||
English | [中文](./README.zh-CN.md)
|
||||
|
||||
## 安装激活
|
||||
|
||||
内置插件无需手动安装激活。
|
||||
|
||||
## 使用方法
|
||||
@ -0,0 +1,9 @@
|
||||
# 工作流邮件发送节点
|
||||
|
||||
[English](./README.md) | 中文
|
||||
|
||||
## 安装激活
|
||||
|
||||
内置插件无需手动安装激活。
|
||||
|
||||
## 使用方法
|
||||
2
packages/plugins/@nocobase/plugin-workflow-notification/client.d.ts
vendored
Normal file
2
packages/plugins/@nocobase/plugin-workflow-notification/client.d.ts
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
export * from './dist/client';
|
||||
export { default } from './dist/client';
|
||||
@ -0,0 +1 @@
|
||||
module.exports = require('./dist/client/index.js');
|
||||
@ -0,0 +1,26 @@
|
||||
{
|
||||
"name": "@nocobase/plugin-workflow-notification",
|
||||
"displayName": "Workflow: notification node",
|
||||
"displayName.zh-CN": "工作流：通知节点",
|
||||
"description": "Send notification in workflow.",
|
||||
"description.zh-CN": "可用于在工作流中发送各类通知。",
|
||||
"version": "1.4.0-alpha",
|
||||
"license": "AGPL-3.0",
|
||||
"main": "./dist/server/index.js",
|
||||
"homepage": "https://docs.nocobase.com/handbook/workflow-smtp-mailer",
|
||||
"homepage.zh-CN": "https://docs-cn.nocobase.com/handbook/workflow-smtp-mailer",
|
||||
"devDependencies": {
|
||||
"antd": "5.x",
|
||||
"react": "18.x"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@nocobase/client": "1.x",
|
||||
"@nocobase/database": "1.x",
|
||||
"@nocobase/plugin-workflow": ">=0.17.0-alpha.3",
|
||||
"@nocobase/server": "1.x",
|
||||
"@nocobase/test": "1.x"
|
||||
},
|
||||
"keywords": [
|
||||
"Workflow"
|
||||
]
|
||||
}
|
||||
2
packages/plugins/@nocobase/plugin-workflow-notification/server.d.ts
vendored
Normal file
2
packages/plugins/@nocobase/plugin-workflow-notification/server.d.ts
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
export * from './dist/server';
|
||||
export { default } from './dist/server';
|
||||
@ -0,0 +1 @@
|
||||
module.exports = require('./dist/server/index.js');
|
||||
@ -0,0 +1,33 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
import React from 'react';
|
||||
import { Instruction, useWorkflowVariableOptions } from '@nocobase/plugin-workflow/client';
|
||||
import { MessageConfigForm } from '@nocobase/plugin-notification-manager/client';
|
||||
import { NAMESPACE } from '../locale';
|
||||
|
||||
const LocalProvider = () => {
|
||||
const variableOptions = useWorkflowVariableOptions();
|
||||
return <MessageConfigForm variableOptions={variableOptions} />;
|
||||
};
|
||||
|
||||
export default class extends Instruction {
|
||||
title = `{{t("Notification", { ns: "${NAMESPACE}" })}}`;
|
||||
type = 'notification';
|
||||
group = 'extended';
|
||||
description = `{{t("Send notification. You can use the variables in the upstream nodes as content and ohter config.", { ns: "${NAMESPACE}" })}}`;
|
||||
fieldset = {
|
||||
message: {
|
||||
type: 'void',
|
||||
'x-component': 'LocalProvider',
|
||||
},
|
||||
};
|
||||
components = {
|
||||
LocalProvider,
|
||||
};
|
||||
}
|
||||
@ -0,0 +1,27 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { Plugin } from '@nocobase/client';
|
||||
import WorkflowPlugin from '@nocobase/plugin-workflow/client';
|
||||
|
||||
import NotificationInstruction from './NotificationInstruction';
|
||||
|
||||
export default class extends Plugin {
|
||||
async afterAdd() {
|
||||
// await this.app.pm.add()
|
||||
}
|
||||
|
||||
async beforeLoad() {}
|
||||
|
||||
// You can get and modify the app instance here
|
||||
async load() {
|
||||
const workflow = this.app.pm.get('workflow') as WorkflowPlugin;
|
||||
workflow.registerInstruction('notification', NotificationInstruction);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,11 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
export * from './server';
|
||||
export { default } from './server';
|
||||
@ -0,0 +1,4 @@
|
||||
{
|
||||
"Send email. You can use the variables in the upstream nodes as receivers, subject and content of the email.": "Send email by calling SMTP service. You can use the variables in the upstream nodes as receivers, subject and content of the email.",
|
||||
"Ignore failed sending and continue workflow": "Ignore failed sending and continue workflow"
|
||||
}
|
||||
@ -0,0 +1,21 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { useTranslation } from 'react-i18next';
|
||||
|
||||
export const NAMESPACE = 'workflow-notification';
|
||||
|
||||
export function useLang(key: string, options = {}) {
|
||||
const { t } = usePluginTranslation(options);
|
||||
return t(key);
|
||||
}
|
||||
|
||||
export function usePluginTranslation(options) {
|
||||
return useTranslation(NAMESPACE, options);
|
||||
}
|
||||
@ -0,0 +1,4 @@
|
||||
{
|
||||
"Notification": "通知",
|
||||
"Send notification. You can use the variables in the upstream nodes as content and ohter config.": "发送通知。您可以使用上游节点中的变量作为通知的内容和其他配置。"
|
||||
}
|
||||
@ -0,0 +1,91 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import NotificationsServerPlugin from '@nocobase/plugin-notification-manager';
|
||||
|
||||
import { Processor, Instruction, JOB_STATUS, FlowNodeModel } from '@nocobase/plugin-workflow';
|
||||
|
||||
export default class extends Instruction {
|
||||
async run(node: FlowNodeModel, prevJob, processor: Processor) {
|
||||
const options = processor.getParsedValue(node.config, node.id);
|
||||
const sendParams = { channelName: options.channelName, message: options, triggerFrom: 'workflow' };
|
||||
const notificationServer = this.workflow.pm.get(NotificationsServerPlugin) as NotificationsServerPlugin;
|
||||
|
||||
const { workflow } = processor.execution;
|
||||
const sync = this.workflow.isWorkflowSync(workflow);
|
||||
if (sync) {
|
||||
try {
|
||||
const result = await notificationServer.send(sendParams);
|
||||
if (result.status === 'success') {
|
||||
return {
|
||||
status: JOB_STATUS.RESOLVED,
|
||||
result,
|
||||
};
|
||||
} else {
|
||||
return {
|
||||
status: JOB_STATUS.FAILED,
|
||||
result,
|
||||
};
|
||||
}
|
||||
} catch (error) {
|
||||
return {
|
||||
status: JOB_STATUS.FAILED,
|
||||
result: error,
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
const job = await processor.saveJob({
|
||||
status: JOB_STATUS.PENDING,
|
||||
nodeId: node.id,
|
||||
nodeKey: node.key,
|
||||
upstreamId: prevJob?.id ?? null,
|
||||
});
|
||||
|
||||
// eslint-disable-next-line promise/catch-or-return
|
||||
notificationServer
|
||||
.send(sendParams)
|
||||
.then((result) => {
|
||||
if (result.status === 'success') {
|
||||
processor.logger.info(`notification (#${node.id}) sent successfully.`);
|
||||
job.set({
|
||||
status: JOB_STATUS.RESOLVED,
|
||||
result,
|
||||
});
|
||||
} else {
|
||||
processor.logger.info(`notification (#${node.id}) sent failed.`);
|
||||
job.set({
|
||||
status: JOB_STATUS.FAILED,
|
||||
result: result,
|
||||
});
|
||||
}
|
||||
})
|
||||
.catch((error) => {
|
||||
processor.logger.warn(`notification (#${node.id}) sent failed: ${error.message}`);
|
||||
|
||||
job.set({
|
||||
status: JOB_STATUS.FAILED,
|
||||
result: error,
|
||||
});
|
||||
})
|
||||
.finally(() => {
|
||||
processor.logger.debug(`notification (#${node.id}) sending ended, resume workflow...`);
|
||||
setImmediate(() => {
|
||||
this.workflow.resume(job);
|
||||
});
|
||||
});
|
||||
processor.logger.info(`notification (#${node.id}) sent, waiting for response...`);
|
||||
|
||||
return processor.exit();
|
||||
}
|
||||
|
||||
async resume(node: FlowNodeModel, job, processor: Processor) {
|
||||
return job;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,20 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
import { Plugin } from '@nocobase/server';
|
||||
import WorkflowPlugin from '@nocobase/plugin-workflow';
|
||||
|
||||
import MailerInstruction from './NotificationInstruction';
|
||||
|
||||
export default class extends Plugin {
|
||||
async load() {
|
||||
const workflowPlugin = this.app.pm.get(WorkflowPlugin) as WorkflowPlugin;
|
||||
workflowPlugin.registerInstruction('notification', MailerInstruction);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,10 @@
|
||||
/**
|
||||
* 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.
|
||||
*/
|
||||
|
||||
export { default } from './Plugin';
|
||||
@ -66,7 +66,10 @@
|
||||
"@nocobase/plugin-workflow-parallel": "1.4.0-alpha",
|
||||
"@nocobase/plugin-workflow-request": "1.4.0-alpha",
|
||||
"@nocobase/plugin-workflow-sql": "1.4.0-alpha",
|
||||
"@nocobase/plugin-workflow-notification": "1.4.0-alpha",
|
||||
"@nocobase/server": "1.4.0-alpha",
|
||||
"@nocobase/plugin-notification-email": "1.4.0-alpha",
|
||||
"@nocobase/plugin-notification-manager": "1.4.0-alpha",
|
||||
"cronstrue": "^2.11.0",
|
||||
"fs-extra": "^11.1.1"
|
||||
},
|
||||
@ -103,6 +106,7 @@
|
||||
"@nocobase/plugin-gantt",
|
||||
"@nocobase/plugin-kanban",
|
||||
"@nocobase/plugin-logger",
|
||||
"@nocobase/plugin-notification-manager",
|
||||
"@nocobase/plugin-mobile",
|
||||
"@nocobase/plugin-system-settings",
|
||||
"@nocobase/plugin-ui-schema-storage",
|
||||
@ -118,7 +122,8 @@
|
||||
"@nocobase/plugin-workflow-manual",
|
||||
"@nocobase/plugin-workflow-parallel",
|
||||
"@nocobase/plugin-workflow-request",
|
||||
"@nocobase/plugin-workflow-sql"
|
||||
"@nocobase/plugin-workflow-sql",
|
||||
"@nocobase/plugin-workflow-notification"
|
||||
],
|
||||
"repository": {
|
||||
"type": "git",
|
||||
@ -126,4 +131,4 @@
|
||||
"directory": "packages/presets/nocobase"
|
||||
},
|
||||
"gitHead": "d0b4efe4be55f8c79a98a331d99d9f8cf99021a1"
|
||||
}
|
||||
}
|
||||
|
||||
41
yarn.lock
41
yarn.lock
@ -3982,6 +3982,25 @@
|
||||
classnames "^2.2.6"
|
||||
react-sticky-box "^1.0.2"
|
||||
|
||||
"@formily/antd-v5@^1.x":
|
||||
version "1.2.2"
|
||||
resolved "https://registry.npmmirror.com/@formily/antd-v5/-/antd-v5-1.2.2.tgz#7c26871bd120585f7ffcde042bc23f095fe530a0"
|
||||
integrity sha512-vlEL8gme9dp9fJ70Cpo+iY3+YGZyd6uTMoAmRiGg0jug+g+CLbten3GGe7vEuxWvOiHkV4s6XkS2SpmyNMjvjA==
|
||||
dependencies:
|
||||
"@ant-design/cssinjs" "^1.3.1"
|
||||
"@ant-design/icons" "^5.0.0"
|
||||
"@dnd-kit/core" "^6.0.0"
|
||||
"@dnd-kit/sortable" "^7.0.0"
|
||||
"@formily/core" "^2.2.0"
|
||||
"@formily/grid" "^2.2.0"
|
||||
"@formily/json-schema" "^2.2.0"
|
||||
"@formily/react" "^2.2.0"
|
||||
"@formily/reactive" "^2.2.0"
|
||||
"@formily/reactive-react" "^2.2.0"
|
||||
"@formily/shared" "^2.2.0"
|
||||
classnames "^2.2.6"
|
||||
react-sticky-box "^1.0.2"
|
||||
|
||||
"@formily/core@2.3.0", "@formily/core@2.x", "@formily/core@^2.2.0", "@formily/core@^2.2.27":
|
||||
version "2.3.0"
|
||||
resolved "https://registry.npmmirror.com/@formily/core/-/core-2.3.0.tgz#2d9c09ec7579dc11cfd4d8f2f20fb0a56504e180"
|
||||
@ -7237,6 +7256,13 @@
|
||||
dependencies:
|
||||
"@types/node" "*"
|
||||
|
||||
"@types/nodemailer@^6.x":
|
||||
version "6.4.15"
|
||||
resolved "https://registry.npmmirror.com/@types/nodemailer/-/nodemailer-6.4.15.tgz#494be695e11c438f7f5df738fb4ab740312a6ed2"
|
||||
integrity sha512-0EBJxawVNjPkng1zm2vopRctuWVCxk34JcIlRuXSf54habUWdz1FB7wHDqOqvDa8Mtpt0Q3LTXQkAs2LNyK5jQ==
|
||||
dependencies:
|
||||
"@types/node" "*"
|
||||
|
||||
"@types/normalize-package-data@^2.4.0":
|
||||
version "2.4.4"
|
||||
resolved "https://registry.npmmirror.com/@types/normalize-package-data/-/normalize-package-data-2.4.4.tgz#56e2cc26c397c038fab0e3a917a12d5c5909e901"
|
||||
@ -8620,9 +8646,9 @@ antd-mobile@^5.29.1:
|
||||
use-sync-external-store "^1.2.0"
|
||||
|
||||
antd-mobile@^5.36.1:
|
||||
version "5.36.1"
|
||||
resolved "https://registry.npmmirror.com/antd-mobile/-/antd-mobile-5.36.1.tgz#6b0d1ada43923bcdc592aa4448f2b60e13eef75a"
|
||||
integrity sha512-TneFsSc0OV95+lYSA1DzOyDdZZI3bitA071QT71cu+duS7RLMJXoOUPGcDxkCrqPC4ticwkfNx3s6NTdP2d8fQ==
|
||||
version "5.37.1"
|
||||
resolved "https://registry.npmmirror.com/antd-mobile/-/antd-mobile-5.37.1.tgz#9a86718d9a95899b7efcb798ca005b59af14b75a"
|
||||
integrity sha512-r7LXWsvgI13BCwX3k0CPhRXeWVvlpyiION4k6YjoIlkc2NCah0InhVmFSkmbhSU3zufQai5ao0oFhQtVq5dY+Q==
|
||||
dependencies:
|
||||
"@floating-ui/dom" "^1.4.2"
|
||||
"@rc-component/mini-decimal" "^1.1.0"
|
||||
@ -12383,7 +12409,7 @@ delegates@^1.0.0:
|
||||
resolved "https://registry.npmmirror.com/delegates/-/delegates-1.0.0.tgz#84c6e159b81904fdca59a0ef44cd870d31250f9a"
|
||||
integrity sha512-bd2L678uiWATM6m5Z1VzNCErI3jiGzt6HGY8OVICs40JQq/HALfbyNJmp0UDakEY4pMMaN0Ly5om/B1VI/+xfQ==
|
||||
|
||||
denque@^2.0.1, denque@^2.1.0:
|
||||
denque@^2.0.1:
|
||||
version "2.1.0"
|
||||
resolved "https://registry.npmmirror.com/denque/-/denque-2.1.0.tgz#e93e1a6569fb5e66f16a3c2a2964617d349d6ab1"
|
||||
integrity sha512-HVQE3AAb/pxF8fQAoiqpvg9i3evqug3hoiwakOyZAwJm+6vZehbkYXZ0l4JxS+I3QxM97v5aaRNhj8v5oBhekw==
|
||||
@ -18195,7 +18221,7 @@ lru-cache@6.0.0, lru-cache@^6.0.0:
|
||||
dependencies:
|
||||
yallist "^4.0.0"
|
||||
|
||||
lru-cache@8.0.5, lru-cache@^8.0.0:
|
||||
lru-cache@8.0.5:
|
||||
version "8.0.5"
|
||||
resolved "https://registry.npmmirror.com/lru-cache/-/lru-cache-8.0.5.tgz#983fe337f3e176667f8e567cfcce7cb064ea214e"
|
||||
integrity sha512-MhWWlVnuab1RG5/zMRRcVGXZLCXrZTgfwMikgzCegsPnG62yDQo5JnqKkrK4jO5iKqDAZGItAqN5CtKBCBWRUA==
|
||||
@ -18205,11 +18231,6 @@ lru-cache@^10.0.2:
|
||||
resolved "https://registry.npmmirror.com/lru-cache/-/lru-cache-10.1.0.tgz#2098d41c2dc56500e6c88584aa656c84de7d0484"
|
||||
integrity sha512-/1clY/ui8CzjKFyjdvwPWJUYKiFVXG2I2cY0ssG7h4+hwk+XOIX7ZSG9Q7TW8TW3Kp3BUSqgFWBLgL4PJ+Blag==
|
||||
|
||||
lru-cache@^10.2.0:
|
||||
version "10.4.3"
|
||||
resolved "https://registry.npmmirror.com/lru-cache/-/lru-cache-10.4.3.tgz#410fc8a17b70e598013df257c2446b7f3383f119"
|
||||
integrity sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ==
|
||||
|
||||
lru-cache@^4.0.1, lru-cache@^4.1.1:
|
||||
version "4.1.5"
|
||||
resolved "https://registry.npmmirror.com/lru-cache/-/lru-cache-4.1.5.tgz#8bbe50ea85bed59bc9e33dcab8235ee9bcf443cd"
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user