Avanzar-Auth.JS

A JavaScript SDK for Avanzar-Auth

Getting Avanzar-Auth.js

Using npm

npm install avanzar-auth.js@latest

Download from a580mftt01 Keep in mind you can't use the typescript module if you choose to go this route

import { getClient } from 'http://a580mftt01:5015/prod/JS/AvanzarAuthClient.js';

Using Avanzar-Auth.js

1. Import the client

// We import get client to get the client AvanzarAuthClient is optional but helps with intellisense
import { getClient, AvanzarAuthClient } from 'avanzar-auth.js/prod/TS/AvanzarAuthClient';

2. Get the client

// The audience should be set to whatever your API is expecting in its configuration
// In this case I am using the Auth-Testing.API so my audience is configured as such
const client: AvanzarAuthClient = await getClient({ audience: "http://a580mftt01:5099" });

Now you can use the client!

Getting the user

import { getClient, AvanzarAuthClient, User } from 'avanzar-auth.js/prod/TS/AvanzarAuthClient';

const client: AvanzarAuthClient = await getClient({ audience: "http://a580mftt01:5099" });

let user: User = client.user;

// Alternatively you can use
user = client.getUser();

Checking if the user is still logged in The client does handle refreshing the tokens for the user but we understand it can be necessary to see the current state of the user as it updates. For this reason on refresh the 'refresh' event is fired from the client.

import { getClient, AvanzarAuthClient } from 'avanzar-auth.js/prod/TS/AvanzarAuthClient';

const client: AvanzarAuthClient = await getClient({ audience: "http://a580mftt01:5099" });

client.on('refresh',() => {
  console.log('Refreshed!');
});

Getting the access token

import { getClient, AvanzarAuthClient } from 'avanzar-auth.js/prod/TS/AvanzarAuthClient';

const client: AvanzarAuthClient = await getClient({ audience: "http://a580mftt01:5099" });

const token = client.getToken();

// Authenticate to an api using the token

Sign In / Sign Out The auth client implements a login and logout method to handle redirection to the Avanzar Login Form

import { getClient, AvanzarAuthClient } from 'avanzar-auth.js/prod/TS/AvanzarAuthClient';

const client: AvanzarAuthClient = await getClient({ audience: "http://a580mftt01:5099" });

const login = () => {
  client.login();
};

const logout = () => {
  client.logout();
};

There is also a full example application at https://github.com/Avanzar-PC/Avanzar-Auth.ex.svelte

Contributing

Publishing

npm publish