@uns-kit/api 3.0.23 → 3.0.24

package/dist/app.js

@@ -1,148 +0,0 @@
-/**
- * Module dependencies.
- */
-import express from "express";
-import * as http from "http";
-import * as path from "path";
-import cookieParser from "cookie-parser";
-import { basePath } from "@uns-kit/core/base-path.js";
-import logger from "@uns-kit/core/logger.js";
-import os from 'os';
-import { logRequestContext } from "./request-log.js";
-const normalizeBasePrefix = (value) => {
-    if (!value)
-        return "";
-    const trimmed = value.trim();
-    if (!trimmed)
-        return "";
-    const withLeading = trimmed.startsWith("/") ? trimmed : `/${trimmed}`;
-    return withLeading.replace(/\/+$/, "");
-};
-const buildSwaggerPath = (base, processName, instanceName) => {
-    const processSegment = `/${processName}`;
-    let baseWithProcess = base || "/";
-    if (!baseWithProcess.endsWith(processSegment)) {
-        baseWithProcess = `${baseWithProcess}${processSegment}`;
-    }
-    return `${baseWithProcess}/${instanceName}/swagger.json`.replace(/\/{2,}/g, "/");
-};
-export default class App {
-    expressApplication;
-    server;
-    port;
-    router;
-    processName;
-    instanceName;
-    apiBasePrefix;
-    swaggerBasePrefix;
-    swaggerSpec;
-    swaggerDocs = new Map();
-    constructor(port, processName, instanceName, appContext, mountConfig) {
-        this.router = express.Router();
-        this.port = port;
-        this.expressApplication = express();
-        this.server = http.createServer(this.expressApplication);
-        this.processName = processName;
-        this.instanceName = instanceName;
-        this.apiBasePrefix =
-            normalizeBasePrefix(mountConfig?.apiBasePrefix ?? process.env.UNS_API_BASE_PATH) || "/api";
-        const rawSwaggerBase = normalizeBasePrefix(mountConfig?.swaggerBasePrefix ?? process.env.UNS_SWAGGER_BASE_PATH) ||
-            this.apiBasePrefix;
-        // If someone passed ".../api" as swagger base, strip that to avoid duplicated segments
-        this.swaggerBasePrefix = rawSwaggerBase.endsWith("/api")
-            ? rawSwaggerBase.replace(/\/api\/?$/, "") || "/"
-            : rawSwaggerBase;
-        // Add context
-        this.expressApplication.use((req, _res, next) => {
-            req.appContext = appContext;
-            next();
-        });
-        // Body parser (req.body)
-        this.expressApplication.use(express.json());
-        this.expressApplication.use(express.urlencoded({ extended: false }));
-        // Add cookie parser
-        this.expressApplication.use(cookieParser());
-        // Static / public folder
-        const publicHome = process.env.PUBLIC_HOME === null || process.env.PUBLIC_HOME === undefined
-            ? "public"
-            : process.env.PUBLIC_HOME;
-        this.expressApplication.use(express.static(path.join(basePath, publicHome)));
-        // Map routes
-        this.router.use(logRequestContext);
-        if (!mountConfig?.disableDefaultApiMount) {
-            this.expressApplication.use(this.apiBasePrefix, this.router);
-        }
-        // Swagger specs
-        this.swaggerSpec = {
-            openapi: "3.0.0",
-            info: {
-                title: "UNS API",
-                version: "1.0.0",
-            },
-            paths: {},
-            servers: this.swaggerBasePrefix ? [{ url: this.swaggerBasePrefix }] : undefined,
-        };
-    }
-    static getExternalIPv4() {
-        const interfaces = os.networkInterfaces();
-        for (const name of Object.keys(interfaces)) {
-            for (const iface of interfaces[name] || []) {
-                if (iface.family === 'IPv4' && !iface.internal) {
-                    return iface.address;
-                }
-            }
-        }
-        return null;
-    }
-    getSwaggerSpec() {
-        return this.swaggerSpec;
-    }
-    registerSwaggerDoc(path, doc) {
-        const normalizedPath = path.startsWith("/") ? path : `/${path}`;
-        this.swaggerDocs.set(normalizedPath, doc);
-        this.expressApplication.get(normalizedPath, (_req, res) => res.json(doc));
-    }
-    async start() {
-        // Listen on provided port, on all network interfaces.
-        this.server.listen(this.port);
-        this.server.on("error", (error) => {
-            if (error.syscall !== "listen") {
-                throw error;
-            }
-            const bind = typeof this.port === "string"
-                ? `Pipe ${this.port}`
-                : `Port ${this.port}`;
-            // handle specific listen errors with friendly messages
-            switch (error.code) {
-                case "EACCES":
-                    logger.error(`${bind} requires elevated privileges`);
-                    process.exit(1);
-                    break;
-                case "EADDRINUSE":
-                    logger.error(`${bind} is already in use`);
-                    process.exit(1);
-                    break;
-                default:
-                    throw error;
-            }
-        });
-        this.server.on("listening", () => {
-            App.bind(this);
-            const addressInfo = this.server.address();
-            let ip;
-            let port;
-            if (addressInfo && typeof addressInfo === "object") {
-                ip = App.getExternalIPv4();
-                port = addressInfo.port;
-            }
-            else if (typeof addressInfo === "string") {
-                ip = App.getExternalIPv4();
-                port = "";
-            }
-            logger.info(`API listening on http://${ip}:${port}${this.apiBasePrefix}`);
-            const swaggerPath = buildSwaggerPath(this.swaggerBasePrefix, this.processName, this.instanceName);
-            logger.info(`Swagger openAPI on http://${ip}:${port}${swaggerPath}`);
-            this.expressApplication.get(swaggerPath, (req, res) => res.json(this.getSwaggerSpec()));
-        });
-    }
-}

package/dist/index.d.ts

@@ -1,5 +0,0 @@
-export { default } from "./uns-api-plugin.js";
-export { UnsApiProxy, type UnsProxyProcessWithApi } from "./uns-api-plugin.js";
-export * from "./api-interfaces.js";
-export * from "./api-event-routing.js";
-export * from "./parquet.js";

package/dist/index.js

@@ -1,5 +0,0 @@
-export { default } from "./uns-api-plugin.js";
-export { UnsApiProxy } from "./uns-api-plugin.js";
-export * from "./api-interfaces.js";
-export * from "./api-event-routing.js";
-export * from "./parquet.js";

package/dist/routes/api.d.ts

@@ -1,6 +0,0 @@
-import { type Router } from "express";
-export default class Api {
-    router: Router;
-    private upload;
-    constructor();
-}

package/dist/routes/api.js

@@ -1,44 +0,0 @@
-import express from "express";
-import multer from "multer";
-import logger from "@uns-kit/core/logger.js";
-export default class Api {
-    router;
-    upload;
-    constructor() {
-        const storage = multer.diskStorage({
-            destination: function (req, file, cb) {
-                cb(null, "tmp/");
-            },
-            filename: function (req, file, cb) {
-                const uniqueSuffix = Date.now() + "-" + Math.round(Math.random() * 1e9);
-                cb(null, file.fieldname + "-" + uniqueSuffix + ".jpg");
-            },
-        });
-        this.upload = multer({ storage: storage });
-        this.router = express.Router();
-        /**
-         * Open for all
-         *
-         * Example post request
-         */
-        this.router.post("/call", async function (req, res) {
-            try {
-                const appContext = req.appContext;
-                res.send("OK");
-            }
-            catch (error) {
-                res.status(400).send("Error");
-            }
-        });
-        /**
-         * Open for all
-         *
-         * Upload files
-         */
-        this.router.post("/upload", this.upload.single("file"), function (req, res) {
-            const appContext = req.appContext;
-            logger.info(req.file);
-            res.send("Successfully uploaded files");
-        });
-    }
-}

package/dist/uns-api-plugin.d.ts

@@ -1,9 +0,0 @@
-import type { IApiProxyOptions } from "@uns-kit/core/uns/uns-interfaces.js";
-import UnsProxyProcess, { type UnsProxyProcessPlugin } from "@uns-kit/core/uns/uns-proxy-process.js";
-import UnsApiProxy from "./uns-api-proxy.js";
-declare const unsApiPlugin: UnsProxyProcessPlugin;
-export default unsApiPlugin;
-export { UnsApiProxy };
-export type UnsProxyProcessWithApi = UnsProxyProcess & {
-    createApiProxy(instanceName: string, options: IApiProxyOptions): Promise<UnsApiProxy>;
-};

package/dist/uns-api-plugin.js

@@ -1,52 +0,0 @@
-import UnsProxyProcess from "@uns-kit/core/uns/uns-proxy-process.js";
-import UnsApiProxy from "./uns-api-proxy.js";
-import { UnsPacket } from "@uns-kit/core/uns/uns-packet.js";
-const apiProxyRegistry = new WeakMap();
-const getApiProxies = (instance) => {
-    let proxies = apiProxyRegistry.get(instance);
-    if (!proxies) {
-        proxies = [];
-        apiProxyRegistry.set(instance, proxies);
-    }
-    return proxies;
-};
-const unsApiPlugin = ({ define }) => {
-    define({
-        async createApiProxy(instanceName, options) {
-            await this.waitForProcessConnection();
-            const internals = this;
-            const unsApiProxy = new UnsApiProxy(internals.processName, instanceName, options);
-            unsApiProxy.event.on("unsProxyProducedTopics", (event) => {
-                internals.processMqttProxy.publish(event.statusTopic, JSON.stringify(event.producedTopics));
-            });
-            unsApiProxy.event.on("unsProxyProducedApiEndpoints", (event) => {
-                internals.processMqttProxy.publish(event.statusTopic, JSON.stringify(event.producedApiEndpoints));
-            });
-            unsApiProxy.event.on("unsProxyProducedServiceEndpoints", (event) => {
-                internals.processMqttProxy.publish(event.statusTopic, JSON.stringify(event.producedServiceEndpoints));
-            });
-            unsApiProxy.event.on("unsProxyProducedDataOfferEndpoints", (event) => {
-                internals.processMqttProxy.publish(event.statusTopic, JSON.stringify(event.producedDataOfferEndpoints));
-            });
-            unsApiProxy.event.on("unsProxyProducedApiCatchAll", (event) => {
-                internals.processMqttProxy.publish(event.statusTopic, JSON.stringify(event.producedCatchall));
-            });
-            unsApiProxy.event.on("unsProxyProducedDataCatalogOffers", (event) => {
-                internals.processMqttProxy.publish(event.statusTopic, JSON.stringify(event.producedDataCatalogOffers));
-            });
-            unsApiProxy.event.on("mqttProxyStatus", (event) => {
-                const time = UnsPacket.formatToISO8601(new Date());
-                const unsMessage = { data: { time, value: event.value, uom: event.uom } };
-                UnsPacket.unsPacketFromUnsMessage(unsMessage).then((packet) => {
-                    internals.processMqttProxy.publish(event.statusTopic, JSON.stringify(packet));
-                });
-            });
-            internals.unsApiProxies.push(unsApiProxy);
-            getApiProxies(this).push(unsApiProxy);
-            return unsApiProxy;
-        },
-    });
-};
-UnsProxyProcess.use(unsApiPlugin);
-export default unsApiPlugin;
-export { UnsApiProxy };

package/dist/uns-api-proxy.d.ts

@@ -1,81 +0,0 @@
-import { UnsAttribute } from "@uns-kit/core/uns/uns-interfaces.js";
-import UnsProxy from "@uns-kit/core/uns/uns-proxy.js";
-import { UnsTopics } from "@uns-kit/core/uns/uns-topics.js";
-import { IApiProxyOptions, IGetEndpointOptions, IPostEndpointOptions } from "@uns-kit/core/uns/uns-interfaces.js";
-import { UnsAsset } from "@uns-kit/core/uns/uns-asset.js";
-import { UnsObjectType, UnsObjectId } from "@uns-kit/core/uns/uns-object.js";
-import type { DataCatalogOfferRegistration } from "./api-interfaces.js";
-export default class UnsApiProxy extends UnsProxy {
-    instanceName: string;
-    private topicBuilder;
-    private processName;
-    protected processStatusTopic: string;
-    private app;
-    private options;
-    private apiBasePrefix;
-    private swaggerBasePrefix;
-    private jwksCache?;
-    private catchAllRouteRegistered;
-    private startedAt;
-    private statusInterval;
-    private readonly statusIntervalMs;
-    private readonly dataCatalogOffers;
-    constructor(processName: string, instanceName: string, options: IApiProxyOptions);
-    getProcessName(): string;
-    private getPublishedApiHost;
-    /**
-     * Unregister endpoint
-     * @param topic - The API topic
-     * @param attribute - The attribute for the topic.
-     * @param method - The HTTP method (e.g., "GET", "POST", "PUT", "DELETE").
-     */
-    unregister(topic: UnsTopics, asset: UnsAsset, objectType: UnsObjectType, objectId: UnsObjectId, attribute: UnsAttribute, method: "GET" | "POST" | "PUT" | "DELETE"): Promise<void>;
-    /**
-     * Register a GET endpoint with optional JWT path filter.
-     * @param topic - The API topic
-     * @param attribute - The attribute for the topic.
-     * @param options.description - Optional description.
-     * @param options.tags - Optional tags.
-     */
-    get(topic: UnsTopics, asset: UnsAsset, objectType: UnsObjectType, objectId: UnsObjectId, attribute: UnsAttribute, options?: IGetEndpointOptions): Promise<void>;
-    /**
-     * Register a catch-all API mapping for a topic prefix (e.g., "sij/acroni/#").
-     * Does not create individual API attribute nodes; the controller treats this as a fallback.
-     *
-     * This is intended for use by the uns-api-global microservice, which acts as a
-     * catch-all gateway for an entire topic namespace. Regular microservices should
-     * NOT call this — use registerGetEndpoint() for individual attribute endpoints instead.
-     */
-    registerCatchAll(topicPrefix: string, options?: {
-        apiBase?: string;
-        apiBasePath?: string;
-        swaggerPath?: string;
-        swaggerDoc?: Record<string, unknown>;
-        apiDescription?: string;
-        tags?: string[];
-        queryParams?: IGetEndpointOptions["queryParams"];
-    }): Promise<void>;
-    post(topic: UnsTopics, asset: UnsAsset, objectType: UnsObjectType, objectId: UnsObjectId, attribute: UnsAttribute, options?: IPostEndpointOptions): Promise<void>;
-    put(topic: UnsTopics, asset: UnsAsset, objectType: UnsObjectType, objectId: UnsObjectId, attribute: UnsAttribute, options?: IPostEndpointOptions): Promise<void>;
-    patch(topic: UnsTopics, asset: UnsAsset, objectType: UnsObjectType, objectId: UnsObjectId, attribute: UnsAttribute, options?: IPostEndpointOptions): Promise<void>;
-    delete(topic: UnsTopics, asset: UnsAsset, objectType: UnsObjectType, objectId: UnsObjectId, attribute: UnsAttribute, options?: IPostEndpointOptions): Promise<void>;
-    private registerMutationEndpoint;
-    registerDataOffer(input: DataCatalogOfferRegistration): void;
-    private emitStatusMetrics;
-    private registerHealthEndpoint;
-    private getApiEventName;
-    private extractBearerToken;
-    private getPublicKeyFromJwks;
-    private fetchJwksKeys;
-    private certFromX5c;
-    stop(): Promise<void>;
-    private publishDataCatalogOffer;
-    private emitDataCatalogOffers;
-    private normalizeDataOfferOperation;
-    private normalizeDataOfferParameter;
-    private normalizeDataOfferRequestBody;
-    private normalizeDataOfferResponse;
-    private normalizeDataOfferSchema;
-    private normalizeDataOfferSchemaField;
-    private resolveOfferSchemas;
-}