@lokalise/fastify-bullboard-plugin 1.1.1 → 1.1.3

package/README.md

@@ -30,12 +30,25 @@ await app.register(basicAuth, {
 
 await app.register(bullBoard, {
   queueConstructor: Queue, // can be QueuePro if bullmq-pro is used
-  redisInstances: [
-      new Redis({
-          // some redis config
-      }),
+  redisConfigs: [
+      {
+          host: process.env.REDIS_HOST!,
+          port: Number(process.env.REDIS_PORT),
+          username: process.env.REDIS_USERNAME,
+          password: process.env.REDIS_PASSWORD,
+          keyPrefix: process.env.REDIS_KEY_PREFIX,
+          useTls: false,
+      } // any Redis config
   ],
   basePath: '/bull',
   refreshIntervalInSeconds: config.bullBoard.refreshIntervalInSeconds,
 })
 ```
+
+## Compatibility with existing fastify plugins
+
+`@lokalise/fastify-bullboard-plugin/basicAuth` registers it own instance of `fastifyBasicAuth`, it will not work if you also have it installed in your fastify app.
+
+It will also attempt registering `fastifyAuth` if it is not yet registered, so if you prefer to register it explicitly in your app, make sure that `@lokalise/fastify-bullboard-plugin/basicAuth` is registered after `fastifyAuth`.
+
+`bullBoard` attempts to register `fastifySchedule` if it's not already registered, so if you are registering it explicitly in your app, make sure that `bullBoard` plugin is registered after `fastifySchedule`.

package/dist/basicAuth.js

@@ -14,17 +14,22 @@ function validate(config) {
 }
 function enableListAuthHandler(enableList) {
     return (req, _res, done) => {
-        if (req.routeOptions.url && !enableList.has(req.routeOptions.url)) {
-            return done();
+        // If the route is NOT in enableList, allow through: skip auth
+        if (!req.routeOptions.url || !enableList.has(req.routeOptions.url)) {
+            return done(); // success: skip the rest of the handlers
         }
-        return done(new AuthFailedError());
+        // If the route IS in enableList, fail: go to next handler (basicAuth)
+        // String for performance, it also works
+        return done('Needs auth');
     };
 }
 async function plugin(fastify, pluginOptions) {
     if (!pluginOptions.config.isEnabled) {
         return;
     }
-    await fastify.register(fastifyAuth);
+    if (!fastify.auth) {
+        await fastify.register(fastifyAuth);
+    }
     await fastify.register(fastifyBasicAuth, {
         validate: validate(pluginOptions.config),
         authenticate: true,

package/dist/basicAuth.js.map

@@ -1 +1 @@
-{"version":3,"file":"basicAuth.js","sourceRoot":"","sources":["../src/basicAuth.ts"],"names":[],"mappings":"AACA,OAAO,WAAW,MAAM,eAAe,CAAA;AACvC,OAAO,gBAAgB,MAAM,qBAAqB,CAAA;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAErD,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAa/B,SAAS,QAAQ,CAAC,MAAkB;IAClC,OAAO,CACL,QAAgB,EAChB,QAAgB,EAChB,IAAoB,EACpB,MAAoB,EACpB,IAA2B,EAC3B,EAAE;QACF,IAAI,QAAQ,KAAK,MAAM,CAAC,QAAQ,IAAI,QAAQ,KAAK,MAAM,CAAC,QAAQ,EAAE,CAAC;YACjE,IAAI,EAAE,CAAA;QACR,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,eAAe,EAAE,CAAC,CAAA;QAC7B,CAAC;IACH,CAAC,CAAA;AACH,CAAC;AAED,SAAS,qBAAqB,CAAC,UAAuB;IACpD,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;QACzB,IAAI,GAAG,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC;YAClE,OAAO,IAAI,EAAE,CAAA;QACf,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,eAAe,EAAE,CAAC,CAAA;IACpC,CAAC,CAAA;AACH,CAAC;AAED,KAAK,UAAU,MAAM,CAAC,OAAwB,EAAE,aAA+B;IAC7E,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;QACpC,OAAM;IACR,CAAC;IAED,MAAM,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;IACnC,MAAM,OAAO,CAAC,QAAQ,CAAC,gBAAgB,EAAE;QACvC,QAAQ,EAAE,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC;QACxC,YAAY,EAAE,IAAI;KACnB,CAAC,CAAA;IAEF,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE;QACjB,OAAO,CAAC,OAAO,CACb,WAAW,EACX,OAAO,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,CACnF,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,SAAS,GAAG,EAAE,CAAmB,MAAM,EAAE;IACpD,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,YAAY;CACnB,CAAC,CAAA"}
+{"version":3,"file":"basicAuth.js","sourceRoot":"","sources":["../src/basicAuth.ts"],"names":[],"mappings":"AACA,OAAO,WAAW,MAAM,eAAe,CAAA;AACvC,OAAO,gBAAgB,MAAM,qBAAqB,CAAA;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAErD,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAa/B,SAAS,QAAQ,CAAC,MAAkB;IAClC,OAAO,CACL,QAAgB,EAChB,QAAgB,EAChB,IAAoB,EACpB,MAAoB,EACpB,IAA2B,EAC3B,EAAE;QACF,IAAI,QAAQ,KAAK,MAAM,CAAC,QAAQ,IAAI,QAAQ,KAAK,MAAM,CAAC,QAAQ,EAAE,CAAC;YACjE,IAAI,EAAE,CAAA;QACR,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,eAAe,EAAE,CAAC,CAAA;QAC7B,CAAC;IACH,CAAC,CAAA;AACH,CAAC;AAED,SAAS,qBAAqB,CAAC,UAAuB;IACpD,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;QACzB,8DAA8D;QAC9D,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC;YACnE,OAAO,IAAI,EAAE,CAAA,CAAC,yCAAyC;QACzD,CAAC;QACD,sEAAsE;QACtE,wCAAwC;QACxC,OAAO,IAAI,CAAC,YAAgC,CAAC,CAAA;IAC/C,CAAC,CAAA;AACH,CAAC;AAED,KAAK,UAAU,MAAM,CAAC,OAAwB,EAAE,aAA+B;IAC7E,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;QACpC,OAAM;IACR,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAClB,MAAM,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;IACrC,CAAC;IACD,MAAM,OAAO,CAAC,QAAQ,CAAC,gBAAgB,EAAE;QACvC,QAAQ,EAAE,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC;QACxC,YAAY,EAAE,IAAI;KACnB,CAAC,CAAA;IAEF,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE;QACjB,OAAO,CAAC,OAAO,CACb,WAAW,EACX,OAAO,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,CACnF,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,SAAS,GAAG,EAAE,CAAmB,MAAM,EAAE;IACpD,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,YAAY;CACnB,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@lokalise/fastify-bullboard-plugin",
-    "version": "1.1.1",
+    "version": "1.1.3",
     "type": "module",
     "files": [
         "dist",