@nocobase/plugin-verification 1.7.0-beta.9 → 1.8.0-alpha.1

package/dist/server/Plugin.d.ts

@@ -9,9 +9,12 @@
 import { Plugin } from '@nocobase/server';
 import { VerificationManager } from './verification-manager';
 import { SMSOTPProviderManager } from './otp-verification/sms';
+import { Counter } from '@nocobase/cache';
 export default class PluginVerficationServer extends Plugin {
     verificationManager: VerificationManager;
     smsOTPProviderManager: SMSOTPProviderManager;
+    smsOTPCounter: Counter;
+    afterAdd(): Promise<void>;
     load(): Promise<void>;
     install(): Promise<void>;
 }

package/dist/server/Plugin.js

@@ -46,7 +46,7 @@ var import_constants = require("../constants");
 var import_verification_manager = require("./verification-manager");
 var import_sms = require("./otp-verification/sms");
 var import_constants2 = require("../constants");
-var import_verificators = __toESM(require("./actions/verificators"));
+var import_verifiers = __toESM(require("./actions/verifiers"));
 var import_sms_aliyun = __toESM(require("./otp-verification/sms/providers/sms-aliyun"));
 var import_sms_tencent = __toESM(require("./otp-verification/sms/providers/sms-tencent"));
 var import_sms_otp_providers = __toESM(require("./otp-verification/sms/resource/sms-otp-providers"));
@@ -54,22 +54,34 @@ var import_sms_otp = __toESM(require("./otp-verification/sms/resource/sms-otp"))
 class PluginVerficationServer extends import_server.Plugin {
   verificationManager = new import_verification_manager.VerificationManager({ db: this.db });
   smsOTPProviderManager = new import_sms.SMSOTPProviderManager();
+  smsOTPCounter;
+  async afterAdd() {
+    this.app.on("afterLoad", async () => {
+      this.smsOTPCounter = await this.app.cacheManager.createCounter(
+        {
+          name: "smsOTPCounter",
+          prefix: "sms-otp:attempts"
+        },
+        this.app.lockManager
+      );
+    });
+  }
   async load() {
     this.app.dataSourceManager.use(this.verificationManager.middleware());
     this.app.resourceManager.define(import_sms_otp_providers.default);
     this.app.resourceManager.define(import_sms_otp.default);
-    Object.entries(import_verificators.default).forEach(
-      ([action, handler]) => this.app.resourceManager.registerActionHandler(`verificators:${action}`, handler)
+    Object.entries(import_verifiers.default).forEach(
+      ([action, handler]) => this.app.resourceManager.registerActionHandler(`verifiers:${action}`, handler)
     );
-    this.app.acl.allow("verificators", "listByUser", "loggedIn");
-    this.app.acl.allow("verificators", "listForVerify", "loggedIn");
-    this.app.acl.allow("verificators", "bind", "loggedIn");
-    this.app.acl.allow("verificators", "unbind", "loggedIn");
+    this.app.acl.allow("verifiers", "listByUser", "loggedIn");
+    this.app.acl.allow("verifiers", "listForVerify", "loggedIn");
+    this.app.acl.allow("verifiers", "bind", "loggedIn");
+    this.app.acl.allow("verifiers", "unbind", "loggedIn");
     this.app.acl.allow("smsOTP", "create", "loggedIn");
     this.app.acl.allow("smsOTP", "publicCreate");
     this.app.acl.registerSnippet({
-      name: `pm.${this.name}.verificators`,
-      actions: ["verificators:*", "smsOTPProviders:*"]
+      name: `pm.${this.name}.verifiers`,
+      actions: ["verifiers:*", "smsOTPProviders:*"]
     });
     this.verificationManager.registerVerificationType(import_constants2.SMS_OTP_VERIFICATION_TYPE, {
       title: (0, import_utils.tval)("SMS OTP", { ns: import__.namespace }),
@@ -80,17 +92,17 @@ class PluginVerficationServer extends import_server.Plugin {
       verification: import_sms.SMSOTPVerification
     });
     this.verificationManager.addSceneRule(
-      (scene, verificationType) => ["auth-sms", "unbind-verificator"].includes(scene) && verificationType === import_constants2.SMS_OTP_VERIFICATION_TYPE
+      (scene, verificationType) => ["auth-sms", "unbind-verifier"].includes(scene) && verificationType === import_constants2.SMS_OTP_VERIFICATION_TYPE
     );
-    this.verificationManager.registerAction("verificators:bind", {
+    this.verificationManager.registerAction("verifiers:bind", {
       manual: true,
       getBoundInfoFromCtx: (ctx) => {
         return ctx.action.params.values || {};
       }
     });
-    this.verificationManager.registerScene("unbind-verificator", {
+    this.verificationManager.registerScene("unbind-verifier", {
       actions: {
-        "verificators:unbind": {}
+        "verifiers:unbind": {}
       }
     });
     this.smsOTPProviderManager.registerProvider(import_constants.PROVIDER_TYPE_SMS_ALIYUN, {

package/dist/server/actions/{verificators.js → verifiers.js}

@@ -34,13 +34,13 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
   mod
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var verificators_exports = {};
-__export(verificators_exports, {
-  default: () => verificators_default
+var verifiers_exports = {};
+__export(verifiers_exports, {
+  default: () => verifiers_default
 });
-module.exports = __toCommonJS(verificators_exports);
+module.exports = __toCommonJS(verifiers_exports);
 var import_package = __toESM(require("../../../package.json"));
-var verificators_default = {
+var verifiers_default = {
   listTypes: async (ctx, next) => {
     const plugin = ctx.app.pm.get("verification");
     ctx.body = plugin.verificationManager.listTypes();
@@ -51,16 +51,16 @@ var verificators_default = {
     const plugin = ctx.app.pm.get("verification");
     const verificationTypes = plugin.verificationManager.getVerificationTypesByScene(scene);
     if (!verificationTypes.length) {
-      ctx.body = { verificators: [], availableTypes: [] };
+      ctx.body = { verifiers: [], availableTypes: [] };
       return next();
     }
-    const verificators = await ctx.db.getRepository("verificators").find({
+    const verifiers = await ctx.db.getRepository("verifiers").find({
       filter: {
         verificationType: verificationTypes.map((item) => item.type)
       }
     });
     ctx.body = {
-      verificators: (verificators || []).map((item) => ({
+      verifiers: (verifiers || []).map((item) => ({
         name: item.name,
         title: item.title
       })),
@@ -75,22 +75,22 @@ var verificators_default = {
     const plugin = ctx.app.pm.get("verification");
     const verificationTypes = plugin.verificationManager.verificationTypes;
     const bindingRequiredTypes = Array.from(verificationTypes.getEntities()).filter(([, options]) => options.bindingRequired).map(([type]) => type);
-    const verificators = await ctx.db.getRepository("verificators").find({
+    const verifiers = await ctx.db.getRepository("verifiers").find({
       filter: {
         verificationType: bindingRequiredTypes
       }
     });
     const result = [];
-    for (const verificator of verificators) {
+    for (const verifier of verifiers) {
       try {
-        const verificationType = plugin.verificationManager.verificationTypes.get(verificator.verificationType);
-        const Verification = plugin.verificationManager.getVerification(verificator.verificationType);
-        const verification = new Verification({ ctx, verificator, options: verificator.options });
+        const verificationType = plugin.verificationManager.verificationTypes.get(verifier.verificationType);
+        const Verification = plugin.verificationManager.getVerification(verifier.verificationType);
+        const verification = new Verification({ ctx, verifier, options: verifier.options });
         const boundInfo = await verification.getPublicBoundInfo(ctx.auth.user.id);
         result.push({
-          ...verificator.dataValues,
-          title: verificator.title || verificationType.title,
-          description: verificator.description || verificationType.description,
+          ...verifier.dataValues,
+          title: verifier.title || verificationType.title,
+          description: verifier.description || verificationType.description,
           boundInfo
         });
       } catch (error) {
@@ -108,28 +108,28 @@ var verificators_default = {
       ctx.body = [];
       return next();
     }
-    const verificators = await ctx.db.getRepository("verificators").find({
+    const verifiers = await ctx.db.getRepository("verifiers").find({
       filter: {
         verificationType: verificationTypes.map((item) => item.type)
       }
     });
-    if (!verificators.length) {
+    if (!verifiers.length) {
       ctx.body = [];
       return next();
     }
     const result = [];
-    for (const verificator of verificators) {
-      const verificationType = plugin.verificationManager.verificationTypes.get(verificator.verificationType);
-      const Verification = plugin.verificationManager.getVerification(verificator.verificationType);
-      const verification = new Verification({ ctx, verificator, options: verificator.options });
+    for (const verifier of verifiers) {
+      const verificationType = plugin.verificationManager.verificationTypes.get(verifier.verificationType);
+      const Verification = plugin.verificationManager.getVerification(verifier.verificationType);
+      const verification = new Verification({ ctx, verifier, options: verifier.options });
       const publicBoundInfo = await verification.getPublicBoundInfo(ctx.auth.user.id);
       if (!(publicBoundInfo == null ? void 0 : publicBoundInfo.bound)) {
         continue;
       }
       result.push({
-        name: verificator.name,
-        title: verificator.title,
-        verificationType: verificator.verificationType,
+        name: verifier.name,
+        title: verifier.title,
+        verificationType: verifier.verificationType,
         verificationTypeTitle: verificationType == null ? void 0 : verificationType.title,
         boundInfo: publicBoundInfo
       });
@@ -138,21 +138,21 @@ var verificators_default = {
     await next();
   },
   bind: async (ctx, next) => {
-    const { verificator: name } = ctx.action.params.values || {};
+    const { verifier: name } = ctx.action.params.values || {};
     const user = ctx.auth.user;
     const verificationPlugin = ctx.app.pm.get("verification");
     const record = await verificationPlugin.verificationManager.getBoundRecord(user.id, name);
     if (record) {
-      return ctx.throw(400, ctx.t("You have already bound this verificator", { ns: import_package.default.name }));
+      return ctx.throw(400, ctx.t("You have already bound this verifier", { ns: import_package.default.name }));
     }
-    const verificator = await verificationPlugin.verificationManager.getVerificator(name);
-    if (!verificator) {
-      return ctx.throw(400, ctx.t("Invalid verificator"));
+    const verifier = await verificationPlugin.verificationManager.getVerifier(name);
+    if (!verifier) {
+      return ctx.throw(400, ctx.t("Invalid verifier"));
     }
-    const Verification = verificationPlugin.verificationManager.getVerification(verificator.verificationType);
-    const verification = new Verification({ ctx, verificator, options: verificator.options });
+    const Verification = verificationPlugin.verificationManager.getVerification(verifier.verificationType);
+    const verification = new Verification({ ctx, verifier, options: verifier.options });
     const { uuid, meta } = await verification.bind(user.id);
-    await verificator.addUser(user.id, {
+    await verifier.addUser(user.id, {
       through: {
         uuid,
         meta
@@ -162,14 +162,14 @@ var verificators_default = {
     await next();
   },
   unbind: async (ctx, next) => {
-    const { unbindVerificator: name } = ctx.action.params.values || {};
+    const { unbindVerifier: name } = ctx.action.params.values || {};
     const user = ctx.auth.user;
     const verificationPlugin = ctx.app.pm.get("verification");
-    const verificator = await verificationPlugin.verificationManager.getVerificator(name);
-    if (!verificator) {
-      return ctx.throw(400, ctx.t("Invalid verificator"));
+    const verifier = await verificationPlugin.verificationManager.getVerifier(name);
+    if (!verifier) {
+      return ctx.throw(400, ctx.t("Invalid verifier"));
     }
-    await verificator.removeUser(user.id);
+    await verifier.removeUser(user.id);
     await next();
   }
 };

package/dist/server/collections/otp-records.js

@@ -67,8 +67,8 @@ var otp_records_default = (0, import_database.defineCollection)({
     },
     {
       type: "belongsTo",
-      name: "verificator",
-      target: "verificators",
+      name: "verifier",
+      target: "verifiers",
       targetKey: "name"
     }
   ]

package/dist/server/collections/users-verificators.d.ts

@@ -6,9 +6,5 @@
  * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
-/**
- * Collection for user information of extended authentication methods,
- * such as saml, oicd, oauth, sms, etc.
- */
 declare const _default: import("@nocobase/database").CollectionOptions;
 export default _default;

package/dist/server/collections/users-verificators.js

@@ -31,7 +31,7 @@ __export(users_verificators_exports, {
 module.exports = __toCommonJS(users_verificators_exports);
 var import_database = require("@nocobase/database");
 var users_verificators_default = (0, import_database.defineCollection)({
-  migrationRules: ["schema-only", "overwrite", "skip"],
+  migrationRules: ["skip"],
   name: "usersVerificators",
   createdBy: true,
   updatedBy: true,

package/dist/server/collections/users-verifiers.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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.
+ */
+/**
+ * Collection for user information of extended authentication methods,
+ * such as saml, oicd, oauth, sms, etc.
+ */
+declare const _default: import("@nocobase/database").CollectionOptions;
+export default _default;

package/dist/server/collections/users-verifiers.js

@@ -0,0 +1,58 @@
+/**
+ * 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.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var users_verifiers_exports = {};
+__export(users_verifiers_exports, {
+  default: () => users_verifiers_default
+});
+module.exports = __toCommonJS(users_verifiers_exports);
+var import_database = require("@nocobase/database");
+var users_verifiers_default = (0, import_database.defineCollection)({
+  migrationRules: ["schema-only", "overwrite", "skip"],
+  name: "usersVerifiers",
+  createdBy: true,
+  updatedBy: true,
+  logging: true,
+  fields: [
+    {
+      name: "uuid",
+      interface: "input",
+      type: "string",
+      allowNull: false,
+      uiSchema: {
+        type: "string",
+        title: '{{t("UUID")}}',
+        "x-component": "Input",
+        required: true
+      }
+    },
+    {
+      type: "json",
+      name: "meta",
+      defaultValue: {}
+    }
+  ]
+});

package/dist/server/collections/verificators.js

@@ -42,6 +42,6 @@ module.exports = __toCommonJS(verificators_exports);
 var import_database = require("@nocobase/database");
 var import_verificators = __toESM(require("../../collections/verificators"));
 var verificators_default = (0, import_database.defineCollection)({
-  migrationRules: ["overwrite", "skip"],
+  migrationRules: ["skip"],
   ...import_verificators.default
 });

package/dist/server/collections/verifiers.d.ts

@@ -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.
+ */
+declare const _default: import("@nocobase/database").CollectionOptions;
+export default _default;

package/dist/server/collections/verifiers.js

@@ -0,0 +1,47 @@
+/**
+ * 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.
+ */
+
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var verifiers_exports = {};
+__export(verifiers_exports, {
+  default: () => verifiers_default
+});
+module.exports = __toCommonJS(verifiers_exports);
+var import_database = require("@nocobase/database");
+var import_verifiers = __toESM(require("../../collections/verifiers"));
+var verifiers_default = (0, import_database.defineCollection)({
+  migrationRules: ["overwrite", "skip"],
+  ...import_verifiers.default
+});

package/dist/server/migrations/20250111192640-providers2verificators.js

@@ -35,9 +35,20 @@ var import_constants = require("../../constants");
 class providers2verificators_default extends import_server.Migration {
   on = "afterLoad";
   // 'beforeLoad' or 'afterLoad'
-  appVersion = "<1.6.1";
+  appVersion = "<1.7.0";
   async up() {
+    const verificatorsRepo = this.db.getRepository("verificators");
+    if (await verificatorsRepo.count()) {
+      return;
+    }
+    const repo = this.db.getRepository("verifications_providers");
+    if (!repo) {
+      return;
+    }
     const providers = await this.db.getRepository("verifications_providers").find();
+    if (!providers.length) {
+      return;
+    }
     const verificators = [];
     let defaultVerificator;
     providers.forEach((provider) => {
@@ -55,6 +66,9 @@ class providers2verificators_default extends import_server.Migration {
         defaultVerificator = verificator;
       }
     });
+    if (!defaultVerificator) {
+      defaultVerificator = verificators[0];
+    }
     const smsAuth = await this.db.getRepository("authenticators").find({
       filter: {
         authType: "SMS"
@@ -71,7 +85,7 @@ class providers2verificators_default extends import_server.Migration {
               ...item.options,
               public: {
                 ...(_a = item.options) == null ? void 0 : _a.public,
-                verificator: defaultVerificator.name
+                verificator: defaultVerificator == null ? void 0 : defaultVerificator.name
               }
             }
           },

package/dist/server/migrations/20250507220644-fix-verifier-typo.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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 { Migration } from '@nocobase/server';
+export default class extends Migration {
+    on: string;
+    appVersion: string;
+    up(): Promise<void>;
+}

package/dist/server/migrations/20250507220644-fix-verifier-typo.js

@@ -0,0 +1,86 @@
+/**
+ * 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.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var fix_verifier_typo_exports = {};
+__export(fix_verifier_typo_exports, {
+  default: () => fix_verifier_typo_default
+});
+module.exports = __toCommonJS(fix_verifier_typo_exports);
+var import_server = require("@nocobase/server");
+class fix_verifier_typo_default extends import_server.Migration {
+  on = "afterLoad";
+  // 'beforeLoad' or 'afterLoad'
+  appVersion = "<1.7.0";
+  async up() {
+    const oldRepo = await this.db.getRepository("verificators");
+    const newRepo = await this.db.getRepository("verifiers");
+    const oldThroughRepo = await this.db.getRepository("usersVerificators");
+    const newThroughRepo = await this.db.getRepository("usersVerifiers");
+    await this.db.sequelize.transaction(async (transaction) => {
+      if (await newRepo.count({ transaction })) {
+        return;
+      }
+      const oldRecords = await oldRepo.find({ transaction });
+      if (!oldRecords.length) {
+        return;
+      }
+      const newRecords = oldRecords.map((record) => ({
+        createdAt: record.createdAt,
+        updatedAt: record.updatedAt,
+        name: record.name,
+        title: record.title,
+        verificationType: record.verificationType,
+        description: record.description,
+        options: record.options
+      }));
+      const model = await this.db.getModel("verifiers");
+      await model.bulkCreate(newRecords, {
+        transaction
+      });
+      if (await newThroughRepo.count({ transaction })) {
+        return;
+      }
+      const oldThroughRecords = await oldThroughRepo.find({ transaction });
+      if (!oldThroughRecords.length) {
+        return;
+      }
+      const newThroughRecords = oldThroughRecords.map((record) => ({
+        createdAt: record.createdAt,
+        updatedAt: record.updatedAt,
+        userId: record.userId,
+        uuid: record.uuid,
+        meta: record.meta,
+        verifier: record.verificator,
+        createdById: record.createdById,
+        updatedById: record.updatedById
+      }));
+      const throughModel = await this.db.getModel("usersVerifiers");
+      await throughModel.bulkCreate(newThroughRecords, {
+        transaction
+      });
+    });
+  }
+}

package/dist/server/otp-verification/index.d.ts

@@ -9,6 +9,7 @@
 import { Verification } from '../verification';
 export declare class OTPVerification extends Verification {
     expiresIn: number;
+    maxVerifyAttempts: number;
     verify({ resource, action, boundInfo, verifyParams }: {
         resource: any;
         action: any;