Add Fastify Adapter 🎉 (#237)

Author: oliverbutler

.changeset/nine-tools-thank.md

@@ -0,0 +1,5 @@
+---
+'@ts-rest/fastify': minor
+---
+
+Release initial fastify implementation

.vscode/settings.json

@@ -1,5 +1,6 @@
 {
   "cSpell.words": [
+    "fastify",
     "openapi",
     "solidjs",
     "tanstack",

apps/docs/docs/fastify.mdx

@@ -0,0 +1,112 @@
+import { InstallTabs } from '@site/src/components/InstallTabs';
+
+# Fastify Server
+
+## Installation
+
+<InstallTabs packageName="@ts-rest/fastify" />
+
+## Usage
+
+```typescript
+import * as fastify from 'fastify';
+import { initServer } from '@ts-rest/fastify';
+
+const app = fastify();
+
+const s = initServer();
+
+const router = s.router(contract, {
+  getPost: async ({ params: { id } }) => {
+    const post = await prisma.post.findUnique({ where: { id } });
+
+    return {
+      status: 200,
+      body: post,
+    };
+  },
+  createPost: async ({ body }) => {
+    const post = await prisma.post.create({
+      data: body,
+    });
+
+    return {
+      status: 201,
+      body: post,
+    };
+  },
+});
+
+s.registerRouter(contract, router, app);
+
+const start = async () => {
+  try {
+    await app.listen({ port: 3000 });
+  } catch (err) {
+    app.log.error(err);
+    process.exit(1);
+  }
+};
+
+start();
+```
+
+`s.registerRouter` is a function that takes a contract, a corresponding router with implementations for each route and an fastify app, and it will
+create the corresponding fastify routes for each endpoint with the correct method, paths and middleware and attach them to your fastify app.
+
+## Options
+
+You can pass an optional options object as the last argument for `createfastifyEndpoints`.
+
+```typescript
+type Options = {
+  logInitialization?: boolean; // print route initialization logs to console
+  jsonQuery?: boolean;
+  responseValidation?: boolean;
+  requestValidationErrorHandler?:
+    | 'combined'
+    | ((
+        err: TsRestRequestValidationError,
+        request: fastify.FastifyRequest,
+        reply: fastify.FastifyReply
+      ) => void);
+};
+```
+
+### Response Validation
+
+To enable response parsing and validation, you can use the `validateResponses` option.
+If there is a corresponding response Zod schema defined in the contract for the returned status code, the response will be parsed and validated.
+If validation fails a `ResponseValidationError` will be thrown causing a 500 response to be returned.
+
+```typescript
+createfastifyEndpoints(contract, router, app, {
+  validateResponses: true,
+});
+```
+
+### Request Validation Error Handling
+
+The default functionality of handling request validation errors is `combined` which returns a 400 response with all validation errors in the body in this form.
+
+```typescript
+{
+  pathParameterErrors: z.ZodError | null;
+  headerErrors: z.ZodError | null;
+  queryParameterErrors: z.ZodError | null;
+  bodyErrors: z.ZodError | null;
+}
+```
+
+You can also pass a custom error handler function to the `requestValidationErrorHandler` option.
+
+```typescript
+s.registerRouter(contract, router, app, {
+  requestValidationErrorHandler: (err, req, res, next) => {
+    //             err is typed as ^ RequestValidationError
+    return res.status(400).json({
+      message: 'Validation failed',
+    });
+  },
+});
+```

apps/docs/docs/quickstart.mdx

@@ -210,6 +210,53 @@ const port = process.env.port || 3333;
 const server = app.listen(port, () => {
   console.log(`Listening at http://localhost:${port}`);
 });
+```
+
+  </TabItem>
+   <TabItem value="fastify" label="Fastify">
+  <InstallTabs packageName="@ts-rest/fastify" />
+<p>The fastify implementaton allows full type safety, offering; body parsing, query parsing, param parsing and full error handling</p>
+
+```typescript
+// main.ts
+
+const app = fastify();
+
+const s = initServer();
+
+const router = s.router(contract, {
+  getPost: async ({ params: { id } }) => {
+    const post = await prisma.post.findUnique({ where: { id } });
+
+    return {
+      status: 200,
+      body: post,
+    };
+  },
+  createPost: async ({ body }) => {
+    const post = await prisma.post.create({
+      data: body,
+    });
+
+    return {
+      status: 201,
+      body: post,
+    };
+  },
+});
+
+s.registerRouter(contract, router, app);
+
+const start = async () => {
+  try {
+    await app.listen({ port: 3000 });
+  } catch (err) {
+    app.log.error(err);
+    process.exit(1);
+  }
+};
+
+start();
 ```
 
   </TabItem>

apps/docs/sidebars.js

@@ -86,6 +86,11 @@ const sidebars = {
       label: '@ts-rest/next',
       id: 'next',
     },
+    {
+      type: 'doc',
+      label: '@ts-rest/fastify',
+      id: 'fastify',
+    },
     {
       type: 'category',
       label: '@ts-rest/express',

apps/docs/src/pages/index.tsx

@@ -19,6 +19,8 @@ import express from '../../static/img/express.png';
 // @ts-ignore
 import nest from '../../static/img/nest.png';
 // @ts-ignore
+import fastify from '../../static/img/fastify.png';
+// @ts-ignore
 import openApi from '../../static/img/swagger.png';
 // @ts-ignore
 import vercel from '../../static/img/vercel.png';
@@ -223,6 +225,11 @@ export default function Home(): JSX.Element {
               description: 'Nest.js integration',
               image: nest,
             },
+            {
+              name: '@ts-rest/fastify',
+              description: 'Fastify integration 🆕',
+              image: fastify,
+            },
             {
               name: '@ts-rest/open-api',
               description:

apps/docs/static/img/fastify.png

@@ -0,0 +1,18 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

apps/example-fastify/.eslintrc.json

@@ -0,0 +1,16 @@
+/* eslint-disable */
+export default {
+  displayName: 'example-fastify',
+  preset: '../../jest.preset.js',
+  globals: {
+    'ts-jest': {
+      tsconfig: '<rootDir>/tsconfig.spec.json',
+    },
+  },
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': 'ts-jest',
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../coverage/apps/example-fastify',
+};

apps/example-fastify/jest.config.ts

@@ -0,0 +1,54 @@
+{
+  "name": "example-fastify",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "apps/example-fastify/src",
+  "projectType": "application",
+  "targets": {
+    "build": {
+      "executor": "@nrwl/webpack:webpack",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "target": "node",
+        "compiler": "tsc",
+        "outputPath": "dist/apps/example-fastify",
+        "main": "apps/example-fastify/src/main.ts",
+        "tsConfig": "apps/example-fastify/tsconfig.app.json",
+        "assets": ["apps/example-fastify/src/assets"]
+      },
+      "configurations": {
+        "production": {
+          "optimization": true,
+          "extractLicenses": true,
+          "inspect": false
+        }
+      }
+    },
+    "serve": {
+      "executor": "@nrwl/js:node",
+      "options": {
+        "buildTarget": "example-fastify:build"
+      },
+      "configurations": {
+        "production": {
+          "buildTarget": "example-fastify:build:production"
+        }
+      }
+    },
+    "lint": {
+      "executor": "@nrwl/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": ["apps/example-fastify/**/*.ts"]
+      }
+    },
+    "test": {
+      "executor": "@nrwl/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "apps/example-fastify/jest.config.ts",
+        "passWithNoTests": true
+      }
+    }
+  },
+  "tags": []
+}