@twin.org/api-server-fastify 0.0.1-next.10

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IOTA Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,21 @@
+# TWIN API Server Fastify
+
+Use [Fastify](https://fastify.dev/) as the core web server for APIs.
+
+## Installation
+
+```shell
+npm install @twin.org/api-server-fastify
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)

package/dist/cjs/index.cjs

@@ -0,0 +1,297 @@
+'use strict';
+
+var FastifyCompress = require('@fastify/compress');
+var FastifyCors = require('@fastify/cors');
+var apiModels = require('@twin.org/api-models');
+var core = require('@twin.org/core');
+var loggingModels = require('@twin.org/logging-models');
+var web = require('@twin.org/web');
+var Fastify = require('fastify');
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Implementation of the web server using Fastify.
+ */
+class FastifyWebServer {
+    /**
+     * Runtime name for the class in camel case.
+     * @internal
+     */
+    static _CLASS_NAME_CAMEL_CASE = core.StringHelper.camelCase("FastifyWebServer");
+    /**
+     * Default port for running the server.
+     * @internal
+     */
+    static _DEFAULT_PORT = 3000;
+    /**
+     * Default host for running the server.
+     * @internal
+     */
+    static _DEFAULT_HOST = "localhost";
+    /**
+     * Runtime name for the class.
+     */
+    CLASS_NAME = "FastifyWebServer";
+    /**
+     * The logging connector.
+     * @internal
+     */
+    _loggingConnector;
+    /**
+     * The options for the server.
+     * @internal
+     */
+    _options;
+    /**
+     * The Fastify instance.
+     * @internal
+     */
+    _fastify;
+    /**
+     * Whether the server has been started.
+     * @internal
+     */
+    _started;
+    /**
+     * Create a new instance of FastifyWebServer.
+     * @param options The options for the server.
+     * @param options.loggingConnectorType The type of the logging connector to use, if undefined, no logging will happen.
+     * @param options.config Additional options for the Fastify server.
+     */
+    constructor(options) {
+        this._loggingConnector = core.Is.stringValue(options?.loggingConnectorType)
+            ? loggingModels.LoggingConnectorFactory.get(options.loggingConnectorType)
+            : undefined;
+        this._fastify = Fastify({ maxParamLength: 2000, ...options?.config });
+        this._started = false;
+    }
+    /**
+     * Get the web server instance.
+     * @returns The web server instance.
+     */
+    getInstance() {
+        return this._fastify;
+    }
+    /**
+     * Build the server.
+     * @param restRouteProcessors The hooks to process the incoming requests.
+     * @param restRoutes The REST routes.
+     * @param options Options for building the server.
+     * @returns Nothing.
+     */
+    async build(restRouteProcessors, restRoutes, options) {
+        if (!core.Is.arrayValue(restRouteProcessors)) {
+            throw new core.GeneralError(this.CLASS_NAME, "noProcessors");
+        }
+        await this._loggingConnector?.log({
+            level: "info",
+            ts: Date.now(),
+            source: this.CLASS_NAME,
+            message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.building`
+        });
+        this._options = options;
+        await this._fastify.register(FastifyCompress);
+        await this.initCors(options);
+        this._fastify.setNotFoundHandler({}, async (request, reply) => this.handleRequest(restRouteProcessors, request, reply));
+        this._fastify.setErrorHandler(async (error, request, reply) => {
+            // If code property is set this is a fastify error
+            // otherwise it's from our framework
+            let httpStatusCode;
+            let err;
+            if (core.Is.number(error.code)) {
+                err = {
+                    source: this.CLASS_NAME,
+                    name: error.name,
+                    message: `${error.code}: ${error.message}`
+                };
+                httpStatusCode = error.statusCode ?? web.HttpStatusCode.badRequest;
+            }
+            else {
+                const errorAndCode = apiModels.HttpErrorHelper.processError(error);
+                err = errorAndCode.error;
+                httpStatusCode = errorAndCode.httpStatusCode;
+            }
+            await this._loggingConnector?.log({
+                level: "error",
+                ts: Date.now(),
+                source: this.CLASS_NAME,
+                message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.badRequest`,
+                error: err
+            });
+            return reply.status(httpStatusCode).send({
+                error: err
+            });
+        });
+        // Add the routes to the server.
+        for (const restRoute of restRoutes) {
+            let path = core.StringHelper.trimTrailingSlashes(restRoute.path);
+            if (!path.startsWith("/")) {
+                path = `/${path}`;
+            }
+            await this._loggingConnector?.log({
+                level: "info",
+                ts: Date.now(),
+                source: this.CLASS_NAME,
+                message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.restRouteAdded`,
+                data: { route: path, method: restRoute.method }
+            });
+            const method = restRoute.method.toLowerCase();
+            this._fastify[method](path, async (request, reply) => this.handleRequest(restRouteProcessors, request, reply, restRoute));
+        }
+    }
+    /**
+     * Start the server.
+     * @returns Nothing.
+     */
+    async start() {
+        const host = this._options?.host ?? FastifyWebServer._DEFAULT_HOST;
+        const port = this._options?.port ?? FastifyWebServer._DEFAULT_PORT;
+        await this._loggingConnector?.log({
+            level: "info",
+            ts: Date.now(),
+            source: this.CLASS_NAME,
+            message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.starting`,
+            data: {
+                host,
+                port
+            }
+        });
+        if (!this._started) {
+            try {
+                await this._fastify.listen({ port, host });
+                const addresses = this._fastify.addresses();
+                const protocol = core.Is.object(this._fastify.initialConfig.https) ? "https://" : "http://";
+                await this._loggingConnector?.log({
+                    level: "info",
+                    ts: Date.now(),
+                    source: this.CLASS_NAME,
+                    message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.started`,
+                    data: {
+                        addresses: addresses
+                            .map(a => `${protocol}${a.family === "IPv6" ? "[" : ""}${a.address}${a.family === "IPv6" ? "]" : ""}:${a.port}`)
+                            .join(", ")
+                    }
+                });
+                this._started = true;
+            }
+            catch (err) {
+                await this._loggingConnector?.log({
+                    level: "error",
+                    ts: Date.now(),
+                    source: this.CLASS_NAME,
+                    message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.startFailed`,
+                    error: core.BaseError.fromError(err)
+                });
+            }
+        }
+    }
+    /**
+     * Stop the server.
+     * @returns Nothing.
+     */
+    async stop() {
+        if (this._started) {
+            this._started = false;
+            await this._fastify.close();
+            await this._loggingConnector?.log({
+                level: "info",
+                ts: Date.now(),
+                source: this.CLASS_NAME,
+                message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.stopped`
+            });
+        }
+    }
+    /**
+     * Handle the incoming request.
+     * @param restRouteProcessors The hooks to process the incoming requests.
+     * @param request The incoming request.
+     * @param reply The outgoing response.
+     * @param restRoute The REST route to handle.
+     * @internal
+     */
+    async handleRequest(restRouteProcessors, request, reply, restRoute) {
+        const httpServerRequest = {
+            method: request.method.toUpperCase(),
+            url: `${request.protocol}://${request.hostname}${request.url}`,
+            body: request.body,
+            query: request.query,
+            pathParams: request.params,
+            headers: request.headers
+        };
+        const httpResponse = {};
+        const httpRequestIdentity = {};
+        const processorState = {};
+        for (const restRouteProcessor of restRouteProcessors) {
+            if (core.Is.function(restRouteProcessor.pre)) {
+                await restRouteProcessor.pre(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState);
+            }
+        }
+        for (const restRouteProcessor of restRouteProcessors) {
+            if (core.Is.function(restRouteProcessor.process)) {
+                await restRouteProcessor.process(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState);
+            }
+        }
+        for (const restRouteProcessor of restRouteProcessors) {
+            if (core.Is.function(restRouteProcessor.post)) {
+                await restRouteProcessor.post(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState);
+            }
+        }
+        if (!core.Is.empty(httpResponse.headers)) {
+            for (const header of Object.keys(httpResponse.headers)) {
+                reply.header(header, httpResponse.headers[header]);
+            }
+        }
+        return reply
+            .status((httpResponse.statusCode ?? web.HttpStatusCode.ok))
+            .send(httpResponse.body);
+    }
+    /**
+     * Initialize the cors options.
+     * @param options The web server options.
+     * @internal
+     */
+    async initCors(options) {
+        let origins = ["*"];
+        if (core.Is.arrayValue(options?.corsOrigins)) {
+            origins = options?.corsOrigins;
+        }
+        else if (core.Is.stringValue(options?.corsOrigins)) {
+            origins = [options?.corsOrigins];
+        }
+        const hasWildcardOrigin = origins.includes("*");
+        const methods = options?.methods ?? [
+            web.HttpMethod.GET,
+            web.HttpMethod.PUT,
+            web.HttpMethod.POST,
+            web.HttpMethod.DELETE,
+            web.HttpMethod.OPTIONS
+        ];
+        const allowedHeaders = [
+            "Access-Control-Allow-Origin",
+            "Content-Encoding",
+            "Accept-Encoding",
+            web.HeaderTypes.ContentType,
+            web.HeaderTypes.Authorization,
+            web.HeaderTypes.Accept
+        ];
+        const exposedHeaders = [web.HeaderTypes.ContentDisposition, web.HeaderTypes.Location];
+        if (core.Is.arrayValue(options?.allowedHeaders)) {
+            allowedHeaders.push(...options.allowedHeaders);
+        }
+        if (core.Is.arrayValue(options?.exposedHeaders)) {
+            exposedHeaders.push(...options.exposedHeaders);
+        }
+        await this._fastify.register(FastifyCors, {
+            origin: (origin, callback) => {
+                callback(null, hasWildcardOrigin ? true : origins.includes(origin));
+            },
+            methods,
+            allowedHeaders,
+            exposedHeaders,
+            credentials: true
+        });
+    }
+}
+
+exports.FastifyWebServer = FastifyWebServer;

package/dist/esm/index.mjs

@@ -0,0 +1,295 @@
+import FastifyCompress from '@fastify/compress';
+import FastifyCors from '@fastify/cors';
+import { HttpErrorHelper } from '@twin.org/api-models';
+import { StringHelper, Is, GeneralError, BaseError } from '@twin.org/core';
+import { LoggingConnectorFactory } from '@twin.org/logging-models';
+import { HttpStatusCode, HttpMethod, HeaderTypes } from '@twin.org/web';
+import Fastify from 'fastify';
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Implementation of the web server using Fastify.
+ */
+class FastifyWebServer {
+    /**
+     * Runtime name for the class in camel case.
+     * @internal
+     */
+    static _CLASS_NAME_CAMEL_CASE = StringHelper.camelCase("FastifyWebServer");
+    /**
+     * Default port for running the server.
+     * @internal
+     */
+    static _DEFAULT_PORT = 3000;
+    /**
+     * Default host for running the server.
+     * @internal
+     */
+    static _DEFAULT_HOST = "localhost";
+    /**
+     * Runtime name for the class.
+     */
+    CLASS_NAME = "FastifyWebServer";
+    /**
+     * The logging connector.
+     * @internal
+     */
+    _loggingConnector;
+    /**
+     * The options for the server.
+     * @internal
+     */
+    _options;
+    /**
+     * The Fastify instance.
+     * @internal
+     */
+    _fastify;
+    /**
+     * Whether the server has been started.
+     * @internal
+     */
+    _started;
+    /**
+     * Create a new instance of FastifyWebServer.
+     * @param options The options for the server.
+     * @param options.loggingConnectorType The type of the logging connector to use, if undefined, no logging will happen.
+     * @param options.config Additional options for the Fastify server.
+     */
+    constructor(options) {
+        this._loggingConnector = Is.stringValue(options?.loggingConnectorType)
+            ? LoggingConnectorFactory.get(options.loggingConnectorType)
+            : undefined;
+        this._fastify = Fastify({ maxParamLength: 2000, ...options?.config });
+        this._started = false;
+    }
+    /**
+     * Get the web server instance.
+     * @returns The web server instance.
+     */
+    getInstance() {
+        return this._fastify;
+    }
+    /**
+     * Build the server.
+     * @param restRouteProcessors The hooks to process the incoming requests.
+     * @param restRoutes The REST routes.
+     * @param options Options for building the server.
+     * @returns Nothing.
+     */
+    async build(restRouteProcessors, restRoutes, options) {
+        if (!Is.arrayValue(restRouteProcessors)) {
+            throw new GeneralError(this.CLASS_NAME, "noProcessors");
+        }
+        await this._loggingConnector?.log({
+            level: "info",
+            ts: Date.now(),
+            source: this.CLASS_NAME,
+            message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.building`
+        });
+        this._options = options;
+        await this._fastify.register(FastifyCompress);
+        await this.initCors(options);
+        this._fastify.setNotFoundHandler({}, async (request, reply) => this.handleRequest(restRouteProcessors, request, reply));
+        this._fastify.setErrorHandler(async (error, request, reply) => {
+            // If code property is set this is a fastify error
+            // otherwise it's from our framework
+            let httpStatusCode;
+            let err;
+            if (Is.number(error.code)) {
+                err = {
+                    source: this.CLASS_NAME,
+                    name: error.name,
+                    message: `${error.code}: ${error.message}`
+                };
+                httpStatusCode = error.statusCode ?? HttpStatusCode.badRequest;
+            }
+            else {
+                const errorAndCode = HttpErrorHelper.processError(error);
+                err = errorAndCode.error;
+                httpStatusCode = errorAndCode.httpStatusCode;
+            }
+            await this._loggingConnector?.log({
+                level: "error",
+                ts: Date.now(),
+                source: this.CLASS_NAME,
+                message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.badRequest`,
+                error: err
+            });
+            return reply.status(httpStatusCode).send({
+                error: err
+            });
+        });
+        // Add the routes to the server.
+        for (const restRoute of restRoutes) {
+            let path = StringHelper.trimTrailingSlashes(restRoute.path);
+            if (!path.startsWith("/")) {
+                path = `/${path}`;
+            }
+            await this._loggingConnector?.log({
+                level: "info",
+                ts: Date.now(),
+                source: this.CLASS_NAME,
+                message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.restRouteAdded`,
+                data: { route: path, method: restRoute.method }
+            });
+            const method = restRoute.method.toLowerCase();
+            this._fastify[method](path, async (request, reply) => this.handleRequest(restRouteProcessors, request, reply, restRoute));
+        }
+    }
+    /**
+     * Start the server.
+     * @returns Nothing.
+     */
+    async start() {
+        const host = this._options?.host ?? FastifyWebServer._DEFAULT_HOST;
+        const port = this._options?.port ?? FastifyWebServer._DEFAULT_PORT;
+        await this._loggingConnector?.log({
+            level: "info",
+            ts: Date.now(),
+            source: this.CLASS_NAME,
+            message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.starting`,
+            data: {
+                host,
+                port
+            }
+        });
+        if (!this._started) {
+            try {
+                await this._fastify.listen({ port, host });
+                const addresses = this._fastify.addresses();
+                const protocol = Is.object(this._fastify.initialConfig.https) ? "https://" : "http://";
+                await this._loggingConnector?.log({
+                    level: "info",
+                    ts: Date.now(),
+                    source: this.CLASS_NAME,
+                    message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.started`,
+                    data: {
+                        addresses: addresses
+                            .map(a => `${protocol}${a.family === "IPv6" ? "[" : ""}${a.address}${a.family === "IPv6" ? "]" : ""}:${a.port}`)
+                            .join(", ")
+                    }
+                });
+                this._started = true;
+            }
+            catch (err) {
+                await this._loggingConnector?.log({
+                    level: "error",
+                    ts: Date.now(),
+                    source: this.CLASS_NAME,
+                    message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.startFailed`,
+                    error: BaseError.fromError(err)
+                });
+            }
+        }
+    }
+    /**
+     * Stop the server.
+     * @returns Nothing.
+     */
+    async stop() {
+        if (this._started) {
+            this._started = false;
+            await this._fastify.close();
+            await this._loggingConnector?.log({
+                level: "info",
+                ts: Date.now(),
+                source: this.CLASS_NAME,
+                message: `${FastifyWebServer._CLASS_NAME_CAMEL_CASE}.stopped`
+            });
+        }
+    }
+    /**
+     * Handle the incoming request.
+     * @param restRouteProcessors The hooks to process the incoming requests.
+     * @param request The incoming request.
+     * @param reply The outgoing response.
+     * @param restRoute The REST route to handle.
+     * @internal
+     */
+    async handleRequest(restRouteProcessors, request, reply, restRoute) {
+        const httpServerRequest = {
+            method: request.method.toUpperCase(),
+            url: `${request.protocol}://${request.hostname}${request.url}`,
+            body: request.body,
+            query: request.query,
+            pathParams: request.params,
+            headers: request.headers
+        };
+        const httpResponse = {};
+        const httpRequestIdentity = {};
+        const processorState = {};
+        for (const restRouteProcessor of restRouteProcessors) {
+            if (Is.function(restRouteProcessor.pre)) {
+                await restRouteProcessor.pre(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState);
+            }
+        }
+        for (const restRouteProcessor of restRouteProcessors) {
+            if (Is.function(restRouteProcessor.process)) {
+                await restRouteProcessor.process(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState);
+            }
+        }
+        for (const restRouteProcessor of restRouteProcessors) {
+            if (Is.function(restRouteProcessor.post)) {
+                await restRouteProcessor.post(httpServerRequest, httpResponse, restRoute, httpRequestIdentity, processorState);
+            }
+        }
+        if (!Is.empty(httpResponse.headers)) {
+            for (const header of Object.keys(httpResponse.headers)) {
+                reply.header(header, httpResponse.headers[header]);
+            }
+        }
+        return reply
+            .status((httpResponse.statusCode ?? HttpStatusCode.ok))
+            .send(httpResponse.body);
+    }
+    /**
+     * Initialize the cors options.
+     * @param options The web server options.
+     * @internal
+     */
+    async initCors(options) {
+        let origins = ["*"];
+        if (Is.arrayValue(options?.corsOrigins)) {
+            origins = options?.corsOrigins;
+        }
+        else if (Is.stringValue(options?.corsOrigins)) {
+            origins = [options?.corsOrigins];
+        }
+        const hasWildcardOrigin = origins.includes("*");
+        const methods = options?.methods ?? [
+            HttpMethod.GET,
+            HttpMethod.PUT,
+            HttpMethod.POST,
+            HttpMethod.DELETE,
+            HttpMethod.OPTIONS
+        ];
+        const allowedHeaders = [
+            "Access-Control-Allow-Origin",
+            "Content-Encoding",
+            "Accept-Encoding",
+            HeaderTypes.ContentType,
+            HeaderTypes.Authorization,
+            HeaderTypes.Accept
+        ];
+        const exposedHeaders = [HeaderTypes.ContentDisposition, HeaderTypes.Location];
+        if (Is.arrayValue(options?.allowedHeaders)) {
+            allowedHeaders.push(...options.allowedHeaders);
+        }
+        if (Is.arrayValue(options?.exposedHeaders)) {
+            exposedHeaders.push(...options.exposedHeaders);
+        }
+        await this._fastify.register(FastifyCors, {
+            origin: (origin, callback) => {
+                callback(null, hasWildcardOrigin ? true : origins.includes(origin));
+            },
+            methods,
+            allowedHeaders,
+            exposedHeaders,
+            credentials: true
+        });
+    }
+}
+
+export { FastifyWebServer };

package/dist/types/fastifyWebServer.d.ts

@@ -0,0 +1,44 @@
+import { type IHttpRestRouteProcessor, type IRestRoute, type IWebServer, type IWebServerOptions } from "@twin.org/api-models";
+import { type FastifyServerOptions, type FastifyInstance } from "fastify";
+/**
+ * Implementation of the web server using Fastify.
+ */
+export declare class FastifyWebServer implements IWebServer<FastifyInstance> {
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of FastifyWebServer.
+     * @param options The options for the server.
+     * @param options.loggingConnectorType The type of the logging connector to use, if undefined, no logging will happen.
+     * @param options.config Additional options for the Fastify server.
+     */
+    constructor(options?: {
+        loggingConnectorType?: string;
+        config?: FastifyServerOptions;
+    });
+    /**
+     * Get the web server instance.
+     * @returns The web server instance.
+     */
+    getInstance(): FastifyInstance;
+    /**
+     * Build the server.
+     * @param restRouteProcessors The hooks to process the incoming requests.
+     * @param restRoutes The REST routes.
+     * @param options Options for building the server.
+     * @returns Nothing.
+     */
+    build(restRouteProcessors: IHttpRestRouteProcessor[], restRoutes: IRestRoute[], options?: IWebServerOptions): Promise<void>;
+    /**
+     * Start the server.
+     * @returns Nothing.
+     */
+    start(): Promise<void>;
+    /**
+     * Stop the server.
+     * @returns Nothing.
+     */
+    stop(): Promise<void>;
+}

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./fastifyWebServer";

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/api-server-fastify - Changelog
+
+## v0.0.1-next.10
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/api-server-fastify - Examples

package/docs/reference/classes/FastifyWebServer.md

@@ -0,0 +1,127 @@
+# Class: FastifyWebServer
+
+Implementation of the web server using Fastify.
+
+## Implements
+
+- `IWebServer`\<`FastifyInstance`\>
+
+## Constructors
+
+### new FastifyWebServer()
+
+> **new FastifyWebServer**(`options`?): [`FastifyWebServer`](FastifyWebServer.md)
+
+Create a new instance of FastifyWebServer.
+
+#### Parameters
+
+• **options?**
+
+The options for the server.
+
+• **options.loggingConnectorType?**: `string`
+
+The type of the logging connector to use, if undefined, no logging will happen.
+
+• **options.config?**: `FastifyServerOptions`
+
+Additional options for the Fastify server.
+
+#### Returns
+
+[`FastifyWebServer`](FastifyWebServer.md)
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### getInstance()
+
+> **getInstance**(): `FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\>
+
+Get the web server instance.
+
+#### Returns
+
+`FastifyInstance`\<`RawServerDefault`, `IncomingMessage`, `ServerResponse`\<`IncomingMessage`\>, `FastifyBaseLogger`, `FastifyTypeProviderDefault`\>
+
+The web server instance.
+
+#### Implementation of
+
+`IWebServer.getInstance`
+
+***
+
+### build()
+
+> **build**(`restRouteProcessors`, `restRoutes`, `options`?): `Promise`\<`void`\>
+
+Build the server.
+
+#### Parameters
+
+• **restRouteProcessors**: `IHttpRestRouteProcessor`[]
+
+The hooks to process the incoming requests.
+
+• **restRoutes**: `IRestRoute`\<`any`, `any`\>[]
+
+The REST routes.
+
+• **options?**: `IWebServerOptions`
+
+Options for building the server.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IWebServer.build`
+
+***
+
+### start()
+
+> **start**(): `Promise`\<`void`\>
+
+Start the server.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IWebServer.start`
+
+***
+
+### stop()
+
+> **stop**(): `Promise`\<`void`\>
+
+Stop the server.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IWebServer.stop`

package/docs/reference/index.md

@@ -0,0 +1,5 @@
+# @twin.org/api-server-fastify
+
+## Classes
+
+- [FastifyWebServer](classes/FastifyWebServer.md)

package/locales/en.json

@@ -0,0 +1,12 @@
+{
+	"fastifyWebServer": {
+		"building": "Building Web Server",
+		"starting": "Starting Web Server at address \"{host}\" on port \"{port}\"",
+		"startFailed": "The Web Server failed to start",
+		"started": "The Web Server started on {addresses}",
+		"stopped": "The Web Server was stopped",
+		"badRequest": "The web server could not handle the request",
+		"restRouteAdded": "Added REST route \"{route}\" \"{method}\"",
+		"noProcessors": "You must configure at least one processor"
+	}
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+	"name": "@twin.org/api-server-fastify",
+	"version": "0.0.1-next.10",
+	"description": "Use Fastify as the core web server for APIs",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/api.git",
+		"directory": "packages/api-server-fastify"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@fastify/compress": "8.0.1",
+		"@fastify/cors": "10.0.1",
+		"@twin.org/api-core": "0.0.1-next.10",
+		"@twin.org/api-models": "0.0.1-next.10",
+		"@twin.org/core": "next",
+		"@twin.org/logging-models": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/web": "next",
+		"fastify": "5.0.0"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		}
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}