@nocobase/plugin-users 0.12.0-alpha.5 → 0.13.0-alpha.1

package/dist/server/collections/users.js

@@ -33,6 +33,19 @@ var users_default = {
         "x-component": "Input"
       }
     },
+    {
+      interface: "username",
+      type: "string",
+      name: "username",
+      unique: true,
+      uiSchema: {
+        type: "string",
+        title: '{{t("Username")}}',
+        "x-component": "Input",
+        "x-validator": { username: true },
+        required: true
+      }
+    },
     {
       interface: "email",
       type: "string",

package/dist/server/migrations/20230802170800-add-username.d.ts

@@ -0,0 +1,5 @@
+import { Migration } from '@nocobase/server';
+export default class AddUserNameMigration extends Migration {
+    up(): Promise<void>;
+    down(): Promise<void>;
+}

package/dist/server/migrations/20230802170800-add-username.js

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

package/dist/server/migrations/20230802183100-update-username.d.ts

@@ -0,0 +1,5 @@
+import { Migration } from '@nocobase/server';
+export default class UpdateUserNameMigration extends Migration {
+    up(): Promise<void>;
+    down(): Promise<void>;
+}

package/dist/server/migrations/20230802183100-update-username.js

@@ -0,0 +1,33 @@
+'use strict';
+
+var server = require('@nocobase/server');
+
+class UpdateUserNameMigration extends server.Migration {
+  async up() {
+    const match = await this.app.version.satisfies("<=0.12.0-alpha.4");
+    if (!match) {
+      return;
+    }
+    const repo = this.context.db.getRepository("users");
+    const user = await repo.findOne({
+      filter: {
+        email: "admin@nocobase.com",
+        username: null
+      }
+    });
+    if (user) {
+      await repo.update({
+        values: {
+          username: process.env.INIT_ROOT_USERNAME || "nocobase"
+        },
+        filter: {
+          id: user.id
+        }
+      });
+    }
+  }
+  async down() {
+  }
+}
+
+module.exports = UpdateUserNameMigration;

package/dist/server/server.d.ts

@@ -16,6 +16,7 @@ export default class UsersPlugin extends Plugin<UserPluginConfig> {
         rootEmail: any;
         rootPassword: any;
         rootNickname: any;
+        rootUsername: any;
     };
     install(options: any): Promise<void>;
     initVerification(): Promise<void>;

package/dist/server/server.js

@@ -45,6 +45,7 @@ class UsersPlugin extends server.Plugin {
     this.app.i18n.addResources("en-US", _.namespace, locale.enUS);
     const cmd = this.app.findCommand("install");
     if (cmd) {
+      cmd.requiredOption("-u, --root-username <rootUsername>", "", process.env.INIT_ROOT_USERNAME);
       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>");
@@ -142,20 +143,22 @@ class UsersPlugin extends server.Plugin {
   }
   getInstallingData(options = {}) {
     var _a;
-    const { INIT_ROOT_NICKNAME, INIT_ROOT_PASSWORD, INIT_ROOT_EMAIL } = process.env;
+    const { INIT_ROOT_NICKNAME, INIT_ROOT_PASSWORD, INIT_ROOT_EMAIL, INIT_ROOT_USERNAME } = process.env;
     const {
       rootEmail = INIT_ROOT_EMAIL,
       rootPassword = INIT_ROOT_PASSWORD,
-      rootNickname = INIT_ROOT_NICKNAME || "Super Admin"
+      rootNickname = INIT_ROOT_NICKNAME || "Super Admin",
+      rootUsername = INIT_ROOT_USERNAME || "nocobase"
     } = options.users || ((_a = options == null ? void 0 : options.cliArgs) == null ? void 0 : _a[0]) || {};
     return {
       rootEmail,
       rootPassword,
-      rootNickname
+      rootNickname,
+      rootUsername
     };
   }
   async install(options) {
-    const { rootNickname, rootPassword, rootEmail } = this.getInstallingData(options);
+    const { rootNickname, rootPassword, rootEmail, rootUsername } = this.getInstallingData(options);
     const User = this.db.getCollection("users");
     if (await User.repository.findOne({ filter: { email: rootEmail } })) {
       return;
@@ -164,7 +167,8 @@ class UsersPlugin extends server.Plugin {
       values: {
         email: rootEmail,
         password: rootPassword,
-        nickname: rootNickname
+        nickname: rootNickname,
+        username: rootUsername
       }
     });
     const repo = this.db.getRepository("collections");

package/dist/swagger/index.js

@@ -0,0 +1,131 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var openapi = "3.0.2";
+var info = {
+  title: "NocoBase API - Users plugin"
+};
+var tags = [];
+var paths = {
+  "/users:list": {
+    get: {
+      tags: ["users"],
+      description: "",
+      parameters: [],
+      responses: {
+        "200": {
+          description: "OK"
+        }
+      }
+    }
+  },
+  "/users:get": {
+    get: {
+      tags: ["users"],
+      description: "",
+      parameters: [],
+      responses: {
+        "200": {
+          description: "OK"
+        }
+      }
+    }
+  },
+  "/users:create": {
+    post: {
+      tags: ["users"],
+      description: "",
+      parameters: [],
+      responses: {
+        "200": {
+          description: "OK"
+        }
+      }
+    }
+  },
+  "/users:update": {
+    post: {
+      tags: ["users"],
+      description: "",
+      parameters: [],
+      responses: {
+        "200": {
+          description: "OK"
+        }
+      }
+    }
+  },
+  "/users:updateProfile": {
+    post: {
+      tags: ["users"],
+      description: "",
+      parameters: [],
+      responses: {
+        "200": {
+          description: "OK"
+        }
+      }
+    }
+  },
+  "/users:changePassword": {
+    post: {
+      tags: ["users"],
+      description: "",
+      parameters: [],
+      responses: {
+        "200": {
+          description: "OK"
+        }
+      }
+    }
+  },
+  "/users:destroy": {
+    post: {
+      tags: ["users"],
+      description: "",
+      parameters: [],
+      responses: {
+        "200": {
+          description: "OK"
+        }
+      }
+    }
+  },
+  "/{collectionName}/{collectionIndex}/createdBy:get": {
+    post: {
+      tags: ["$collection.createdBy"],
+      description: "",
+      parameters: [],
+      responses: {
+        "200": {
+          description: "OK"
+        }
+      }
+    }
+  },
+  "/{collectionName}/{collectionIndex}/updatedBy:get": {
+    post: {
+      tags: ["$collection.updatedBy"],
+      description: "",
+      parameters: [],
+      responses: {
+        "200": {
+          description: "OK"
+        }
+      }
+    }
+  }
+};
+var swagger_default = {
+  openapi,
+  info,
+  tags,
+  paths
+};
+
+exports.default = swagger_default;
+exports.info = info;
+exports.openapi = openapi;
+exports.paths = paths;
+exports.tags = tags;

package/package.json

@@ -4,7 +4,7 @@
   "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.5",
+  "version": "0.13.0-alpha.1",
   "license": "AGPL-3.0",
   "main": "./dist/server/index.js",
   "devDependencies": {
@@ -22,5 +22,5 @@
     "@nocobase/test": "0.x",
     "@nocobase/utils": "0.x"
   },
-  "gitHead": "689cc16e83361c4d0b91907e0deac30bdb907692"
+  "gitHead": "0ebd4e85a1b0b0d0943768ab6cb5c3d824562239"
 }