@uns-kit/api 2.0.4 → 2.0.6

package/dist/app.d.ts

@@ -3,6 +3,11 @@
  */
 import { type Router } from "express";
 import * as http from "http";
+type MountConfig = {
+    apiBasePrefix?: string;
+    swaggerBasePrefix?: string;
+    disableDefaultApiMount?: boolean;
+};
 export default class App {
     private expressApplication;
     server: http.Server<typeof http.IncomingMessage, typeof http.ServerResponse>;
@@ -10,6 +15,8 @@ export default class App {
     router: Router;
     private processName;
     private instanceName;
+    private apiBasePrefix;
+    private swaggerBasePrefix;
     swaggerSpec: {
         openapi: string;
         info: {
@@ -17,9 +24,12 @@ export default class App {
             version: string;
         };
         paths: Record<string, any>;
+        servers?: Array<{
+            url: string;
+        }>;
     };
     private swaggerDocs;
-    constructor(port: number, processName: string, instanceName: string, appContext?: any);
+    constructor(port: number, processName: string, instanceName: string, appContext?: any, mountConfig?: MountConfig);
     static getExternalIPv4(): string | null;
     getSwaggerSpec(): {
         openapi: string;
@@ -28,7 +38,11 @@ export default class App {
             version: string;
         };
         paths: Record<string, any>;
+        servers?: Array<{
+            url: string;
+        }>;
     };
     registerSwaggerDoc(path: string, doc: Record<string, unknown>): void;
     start(): Promise<void>;
 }
+export {};

package/dist/app.js

@@ -8,6 +8,23 @@ 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';
+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;
@@ -15,15 +32,22 @@ export default class App {
     router;
     processName;
     instanceName;
+    apiBasePrefix;
+    swaggerBasePrefix;
     swaggerSpec;
     swaggerDocs = new Map();
-    constructor(port, processName, instanceName, appContext) {
+    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";
+        this.swaggerBasePrefix =
+            normalizeBasePrefix(mountConfig?.swaggerBasePrefix ?? process.env.UNS_SWAGGER_BASE_PATH) ||
+                this.apiBasePrefix;
         // Add context
         this.expressApplication.use((req, _res, next) => {
             req.appContext = appContext;
@@ -44,7 +68,9 @@ export default class App {
             logger.info("Time: ", Date.now());
             next();
         });
-        this.expressApplication.use("/api", this.router);
+        if (!mountConfig?.disableDefaultApiMount) {
+            this.expressApplication.use(this.apiBasePrefix, this.router);
+        }
         // Swagger specs
         this.swaggerSpec = {
             openapi: "3.0.0",
@@ -53,6 +79,7 @@ export default class App {
                 version: "1.0.0",
             },
             paths: {},
+            servers: this.swaggerBasePrefix ? [{ url: this.swaggerBasePrefix }] : undefined,
         };
     }
     static getExternalIPv4() {
@@ -111,9 +138,10 @@ export default class App {
                 ip = App.getExternalIPv4();
                 port = "";
             }
-            logger.info(`API listening on http://${ip}:${port}/api`);
-            logger.info(`Swagger openAPI on http://${ip}:${port}/${this.processName}/${this.instanceName}/swagger.json`);
-            this.expressApplication.get(`/${this.processName}/${this.instanceName}/swagger.json`, (req, res) => res.json(this.getSwaggerSpec()));
+            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/uns-api-proxy.d.ts

@@ -11,6 +11,8 @@ export default class UnsApiProxy extends UnsProxy {
     protected processStatusTopic: string;
     private app;
     private options;
+    private apiBasePrefix;
+    private swaggerBasePrefix;
     private jwksCache?;
     private catchAllRouteRegistered;
     private startedAt;

package/dist/uns-api-proxy.js

@@ -13,6 +13,23 @@ import { DataSizeMeasurements, PhysicalMeasurements } from "@uns-kit/core/uns/un
 import App from "./app.js";
 const packageJsonPath = path.join(basePath, "package.json");
 const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf8"));
+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 UnsApiProxy extends UnsProxy {
     instanceName;
     topicBuilder;
@@ -20,6 +37,8 @@ export default class UnsApiProxy extends UnsProxy {
     processStatusTopic;
     app;
     options;
+    apiBasePrefix;
+    swaggerBasePrefix;
     jwksCache;
     catchAllRouteRegistered = false;
     startedAt;
@@ -28,7 +47,15 @@ export default class UnsApiProxy extends UnsProxy {
     constructor(processName, instanceName, options) {
         super();
         this.options = options;
-        this.app = new App(0, processName, instanceName);
+        this.apiBasePrefix =
+            normalizeBasePrefix(options.apiBasePath ?? process.env.UNS_API_BASE_PATH) || "/api";
+        this.swaggerBasePrefix =
+            normalizeBasePrefix(options.swaggerBasePath ?? process.env.UNS_SWAGGER_BASE_PATH) || this.apiBasePrefix;
+        this.app = new App(0, processName, instanceName, undefined, {
+            apiBasePrefix: this.apiBasePrefix,
+            swaggerBasePrefix: this.swaggerBasePrefix,
+            disableDefaultApiMount: options.disableDefaultApiMount ?? false,
+        });
         this.app.start();
         this.startedAt = Date.now();
         this.instanceName = instanceName;
@@ -54,7 +81,7 @@ export default class UnsApiProxy extends UnsProxy {
      */
     async unregister(topic, asset, objectType, objectId, attribute, method) {
         const fullPath = `/${topic}${attribute}`;
-        const apiPath = `/api${fullPath}`;
+        const apiPath = `${this.apiBasePrefix}${fullPath}`.replace(/\/{2,}/g, "/");
         const methodKey = method.toLowerCase(); // Express stores method keys in lowercase
         // Remove route from router
         if (this.app.router?.stack) {
@@ -88,6 +115,9 @@ export default class UnsApiProxy extends UnsProxy {
             await new Promise((resolve) => setTimeout(resolve, 100));
         }
         const time = UnsPacket.formatToISO8601(new Date());
+        const fullPath = `/${topic}${attribute}`;
+        const apiPath = `${this.apiBasePrefix}${fullPath}`.replace(/\/{2,}/g, "/");
+        const swaggerPath = buildSwaggerPath(this.swaggerBasePrefix, this.processName, this.instanceName);
         try {
             // Get ip and port from environment variables or defaults
             const addressInfo = this.app.server.address();
@@ -106,17 +136,16 @@ export default class UnsApiProxy extends UnsProxy {
                 topic: topic,
                 attribute: attribute,
                 apiHost: `http://${ip}:${port}`,
-                apiEndpoint: `/api/${topic}${attribute}`,
+                apiEndpoint: apiPath,
                 apiMethod: "GET",
                 apiQueryParams: options.queryParams,
                 apiDescription: options?.apiDescription,
                 attributeType: UnsAttributeType.Api,
-                apiSwaggerEndpoint: `/${this.processName}/${this.instanceName}/swagger.json`,
+                apiSwaggerEndpoint: swaggerPath,
                 asset,
                 objectType,
                 objectId
             });
-            const fullPath = `/${topic}${attribute}`;
             const handler = (req, res) => {
                 // Query param validation
                 if (options?.queryParams) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uns-kit/api",
-  "version": "2.0.4",
+  "version": "2.0.6",
   "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": "2.0.4"
+    "@uns-kit/core": "2.0.6"
   },
   "devDependencies": {
     "@types/jsonwebtoken": "^9.0.10",