Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 1,000,000+ packages pre-installed, including piral-adal with all npm packages installed. Try it out:

require("piral-core/package.json"); // piral-core is a peer dependency. var piralAdal = require("piral-adal")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

piral-adal v0.12.2

Plugin to integrate AAD authentication in Piral.

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.

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.

Metadata

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free