Implement broadcast message preview (#9762)

src/voice-broadcast/index.ts

@@ -19,8 +19,7 @@ limitations under the License.
  * {@link https://github.com/vector-im/element-meta/discussions/632}
  */
 
-import { RelationType } from "matrix-js-sdk/src/matrix";
-
+export * from "./types";
 export * from "./models/VoiceBroadcastPlayback";
 export * from "./models/VoiceBroadcastPreRecording";
 export * from "./models/VoiceBroadcastRecording";
@@ -55,27 +54,5 @@ export * from "./utils/shouldDisplayAsVoiceBroadcastTile";
 export * from "./utils/shouldDisplayAsVoiceBroadcastStoppedText";
 export * from "./utils/startNewVoiceBroadcastRecording";
 export * from "./utils/textForVoiceBroadcastStoppedEvent";
+export * from "./utils/textForVoiceBroadcastStoppedEventWithoutLink";
 export * from "./utils/VoiceBroadcastResumer";
-
-export const VoiceBroadcastInfoEventType = "io.element.voice_broadcast_info";
-export const VoiceBroadcastChunkEventType = "io.element.voice_broadcast_chunk";
-
-export type VoiceBroadcastLiveness = "live" | "not-live" | "grey";
-
-export enum VoiceBroadcastInfoState {
-    Started = "started",
-    Paused = "paused",
-    Resumed = "resumed",
-    Stopped = "stopped",
-}
-
-export interface VoiceBroadcastInfoEventContent {
-    device_id: string;
-    state: VoiceBroadcastInfoState;
-    chunk_length?: number;
-    last_chunk_sequence?: number;
-    ["m.relates_to"]?: {
-        rel_type: RelationType;
-        event_id: string;
-    };
-}

src/voice-broadcast/types.ts

@@ -0,0 +1,40 @@
+/*
+Copyright 2022 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { RelationType } from "matrix-js-sdk/src/matrix";
+
+export const VoiceBroadcastInfoEventType = "io.element.voice_broadcast_info";
+export const VoiceBroadcastChunkEventType = "io.element.voice_broadcast_chunk";
+
+export type VoiceBroadcastLiveness = "live" | "not-live" | "grey";
+
+export enum VoiceBroadcastInfoState {
+    Started = "started",
+    Paused = "paused",
+    Resumed = "resumed",
+    Stopped = "stopped",
+}
+
+export interface VoiceBroadcastInfoEventContent {
+    device_id: string;
+    state: VoiceBroadcastInfoState;
+    chunk_length?: number;
+    last_chunk_sequence?: number;
+    ["m.relates_to"]?: {
+        rel_type: RelationType;
+        event_id: string;
+    };
+}

src/voice-broadcast/utils/textForVoiceBroadcastStoppedEvent.tsx

@@ -20,8 +20,8 @@ import { MatrixEvent } from "matrix-js-sdk/src/matrix";
 import { MatrixClientPeg } from "../../MatrixClientPeg";
 import AccessibleButton from "../../components/views/elements/AccessibleButton";
 import { highlightEvent } from "../../utils/EventUtils";
-import { getSenderName } from "../../TextForEvent";
 import { _t } from "../../languageHandler";
+import { getSenderName } from "../../utils/event/getSenderName";
 
 export const textForVoiceBroadcastStoppedEvent = (event: MatrixEvent): (() => ReactNode) => {
     return (): ReactNode => {

src/voice-broadcast/utils/textForVoiceBroadcastStoppedEventWithoutLink.ts

@@ -0,0 +1,31 @@
+/*
+Copyright 2022 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { MatrixEvent } from "matrix-js-sdk/src/matrix";
+
+import { _t } from "../../languageHandler";
+import { MatrixClientPeg } from "../../MatrixClientPeg";
+import { getSenderName } from "../../utils/event/getSenderName";
+
+export const textForVoiceBroadcastStoppedEventWithoutLink = (event: MatrixEvent): string => {
+    const ownUserId = MatrixClientPeg.get()?.getUserId();
+
+    if (ownUserId && ownUserId === event.getSender()) {
+        return _t("You ended a voice broadcast", {});
+    }
+
+    return _t("%(senderName)s ended a voice broadcast", { senderName: getSenderName(event) });
+};