@rocket.chat/apps-engine/deno-runtime/lib/accessors/builders/RoomBuilder.ts

The engine code for the Rocket.Chat Apps which manages, runs, translates, coordinates and all of that.

import type { IRoomBuilder } from '@rocket.chat/apps-engine/definition/accessors/IRoomBuilder.ts';
import type { IRoom } from '@rocket.chat/apps-engine/definition/rooms/IRoom.ts';
import type { IUser } from '@rocket.chat/apps-engine/definition/users/IUser.ts';

import type { RoomType } from '@rocket.chat/apps-engine/definition/rooms/RoomType.ts';
import type { RocketChatAssociationModel as _RocketChatAssociationModel } from '@rocket.chat/apps-engine/definition/metadata/RocketChatAssociations.ts';

import { require } from '../../../lib/require.ts';

const { RocketChatAssociationModel } = require('@rocket.chat/apps-engine/definition/metadata/RocketChatAssociations.js') as {
    RocketChatAssociationModel: typeof _RocketChatAssociationModel;
};

export class RoomBuilder implements IRoomBuilder {
    public kind: _RocketChatAssociationModel.ROOM | _RocketChatAssociationModel.DISCUSSION;

    protected room: IRoom;

    private members: Array<string>;

    private changes: Partial<IRoom> = {};
    private customFieldsChanged = false;

    constructor(data?: Partial<IRoom>) {
        this.kind = RocketChatAssociationModel.ROOM;
        this.room = (data || { customFields: {} }) as IRoom;
        this.members = [];
    }

    public setData(data: Partial<IRoom>): IRoomBuilder {
        delete data.id;
        this.room = data as IRoom;

        this.changes = structuredClone(this.room);

        return this;
    }

    public setDisplayName(name: string): IRoomBuilder {
        this.room.displayName = name;
        this.changes.displayName = name;

        return this;
    }

    public getDisplayName(): string {
        return this.room.displayName!;
    }

    public setSlugifiedName(name: string): IRoomBuilder {
        this.room.slugifiedName = name;
        this.changes.slugifiedName = name;

        return this;
    }

    public getSlugifiedName(): string {
        return this.room.slugifiedName;
    }

    public setType(type: RoomType): IRoomBuilder {
        this.room.type = type;
        this.changes.type = type;

        return this;
    }

    public getType(): RoomType {
        return this.room.type;
    }

    public setCreator(creator: IUser): IRoomBuilder {
        this.room.creator = creator;
        this.changes.creator = creator;

        return this;
    }

    public getCreator(): IUser {
        return this.room.creator;
    }

    /**
     * @deprecated
     */
    public addUsername(username: string): IRoomBuilder {
        this.addMemberToBeAddedByUsername(username);
        return this;
    }

    /**
     * @deprecated
     */
    public setUsernames(usernames: Array<string>): IRoomBuilder {
        this.setMembersToBeAddedByUsernames(usernames);
        return this;
    }

    /**
     * @deprecated
     */
    public getUsernames(): Array<string> {
        const usernames = this.getMembersToBeAddedUsernames();
        if (usernames && usernames.length > 0) {
            return usernames;
        }
        return this.room.usernames || [];
    }

    public addMemberToBeAddedByUsername(username: string): IRoomBuilder {
        this.members.push(username);
        return this;
    }

    public setMembersToBeAddedByUsernames(usernames: Array<string>): IRoomBuilder {
        this.members = usernames;
        return this;
    }

    public getMembersToBeAddedUsernames(): Array<string> {
        return this.members;
    }

    public setDefault(isDefault: boolean): IRoomBuilder {
        this.room.isDefault = isDefault;
        this.changes.isDefault = isDefault;

        return this;
    }

    public getIsDefault(): boolean {
        return this.room.isDefault!;
    }

    public setReadOnly(isReadOnly: boolean): IRoomBuilder {
        this.room.isReadOnly = isReadOnly;
        this.changes.isReadOnly = isReadOnly;

        return this;
    }

    public getIsReadOnly(): boolean {
        return this.room.isReadOnly!;
    }

    public setDisplayingOfSystemMessages(displaySystemMessages: boolean): IRoomBuilder {
        this.room.displaySystemMessages = displaySystemMessages;
        this.changes.displaySystemMessages = displaySystemMessages;

        return this;
    }

    public getDisplayingOfSystemMessages(): boolean {
        return this.room.displaySystemMessages!;
    }

    public addCustomField(key: string, value: object): IRoomBuilder {
        if (typeof this.room.customFields !== 'object') {
            this.room.customFields = {};
        }

        this.room.customFields[key] = value;

        this.customFieldsChanged = true;

        return this;
    }

    public setCustomFields(fields: { [key: string]: object }): IRoomBuilder {
        this.room.customFields = fields;
        this.customFieldsChanged = true;

        return this;
    }

    public getCustomFields(): { [key: string]: object } {
        return this.room.customFields!;
    }

    public getUserIds(): Array<string> {
        return this.room.userIds!;
    }

    public getRoom(): IRoom {
        return this.room;
    }

    public getChanges() {
        const changes: Partial<IRoom> = structuredClone(this.changes);

        if (this.customFieldsChanged) {
            changes.customFields = structuredClone(this.room.customFields);
        }

        return changes;
    }
}