piral-auth

Piral Authentication ·

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

For details on the provided API check out the documentation at the Piral website or on GitHub.

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';

For the integration this depends on the Piral instance.

For piral-core-based instances this boils down to:

const PiralInstance = createInstance({
  // important part
  extendApi: extendApis([createAuthApi]),
  // ...
});

For piral-based instances the integration looks like:

renderInstance({
  // important part
  extendApi: extendApis([createAuthApi]),
  // ...
});

Events

The extension gives the core a set of new events to be listened to:

• change-user

The events are fully typed.

License

Piral is released using the MIT license. For more information see the license file.