From b5dcb6d53fc59154bf0d2f64c2459fc292d09f82 Mon Sep 17 00:00:00 2001 From: Pierre Lehnen <55164754+pierre-lehnen-rc@users.noreply.github.com> Date: Wed, 17 Jul 2024 11:55:22 -0300 Subject: [PATCH] feat: VideoConf Persistent Chat (#783) --- .../builders/VideoConferenceBuilder.ts | 12 ++++++++- .../extenders/VideoConferenceExtend.ts | 6 +++++ ...erenceBuilder.IVideoConferenceBuilder.html | 27 ++++++++++++++++++- ...erenceExtend.IVideoConferenceExtender.html | 15 +++++++++++ ...IVideoConfProvider.IVideoConfProvider.html | 18 +++++++------ ...ideoConference.IDirectVideoConference.html | 12 +++++++-- ...VideoConference.IGroupVideoConference.html | 16 ++++++++--- ...eoConference.ILivechatVideoConference.html | 12 +++++++-- ...ces_IVideoConference.IVideoConference.html | 7 +++++ ...Providers_VideoConfData.VideoConfData.html | 2 +- ...s_VideoConfData.VideoConfDataExtended.html | 2 +- ...AppVideoConference.AppVideoConference.html | 2 +- ...nces_IVideoConference.VideoConference.html | 2 +- .../accessors/IVideoConferenceBuilder.ts | 4 +++ .../accessors/IVideoConferenceExtend.ts | 2 ++ .../videoConfProviders/IVideoConfProvider.ts | 2 ++ .../videoConfProviders/VideoConfData.ts | 4 ++- .../videoConferences/AppVideoConference.ts | 2 +- .../videoConferences/IVideoConference.ts | 1 + .../accessors/VideoConferenceBuilder.ts | 10 +++++++ src/server/accessors/VideoConferenceExtend.ts | 6 +++++ .../accessors/VideoConferenceBuilder.spec.ts | 12 +++++++++ .../accessors/VideoConferenceExtend.spec.ts | 10 +++++++ 23 files changed, 162 insertions(+), 24 deletions(-) diff --git a/deno-runtime/lib/accessors/builders/VideoConferenceBuilder.ts b/deno-runtime/lib/accessors/builders/VideoConferenceBuilder.ts index f29c62504..e617cdddf 100644 --- a/deno-runtime/lib/accessors/builders/VideoConferenceBuilder.ts +++ b/deno-runtime/lib/accessors/builders/VideoConferenceBuilder.ts @@ -9,7 +9,7 @@ const { RocketChatAssociationModel } = require('@rocket.chat/apps-engine/definit RocketChatAssociationModel: typeof _RocketChatAssociationModel; }; -export type AppVideoConference = Pick & { +export type AppVideoConference = Pick & { createdBy: IGroupVideoConference['createdBy']['_id']; }; @@ -28,6 +28,7 @@ export class VideoConferenceBuilder implements IVideoConferenceBuilder { createdBy: data.createdBy, providerName: data.providerName!, title: data.title!, + discussionRid: data.discussionRid, }; return this; @@ -78,6 +79,15 @@ export class VideoConferenceBuilder implements IVideoConferenceBuilder { return this.call.title; } + public setDiscussionRid(rid: AppVideoConference['discussionRid']): IVideoConferenceBuilder { + this.call.discussionRid = rid; + return this; + } + + public getDiscussionRid(): AppVideoConference['discussionRid'] { + return this.call.discussionRid; + } + public getVideoConference(): AppVideoConference { return this.call; } diff --git a/deno-runtime/lib/accessors/extenders/VideoConferenceExtend.ts b/deno-runtime/lib/accessors/extenders/VideoConferenceExtend.ts index ff7265ce7..9616bf619 100644 --- a/deno-runtime/lib/accessors/extenders/VideoConferenceExtend.ts +++ b/deno-runtime/lib/accessors/extenders/VideoConferenceExtend.ts @@ -57,6 +57,12 @@ export class VideoConferenceExtender implements IVideoConferenceExtender { return this; } + public setDiscussionRid(rid: VideoConference['discussionRid']): IVideoConferenceExtender { + this.videoConference.discussionRid = rid; + + return this; + } + public getVideoConference(): VideoConference { return structuredClone(this.videoConference); } diff --git a/docs/interfaces/accessors_IVideoConferenceBuilder.IVideoConferenceBuilder.html b/docs/interfaces/accessors_IVideoConferenceBuilder.IVideoConferenceBuilder.html index 0440dc9fb..a131b64fe 100644 --- a/docs/interfaces/accessors_IVideoConferenceBuilder.IVideoConferenceBuilder.html +++ b/docs/interfaces/accessors_IVideoConferenceBuilder.IVideoConferenceBuilder.html @@ -34,6 +34,7 @@

Properties

Methods

getCreatedBy +getDiscussionRid getProviderData getProviderName getRoomId @@ -41,6 +42,7 @@

Methods

getVideoConference setCreatedBy setData +setDiscussionRid setProviderData setProviderName setRoomId @@ -63,6 +65,14 @@

getCreatedByReturns string

+
+

getDiscussionRid

+

getProviderData

+
  • Defined in src/definition/accessors/IVideoConferenceBuilder.ts:33

    • setCreatedBy

    +
    +

    setDiscussionRid

    +

    setProviderData

    +
    +

    setDiscussionRid

    +

    setEndedAt

    @@ -145,6 +159,7 @@

    kind
  • addUser
  • getVideoConference
    • +
  • setDiscussionRid
  • setEndedAt
  • setEndedBy
  • setProviderData
    • diff --git a/docs/interfaces/videoConfProviders_IVideoConfProvider.IVideoConfProvider.html b/docs/interfaces/videoConfProviders_IVideoConfProvider.IVideoConfProvider.html index c879c0fa8..e7762c464 100644 --- a/docs/interfaces/videoConfProviders_IVideoConfProvider.IVideoConfProvider.html +++ b/docs/interfaces/videoConfProviders_IVideoConfProvider.IVideoConfProvider.html @@ -50,7 +50,7 @@

    Methods

    Properties

    Optional capabilities

    -
    capabilities?: {
        cam?: boolean;
        mic?: boolean;
        title?: boolean;
    }
    +
    capabilities?: {
        cam?: boolean;
        mic?: boolean;
        persistentChat?: boolean;
        title?: boolean;
    }

    Type declaration

      @@ -59,6 +59,8 @@
      Optional
      Optional mic?: boolean
    • +
      Optional persistentChat?: boolean
      • +
    • Optional title?: boolean
    @@ -96,7 +98,7 @@
    persis: Returns Promise<string>
    +
  • Defined in src/definition/videoConfProviders/IVideoConfProvider.ts:54

    • generateUrl

    +
  • Defined in src/definition/videoConfProviders/IVideoConfProvider.ts:50

    • Optional getVideoConferenceInfo

    Returns Promise<IBlock[]>

    +
  • Defined in src/definition/videoConfProviders/IVideoConfProvider.ts:38

    • Optional isFullyConfigured

    Returns Promise<boolean>

    +
  • Defined in src/definition/videoConfProviders/IVideoConfProvider.ts:26

    • Optional onNewVideoConference

    Returns Promise<void>

    +
  • Defined in src/definition/videoConfProviders/IVideoConfProvider.ts:29

    • Optional onUserJoin

    Returns Promise<void>

    +
  • Defined in src/definition/videoConfProviders/IVideoConfProvider.ts:35

    • Optional onVideoConferenceChanged

    Returns Promise<void>

    +
  • Defined in src/definition/videoConfProviders/IVideoConfProvider.ts:32
    • diff --git a/docs/interfaces/videoConferences_IVideoConference.IDirectVideoConference.html b/docs/interfaces/videoConferences_IVideoConference.IDirectVideoConference.html index 5ea883db7..828e27480 100644 --- a/docs/interfaces/videoConferences_IVideoConference.IDirectVideoConference.html +++ b/docs/interfaces/videoConferences_IVideoConference.IDirectVideoConference.html @@ -23,7 +23,7 @@

    Hierarchy

    • IDirectVideoConference
    +
  • Defined in src/definition/videoConferences/IVideoConference.ts:42
    • @@ -35,6 +35,7 @@

    Properties

    _updatedAt createdAt createdBy +discussionRid? endedAt? endedBy? messages @@ -73,6 +74,12 @@

    createdByInherited from IVideoConference.createdBy

    +
    +

    Optional discussionRid

    +
    discussionRid?: string

    Optional endedAt

    endedAt?: Date
    +
  • Defined in src/definition/videoConferences/IVideoConference.ts:43

    • Optional url

    url?: string
    +
  • Defined in src/definition/videoConferences/IVideoConference.ts:46
    • @@ -36,6 +36,7 @@

    Properties

    anonymousUsers createdAt createdBy +discussionRid? endedAt? endedBy? messages @@ -67,7 +68,7 @@

    _updatedAtanonymousUsers

    anonymousUsers: number
    +
  • Defined in src/definition/videoConferences/IVideoConference.ts:48

    • createdAt

    createdAt: Date
    +
    +

    Optional discussionRid

    +
    discussionRid?: string

    Optional endedAt

    endedAt?: Date
    +
  • Defined in src/definition/videoConferences/IVideoConference.ts:49

    • type

    type: "videoconference"
    +
  • Defined in src/definition/videoConferences/IVideoConference.ts:47

    • Optional url

    url?: string
    +
  • Defined in src/definition/videoConferences/IVideoConference.ts:52
    • @@ -35,6 +35,7 @@

    Properties

    _updatedAt createdAt createdBy +discussionRid? endedAt? endedBy? messages @@ -73,6 +74,12 @@

    createdByInherited from IVideoConference.createdBy

    +
    +

    Optional discussionRid

    +
    discussionRid?: string

    Optional endedAt

    endedAt?: Date
    +
  • Defined in src/definition/videoConferences/IVideoConference.ts:53

    • Optional url

    url?: string
    +
    +

    Optional discussionRid

    +
    discussionRid?: string

    Optional endedAt

    endedAt?: Date
    diff --git a/docs/types/videoConferences_AppVideoConference.AppVideoConference.html b/docs/types/videoConferences_AppVideoConference.AppVideoConference.html index fc82d82a1..50fb9d267 100644 --- a/docs/types/videoConferences_AppVideoConference.AppVideoConference.html +++ b/docs/types/videoConferences_AppVideoConference.AppVideoConference.html @@ -16,7 +16,7 @@
  • videoConferences/AppVideoConference
  • AppVideoConference

    • Type alias AppVideoConference

    -
    AppVideoConference: Pick<IGroupVideoConference, "rid" | "providerName" | "providerData" | "title"> & {
        createdBy: IGroupVideoConference["createdBy"]["_id"];
    }
    +
    AppVideoConference: Pick<IGroupVideoConference, "rid" | "providerName" | "providerData" | "title" | "discussionRid"> & {
        createdBy: IGroupVideoConference["createdBy"]["_id"];
    }

    Type declaration

      diff --git a/docs/types/videoConferences_IVideoConference.VideoConference.html b/docs/types/videoConferences_IVideoConference.VideoConference.html index 4b31acecf..906a5e173 100644 --- a/docs/types/videoConferences_IVideoConference.VideoConference.html +++ b/docs/types/videoConferences_IVideoConference.VideoConference.html @@ -18,7 +18,7 @@

      Type alias VideoConference

    VideoConference: IDirectVideoConference | IGroupVideoConference | ILivechatVideoConference
    +
  • Defined in src/definition/videoConferences/IVideoConference.ts:56
    • diff --git a/src/definition/accessors/IVideoConferenceBuilder.ts b/src/definition/accessors/IVideoConferenceBuilder.ts index d49278e45..11b96da0e 100644 --- a/src/definition/accessors/IVideoConferenceBuilder.ts +++ b/src/definition/accessors/IVideoConferenceBuilder.ts @@ -26,5 +26,9 @@ export interface IVideoConferenceBuilder { getTitle(): string; + setDiscussionRid(rid: string | undefined): IVideoConferenceBuilder; + + getDiscussionRid(): string | undefined; + getVideoConference(): AppVideoConference; } diff --git a/src/definition/accessors/IVideoConferenceExtend.ts b/src/definition/accessors/IVideoConferenceExtend.ts index 5b1eab057..d9b7e5838 100644 --- a/src/definition/accessors/IVideoConferenceExtend.ts +++ b/src/definition/accessors/IVideoConferenceExtend.ts @@ -15,5 +15,7 @@ export interface IVideoConferenceExtender { addUser(userId: VideoConferenceMember['_id'], ts?: VideoConferenceMember['ts']): IVideoConferenceExtender; + setDiscussionRid(rid: VideoConference['discussionRid']): IVideoConferenceExtender; + getVideoConference(): VideoConference; } diff --git a/src/definition/videoConfProviders/IVideoConfProvider.ts b/src/definition/videoConfProviders/IVideoConfProvider.ts index 66395b960..00ca57de8 100644 --- a/src/definition/videoConfProviders/IVideoConfProvider.ts +++ b/src/definition/videoConfProviders/IVideoConfProvider.ts @@ -18,6 +18,8 @@ export interface IVideoConfProvider { cam?: boolean; // Indicates if Rocket.Chat can send a custom title for the video conferences title?: boolean; + // Indicates if the provider supports Rocket.Chat's Persistent Chat feature on its conferences. + persistentChat?: boolean; }; // Optional function that can be used to determine if the provider is ready to use or still needs to be configured diff --git a/src/definition/videoConfProviders/VideoConfData.ts b/src/definition/videoConfProviders/VideoConfData.ts index 1ab46e3ae..dc6f2cc6d 100644 --- a/src/definition/videoConfProviders/VideoConfData.ts +++ b/src/definition/videoConfProviders/VideoConfData.ts @@ -1,5 +1,7 @@ import type { IGroupVideoConference, IVideoConference } from '../videoConferences/IVideoConference'; -export type VideoConfData = Pick & { title?: IGroupVideoConference['title'] }; +export type VideoConfData = Pick & { + title?: IGroupVideoConference['title']; +}; export type VideoConfDataExtended = VideoConfData & Required>; diff --git a/src/definition/videoConferences/AppVideoConference.ts b/src/definition/videoConferences/AppVideoConference.ts index 92c3f97c5..86640e000 100644 --- a/src/definition/videoConferences/AppVideoConference.ts +++ b/src/definition/videoConferences/AppVideoConference.ts @@ -1,6 +1,6 @@ import type { IGroupVideoConference } from './IVideoConference'; // Type for video conferences being created by an app -export type AppVideoConference = Pick & { +export type AppVideoConference = Pick & { createdBy: IGroupVideoConference['createdBy']['_id']; }; diff --git a/src/definition/videoConferences/IVideoConference.ts b/src/definition/videoConferences/IVideoConference.ts index 106bddc68..6f0286ae2 100644 --- a/src/definition/videoConferences/IVideoConference.ts +++ b/src/definition/videoConferences/IVideoConference.ts @@ -36,6 +36,7 @@ export interface IVideoConference { providerData?: Record; ringing?: boolean; + discussionRid?: string; } export interface IDirectVideoConference extends IVideoConference { diff --git a/src/server/accessors/VideoConferenceBuilder.ts b/src/server/accessors/VideoConferenceBuilder.ts index a0a474143..bd12028b7 100644 --- a/src/server/accessors/VideoConferenceBuilder.ts +++ b/src/server/accessors/VideoConferenceBuilder.ts @@ -17,6 +17,7 @@ export class VideoConferenceBuilder implements IVideoConferenceBuilder { createdBy: data.createdBy, providerName: data.providerName, title: data.title, + discussionRid: data.discussionRid, }; return this; @@ -67,6 +68,15 @@ export class VideoConferenceBuilder implements IVideoConferenceBuilder { return this.call.title; } + public setDiscussionRid(rid: AppVideoConference['discussionRid']): IVideoConferenceBuilder { + this.call.discussionRid = rid; + return this; + } + + public getDiscussionRid(): AppVideoConference['discussionRid'] { + return this.call.discussionRid; + } + public getVideoConference(): AppVideoConference { return this.call; } diff --git a/src/server/accessors/VideoConferenceExtend.ts b/src/server/accessors/VideoConferenceExtend.ts index 4afe4d2d0..fd3692614 100644 --- a/src/server/accessors/VideoConferenceExtend.ts +++ b/src/server/accessors/VideoConferenceExtend.ts @@ -52,6 +52,12 @@ export class VideoConferenceExtender implements IVideoConferenceExtender { return this; } + public setDiscussionRid(rid: VideoConference['discussionRid']): IVideoConferenceExtender { + this.videoConference.discussionRid = rid; + + return this; + } + public getVideoConference(): VideoConference { return Utilities.deepClone(this.videoConference); } diff --git a/tests/server/accessors/VideoConferenceBuilder.spec.ts b/tests/server/accessors/VideoConferenceBuilder.spec.ts index 5905338f5..bda462938 100644 --- a/tests/server/accessors/VideoConferenceBuilder.spec.ts +++ b/tests/server/accessors/VideoConferenceBuilder.spec.ts @@ -79,6 +79,18 @@ export class VideoConferenceBuilderAccessorTestFixture { Expect(builder.getVideoConference()).toBe(call); } + @Test() + public setDiscussionRid() { + const call = {} as AppVideoConference; + const builder = new VideoConferenceBuilder(call); + + Expect(builder.setDiscussionRid('testId')).toBe(builder); + Expect(call.discussionRid).toBe('testId'); + Expect(builder.getDiscussionRid()).toBe('testId'); + + Expect(builder.getVideoConference()).toBe(call); + } + @Test() public initialData() { const call = { providerName: 'test' } as AppVideoConference; diff --git a/tests/server/accessors/VideoConferenceExtend.spec.ts b/tests/server/accessors/VideoConferenceExtend.spec.ts index 2d8a656c4..d65411e74 100644 --- a/tests/server/accessors/VideoConferenceExtend.spec.ts +++ b/tests/server/accessors/VideoConferenceExtend.spec.ts @@ -58,6 +58,16 @@ export class VideoConferenceExtendAccessorTestFixture { Expect(call.endedAt).toBe(date); } + @Test() + public setDiscussionRid() { + const call = {} as VideoConference; + const extend = new VideoConferenceExtender(call); + + Expect(call.discussionRid).not.toBeDefined(); + Expect(extend.setDiscussionRid('testId')).toBe(extend); + Expect(call.discussionRid).toBe('testId'); + } + @Test() public addUser() { const call = { users: [] } as VideoConference;