Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

piral-auth

0.11.7 • Public • Published

Piral Logo

Piral Authentication · GitHub License npm version tested with jest Gitter Chat

This is a plugin that only has a peer dependency to piral-core. What piral-auth brings to the table is a set of Pilet API extensions that can be used with piral or piral-core.

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.

Documentation

The following functions are brought to the Pilet API.

getUser()

Gets the currently authenticated user or undefined if no user is authenticated.

Usage

For authors of pilets

You can use the getUser function from the Pilet API to obtain information about the currently logged in user.

Example use:

import { PiletApi } from '<name-of-piral-instance>';
 
export function setup(piral: PiletApi) {
  const currentUser = piral.geUser();
}

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 piral-auth package.

import { createAuthApi } from 'piral-auth';

The integration looks like:

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

The options include defining an existing user (e.g., obtained by a redirect).

const instance = createInstance({
  // important part
  extendApi: [createAuthApi({
    user: {
      firstName: 'Hans',
      lastName: 'Zimmermann',
      // ...
    },
  })],
  // ...
});

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.

Install

npm i piral-auth

DownloadsWeekly Downloads

1,688

Version

0.11.7

License

MIT

Unpacked Size

13.7 kB

Total Files

21

Homepage

piral.io

Last publish

Collaborators

  • avatar