This is a plugin that only has a peer dependency to
piral-auth brings to the table is a set of Pilet API extensions that can be used with
The set includes the
getUser API to retrieve the user, login / logout functionality and user state management incl. features and permissions.
By default, these API extensions are not integrated in
piral, so you'd need to add them to your Piral instance.
The following functions are brought to the Pilet API.
Gets the currently authenticated user or
undefined if no user is authenticated.
For authors of pilets
You can use the
getUser function from the Pilet API to obtain information about the currently logged in user.
Note that the retrieved user data may change if the Piral instance supports an "on the fly" login (i.e., a login without redirect / reloading of the page).
Setup and Bootstrapping
For Piral instance developers
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
The integration looks like:
The options include defining an existing user (e.g., obtained by a redirect).
The extension gives the core a set of new events to be listened to:
The events are fully typed.
Piral is released using the MIT license. For more information see the license file.