README
Full documentation
install:
npm i @plasma-platform/social-providers -S
Short documentation
Table of Contents
rslError
Create error object
Parameters
errorObject
object any expand
Examples
const error = rslError({
provider: 'facebook',
type: 'skd',
description: 'sdk not load',
});
timestampFromNow
Calculate expires at
Parameters
duration
number duration in seconds
Examples
const expiresAt = timestampFromNow(10);
Facebook provider
load
Load Facebook SDK
Parameters
Examples
const sdk = new Facebook();
const loadPromise = sdk.load(1, 'email,address');
Returns any User profile
getProfile
Gets currently logged in user profile data. Requires SDK to be loaded first.
Examples
const sdk = new Facebook();
const loadPromise = sdk.load(1, 'email,address');
sdk.getProfile().then(profile => resolve({
...profile,
...response.authResponse,
}));
handleLoginStatus
ets Facebook user profile if connected.
Parameters
response
object
Examples
const sdk = new Facebook();
const loadPromise = handleLoginStatus.load({
authResponse: {
accessToken: "EAADUgQeh3vUBA",
data_access_expiration_time: 1566306272,
expiresIn: 6928,
reauthorize_required_in: 7776000,
signedRequest: "qPoTVnzwRa_pO",
userID: "22",
},
status: 'connected'
};
Returns boolean
checkLogin
Checks if user is logged in to app through Facebook. Requires SDK to be loaded first.
Examples
const sdk = new Facebook();
const loadPromise = sdk.load(1, 'email,address');
login
Trigger Facebook login popup. Requires SDK to be loaded first.
Examples
const sdk = new Facebook();
const loadPromise = sdk.load(1, 'email,address');
logout
Trigger Facebook logout. Requires SDK to be loaded first.
Examples
const sdk = new Facebook();
const loadPromise = sdk.load(1, 'email,address');
generateUser
Helper to generate user account data.
Parameters
response
object
Examples
const sdk = new Facebook();
const loadPromise = sdk.generateUser(
accessToken: "EAADUgQeh3vUBAECFHo",
data_access_expiration_time: 1566310721,
email: "test@gmail.com",
expiresIn: 6079,
first_name: "Test",
id: "1",
last_name: "Test",
name: "Test Test",
picture: {
data: {
height: 50,
is_silhouette: false,
url: "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=1&height=50&width=50&ext=1561126722&hash=AeSkzdhWH1oVV8Md",
width: 50,
},
},
reauthorize_required_in: 7776000,
signedRequest: "wJdmrFpi",
userID: "1",
);
Returns SocialUser object social user
SocialUser
Model Social User
Google provider
load
- See: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiclientloadname--------version--------callback
- See: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiauth2initparams
- See: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiauth2getauthinstance
Loads Google SDK.
Parameters
Examples
const sdk = new Google();
const loadPromise = sdk.load(1, 'email,address');
checkLogin
- See: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiauth2getauthinstance
- See: https://developers.google.com/api-client-library/javascript/reference/referencedocs#googleauthissignedinget
- See: https://developers.google.com/api-client-library/javascript/reference/referencedocs#googleauthcurrentuserget
Checks if user is logged in to app through Google. Requires SDK to be loaded first.
Examples
const sdk = new Google();
const loadPromise = sdk.load(1, 'email,address');
Returns any
login
- See: https://developers.google.com/api-client-library/javascript/reference/referencedocs#gapiauth2getauthinstance
- See: https://developers.google.com/api-client-library/javascript/reference/referencedocs#googleauthsignin
Trigger Google login process. Requires SDK to be loaded first.
Examples
const sdk = new Google();
const loadPromise = sdk.load(1, 'email,address');
logout
Trigger Google logout. Requires SDK to be loaded first.
Examples
const sdk = new Google();
const loadPromise = sdk.load(1, 'email,address');
generateUser
- See: https://developers.google.com/api-client-library/javascript/reference/referencedocs#googleusergetbasicprofile
- See: https://developers.google.com/api-client-library/javascript/reference/referencedocs#googleusergetauthresponseincludeauthorizationdata
Helper to generate user account data.
Parameters
response
object response social
Examples
const sdk = new Google();
const loadPromise = generateUser.load({});
Returns SocialUser object social user