@nocobase/plugin-notifications 0.10.1-alpha.1 → 0.11.0-alpha.1

package/client.d.ts

@@ -0,0 +1,3 @@
+export * from './src/client';
+export { default } from './src/client';
+

package/client.js

@@ -0,0 +1 @@
+module.exports = require('./lib/client/index.js');

package/lib/client/index.d.ts

@@ -0,0 +1,5 @@
+import { Plugin } from '@nocobase/client';
+declare class NotificationPlugin extends Plugin {
+    load(): Promise<void>;
+}
+export default NotificationPlugin;

package/lib/client/index.js

@@ -0,0 +1,22 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+function _client() {
+  const data = require("@nocobase/client");
+  _client = function _client() {
+    return data;
+  };
+  return data;
+}
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
+function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
+class NotificationPlugin extends _client().Plugin {
+  load() {
+    return _asyncToGenerator(function* () {})();
+  }
+}
+var _default = NotificationPlugin;
+exports.default = _default;

package/lib/server/index.d.ts

@@ -0,0 +1 @@
+export { default } from './server';

package/lib/server/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function get() {
+    return _server.default;
+  }
+});
+var _server = _interopRequireDefault(require("./server"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/lib/{models → server/models}/Notification.js

@@ -11,14 +11,13 @@ function _database() {
   };
   return data;
 }
-function _lodash() {
-  const data = _interopRequireDefault(require("lodash"));
-  _lodash = function _lodash() {
+function _utils() {
+  const data = require("@nocobase/utils");
+  _utils = function _utils() {
     return data;
   };
   return data;
 }
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
 function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
 function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
@@ -106,7 +105,7 @@ class Notification extends _database().Model {
     return this.subject;
   }
   getBody(data) {
-    const compiled = _lodash().default.template(this.body);
+    const compiled = _utils().lodash.template(this.body);
     const body = compiled(data);
     return body;
   }

package/package.json

@@ -1,17 +1,31 @@
 {
   "name": "@nocobase/plugin-notifications",
-  "version": "0.10.1-alpha.1",
+  "version": "0.11.0-alpha.1",
   "description": "",
   "license": "AGPL-3.0",
-  "main": "./lib/index.js",
-  "types": "./lib/index.d.ts",
+  "main": "./lib/server/index.js",
+  "files": [
+    "lib",
+    "src",
+    "README.md",
+    "README.zh-CN.md",
+    "CHANGELOG.md",
+    "server.js",
+    "server.d.ts",
+    "client.js",
+    "client.d.ts"
+  ],
   "dependencies": {
+    "@types/nodemailer": "6.4.4",
     "nodemailer": "^6.6.1"
   },
   "devDependencies": {
-    "@nocobase/test": "0.10.1-alpha.1",
-    "@types/nodemailer": "6.4.4",
+    "@nocobase/client": "0.11.0-alpha.1",
+    "@nocobase/database": "0.11.0-alpha.1",
+    "@nocobase/server": "0.11.0-alpha.1",
+    "@nocobase/test": "0.11.0-alpha.1",
+    "@nocobase/utils": "0.11.0-alpha.1",
     "nodemailer-mock": "^1.5.11"
   },
-  "gitHead": "8f415f5e0ee2e72d681f9ab16af5911b52c374a9"
+  "gitHead": "7581b6d3a3a54f09f06a9effb7e3e65328281b2b"
 }

package/server.d.ts

@@ -0,0 +1,3 @@
+export * from './src/server';
+export { default } from './src/server';
+

package/server.js

@@ -0,0 +1 @@
+module.exports = require('./lib/server/index.js');

package/src/client/index.ts

@@ -0,0 +1,7 @@
+import { Plugin } from '@nocobase/client';
+
+class NotificationPlugin extends Plugin {
+  async load() { }
+}
+
+export default NotificationPlugin;

package/src/index.ts

@@ -0,0 +1 @@
+export { default } from './server';

package/src/server/__tests__/notifications.test.ts

@@ -0,0 +1,53 @@
+import Database from '@nocobase/database';
+import { mockServer } from '@nocobase/test';
+import nodemailerMock from 'nodemailer-mock';
+import { Notification, NotificationService } from '../models';
+import plugin from '../server';
+
+jest.setTimeout(300000);
+
+describe('notifications', () => {
+  let db: Database;
+
+  beforeEach(async () => {
+    const app = mockServer();
+    app.plugin(plugin);
+    await app.load();
+    db = app.db;
+    await db.sync();
+    NotificationService.createTransport = nodemailerMock.createTransport;
+  });
+
+  afterEach(() => db.close());
+
+  it('create', async () => {
+    const Notification = db.getCollection('notifications');
+    const notification = (await Notification.repository.create({
+      values: {
+        subject: 'Subject',
+        body: 'hell world',
+        receiver_options: {
+          data: 'to@nocobase.com',
+          fromTable: 'users',
+          filter: {},
+          dataField: 'email',
+        },
+        service: {
+          type: 'email',
+          title: '阿里云邮件推送',
+          options: {
+            host: 'smtpdm.aliyun.com',
+            port: 465,
+            secure: true,
+            auth: {
+              user: 'from@nocobase.com',
+              pass: 'pass',
+            },
+            from: 'NocoBase<from@nocobase.com>',
+          },
+        },
+      },
+    })) as Notification;
+    await notification.send();
+  });
+});

package/src/server/collections/notification_logs.ts

@@ -0,0 +1,25 @@
+import { CollectionOptions } from '@nocobase/database';
+import { NotificationLog } from '../models';
+
+export default {
+  name: 'notification_logs',
+  model: NotificationLog,
+  title: '通知日志',
+  fields: [
+    {
+      title: '接收人',
+      type: 'json',
+      name: 'receiver',
+    },
+    {
+      title: '状态',
+      type: 'string',
+      name: 'state',
+    },
+    {
+      title: '详情',
+      type: 'json',
+      name: 'response',
+    },
+  ],
+} as CollectionOptions;

package/src/server/collections/notification_services.ts

@@ -0,0 +1,25 @@
+import { CollectionOptions } from '@nocobase/database';
+import { NotificationService } from '../models';
+
+export default {
+  name: 'notification_services',
+  model: NotificationService,
+  title: '通知服务',
+  fields: [
+    {
+      title: '类型',
+      type: 'string',
+      name: 'type',
+    },
+    {
+      title: '服务名称',
+      type: 'string',
+      name: 'title',
+    },
+    {
+      title: '配置信息',
+      type: 'json',
+      name: 'options',
+    },
+  ],
+} as CollectionOptions;

package/src/server/collections/notifications.ts

@@ -0,0 +1,42 @@
+import { CollectionOptions } from '@nocobase/database';
+import { Notification } from '../models';
+
+export default {
+  name: 'notifications',
+  model: Notification,
+  title: '通知',
+  fields: [
+    {
+      type: 'uid',
+      name: 'name',
+      prefix: 'n_',
+    },
+    {
+      title: '主题',
+      type: 'string',
+      name: 'subject',
+    },
+    {
+      title: '内容',
+      type: 'text',
+      name: 'body',
+    },
+    {
+      title: '接收人配置',
+      type: 'json',
+      name: 'receiver_options',
+    },
+    {
+      title: '发送服务',
+      type: 'belongsTo',
+      name: 'service',
+      target: 'notification_services',
+    },
+    {
+      title: '日志',
+      type: 'hasMany',
+      name: 'logs',
+      target: 'notification_logs',
+    },
+  ],
+} as CollectionOptions;

package/src/server/index.ts

@@ -0,0 +1 @@
+export { default } from './server';

package/src/server/models/Notification.ts

@@ -0,0 +1,85 @@
+import Database, { Model } from '@nocobase/database';
+import { lodash } from '@nocobase/utils';
+import { NotificationService } from './NotificationService';
+
+export class Notification extends Model {
+  [key: string]: any;
+
+  get db(): Database {
+    return this.constructor['database'];
+  }
+
+  async getReceiversByOptions(): Promise<any[]> {
+    const { data, fromTable, filter, dataField } = this.receiver_options;
+    let receivers = [];
+    if (data) {
+      receivers = Array.isArray(data) ? data : [data];
+    } else if (fromTable) {
+      const collection = this.db.getCollection(fromTable);
+      const rows = await collection.repository.find({
+        filter,
+      });
+      receivers = rows.map((row) => row[dataField]);
+    }
+    return receivers;
+  }
+
+  async send(options: any = {}) {
+    const { transaction } = options;
+
+    if (!this.service) {
+      this.service = await this.getService();
+    }
+    const receivers = await this.getReceiversByOptions();
+    let { to } = options;
+    if (to) {
+      to = Array.isArray(to) ? to : [to];
+      receivers.push(...to);
+    }
+    console.log(receivers);
+    for (const receiver of receivers) {
+      try {
+        const response = await (this.service as NotificationService).send({
+          to: receiver,
+          subject: this.getSubject(),
+          html: this.getBody(options),
+        });
+        await this.createLog(
+          {
+            receiver,
+            state: 'success',
+            response,
+          },
+          {
+            transaction,
+          },
+        );
+        await new Promise((resolve) => {
+          setTimeout(resolve, 100);
+        });
+      } catch (error) {
+        console.error(error);
+        await this.createLog(
+          {
+            receiver,
+            state: 'fail',
+            response: {},
+          },
+          {
+            transaction,
+          },
+        );
+      }
+    }
+  }
+
+  getSubject() {
+    return this.subject;
+  }
+
+  getBody(data) {
+    const compiled = lodash.template(this.body);
+    const body = compiled(data);
+    return body;
+  }
+}

package/src/server/models/NotificationLog.ts

@@ -0,0 +1,3 @@
+import { Model } from '@nocobase/database';
+
+export class NotificationLog extends Model {}

package/src/server/models/NotificationService.ts

@@ -0,0 +1,26 @@
+import { Model } from '@nocobase/database';
+import nodemailer from 'nodemailer';
+
+export class NotificationService extends Model {
+  [key: string]: any;
+
+  static createTransport = nodemailer.createTransport;
+
+  private _transporter = null;
+
+  get transporter() {
+    if (this._transporter) {
+      return this._transporter;
+    }
+    return (this._transporter = NotificationService.createTransport(this.options));
+  }
+
+  async send(options) {
+    const { from } = this.options;
+    const mailOptions = {
+      from,
+      ...options,
+    };
+    return this.transporter.sendMail(mailOptions);
+  }
+}

package/src/server/models/index.ts

@@ -0,0 +1,3 @@
+export * from './Notification';
+export * from './NotificationLog';
+export * from './NotificationService';

package/src/server/server.ts

@@ -0,0 +1,10 @@
+import { Plugin } from '@nocobase/server';
+import path from 'path';
+
+export default class PluginNotifications extends Plugin {
+  async load() {
+    await this.app.db.import({
+      directory: path.resolve(__dirname, 'collections'),
+    });
+  }
+}