fix: 登录页

.npmignore

@@ -1,2 +1,2 @@
 /node_modules
-/src
+/src

README.md

@@ -1 +1,117 @@
-# @nocobase-sample/plugin-shared-forms
+# Auth
+
+提供基础认证功能和扩展认证器管理功能。
+
+## 使用方法
+
+### 认证器管理
+页面：系统设置 - 认证
+
+
+<img src="https://s2.loli.net/2023/05/15/NdriQZvBuE6hGRS.png" width="800px" />
+
+#### 内置认证器
+- 名称：basic
+- 认证类型：邮箱密码登录
+
+<img src="https://s2.loli.net/2023/05/15/HC4gtx9fQPrqvac.png" width="300px" />
+
+<img src="https://s2.loli.net/2023/05/15/fcLqypdhOxnksbg.png" width="300px" />
+
+#### 增加认证器
+Add new - 选择认证类型
+
+<img src="https://s2.loli.net/2023/05/15/CR7UTDt2WzbEfgs.png" width="300px" />
+
+#### 启用/禁用
+Actions - Edit - 勾选/取消Enabled
+
+<img src="https://s2.loli.net/2023/05/15/2utpSHly9fzCKX5.png" width="400px" />
+
+#### 配置认证器
+Actions - Edit
+
+## 开发一个登录插件
+### 接口
+Nocobase内核提供了扩展登录方式的接入和管理。扩展登录插件的核心逻辑处理，需要继承内核的`Auth`类，并对相应的标准接口进行实现。
+参考`core/auth/auth.ts`
+
+```TypeScript
+import { Auth } from '@nocobase/auth';
+
+class CustomAuth extends Auth {
+  set user(user) {}
+  get user() {}
+
+  async check() {}
+  async signIn() {}
+}
+```
+
+多数情况下，扩展的用户登录方式也将沿用现有的jwt逻辑来生成用户访问API的凭证，插件也可以继承`BaseAuth`类以便复用部分逻辑代码，如`check`, `signIn`接口。
+
+```TypeScript
+import { BaseAuth } from '@nocobase/auth';
+
+class CustomAuth extends BaseAuth {
+  constructor(config: AuthConfig) {
+    const userCollection = config.ctx.db.getCollection('users');
+    super({ ...config, userCollection });
+  }
+
+  async validate() {}
+}
+```
+
+### 用户数据
+
+`@nocobase/plugin-auth`插件提供了`usersAuthenticators`表来建立users和authenticators，即用户和认证方式的关联。  
+通常情况下，扩展登录方式用`users`和`usersAuthenticators`来存储相应的用户数据即可，特殊情况下才需要自己新增Collection.  
+`users`存储的是最基础的用户数据，邮箱、昵称和密码。  
+`usersAuthenticators`存储扩展登录方式数据  
+- uuid: 该种认证方式的用户唯一标识，如手机号、微信openid等
+- meta: JSON字段，其他需要保存的信息
+- userId: 用户id
+- authenticator：认证器名字
+
+对于用户操作，`Authenticator`模型也提供了几个封装的方法，可以在`CustomAuth`类中通过`this.authenticator[方法名]`使用：
+- `findUser(uuid: string): UserModel` - 查询用户
+- `newUser(uuid: string, values?: any): UserModel` - 创建新用户
+- `findOrCreateUser(uuid: string, userValues?: any): UserModel` - 查找或创建新用户
+
+### 注册
+扩展的登录方式需要向内核注册。
+```TypeScript
+async load() {
+  this.app.authManager.registerTypes('custom-auth-type', {
+    auth: CustomAuth,
+  });
+}
+```
+
+### 客户端API
+#### OptionsComponentProvider
+可供用户配置的认证器配置项
+- authType 认证方式
+- component 配置组件
+```TypeScript
+<OptionsComponentProvider authType="custom-auth-type" component={Options} /> 
+```
+
+`Options`组件使用的值是`authenticator`的`options`字段，如果有需要暴露在前端的配置，应该放在`options.public`字段中。`authenticators:publicList`接口会返回`options.public`字段的值。
+
+#### SigninPageProvider
+自定义登录页界面
+- authType 认证方式
+- tabTitle 登录页tab标题
+- component 登录页组件
+
+#### SignupPageProvider 
+自定义注册页界面
+- authType 认证方式
+- component 注册页组件 
+
+#### SigninPageExtensionProvider
+自定义登录页下方的扩展内容
+- authType 认证方式
+- component 扩展组件

client.js

@@ -1 +1,65 @@
-module.exports = require('./dist/client/index.js');
+'use strict';
+
+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;
+}
+
+var _index = _interopRequireWildcard(require('./dist/client'));
+
+Object.defineProperty(exports, '__esModule', {
+  value: true,
+});
+var _exportNames = {};
+Object.defineProperty(exports, 'default', {
+  enumerable: true,
+  get: function get() {
+    return _index.default;
+  },
+});
+
+Object.keys(_index).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _index[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index[key];
+    },
+  });
+});

package.json

@@ -1,11 +1,31 @@
 {
-  "name": "@nocobase/plugin-shared-forms",
+  "name": "@LeWanYun/plugin-login",
   "version": "1.3.0-alpha",
-  "main": "dist/server/index.js",
-  "dependencies": {},
+  "main": "./dist/server/index.js",
+  "devDependencies": {
+    "@ant-design/icons": "5.x",
+    "@formily/react": "2.x",
+    "@formily/shared": "2.x",
+    "@types/cron": "^2.0.1",
+    "antd": "5.x",
+    "cron": "^2.3.1",
+    "react": "^18.2.0",
+    "react-i18next": "^11.15.1"
+  },
   "peerDependencies": {
+    "@nocobase/actions": "1.x",
+    "@nocobase/auth": "1.x",
     "@nocobase/client": "1.x",
+    "@nocobase/database": "1.x",
     "@nocobase/server": "1.x",
     "@nocobase/test": "1.x"
-  }
+  },
+  "displayName": "Authentication",
+  "displayName.zh-CN": "LW用户认证",
+  "description": "User authentication management, including password, SMS, and support for Single Sign-On (SSO) protocols, with extensibility.",
+  "description.zh-CN": "用户认证管理，包括基础的密码认证、短信认证、SSO 协议的认证等，可扩展。",
+  "gitHead": "d0b4efe4be55f8c79a98a331d99d9f8cf99021a1",
+  "keywords": [
+    "Authentication"
+  ]
 }

server.js

@@ -1 +1,65 @@
-module.exports = require('./dist/server/index.js');
+'use strict';
+
+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;
+}
+
+var _index = _interopRequireWildcard(require('./dist/server'));
+
+Object.defineProperty(exports, '__esModule', {
+  value: true,
+});
+var _exportNames = {};
+Object.defineProperty(exports, 'default', {
+  enumerable: true,
+  get: function get() {
+    return _index.default;
+  },
+});
+
+Object.keys(_index).forEach(function (key) {
+  if (key === 'default' || key === '__esModule') return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _index[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _index[key];
+    },
+  });
+});

src/client/AuthProvider.tsx

@@ -0,0 +1,33 @@
+/**
+ * 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 { useApp } from '@nocobase/client';
+import React, { useEffect } from 'react';
+import { useLocation } from 'react-router-dom';
+import { LWAuthProvider } from './basic/code';
+
+export const AuthProvider: React.FC = (props) => {
+  const location = useLocation();
+  const app = useApp();
+
+  useEffect(() => {
+    const params = new URLSearchParams(location.search);
+    const authenticator = params.get('authenticator');
+    const token = params.get('token');
+    if (token) {
+      app.apiClient.auth.setToken(token);
+      app.apiClient.auth.setAuthenticator(authenticator);
+    }
+  });
+  return (
+    <LWAuthProvider>
+      <>{props.children}</>
+    </LWAuthProvider>
+  );
+};

src/client/__e2e__/auth.test.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 { expect, test } from '@nocobase/test/e2e';
+
+test.describe('auth', () => {
+  // 重置登录状态
+  test.use({
+    storageState: {
+      cookies: [],
+      origins: [],
+    },
+  });
+
+  test('register', async ({ page }) => {
+    await page.goto('/');
+    await page.getByRole('link', { name: 'Create an account' }).click();
+    await page.getByPlaceholder('Username').click();
+    await page.getByPlaceholder('Username').fill('zidonghuaceshi');
+    await page.getByPlaceholder('Password', { exact: true }).click();
+    await page.getByPlaceholder('Password', { exact: true }).fill('zidonghuaceshi123');
+    await page.getByPlaceholder('Confirm password').click();
+    await page.getByPlaceholder('Confirm password').fill('zidonghuaceshi123');
+    await page.getByRole('button', { name: 'Sign up' }).click();
+
+    await expect(page.getByText('Sign up successfully, and automatically jump to the sign in page')).toBeVisible();
+
+    // 用新账户登录
+    await page.getByPlaceholder('Username/Email').click();
+    await page.getByPlaceholder('Username/Email').fill('zidonghuaceshi');
+    await page.getByPlaceholder('Password').click();
+    await page.getByPlaceholder('Password').fill('zidonghuaceshi123');
+    await page.getByRole('button', { name: 'Sign in' }).click();
+
+    await page.getByTestId('user-center-button').hover();
+    await expect(page.getByText('zidonghuaceshi')).toBeVisible();
+  });
+});