@gasket/plugin-fastify 6.0.0 → 6.10.0

package/CHANGELOG.md

@@ -1,6 +1,20 @@
 # `@gasket/plugin-fastify`
 
-Enable middleware support
+### 6.10.0
+
+- TypeScript definitions for config & lifecycles ([#311])
+
+### 6.0.5
+
+- Filter falsy middleware ([#255])
+
+### 6.0.1
+
+- Fix to add `res.locals` for attaching data ([#250])
+
+### 6.0.0
+
+Enable middleware support ([#172])
 - Add `middie@5` as dependency
 - Register `middie` to enable Fastify middleware
 
@@ -12,4 +26,9 @@ Enable middleware support
 
 - [#88] Initial release.
 
+
 [#88]: https://github.com/godaddy/gasket/pull/88
+[#172]: https://github.com/godaddy/gasket/pull/172
+[#250]: https://github.com/godaddy/gasket/pull/250
+[#255]: https://github.com/godaddy/gasket/pull/255
+[#311]: https://github.com/godaddy/gasket/pull/311

package/index.d.ts

@@ -0,0 +1,28 @@
+import type { GasketConfig, HookExecTypes, MaybeAsync, MaybeMultiple } from '@gasket/engine';
+import type { FastifyInstance, FastifyRequest, FastifyReply } from 'fastify';
+
+declare module '@gasket/engine' {
+  export interface GasketConfig {
+    compression?: boolean,
+    excludedRoutesRegex?: RegExp
+  }
+
+  // The middie middleware is added for express compatibility
+  type Handler = (
+    req: FastifyRequest,
+    res: FastifyReply,
+    next: (error?: Error) => void
+  ) => void;
+  type ErrorHandler = (
+    error: Error,
+    req: FastifyRequest,
+    res: FastifyReply,
+    next: (error?: Error) => void
+  ) => void;
+
+  export interface HookExecTypes {
+    middleware(fastify: FastifyInstance): MaybeAsync<MaybeMultiple<Handler>>,
+    fastify(fastify: FastifyInstance): MaybeAsync<void>,
+    errorMiddleware(fastify: FastifyInstance): MaybeAsync<MaybeMultiple<ErrorHandler>>
+  }
+}

package/index.js

@@ -41,6 +41,12 @@ module.exports = {
       // Enable middleware for fastify@3
       await app.register(middie);
 
+      // Add express-like `res.locals` object attaching data
+      app.use(function attachLocals(req, res, next) {
+        res.locals = {};
+        next();
+      });
+
       if (excludedRoutesRegex) {
         app.use(excludedRoutesRegex, cookieParser());
       } else {
@@ -52,7 +58,7 @@ module.exports = {
         app.use(compression());
       }
 
-      const middlewares = await gasket.exec('middleware', app);
+      const middlewares = (await gasket.exec('middleware', app)).filter(Boolean);
 
       debug('applied %s middleware layers to fastify', middlewares.length);
       middlewares.forEach(layer => {
@@ -66,7 +72,7 @@ module.exports = {
       // allow consuming apps to directly append options to their server
       await gasket.exec('fastify', app);
 
-      const postRenderingStacks = await gasket.exec('errorMiddleware');
+      const postRenderingStacks = (await gasket.exec('errorMiddleware')).filter(Boolean);
       postRenderingStacks.forEach(stack => app.use(stack));
 
       return {

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@gasket/plugin-fastify",
-  "version": "6.0.0",
+  "version": "6.10.0",
   "description": "Adds fastify support to your application",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
     "lint": "eslint index.js test",
     "lint:fix": "npm run lint -- --fix",
@@ -41,12 +42,14 @@
     "middie": "5.1.0"
   },
   "devDependencies": {
+    "@gasket/engine": "^6.10.0",
     "assume": "^2.3.0",
     "assume-sinon": "^1.1.0",
     "eslint": "^7.17.0",
     "eslint-config-godaddy": "^4.0.1",
     "eslint-plugin-json": "^2.1.2",
     "eslint-plugin-mocha": "^8.0.0",
+    "eslint-plugin-unicorn": "^39.0.0",
     "fastify": "^3.3.0",
     "mocha": "^8.2.1",
     "nyc": "^15.1.0",
@@ -56,5 +59,16 @@
   "peerDependencies": {
     "fastify": "^3.0.0"
   },
-  "gitHead": "0b7fa1ba4fd6b8dc280efbb2bd87089967356c9d"
+  "eslintConfig": {
+    "extends": [
+      "godaddy"
+    ],
+    "plugins": [
+      "unicorn"
+    ],
+    "rules": {
+      "unicorn/filename-case": "error"
+    }
+  },
+  "gitHead": "eca8f68eb2389d28f47f2fcf0b06b2b7f9575177"
 }