feat(serverless): add support for Azure Functions V4 serverless runtime (#615)

Co-authored-by: Youssef Gaber <1728215+Gabrola@users.noreply.github.com>

Author: Liamandrew

.changeset/twelve-needles-walk.md

@@ -0,0 +1,5 @@
+---
+'@ts-rest/serverless': minor
+---
+
+Add Azure Functions compatibility

apps/docs/docs/serverless/azure-functions.md

@@ -0,0 +1,77 @@
+# Azure Functions
+
+The Azure Function handler can handle the Azure Functions V4 programming model.
+
+```typescript
+import { app } from '@azure/functions';
+import { createAzureFunctionHandler } from '@ts-rest/serverless/azure';
+import { contract } from './contract';
+import { router } from './router';
+
+const handler = createAzureFunctionHandler(contract, router, {
+  // options
+});
+
+// This will register a single function handler for the handler
+app.http('api', {
+  // Be sure to include any method that the router requires
+  methods: ['POST', 'PATCH', 'DELETE', 'GET'],
+  authLevel: 'anonymous',
+  route: '{*route}',
+  handler,
+});
+```
+
+## Route Prefix
+
+By default, Azure Functions have a route prefix `api` for every route registered. Unless you specifically have the same in your contract, then you will need to add the following to the end of your `host.json` file to remove this prefix.
+
+```json
+// host.json
+{
+  ...,
+  "extensions": {
+    "http": {
+      "routePrefix": ""
+    }
+  }
+}
+```
+
+## Context Object
+
+In addition to the regular context properties, the context object for Azure Function handlers includes the following additional properties:
+
+- `rawHttpRequest: HttpRequest`: The raw request that was passed to the Azure Function
+- `azureContext: InvocationContext`: The Azure Function Invocation Context passed with each invocation of a function
+
+```typescript
+import { createLambdaHandler } from '@ts-rest/serverless/aws';
+import { contract } from './contract';
+
+export const handler = createAzureFunctionHandler(
+  contract,
+  {
+    getPost: async ({ params: { id } }, { azureContext, rawHttpRequest }) => {
+      azureContext.log('Received request!');
+
+      return {
+        status: 200,
+        body: {
+          id,
+          title: 'Hello, World!',
+        },
+      };
+    },
+  },
+  {
+    requestMiddleware: [
+      (request, { rawHttpRequest, azureContext }) => {
+        console.log('Raw HttpRequest:', rawHttpRequest);
+        console.log('Azure Invocation Context:', azureContext);
+      },
+    ],
+    responseHandlers: [(response, request, { rawHttpRequest, azureContext }) => {}],
+  },
+);
+```

apps/docs/sidebars.js

@@ -123,6 +123,7 @@ const sidebars = {
             { type: 'doc', id: 'serverless/fetch-runtimes' },
             { type: 'doc', id: 'serverless/aws' },
             { type: 'doc', id: 'serverless/next-serverless' },
+            { type: 'doc', id: 'serverless/azure-functions' },
           ],
         },
         {

apps/example-azure-function/.env

@@ -0,0 +1 @@
+FUNCTIONS_WORKER_RUNTIME=node

apps/example-azure-function/.eslintrc.json

@@ -0,0 +1,21 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {
+        "@typescript-eslint/no-unused-vars": ["warn"],
+        "@typescript-eslint/no-explicit-any": ["warn"]
+      }
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

apps/example-azure-function/.funcignore

@@ -0,0 +1,10 @@
+*.js.map
+*.ts
+.git*
+.vscode
+local.settings.json
+test
+getting_started.md
+node_modules/@types/
+node_modules/azure-functions-core-tools/
+node_modules/typescript/

apps/example-azure-function/.gitignore

@@ -0,0 +1,49 @@
+bin
+obj
+csx
+.vs
+edge
+Publish
+
+*.user
+*.suo
+*.cscfg
+*.Cache
+project.lock.json
+
+/packages
+/TestResults
+
+/tools/NuGet.exe
+/App_Data
+/secrets
+/data
+.secrets
+appsettings.json
+local.settings.json
+
+node_modules
+dist
+
+# Local python packages
+.python_packages/
+
+# Python Environments
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Azurite artifacts
+__blobstorage__
+__queuestorage__
+__azurite_db*__.json
+
+!.env

apps/example-azure-function/host.json

@@ -0,0 +1,20 @@
+{
+  "version": "2.0",
+  "logging": {
+    "applicationInsights": {
+      "samplingSettings": {
+        "isEnabled": true,
+        "excludedTypes": "Request"
+      }
+    }
+  },
+  "extensionBundle": {
+    "id": "Microsoft.Azure.Functions.ExtensionBundle",
+    "version": "[4.*, 5.0.0)"
+  },
+  "extensions": {
+    "http": {
+      "routePrefix": ""
+    }
+  }
+}

apps/example-azure-function/jest.config.ts

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

apps/example-azure-function/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "example-azure-function",
+  "version": "0.0.0",
+  "main": "../../dist/apps/example-azure-function/*.js"
+}