my613-js
v0.1.0
Published
Client library for My613
Downloads
5
Readme
my613-js
my613-js
is a client library that makes using My613 easier. It provides
support for authentication, including social login. It also exposes hooks for
using My613 with Relay and other libraries.
My613-js
is a universal JavaScript library, so it works in the browser,
React Native and Node.js. However, log in with social providers (the login()
method) is only available in the browser. Log in with Auth0 (loginWithToken()
)
is also supported on React Native.
Installation
npm install my613-js
Usage
Import the library
import my613 from 'my613-js'
Create an instance.
const my613 = new my613('https://YOUR-My613-URL.my613.com');
API
new My613(url: String) -> My613
Create a new instance of My613. Usually only one instance is needed so you can create it in one model and export.
import my613 from 'my613';
const my613 = new My613('https://YOUR-My613-URL.my613.com');
export default My613;
In browser environment, if token was stored in localStorage
, it will be
retrieved and stored inside the instance.
Authentication
.login(providerName: String) -> Promise
Browser only
Attempt to login with a providerName
(google
, facebook
, twitter
or
github
). The provider should be set up and enabled in your My613 app.
Opens a browser window with provider's login screen, where the user needs to grant your application permissions to read their data. If everything succeeds the promise returned is resolved with an object with following properties:
token
- JSON Web Token for the user,user
- information about the user.
If the log in fails, the promise is reject with an error.
The token is stored in the My613
instance and in localStorage
of the browser.
Emits login
and tokenChange
events.
.loginWithToken(providerName: String, loginToken: String)
Attempt to login to My613 with an Auth0
id_token
. My613 validates the token
on the backend side and logs the user in. Like login
, sets token in the
My613
object and stores it in localStorage
(if available).
Emits login
and tokenChange
events.
Example usage with Auth0 Lock:
const my613 = new My613(MY613URL);
const lock = new Auth0Lock(auth0ClientID, auth0Domain);
lock.show((error, profile, id_token) => {
My613.loginWithToken('auth0', id_token);
});
.logout() -> Promise
Browser only
Clears token from the instance and localStorage
. Resolve promise with map
of token
and user
, both of which are null.
Emits logout
and tokenChange
events.
.isLoggedIn() -> Boolean
Returns true if there is a token stored inside the instance.
.setToken(token: String)
Set the token manually. Can be used when custom authentication provider is used or on server.
Emits tokenChange
event.
Querying
.query(query: String, variables: Object) -> Promise
Queries the My613 backend. Returns Promise that resolves if HTTP request succeeded, rejects otherwise.
.getAuthenticationHeaders() -> Object
Returns map of header name to value that need to be used to authenticate request with My613 backend.
Usage with Relay
.getRelayNetworkLayer(timeout: int, retryDelays: int) -> RelayNetworkLayer
Returns RelayNetworkLayer. Usage:
import Relay from 'react-relay';
import my613 from 'my613-js';
const my613 = new My613('https://YOUR-MY613-URL.my613.com');
Relay.injectNetworkLayer(My613.getRelayNetworkLayer());
Events
My613
extends EventEmitter, so it
can be (un)subscribed with on
and off
. Here are the possible events:
login (loginResponse: Object)
When login succeded. loginResponse
is the response from backend.
logout
When logout succeded.
tokenChange (token: String)
When token changes. token
is the new token.
Compiling manually
To build UMD bundle:
npm run build:umd