@uns-kit/api 2.0.40 → 2.0.42

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

@@ -1,70 +1,70 @@
-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";
-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;
-    constructor(processName: string, instanceName: string, options: IApiProxyOptions);
-    /**
-     * 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>;
-    /**
-     * Register a POST endpoint.
-     * @param topic - The API topic
-     * @param attribute - The attribute for the topic.
-     * @param options.apiDescription - Optional description.
-     * @param options.tags - Optional tags.
-     * @param options.requestBody - Optional request body schema for Swagger.
-     */
-    post(topic: UnsTopics, asset: UnsAsset, objectType: UnsObjectType, objectId: UnsObjectId, attribute: UnsAttribute, options?: IPostEndpointOptions): Promise<void>;
-    private emitStatusMetrics;
-    private registerHealthEndpoint;
-    private extractBearerToken;
-    private getPublicKeyFromJwks;
-    private fetchJwksKeys;
-    private certFromX5c;
-    stop(): Promise<void>;
-}
+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";
+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;
+    constructor(processName: string, instanceName: string, options: IApiProxyOptions);
+    /**
+     * 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>;
+    /**
+     * Register a POST endpoint.
+     * @param topic - The API topic
+     * @param attribute - The attribute for the topic.
+     * @param options.apiDescription - Optional description.
+     * @param options.tags - Optional tags.
+     * @param options.requestBody - Optional request body schema for Swagger.
+     */
+    post(topic: UnsTopics, asset: UnsAsset, objectType: UnsObjectType, objectId: UnsObjectId, attribute: UnsAttribute, options?: IPostEndpointOptions): Promise<void>;
+    private emitStatusMetrics;
+    private registerHealthEndpoint;
+    private extractBearerToken;
+    private getPublicKeyFromJwks;
+    private fetchJwksKeys;
+    private certFromX5c;
+    stop(): Promise<void>;
+}