agendash 2.0.0 → 3.1.0

package/README.md

@@ -41,8 +41,6 @@ A Dashboard for [Agenda](https://github.com/agenda/agenda).
 
 ![Mobile UI small devices](mobile-ui-sm.png)
 
-
-
 ![Mobile UI extra small devices](mobile-ui-xs.png)
 
 ---
@@ -75,7 +73,7 @@ db.agendaJobs.ensureIndex({
 npm install --save agendash
 ```
 
-*Note*: `Agendash` requires mongodb version >2.6.0 to perform the needed aggregate queries. This is your mongo database version, not your node package version! To check your database version, connect to mongo and run `db.version()`.
+_Note_: `Agendash` requires mongodb version >2.6.0 to perform the needed aggregate queries. This is your mongo database version, not your node package version! To check your database version, connect to mongo and run `db.version()`.
 
 ### Middleware usage
 
@@ -86,19 +84,19 @@ make Agendash available on your site at the `/dash` path. Note: Do not try to mo
 at the root level like `app.use('/', Agendash(agenda))`.
 
 ```js
-var express = require('express');
+var express = require("express");
 var app = express();
 
 // ... your other express middleware like body-parser
 
-var Agenda = require('agenda');
-var Agendash = require('agendash');
+var Agenda = require("agenda");
+var Agendash = require("agendash");
 
-var agenda = new Agenda({db: {address: 'mongodb://127.0.0.1/agendaDb'}});
+var agenda = new Agenda({ db: { address: "mongodb://127.0.0.1/agendaDb" } });
 // or provide your own mongo client:
 // var agenda = new Agenda({mongo: myMongoClient})
 
-app.use('/dash', Agendash(agenda));
+app.use("/dash", Agendash(agenda));
 
 // ... your other routes
 
@@ -110,7 +108,8 @@ own authentication for that path. For example if you have an authenticated
 session using passport, you can protect the dashboard path like this:
 
 ```js
-app.use('/dash',
+app.use(
+  "/dash",
   function (req, res, next) {
     if (!req.user || !req.user.is_admin) {
       res.send(401);
@@ -126,9 +125,12 @@ Other middlewares will come soon in the folder `/lib/middlewares/`.
 You'll just have to update the last line to require the middleware you need:
 
 ```js
-app.use('/agendash', Agendash(agenda, {
-  middleware: 'connect'
-}));
+app.use(
+  "/agendash",
+  Agendash(agenda, {
+    middleware: "connect",
+  })
+);
 ```
 
 Note that if you use a CSRF protection middleware like [`csurf`](https://www.npmjs.com/package/csurf), you might need to [configure it off](https://github.com/agenda/agendash/issues/23#issuecomment-270917949) for Agendash-routes.
@@ -142,16 +144,21 @@ npm i @hapi/inert @hapi/hapi
 ```
 
 ```js
-const agenda = new Agenda().database("mongodb://127.0.0.1/agendaDb", "agendaJobs");
+const agenda = new Agenda().database(
+  "mongodb://127.0.0.1/agendaDb",
+  "agendaJobs"
+);
 
-const server = require('@hapi/hapi').server({
+const server = require("@hapi/hapi").server({
   port: 3002,
-  host: 'localhost'
+  host: "localhost",
 });
-await server.register(require('@hapi/inert'));
-await server.register(Agendash(agenda, {
-  middleware: 'hapi'
-}));
+await server.register(require("@hapi/inert"));
+await server.register(
+  Agendash(agenda, {
+    middleware: "hapi",
+  })
+);
 
 await server.start();
 ```
@@ -165,12 +172,15 @@ npm i koa koa-bodyparser koa-router koa-static
 ```
 
 ```js
-const agenda = new Agenda().database("mongodb://127.0.0.1/agendaDb", "agendaJobs");
+const agenda = new Agenda().database(
+  "mongodb://127.0.0.1/agendaDb",
+  "agendaJobs"
+);
 
-const Koa = require('koa');
+const Koa = require("koa");
 const app = new Koa();
 const middlewares = Agendash(agenda, {
-  middleware: 'koa'
+  middleware: "koa",
 });
 for (const middleware of middlewares) {
   app.use(middleware);
@@ -181,6 +191,33 @@ await app.listen(3002);
 
 Then browse to `http://localhost:3002/`.
 
+#### Fastify
+
+```shell
+npm i fastify
+```
+
+```js
+const agenda = new Agenda().database(
+  "mongodb://127.0.0.1/agendaDb",
+  "agendaJobs"
+);
+
+const Fastify = require("fastify");
+const fastify = new Fastify();
+
+fastify.register(
+  Agendash(
+    agenda, 
+    { middleware: "fastify" }
+  );
+);
+
+await fastify.listen(3002);
+```
+
+Then browse to `http://localhost:3002/`.
+
 ### Standalone usage
 
 Agendash comes with a standalone Express app which you can use like this:

package/app.js

@@ -1,14 +1,18 @@
-'use strict';
-const path = require('path');
+"use strict";
+const path = require("path");
 
 module.exports = (agenda, options) => {
   options = options || {};
   if (!options.middleware) {
-    options.middleware = 'express';
+    options.middleware = "express";
   }
 
-  const agendash = require('./lib/controllers/agendash')(agenda, options);
-  const middlewarePath = path.join(__dirname, './lib/middlewares', options.middleware);
+  const agendash = require("./lib/controllers/agendash")(agenda, options);
+  const middlewarePath = path.join(
+    __dirname,
+    "./lib/middlewares",
+    options.middleware
+  );
 
   try {
     return require(middlewarePath)(agendash);

package/bin/agendash-standalone-fastify.js

@@ -0,0 +1,61 @@
+#!/usr/bin/env node
+"use strict";
+const Agenda = require("agenda");
+const agendash = require("../app");
+const Fastify = require("fastify");
+const program = require("commander");
+
+program
+  .option(
+    "-d, --db <db>",
+    "[required] Mongo connection string, same as Agenda connection string"
+  )
+  .option(
+    "-c, --collection <collection>",
+    "[optional] Mongo collection, same as Agenda collection name, default agendaJobs",
+    "agendaJobs"
+  )
+  .option(
+    "-p, --port <port>",
+    "[optional] Server port, default 3000",
+    (n, d) => Number(n) || d,
+    3000
+  )
+  .option(
+    "-t, --title <title>",
+    "[optional] Page title, default Agendash",
+    "Agendash"
+  )
+  .option(
+    "-p, --path <path>",
+    "[optional] Path to bind Agendash to, default /",
+    "/"
+  )
+  .parse(process.argv);
+
+if (!program.db) {
+  console.error("--db required");
+  process.exit(1);
+}
+
+if (!program.path.startsWith("/")) {
+  console.error("--path must begin with /");
+  process.exit(1);
+}
+
+const fastify = Fastify();
+
+const agenda = new Agenda().database(program.db, program.collection);
+
+fastify.register(
+  agendash(agenda, {
+    middleware: "fastify",
+    title: program.title,
+  })
+);
+
+fastify.listen(program.port, function () {
+  console.log(
+    `Agendash started http://localhost:${program.port}${program.path}`
+  );
+});

package/bin/agendash-standalone-hapi.js

@@ -1,40 +1,58 @@
 #!/usr/bin/env node
-'use strict';
-const Agenda = require('agenda');
-const agendash = require('../app');
-const Hapi = require('@hapi/hapi');
-const program = require('commander');
+"use strict";
+const { Agenda } = require("agenda");
+const agendash = require("../app");
+const Hapi = require("@hapi/hapi");
+const program = require("commander");
 
 program
-  .option('-d, --db <db>', '[required] Mongo connection string, same as Agenda connection string')
-  .option('-c, --collection <collection>', '[optional] Mongo collection, same as Agenda collection name, default agendaJobs', 'agendaJobs')
-  .option('-p, --port <port>', '[optional] Server port, default 3000', (n, d) => Number(n) || d, 3000)
-  .option('-t, --title <title>', '[optional] Page title, default Agendash', 'Agendash')
+  .option(
+    "-d, --db <db>",
+    "[required] Mongo connection string, same as Agenda connection string"
+  )
+  .option(
+    "-c, --collection <collection>",
+    "[optional] Mongo collection, same as Agenda collection name, default agendaJobs",
+    "agendaJobs"
+  )
+  .option(
+    "-p, --port <port>",
+    "[optional] Server port, default 3000",
+    (n, d) => Number(n) || d,
+    3000
+  )
+  .option(
+    "-t, --title <title>",
+    "[optional] Page title, default Agendash",
+    "Agendash"
+  )
   .parse(process.argv);
 
 if (!program.db) {
-  console.error('--db required');
+  console.error("--db required");
   process.exit(1);
 }
 
-const init = async() => {
+const init = async () => {
   const server = Hapi.server({
     port: 3002,
-    host: 'localhost'
+    host: "localhost",
   });
 
   const agenda = new Agenda().database(program.db, program.collection);
 
-  await server.register(require('@hapi/inert'));
-  await server.register(agendash(agenda, {
-    middleware: 'hapi'
-  }));
+  await server.register(require("@hapi/inert"));
+  await server.register(
+    agendash(agenda, {
+      middleware: "hapi",
+    })
+  );
 
   await server.start();
-  console.log('Server running on %s', server.info.uri);
+  console.log("Server running on %s", server.info.uri);
 };
 
-process.on('unhandledRejection', error => {
+process.on("unhandledRejection", (error) => {
   console.log(error);
   process.exit(1);
 });

package/bin/agendash-standalone-koa.js

@@ -1,38 +1,54 @@
 #!/usr/bin/env node
-'use strict';
-const Agenda = require('agenda');
-const agendash = require('../app');
-const Koa = require('koa');
-const program = require('commander');
+"use strict";
+const { Agenda } = require("agenda");
+const agendash = require("../app");
+const Koa = require("koa");
+const program = require("commander");
 
 program
-  .option('-d, --db <db>', '[required] Mongo connection string, same as Agenda connection string')
-  .option('-c, --collection <collection>', '[optional] Mongo collection, same as Agenda collection name, default agendaJobs', 'agendaJobs')
-  .option('-p, --port <port>', '[optional] Server port, default 3000', (n, d) => Number(n) || d, 3000)
-  .option('-t, --title <title>', '[optional] Page title, default Agendash', 'Agendash')
+  .option(
+    "-d, --db <db>",
+    "[required] Mongo connection string, same as Agenda connection string"
+  )
+  .option(
+    "-c, --collection <collection>",
+    "[optional] Mongo collection, same as Agenda collection name, default agendaJobs",
+    "agendaJobs"
+  )
+  .option(
+    "-p, --port <port>",
+    "[optional] Server port, default 3000",
+    (n, d) => Number(n) || d,
+    3000
+  )
+  .option(
+    "-t, --title <title>",
+    "[optional] Page title, default Agendash",
+    "Agendash"
+  )
   .parse(process.argv);
 
 if (!program.db) {
-  console.error('--db required');
+  console.error("--db required");
   process.exit(1);
 }
 
-const init = async() => {
+const init = async () => {
   const agenda = new Agenda().database(program.db, program.collection);
 
   const app = new Koa();
   const middlewares = agendash(agenda, {
-    middleware: 'koa'
+    middleware: "koa",
   });
   for (const middleware of middlewares) {
     app.use(middleware);
   }
 
   await app.listen(program.port);
-  console.log('Server running on port %s', program.port);
+  console.log("Server running on port %s", program.port);
 };
 
-process.on('unhandledRejection', error => {
+process.on("unhandledRejection", (error) => {
   console.log(error);
   process.exit(1);
 });

package/bin/agendash-standalone.js

@@ -1,39 +1,64 @@
 #!/usr/bin/env node
-'use strict';
-const http = require('http');
-const Agenda = require('agenda');
-const agendash = require('../app');
-const express = require('express');
-const program = require('commander');
+"use strict";
+const http = require("http");
+const { Agenda } = require("agenda");
+const agendash = require("../app");
+const express = require("express");
+const program = require("commander");
 
 program
-  .option('-d, --db <db>', '[required] Mongo connection string, same as Agenda connection string')
-  .option('-c, --collection <collection>', '[optional] Mongo collection, same as Agenda collection name, default agendaJobs', 'agendaJobs')
-  .option('-p, --port <port>', '[optional] Server port, default 3000', (n, d) => Number(n) || d, 3000)
-  .option('-t, --title <title>', '[optional] Page title, default Agendash', 'Agendash')
-  .option('-p, --path <path>', '[optional] Path to bind Agendash to, default /', '/')
+  .option(
+    "-d, --db <db>",
+    "[required] Mongo connection string, same as Agenda connection string"
+  )
+  .option(
+    "-c, --collection <collection>",
+    "[optional] Mongo collection, same as Agenda collection name, default agendaJobs",
+    "agendaJobs"
+  )
+  .option(
+    "-p, --port <port>",
+    "[optional] Server port, default 3000",
+    (n, d) => Number(n) || d,
+    3000
+  )
+  .option(
+    "-t, --title <title>",
+    "[optional] Page title, default Agendash",
+    "Agendash"
+  )
+  .option(
+    "-p, --path <path>",
+    "[optional] Path to bind Agendash to, default /",
+    "/"
+  )
   .parse(process.argv);
 
 if (!program.db) {
-  console.error('--db required');
+  console.error("--db required");
   process.exit(1);
 }
 
-if (!program.path.startsWith('/')) {
-  console.error('--path must begin with /');
+if (!program.path.startsWith("/")) {
+  console.error("--path must begin with /");
   process.exit(1);
 }
 
 const app = express();
 
 const agenda = new Agenda().database(program.db, program.collection);
-app.use(program.path, agendash(agenda, {
-  title: program.title
-}));
+app.use(
+  program.path,
+  agendash(agenda, {
+    title: program.title,
+  })
+);
 
-app.set('port', program.port);
+app.set("port", program.port);
 
 const server = http.createServer(app);
 server.listen(program.port, () => {
-  console.log(`Agendash started http://localhost:${program.port}${program.path}`);
+  console.log(
+    `Agendash started http://localhost:${program.port}${program.path}`
+  );
 });