@nocobase/plugin-auth 0.10.0-alpha.2

package/README.md

@@ -0,0 +1,117 @@
+# 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 扩展组件

package/client.d.ts

@@ -0,0 +1,3 @@
+// @ts-nocheck
+export * from './lib/client';
+export { default } from './lib/client';

package/client.js

@@ -0,0 +1,65 @@
+'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('./lib/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/lib/client/basic/Options.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const Options: () => React.JSX.Element;

package/lib/client/basic/Options.js

@@ -0,0 +1,51 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Options = void 0;
+function _client() {
+  const data = require("@nocobase/client");
+  _client = function _client() {
+    return data;
+  };
+  return data;
+}
+function _react() {
+  const data = _interopRequireDefault(require("react"));
+  _react = function _react() {
+    return data;
+  };
+  return data;
+}
+var _locale = require("../locale");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+const Options = () => {
+  const _useAuthTranslation = (0, _locale.useAuthTranslation)(),
+    t = _useAuthTranslation.t;
+  return _react().default.createElement(_client().SchemaComponent, {
+    scope: {
+      t
+    },
+    schema: {
+      type: 'object',
+      properties: {
+        public: {
+          type: 'object',
+          properties: {
+            allowSignup: {
+              'x-decorator': 'FormItem',
+              type: 'boolean',
+              title: '{{t("Allow to sign up")}}',
+              'x-component': 'Checkbox',
+              'x-component-props': {
+                defaultChecked: true
+              }
+            }
+          }
+        }
+      }
+    }
+  });
+};
+exports.Options = Options;

package/lib/client/basic/SigninPage.d.ts

@@ -0,0 +1,6 @@
+import { Authenticator } from '@nocobase/client';
+import React from 'react';
+declare const _default: (props: {
+    authenticator: Authenticator;
+}) => React.JSX.Element;
+export default _default;

package/lib/client/basic/SigninPage.js

@@ -0,0 +1,100 @@
+"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 _react() {
+  const data = _interopRequireWildcard(require("react"));
+  _react = function _react() {
+    return data;
+  };
+  return data;
+}
+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; }
+const passwordForm = {
+  type: 'object',
+  name: 'passwordForm',
+  'x-component': 'FormV2',
+  properties: {
+    email: {
+      type: 'string',
+      required: true,
+      'x-component': 'Input',
+      'x-validator': 'email',
+      'x-decorator': 'FormItem',
+      'x-component-props': {
+        placeholder: '{{t("Email")}}',
+        style: {}
+      }
+    },
+    password: {
+      type: 'string',
+      'x-component': 'Password',
+      required: true,
+      'x-decorator': 'FormItem',
+      'x-component-props': {
+        placeholder: '{{t("Password")}}',
+        style: {}
+      }
+    },
+    actions: {
+      type: 'void',
+      'x-component': 'div',
+      properties: {
+        submit: {
+          title: '{{t("Sign in")}}',
+          type: 'void',
+          'x-component': 'Action',
+          'x-component-props': {
+            htmlType: 'submit',
+            block: true,
+            type: 'primary',
+            useAction: `{{ useBasicSignIn }}`,
+            style: {
+              width: '100%'
+            }
+          }
+        }
+      }
+    },
+    signup: {
+      type: 'void',
+      'x-component': 'Link',
+      'x-component-props': {
+        to: '{{ signupLink }}'
+      },
+      'x-content': '{{t("Create an account")}}',
+      'x-visible': '{{ allowSignUp }}'
+    }
+  }
+};
+var _default = props => {
+  const authenticator = props.authenticator;
+  const authType = authenticator.authType,
+    name = authenticator.name,
+    options = authenticator.options;
+  const signupPages = (0, _react().useContext)(_client().SignupPageContext);
+  const allowSignUp = !!signupPages[authType] && (options === null || options === void 0 ? void 0 : options.allowSignup);
+  const signupLink = `/signup?authType=${authType}&name=${name}`;
+  const useBasicSignIn = () => {
+    return (0, _client().useSignIn)(name);
+  };
+  return _react().default.createElement(_client().SchemaComponent, {
+    schema: passwordForm,
+    scope: {
+      useBasicSignIn,
+      allowSignUp,
+      signupLink
+    }
+  });
+};
+exports.default = _default;

package/lib/client/basic/SignupPage.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+declare const _default: (props: {
+    name: string;
+}) => React.JSX.Element;
+export default _default;

package/lib/client/basic/SignupPage.js

@@ -0,0 +1,131 @@
+"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 _react() {
+  const data = _interopRequireDefault(require("react"));
+  _react = function _react() {
+    return data;
+  };
+  return data;
+}
+function _shared() {
+  const data = require("@formily/shared");
+  _shared = function _shared() {
+    return data;
+  };
+  return data;
+}
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+const signupPageSchema = {
+  type: 'object',
+  name: (0, _shared().uid)(),
+  'x-component': 'FormV2',
+  properties: {
+    email: {
+      type: 'string',
+      required: true,
+      'x-component': 'Input',
+      'x-validator': 'email',
+      'x-decorator': 'FormItem',
+      'x-component-props': {
+        placeholder: '{{t("Email")}}',
+        style: {}
+      }
+    },
+    password: {
+      type: 'string',
+      required: true,
+      'x-component': 'Password',
+      'x-decorator': 'FormItem',
+      'x-component-props': {
+        placeholder: '{{t("Password")}}',
+        checkStrength: true,
+        style: {}
+      },
+      'x-reactions': [{
+        dependencies: ['.confirm_password'],
+        fulfill: {
+          state: {
+            selfErrors: '{{$deps[0] && $self.value && $self.value !== $deps[0] ? t("Password mismatch") : ""}}'
+          }
+        }
+      }]
+    },
+    confirm_password: {
+      type: 'string',
+      required: true,
+      'x-component': 'Password',
+      'x-decorator': 'FormItem',
+      'x-component-props': {
+        placeholder: '{{t("Confirm password")}}',
+        style: {}
+      },
+      'x-reactions': [{
+        dependencies: ['.password'],
+        fulfill: {
+          state: {
+            selfErrors: '{{$deps[0] && $self.value && $self.value !== $deps[0] ? t("Password mismatch") : ""}}'
+          }
+        }
+      }]
+    },
+    actions: {
+      type: 'void',
+      'x-component': 'div',
+      properties: {
+        submit: {
+          title: '{{t("Sign up")}}',
+          type: 'void',
+          'x-component': 'Action',
+          'x-component-props': {
+            block: true,
+            type: 'primary',
+            htmlType: 'submit',
+            useAction: '{{ useBasicSignup }}',
+            style: {
+              width: '100%'
+            }
+          }
+        }
+      }
+    },
+    link: {
+      type: 'void',
+      'x-component': 'div',
+      properties: {
+        link: {
+          type: 'void',
+          'x-component': 'Link',
+          'x-component-props': {
+            to: '/signin'
+          },
+          'x-content': '{{t("Log in with an existing account")}}'
+        }
+      }
+    }
+  }
+};
+var _default = props => {
+  const useBasicSignup = () => {
+    return (0, _client().useSignup)({
+      authenticator: props.name
+    });
+  };
+  return _react().default.createElement(_client().SchemaComponent, {
+    schema: signupPageSchema,
+    scope: {
+      useBasicSignup
+    }
+  });
+};
+exports.default = _default;

package/lib/client/index.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const _default: (props: any) => React.JSX.Element;
+export default _default;

package/lib/client/index.js

@@ -0,0 +1,56 @@
+"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 _react() {
+  const data = _interopRequireDefault(require("react"));
+  _react = function _react() {
+    return data;
+  };
+  return data;
+}
+var _Authenticator = require("./settings/Authenticator");
+var _SigninPage = _interopRequireDefault(require("./basic/SigninPage"));
+var _preset = require("../preset");
+var _SignupPage = _interopRequireDefault(require("./basic/SignupPage"));
+var _locale = require("./locale");
+var _Options = require("./basic/Options");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+var _default = props => {
+  const _useAuthTranslation = (0, _locale.useAuthTranslation)(),
+    t = _useAuthTranslation.t;
+  return _react().default.createElement(_client().SettingsCenterProvider, {
+    settings: {
+      auth: {
+        title: t('Authentication'),
+        icon: 'LoginOutlined',
+        tabs: {
+          authenticators: {
+            title: t('Authenticators'),
+            component: () => _react().default.createElement(_Authenticator.Authenticator, null)
+          }
+        }
+      }
+    }
+  }, _react().default.createElement(_client().OptionsComponentProvider, {
+    authType: _preset.presetAuthType,
+    component: _Options.Options
+  }, _react().default.createElement(_client().SigninPageProvider, {
+    authType: _preset.presetAuthType,
+    tabTitle: t('Sign in via email'),
+    component: _SigninPage.default
+  }, _react().default.createElement(_client().SignupPageProvider, {
+    authType: _preset.presetAuthType,
+    component: _SignupPage.default
+  }, props.children))));
+};
+exports.default = _default;

package/lib/client/locale/index.d.ts

@@ -0,0 +1,2 @@
+export declare const NAMESPACE = "auth";
+export declare function useAuthTranslation(): import("react-i18next").UseTranslationResponse<"auth", undefined>;

package/lib/client/locale/index.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.NAMESPACE = void 0;
+exports.useAuthTranslation = useAuthTranslation;
+function _reactI18next() {
+  const data = require("react-i18next");
+  _reactI18next = function _reactI18next() {
+    return data;
+  };
+  return data;
+}
+const NAMESPACE = 'auth';
+exports.NAMESPACE = NAMESPACE;
+function useAuthTranslation() {
+  return (0, _reactI18next().useTranslation)(NAMESPACE);
+}

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

@@ -0,0 +1,9 @@
+declare const locale: {
+    'Auth Type': string;
+    Authenticators: string;
+    Authentication: string;
+    'Sign in via email': string;
+    'Not allowed to sign up': string;
+    'Allow to sign up': string;
+};
+export default locale;

package/lib/client/locale/zh-CN.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+const locale = {
+  'Auth Type': '认证类型',
+  Authenticators: '认证器',
+  Authentication: '用户认证',
+  'Sign in via email': '邮箱登录',
+  'Not allowed to sign up': '禁止注册',
+  'Allow to sign up': '允许注册'
+};
+var _default = locale;
+exports.default = _default;

package/lib/client/settings/Authenticator.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const Authenticator: () => React.JSX.Element;