@staffbase/create-staffbase-plugin 1.0.6 → 1.0.8

package/.github/CODEOWNERS

@@ -1,9 +1,9 @@
 # Shared
-.github/CODEOWNERS      @Staffbase/cc-tech
+.github/CODEOWNERS      @Staffbase/cs-tech
 
 # Global
 *                       @maximizeIT
 
 # Misc
-package.json            @maximizeIT @Staffbot
-yarn.lock               @maximizeIT @Staffbot
+package.json            @maximizeIT
+yarn.lock               @maximizeIT

package/.github/workflows/auto-merge.yml

@@ -4,7 +4,7 @@ on: pull_request
 
 jobs:
   dependabot:
-    uses: Staffbase/gha-workflows/.github/workflows/template_automerge_dependabot.yml@v4.0.2
+    uses: Staffbase/gha-workflows/.github/workflows/template_automerge_dependabot.yml@v7.2.0
     secrets:
       app_id: ${{ vars.STAFFBASE_ACTIONS_APP_ID }}
       private_key: ${{ secrets.STAFFBASE_ACTIONS_PRIVATE_KEY }}

package/.github/workflows/publish-npm.yml

@@ -0,0 +1,23 @@
+name: Publish to NPM Registry
+on:
+  release:
+    types: [created]
+
+permissions:
+  contents: read  # we need to read secrets
+  id-token: write
+  
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          registry-url: 'https://registry.npmjs.org'
+      - name: Publish package on NPM 📦
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/{README.MD → README.md}

@@ -1,5 +1,6 @@
 # Create-Staffbase-SSO-CLI Documentation
 ![Staffbase Logo](https://staffbase.com/wp-content/themes/staffbase-theme/img/logo-blau.svg)
+
 ## Getting started
 Install the package in your global namespace and then run the command.
 
@@ -15,6 +16,7 @@ Example:
 ```bash
 $ yarn create @staffbase/staffbase-plugin /home/user1/work/staffbase-server/ --name staffbase-sso-server
 ```
+
 ## Interactive Mode
 You can also run the command without passing any arguments to get into interactive
 mode which would ask you the name of your app and the path where it need to be installed.
@@ -74,7 +76,7 @@ $ npm start
 
 ## License
 
-Copyright 2017-2024 Staffbase GmbH.
+Copyright 2017-2025 Staffbase SE.
 
 Licensed under the Apache License, Version 2.0: https://www.apache.org/licenses/LICENSE-2.0
 
@@ -84,9 +86,9 @@ Licensed under the Apache License, Version 2.0: https://www.apache.org/licenses/
       <img src="docs/assets/images/staffbase.png" alt="Staffbase GmbH" width="96" />
     </td>
     <td>
-      <b>Staffbase GmbH</b>
-      <br />Staffbase is an internal communications platform built to revolutionize the way you work and unite your company. Staffbase is hiring: <a href="https://jobs.staffbase.com" target="_blank" rel="noreferrer">jobs.staffbase.com</a>
-      <br /><a href="https://github.com/Staffbase" target="_blank" rel="noreferrer">GitHub</a> | <a href="https://staffbase.com/" target="_blank" rel="noreferrer">Website</a> | <a href="https://jobs.staffbase.com" target="_blank" rel="noreferrer">Jobs</a>
+      <b>Staffbase SE</b>
+      <br />Staffbase is an internal communications platform built to revolutionize the way you work and unite your company. Staffbase is hiring: <a href="https://staffbase.com/jobs/" target="_blank" rel="noreferrer">https://staffbase.com/jobs</a>
+      <br /><a href="https://github.com/Staffbase" target="_blank" rel="noreferrer">GitHub</a> | <a href="https://staffbase.com/" target="_blank" rel="noreferrer">Website</a> | <a href="https://staffbase.com/jobs/" target="_blank" rel="noreferrer">Jobs</a>
     </td>
   </tr>
 </table>

package/catalog-info.yaml

@@ -0,0 +1,14 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: create-staffbase-plugin-nodejs
+  description: Node.js plugin skeleton generator provided by Staffbase
+  annotations:
+    github.com/project-slug: Staffbase/create-staffbase-plugin-nodejs
+    jfrog-artifactory/image-name: create-staffbase-plugin-nodejs
+  tags:
+    - js
+    - nodejs
+spec:
+  type: service
+  lifecycle: production

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@staffbase/create-staffbase-plugin",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "bin": {
     "create-staffbase-plugin": "csss.js"
   },
@@ -35,15 +35,15 @@
     "@typescript-eslint/eslint-plugin": "^5.50.0",
     "@typescript-eslint/parser": "^5.50.0",
     "eslint": "^8.33.0",
+    "eslint-config-google": "^0.14.0",
     "eslint-config-prettier": "^8.6.0",
-    "eslint-plugin-react": "^7.32.2",
     "eslint-plugin-import-helpers": "^1.1.0",
+    "eslint-plugin-react": "^7.32.2",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-simple-import-sort": "^10.0.0",
-    "eslint-config-google": "^0.14.0",
     "highlight.js": "^10.0.3",
     "husky": "^4.2.5",
-    "jest": "^26.0.1",
+    "jest": "^29.7.0",
     "markdown-it": "^12.3.2",
     "marked": "^4.0.10",
     "typescript": "^4.9.5"

package/scaffoldTpl/app.js

@@ -1,77 +1,79 @@
-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 bodyParser = require("body-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(logger("dev"));
 app.use(bodyParser.json());
-app.use(bodyParser.urlencoded({extended: false}));
+app.use(bodyParser.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/package.json

@@ -7,10 +7,10 @@
   },
   "dependencies": {
     "@staffbase/staffbase-plugin-sdk": "^1.3.1",
-    "body-parser": "~1.19.2",
+    "body-parser": "~1.20.3",
     "cookie-parser": "~1.4.5",
-    "debug": "~4.3.1",
-    "express": "~4.17.3",
+    "debug": "~4.4.0",
+    "express": "~4.21.2",
     "morgan": "~1.10.0",
     "pug": ">=3.0.1",
     "serve-favicon": "~2.5.0"

package/scaffoldTpl/views/index.html

@@ -1,19 +1,40 @@
-<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>
+  <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>
 <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 +42,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/master/README.md"
+      >Staffbase Plugins SDK for Node.js</a
+    >
+  </li>
 </ul>