@nocobase/plugin-auth 1.4.0-alpha.5 → 1.4.0-alpha.7

package/README.md

@@ -1,117 +1,30 @@
-# Auth
+# NocoBase
 
-提供基础认证功能和扩展认证器管理功能。
+<video width="100%" controls>
+      <source src="https://static-docs.nocobase.com/NocoBase0510.mp4" type="video/mp4">
+</video>
 
-## 使用方法
 
-### 认证器管理
-页面：系统设置 - 认证
+## What is NocoBase
 
+NocoBase is a scalability-first, open-source no-code development platform.  
+Instead of investing years of time and millions of dollars in research and development, deploy NocoBase in a few minutes and you'll have a private, controllable, and extremely scalable no-code development platform!
 
-<img src="https://s2.loli.net/2023/05/15/NdriQZvBuE6hGRS.png" width="800px" />
+Homepage:  
+https://www.nocobase.com/
 
-#### 内置认证器
-- 名称：basic
-- 认证类型：邮箱密码登录
+Online Demo:  
+https://demo.nocobase.com/new
 
-<img src="https://s2.loli.net/2023/05/15/HC4gtx9fQPrqvac.png" width="300px" />
+Documents:  
+https://docs.nocobase.com/
 
-<img src="https://s2.loli.net/2023/05/15/fcLqypdhOxnksbg.png" width="300px" />
+Commericial license & plugins:  
+https://www.nocobase.com/en/commercial
 
-#### 增加认证器
-Add new - 选择认证类型
+License agreement:   
+https://www.nocobase.com/en/agreement
 
-<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 扩展组件
+## Contact Us:  
+hello@nocobase.com

package/dist/externalVersion.js

@@ -8,14 +8,14 @@
  */
 
 module.exports = {
-  "@nocobase/client": "1.4.0-alpha.5",
+  "@nocobase/client": "1.4.0-alpha.7",
   "react": "18.2.0",
-  "@nocobase/utils": "1.4.0-alpha.5",
-  "@nocobase/auth": "1.4.0-alpha.5",
-  "@nocobase/database": "1.4.0-alpha.5",
-  "@nocobase/cache": "1.4.0-alpha.5",
-  "@nocobase/server": "1.4.0-alpha.5",
-  "@nocobase/test": "1.4.0-alpha.5",
+  "@nocobase/utils": "1.4.0-alpha.7",
+  "@nocobase/auth": "1.4.0-alpha.7",
+  "@nocobase/database": "1.4.0-alpha.7",
+  "@nocobase/cache": "1.4.0-alpha.7",
+  "@nocobase/server": "1.4.0-alpha.7",
+  "@nocobase/test": "1.4.0-alpha.7",
   "antd": "5.12.8",
   "@formily/react": "2.3.0",
   "react-router-dom": "6.21.0",
@@ -23,5 +23,5 @@ module.exports = {
   "react-i18next": "11.18.6",
   "@emotion/css": "11.13.0",
   "@ant-design/icons": "5.2.6",
-  "@nocobase/actions": "1.4.0-alpha.5"
+  "@nocobase/actions": "1.4.0-alpha.7"
 };

package/dist/node_modules/cron/package.json

@@ -1 +1 @@
-{"name":"cron","description":"Cron jobs for your node","version":"2.4.4","author":"Nick Campbell <nicholas.j.campbell@gmail.com> (https://github.com/ncb000gt)","bugs":{"url":"https://github.com/kelektiv/node-cron/issues"},"repository":{"type":"git","url":"https://github.com/kelektiv/node-cron.git"},"main":"lib/cron","scripts":{"lint":"eslint {lib,tests}/*.js","test":"jest --coverage","test:watch":"jest --watch --coverage","test:types":"tsd","prepare":"husky install","release":"semantic-release"},"types":"types/index.d.ts","dependencies":{"@types/luxon":"~3.3.0","luxon":"~3.3.0"},"devDependencies":{"@commitlint/cli":"~17.6.6","@insurgentlab/commitlint-config":"^18.1.0","@insurgentlab/conventional-changelog-preset":"~6.0.3","@semantic-release/changelog":"~6.0.x","@semantic-release/commit-analyzer":"~9.0.x","@semantic-release/git":"~10.0.x","@semantic-release/github":"~8.1.x","@semantic-release/npm":"~10.0.x","@semantic-release/release-notes-generator":"~11.0.x","chai":"~4.2.x","eslint":"~8.36.x","eslint-config-prettier":"^8.7.x","eslint-config-standard":"~17.0.x","eslint-plugin-import":"~2.27.x","eslint-plugin-jest":"~27.2.x","eslint-plugin-n":"~15.6.x","eslint-plugin-prettier":"~4.2.x","eslint-plugin-promise":"~6.1.x","husky":"^8.0.3","jest":"~29.5.x","prettier":"~2.8.x","semantic-release":"~21.0.x","sinon":"^15.0.x","tsd":"^0.28.1"},"keywords":["cron","node cron","node-cron","schedule","scheduler","cronjob","cron job"],"license":"MIT","contributors":["Brandon der Blätter <https://interlucid.com/contact/> (https://github.com/intcreator)","Romain Beauxis <toots@rastageeks.org> (https://github.com/toots)","James Padolsey <> (https://github.com/jamespadolsey)","Finn Herpich <fh@three-heads.de> (https://github.com/ErrorProne)","Clifton Cunningham <clifton.cunningham@gmail.com> (https://github.com/cliftonc)","Eric Abouaf <eric.abouaf@gmail.com> (https://github.com/neyric)","humanchimp <morphcham@gmail.com> (https://github.com/humanchimp)","Craig Condon <craig@spiceapps.com> (https://github.com/spiceapps)","Dan Bear <daniel@hulu.com> (https://github.com/danhbear)","Vadim Baryshev <vadimbaryshev@gmail.com> (https://github.com/baryshev)","Leandro Ferrari <lfthomaz@gmail.com> (https://github.com/lfthomaz)","Gregg Zigler <greggzigler@gmail.com> (https://github.com/greggzigler)","Jordan Abderrachid <jabderrachid@gmail.com> (https://github.com/jordanabderrachid)","Masakazu Matsushita <matsukaz@gmail.com> (matsukaz)","Christopher Lunt <me@kirisu.co.uk> (https://github.com/kirisu)"],"jest":{"collectCoverage":true,"collectCoverageFrom":["lib/*.js"],"coverageThreshold":{"global":{"statements":80,"branches":80,"functions":70,"lines":80}}},"files":["lib","types","CHANGELOG.md","LICENSE","README.md"],"_lastModified":"2024-11-08T00:57:56.721Z"}
+{"name":"cron","description":"Cron jobs for your node","version":"2.4.4","author":"Nick Campbell <nicholas.j.campbell@gmail.com> (https://github.com/ncb000gt)","bugs":{"url":"https://github.com/kelektiv/node-cron/issues"},"repository":{"type":"git","url":"https://github.com/kelektiv/node-cron.git"},"main":"lib/cron","scripts":{"lint":"eslint {lib,tests}/*.js","test":"jest --coverage","test:watch":"jest --watch --coverage","test:types":"tsd","prepare":"husky install","release":"semantic-release"},"types":"types/index.d.ts","dependencies":{"@types/luxon":"~3.3.0","luxon":"~3.3.0"},"devDependencies":{"@commitlint/cli":"~17.6.6","@insurgentlab/commitlint-config":"^18.1.0","@insurgentlab/conventional-changelog-preset":"~6.0.3","@semantic-release/changelog":"~6.0.x","@semantic-release/commit-analyzer":"~9.0.x","@semantic-release/git":"~10.0.x","@semantic-release/github":"~8.1.x","@semantic-release/npm":"~10.0.x","@semantic-release/release-notes-generator":"~11.0.x","chai":"~4.2.x","eslint":"~8.36.x","eslint-config-prettier":"^8.7.x","eslint-config-standard":"~17.0.x","eslint-plugin-import":"~2.27.x","eslint-plugin-jest":"~27.2.x","eslint-plugin-n":"~15.6.x","eslint-plugin-prettier":"~4.2.x","eslint-plugin-promise":"~6.1.x","husky":"^8.0.3","jest":"~29.5.x","prettier":"~2.8.x","semantic-release":"~21.0.x","sinon":"^15.0.x","tsd":"^0.28.1"},"keywords":["cron","node cron","node-cron","schedule","scheduler","cronjob","cron job"],"license":"MIT","contributors":["Brandon der Blätter <https://interlucid.com/contact/> (https://github.com/intcreator)","Romain Beauxis <toots@rastageeks.org> (https://github.com/toots)","James Padolsey <> (https://github.com/jamespadolsey)","Finn Herpich <fh@three-heads.de> (https://github.com/ErrorProne)","Clifton Cunningham <clifton.cunningham@gmail.com> (https://github.com/cliftonc)","Eric Abouaf <eric.abouaf@gmail.com> (https://github.com/neyric)","humanchimp <morphcham@gmail.com> (https://github.com/humanchimp)","Craig Condon <craig@spiceapps.com> (https://github.com/spiceapps)","Dan Bear <daniel@hulu.com> (https://github.com/danhbear)","Vadim Baryshev <vadimbaryshev@gmail.com> (https://github.com/baryshev)","Leandro Ferrari <lfthomaz@gmail.com> (https://github.com/lfthomaz)","Gregg Zigler <greggzigler@gmail.com> (https://github.com/greggzigler)","Jordan Abderrachid <jabderrachid@gmail.com> (https://github.com/jordanabderrachid)","Masakazu Matsushita <matsukaz@gmail.com> (matsukaz)","Christopher Lunt <me@kirisu.co.uk> (https://github.com/kirisu)"],"jest":{"collectCoverage":true,"collectCoverageFrom":["lib/*.js"],"coverageThreshold":{"global":{"statements":80,"branches":80,"functions":70,"lines":80}}},"files":["lib","types","CHANGELOG.md","LICENSE","README.md"],"_lastModified":"2024-11-11T02:33:53.440Z"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/plugin-auth",
-  "version": "1.4.0-alpha.5",
+  "version": "1.4.0-alpha.7",
   "main": "./dist/server/index.js",
   "homepage": "https://docs.nocobase.com/handbook/auth",
   "homepage.zh-CN": "https://docs-cn.nocobase.com/handbook/auth",
@@ -26,7 +26,7 @@
   "displayName.zh-CN": "用户认证",
   "description": "User authentication management, including password, SMS, and support for Single Sign-On (SSO) protocols, with extensibility.",
   "description.zh-CN": "用户认证管理，包括基础的密码认证、短信认证、SSO 协议的认证等，可扩展。",
-  "gitHead": "101d541ccb57037bb28c11a0c33b56266da1840b",
+  "gitHead": "52bb98fe5fd95cc25baeaaef5aeae9cdd1a0e2fa",
   "keywords": [
     "Authentication"
   ]