@staffbase/create-staffbase-plugin 1.0.2 → 1.0.8

package/scaffoldTpl/node_modules/@babel/types/scripts/generators/validators.js

@@ -1,87 +0,0 @@
-import definitions from "../../lib/definitions/index.js";
-
-const has = Function.call.bind(Object.prototype.hasOwnProperty);
-
-function joinComparisons(leftArr, right) {
-  return (
-    leftArr.map(JSON.stringify).join(` === ${right} || `) + ` === ${right}`
-  );
-}
-
-function addIsHelper(type, aliasKeys, deprecated) {
-  const targetType = JSON.stringify(type);
-  let aliasSource = "";
-  if (aliasKeys) {
-    aliasSource = joinComparisons(aliasKeys, "nodeType");
-  }
-
-  let placeholderSource = "";
-  const placeholderTypes = [];
-  if (
-    definitions.PLACEHOLDERS.includes(type) &&
-    has(definitions.FLIPPED_ALIAS_KEYS, type)
-  ) {
-    placeholderTypes.push(type);
-  }
-  if (has(definitions.PLACEHOLDERS_FLIPPED_ALIAS, type)) {
-    placeholderTypes.push(...definitions.PLACEHOLDERS_FLIPPED_ALIAS[type]);
-  }
-  if (placeholderTypes.length > 0) {
-    placeholderSource =
-      ' || nodeType === "Placeholder" && (' +
-      joinComparisons(
-        placeholderTypes,
-        "(node as t.Placeholder).expectedNode"
-      ) +
-      ")";
-  }
-
-  const result =
-    definitions.NODE_FIELDS[type] || definitions.FLIPPED_ALIAS_KEYS[type]
-      ? `node is t.${type}`
-      : "boolean";
-
-  return `export function is${type}(node: object | null | undefined, opts?: object | null): ${result} {
-    ${deprecated || ""}
-    if (!node) return false;
-
-    const nodeType = (node as t.Node).type;
-    if (${
-      aliasSource ? aliasSource : `nodeType === ${targetType}`
-    }${placeholderSource}) {
-      if (typeof opts === "undefined") {
-        return true;
-      } else {
-        return shallowEqual(node, opts);
-      }
-    }
-
-    return false;
-  }
-  `;
-}
-
-export default function generateValidators() {
-  let output = `/*
- * This file is auto-generated! Do not modify it directly.
- * To re-generate run 'make build'
- */
-import shallowEqual from "../../utils/shallowEqual";
-import type * as t from "../..";\n\n`;
-
-  Object.keys(definitions.VISITOR_KEYS).forEach(type => {
-    output += addIsHelper(type);
-  });
-
-  Object.keys(definitions.FLIPPED_ALIAS_KEYS).forEach(type => {
-    output += addIsHelper(type, definitions.FLIPPED_ALIAS_KEYS[type]);
-  });
-
-  Object.keys(definitions.DEPRECATED_KEYS).forEach(type => {
-    const newType = definitions.DEPRECATED_KEYS[type];
-    const deprecated = `console.trace("The node type ${type} has been renamed to ${newType}");`;
-    output += addIsHelper(type, null, deprecated);
-  });
-
-  return output;
-}

package/scaffoldTpl/node_modules/@babel/types/scripts/package.json

@@ -1 +0,0 @@
-{ "type": "module" }

package/scaffoldTpl/node_modules/@babel/types/scripts/utils/formatBuilderName.js

@@ -1,8 +0,0 @@
-const toLowerCase = Function.call.bind("".toLowerCase);
-
-export default function formatBuilderName(type) {
-  // FunctionExpression -> functionExpression
-  // JSXIdentifier -> jsxIdentifier
-  // V8IntrinsicIdentifier -> v8IntrinsicIdentifier
-  return type.replace(/^([A-Z](?=[a-z0-9])|[A-Z]+(?=[A-Z]))/, toLowerCase);
-}

package/scaffoldTpl/node_modules/@babel/types/scripts/utils/lowerFirst.js

@@ -1,3 +0,0 @@
-export default function lowerFirst(string) {
-  return string[0].toLowerCase() + string.slice(1);
-}

package/scaffoldTpl/node_modules/@babel/types/scripts/utils/stringifyValidator.js

@@ -1,66 +0,0 @@
-export default function stringifyValidator(validator, nodePrefix) {
-  if (validator === undefined) {
-    return "any";
-  }
-
-  if (validator.each) {
-    return `Array<${stringifyValidator(validator.each, nodePrefix)}>`;
-  }
-
-  if (validator.chainOf) {
-    return stringifyValidator(validator.chainOf[1], nodePrefix);
-  }
-
-  if (validator.oneOf) {
-    return validator.oneOf.map(JSON.stringify).join(" | ");
-  }
-
-  if (validator.oneOfNodeTypes) {
-    return validator.oneOfNodeTypes.map(_ => nodePrefix + _).join(" | ");
-  }
-
-  if (validator.oneOfNodeOrValueTypes) {
-    return validator.oneOfNodeOrValueTypes
-      .map(_ => {
-        return isValueType(_) ? _ : nodePrefix + _;
-      })
-      .join(" | ");
-  }
-
-  if (validator.type) {
-    return validator.type;
-  }
-
-  if (validator.shapeOf) {
-    return (
-      "{ " +
-      Object.keys(validator.shapeOf)
-        .map(shapeKey => {
-          const propertyDefinition = validator.shapeOf[shapeKey];
-          if (propertyDefinition.validate) {
-            const isOptional =
-              propertyDefinition.optional || propertyDefinition.default != null;
-            return (
-              shapeKey +
-              (isOptional ? "?: " : ": ") +
-              stringifyValidator(propertyDefinition.validate)
-            );
-          }
-          return null;
-        })
-        .filter(Boolean)
-        .join(", ") +
-      " }"
-    );
-  }
-
-  return ["any"];
-}
-
-/**
- * Heuristic to decide whether or not the given type is a value type (eg. "null")
- * or a Node type (eg. "Expression").
- */
-function isValueType(type) {
-  return type.charAt(0).toLowerCase() === type.charAt(0);
-}

package/scaffoldTpl/node_modules/@babel/types/scripts/utils/toFunctionName.js

@@ -1,4 +0,0 @@
-export default function toFunctionName(typeName) {
-  const _ = typeName.replace(/^TS/, "ts").replace(/^JSX/, "jsx");
-  return _.slice(0, 1).toLowerCase() + _.slice(1);
-}

package/scaffoldTpl/node_modules/@staffbase/staffbase-plugin-sdk/README.MD

@@ -1,186 +0,0 @@
-[![Build Status](https://github.com/Staffbase/plugins-sdk-nodejs/workflows/Node.js%20CI/badge.svg)](https://github.com/Staffbase/plugins-sdk-nodejs/actions)
-
-# Staffbase Plugins SDK for Node.js.
-
-If you are developing your own plugin for your Staffbase app we describe the authentication flow of a plugin at https://developers.staffbase.com/guide/customplugin-overview/. While this documentation just covers the conceptual ideas of the interface of plugins though – the so called Plugin SSO – we want to provide a library to help you develop your first plugin for Staffbase even faster. This SDK provides the basic functionality to parse and verify a provided token for Node.js.
-
-
-## Installation
-
-The plugin SDK can be fetched from the npm registry (http://npmjs.org/package/staffbase-plugins-nodejs). You can use npm command line tool to install it locally.
-
-    npm install (@staffbase/staffbase-plugin-sdk)
-
-You can also save the module as a local dependency in your project package.json file with the following command:
-
-    npm install --save (@staffbase/staffbase-plugin-sdk)
-
-
-## API Reference
-
-For the API reference of this SDK please consult the [docs](docs/API.MD).
-
-## Usage
-
-After installation you just need to include the module in your own Javascript Program.
-The module can be included using the following syntax:
-
-```javascript
-const StaffBaseSSO = require('@staffbase/staffbase-plugin-sdk').sso;
-```
-## About secret token
-Staffbase backend support only RS256 algorithm of JWT which means that the secret
-you should provide must be the content of public key in the `PKCS8` format.
-This means your public key should start and end with tags:
-
-```
------BEGIN PUBLIC KEY-----
-BASE64 ENCODED DATA
------END PUBLIC KEY-----
-```
-
-You can use the helper function to read and verify if your public key is in the supported format.
-```javascript
-const helpers = require(`@staffbase/staffbase-plugin-sdk`).helpers;
-const publicKeyPath = '[[Your File Path]]';
-let keySecret;
-try {
-	keySecret = helpers.readKeyFile(publicKeyPath);
-} catch (err) {
-	console.log('Error Reading Key file', err);
-}
-```
-
-You can then use keySecret to get an instance of StaffBaseSSO class.
-
-## Getting the SSOTokenData instance
-You should have got your plugin id and Public Key file from Staffbase. After receiving the jwt token
-from the Staffbase backend, you can use the module to get the contents of the token.
-
-```javascript
-const pluginId = '[As received from Staffbase]';
-const publicKey = '[As received from Staffbase]';
-const jwtToken = '[As received in current request via jwt query parameter]';
-let tokenData = null;
-try {
-	let SSOContents = new StaffBaseSSO(pluginId, publicKey, jwtToken);
-	tokenData = SSOContents.getTokenData();
-	console.log('Received token data:', tokenData);
-} catch(tokenErr) {
- 	console.error('Error decoding token:', tokenErr);
-}
-```
-
-If no exception is thrown, you would get a SSOTokenData instance in the tokenData
-variable which you can use to get contents of the SSO Token.
-
-The following data can be retrieved from the token:
-
-|Helper Name|Token Key| Fetch Function| Description|
-| --- | --- | --- | --- |
-|CLAIM_AUDIENCE|aud|getAudience()|Get targeted audience of the token.|
-|CLAIM_EXPIRE_AT|exp|getExpireAtTime()|Get the time when the token expires.|
-|CLAIM_NOT_BEFORE|nbf|getNotBeforeTime()|Get the time when the token starts to be valid.|
-|CLAIM_ISSUED_AT|iat|getIssuedAtTime()|Get the time when the token was issued.|
-|CLAIM_ISSUER|iss|getIssuer()|Get issuer of the token.|
-|CLAIM_INSTANCE_ID|instance_id|getInstanceId()|Get the (plugin) instance id for which the token was issued.|
-|CLAIM_INSTANCE_NAME|instance_name|getInstanceName()|Get the (plugin) instance name for which the token was issued.|
-|CLAIM_USER_ID|sub|getUserId()|Get the id of the authenticated user.|
-|CLAIM_USER_EXTERNAL_ID|external_id|getUserExternalId()|Get the id of the user in an external system.|
-|CLAIM_USER_USERNAME|username|getUserUsername()|Get the username of the user accessing.|
-|CLAIM_USER_PRIMARY_EMAIL_ADDRESS|primary_email_address|getUserPrimaryEmailAddress()|Get the primary email address of the user accessing.|
-|CLAIM_USER_FULL_NAME|name|getFullName()|Get either the combined name of the user or the name of the token.|
-|CLAIM_USER_FIRST_NAME|given_name|getFirstName()|Get the first name of the user accessing.|
-|CLAIM_USER_LAST_NAME|family_name|getLastName()|Get the last name of the user accessing.|
-|CLAIM_USER_ROLE|role|getRole()|Get the role of the accessing user.|
-|CLAIM_ENTITY_TYPE|type|getType()|Get the type of the token.|
-|CLAIM_THEME_TEXT_COLOR|theming_text|getThemeTextColor()|Get text color used in the overall theme for this audience.|
-|CLAIM_THEME_BACKGROUND_COLOR|theming_bg|getThemeBackgroundColor()|Get background color used in the overall theme for this audience.|
-|CLAIM_USER_LOCALE|locale|getLocale()|Get the locale of the requesting user in the format of language tags.|
-
-It is not guaranteed that the token would contain information of all the keys.
-If there is no value for the corresponding field, the SDK would return a `null` value.
-
-## Using with Express
-You can use the provided helper middleware to simply mount it to your express
-server and get an instance of SSOTokenData class in your Express request object.
-
-You need to provide your *Secret Key* and *Plugin ID* to the middleware so it can decode the data.
-The key can be provided in the constructor or by setting an Environment variables `STAFFBASE_SSO_SECRET` and `STAFFBASE_SSO_AUDIENCE` respectively.
-
-To provide the key using constructor:
-```javascript
-const ssoSecret = [[YOUR_PUBLIC_KEY_HERE]];
-const SSOMiddleware = require('@staffbase/staffbase-plugin-sdk').middleware;
-let ssoMiddleWare = ssoMiddleWare(ssoSecret);
-```
-
-After getting an instance of the middleware function, you can simply mount it to your
-SSO URL of the plugin. If the secret is fine and the middleware is able to decode the token,
-an instance of `SSOTokenData` can be used in `req.sbSSO`.
-
-```javascript
-const ssoSecret = [[YOUR_PUBLIC_KEY_HERE]];
-const SSOMiddleware = require('@staffbase/staffbase-plugin-sdk').middleware;
-let ssoMiddleWare = SSOMiddleware(ssoSecret);
-
-const redirectURL = '/staffbase/sso/backoffice';
-let express = require('express');
-let app = express();
-
-// Request Handler for client side of plugin
-app.use('/frontEnd', ssoMiddleWare);
-app.get('/frontEnd', function(req, res) {
-  if (req.sbSSO) {
-    // Render the decoded object using Express templating engine
-    return res.render('plugin', req.sbSSO);
-  }
-  return res.end("Unable to decode token data");
-});
-
-// Apply middleware on the SSO URL
-app.use(redirectURL, ssoMiddleWare);
-// Your request handler for admin side of plugin below
-app.get(redirectURL, function(req, res) {
-  // Middleware was able to decode the token
-  // console.log('Got SSO Request from backend', req.query);
-  if (req.sbSSO) {
-    let ssoTokenData = req.sbSSO;
-    // Send back the token data back.
-    res.json(ssoTokenData);
-    return res.end();
-  }
-  res.json({
-    error: {
-      msg: "Unable to get token information."
-    }
-  });
-  return res.end();
-});
-```
-
-### Generating Express Template
-You can also use the `create-staffbase-plugin` CLI tool to start a template for a basic
-express server configured with the SDK. For more detail please check out the
-[Project Repo](https://github.com/Staffbase/create-staffbase-plugin-nodejs).
-
-
-## Contribution
-
-- Fork it
-- Create a branch `git checkout -b feature-description`
-- Put your name into authors.txt
-- Commit your changes `git commit -am "Added ...."`
-- Push to the branch `git push origin feature-description`
-- Open a Pull Request
-
-## Running Tests
-
-To run the tests a simple `# npm test` command in the root directory will suffice. The tests are run using the Jest  framework. Please consult [jest](https://facebook.github.io/jest/) to learn more about writing unit tests for the plugin.
-
-## License
-
-Copyright 2017-2021 Staffbase GmbH.
-
-Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0
-

package/scaffoldTpl/node_modules/@staffbase/staffbase-plugin-sdk/docs/API.MD

@@ -1,272 +0,0 @@
-
-## SSOToken
-SSOToken Class. Used as an interface to decode the Staffbase SSO Token.
-
-**Kind**: global class  
-
-* [SSOToken](#markdown-header-ssotoken)
-    * [new SSOToken(audience, appSecret, tokenData)](#markdown-header-new-ssotokenaudience-appsecret-tokendata)
-    * [.getTokenData()](#markdown-header-ssotokengettokendata-ssotokendata) ⇒ SSOTokenData
-
-### new SSOToken(audience, appSecret, tokenData)
-Create an instance of SSOToken to parse signed token data received from StaffBase backend.
-
-
-| Param | Type | Description |
-| --- | --- | --- |
-| audience | String | Audience param of jwt. This is the your plugin ID registered in StaffBase servers |
-| appSecret | String | App Secret used to decode the token data |
-| tokenData | String | Signed Token Data to be decoded |
-
-### ssoToken.getTokenData() ⇒ SSOTokenData
-Get  TokenData Object parsed by the SSOToken class.
-
-**Kind**: instance method of [SSOToken](#markdown-header-new-ssotokenaudience-appsecret-tokendata)  
-**Returns**: SSOTokenData - a TokenData object which can be used  to get SSO Token inforamtion.  
-## SSOTokenData : SSOTokenData
-SSOTokenData Class used to host the token data values and provide getter functions to extract correspinding values.
-
-**Kind**: global class  
-
-* [SSOTokenData](#markdown-header-ssotokendata-ssotokendata) : [SSOTokenData](#markdown-header-ssotokendata-ssotokendata)
-    * [new SSOTokenData(tokenVals)](#markdown-header-new-ssotokendatatokenvals)
-    * [.getSigned(secret, cb)](#markdown-header-ssotokendatagetsignedsecret-cb-string) ⇒ String
-    * [._getSignedWrong(secret, cb)](#markdown-header-ssotokendata_getsignedwrongsecret-cb-string) ⇒ String
-    * [.toJSObj()](#markdown-header-ssotokendatatojsobj-object) ⇒ Object
-    * [.toJSObjPretty()](#markdown-header-ssotokendatatojsobjpretty-object) ⇒ Object
-    * [._getClaim(claimName)](#markdown-header-ssotokendata_getclaimclaimname-stringnumbernull) ⇒ String ⎮ number ⎮ null
-    * [.getAudience()](#markdown-header-ssotokendatagetaudience-nullstring) ⇒ null ⎮ string
-    * [.getExpireAtTime()](#markdown-header-ssotokendatagetexpireattime-number) ⇒ number
-    * [.getNotBeforeTime()](#markdown-header-ssotokendatagetnotbeforetime-number) ⇒ number
-    * [.getIssuedAtTime()](#markdown-header-ssotokendatagetissuedattime-number) ⇒ number
-    * [.getIssuer()](#markdown-header-ssotokendatagetissuer-nullstring) ⇒ null ⎮ string
-    * [.getInstanceId()](#markdown-header-ssotokendatagetinstanceid-string) ⇒ string
-    * [.getInstanceName()](#markdown-header-ssotokendatagetinstancename-nullstring) ⇒ null ⎮ string
-    * [.getUserId()](#markdown-header-ssotokendatagetuserid-nullstring) ⇒ null ⎮ string
-    * [.getUserExternalId()](#markdown-header-ssotokendatagetuserexternalid-nullstring) ⇒ null ⎮ string
-    * [.getUserUsername()](#markdown-header-ssotokendatagetuserusername-nullstring) ⇒ null ⎮ string
-    * [.getUserPrimaryEmailAddress()](#markdown-header-ssotokendatagetuserprimaryemailaddress-nullstring) ⇒ null ⎮ string
-    * [.getFullName()](#markdown-header-ssotokendatagetfullname-nullstring) ⇒ null ⎮ string
-    * [.getFirstName()](#markdown-header-ssotokendatagetfirstname-nullstring) ⇒ null ⎮ string
-    * [.getLastName()](#markdown-header-ssotokendatagetlastname-nullstring) ⇒ null ⎮ string
-    * [.getRole()](#markdown-header-ssotokendatagetrole-nullstring) ⇒ null ⎮ string
-    * [.getType()](#markdown-header-ssotokendatagettype-nullstring) ⇒ null ⎮ string
-    * [.getThemeTextColor()](#markdown-header-ssotokendatagetthemetextcolor-nullstring) ⇒ null ⎮ string
-    * [.getThemeBackgroundColor()](#markdown-header-ssotokendatagetthemebackgroundcolor-nullstring) ⇒ null ⎮ string
-    * [.getLocale()](#markdown-header-ssotokendatagetlocale-nullstring) ⇒ null ⎮ string
-    * [.isEditor()](#markdown-header-ssotokendataiseditor-boolean) ⇒ boolean
-    * [.getTags()](#markdown-header-ssotokendatagettags-arraystring) ⇒ Array.<String>
-
-### new SSOTokenData(tokenVals)
-SSO Token Data
-
-
-| Param | Type | Description |
-| --- | --- | --- |
-| tokenVals | Object | TokenVals object wit keys representing possible SSO token values. |
-
-### ssoTokenData.getSigned(secret, cb) ⇒ String
-Get signed string representation of the token data
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-**Returns**: String - Signed representation of the token data. Returns
-if no callback is specified.  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| secret | String | The Secret to be used for signing the token. The supported algorithm is RS256 so it is important that the secret is read from a private key file. |
-| cb | function | Optional callback function to get the signed data in a callback pattern. |
-
-### ssoTokenData._getSignedWrong(secret, cb) ⇒ String
-Get a wrong signed string representation of the token data with a non supported
-(by Staffbase) Algotirhm. (Private). Used for tests
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-**Returns**: String - Signed representation of the token data. Returns
-if no callback is specified.  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| secret | String | The Secret to be used for signing the token |
-| cb | function | Optional callback function to get the signed data in a callback pattern. |
-
-### ssoTokenData.toJSObj() ⇒ Object
-Convert Token Data to an internally used keys for Claims
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-**Returns**: Object - With internally  represented values for the jwt  
-### ssoTokenData.toJSObjPretty() ⇒ Object
-Convert Token  Data to a CLAIM Represented JS Object
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-**Returns**: Object - with possible Claim Values.  
-### ssoTokenData._getClaim(claimName) ⇒ String ⎮ number ⎮ null
-Internally used to get value against the client param string.
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-**Returns**: String ⎮ number ⎮ null - The  correspinding value of the Specified claim name.  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| claimName | String | The claim name as defined in the tokenDataConsts |
-
-### ssoTokenData.getAudience() ⇒ null ⎮ string
-Get targeted audience of the token.
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-### ssoTokenData.getExpireAtTime() ⇒ number
-Get the time when the token expires.
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-### ssoTokenData.getNotBeforeTime() ⇒ number
-Get the time when the token starts to be valid.
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-### ssoTokenData.getIssuedAtTime() ⇒ number
-Get the time when the token was issued.
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-### ssoTokenData.getIssuer() ⇒ null ⎮ string
-Get issuer of the token.
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-### ssoTokenData.getInstanceId() ⇒ string
-Get the (plugin) instance id for which the token was issued.
-
-The id will always be present.
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-### ssoTokenData.getInstanceName() ⇒ null ⎮ string
-Get the (plugin) instance name for which the token was issued.
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-### ssoTokenData.getUserId() ⇒ null ⎮ string
-Get the id of the authenticated user.
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-### ssoTokenData.getUserExternalId() ⇒ null ⎮ string
-Get the id of the user in an external system.
-
-Example use case would be to map user from an external store
-to the entry defined in the token.
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-### ssoTokenData.getUserUsername() ⇒ null ⎮ string
-Get the username of the user accessing.
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-### ssoTokenData.getUserPrimaryEmailAddress() ⇒ null ⎮ string
-Get the primary email address of the user accessing.
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-### ssoTokenData.getFullName() ⇒ null ⎮ string
-Get either the combined name of the user or the name of the token.
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-### ssoTokenData.getFirstName() ⇒ null ⎮ string
-Get the first name of the user accessing.
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-### ssoTokenData.getLastName() ⇒ null ⎮ string
-Get the last name of the user accessing.
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-### ssoTokenData.getRole() ⇒ null ⎮ string
-Get the role of the accessing user.
-
-If this is set to “editor”, the requesting user may manage the contents
-of the plugin instance, i.e. she has administration rights.
-The type of the accessing entity can be either a “user” or a “editor”.
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-### ssoTokenData.getType() ⇒ null ⎮ string
-Get the type of the token.
-
-The type of the accessing entity can be either a “user” or a “token”.
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-### ssoTokenData.getThemeTextColor() ⇒ null ⎮ string
-Get text color used in the overall theme for this audience.
-
-The color is represented as a CSS-HEX code.
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-### ssoTokenData.getThemeBackgroundColor() ⇒ null ⎮ string
-Get background color used in the overall theme for this audience.
-
-The color is represented as a CSS-HEX code.
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-### ssoTokenData.getLocale() ⇒ null ⎮ string
-Get the locale of the requesting user in the format of language tags.
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-### ssoTokenData.isEditor() ⇒ boolean
-Check if the user is an editor.
-
-The user will always have a user role to prevent a bug class
-on missing values. Only when the editor role is explicitly
-provided the user will be marked as editor.
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-### ssoTokenData.getTags() ⇒ Array.<String>
-Get User Tags
-
-**Kind**: instance method of [SSOTokenData](#markdown-header-new-ssotokendatatokenvals)  
-**Returns**: Array.<String> - A String array containing user tags.  
-## ssoMiddleWare(secret, audience) ⇒ function
-Mountable express middleware functions
-
-**Kind**: global function  
-**Returns**: function - Calls the next() handler in the roule handlers chain  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| secret | string | The secret public provided by StaffBase |
-| audience | String | Audience parma of jwt. This is the your plugin ID registered in StaffBase servers |
-
-## readKeyFile(path, cb) ⇒ String
-Reads public key file from the specified path and returns a string representation
-of the key to be used to decode token.
-
-**Kind**: global function  
-**Returns**: String - String representation of the key file  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| path | String | The path of the private key file. |
-| cb | function | Optional callback function to use this in an async way |
-
-## asCert(cert, type) ⇒ string
-asCert converts a binary encoded key to PKCS8 format
-
-**Kind**: global function  
-**Returns**: string - the PKCS8 representation of the key  
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| cert | string |  | the binary endoded key string |
-| type | string | `"PUBLIC KEY"` | the type of key 'PUBLIC KEY'|'PRIVATE KEY' |
-
-## isPKCS8Format(key, type) ⇒ Boolean
-Checks if the format of the key is similar to PKCS8 Format.
-
-**Kind**: global function  
-**Returns**: Boolean - true if its similat to PKCS8 otherwise false.  
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| key | String |  | The public key file string. |
-| type | String | `PUBLIC KEY` | the type of key 'PUBLIC KEY'|'PRIVATE KEY' |
-
-## transformKeyToFormat(key, type) ⇒ String
-Transforms the provided key to PKCS8 format for supported jwt algorithm.
-
-**Kind**: global function  
-**Returns**: String - The public key in PKCS8 format.  
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| key | String |  | The public key file string. |
-| type | String | `PUBLIC KEY` | the type of key 'PUBLIC KEY'|'PRIVATE KEY' |
-