From 44042de194e75a5c3da5d7c2529d46f0755c9f63 Mon Sep 17 00:00:00 2001 From: Cornelius Behrend Date: Thu, 21 Jan 2021 10:27:14 +0100 Subject: [PATCH] NFS-1239: Readme templates updated --- docSrc/mainFile.tpl | 2 ++ docSrc/sections/license.tpl | 2 +- docSrc/sections/overview.tpl | 2 +- docs/API.MD | 16 ---------------- package.json | 2 +- 5 files changed, 5 insertions(+), 19 deletions(-) diff --git a/docSrc/mainFile.tpl b/docSrc/mainFile.tpl index 87c74f5..a898775 100644 --- a/docSrc/mainFile.tpl +++ b/docSrc/mainFile.tpl @@ -1,3 +1,5 @@ +[![Build Status](https://travis-ci.org/Staffbase/plugins-sdk-nodejs.svg?branch=master)](https://travis-ci.org/Staffbase/plugins-sdk-nodejs) + # Staffbase Plugins SDK for Node.js. {{{overview}}} diff --git a/docSrc/sections/license.tpl b/docSrc/sections/license.tpl index 5496ac5..2b649fa 100644 --- a/docSrc/sections/license.tpl +++ b/docSrc/sections/license.tpl @@ -1,3 +1,3 @@ -Copyright 2017 Staffbase GmbH. +Copyright 2017-2021 Staffbase GmbH. Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/docSrc/sections/overview.tpl b/docSrc/sections/overview.tpl index 00a9ea6..70f2c6a 100644 --- a/docSrc/sections/overview.tpl +++ b/docSrc/sections/overview.tpl @@ -1 +1 @@ -If you are developing your own plugin for your Staffbase app we describe the authentication flow of a plugin at https://developers.staffbase.com/api/plugin-sso/. 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. +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. diff --git a/docs/API.MD b/docs/API.MD index dbb17b1..cf05704 100644 --- a/docs/API.MD +++ b/docs/API.MD @@ -1,20 +1,4 @@ -## Classes -Global | Description ------- | ----------- -SSOToken | SSOToken Class. Used as an interface to decode the Staffbase SSO Token. -SSOTokenData : SSOTokenData | SSOTokenData Class used to host the token data values and provide getter functions to extract correspinding values. - -## Functions -Global | Description ------- | ----------- -ssoMiddleWare(secret, audience) ⇒ function | Mountable express middleware functions -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. -asCert(cert, type) ⇒ string | asCert converts a binary encoded key to PKCS8 format -isPKCS8Format(key, type) ⇒ Boolean | Checks if the format of the key is similar to PKCS8 Format. -transformKeyToFormat(key, type) ⇒ String | Transforms the provided key to PKCS8 format for supported jwt algorithm. - ## SSOToken SSOToken Class. Used as an interface to decode the Staffbase SSO Token. diff --git a/package.json b/package.json index 5bc9755..c92c4ac 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@staffbase/staffbase-plugin-sdk", - "version": "1.1.1", + "version": "1.1.2", "description": "Staffbase Plugin SDK for Javascript / Node.js", "main": "./dist/index.js", "scripts": {