Wondering what’s next for npm?Check out our public roadmap! »

    piral-adal
    TypeScript icon, indicating that this package has built-in type declarations

    0.13.2 • Public • Published

    Piral Logo

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

    This is a plugin that only has a peer dependency to piral-core. What piral-adal brings to the table is a direct integration with Azure Active Directory on basis of the MSAL library that can be used with piral or piral-core.

    The set includes the getAccessToken API to retrieve the current user's access token.

    By default, these Pilet API extensions are not integrated in piral, so you'd need to add them to your Piral instance.

    Why and When

    If you are using authorization with an Microsoft Account or an Active Directory then piral-adal might be a useful plugin. It uses the msal library under the hood and exposes token functionality in common HTTP mechanisms (e.g., using fetch or a library such as axios). Pilets can get the currently available token via the pilet API.

    Alternatives: Use a plugin that is specific to your method of authentication (e.g., piral-auth for generic user management, piral-oidc for generic OpenID Connect, piral-oauth2 for generic OAuth 2, etc.) or just a library.

    Documentation

    The following functions are brought to the Pilet API.

    getAccessToken()

    Gets the currently authenticated user's token or undefined if no user is authenticated.

    Usage

    ::: summary: For pilet authors

    You can use the getAccessToken function from the Pilet API. This returns a promise.

    Example use:

    import { PiletApi } from '<name-of-piral-instance>';
    
    export async function setup(piral: PiletApi) {
      const userToken = await piral.getAccessToken();
      // do something with userToken
    }

    Note that this value may change if the Piral instance supports an "on the fly" login (i.e., a login without redirect / reloading of the page).

    :::

    ::: summary: 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 createAdalApi from the piral-adal package.

    import { createAdalApi } from 'piral-adal';

    The integration looks like:

    import { createAdalApi, setupAdalClient } from 'piral-adal';
    
    const client = setupAdalClient({ clientId, ... });
    
    const instance = createInstance({
      // important part
      plugins: [createAdalApi(client)],
      // ...
    });

    The separation into setupAdalClient and createAdalApi was done to simplify the standard usage.

    Normally, you would want to have different modules here. As an example consider the following code:

    // module adal.ts
    import { setupAdalClient } from 'piral-adal';
    
    export const client = setupAdalClient({ ... });
    
    // app.ts
    import { createAdalApi } from 'piral-adal';
    import { client } from './adal';
    
    export function render() {
      renderInstance({
        // ...
        plugins: [createAdalApi(client)],
      });
    }
    
    // index.ts
    import { client } from './adal';
    
    if (location.pathname !== '/auth') {
      if (client.account()) {
        import('./app').then(({ render }) => render());
      } else {
        client.login();
      }
    }

    This way we evaluate the current path and act accordingly. Note that the actually used path may be different for your application.

    :::

    License

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

    Install

    npm i piral-adal

    DownloadsWeekly Downloads

    628

    Version

    0.13.2

    License

    MIT

    Unpacked Size

    30.7 kB

    Total Files

    33

    Homepage

    piral.io

    Last publish

    Collaborators

    • avatar
    • avatar