Merge pull request #163 from leancloud/auth-data

✨ Add onAuthDataTransform Hook

API.md

@@ -174,6 +174,15 @@ LeanEngine 中间件会为这些 Hook 函数检查「Hook 签名」，确保调
 * `currentUser: AV.User`：被操作的用户。
 * `user: AV.User`：同 `currentUser`.
 * `object: AV.User`：同 `currentUser`，因为登录认证 hook 被操作的对象正好是发起操作的用户。
+* `authData: {[provider: string]: any}`，客户端发送的第三方登录信息（仅 `onAuthData`）。
+
+#### `AV.Cloud.onAuthData`
+
+这个函数的签名：`function(func: function)`，其中 `func` 是接受一个 Request 对象作为参数，返回新的 authData 的异步函数，如果抛出异常会中断第三方登录。
+
+`Request` 上的属性包括：
+
+* `authData: {[provider: string]: any}`，客户端发送的第三方登录信息。
 
 ### 实时通信 Hook 函数
 

leanengine.d.ts

@@ -125,9 +125,14 @@ export namespace Cloud {
     currentUser: User
   }
 
+  interface AuthDataTransformRequest {
+    authData: {[provider: string]: any}
+  }
+
   type CloudFunction = (request: CloudFunctionRequest) => Promise<any>;
   type ClassHookFunction = (request: ClassHookRequest) => Promise<any>;
   type UserHookFunction = (request: UserHookRequest) => Promise<any>;
+  type AuthDataTransformFunction = (request: AuthDataTransformRequest) => Promise<{[provider: string]: any}>;
 
   export class Error {
     constructor(message: string, options?: {status?: number, code?: number})
@@ -150,6 +155,7 @@ export namespace Cloud {
 
   export function onVerified(handler: UserHookFunction): void;
   export function onLogin(handler: UserHookFunction): void;
+  export function onAuthData(handler: AuthDataTransformFunction): void;
 
   export function onIMMessageReceived(handler: CloudFunction): void;
   export function onIMReceiversOffline(handler: CloudFunction): void;

lib/cloud.js

@@ -161,6 +161,10 @@ Cloud.onLogin = function(func) {
   Cloud.define('__on_login__User', func);
 };
 
+Cloud.onAuthData = function(func) {
+  Cloud.define('__on_authdata__User', func);
+};
+
 _.each(utils.realtimeHookMapping, (metadataName, hookName) => {
   Cloud[hookName] = Cloud.define.bind(null, metadataName);
 });

lib/leanengine.js

@@ -96,8 +96,8 @@ function createCloudFunctionRouter(options) {
         return callCloudFunction(req, functionOrClass, options);
       } else if (functionOrClass === 'onVerified') {
         return callUserHook(req, 'onVerified', hookName);
-      } else if (functionOrClass === '_User' && hookName === 'onLogin') {
-        return callUserHook(req, 'onLogin', '_User');
+      } else if (functionOrClass === '_User' && _.contains(['onLogin', 'onAuthData'], hookName)) {
+        return callUserHook(req, hookName, '_User');
       } else if ((functionOrClass === 'BigQuery' || functionOrClass === 'Insight') && hookName === 'onComplete') {
         return onCompleteBigQueryJob(req);
       } else {
@@ -278,6 +278,10 @@ function callUserHook(req, hookName, verifyType) {
     object: user
   });
 
+  if (req.body.authData) {
+    request.authData = req.body.authData;
+  }
+
   return new Promise( (resolve, reject) => {
     if (hookName === 'onLogin' && userHookFunction.length === 2) {
       userHookFunction(request, utils.prepareResponseObject(req.res, err => {
@@ -288,8 +292,12 @@ function callUserHook(req, hookName, verifyType) {
         }
       }));
     } else {
-      promiseTry(userHookFunction.bind(null, request)).then( () => {
-        resolve({result: 'ok'});
+      promiseTry(userHookFunction.bind(null, request)).then( result => {
+        if (hookName === 'onAuthData') {
+          resolve({result});
+        } else {
+          resolve({result: 'ok'});
+        }
       }).catch(reject);
     }
   });

lib/utils.js

@@ -13,7 +13,8 @@ exports.hookNameMapping = {
   beforeDelete: '__before_delete_for_',
   afterDelete: '__after_delete_for_',
   onVerified: '__on_verified_',
-  onLogin: '__on_login_'
+  onLogin: '__on_login_',
+  onAuthData: '__on_authdata_'
 };
 
 exports.realtimeHookMapping = {