@nocobase/plugin-verification 0.7.5-alpha.1

package/lib/collections/verifications.d.ts

@@ -0,0 +1,29 @@
+declare const _default: {
+    name: string;
+    fields: ({
+        type: string;
+        name: string;
+        primaryKey: boolean;
+        defaultValue?: undefined;
+        target?: undefined;
+    } | {
+        type: string;
+        name: string;
+        primaryKey?: undefined;
+        defaultValue?: undefined;
+        target?: undefined;
+    } | {
+        type: string;
+        name: string;
+        defaultValue: number;
+        primaryKey?: undefined;
+        target?: undefined;
+    } | {
+        type: string;
+        name: string;
+        target: string;
+        primaryKey?: undefined;
+        defaultValue?: undefined;
+    })[];
+};
+export default _default;

package/lib/collections/verifications.js

@@ -0,0 +1,35 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = {
+  name: 'verifications',
+  fields: [{
+    type: 'uuid',
+    name: 'id',
+    primaryKey: true
+  }, {
+    type: 'string',
+    name: 'type'
+  }, {
+    type: 'string',
+    name: 'receiver'
+  }, {
+    type: 'integer',
+    name: 'status',
+    defaultValue: 0
+  }, {
+    type: 'date',
+    name: 'expiresAt'
+  }, {
+    type: 'string',
+    name: 'content'
+  }, {
+    type: 'belongsTo',
+    name: 'provider',
+    target: 'verifications_providers'
+  }]
+};
+exports.default = _default;

package/lib/collections/verifications_providers.d.ts

@@ -0,0 +1,13 @@
+declare const _default: {
+    name: string;
+    fields: ({
+        type: string;
+        name: string;
+        primaryKey: boolean;
+    } | {
+        type: string;
+        name: string;
+        primaryKey?: undefined;
+    })[];
+};
+export default _default;

package/lib/collections/verifications_providers.js

@@ -0,0 +1,24 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = {
+  name: 'verifications_providers',
+  fields: [{
+    type: 'string',
+    name: 'id',
+    primaryKey: true
+  }, {
+    type: 'string',
+    name: 'title'
+  }, {
+    type: 'string',
+    name: 'type'
+  }, {
+    type: 'jsonb',
+    name: 'options'
+  }]
+};
+exports.default = _default;

package/lib/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const PROVIDER_TYPE_SMS_ALIYUN = "sms-aliyun";
+export declare const CODE_STATUS_UNUSED = 0;
+export declare const CODE_STATUS_USED = 1;

package/lib/constants.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.PROVIDER_TYPE_SMS_ALIYUN = exports.CODE_STATUS_USED = exports.CODE_STATUS_UNUSED = void 0;
+const PROVIDER_TYPE_SMS_ALIYUN = 'sms-aliyun';
+exports.PROVIDER_TYPE_SMS_ALIYUN = PROVIDER_TYPE_SMS_ALIYUN;
+const CODE_STATUS_UNUSED = 0;
+exports.CODE_STATUS_UNUSED = CODE_STATUS_UNUSED;
+const CODE_STATUS_USED = 1;
+exports.CODE_STATUS_USED = CODE_STATUS_USED;

package/lib/index.d.ts

@@ -0,0 +1,4 @@
+export * from './constants';
+export { Provider } from './providers';
+export { Interceptor, default } from './Plugin';
+export declare const namespace: any;

package/lib/index.js

@@ -0,0 +1,46 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  namespace: true,
+  Provider: true
+};
+Object.defineProperty(exports, "Provider", {
+  enumerable: true,
+  get: function get() {
+    return _providers.Provider;
+  }
+});
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function get() {
+    return _Plugin.default;
+  }
+});
+exports.namespace = void 0;
+
+var _constants = require("./constants");
+
+Object.keys(_constants).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _constants[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _constants[key];
+    }
+  });
+});
+
+var _providers = require("./providers");
+
+var _Plugin = _interopRequireDefault(require("./Plugin"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const namespace = require('../package.json').name;
+
+exports.namespace = namespace;

package/lib/locale/index.d.ts

@@ -0,0 +1 @@
+export { default as zhCN } from './zh-CN';

package/lib/locale/index.js

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

package/lib/locale/zh-CN.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    'Verification send failed, please try later or contact to administrator': string;
+    'Not a valid cellphone number, please re-enter': string;
+    "Please don't retry in {{time}} seconds": string;
+    'You are trying so frequently, please slow down': string;
+};
+export default _default;

package/lib/locale/zh-CN.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _default = {
+  'Verification send failed, please try later or contact to administrator': '验证码发送失败，请稍后重试或联系管理员',
+  'Not a valid cellphone number, please re-enter': '不是有效的手机号，请重新输入',
+  "Please don't retry in {{time}} seconds": '请 {{time}} 秒后再试',
+  'You are trying so frequently, please slow down': '您的操作太频繁，请稍后再试'
+};
+exports.default = _default;

package/lib/providers/index.d.ts

@@ -0,0 +1,14 @@
+import Plugin from '../Plugin';
+export declare class Provider {
+    protected plugin: Plugin;
+    protected options: any;
+    constructor(plugin: Plugin, options: any);
+    send(receiver: string, data: {
+        [key: string]: any;
+    }): Promise<any>;
+}
+interface Providers {
+    [key: string]: typeof Provider;
+}
+export default function (plugin: Plugin, more?: Providers): void;
+export {};

package/lib/providers/index.js

@@ -0,0 +1,84 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Provider = void 0;
+exports.default = _default;
+
+function _path() {
+  const data = _interopRequireDefault(require("path"));
+
+  _path = function _path() {
+    return data;
+  };
+
+  return data;
+}
+
+function _utils() {
+  const data = require("@nocobase/utils");
+
+  _utils = function _utils() {
+    return data;
+  };
+
+  return data;
+}
+
+var _constants = require("../constants");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+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; }
+
+function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
+
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+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 Provider {
+  constructor(plugin, options) {
+    this.plugin = void 0;
+    this.options = void 0;
+    this.plugin = plugin;
+    this.options = options;
+  }
+
+  send(receiver, data) {
+    return _asyncToGenerator(function* () {})();
+  }
+
+}
+
+exports.Provider = Provider;
+
+function _default(plugin, more = {}) {
+  const providers = plugin.providers;
+  const natives = [_constants.PROVIDER_TYPE_SMS_ALIYUN].reduce((result, key) => Object.assign(result, {
+    [key]: (0, _utils().requireModule)(_path().default.isAbsolute(key) ? key : _path().default.join(__dirname, key))
+  }), {});
+
+  for (var _i = 0, _Object$entries = Object.entries(_objectSpread(_objectSpread({}, more), natives)); _i < _Object$entries.length; _i++) {
+    const _Object$entries$_i = _slicedToArray(_Object$entries[_i], 2),
+          name = _Object$entries$_i[0],
+          provider = _Object$entries$_i[1];
+
+    providers.register(name, provider);
+  }
+}

package/lib/providers/sms-aliyun.d.ts

@@ -0,0 +1,7 @@
+import DysmsApi from '@alicloud/dysmsapi20170525';
+import { Provider } from '.';
+export default class extends Provider {
+    client: DysmsApi;
+    constructor(plugin: any, options: any);
+    send(phoneNumbers: any, data?: {}): Promise<never>;
+}

package/lib/providers/sms-aliyun.js

@@ -0,0 +1,111 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+function _dysmsapi() {
+  const data = _interopRequireWildcard(require("@alicloud/dysmsapi20170525"));
+
+  _dysmsapi = function _dysmsapi() {
+    return data;
+  };
+
+  return data;
+}
+
+function OpenApi() {
+  const data = _interopRequireWildcard(require("@alicloud/openapi-client"));
+
+  OpenApi = function OpenApi() {
+    return data;
+  };
+
+  return data;
+}
+
+function _teaUtil() {
+  const data = require("@alicloud/tea-util");
+
+  _teaUtil = function _teaUtil() {
+    return data;
+  };
+
+  return data;
+}
+
+var _ = require(".");
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+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 _default extends _.Provider {
+  constructor(plugin, options) {
+    super(plugin, options);
+    this.client = void 0;
+    const _this$options = this.options,
+          accessKeyId = _this$options.accessKeyId,
+          accessKeySecret = _this$options.accessKeySecret,
+          endpoint = _this$options.endpoint;
+    let config = new (OpenApi().Config)({
+      // 您的 AccessKey ID
+      accessKeyId: accessKeyId,
+      // 您的 AccessKey Secret
+      accessKeySecret: accessKeySecret
+    }); // 访问的域名
+
+    config.endpoint = endpoint;
+    this.client = new (_dysmsapi().default)(config);
+  }
+
+  send(phoneNumbers, data = {}) {
+    var _this = this;
+
+    return _asyncToGenerator(function* () {
+      const request = new (_dysmsapi().SendSmsRequest)({
+        phoneNumbers,
+        signName: _this.options.sign,
+        templateCode: _this.options.template,
+        templateParam: JSON.stringify(data)
+      });
+
+      try {
+        const _yield$_this$client$s = yield _this.client.sendSmsWithOptions(request, new (_teaUtil().RuntimeOptions)({})),
+              body = _yield$_this$client$s.body;
+
+        let err = new Error(body.message);
+
+        switch (body.code) {
+          case 'OK':
+            break;
+
+          case 'isv.MOBILE_NUMBER_ILLEGAL':
+            err.name = 'InvalidReceiver';
+            return Promise.reject(err);
+
+          case 'isv.BUSINESS_LIMIT_CONTROL':
+            err.name = 'RateLimit';
+            console.error(body);
+            return Promise.reject(err);
+
+          default:
+            // should not let user to know
+            console.error(body);
+            err.name = 'SendSMSFailed';
+            return Promise.reject(err);
+        }
+      } catch (error) {
+        return Promise.reject(error);
+      }
+    })();
+  }
+
+}
+
+exports.default = _default;

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@nocobase/plugin-verification",
+  "version": "0.7.5-alpha.1",
+  "main": "lib/index.js",
+  "license": "Apache-2.0",
+  "licenses": [
+    {
+      "type": "Apache-2.0",
+      "url": "http://www.apache.org/licenses/LICENSE-2.0"
+    }
+  ],
+  "dependencies": {
+    "@alicloud/dysmsapi20170525": "2.0.17",
+    "@alicloud/openapi-client": "0.4.1",
+    "@alicloud/tea-util": "1.4.4",
+    "@nocobase/actions": "0.7.5-alpha.1",
+    "@nocobase/resourcer": "0.7.5-alpha.1",
+    "@nocobase/server": "0.7.5-alpha.1",
+    "@nocobase/utils": "0.7.5-alpha.1"
+  },
+  "devDependencies": {
+    "@nocobase/test": "0.7.5-alpha.1"
+  },
+  "gitHead": "f6eb27b68185bb0c0b4c2cfca1df84205a9b9173"
+}

package/src/Plugin.ts

@@ -0,0 +1,141 @@
+import path from 'path';
+
+import { Plugin } from '@nocobase/server';
+import { Registry } from '@nocobase/utils';
+import { Op } from '@nocobase/database';
+import { HandlerType } from '@nocobase/resourcer';
+import { Context } from '@nocobase/actions';
+
+import initProviders, { Provider } from './providers';
+import initActions from './actions';
+import { CODE_STATUS_UNUSED, CODE_STATUS_USED, PROVIDER_TYPE_SMS_ALIYUN } from './constants';
+import { namespace } from '.';
+import { zhCN } from './locale';
+
+export interface Interceptor {
+  manual?: boolean;
+  provider: string;
+  expiresIn?: number;
+  getReceiver(ctx): string;
+  getCode?(ctx): string;
+  validate?(ctx: Context, receiver: string): boolean | Promise<boolean>;
+};
+
+export default class VerificationPlugin extends Plugin {
+  providers: Registry<typeof Provider> = new Registry();
+  interceptors: Registry<Interceptor> = new Registry();
+
+  intercept: HandlerType = async (context, next) => {
+    const { resourceName, actionName, values } = context.action.params;
+    const key = `${resourceName}:${actionName}`;
+    const interceptor = this.interceptors.get(key);
+
+    if (!interceptor) {
+      return context.throw(400);
+    }
+
+    const receiver = interceptor.getReceiver(context);
+    const content = interceptor.getCode ? interceptor.getCode(context) : values.code;
+    if (!receiver || !content) {
+      return context.throw(400);
+    }
+
+    // check if code match, then call next
+    // find the code based on action params
+    const VerificationRepo = this.db.getRepository('verifications');
+    const item = await VerificationRepo.findOne({
+      filter: {
+        receiver,
+        type: key,
+        content,
+        expiresAt: {
+          [Op.gt]: new Date()
+        },
+        status: CODE_STATUS_UNUSED
+      }
+    });
+
+    if (!item) {
+      return context.throw(400, { code: 'InvalidSMSCode', message: 'verify by sms code failed' });
+    }
+
+    // TODO: code should be removed if exists in values
+    // context.action.mergeParams({
+    //   values: {
+
+    //   }
+    // });
+
+    await next();
+
+    // or delete
+    await item.update({
+      status: CODE_STATUS_USED
+    });
+  }
+
+
+  getName(): string {
+    return this.getPackageName(__dirname);
+  }
+
+  async install() {
+    const {
+      DEFAULT_SMS_VERIFY_CODE_PROVIDER,
+      INIT_ALI_SMS_ACCESS_KEY,
+      INIT_ALI_SMS_ACCESS_KEY_SECRET,
+      INIT_ALI_SMS_ENDPOINT = 'dysmsapi.aliyuncs.com',
+      INIT_ALI_SMS_VERIFY_CODE_TEMPLATE,
+      INIT_ALI_SMS_VERIFY_CODE_SIGN
+    } = process.env;
+
+    if (INIT_ALI_SMS_ACCESS_KEY
+      && INIT_ALI_SMS_ACCESS_KEY_SECRET
+      && INIT_ALI_SMS_VERIFY_CODE_TEMPLATE
+      && INIT_ALI_SMS_VERIFY_CODE_SIGN
+    ) {
+      const ProviderRepo = this.db.getRepository('verifications_providers');
+      await ProviderRepo.create({
+        values: {
+          id: DEFAULT_SMS_VERIFY_CODE_PROVIDER,
+          type: PROVIDER_TYPE_SMS_ALIYUN,
+          title: 'Default SMS sender',
+          options: {
+            accessKeyId: INIT_ALI_SMS_ACCESS_KEY,
+            accessKeySecret: INIT_ALI_SMS_ACCESS_KEY_SECRET,
+            endpoint: INIT_ALI_SMS_ENDPOINT,
+            sign: INIT_ALI_SMS_VERIFY_CODE_SIGN,
+            template: INIT_ALI_SMS_VERIFY_CODE_TEMPLATE
+          }
+        }
+      });
+    }
+  }
+
+  async load() {
+    const { app, db, options } = this;
+
+    app.i18n.addResources('zh-CN', namespace, zhCN);
+
+    await db.import({
+      directory: path.resolve(__dirname, 'collections'),
+    });
+
+    initProviders(this);
+    initActions(this);
+
+    // add middleware to action
+    app.resourcer.use(async (context, next) => {
+      const { resourceName, actionName, values } = context.action.params;
+      const key = `${resourceName}:${actionName}`;
+      const interceptor = this.interceptors.get(key);
+      if (!interceptor || interceptor.manual) {
+        return next();
+      }
+
+      return this.intercept(context, next);
+    });
+
+    app.acl.allow('verifications', 'create');
+  }
+}