@staffbase/create-staffbase-plugin 1.0.6 → 1.0.14

package/scaffoldTpl/app.js

@@ -1,77 +1,78 @@
-let express = require('express');
-let path = require('path');
-let favicon = require('serve-favicon');
-let logger = require('morgan');
-let cookieParser = require('cookie-parser');
-let bodyParser = require('body-parser');
+let express = require("express");
+let path = require("path");
+let favicon = require("serve-favicon");
+let logger = require("morgan");
+let cookieParser = require("cookie-parser");
 
-let index = require('./routes/index');
-let users = require('./routes/users');
+let index = require("./routes/index");
+let users = require("./routes/users");
 
 let app = express();
 
 const staffbaseKey = null;
 const pluginID = null;
 let ssoMiddleWare;
-ssoMiddleWare = require('@staffbase/staffbase-plugin-sdk').middleware(staffbaseKey, pluginID);
-
+ssoMiddleWare = require("@staffbase/staffbase-plugin-sdk").middleware(
+  staffbaseKey,
+  pluginID
+);
 
 // view engine setup
-app.set('views', path.join(__dirname, 'views'));
-app.set('view engine', 'pug');
+app.set("views", path.join(__dirname, "views"));
+app.set("view engine", "pug");
 
 // uncomment after placing your favicon in /public
 // app.use(favicon(path.join(__dirname, 'public', 'favicon.ico')));
-app.use(logger('dev'));
-app.use(bodyParser.json());
-app.use(bodyParser.urlencoded({extended: false}));
+app.use(logger("dev"));
+app.use(express.json());
+app.use(express.urlencoded({ extended: false }));
 app.use(cookieParser());
-app.use(express.static(path.join(__dirname, 'public')));
+app.use(express.static(path.join(__dirname, "public")));
 
-app.use('/', index);
-app.use('/users', users);
+app.use("/", index);
+app.use("/users", users);
 
 // Frontend Handler
-app.use('/frontEnd', ssoMiddleWare);
-app.get('/frontEnd', function(req, res) {
-  res.render('plugin', req.sbSSO);
+app.use("/frontEnd", ssoMiddleWare);
+app.get("/frontEnd", function (req, res) {
+  res.render("plugin", req.sbSSO);
 });
 
 // Setup SSO Milleware on the endpoint server
-app.use('/staffbase/sso/backoffice', ssoMiddleWare);
+app.use("/staffbase/sso/backoffice", ssoMiddleWare);
 
 // Handle SSO response from server with decoded data
-app.get('/staffbase/sso/backoffice', function(req, res) {
+app.get("/staffbase/sso/backoffice", function (req, res) {
   // Middleware was able to decode the token
   if (req.sbSSO) {
-    console.log('Decoded data on backend(admin):', req.sbSSO);
-    res.render('plugin', req.sbSSO);
+    console.log("Decoded data on backend(admin):", req.sbSSO);
+    res.render("plugin", req.sbSSO);
     return res.end();
   }
   res.json({
     error: {
-      msg: 'Unable to get token information.',
+      msg: "Unable to get token information.",
     },
   });
   return res.end();
 });
 
 // catch 404 and forward to error handler
-app.use(function(req, res, next) {
-  let err = new Error('Not Found');
+app.use(function (req, res, next) {
+  let err = new Error("Not Found");
   err.status = 404;
   next(err);
 });
 
 // error handler
-app.use(function(err, req, res, next) {
+app.use(function (err, req, res, next) {
   // set locals, only providing error in development
   res.locals.message = err.message;
-  res.locals.error = req.app.get('env') === 'development' ? err : {};
+  res.locals.error = req.app.get("env") === "development" ? err : {};
 
   // render the error page
   res.status(err.status || 500);
-  res.render('error');
+  res.render("error");
 });
 
 module.exports = app;

package/scaffoldTpl/bin/www

@@ -4,18 +4,18 @@
  * Module dependencies.
  */
 
-var app = require('../app');
-var debug = require('debug')('ssosampleserver:server');
-var http = require('http');
+var app = require("../app");
+var debug = require("debug")("ssosampleserver:server");
+var http = require("http");
 
 /**
  * Get port and listen address from environment and store in Express.
  */
 
-var port = normalizePort(process.env.PORT || '3000');
-var address = process.env.ADDRESS || '';
-app.set('port', port);
-app.set('address', port);
+var port = normalizePort(process.env.PORT || "3000");
+var address = process.env.ADDRESS || "";
+app.set("port", port);
+app.set("address", port);
 
 /**
  * Create HTTP server.
@@ -28,8 +28,8 @@ var server = http.createServer(app);
  */
 
 server.listen(port, address);
-server.on('error', onError);
-server.on('listening', onListening);
+server.on("error", onError);
+server.on("listening", onListening);
 
 /**
  * Normalize a port into a number, string, or false.
@@ -56,22 +56,20 @@ function normalizePort(val) {
  */
 
 function onError(error) {
-  if (error.syscall !== 'listen') {
+  if (error.syscall !== "listen") {
     throw error;
   }
 
-  var bind = typeof port === 'string'
-    ? 'Pipe ' + port
-    : 'Port ' + port;
+  var bind = typeof port === "string" ? "Pipe " + port : "Port " + port;
 
   // handle specific listen errors with friendly messages
   switch (error.code) {
-    case 'EACCES':
-      console.error(bind + ' requires elevated privileges');
+    case "EACCES":
+      console.error(bind + " requires elevated privileges");
       process.exit(1);
       break;
-    case 'EADDRINUSE':
-      console.error(bind + ' is already in use');
+    case "EADDRINUSE":
+      console.error(bind + " is already in use");
       process.exit(1);
       break;
     default:
@@ -85,9 +83,9 @@ function onError(error) {
 
 function onListening() {
   var addr = server.address();
-  var bind = typeof addr === 'string'
-    ? 'pipe ' + addr
-    : 'port ' + addr.port;
-  debug('Listening on ' + bind);
-  console.log(`Server listening on ${server.address().address}:${server.address().port}`);
+  var bind = typeof addr === "string" ? "pipe " + addr : "port " + addr.port;
+  debug("Listening on " + bind);
+  console.log(
+    `Server listening on ${server.address().address}:${server.address().port}`
+  );
 }

package/scaffoldTpl/lib/ssoMiddleware/index.js

@@ -1,7 +1,6 @@
-const StaffBaseSSO = require('staffbase-sso').sso;
-const helpers = require('staffbase-sso').helpers;
-const staffbaseSSO1 = require('staffbase-sso');
-const TOKEN_QUERY_PARAM = 'jwt';
+const StaffBaseSSO = require("staffbase-sso").sso;
+const helpers = require("staffbase-sso").helpers;
+const TOKEN_QUERY_PARAM = "jwt";
 
 function ssoMiddleWare(secret) {
   secret = secret || process.env.STAFFBASE_SSO_SECRET;
@@ -10,24 +9,24 @@ function ssoMiddleWare(secret) {
   try {
     formattedSecret = helpers.transformKeyToFormat(secret);
   } catch (err) {
-    console.log('Unable to transform key to right format.', err);
+    console.log("Unable to transform key to right format.", err);
     formattedSecret = null;
   }
-  return function(req, res, next) {
+  return function (req, res, next) {
     if (!formattedSecret) {
-      console.log('Unsupported secret.');
+      console.log("Unsupported secret.");
       return next();
     }
     if (req.query[TOKEN_QUERY_PARAM]) {
       let token = req.query[TOKEN_QUERY_PARAM];
       try {
-      	let SSOContents = new StaffBaseSSO(formattedSecret, token);
-      	let tokenData = SSOContents.getTokenData();
+        let SSOContents = new StaffBaseSSO(formattedSecret, token);
+        let tokenData = SSOContents.getTokenData();
         req.sbSSO = tokenData;
-        console.log('TokenData:', tokenData);
+        console.log("TokenData:", tokenData);
         return next();
-      } catch(tokenErr) {
-      	console.log('Error decoding token:', tokenErr);
+      } catch (err) {
+        console.log("Error decoding token:", err);
         return next();
       }
     }

package/scaffoldTpl/package.json

@@ -7,12 +7,11 @@
   },
   "dependencies": {
     "@staffbase/staffbase-plugin-sdk": "^1.3.1",
-    "body-parser": "~1.19.2",
-    "cookie-parser": "~1.4.5",
-    "debug": "~4.3.1",
-    "express": "~4.17.3",
-    "morgan": "~1.10.0",
-    "pug": ">=3.0.1",
-    "serve-favicon": "~2.5.0"
+    "cookie-parser": "^1.4.7",
+    "debug": "^4.4.3",
+    "express": "^5.2.1",
+    "morgan": "^1.10.0",
+    "pug": "^3.0.3",
+    "serve-favicon": "^2.5.1"
   }
 }

package/scaffoldTpl/public/stylesheets/style.css

@@ -4,5 +4,5 @@ body {
 }
 
 a {
-  color: #00B7FF;
+  color: #00b7ff;
 }

package/scaffoldTpl/routes/index.js

@@ -1,9 +1,9 @@
-let express = require('express');
+let express = require("express");
 let router = express.Router();
 
 /* GET home page. */
-router.get('/', function(req, res, next) {
-  res.render('index', {title: 'Staffbase SSO Server'});
+router.get("/", function (req, res, next) {
+  res.render("index", { title: "Staffbase SSO Server" });
 });
 
 module.exports = router;

package/scaffoldTpl/routes/users.js

@@ -1,9 +1,9 @@
-let express = require('express');
+let express = require("express");
 let router = express.Router();
 
 /* GET users listing. */
-router.get('/', function(req, res, next) {
-  res.send('respond with a resource');
+router.get("/", function (req, res, next) {
+  res.send("respond with a resource");
 });
 
 module.exports = router;

package/scaffoldTpl/views/index.html

@@ -1,19 +1,34 @@
-<p><img src="https://staffbase.com/wp-content/themes/staffbase-theme/img/logo-blau.svg" alt="Staffbase Logo"></p>
-<p>Welcome to your Staffbase SSO plugin server. Please follow the following instructions
-to get started with your Plugin Application.</p>
+<p>
+  Welcome to your Staffbase SSO plugin server. Please follow the following
+  instructions to get started with your Plugin Application.
+</p>
 <h2>Prerequisites</h2>
-<p>In order to get connected with the Staffbase SSO interface, you need a Valid Secret and an Audience ID.</p>
-<p>If you are here, you probably have a secret and audience ID registered with Staffbase. If you are not sure about it or you need more information about Staffbase SSO, feel free to contact the Customer Success team at Staffbase.</p>
+<p>
+  In order to get connected with the Staffbase SSO interface, you need a Valid
+  Secret and an Audience ID.
+</p>
+<p>
+  If you are here, you probably have a secret and audience ID registered with
+  Staffbase. If you are not sure about it or you need more information about
+  Staffbase SSO, feel free to contact the Customer Success team at Staffbase.
+</p>
 <h2>Configuration</h2>
-<p>After the scaffolding is complete, you need to provide some values for configuring your
-plugin server. The following values need to be configured.</p>
+<p>
+  After the scaffolding is complete, you need to provide some values for
+  configuring your plugin server. The following values need to be configured.
+</p>
 <ul>
-<li>Plugin Secret</li>
-<li>Plugin Audience</li>
+  <li>Plugin Secret</li>
+  <li>Plugin Audience</li>
 </ul>
-<p>You can either specify these values in environment variables or directly passing
-the values in the <code>app.js</code> file where the middleware is initialized.</p>
-<p>To configure values in <code>app.js</code> file, change the following lines:</p>
+<p>
+  You can either specify these values in environment variables or directly
+  passing the values in the <code>app.js</code> file where the middleware is
+  initialized.
+</p>
+<p>
+  To configure values in <code>app.js</code> file, change the following lines:
+</p>
 <p>app.js</p>
 <pre><code class="language-javascript">12 ...
 13 ...
@@ -21,40 +36,56 @@ the values in the <code>app.js</code> file where the middleware is initialized.<
 15 const pluginID = null;
 16 ...
 </code></pre>
-<p>You can also specify these values using environment variables.
-Refer to the table to see which environment variables can be used.</p>
+<p>
+  You can also specify these values using environment variables. Refer to the
+  table to see which environment variables can be used.
+</p>
 <table>
-<thead>
-<tr>
-<th style="text-align:left"><em>Value</em></th>
-<th style="text-align:center"><em>Environment Variable</em></th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td style="text-align:left">Secret</td>
-<td style="text-align:center">STAFFBASE_SSO_SECRET</td>
-</tr>
-<tr>
-<td style="text-align:left">Audience</td>
-<td style="text-align:center">STAFFBASE_SSO_AUDIENCE</td>
-</tr>
-<tr>
-<td style="text-align:left">Server Port</td>
-<td style="text-align:center">PORT</td>
-</tr>
-</tbody>
+  <thead>
+    <tr>
+      <th style="text-align: left"><em>Value</em></th>
+      <th style="text-align: center"><em>Environment Variable</em></th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td style="text-align: left">Secret</td>
+      <td style="text-align: center">STAFFBASE_SSO_SECRET</td>
+    </tr>
+    <tr>
+      <td style="text-align: left">Audience</td>
+      <td style="text-align: center">STAFFBASE_SSO_AUDIENCE</td>
+    </tr>
+    <tr>
+      <td style="text-align: left">Server Port</td>
+      <td style="text-align: center">PORT</td>
+    </tr>
+  </tbody>
 </table>
 <h2>Running the server</h2>
-<p><em>create-staffbase-plugin</em> installs the project dependencies for you.
-After configurations is done, the only thing you need to do is navigate to the
-folder where your app was generated and start the express server.</p>
+<p>
+  <em>create-staffbase-plugin</em> installs the project dependencies for you.
+  After configurations is done, the only thing you need to do is navigate to the
+  folder where your app was generated and start the express server.
+</p>
 <pre><code class="language-bash">$ cd [path of generated app]
 $ npm start
 </code></pre>
 <h2>Further Reading</h2>
-<p>For getting more information about Staffbase SSO, please check out the following links:</p>
+<p>
+  For getting more information about Staffbase SSO, please check out the
+  following links:
+</p>
 <ul>
-<li><a href="https://developers.staffbase.com/concepts/customplugin-overview/">Developer Portal: Custom Plugins</a></li>
-<li><a href="https://github.com/Staffbase/plugins-sdk-nodejs/blob/master/README.MD">Staffbase Plugins SDK for Node.js</a></li>
+  <li>
+    <a href="https://developers.staffbase.com/concepts/customplugin-overview/"
+      >Developer Portal: Custom Plugins</a
+    >
+  </li>
+  <li>
+    <a
+      href="https://github.com/Staffbase/plugins-sdk-nodejs/blob/main/README.MD"
+      >Staffbase Plugins SDK for Node.js</a
+    >
+  </li>
 </ul>

package/scripts/genDoc.js

@@ -1,9 +1,9 @@
-const path = require('path');
-const fs = require('fs-extra');
-const hljs = require('highlight.js');
+const path = require("path");
+const fs = require("fs-extra");
+const hljs = require("highlight.js");
 
-const md = require('markdown-it')({
-  highlight: function(str) {
+const md = require("markdown-it")({
+  highlight: function (str) {
     if (str && hljs.getLanguage(str)) {
       try {
         return hljs.highlight(str, true).value;
@@ -12,23 +12,23 @@ const md = require('markdown-it')({
       }
     }
 
-    return ''; // use external default escaping
+    return ""; // use external default escaping
   },
 });
 
-const input = path.resolve(__dirname, '../scaffoldTpl/README.MD');
-const output = path.resolve(__dirname, '../scaffoldTpl/views/index.html');
-console.log('Generating HTML Getting started from README.MD');
-console.log('Reading from:', input);
+const input = path.resolve(__dirname, "../scaffoldTpl/README.MD");
+const output = path.resolve(__dirname, "../scaffoldTpl/views/index.html");
+console.log("Generating HTML Getting started from README.MD");
+console.log("Reading from:", input);
 fs.readFile(input)
-    .then( (inputStr) => {
-      // TODO Add better css in the genreated html
-      const outStr = md.render(inputStr.toString());
-      return fs.outputFile(output, outStr);
-    })
-    .then( (done) => {
-      console.log('File written to:', output);
-    })
-    .catch( (err) => {
-      console.log(err);
-    });
+  .then((inputStr) => {
+    // TODO Add better css in the generated html
+    const outStr = md.render(inputStr.toString());
+    return fs.outputFile(output, outStr);
+  })
+  .then((done) => {
+    console.log("File written to:", output);
+  })
+  .catch((err) => {
+    console.log(err);
+  });