reindex-js is a client library that makes using Reindex
(https://www.reindex.io) easier. It provides
support for authentication, including social login. It also exposes hooks for
using Reindex with Relay and other libraries.
Some features (like handling Social Login, storing authentication info) only makes sense in a browser, but otherwise the library can also be used on server with nodejs.
npm install reindex-js
Import the library
Create an instance.
const reindex = '';
new Reindex(url: String) -> Reindex
Create a new instance of Reindex. Usually only one instance is needed so you can create it in one model and export.
;const reindex = '';;
In browser environment, if token was stored in
localStorage, it will be
retrieved and stored inside the instance.
.login(providerName: String) -> Promise
Attempt to login with a
providerName. Currently only Social Login providers
are available (
github). Provider should be
set up and enabled in your Reindex app.
Practically, it opens a browser window with provider's login screen, where user
needs to grant your application permissions to read his data. If everything
succeeds promise is resolved with an object of
token - JSON Web Token for the
user - information about the user. If anything fails for any reason,
promise rejects with an error as result.
Token is stored inside the instance and inside browser
.logout() -> Promise
Clears token from the instance and
localStorage. Resolve promise with map
user, both of which are null.
.isLoggedIn() -> Boolean
Returns true if there is a token stored inside the instance.
Set the token manually. Can be used when custom authentication provider is used or on server.
.query(query: String, variables: Object) -> Promise
Queries the Reindex 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 Reindex backend.
Usage with Relay
.getRelayNetworkLayer(timeout: int, retryDelays: int) -> RelayNetworkLayer
Returns RelayNetworkLayer. Usage:
;;const reindex = '';Relay;
Reindex extends EventEmitter, so it
can be (un)subscribed with
off. Here are the possible events:
login (loginResponse: Object)
When login succeded.
loginResponse is the response from backend.
When logout succeded.
tokenChange (token: String)
When token changes.
token is the new token.
To build UMD bundle:
npm run build:umd