@uns-kit/core 2.0.40 → 2.0.41

package/dist/uns-grpc/uns-gateway.proto

@@ -1,104 +1,104 @@
-syntax = "proto3";
-
-package uns;
-
-service UnsGateway {
-  rpc Publish (PublishRequest) returns (Ack);
-  rpc Subscribe (SubscribeRequest) returns (stream MqttMessage);
-  rpc RegisterApiGet (RegisterApiGetRequest) returns (Ack);
-  rpc UnregisterApiGet (UnregisterApiGetRequest) returns (Ack);
-  rpc ApiEventStream (stream ApiEventResponse) returns (stream ApiEvent);
-  rpc Ready (ReadyRequest) returns (Ack);
-}
-
-message PublishRequest {
-  string topic = 1;
-  string attribute = 2;
-  string description = 3;
-  repeated string tags = 4;
-  bool attribute_needs_persistence = 5;
-  oneof content {
-    Data data = 6;
-    Table table = 7;
-  }
-  bool value_is_cumulative = 8; // for Data: publish as delta
-}
-
-message Data {
-  string time = 1;
-  double value_number = 2;
-  string value_string = 3;
-  string uom = 4;
-  string data_group = 5;
-  string foreign_event_key = 6;
-}
-
-message TableValue {
-  string name = 1;
-  string type = 2;          // QuestDB column type (e.g., int, double, geohash(5c))
-  string uom = 3;           // Optional unit of measure
-  double value_number = 4;
-  string value_string = 5;
-}
-
-message Table {
-  string time = 1;
-  repeated TableValue columns = 2;
-  string data_group = 3;
-}
-
-message SubscribeRequest {
-  repeated string topics = 1;
-}
-
-message MqttMessage {
-  string topic = 1;
-  string payload = 2; // UNS packet JSON
-}
-
-message Ack {
-  bool ok = 1;
-  string error = 2;
-}
-
-message ReadyRequest {
-  int32 timeout_ms = 1;              // default 15000
-  bool wait_output = 2;              // wait for publisher active (output)
-  bool wait_input = 3;               // wait for subscriber active (input)
-  bool wait_api = 4;                 // wait for API server (optional)
-}
-
-message ApiQueryParam {
-  string name = 1;
-  string type = 2; // string | number | boolean
-  bool required = 3;
-  string description = 4;
-}
-
-message RegisterApiGetRequest {
-  string topic = 1;
-  string attribute = 2;
-  string api_description = 3;
-  repeated string tags = 4;
-  repeated ApiQueryParam query_params = 5;
-}
-
-message UnregisterApiGetRequest {
-  string topic = 1;
-  string attribute = 2;
-}
-
-message ApiEvent {
-  string id = 1;
-  string method = 2; // GET only for now
-  string path = 3;   // /{topic}{attribute}
-  map<string, string> query = 4;
-  string bearer = 5; // access token (optional)
-}
-
-message ApiEventResponse {
-  string id = 1;          // correlation
-  int32 status = 2;       // HTTP status
-  string body = 3;        // response body as string (JSON string if needed)
-  map<string, string> headers = 4; // optional extra headers
-}
+syntax = "proto3";
+
+package uns;
+
+service UnsGateway {
+  rpc Publish (PublishRequest) returns (Ack);
+  rpc Subscribe (SubscribeRequest) returns (stream MqttMessage);
+  rpc RegisterApiGet (RegisterApiGetRequest) returns (Ack);
+  rpc UnregisterApiGet (UnregisterApiGetRequest) returns (Ack);
+  rpc ApiEventStream (stream ApiEventResponse) returns (stream ApiEvent);
+  rpc Ready (ReadyRequest) returns (Ack);
+}
+
+message PublishRequest {
+  string topic = 1;
+  string attribute = 2;
+  string description = 3;
+  repeated string tags = 4;
+  bool attribute_needs_persistence = 5;
+  oneof content {
+    Data data = 6;
+    Table table = 7;
+  }
+  bool value_is_cumulative = 8; // for Data: publish as delta
+}
+
+message Data {
+  string time = 1;
+  double value_number = 2;
+  string value_string = 3;
+  string uom = 4;
+  string data_group = 5;
+  string foreign_event_key = 6;
+}
+
+message TableValue {
+  string name = 1;
+  string type = 2;          // QuestDB column type (e.g., int, double, geohash(5c))
+  string uom = 3;           // Optional unit of measure
+  double value_number = 4;
+  string value_string = 5;
+}
+
+message Table {
+  string time = 1;
+  repeated TableValue columns = 2;
+  string data_group = 3;
+}
+
+message SubscribeRequest {
+  repeated string topics = 1;
+}
+
+message MqttMessage {
+  string topic = 1;
+  string payload = 2; // UNS packet JSON
+}
+
+message Ack {
+  bool ok = 1;
+  string error = 2;
+}
+
+message ReadyRequest {
+  int32 timeout_ms = 1;              // default 15000
+  bool wait_output = 2;              // wait for publisher active (output)
+  bool wait_input = 3;               // wait for subscriber active (input)
+  bool wait_api = 4;                 // wait for API server (optional)
+}
+
+message ApiQueryParam {
+  string name = 1;
+  string type = 2; // string | number | boolean
+  bool required = 3;
+  string description = 4;
+}
+
+message RegisterApiGetRequest {
+  string topic = 1;
+  string attribute = 2;
+  string api_description = 3;
+  repeated string tags = 4;
+  repeated ApiQueryParam query_params = 5;
+}
+
+message UnregisterApiGetRequest {
+  string topic = 1;
+  string attribute = 2;
+}
+
+message ApiEvent {
+  string id = 1;
+  string method = 2; // GET only for now
+  string path = 3;   // /{topic}{attribute}
+  map<string, string> query = 4;
+  string bearer = 5; // access token (optional)
+}
+
+message ApiEventResponse {
+  string id = 1;          // correlation
+  int32 status = 2;       // HTTP status
+  string body = 3;        // response body as string (JSON string if needed)
+  map<string, string> headers = 4; // optional extra headers
+}

package/dist/uns-mqtt/mqtt-topic-builder.d.ts

@@ -38,6 +38,12 @@ export declare class MqttTopicBuilder {
      * Example: "uns-infra/packageName/version/processName/handover"
      */
     getHandoverTopic(): string;
+    /**
+     * Returns the retained metadata topic for product/system service discovery.
+     *
+     * Example: "uns-infra/packageName/version/processName/service-metadata"
+     */
+    getServiceMetadataTopic(): string;
     /**
      * Returns a wildcard topic for active status messages from any process.
      * Useful for subscriptions that must capture status from multiple processes.

package/dist/uns-mqtt/mqtt-topic-builder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mqtt-topic-builder.d.ts","sourceRoot":"","sources":["../../src/uns-mqtt/mqtt-topic-builder.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,qBAAa,gBAAgB;IACzB,OAAO,CAAC,kBAAkB,CAAS;IAEnC;;;;;OAKG;gBACS,kBAAkB,EAAE,MAAM;IAQtC;;;;OAIG;WACW,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IASrD;;;;OAIG;IACI,qBAAqB,IAAI,MAAM;IAItC;;;;OAIG;IACI,cAAc,IAAI,MAAM;IAI/B;;;;OAIG;IACI,gBAAgB,IAAI,MAAM;IAIjC;;;;;OAKG;IACI,sBAAsB,IAAI,MAAM;IAIvC;;;;;;;OAOG;WACW,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;CAO1D"}
+{"version":3,"file":"mqtt-topic-builder.d.ts","sourceRoot":"","sources":["../../src/uns-mqtt/mqtt-topic-builder.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,qBAAa,gBAAgB;IACzB,OAAO,CAAC,kBAAkB,CAAS;IAEnC;;;;;OAKG;gBACS,kBAAkB,EAAE,MAAM;IAQtC;;;;OAIG;WACW,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IASrD;;;;OAIG;IACI,qBAAqB,IAAI,MAAM;IAItC;;;;OAIG;IACI,cAAc,IAAI,MAAM;IAI/B;;;;OAIG;IACI,gBAAgB,IAAI,MAAM;IAIjC;;;;OAIG;IACI,uBAAuB,IAAI,MAAM;IAIxC;;;;;OAKG;IACI,sBAAsB,IAAI,MAAM;IAIvC;;;;;;;OAOG;WACW,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM;CAO1D"}

package/dist/uns-mqtt/mqtt-topic-builder.js

@@ -56,6 +56,14 @@ export class MqttTopicBuilder {
     getHandoverTopic() {
         return this.getProcessStatusTopic() + "handover";
     }
+    /**
+     * Returns the retained metadata topic for product/system service discovery.
+     *
+     * Example: "uns-infra/packageName/version/processName/service-metadata"
+     */
+    getServiceMetadataTopic() {
+        return this.getProcessStatusTopic() + "service-metadata";
+    }
     /**
      * Returns a wildcard topic for active status messages from any process.
      * Useful for subscriptions that must capture status from multiple processes.

package/dist/uns-mqtt/mqtt-topic-builder.js.map

@@ -1 +1 @@
-{"version":3,"file":"mqtt-topic-builder.js","sourceRoot":"","sources":["../../src/uns-mqtt/mqtt-topic-builder.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,OAAO,gBAAgB;IACjB,kBAAkB,CAAS;IAEnC;;;;;OAKG;IACH,YAAY,kBAA0B;QAEpC,IAAI,CAAC,oCAAoC,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACnE,MAAM,IAAI,KAAK,CAAC,+FAA+F,CAAC,CAAC;QACnH,CAAC;QACD,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,IAAY;QAC1C,MAAM,SAAS,GAAG,IAAI;aACnB,OAAO,CAAC,kBAAkB,EAAE,GAAG,CAAC;aAChC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC;aACtB,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QAE3B,OAAO,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC;IAC1D,CAAC;IAAA,CAAC;IAEF;;;;OAIG;IACI,qBAAqB;QAC1B,OAAO,IAAI,CAAC,kBAAkB,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACI,cAAc;QACnB,OAAO,IAAI,CAAC,qBAAqB,EAAE,GAAG,QAAQ,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACI,gBAAgB;QACrB,OAAO,IAAI,CAAC,qBAAqB,EAAE,GAAG,UAAU,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACI,sBAAsB;QAC3B,OAAO,IAAI,CAAC,qBAAqB,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC;IACvF,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,gBAAgB,CAAC,SAAiB;QAC9C,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACnC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,oFAAoF,CAAC,CAAC;QACxG,CAAC;QACD,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;IAC3C,CAAC;CACF","sourcesContent":["/**\n * MqttTopicBuilder is a utility class responsible for generating MQTT topics\n * based on a standardized pattern using the package name, version, and process name.\n *\n * This centralizes all MQTT topic definitions so that changes to topic structures\n * only need to be made in one place.\n */\nexport class MqttTopicBuilder {\n    private processStatusTopic: string;\n\n    /**\n     * Constructor for MqttTopicBuilder.\n     * It validates the provided process status topic and initializes the instance.\n     * @param processStatusTopic The base topic for the process status.\n     * Example: \"uns-infra/packageName/version/processName/\"\n     */\n    constructor(processStatusTopic: string) {\n      \n      if (!/^uns-infra\\/[^/]+\\/[^/]+\\/[^/]+\\/$/.test(processStatusTopic)) {\n        throw new Error(\"processStatusTopic must follow the pattern 'uns-infra/<packageName>/<version>/<processName>/'\");\n      }\n      this.processStatusTopic = processStatusTopic;\n    }\n\n    /**\n     * Sanitize topic\n     * @param name \n     * @returns \n     */\n    public static sanitizeTopicPart(name: string): string {\n      const sanitized = name\n        .replace(/[^a-zA-Z0-9_-]+/g, \"-\")\n        .replace(/-{2,}/g, \"-\")\n        .replace(/^-+|-+$/g, \"\");\n\n      return sanitized.length > 0 ? sanitized : \"uns-process\";\n    };    \n  \n    /**\n     * Returns the process status topic.\n     *\n     * Example: \"uns-infra/packageName/version/processName\"\n     */\n    public getProcessStatusTopic(): string {\n      return this.processStatusTopic;\n    }\n  \n    /**\n     * Returns the topic used for publishing the active state.\n     *\n     * Example: \"uns-infra/packageName/version/processName/active\"\n     */\n    public getActiveTopic(): string {\n      return this.getProcessStatusTopic() + \"active\";\n    }\n  \n    /**\n     * Returns the topic used for handover requests.\n     *\n     * Example: \"uns-infra/packageName/version/processName/handover\"\n     */\n    public getHandoverTopic(): string {\n      return this.getProcessStatusTopic() + \"handover\";\n    }\n    \n    /**\n     * Returns a wildcard topic for active status messages from any process.\n     * Useful for subscriptions that must capture status from multiple processes.\n     *\n     * Example: \"uns-infra/packageName/+/+/active\"\n     */\n    public getWildcardActiveTopic(): string {\n      return this.getProcessStatusTopic().split('/').slice(0, 2).join('/') + '/+/+/active';\n    }\n\n    /**\n     * Extract base topic from a full topic string.\n     * This is useful for creating a topic builder from an existing topic.\n     * @param fullTopic The full topic string.\n     * Example: \"uns-infra/packageName/version/processName/active\"\n     * @returns The base topic string.\n     * Example: \"uns-infra/packageName/version/processName/\"\n     */\n    public static extractBaseTopic(fullTopic: string): string {\n      const parts = fullTopic.split('/');\n      if (parts.length < 4) {\n        throw new Error(\"Invalid topic format. Expected 'uns-infra/<packageName>/<version>/<processName>/'.\");\n      }\n      return parts.slice(0, 4).join('/') + '/';\n    }\n  }\n  "]}
+{"version":3,"file":"mqtt-topic-builder.js","sourceRoot":"","sources":["../../src/uns-mqtt/mqtt-topic-builder.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,OAAO,gBAAgB;IACjB,kBAAkB,CAAS;IAEnC;;;;;OAKG;IACH,YAAY,kBAA0B;QAEpC,IAAI,CAAC,oCAAoC,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACnE,MAAM,IAAI,KAAK,CAAC,+FAA+F,CAAC,CAAC;QACnH,CAAC;QACD,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,IAAY;QAC1C,MAAM,SAAS,GAAG,IAAI;aACnB,OAAO,CAAC,kBAAkB,EAAE,GAAG,CAAC;aAChC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC;aACtB,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QAE3B,OAAO,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC;IAC1D,CAAC;IAAA,CAAC;IAEF;;;;OAIG;IACI,qBAAqB;QAC1B,OAAO,IAAI,CAAC,kBAAkB,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACI,cAAc;QACnB,OAAO,IAAI,CAAC,qBAAqB,EAAE,GAAG,QAAQ,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACI,gBAAgB;QACrB,OAAO,IAAI,CAAC,qBAAqB,EAAE,GAAG,UAAU,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACI,uBAAuB;QAC5B,OAAO,IAAI,CAAC,qBAAqB,EAAE,GAAG,kBAAkB,CAAC;IAC3D,CAAC;IAED;;;;;OAKG;IACI,sBAAsB;QAC3B,OAAO,IAAI,CAAC,qBAAqB,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,aAAa,CAAC;IACvF,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,gBAAgB,CAAC,SAAiB;QAC9C,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACnC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,oFAAoF,CAAC,CAAC;QACxG,CAAC;QACD,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;IAC3C,CAAC;CACF","sourcesContent":["/**\n * MqttTopicBuilder is a utility class responsible for generating MQTT topics\n * based on a standardized pattern using the package name, version, and process name.\n *\n * This centralizes all MQTT topic definitions so that changes to topic structures\n * only need to be made in one place.\n */\nexport class MqttTopicBuilder {\n    private processStatusTopic: string;\n\n    /**\n     * Constructor for MqttTopicBuilder.\n     * It validates the provided process status topic and initializes the instance.\n     * @param processStatusTopic The base topic for the process status.\n     * Example: \"uns-infra/packageName/version/processName/\"\n     */\n    constructor(processStatusTopic: string) {\n      \n      if (!/^uns-infra\\/[^/]+\\/[^/]+\\/[^/]+\\/$/.test(processStatusTopic)) {\n        throw new Error(\"processStatusTopic must follow the pattern 'uns-infra/<packageName>/<version>/<processName>/'\");\n      }\n      this.processStatusTopic = processStatusTopic;\n    }\n\n    /**\n     * Sanitize topic\n     * @param name \n     * @returns \n     */\n    public static sanitizeTopicPart(name: string): string {\n      const sanitized = name\n        .replace(/[^a-zA-Z0-9_-]+/g, \"-\")\n        .replace(/-{2,}/g, \"-\")\n        .replace(/^-+|-+$/g, \"\");\n\n      return sanitized.length > 0 ? sanitized : \"uns-process\";\n    };    \n  \n    /**\n     * Returns the process status topic.\n     *\n     * Example: \"uns-infra/packageName/version/processName\"\n     */\n    public getProcessStatusTopic(): string {\n      return this.processStatusTopic;\n    }\n  \n    /**\n     * Returns the topic used for publishing the active state.\n     *\n     * Example: \"uns-infra/packageName/version/processName/active\"\n     */\n    public getActiveTopic(): string {\n      return this.getProcessStatusTopic() + \"active\";\n    }\n  \n    /**\n     * Returns the topic used for handover requests.\n     *\n     * Example: \"uns-infra/packageName/version/processName/handover\"\n     */\n    public getHandoverTopic(): string {\n      return this.getProcessStatusTopic() + \"handover\";\n    }\n\n    /**\n     * Returns the retained metadata topic for product/system service discovery.\n     *\n     * Example: \"uns-infra/packageName/version/processName/service-metadata\"\n     */\n    public getServiceMetadataTopic(): string {\n      return this.getProcessStatusTopic() + \"service-metadata\";\n    }\n    \n    /**\n     * Returns a wildcard topic for active status messages from any process.\n     * Useful for subscriptions that must capture status from multiple processes.\n     *\n     * Example: \"uns-infra/packageName/+/+/active\"\n     */\n    public getWildcardActiveTopic(): string {\n      return this.getProcessStatusTopic().split('/').slice(0, 2).join('/') + '/+/+/active';\n    }\n\n    /**\n     * Extract base topic from a full topic string.\n     * This is useful for creating a topic builder from an existing topic.\n     * @param fullTopic The full topic string.\n     * Example: \"uns-infra/packageName/version/processName/active\"\n     * @returns The base topic string.\n     * Example: \"uns-infra/packageName/version/processName/\"\n     */\n    public static extractBaseTopic(fullTopic: string): string {\n      const parts = fullTopic.split('/');\n      if (parts.length < 4) {\n        throw new Error(\"Invalid topic format. Expected 'uns-infra/<packageName>/<version>/<processName>/'.\");\n      }\n      return parts.slice(0, 4).join('/') + '/';\n    }\n  }\n"]}