@uns-kit/core/dist/uns-mqtt/mqtt-topic-builder.js

Core utilities and runtime building blocks for UNS-based realtime transformers.

/**
 * MqttTopicBuilder is a utility class responsible for generating MQTT topics
 * based on a standardized pattern using the package name, version, and process name.
 *
 * This centralizes all MQTT topic definitions so that changes to topic structures
 * only need to be made in one place.
 */
export class MqttTopicBuilder {
    processStatusTopic;
    /**
     * Constructor for MqttTopicBuilder.
     * It validates the provided process status topic and initializes the instance.
     * @param processStatusTopic The base topic for the process status.
     * Example: "uns-infra/packageName/version/processName/"
     */
    constructor(processStatusTopic) {
        if (!/^uns-infra\/[^/]+\/[^/]+\/[^/]+\/$/.test(processStatusTopic)) {
            throw new Error("processStatusTopic must follow the pattern 'uns-infra/<packageName>/<version>/<processName>/'");
        }
        this.processStatusTopic = processStatusTopic;
    }
    /**
     * Sanitize topic
     * @param name
     * @returns
     */
    static sanitizeTopicPart(name) {
        const sanitized = name
            .replace(/[^a-zA-Z0-9_-]+/g, "-")
            .replace(/-{2,}/g, "-")
            .replace(/^-+|-+$/g, "");
        return sanitized.length > 0 ? sanitized : "uns-process";
    }
    ;
    /**
     * Returns the process status topic.
     *
     * Example: "uns-infra/packageName/version/processName"
     */
    getProcessStatusTopic() {
        return this.processStatusTopic;
    }
    /**
     * Returns the topic used for publishing the active state.
     *
     * Example: "uns-infra/packageName/version/processName/active"
     */
    getActiveTopic() {
        return this.getProcessStatusTopic() + "active";
    }
    /**
     * Returns the topic used for handover requests.
     *
     * Example: "uns-infra/packageName/version/processName/handover"
     */
    getHandoverTopic() {
        return this.getProcessStatusTopic() + "handover";
    }
    /**
     * Returns a wildcard topic for active status messages from any process.
     * Useful for subscriptions that must capture status from multiple processes.
     *
     * Example: "uns-infra/packageName/+/+/active"
     */
    getWildcardActiveTopic() {
        return this.getProcessStatusTopic().split('/').slice(0, 2).join('/') + '/+/+/active';
    }
    /**
     * Extract base topic from a full topic string.
     * This is useful for creating a topic builder from an existing topic.
     * @param fullTopic The full topic string.
     * Example: "uns-infra/packageName/version/processName/active"
     * @returns The base topic string.
     * Example: "uns-infra/packageName/version/processName/"
     */
    static extractBaseTopic(fullTopic) {
        const parts = fullTopic.split('/');
        if (parts.length < 4) {
            throw new Error("Invalid topic format. Expected 'uns-infra/<packageName>/<version>/<processName>/'.");
        }
        return parts.slice(0, 4).join('/') + '/';
    }
}
//# sourceMappingURL=mqtt-topic-builder.js.map