@uns-kit/api 3.0.24 → 3.0.26

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,5 @@
+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

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

package/dist/routes/api.js

@@ -0,0 +1,44 @@
+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

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,52 @@
+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

@@ -0,0 +1,81 @@
+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;
+}