Cosync-jwt-react-native NPM

CosyncJWTReactNative

The CosyncJWTReactNative package is used to add functional bindings between a React Native application and the CosyncJWT service. To install this package into a React Native application do the following

Installation in React Native

npm i cosync-jwt-react-native --save

Function API

The CosyncJWTReactNative provides a number of node functions

configure

Create new instant to use the CosyncJWTReactNative to operate with a REST API that implements the CosyncJWT service protocol. This function should be called once at the time the application starts up.

import CosyncJWTReactNative from 'cosync-jwt-react-native';
let cosync = new CosyncJWTReactNative({appToken: String, apiUrl: String}).getInstance();

Parameters

appToken : String - this contains the application token for CosyncJWT (usually retrieved from the Keys section of the Cosync Portal.

apiUrl : String - this optional parameter contains the HTTPS REST API address for the CosyncJWT service. The default is 'https://rest.cosync.net' if not specified.

Example

let cosync = new CosyncJWTReactNative({appToken: String, apiUrl: String}).getInstance();

loginAnonymous

The loginAnonymous() function is used to login into a anonymous user's account and create anonymous account if the user doesn't exist. If the login is successful, a login credentials will resolve result from this function vice versa:

jwt: the JWT token of the logged in user
access-token: the access token of the logged in user

loginAnonymous(handle) {
	return new Promise((resolve, reject) => {
		resolve(result) or reject(err)
	})
}

Parameters

handle : String - this contains the user's handle (ANON_UUID).

Example

cosync.login.loginAnonymous(handle).then(result => {
	// login result here...
	// jwt, access-token or login-token

	let jwt = result['jwt'];
	let accessToken = result['access-token'];

	or

	let loginToken = result['login-token'];

}).catch(err => {
	// login invalid result here...
	// code, message
	let code = err.code;
	let message = err.message;

})

login

The login() function is used to login into a user's account. If the login is successful, a login credentials will resolve result from this function vice versa:

jwt: the JWT token of the logged in user
access-token: the access token of the logged in user

login(handle, password) {
	return new Promise((resolve, reject) => {
		resolve(result) or reject(err)
	})
}

If the application has enabled 2-factor google or phone verification, and the user has enabled 2-factor verification for his/her account, the jwt and access-token will be set to undefined, and the CosyncJWT service will return login-token

This login-token will be used by the loginComplete() function, which is passed a 2FA code sent to the user - either through the Google authenticator for Google Authentication or through Twilio for phone 2FA authentication.

Parameters

handle : String - this contains the user's handle or email.

password : String - this contains the user's password.

Example

cosync.login.login(handle, password).then(result => {
	// login result here...
	// jwt, access-token or login-token

	let jwt = result['jwt'];
	let accessToken = result['access-token'];

	or

	let loginToken = result['login-token'];

}).catch(err => {
	// login invalid result here...
	// code, message
	let code = err.code;
	let message = err.message;

})

loginComplete

The loginComplete() function is used to complete a login into a user's account with a 2FA code - provided by the Google authenticator or from a Twilio SMS message for phone 2FA verification.

If the loginComplete is successful, a login credentials will resolve result from this function vice versa:

jwt: the JWT token of the logged in user
accessToken: the access token of the logged in user

loginComplete(loginToken, loginCode){
	return new Promise((resolve, reject) => {
		resolve(result) or reject(err)
	})
}

Parameters

loginToken : String - this is a signed token from login function result code : String - this contains the 6 digit code from the Google Authenticator or Twilio SMS

Example

cosync.login.loginComplete(loginToken, loginCode).then(result => {

	// login result here...
	// jwt, access-token
	let jwt = result['jwt'];
	let accessToken = result['access-token'];

}).catch(err => {
	// login invalid result here...
	// code, message
	let code = err.code;
	let message = err.message;

})

realm login

signup

The signup() function is used to signup a user with a CosyncJWT application. This function may cause the CosyncJWT service to verify the handle email of the user signing up. This verification is done by either sending a six digit verification code to the handle associated with the user account if the signup flow is code, otherwise it sends an email link to the handle that the user can click if the signup flow is link. If the signup flow is none, no verification of the handle is required. If the signup is successful, the signup() function will resolve result from this function vice versa:

Metadata associated with the user is passed in as part of the signup process in the metadata parameter. The metadata is passed in as JSON object. The format of the metadata is specified in the Cosync Portal for the specific application in the JWT tab under the Metadata Fields section.

signup(handle, password, metadata){
	return new Promise((resolve, reject) => {
		resolve(result) or reject(err)
	})
}

Parameters

handle : String - this contains the user's handle or email.

password : String - this contains the user's password.

metadata : Object - JSON object of the metadata.

Example

let metadata = {
	user_data:{
		name:{
			first: "Jonh",
			last: "Doe"
		}
	}
};

cosync.signup.signup(handle,password, metadata).then(result => {

	// signup result is true

}).catch(err => {
	// signup invalid result here...
	// code, message
	let code = err.code;
	let message = err.message;

})

completeSignup

The completeSignup() function is used to complete a signup of a user with a CosyncJWT application, if the developer has selected code as the signup flow within the Cosync Portal. The completeSignup() function should be called after the user has been emailed a six-digit code to verify his/her email handle with CosyncJWT. This function call is not necessary if the developer has selected link or none as the signup flow for the application.

If the call to completeSignup() is successful, the function will resolve result from this function vice versa:

completeSignup(handle, code){
	return new Promise((resolve, reject) => {
		resolve(result) or reject(err)
	})
}

Parameters

handle : String - this contains the user's handle or email.

code : String - this contains the six-digit code sent to the user's email

Example

cosync.signup.completeSignup(handle, code).then(result => {

	// signup result here...
	// jwt, access-token
	let jwt = result['jwt'];
	let accessToken = result['access-token'];

}).catch(err => {
	// signup invalid result here...
	// code, message
	let code = err.code;
	let message = err.message;

})

invite

The invite() function is used to invite a user email into the CosyncJWT application. It is an alternative onboarding process to the signup() function. Invitation is done by the logged in user to another potential user's email. When a user is "invited" into a CosyncJWT application, he/she will receive and email to that effect. Similar the signup process, an invitation can also have attached metadata to it. The invited user email will be sent a six-digit code to validate the email at the time of onboarding during the "register()* function call.

Invite metadata associated with the user is passed in as part of the invite process in the metadata parameter. The metadata is passed in as JSON object. The format of the metadata is specified in the Cosync Portal for the specific application in the JWT tab under the Invite Metadata Fields section. The invite metadata could be used to encode a coupon value for the invited user, or any other data the developer sees fit.

The invitation process will also need to record the unique Realm user id of the inviting user. This is stored within the senderUserId parameter of the invite() function. If the senderUserId is not provided, the function will use current logged in Realm user id.

invite( handle, metadata, senderUserId){
	return new Promise((resolve, reject) => {
		resolve(result) or reject(err)
	})
}

Parameters

handle : String - this contains the user's handle or email.

senderUserId : String - Realm user Id of inviting user

metadata : Object - JSON object of the invite metadata.

Example

let metadata = {
	invite_data: {
		coupon: "premium"
	}
};

cosync.profile.invite(userEmail, metadata, senderUserId).then(result => {

	 // invite result is true

}).catch(err => {
	// invalid result here...
	// code, message
	let code = err.code;
	let message = err.message;

})

register

The register() function is used to complete the invite of a user with a CosyncJWT application. When an inviting user issues a call to the invite() function, the invited user email will be sent an email with a six-digit code associated with the invite. This code is passed by the invited user in the code parameter during a call to the register() function.

Metadata associated with the invited user is passed in as part of the register process in the metadata parameter. The metadata is passed in as JSON dictionary string. This is the invited user's metadata, which is different from the Invite Metadata passed in by the inviting user in the invite(() function call. The format of the metadata is specified in the Cosync Portal for the specific application in the JWT tab under the Metadata Fields section.

If the call to register() is successful, the function will resolve result from this function vice versa:

register(handle, password, code, metadata){
	return new Promise((resolve, reject) => {
		resolve(result) or reject(err)
	})
}

Parameters

handle : String - this contains the user's handle or email.

password : String - this contains the user's password.

metadata : String - JSON object of the metadata.

code : String - this contains the six-digit code sent to the user's email

Example

let metadata = {
	user_data:{
		name:{
			first: "Jonh",
			last: "Doe"
		}
	}
};


cosync.register.register(handle, password, code, metadata).then(result => {

	// register result here...
	// jwt, access-token
	let jwt = result['jwt'];
	let accessToken = result['access-token'];

}).catch(err => {
	// invalid result here...
	// code, message
	let code = err.code;
	let message = err.message;

})

getUser

The getUser() function is used by the client application to get information about the currently logged in user to CosyncJWT. The getUser() function will resovle user data. These member variables include the following information:

handle : String - email handle of user
twoFactorPhoneVerification : Bool - whether phone 2FA is enabled for user
twoFactorGoogleVerification : Bool - whether google 2FA is enabled for user
appId : String - CosyncJWT app Id for user
phone : String - phone number for user in E. 164 format
phoneVerified : Bool - whether user phone number has been verified
metadata : String - JSON string of user metadata
lastLogin : Date - last login date for user

getUser(){
	return new Promise((resolve, reject) => {
		resolve(result) or reject(err)
	})
}

Parameters

None

Example

cosync.profile.getUser().then(result => {
	// result here...
}).catch(err => {
	// invalid result here...
	// code, message
})

getApplication

The getApplication() function is used by the client application to get information about the application within CosyncJWT. The getApplication() function will resolve application information. These member variables include the following information:

name : String - application name as stored in CosyncJWT
twoFactorVerification : String - 2FA type 'phone', 'google', or 'none'
passwordFilter : Bool - whether password filtering is turned on
passwordMinLength : Int - minimum password length
passwordMinUpper : Int - minimum number of upper case characters
passwordMinLower : Int - minimum number of lower case characters
passwordMinDigit : Int - minimum number of digits
passwordMinSpecial : Int - minimum number of special characters
appData : Object - installed verson of Cosync Service
invitationEnabled : Bool - app alow invitation
signupEnabled : Bool - app alow signup
signupFlow : String - signup flow can be 'code', 'link', or 'none'
metaData : Object - Metadata format of app user
metaDataInvite : Object - Metadata format of app invitation
userJWTExpiration : Bool - JWT expired time

getApplication(){
	return new Promise((resolve, reject) => {
		resolve(result) or reject(err)
	})
}

Parameters

None

Example

cosync.app.getApplication().then(result => {
	// result here...
}).catch(err => {	
	// invalid result here...
	// code, message
})

setPhone

The setPhone() function is used by the client application to set the user's phone number, if twoFactorVerification for the application is set to phone. The phone number should be in E.164 format, and can include the prefix '+', e.g. "+19195551212". When a phone number is set, it will be initially considered unverified. After calling the setPhone() function, the CosyncJWT system will send a six digit code SMS to the phone for verification. The application will then have to call the verifyPhone() along with the six-digit code to verify the phone on behalf of the user.

setPhone(phoneNumber){
	return new Promise((resolve, reject) => {
		resolve(result) or reject(err)
	})
}

Parameters

phoneNumber : String - contains the user's phone number in E.164 format

Example

cosync.profile.setPhone(phoneNumber).then(result => {
	// result here...

}).catch(err => {
	// invalid result here...
	// code, message
})

verifyPhone

The verifyPhone() function is used by the client application to verify a user's phone number, after a call to the setPhone() function. The verifyPhone() must passed a six-digit code that was sent to the user's phone.

verifyPhone(code){
	return new Promise((resolve, reject) => {
		resolve(result) or reject(err)
	})
}

Parameters

code : String - six-digit code that was sent to user's phone

Example

cosync.profile.verifyPhone(code).then(result => {
	// result here...

}).catch(err => {
    // invalid result here...
	// code, message
})

setTwoFactorPhoneVerification

The setTwoFactorPhoneVerification() function is used by the client application to enable two factor phone verification for the current logged in user. This function will only enable phone 2FA is the CosyncJWT application has twoFactorVerification set to phone and the user has a verified phone number.

setTwoFactorPhoneVerification(twoFactor){
	return new Promise((resolve, reject) => {
		resolve(result) or reject(err)
	})
}

Parameters

twoFactor : Bool - true to enable phone 2FA for the user, false to disable it

Example

cosync.profile.setTwoFactorPhoneVerification(true).then(result => {
	// result here...

}).catch(err => {
	// invalid result here...
	// code, message

})

setTwoFactorGoogleVerification

The setTwoFactorGoogleVerification() function is used by the client application to enable two factor phone verification for the current logged in user. This function will only enable google 2FA is the CosyncJWT application has twoFactorVerification set to google. After calling this function, the user will be sent an email with a bar code for the Google Authenticator application.

Note: The Google 2FA authentication system is more secure than simple phone 2FA, because the Google codes rotate every minute. Also, the Google 2FA authentication is free is does not require a TWILIO account for SMS phone verification.

setTwoFactorGoogleVerification(twoFactor){
	return new Promise((resolve, reject) => {
		resolve(result) or reject(err)
	})
}

Parameters

twoFactor : Bool - true to enable Google 2FA for the user, false to disable it

Example

cosync.profile.setTwoFactorGoogleVerification(true).then(result => {
	// result here...

}).catch(err => {
	// invalid result here...
	// code, message

})

forgotPassword

The forgotPassword() function is used by the client application to enable a user to reset the password for their account. After calling this function, the user will be sent a reset password email along with a six-digit code to reset their password. The password is reset by calling the resetPassword() function. The user does not need to be logged in for this function to work.

forgotPassword(handle){
	return new Promise((resolve, reject) => {
		resolve(result) or reject(err)
	})
}

Parameters

handle : String - email handle of the user to reset password for

Example

cosync.password.forgotPassword(handle).then(result => {
	// result here...

}).catch(err => {
	// invalid result here...
	// code, message

})

resetPassword

The resetPassword() function is used by the client application to reset the password for their account after issuing a forgotPassword() function call. The user does not need to be logged in for this function to work.

resetPassword(handle, password, code){
	return new Promise((resolve, reject) => {
		resolve(result) or reject(err)
	})
}

Parameters

handle : String - email handle of the user to reset password for password : String - new password for the account. The password must be md5 string. code : String - code that was emailed the user by the forgotPassword() function

Example

cosync.password.resetPassword(handle, password, code).then(result => {
	// result here...

}).catch(err => {
	// invalid result here...
	// code, message

})

changePassword

The changePassword() function is used by the client application to change the password of the current logged in user. The user must be logged in for this function to work.

changePassword(newPassword, password){
	return new Promise((resolve, reject) => {
		resolve(result) or reject(err)
	})
}

Parameters

newPassword : String - new password for the account. password : String - old password for the account.

Example

cosync.password.changePassword(newPassword, password).then(result => {
	// result here...

}).catch(err => {
	// invalid result here...
	// code, message

})

checkPassword

The checkPassword() function is used by the client application to check whether a password conforms to the password filtering parameters set for the application in the Cosync Portal. When using CosyncJWT, a developer can require that user for an application meet specific password requirements, which include:

minimum length
minimum upper-case letters
minimum lower-case letters
minimum number of digits (0…9)
minimum special characters

The special characters include @, %, +, , /, ‘, !, #, $, ^, ?, :, (, ), , , ~, `, -, _, ., and ,

The password filtering parameters are set by the developer in the Cosync Portal, but actual password enforcement takes place at the client side. The reason for this is that passwords are sent to the CosyncJWT service as MD5 hashed strings, so there is no way to enforce this at the server level. This function is automatically called by the signup() function, so does not need to be called by the application code.

checkPassword(password){
	return new Promise((resolve, reject) => {
		resolve(result)
	})

}

Parameters

password : String - this contains the user's password.

Example

cosync.password.checkPassword(password).then(result => {
	// result is true or flase
})

logout

The logout() function is used by the client application to logout current logged in user. The function also logout user from MongodBD Realm.

logout(){
}

Parameters

None

Example

cosync.logout();

@realm/react md5 realm

@everything-registry/sub-chunk-1391 @zalastax/nolb-cos

10 months ago

9 months ago

9 months ago

1 year ago

1 year ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago