@nocobase/plugin-users 0.11.1-alpha.4 → 0.12.0-alpha.1

package/dist/server/migrations/20220818072639-add-users-phone.js

@@ -0,0 +1,43 @@
+'use strict';
+
+var server = require('@nocobase/server');
+
+class AddUsersPhoneMigration extends server.Migration {
+  async up() {
+    const match = await this.app.version.satisfies("<=0.7.4-alpha.7");
+    if (!match) {
+      return;
+    }
+    const Field = this.context.db.getRepository("fields");
+    const existed = await Field.count({
+      filter: {
+        name: "phone",
+        collectionName: "users"
+      }
+    });
+    if (!existed) {
+      await Field.create({
+        values: {
+          name: "phone",
+          collectionName: "users",
+          type: "string",
+          unique: true,
+          interface: "phone",
+          uiSchema: {
+            type: "string",
+            title: '{{t("Phone")}}',
+            "x-component": "Input",
+            "x-validator": "phone",
+            require: true
+          }
+        },
+        // NOTE: to trigger hook
+        context: {}
+      });
+    }
+  }
+  async down() {
+  }
+}
+
+module.exports = AddUsersPhoneMigration;

package/dist/server/server.js

@@ -0,0 +1,249 @@
+'use strict';
+
+var database = require('@nocobase/database');
+var server = require('@nocobase/server');
+var utils = require('@nocobase/utils');
+var path = require('path');
+var _ = require('./');
+var actions = require('./actions/users');
+var initAuthenticators = require('./authenticators');
+var jwtService = require('./jwt-service');
+var locale = require('./locale');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+
+var actions__namespace = /*#__PURE__*/_interopNamespace(actions);
+var initAuthenticators__default = /*#__PURE__*/_interopDefault(initAuthenticators);
+
+class UsersPlugin extends server.Plugin {
+  jwtService;
+  authenticators = new utils.Registry();
+  constructor(app, options) {
+    super(app, options);
+    this.jwtService = new jwtService.JwtService((options == null ? void 0 : options.jwt) || {});
+  }
+  async beforeLoad() {
+    this.app.i18n.addResources("zh-CN", _.namespace, locale.zhCN);
+    this.app.i18n.addResources("en-US", _.namespace, locale.enUS);
+    const cmd = this.app.findCommand("install");
+    if (cmd) {
+      cmd.requiredOption("-e, --root-email <rootEmail>", "", process.env.INIT_ROOT_EMAIL);
+      cmd.requiredOption("-p, --root-password <rootPassword>", "", process.env.INIT_ROOT_PASSWORD);
+      cmd.option("-n, --root-nickname <rootNickname>");
+    }
+    this.db.registerOperators({
+      $isCurrentUser(_, ctx) {
+        var _a, _b, _c, _d;
+        return {
+          [database.Op.eq]: ((_d = (_c = (_b = (_a = ctx == null ? void 0 : ctx.app) == null ? void 0 : _a.ctx) == null ? void 0 : _b.state) == null ? void 0 : _c.currentUser) == null ? void 0 : _d.id) || -1
+        };
+      },
+      $isNotCurrentUser(_, ctx) {
+        var _a, _b, _c, _d;
+        return {
+          [database.Op.ne]: ((_d = (_c = (_b = (_a = ctx == null ? void 0 : ctx.app) == null ? void 0 : _a.ctx) == null ? void 0 : _b.state) == null ? void 0 : _c.currentUser) == null ? void 0 : _d.id) || -1
+        };
+      },
+      $isVar(val, ctx) {
+        var _a, _b;
+        const obj = utils.parse({ val: `{{${val}}}` })(JSON.parse(JSON.stringify((_b = (_a = ctx == null ? void 0 : ctx.app) == null ? void 0 : _a.ctx) == null ? void 0 : _b.state)));
+        return {
+          [database.Op.eq]: obj.val
+        };
+      }
+    });
+    this.db.on("afterDefineCollection", (collection) => {
+      const { createdBy, updatedBy } = collection.options;
+      if (createdBy === true) {
+        collection.setField("createdById", {
+          type: "context",
+          dataType: "bigInt",
+          dataIndex: "state.currentUser.id",
+          createOnly: true,
+          visible: true,
+          index: true
+        });
+        collection.setField("createdBy", {
+          type: "belongsTo",
+          target: "users",
+          foreignKey: "createdById",
+          targetKey: "id"
+        });
+      }
+      if (updatedBy === true) {
+        collection.setField("updatedById", {
+          type: "context",
+          dataType: "bigInt",
+          dataIndex: "state.currentUser.id",
+          visible: true,
+          index: true
+        });
+        collection.setField("updatedBy", {
+          type: "belongsTo",
+          target: "users",
+          foreignKey: "updatedById",
+          targetKey: "id"
+        });
+      }
+    });
+    for (const [key, action] of Object.entries(actions__namespace)) {
+      this.app.resourcer.registerActionHandler(`users:${key}`, action);
+    }
+    this.app.acl.addFixedParams("users", "destroy", () => {
+      return {
+        filter: {
+          "id.$ne": 1
+        }
+      };
+    });
+    this.app.acl.addFixedParams("collections", "destroy", () => {
+      return {
+        filter: {
+          "name.$ne": "users"
+        }
+      };
+    });
+    const publicActions = ["check", "signin", "signup", "lostpassword", "resetpassword", "getUserByResetToken"];
+    const loggedInActions = ["signout", "updateProfile", "changePassword"];
+    publicActions.forEach((action) => this.app.acl.allow("users", action));
+    loggedInActions.forEach((action) => this.app.acl.allow("users", action, "loggedIn"));
+    this.app.on("beforeStart", () => this.initVerification());
+  }
+  async load() {
+    await this.db.import({
+      directory: path.resolve(__dirname, "collections")
+    });
+    this.db.addMigrations({
+      namespace: "users",
+      directory: path.resolve(__dirname, "migrations"),
+      context: {
+        plugin: this
+      }
+    });
+    initAuthenticators__default.default(this);
+  }
+  getInstallingData(options = {}) {
+    var _a;
+    const { INIT_ROOT_NICKNAME, INIT_ROOT_PASSWORD, INIT_ROOT_EMAIL } = process.env;
+    const {
+      rootEmail = INIT_ROOT_EMAIL,
+      rootPassword = INIT_ROOT_PASSWORD,
+      rootNickname = INIT_ROOT_NICKNAME || "Super Admin"
+    } = options.users || ((_a = options == null ? void 0 : options.cliArgs) == null ? void 0 : _a[0]) || {};
+    return {
+      rootEmail,
+      rootPassword,
+      rootNickname
+    };
+  }
+  async install(options) {
+    const { rootNickname, rootPassword, rootEmail } = this.getInstallingData(options);
+    const User = this.db.getCollection("users");
+    if (await User.repository.findOne({ filter: { email: rootEmail } })) {
+      return;
+    }
+    await User.repository.create({
+      values: {
+        email: rootEmail,
+        password: rootPassword,
+        nickname: rootNickname
+      }
+    });
+    const repo = this.db.getRepository("collections");
+    if (repo) {
+      await repo.db2cm("users");
+    }
+  }
+  // TODO(module): should move to preset or dynamic configuration panel
+  async initVerification() {
+    const verificationPlugin = this.app.getPlugin("verification");
+    if (!verificationPlugin) {
+      return;
+    }
+    const systemSettingsRepo = this.db.getRepository("systemSettings");
+    const settings = await systemSettingsRepo.findOne();
+    if (!settings.smsAuthEnabled) {
+      return;
+    }
+    verificationPlugin.interceptors.register("users:signin", {
+      manual: true,
+      getReceiver(ctx) {
+        return ctx.action.params.values.phone;
+      },
+      expiresIn: 120,
+      validate: async (ctx, phone) => {
+        if (!phone) {
+          throw new Error(ctx.t("Not a valid cellphone number, please re-enter"));
+        }
+        const User = this.db.getCollection("users");
+        const exists = await User.model.count({
+          where: {
+            phone
+          }
+        });
+        if (!exists) {
+          throw new Error(ctx.t("The phone number is not registered, please register first", { ns: _.namespace }));
+        }
+        return true;
+      }
+    });
+    verificationPlugin.interceptors.register("users:signup", {
+      getReceiver(ctx) {
+        return ctx.action.params.values.phone;
+      },
+      expiresIn: 120,
+      validate: async (ctx, phone) => {
+        if (!phone) {
+          throw new Error(ctx.t("Not a valid cellphone number, please re-enter", { ns: _.namespace }));
+        }
+        const User = this.db.getCollection("users");
+        const exists = await User.model.count({
+          where: {
+            phone
+          }
+        });
+        if (exists) {
+          throw new Error(ctx.t("The phone number has been registered, please login directly", { ns: _.namespace }));
+        }
+        return true;
+      }
+    });
+    this.authenticators.register(
+      "sms",
+      (ctx, next) => verificationPlugin.intercept(ctx, async () => {
+        const { values } = ctx.action.params;
+        const User = ctx.db.getCollection("users");
+        const user = await User.model.findOne({
+          where: {
+            phone: values.phone
+          }
+        });
+        if (!user) {
+          return ctx.throw(404, ctx.t("The phone number is incorrect, please re-enter", { ns: _.namespace }));
+        }
+        ctx.state.currentUser = user;
+        return next();
+      })
+    );
+  }
+}
+
+module.exports = UsersPlugin;

package/package.json

@@ -1,37 +1,26 @@
 {
   "name": "@nocobase/plugin-users",
   "displayName": "users",
-  "displayName.zh-CN": "用户管理",
-  "description": "manage the uses of nocobase system",
-  "description.zh-CN": "管理系统用户",
-  "version": "0.11.1-alpha.4",
+  "displayName.zh-CN": "用户",
+  "description": "Provide a basic user model and a password-based user authentication type, and extended the createdBy and updatedBy field types",
+  "description.zh-CN": "提供了基础的用户模型和基于密码的用户认证方式，并拓展了创建人和最后更新人字段类型",
+  "version": "0.12.0-alpha.1",
   "license": "AGPL-3.0",
-  "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": {
+  "main": "./dist/server/index.js",
+  "devDependencies": {
     "@types/jsonwebtoken": "^8.5.8",
     "jsonwebtoken": "^8.5.1"
   },
-  "devDependencies": {
-    "@nocobase/actions": "0.11.1-alpha.4",
-    "@nocobase/client": "0.11.1-alpha.4",
-    "@nocobase/database": "0.11.1-alpha.4",
-    "@nocobase/plugin-acl": "0.11.1-alpha.4",
-    "@nocobase/plugin-auth": "0.11.1-alpha.4",
-    "@nocobase/resourcer": "0.11.1-alpha.4",
-    "@nocobase/server": "0.11.1-alpha.4",
-    "@nocobase/test": "0.11.1-alpha.4",
-    "@nocobase/utils": "0.11.1-alpha.4"
+  "peerDependencies": {
+    "@nocobase/actions": "0.x",
+    "@nocobase/client": "0.x",
+    "@nocobase/database": "0.x",
+    "@nocobase/plugin-acl": "0.x",
+    "@nocobase/plugin-auth": "0.x",
+    "@nocobase/resourcer": "0.x",
+    "@nocobase/server": "0.x",
+    "@nocobase/test": "0.x",
+    "@nocobase/utils": "0.x"
   },
-  "gitHead": "d9b5bde913013f1057e1aab49587eb0ad3dcb06e"
+  "gitHead": "543dcc0216b7b1451b552b0f685bc3e0682f9d59"
 }

package/lib/client/index.js

@@ -1,22 +0,0 @@
-"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 UsersPlugin extends _client().Plugin {
-  load() {
-    return _asyncToGenerator(function* () {})();
-  }
-}
-var _default = UsersPlugin;
-exports.default = _default;

package/lib/index.js

@@ -1,13 +0,0 @@
-"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/locale/en-US.js

@@ -1,15 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _default = {
-  'The email is incorrect, please re-enter': 'The email is incorrect, please re-enter',
-  'Please fill in your email address': 'Please fill in your email address',
-  'The password is incorrect, please re-enter': 'The password is incorrect, please re-enter',
-  'Not a valid cellphone number, please re-enter': 'Not a valid cellphone number, please re-enter',
-  'The phone number has been registered, please login directly': 'The phone number has been registered, please login directly',
-  'The phone number is not registered, please register first': 'The phone number is not registered, please register first'
-};
-exports.default = _default;

package/lib/locale/es-ES.js

@@ -1,15 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _default = {
-  "The email is incorrect, please re-enter": "El correo electrónico es incorrecto, por favor vuelva a introducirlo",
-  "Please fill in your email address": "Por favor, introduzca su dirección de correo electrónico",
-  "The password is incorrect, please re-enter": "La contraseña es incorrecta, por favor, vuelva a introducirla",
-  "Not a valid cellphone number, please re-enter": "No es un número de móvil válido, por favor, vuelva a introducirlo",
-  "The phone number has been registered, please login directly": "El número de teléfono ha sido registrado, por favor, inicie sesión directamente",
-  "The phone number is not registered, please register first": "El número de teléfono no está registrado, por favor regístrese primero"
-};
-exports.default = _default;

package/lib/locale/fr-FR.js

@@ -1,15 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _default = {
-  'The email is incorrect, please re-enter': "L'adresse e-mail est incorrecte, veuillez la saisir à nouveau",
-  'Please fill in your email address': 'Veuillez remplir votre adresse e-mail',
-  'The password is incorrect, please re-enter': 'Le mot de passe est incorrect, veuillez le saisir à nouveau',
-  'Not a valid cellphone number, please re-enter': 'Numéro de téléphone portable invalide, veuillez le saisir à nouveau',
-  'The phone number has been registered, please login directly': 'Le numéro de téléphone a été enregistré, veuillez vous connecter directement',
-  'The phone number is not registered, please register first': "Le numéro de téléphone n'est pas enregistré, veuillez vous inscrire d'abord"
-};
-exports.default = _default;

package/lib/locale/ja-JP.js

@@ -1,11 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _default = {
-  'Please fill in your email address': 'メールアドレスを入力してください',
-  'The password is incorrect, please re-enter': 'パスワードが正しくありません。再度入力してください。'
-};
-exports.default = _default;

package/lib/locale/pt-BR.js

@@ -1,15 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _default = {
-  'The email is incorrect, please re-enter': 'O e-mail está incorreto, por favor, digite novamente',
-  'Please fill in your email address': 'Por favor, preencha o seu endereço de e-mail',
-  'The password is incorrect, please re-enter': 'A senha está incorreta, por favor, digite novamente',
-  'Not a valid cellphone number, please re-enter': 'Número de celular inválido, por favor, digite novamente',
-  'The phone number has been registered, please login directly': 'O número de celular já está registrado, por favor, faça login diretamente',
-  'The phone number is not registered, please register first': 'O número de celular não está registrado, por favor, registre-se primeiro'
-};
-exports.default = _default;

package/lib/locale/zh-CN.js

@@ -1,15 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _default = {
-  'The email is incorrect, please re-enter': '邮箱有误，请重新输入',
-  'Please fill in your email address': '请填写邮箱',
-  'The password is incorrect, please re-enter': '密码有误，请重新输入',
-  'Not a valid cellphone number, please re-enter': '不是有效的手机号，请重新输入',
-  'The phone number has been registered, please login directly': '手机号已注册，请直接登录',
-  'The phone number is not registered, please register first': '手机号未注册，请先注册'
-};
-exports.default = _default;