@uns-kit/api 0.0.42 → 0.0.45

package/dist/app.d.ts

@@ -18,6 +18,7 @@ export default class App {
         };
         paths: Record<string, any>;
     };
+    private swaggerDocs;
     constructor(port: number, processName: string, instanceName: string, appContext?: any);
     static getExternalIPv4(): string | null;
     getSwaggerSpec(): {
@@ -28,5 +29,6 @@ export default class App {
         };
         paths: Record<string, any>;
     };
+    registerSwaggerDoc(path: string, doc: Record<string, unknown>): void;
     start(): Promise<void>;
 }

package/dist/app.js

@@ -16,6 +16,7 @@ export default class App {
     processName;
     instanceName;
     swaggerSpec;
+    swaggerDocs = new Map();
     constructor(port, processName, instanceName, appContext) {
         this.router = express.Router();
         this.port = port;
@@ -68,6 +69,11 @@ export default class App {
     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);

package/dist/uns-api-plugin.js

@@ -27,6 +27,12 @@ const unsApiPlugin = ({ define }) => {
                     properties: { messageExpiryInterval: 120000 },
                 });
             });
+            unsApiProxy.event.on("unsProxyProducedApiCatchAll", (event) => {
+                internals.processMqttProxy.publish(event.statusTopic, JSON.stringify(event.producedCatchall), {
+                    retain: true,
+                    properties: { messageExpiryInterval: 120000 },
+                });
+            });
             internals.unsApiProxies.push(unsApiProxy);
             getApiProxies(this).push(unsApiProxy);
             return unsApiProxy;

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

@@ -12,6 +12,7 @@ export default class UnsApiProxy extends UnsProxy {
     private app;
     private options;
     private jwksCache?;
+    private catchAllRouteRegistered;
     constructor(processName: string, instanceName: string, options: IApiProxyOptions);
     /**
      * Unregister endpoint
@@ -28,6 +29,19 @@ export default class UnsApiProxy extends UnsProxy {
      * @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.
+     */
+    registerCatchAll(topicPrefix: string, options?: {
+        apiBase?: string;
+        apiBasePath?: string;
+        swaggerPath?: string;
+        swaggerDoc?: Record<string, unknown>;
+        apiDescription?: string;
+        tags?: string[];
+        queryParams?: IGetEndpointOptions["queryParams"];
+    }): Promise<void>;
     post(..._args: any[]): any;
     private extractBearerToken;
     private getPublicKeyFromJwks;

package/dist/uns-api-proxy.js

@@ -20,6 +20,7 @@ export default class UnsApiProxy extends UnsProxy {
     app;
     options;
     jwksCache;
+    catchAllRouteRegistered = false;
     constructor(processName, instanceName, options) {
         super();
         this.options = options;
@@ -221,6 +222,92 @@ export default class UnsApiProxy extends UnsProxy {
             logger.error(`${this.instanceNameWithSuffix} - Error publishing message to topic ${topic}${attribute}: ${error.message}`);
         }
     }
+    /**
+     * 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.
+     */
+    async registerCatchAll(topicPrefix, options) {
+        while (this.app.server.listening === false) {
+            await new Promise((resolve) => setTimeout(resolve, 100));
+        }
+        const finalOptions = options ?? {};
+        const topicNormalized = topicPrefix.endsWith("/") ? topicPrefix : `${topicPrefix}`;
+        const addressInfo = this.app.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 = "";
+        }
+        const apiBase = typeof finalOptions?.apiBase === "string" && finalOptions.apiBase.length
+            ? finalOptions.apiBase
+            : `http://${ip}:${port}`;
+        const apiBasePath = typeof finalOptions?.apiBasePath === "string" && finalOptions.apiBasePath.length
+            ? finalOptions.apiBasePath
+            : "/api";
+        const swaggerPath = typeof finalOptions?.swaggerPath === "string" && finalOptions.swaggerPath.length
+            ? finalOptions.swaggerPath
+            : `/${this.processName}/${this.instanceName}/catchall-swagger.json`;
+        const normalizedSwaggerPath = swaggerPath.startsWith("/") ? swaggerPath : `/${swaggerPath}`;
+        const swaggerDoc = finalOptions.swaggerDoc ||
+            {
+                openapi: "3.0.0",
+                info: {
+                    title: "Catch-all API",
+                    version: "1.0.0",
+                },
+                paths: {
+                    "/api/{topicPath}": {
+                        get: {
+                            summary: finalOptions.apiDescription || "Catch-all handler",
+                            tags: finalOptions.tags || [],
+                            parameters: [
+                                {
+                                    name: "topicPath",
+                                    in: "path",
+                                    required: true,
+                                    schema: { type: "string" },
+                                    description: "Resolved UNS topic path",
+                                },
+                                ...(finalOptions.queryParams || []).map((p) => ({
+                                    name: p.name,
+                                    in: "query",
+                                    required: !!p.required,
+                                    schema: { type: p.type },
+                                    description: p.description,
+                                })),
+                            ],
+                            responses: {
+                                "200": { description: "OK" },
+                                "400": { description: "Bad Request" },
+                                "401": { description: "Unauthorized" },
+                                "403": { description: "Forbidden" },
+                            },
+                        },
+                    },
+                },
+            };
+        this.app.registerSwaggerDoc(normalizedSwaggerPath, swaggerDoc);
+        logger.info(`${this.instanceNameWithSuffix} - Catch-all Swagger available at ${normalizedSwaggerPath} (target ${apiBase.replace(/\/+$/, "")}${normalizedSwaggerPath})`);
+        if (!this.catchAllRouteRegistered) {
+            this.app.router.use((req, res) => {
+                const topicPath = (req.path ?? "").replace(/^\/+/, "");
+                req.params = { ...(req.params || {}), topicPath };
+                this.event.emit("apiGetEvent", { req, res });
+            });
+            this.catchAllRouteRegistered = true;
+        }
+        this.registerApiCatchAll({
+            topic: topicNormalized,
+            apiBase,
+            apiBasePath,
+            swaggerPath,
+        });
+    }
     post(..._args) {
         // Implement POST logic or route binding here
         return "POST called";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uns-kit/api",
-  "version": "0.0.42",
+  "version": "0.0.45",
   "description": "Express-powered API gateway plugin for UnsProxyProcess with JWT/JWKS support.",
   "type": "module",
   "license": "MIT",
@@ -35,7 +35,7 @@
     "cookie-parser": "^1.4.7",
     "express": "^5.1.0",
     "multer": "^2.0.2",
-    "@uns-kit/core": "1.0.32"
+    "@uns-kit/core": "1.0.36"
   },
   "devDependencies": {
     "@types/jsonwebtoken": "^9.0.10",