@twin.org/api-service 0.0.2-next.9 → 0.0.3-next.10

package/dist/cjs/index.cjs

@@ -1,447 +0,0 @@
-'use strict';
-
-var core = require('@twin.org/core');
-var web = require('@twin.org/web');
-var promises = require('node:fs/promises');
-
-/**
- * The tag to associate with the routes.
- */
-const tagsInformation = [
-    {
-        name: "Info",
-        description: "Information endpoints for the REST server."
-    }
-];
-/**
- * The REST routes for server information.
- * @param baseRouteName Prefix to prepend to the paths.
- * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
- * @returns The generated routes.
- */
-function generateRestRoutesInformation(baseRouteName, componentName) {
-    const rootRoute = {
-        operationId: "serverRoot",
-        summary: "Get the root text page",
-        tag: tagsInformation[0].name,
-        method: "GET",
-        path: `${baseRouteName}/`,
-        handler: async (httpRequestContext, request) => serverRoot(httpRequestContext, componentName),
-        responseType: [
-            {
-                type: "IServerRootResponse",
-                mimeType: web.MimeTypes.PlainText,
-                examples: [
-                    {
-                        id: "serverRootResponse",
-                        description: "The response for the root request.",
-                        response: {
-                            body: "API Server - 1.0.0"
-                        }
-                    }
-                ]
-            }
-        ],
-        skipAuth: true
-    };
-    const informationRoute = {
-        operationId: "serverInformation",
-        summary: "Get the information for the server",
-        tag: tagsInformation[0].name,
-        method: "GET",
-        path: `${baseRouteName}/info`,
-        handler: async (httpRequestContext, request) => serverInfo(httpRequestContext, componentName),
-        responseType: [
-            {
-                type: "IServerInfoResponse",
-                examples: [
-                    {
-                        id: "informationResponse",
-                        description: "The response for the information request.",
-                        response: {
-                            body: {
-                                name: "API Server",
-                                version: "1.0.0"
-                            }
-                        }
-                    }
-                ]
-            }
-        ],
-        skipAuth: true
-    };
-    const favIconRoute = {
-        operationId: "serverFavIcon",
-        summary: "Get the favicon for the server",
-        tag: tagsInformation[0].name,
-        method: "GET",
-        path: `${baseRouteName}/favicon.ico`,
-        handler: async (httpRequestContext, request) => serverFavIcon(httpRequestContext, componentName),
-        responseType: [
-            {
-                type: "IServerFavIconResponse",
-                mimeType: "image/x-icon"
-            }
-        ],
-        skipAuth: true
-    };
-    const healthRoute = {
-        operationId: "serverHealth",
-        summary: "Get the health for the server",
-        tag: tagsInformation[0].name,
-        method: "GET",
-        path: `${baseRouteName}/health`,
-        handler: async (httpRequestContext, request) => serverHealth(httpRequestContext, componentName),
-        responseType: [
-            {
-                type: "IServerHealthResponse",
-                examples: [
-                    {
-                        id: "healthResponseOK",
-                        description: "The response for the health request.",
-                        response: {
-                            body: {
-                                status: "ok",
-                                components: [
-                                    {
-                                        name: "Database",
-                                        status: "ok"
-                                    },
-                                    {
-                                        name: "Storage",
-                                        status: "ok"
-                                    }
-                                ]
-                            }
-                        }
-                    },
-                    {
-                        id: "healthResponseWarning",
-                        description: "The response for the health request with warnings.",
-                        response: {
-                            body: {
-                                status: "warning",
-                                components: [
-                                    {
-                                        name: "Database",
-                                        status: "warning",
-                                        details: "The database is running slow."
-                                    },
-                                    {
-                                        name: "Storage",
-                                        status: "ok"
-                                    }
-                                ]
-                            }
-                        }
-                    },
-                    {
-                        id: "healthResponseError",
-                        description: "The response for the health request with errors.",
-                        response: {
-                            body: {
-                                status: "error",
-                                components: [
-                                    {
-                                        name: "Database",
-                                        status: "ok"
-                                    },
-                                    {
-                                        name: "Storage",
-                                        status: "error",
-                                        details: "The storage is full."
-                                    }
-                                ]
-                            }
-                        }
-                    }
-                ]
-            }
-        ],
-        skipAuth: true
-    };
-    const specRoute = {
-        operationId: "serverSpec",
-        summary: "Get the OpenAPI specification for the endpoints",
-        tag: tagsInformation[0].name,
-        method: "GET",
-        path: `${baseRouteName}/spec`,
-        handler: async (httpRequestContext, request) => serverSpec(httpRequestContext, componentName),
-        responseType: [
-            {
-                type: "IServerSpecResponse",
-                examples: [
-                    {
-                        id: "specResponse",
-                        description: "The response for the spec request.",
-                        response: {
-                            body: {
-                                openapi: "3.1.0",
-                                info: {},
-                                paths: {}
-                            }
-                        }
-                    }
-                ]
-            }
-        ],
-        skipAuth: true
-    };
-    return [rootRoute, favIconRoute, informationRoute, healthRoute, specRoute];
-}
-/**
- * Get the root for the server.
- * @param httpRequestContext The request context for the API.
- * @param componentName The name of the component to use in the routes.
- * @param request The request.
- * @returns The response object with additional http response properties.
- */
-async function serverRoot(httpRequestContext, componentName, request) {
-    const component = core.ComponentFactory.get(componentName);
-    return {
-        body: await component.root()
-    };
-}
-/**
- * Get the information for the server.
- * @param httpRequestContext The request context for the API.
- * @param componentName The name of the component to use in the routes.
- * @param request The request.
- * @returns The response object with additional http response properties.
- */
-async function serverInfo(httpRequestContext, componentName, request) {
-    const component = core.ComponentFactory.get(componentName);
-    return {
-        body: await component.info()
-    };
-}
-/**
- * Get the health for the server.
- * @param httpRequestContext The request context for the API.
- * @param componentName The name of the component to use in the routes.
- * @param request The request.
- * @returns The response object with additional http response properties.
- */
-async function serverHealth(httpRequestContext, componentName, request) {
-    const component = core.ComponentFactory.get(componentName);
-    return {
-        body: await component.health()
-    };
-}
-/**
- * Get the favicon for the server.
- * @param httpRequestContext The request context for the API.
- * @param componentName The name of the component to use in the routes.
- * @param request The request.
- * @returns The response object with additional http response properties.
- */
-async function serverFavIcon(httpRequestContext, componentName, request) {
-    const component = core.ComponentFactory.get(componentName);
-    const favIcon = await component.favicon();
-    if (core.Is.uint8Array(favIcon)) {
-        return {
-            headers: {
-                [web.HeaderTypes.ContentType]: "image/x-icon"
-            },
-            body: favIcon
-        };
-    }
-    return {
-        statusCode: web.HttpStatusCode.notFound
-    };
-}
-/**
- * Get the spec for the server.
- * @param httpRequestContext The request context for the API.
- * @param componentName The name of the component to use in the routes.
- * @param request The request.
- * @returns The response object with additional http response properties.
- */
-async function serverSpec(httpRequestContext, componentName, request) {
-    const component = core.ComponentFactory.get(componentName);
-    const spec = await component.spec();
-    if (core.Is.objectValue(spec)) {
-        return {
-            body: spec
-        };
-    }
-    return {
-        statusCode: web.HttpStatusCode.notFound
-    };
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The information service for the server.
- */
-class InformationService {
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = "InformationService";
-    /**
-     * The server information.
-     * @internal
-     */
-    _serverInfo;
-    /**
-     * The server health.
-     * @internal
-     */
-    _healthInfo;
-    /**
-     * The path to the favicon Spec.
-     * @internal
-     */
-    _faviconPath;
-    /**
-     * The favicon.
-     * @internal
-     */
-    _favicon;
-    /**
-     * The path to the OpenAPI Spec.
-     * @internal
-     */
-    _openApiSpecPath;
-    /**
-     * The OpenAPI spec.
-     * @internal
-     */
-    _openApiSpec;
-    /**
-     * Create a new instance of InformationService.
-     * @param options The options to create the service.
-     */
-    constructor(options) {
-        core.Guards.object(this.CLASS_NAME, "options", options);
-        core.Guards.object(this.CLASS_NAME, "options.config", options.config);
-        core.Guards.object(this.CLASS_NAME, "options.config.serverInfo", options.config.serverInfo);
-        this._serverInfo = options.config.serverInfo;
-        this._healthInfo = {
-            status: "ok"
-        };
-        this._faviconPath = options.config.favIconPath;
-        this._openApiSpecPath = options.config.openApiSpecPath;
-    }
-    /**
-     * The service needs to be started when the application is initialized.
-     * @returns Nothing.
-     */
-    async start() {
-        const openApiPath = this._openApiSpecPath;
-        if (core.Is.stringValue(openApiPath)) {
-            const contentBuffer = await promises.readFile(openApiPath, "utf8");
-            this._openApiSpec = JSON.parse(contentBuffer);
-        }
-        const favIconPath = this._faviconPath;
-        if (core.Is.stringValue(favIconPath)) {
-            this._favicon = await promises.readFile(favIconPath);
-        }
-    }
-    /**
-     * Get the root information.
-     * @returns The root information.
-     */
-    async root() {
-        return `${this._serverInfo.name} - ${this._serverInfo.version}`;
-    }
-    /**
-     * Get the server information.
-     * @returns The service information.
-     */
-    async info() {
-        return this._serverInfo;
-    }
-    /**
-     * Get the favicon.
-     * @returns The favicon.
-     */
-    async favicon() {
-        return this._favicon;
-    }
-    /**
-     * Get the OpenAPI spec.
-     * @returns The OpenAPI spec.
-     */
-    async spec() {
-        return this._openApiSpec;
-    }
-    /**
-     * Get the server health.
-     * @returns The service health.
-     */
-    async health() {
-        let errorCount = 0;
-        let warningCount = 0;
-        if (core.Is.arrayValue(this._healthInfo.components)) {
-            errorCount = this._healthInfo.components.filter(c => c.status === "error").length;
-            warningCount = this._healthInfo.components.filter(c => c.status === "warning").length;
-        }
-        if (errorCount > 0) {
-            this._healthInfo.status = "error";
-        }
-        else if (warningCount > 0) {
-            this._healthInfo.status = "warning";
-        }
-        else {
-            this._healthInfo.status = "ok";
-        }
-        return this._healthInfo;
-    }
-    /**
-     * Set the status of a component.
-     * @param name The component name.
-     * @param status The status of the component.
-     * @param details The details for the status.
-     * @returns Nothing.
-     */
-    async setComponentHealth(name, status, details) {
-        const component = this._healthInfo.components?.find(c => c.name === name);
-        if (core.Is.undefined(component)) {
-            this._healthInfo.components ??= [];
-            this._healthInfo.components.push({
-                name,
-                status,
-                details
-            });
-        }
-        else {
-            component.status = status;
-            component.details = details;
-        }
-    }
-    /**
-     * Remove the status of a component.
-     * @param name The component name.
-     * @returns Nothing.
-     */
-    async removeComponentHealth(name) {
-        if (core.Is.arrayValue(this._healthInfo.components)) {
-            const componentIndex = this._healthInfo.components.findIndex(c => c.name === name);
-            if (componentIndex !== -1) {
-                this._healthInfo.components.splice(componentIndex, 1);
-            }
-        }
-    }
-}
-
-const restEntryPoints = [
-    {
-        name: "information",
-        defaultBaseRoute: "",
-        tags: tagsInformation,
-        generateRoutes: generateRestRoutesInformation
-    }
-];
-
-exports.InformationService = InformationService;
-exports.generateRestRoutesInformation = generateRestRoutesInformation;
-exports.restEntryPoints = restEntryPoints;
-exports.serverFavIcon = serverFavIcon;
-exports.serverHealth = serverHealth;
-exports.serverInfo = serverInfo;
-exports.serverRoot = serverRoot;
-exports.serverSpec = serverSpec;
-exports.tagsInformation = tagsInformation;