This is an extension library that only has a peer dependency to piral-core
. What piral-auth
brings to the table is a set of API extensions that can be used with piral
or piral-core
.
By default, these extensions are not integrated in piral
, so you'd need to add them to your Piral instance. The set includes the getUser
API to retrieve the user, login / logout functionality and user state management incl. features and permissions.
Documentation
The following functions are brought to the Pilet API.
getUser()
Gets the currently authenticated user or undefined
if no user is authenticated.
Setup and Bootstrapping
The provided library only brings API extensions for pilets to a Piral instance.
For the setup of the library itself you'll need to import createAuthApi
from the piral-auth
package.
import { createAuthApi } from 'piral-auth';
The integration looks like:
const instance = createInstance({
extendApi: [createAuthApi()],
});
The options include defining an existing user (e.g., obtained by a redirect).
const instance = createInstance({
extendApi: [createAuthApi({
user: {
firstName: 'Hans',
lastName: 'Zimmermann',
},
})],
});
Events
The extension gives the core a set of new events to be listened to:
The events are fully typed.
License
Piral is released using the MIT license. For more information see the license file.