@eclipse-ditto/ditto-javascript-client-dom/dist/api/src/client/handles/messages-websocket.js

DOM implementation of Eclipse Ditto JavaScript API to be used in browsers.

/*!
 * Copyright (c) 2019 Contributors to the Eclipse Foundation
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0
 *
 * SPDX-License-Identifier: EPL-2.0
 */
import { AllSubscription } from '../request-factory/websocket-request-handler';
import { WebSocketBindingMessage } from '../request-factory/resilience/websocket-resilience-interfaces';
import { ContentType } from '../constants/content-type';
/**
 * Handle to send and receive Messages. To be able to subscribe to Messages requestMessages() needs to be called first
 */
export class DefaultWebSocketMessagesHandle {
    constructor(requestFactory, requester) {
        this.requestFactory = requestFactory;
        this.requester = requester;
        this.messages = false;
    }
    /**
     * returns an instance of WebSocketMessagesHandle using the provided RequestSender.
     *
     * @param builder - The builder for the RequestSender to work with.
     * @param requester - Requester to use for subscriptions.
     * @returns The WebSocketMessagesHandle
     */
    static getInstance(builder, requester) {
        return new DefaultWebSocketMessagesHandle(builder.buildInstance('things'), requester);
    }
    /**
     * Initiates claiming the specified Thing and returns its response.
     *
     * @param thingId - The ID of the Thing to claim.
     * @param options - Options to use for the request.
     * @returns A Promise for the response
     */
    claim(thingId, claimMessage, options) {
        return this.requestFactory.sendMessageWithResponse({
            options,
            id: thingId,
            path: '',
            messageSubject: 'claim',
            message: claimMessage,
            direction: 'inbox',
            contentType: ContentType.TEXT
        });
    }
    /**
     * Initiates claiming the specified Thing.
     *
     * @param thingId - The ID of the Thing to claim.
     * @param claimMessage - The message to send to the Thing.
     * @param options - Options to use for the request.
     */
    claimWithoutResponse(thingId, claimMessage, options) {
        return this.requestFactory.sendMessage({
            options,
            id: thingId,
            messageSubject: 'claim',
            message: claimMessage,
            direction: 'inbox',
            contentType: ContentType.TEXT
        });
    }
    /**
     * Sends a message to a Thing.
     *
     * @param thingId - The ID of the Thing to message.
     * @param messageSubject - The subject of the message to send.
     * @param message - The message to send.
     * @param contentType - Content type of the message.
     * @param options - Options to use for the request.
     * @returns A Promise for the response
     */
    messageToThing(thingId, messageSubject, message, contentType, options) {
        return this.requestFactory.sendMessageWithResponse({
            messageSubject,
            message,
            contentType,
            options,
            id: thingId,
            direction: 'inbox'
        });
    }
    /**
     * Sends a message to a Thing and returns its response.
     *
     * @param thingId - The ID of the Thing to message.
     * @param messageSubject - The subject of the message to send.
     * @param message - The message to send.
     * @param contentType - Content type of the message.
     * @param options - Options to use for the request.
     */
    messageToThingWithoutResponse(thingId, messageSubject, message, contentType, options) {
        return this.requestFactory.sendMessage({
            messageSubject,
            message,
            contentType,
            options,
            id: thingId,
            direction: 'inbox'
        });
    }
    /**
     * Sends a message from a Thing.
     *
     * @param thingId - The ID of the Thing to message.
     * @param messageSubject - The subject of the message to send.
     * @param message - The message to send.
     * @param contentType - Content type of the message.
     * @param options - Options to use for the request.
     * @returns A Promise for the response
     */
    messageFromThing(thingId, messageSubject, message, contentType, options) {
        return this.requestFactory.sendMessageWithResponse({
            messageSubject,
            message,
            contentType,
            options,
            id: thingId,
            direction: 'outbox'
        });
    }
    /**
     * Sends a message from a Thing and returns the response.
     *
     * @param thingId - The ID of the Thing to message.
     * @param messageSubject - The subject of the message to send.
     * @param message - The message to send.
     * @param contentType - Content type of the message.
     * @param options - Options to use for the request.
     */
    messageFromThingWithoutResponse(thingId, messageSubject, message, contentType, options) {
        return this.requestFactory.sendMessage({
            messageSubject,
            message,
            contentType,
            options,
            id: thingId,
            direction: 'outbox'
        });
    }
    /**
     * Sends a message to a Feature.
     *
     * @param thingId - The ID of the Thing that the Feature belongs to.
     * @param featureId - The ID of the Feature to message.
     * @param messageSubject - The subject of the message to send.
     * @param message - The message to send.
     * @param contentType - Content type of the message.
     * @param options - Options to use for the request.
     * @returns A Promise for the response
     */
    messageToFeature(thingId, featureId, messageSubject, message, contentType, options) {
        return this.requestFactory.sendMessageWithResponse({
            messageSubject,
            message,
            contentType,
            options,
            id: thingId,
            direction: 'inbox',
            path: `/features/${featureId}`
        });
    }
    /**
     * Sends a message to a Feature and returns its response.
     *
     * @param thingId - The ID of the Thing that the Feature belongs to.
     * @param featureId - The ID of the Feature to message.
     * @param messageSubject - The subject of the message to send.
     * @param message - The message to send.
     * @param contentType - Content type of the message.
     * @param options - Options to use for the request.
     */
    messageToFeatureWithoutResponse(thingId, featureId, messageSubject, message, contentType, options) {
        return this.requestFactory.sendMessage({
            messageSubject,
            message,
            contentType,
            options,
            id: thingId,
            direction: 'inbox',
            path: `/features/${featureId}`
        });
    }
    /**
     * Sends a message from a Feature.
     *
     * @param thingId - The ID of the Thing that the Feature belongs to.
     * @param featureId - The ID of the Feature to message.
     * @param messageSubject - The subject of the message to send.
     * @param message - The message to send.
     * @param contentType - Content type of the message.
     * @param options - Options to use for the request.
     * @returns A Promise for the response
     */
    messageFromFeature(thingId, featureId, messageSubject, message, contentType, options) {
        return this.requestFactory.sendMessageWithResponse({
            messageSubject,
            message,
            contentType,
            options,
            id: thingId,
            direction: 'outbox',
            path: `/features/${featureId}`
        });
    }
    /**
     * Sends a message from a Feature and returns the response.
     *
     * @param thingId - The ID of the Thing that the Feature belongs to.
     * @param featureId - The ID of the Feature to message.
     * @param messageSubject - The subject of the message to send.
     * @param message - The message to send.
     * @param contentType - Content type of the message.
     * @param options - Options to use for the request.
     */
    messageFromFeatureWithoutResponse(thingId, featureId, messageSubject, message, contentType, options) {
        return this.requestFactory.sendMessage({
            messageSubject,
            message,
            contentType,
            options,
            id: thingId,
            direction: 'outbox',
            path: `/features/${featureId}`
        });
    }
    /**
     * Registers the provided callback function. registerMessages() needs to be called first.
     * It will be called every time a Message is received
     *
     * @param callback - The function that gets called for every Event.
     * @returns The id for the registered subscription.
     */
    subscribeToAllMessages(callback) {
        this.checkMessages();
        return this.requester.subscribe(new AllSubscription(callback, 'messages'));
    }
    /**
     * Registers the provided callback function. registerMessages() needs to be called first.
     * It will be called every time a Message concerning the specified Thing is received
     *
     * @param thingId - The ID of the Thing to listen to.
     * @param callback - The function that gets called for every Event.
     * @param topic - The message topic to listen for.
     * @param direction - The direction to listen for (outbox/inbox).
     * @returns The id for the registered subscription.
     * @throws Error - Throws an Error if Events were not requested by calling requestEvents()
     */
    subscribeToThing(thingId, callback, topic, direction) {
        return this.buildSubscription({
            callback,
            direction,
            action: topic,
            id: thingId,
            type: 'messages'
        });
    }
    /**
     * Registers the provided callback function. registerMessages() needs to be called first.
     * It will be called every time a Message concerning the specified Feature is received
     *
     * @param thingId - The ID of the Thing the Feature belongs to.
     * @param featureId - The ID of the Feature to listen to.
     * @param callback - The function that gets called for every Event.
     * @param topic - The message topic to listen for.
     * @param direction - The direction to listen for (outbox/inbox).
     * @returns The id for the registered subscription.
     * @throws Error - Throws an Error if Events were not requested by calling requestEvents()
     */
    subscribeToFeature(thingId, featureId, callback, topic, direction) {
        return this.buildSubscription({
            callback,
            direction,
            action: topic,
            id: thingId,
            type: 'messages',
            path: `/features/${featureId}`
        });
    }
    /**
     * Deletes the subscription with the specified ID so it's callback function will no longer be called.
     * If you want to stop receiving any Messages you need to call stopMessages().
     *
     * @param id - The ID of the subscription to remove.
     */
    deleteSubscription(id) {
        this.requester.deleteSubscription(id);
    }
    /**
     * Requests that Messages be sent from the server. This is needed in order to register subscriptions.
     *
     * @returns A Promise that resolves once the server acknowledges the request or if Messages are already registered.
     */
    requestMessages() {
        if (this.messages) {
            return Promise.resolve();
        }
        return this.requester.sendProtocolMessage(WebSocketBindingMessage.START_SEND_MESSAGES)
            .then(() => {
            this.messages = true;
        });
    }
    /**
     * Requests that Messages no longer be sent from the server. None of the subscriptions will be deleted.
     *
     * @returns A Promise that resolves once the server acknowledges the request or if Messages are already stopped.
     */
    stopMessages() {
        if (!this.messages) {
            return Promise.resolve();
        }
        return this.requester.sendProtocolMessage(WebSocketBindingMessage.STOP_SEND_MESSAGES)
            .then(() => {
            this.messages = false;
        });
    }
    /**
     * Builds and registers the subscription with the specified options.
     *
     * @param options - The options to use for the subscription.
     * @returns The ID of the subscription that was registered.
     * @throws Error - Throws an Error if Messages were not requested.
     */
    buildSubscription(options) {
        this.checkMessages();
        const originalPath = options['path'] !== undefined ? options['path'] : '';
        const path = options['direction'] ? `${originalPath}/${options['direction']}` : originalPath;
        options['path'] = path;
        return this.requestFactory.subscribe(options);
    }
    /**
     * Checks if Messages were requested.
     *
     * @throws Error - Throws an Error if Messages were not requested.
     */
    checkMessages() {
        if (!this.messages) {
            throw Error('No Messages were requested. Please call requestMessages() first');
        }
    }
}
//# sourceMappingURL=messages-websocket.js.map