@applicaster/zapp-react-native-ui-components 16.0.0-rc.99 → 17.0.0-alpha.1102403272

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (112) hide show
  1. package/Components/AudioPlayer/index.web.tsx +10 -0
  2. package/Components/Cell/PlatformCellComponent.ts +9 -0
  3. package/Components/Cell/PlatformCellComponent.web.ts +3 -0
  4. package/Components/Cell/index.js +2 -9
  5. package/Components/CellRendererResolver/index.ts +22 -3
  6. package/Components/ComponentResolver/ComponentResolver.ts +6 -2
  7. package/Components/ComponentResolver/__tests__/componentResolver.test.js +13 -5
  8. package/Components/ContentScreen/index.js +2 -2
  9. package/Components/Focusable/index.web.tsx +3 -0
  10. package/Components/FocusableList/hooks/useCheckItemIdsForUnique.ts +2 -7
  11. package/Components/GeneralContentScreen/GeneralContentScreen.tsx +1 -1
  12. package/Components/GeneralContentScreen/hookAdapter/logger.ts +1 -1
  13. package/Components/GeneralContentScreen/utils/__tests__/useCurationAPI.test.js +158 -1
  14. package/Components/GeneralContentScreen/utils/index.ts +2 -2
  15. package/Components/GeneralContentScreen/utils/logger.ts +3 -4
  16. package/Components/GeneralContentScreen/utils/useCurationAPI.ts +32 -10
  17. package/Components/HandlePlayable/utils.ts +2 -7
  18. package/Components/HookRenderer/HookRenderer.tsx +2 -2
  19. package/Components/MasterCell/DefaultComponents/ActionButton.tsx +42 -4
  20. package/Components/MasterCell/DefaultComponents/ButtonContainerView/index.android.tv.tsx +7 -4
  21. package/Components/MasterCell/DefaultComponents/ButtonContainerView/types.ts +1 -0
  22. package/Components/MasterCell/DefaultComponents/FocusableView/index.android.tsx +10 -4
  23. package/Components/MasterCell/DefaultComponents/Image/hoc/utils/__tests__/withDimensions.test.ts +1 -1
  24. package/Components/MasterCell/DefaultComponents/Image/hoc/utils/index.ts +2 -4
  25. package/Components/MasterCell/DefaultComponents/Image/hooks/checkTooBigImageSize.ts +2 -7
  26. package/Components/MasterCell/DefaultComponents/Image/index.web.ts +7 -0
  27. package/Components/MasterCell/DefaultComponents/LiveImage/__tests__/prepareEntry.test.ts +30 -0
  28. package/Components/MasterCell/DefaultComponents/LiveImage/index.tsx +34 -7
  29. package/Components/MasterCell/DefaultComponents/PressableView.tsx +3 -0
  30. package/Components/MasterCell/DefaultComponents/Text/hooks/useText.ts +2 -7
  31. package/Components/MasterCell/DefaultComponents/__tests__/ActionButton.missingPlugin.test.tsx +66 -0
  32. package/Components/MasterCell/DefaultComponents/__tests__/ActionButton.test.tsx +288 -0
  33. package/Components/MasterCell/DefaultComponents/mobile/MobileActionButtons/ActionButton.tsx +2 -1
  34. package/Components/MasterCell/DefaultComponents/mobile/MobileActionButtons/__tests__/PressableView.test.tsx +4 -2
  35. package/Components/MasterCell/SharedUI/CollapsibleTextContainer/__tests__/factory.test.ts +2 -2
  36. package/Components/MasterCell/SharedUI/CollapsibleTextContainer/index.ts +2 -1
  37. package/Components/MasterCell/__tests__/masterCell.test.js +116 -0
  38. package/Components/MasterCell/index.tsx +45 -6
  39. package/Components/MasterCell/logger.ts +2 -2
  40. package/Components/MasterCell/utils/__tests__/getFocusableElementId.test.ts +38 -0
  41. package/Components/MasterCell/utils/__tests__/useIsCellSelected.test.ts +91 -0
  42. package/Components/MasterCell/utils/__tests__/withoutFocusedState.test.js +20 -0
  43. package/Components/MasterCell/utils/behaviorProvider.ts +57 -38
  44. package/Components/MasterCell/utils/index.ts +60 -19
  45. package/Components/ModalComponent/ActionsBottomSheet/openActionsBottomSheet.ts +1 -1
  46. package/Components/ModalComponent/AudioPlayer/Components/Button.tsx +7 -3
  47. package/Components/ModalComponent/AudioPlayer/Components/Item.tsx +22 -1
  48. package/Components/ModalComponent/AudioPlayer/Components/__tests__/Item.test.tsx +52 -1
  49. package/Components/ModalComponent/AudioPlayer/utils/__tests__/mergeStyles.test.ts +77 -0
  50. package/Components/ModalComponent/AudioPlayer/utils/mergeStyles.ts +58 -16
  51. package/Components/ModalComponent/BottomSheetDragArea.web.tsx +15 -0
  52. package/Components/ModalComponent/BottomSheetModalContent.tsx +51 -82
  53. package/Components/ModalComponent/Button/index.tsx +3 -1
  54. package/Components/ModalComponent/SortableList.tsx +2 -3
  55. package/Components/ModalComponent/__tests__/BottomSheetDragArea.test.tsx +30 -0
  56. package/Components/ModalComponent/__tests__/BottomSheetModalContent.test.tsx +237 -17
  57. package/Components/ModalComponent/__tests__/showTextInput.test.ts +25 -0
  58. package/Components/ModalComponent/presets/__tests__/getCell.test.ts +29 -2
  59. package/Components/ModalComponent/presets/index.ts +2 -3
  60. package/Components/ModalComponent/showTextInput.ts +2 -0
  61. package/Components/OfflineHandler/__tests__/index.test.tsx +136 -0
  62. package/Components/OfflineHandler/index.tsx +45 -6
  63. package/Components/PlayerContainer/PlayerContainer.tsx +30 -6
  64. package/Components/PlayerContainer/__tests__/PlayerContainer.test.tsx +51 -0
  65. package/Components/PlayerContainer/logger.ts +9 -5
  66. package/Components/River/ComponentsMap/ComponentsMap.tsx +4 -1
  67. package/Components/River/ComponentsMap/index.web.tsx +3 -0
  68. package/Components/River/RiverItem.tsx +4 -0
  69. package/Components/River/TV/River.tsx +7 -1
  70. package/Components/River/__tests__/__snapshots__/componentsMap.test.js.snap +2 -0
  71. package/Components/ScreenFeedLoader/ScreenFeedLoader.tsx +2 -2
  72. package/Components/ScreenResolver/index.tsx +6 -4
  73. package/Components/Tabs/TV/index.web.tsx +5 -0
  74. package/Components/TopCutoffOverlay/__tests__/TopCutoffOverlay.test.tsx +56 -10
  75. package/Components/TopCutoffOverlay/index.tsx +41 -10
  76. package/Components/Transitioner/AnimationManager.js +1 -1
  77. package/Components/Transitioner/Scene.tsx +4 -3
  78. package/Components/Transitioner/Transitioner.tsx +71 -33
  79. package/Components/Transitioner/__tests__/transitioner.test.js +372 -3
  80. package/Components/VideoLive/LiveImageManager.ts +126 -12
  81. package/Components/VideoLive/MuteUnmuteController.ts +135 -0
  82. package/Components/VideoLive/PlayerLiveImageComponent.tsx +15 -19
  83. package/Components/VideoLive/__tests__/LiveImageManager.test.ts +30 -0
  84. package/Components/VideoLive/__tests__/LiveImageMuteState.test.ts +311 -0
  85. package/Components/VideoLive/__tests__/MuteUnmuteController.test.ts +135 -0
  86. package/Components/VideoLive/__tests__/PlayerLiveImageComponent.test.tsx +63 -1
  87. package/Components/VideoLive/loggerHelper.ts +2 -2
  88. package/Components/VideoModal/PlayerDetails.tsx +27 -2
  89. package/Components/VideoModal/PlayerWrapper.tsx +9 -2
  90. package/Components/VideoModal/__tests__/PlayerDetails.test.tsx +84 -0
  91. package/Components/VideoModal/__tests__/PlayerWrapper.test.tsx +1 -0
  92. package/Components/VideoModal/__tests__/playerWrapperStyle.test.ts +263 -0
  93. package/Components/VideoModal/__tests__/playerWrapperUtils.test.ts +125 -0
  94. package/Components/VideoModal/hooks/useModalSize.ts +2 -7
  95. package/Components/VideoModal/playerWrapperStyle.ts +62 -23
  96. package/Components/VideoModal/playerWrapperUtils.ts +141 -1
  97. package/Components/__tests__/webVariants.test.js +73 -0
  98. package/Components/default-cell-renderer/containerStyles/index.web.ts +6 -0
  99. package/Components/default-cell-renderer/viewTrees/index.web.ts +10 -0
  100. package/Contexts/ZappPipesContext/ZappPipesContextFactory.tsx +3 -5
  101. package/Decorators/RiverResolver/__tests__/riverResolver.missingRiver.test.tsx +52 -0
  102. package/Decorators/RiverResolver/index.tsx +25 -0
  103. package/Decorators/ZappPipesDataConnector/__tests__/UrlFeedResolver.test.tsx +4 -3
  104. package/Decorators/ZappPipesDataConnector/__tests__/screenToolbox.test.ts +347 -0
  105. package/Decorators/ZappPipesDataConnector/__tests__/screenToolboxUnavailable.test.ts +53 -0
  106. package/Decorators/ZappPipesDataConnector/index.tsx +19 -4
  107. package/Decorators/ZappPipesDataConnector/resolvers/UrlFeedResolver.tsx +2 -21
  108. package/Decorators/ZappPipesDataConnector/screenToolbox.ts +384 -0
  109. package/Decorators/ZappPipesDataConnector/utils/mongoFilter.ts +1 -1
  110. package/Decorators/ZappPipesDataConnector/utils/useFilter.tsx +1 -1
  111. package/Helpers/logger.js +2 -2
  112. package/package.json +5 -5
@@ -1,8 +1,15 @@
1
1
  import React from "react";
2
- import { Text, View } from "react-native";
2
+ import { Animated, Text, View } from "react-native";
3
+ import { v4 as uuidV4 } from "uuid";
3
4
 
4
- import { TransitionerComponent } from "../Transitioner";
5
- import { render } from "@testing-library/react-native";
5
+ import { AnimationManager } from "../AnimationManager";
6
+ import {
7
+ NAV_ACTION_BACK,
8
+ NAV_ACTION_PUSH,
9
+ NAV_ACTION_REPLACE,
10
+ TransitionerComponent,
11
+ } from "../Transitioner";
12
+ import { act, render } from "@testing-library/react-native";
6
13
 
7
14
  jest.mock("../Scene", () => {
8
15
  const View = jest.requireActual("react-native").View;
@@ -40,6 +47,47 @@ const transitionerComponentProps = {
40
47
 
41
48
  jest.mock("uuid");
42
49
 
50
+ const sceneTransitionConfig = () => ({
51
+ push: {
52
+ duration: 0,
53
+ easing: jest.fn(),
54
+ from: { style: {} },
55
+ to: { style: {} },
56
+ },
57
+ back: {
58
+ duration: 0,
59
+ easing: jest.fn(),
60
+ from: { style: {} },
61
+ to: { style: {} },
62
+ },
63
+ });
64
+
65
+ const sceneFor = (route) => (
66
+ <View pathname={route}>
67
+ <Text>{route}</Text>
68
+ </View>
69
+ );
70
+
71
+ const root = "/river/root";
72
+ const child = `${root}/river/child`;
73
+ const grandchild = `${child}/river/grandchild`;
74
+
75
+ const propsFor = (route, previousAction, children = sceneFor(route)) => ({
76
+ navigator: {
77
+ previousAction,
78
+ currentRoute: route,
79
+ screenData: {},
80
+ },
81
+ transitionConfig: sceneTransitionConfig,
82
+ layoutData: {
83
+ isTablet: false,
84
+ isTabletPortrait: false,
85
+ },
86
+ children,
87
+ });
88
+
89
+ const sceneKeys = (ref) => ref.current.state.scenes.map((scene) => scene.key);
90
+
43
91
  describe("<TransitionerComponent />", () => {
44
92
  it("renders correctly", () => {
45
93
  const wrapper = render(
@@ -50,4 +98,325 @@ describe("<TransitionerComponent />", () => {
50
98
 
51
99
  expect(wrapper.toJSON()).toMatchSnapshot();
52
100
  });
101
+
102
+ it("removes both intermediate scenes when backing out to the tab root", () => {
103
+ jest
104
+ .spyOn(AnimationManager.prototype, "animate")
105
+ .mockImplementation((_, done) => done());
106
+
107
+ const ref = React.createRef();
108
+
109
+ const { rerender } = render(
110
+ <TransitionerComponent
111
+ ref={ref}
112
+ {...propsFor(root, NAV_ACTION_REPLACE)}
113
+ />
114
+ );
115
+
116
+ act(() => {
117
+ rerender(
118
+ <TransitionerComponent
119
+ ref={ref}
120
+ {...propsFor(child, NAV_ACTION_PUSH)}
121
+ />
122
+ );
123
+ });
124
+
125
+ act(() => {
126
+ rerender(
127
+ <TransitionerComponent
128
+ ref={ref}
129
+ {...propsFor(grandchild, NAV_ACTION_PUSH)}
130
+ />
131
+ );
132
+ });
133
+
134
+ act(() => {
135
+ rerender(
136
+ <TransitionerComponent ref={ref} {...propsFor(root, NAV_ACTION_BACK)} />
137
+ );
138
+ });
139
+
140
+ expect(sceneKeys(ref)).toEqual([root]);
141
+ });
142
+
143
+ describe("with interruptible animations", () => {
144
+ // End callback of the animation that is currently "running"
145
+ let runningAnimationEnd = null;
146
+
147
+ const finishAnimation = () => {
148
+ act(() => {
149
+ const done = runningAnimationEnd;
150
+ runningAnimationEnd = null;
151
+ done?.();
152
+ });
153
+ };
154
+
155
+ const mountTransitioner = ({
156
+ initialRoute = root,
157
+ renderScene = sceneFor,
158
+ } = {}) => {
159
+ const ref = React.createRef();
160
+
161
+ const transitioner = (route, action) => (
162
+ <TransitionerComponent
163
+ ref={ref}
164
+ {...propsFor(route, action, renderScene(route))}
165
+ />
166
+ );
167
+
168
+ const { rerender } = render(
169
+ transitioner(initialRoute, NAV_ACTION_REPLACE)
170
+ );
171
+
172
+ const navigate = (route, action) => {
173
+ act(() => {
174
+ rerender(transitioner(route, action));
175
+ });
176
+ };
177
+
178
+ return { ref, navigate };
179
+ };
180
+
181
+ beforeEach(() => {
182
+ let sceneCount = 0;
183
+ uuidV4.mockImplementation(() => `scene-${++sceneCount}`);
184
+
185
+ jest
186
+ .spyOn(AnimationManager.prototype, "animate")
187
+ .mockImplementation((_, done) => {
188
+ runningAnimationEnd = done;
189
+ });
190
+
191
+ const setValue = Animated.Value.prototype.setValue;
192
+
193
+ // RN 0.77: setValue() stops the running animation, which calls
194
+ // its end callback synchronously with { finished: false }
195
+ jest
196
+ .spyOn(Animated.Value.prototype, "setValue")
197
+ .mockImplementation(function (value) {
198
+ const interrupted = runningAnimationEnd;
199
+ runningAnimationEnd = null;
200
+ interrupted?.();
201
+
202
+ return setValue.call(this, value);
203
+ });
204
+ });
205
+
206
+ afterEach(() => {
207
+ runningAnimationEnd = null;
208
+ jest.restoreAllMocks();
209
+ uuidV4.mockReset();
210
+ });
211
+
212
+ it("drops interrupted scenes when going back twice during a back animation", () => {
213
+ const { ref, navigate } = mountTransitioner();
214
+
215
+ navigate(child, NAV_ACTION_PUSH);
216
+ finishAnimation();
217
+ navigate(grandchild, NAV_ACTION_PUSH);
218
+ finishAnimation();
219
+
220
+ navigate(child, NAV_ACTION_BACK);
221
+ navigate(root, NAV_ACTION_BACK);
222
+
223
+ expect(ref.current.state.animating).toBe(true);
224
+
225
+ finishAnimation();
226
+
227
+ expect(sceneKeys(ref)).toEqual([root]);
228
+ expect(ref.current.state.animating).toBe(false);
229
+ });
230
+
231
+ it("remounts the screen when revisiting it after a quick double back", () => {
232
+ const mounts = {};
233
+
234
+ const MountProbe = ({ pathname }) => {
235
+ React.useEffect(() => {
236
+ mounts[pathname] = (mounts[pathname] || 0) + 1;
237
+ }, [pathname]);
238
+
239
+ return <Text>{pathname}</Text>;
240
+ };
241
+
242
+ const { ref, navigate } = mountTransitioner({
243
+ renderScene: (route) => <MountProbe pathname={route} />,
244
+ });
245
+
246
+ navigate(child, NAV_ACTION_PUSH);
247
+ finishAnimation();
248
+
249
+ const originalChildId = ref.current.state.scenes[1].screenUniqueId;
250
+
251
+ navigate(grandchild, NAV_ACTION_PUSH);
252
+ finishAnimation();
253
+ navigate(child, NAV_ACTION_BACK);
254
+ navigate(root, NAV_ACTION_BACK);
255
+ finishAnimation();
256
+
257
+ navigate(child, NAV_ACTION_PUSH);
258
+ finishAnimation();
259
+
260
+ const { scenes, to } = ref.current.state;
261
+
262
+ expect(scenes).toHaveLength(2);
263
+ expect(to.index).toBe(1);
264
+ expect(scenes[1].screenUniqueId).not.toBe(originalChildId);
265
+ expect(mounts[child]).toBe(2);
266
+ });
267
+
268
+ it("keeps a single scene when going back from the first scene", () => {
269
+ const { ref, navigate } = mountTransitioner({ initialRoute: child });
270
+
271
+ navigate(root, NAV_ACTION_BACK);
272
+ finishAnimation();
273
+
274
+ expect(sceneKeys(ref)).toEqual([root]);
275
+ expect(ref.current.state.to.index).toBe(0);
276
+ expect(ref.current.state.animating).toBe(false);
277
+ });
278
+
279
+ it("pushes a fresh scene after a completed single back", () => {
280
+ const { ref, navigate } = mountTransitioner();
281
+
282
+ navigate(child, NAV_ACTION_PUSH);
283
+ finishAnimation();
284
+
285
+ const originalChildId = ref.current.state.scenes[1].screenUniqueId;
286
+
287
+ navigate(root, NAV_ACTION_BACK);
288
+ finishAnimation();
289
+ navigate(child, NAV_ACTION_PUSH);
290
+ finishAnimation();
291
+
292
+ const { scenes, to } = ref.current.state;
293
+
294
+ expect(sceneKeys(ref)).toEqual([root, child]);
295
+ expect(to.index).toBe(1);
296
+ expect(scenes[1].screenUniqueId).not.toBe(originalChildId);
297
+ });
298
+
299
+ it("ignores the end of a back animation that a newer back superseded", () => {
300
+ const { ref, navigate } = mountTransitioner();
301
+
302
+ navigate(child, NAV_ACTION_PUSH);
303
+ finishAnimation();
304
+ navigate(grandchild, NAV_ACTION_PUSH);
305
+ finishAnimation();
306
+
307
+ navigate(child, NAV_ACTION_BACK);
308
+
309
+ const supersededEnd = runningAnimationEnd;
310
+
311
+ // Deliver the interrupted animation's end late, after the newer one started
312
+ Animated.Value.prototype.setValue.mockImplementation(() => {});
313
+
314
+ navigate(root, NAV_ACTION_BACK);
315
+
316
+ act(() => {
317
+ supersededEnd();
318
+ });
319
+
320
+ expect(ref.current.state.animating).toBe(true);
321
+ expect(sceneKeys(ref)).toEqual([root, child, grandchild]);
322
+
323
+ finishAnimation();
324
+
325
+ expect(sceneKeys(ref)).toEqual([root]);
326
+ expect(ref.current.state.animating).toBe(false);
327
+ });
328
+
329
+ it("drops the pushed scene when going back before its push animation ends", () => {
330
+ const { ref, navigate } = mountTransitioner();
331
+
332
+ navigate(child, NAV_ACTION_PUSH);
333
+ navigate(root, NAV_ACTION_BACK);
334
+
335
+ expect(ref.current.state.animating).toBe(true);
336
+
337
+ finishAnimation();
338
+
339
+ expect(sceneKeys(ref)).toEqual([root]);
340
+ expect(ref.current.state.animating).toBe(false);
341
+ });
342
+
343
+ it("pushes right after the visible scene even when stale scenes are left behind", () => {
344
+ const { ref, navigate } = mountTransitioner();
345
+
346
+ navigate(child, NAV_ACTION_PUSH);
347
+ finishAnimation();
348
+
349
+ // Leftover past to.index, as some other path could leave behind
350
+ act(() => {
351
+ ref.current.setState(({ scenes }) => ({
352
+ scenes: [
353
+ ...scenes,
354
+ {
355
+ ...scenes[1],
356
+ key: `${root}/river/stale`,
357
+ screenUniqueId: "stale",
358
+ },
359
+ ],
360
+ }));
361
+ });
362
+
363
+ navigate(grandchild, NAV_ACTION_PUSH);
364
+ finishAnimation();
365
+
366
+ const { scenes, to } = ref.current.state;
367
+
368
+ expect(sceneKeys(ref)).toEqual([root, child, grandchild]);
369
+ expect(scenes[to.index].key).toBe(grandchild);
370
+ });
371
+
372
+ it("shows the replaced screen when going home during a back animation", () => {
373
+ const home = "/river/home";
374
+ const { ref, navigate } = mountTransitioner();
375
+
376
+ navigate(child, NAV_ACTION_PUSH);
377
+ finishAnimation();
378
+
379
+ navigate(root, NAV_ACTION_BACK);
380
+ navigate(home, NAV_ACTION_REPLACE);
381
+
382
+ const { scenes, to } = ref.current.state;
383
+
384
+ expect(scenes[to.index].key).toBe(home);
385
+
386
+ finishAnimation();
387
+
388
+ expect(sceneKeys(ref)).toEqual([home]);
389
+ expect(ref.current.state.animating).toBe(false);
390
+ });
391
+
392
+ it("shows the pushed screen when pushing during a back animation", () => {
393
+ const sibling = `${root}/river/sibling`;
394
+ const { ref, navigate } = mountTransitioner();
395
+
396
+ navigate(child, NAV_ACTION_PUSH);
397
+ finishAnimation();
398
+
399
+ navigate(root, NAV_ACTION_BACK);
400
+ navigate(sibling, NAV_ACTION_PUSH);
401
+
402
+ const { scenes, to } = ref.current.state;
403
+
404
+ expect(scenes[to.index].key).toBe(sibling);
405
+
406
+ finishAnimation();
407
+
408
+ expect(sceneKeys(ref)).not.toContain(child);
409
+ expect(ref.current.state.animating).toBe(false);
410
+ });
411
+
412
+ it("keeps both scenes when pushing during a push animation", () => {
413
+ const { ref, navigate } = mountTransitioner();
414
+
415
+ navigate(child, NAV_ACTION_PUSH);
416
+ navigate(grandchild, NAV_ACTION_PUSH);
417
+
418
+ expect(sceneKeys(ref)).toEqual([child, grandchild]);
419
+ expect(ref.current.state.to.index).toBe(1);
420
+ });
421
+ });
53
422
  });
@@ -3,7 +3,10 @@ import {
3
3
  PlayerLifecycleListener,
4
4
  playerManager,
5
5
  } from "@applicaster/zapp-react-native-utils/appUtils/playerManager";
6
- import { setUserCellPlayerMutedPreference } from "@applicaster/zapp-react-native-utils/appUtils/playerManager/userCellPlayerMutedPreference";
6
+ import {
7
+ getUserCellPlayerMutedPreference,
8
+ setUserCellPlayerMutedPreference,
9
+ } from "@applicaster/zapp-react-native-utils/appUtils/playerManager/userCellPlayerMutedPreference";
7
10
  import { playerFactory } from "@applicaster/zapp-react-native-utils/appUtils/playerManager/playerFactory";
8
11
  import { PlayerRole } from "@applicaster/zapp-react-native-utils/appUtils/playerManager/const";
9
12
  import { loggerLiveImageManager } from "./loggerHelper";
@@ -21,13 +24,15 @@ export type LiveImageManagerEvent =
21
24
  | "onEnd"
22
25
  | "onStart"
23
26
  | "onError"
24
- | "onDestroy";
27
+ | "onDestroy"
28
+ | "onRegister"
29
+ | "onPlaybackChange"
30
+ | "onMuteChange";
25
31
 
26
32
  export type LiveImageManagerListenerData = {
27
33
  id: string;
28
- listener: Record<
29
- LiveImageManagerEvent,
30
- (event?: Record<string, any>) => void
34
+ listener: Partial<
35
+ Record<LiveImageManagerEvent, (event?: Record<string, any>) => void>
31
36
  >;
32
37
  };
33
38
 
@@ -54,6 +59,7 @@ type PlayerFactoryConfig = {
54
59
  };
55
60
 
56
61
  type LiveImageProps = {
62
+ audioMutedByDefault?: boolean;
57
63
  playerId: string;
58
64
  setMode?: (type: LiveImageType) => void;
59
65
  preloadHooks?: PreloadHookConfig[];
@@ -81,9 +87,11 @@ export class LiveImageManager implements PlayerLifecycleListener {
81
87
 
82
88
  protected listeners: Record<
83
89
  string,
84
- Record<LiveImageManagerEvent, (event?: Record<string, any>) => void>
90
+ LiveImageManagerListenerData["listener"]
85
91
  > = {};
86
92
 
93
+ private mutedSubscriptions = new Map<LiveImage, () => void>();
94
+
87
95
  constructor() {
88
96
  playerManager.addLifecycleListener(this);
89
97
  this.listeners = {};
@@ -96,8 +104,25 @@ export class LiveImageManager implements PlayerLifecycleListener {
96
104
  }
97
105
 
98
106
  public register = (item: LiveImage): (() => void) => {
107
+ if (!isTV()) {
108
+ const muted = !!getUserCellPlayerMutedPreference(item.getMuted());
109
+
110
+ if (muted !== item.getMuted()) {
111
+ muted ? item.mute() : item.unmute();
112
+ }
113
+ }
114
+
99
115
  this.items.push(item);
116
+
117
+ this.mutedSubscriptions.set(
118
+ item,
119
+ item.subscribeMuted(() =>
120
+ this.invokeListenersUpdate({ callbackName: "onMuteChange" })
121
+ )
122
+ );
123
+
100
124
  log_debug(`register: live image ${item.playerId} - ${item.tag}`);
125
+ this.invokeListenersUpdate({ callbackName: "onRegister" });
101
126
 
102
127
  // TV only Start playing video once registered
103
128
  if (isTV()) {
@@ -109,6 +134,8 @@ export class LiveImageManager implements PlayerLifecycleListener {
109
134
 
110
135
  public unregister = (item: LiveImage) => {
111
136
  log_debug(`unregister: live-image ${item.playerId} - ${item.tag}`);
137
+ this.mutedSubscriptions.get(item)?.();
138
+ this.mutedSubscriptions.delete(item);
112
139
 
113
140
  if (this.currentlyPlaying === item) {
114
141
  this.currentlyPlaying = null;
@@ -172,6 +199,25 @@ export class LiveImageManager implements PlayerLifecycleListener {
172
199
  return this.currentlyPlaying;
173
200
  };
174
201
 
202
+ public getEntryMuted = (entryId: string): boolean | undefined => {
203
+ const matches = (item: LiveImage) => String(item.getEntryId()) === entryId;
204
+
205
+ const item =
206
+ this.currentlyPlaying && matches(this.currentlyPlaying)
207
+ ? this.currentlyPlaying
208
+ : this.items.find(matches);
209
+
210
+ return item?.getMuted();
211
+ };
212
+
213
+ public getPlayingCellId = (entryId: string): string | undefined => {
214
+ const item = this.currentlyPlaying;
215
+
216
+ return item && String(item.getEntryId()) === entryId && item.isPlaying()
217
+ ? item.playerId
218
+ : undefined;
219
+ };
220
+
175
221
  private findNextPlayableItem = () => {
176
222
  if (isTV()) {
177
223
  return this.items[this.items.length - 1];
@@ -302,6 +348,7 @@ export class LiveImageManager implements PlayerLifecycleListener {
302
348
  setUserCellPlayerMutedPreference(true);
303
349
 
304
350
  this.items.forEach((liveImage) => liveImage.mute());
351
+ this.invokeListenersUpdate({ callbackName: "onMuteChange" });
305
352
  };
306
353
 
307
354
  public unmuteAll = () => {
@@ -310,6 +357,7 @@ export class LiveImageManager implements PlayerLifecycleListener {
310
357
  setUserCellPlayerMutedPreference(false);
311
358
 
312
359
  this.items.forEach((liveImage) => liveImage.unmute());
360
+ this.invokeListenersUpdate({ callbackName: "onMuteChange" });
313
361
  };
314
362
 
315
363
  public onViewPositionChanged = (item: LiveImage) => {
@@ -579,20 +627,67 @@ export class LiveImage implements QuickBrickPlayer.SharedPlayerCallBacks {
579
627
  left: 0,
580
628
  };
581
629
 
582
- // Keeps muted state in sync: updates the initial value for deferred
583
- // player creation and forwards to the player if it already exists.
584
- public initiallyMuted: boolean = true;
630
+ private muted: boolean;
631
+ private mutedListeners = new Set<() => void>();
632
+ private playbackEnded = false;
633
+
634
+ getMuted = (): boolean => this.muted;
635
+
636
+ getEntryId = () => this.factoryConfig.entry.id;
637
+
638
+ isPlaying = (): boolean =>
639
+ !this.playbackEnded &&
640
+ !!this.player?.isReadyToPlay() &&
641
+ this.player.isPlaying();
642
+
643
+ subscribeMuted = (listener: () => void): (() => void) => {
644
+ this.mutedListeners.add(listener);
645
+
646
+ return () => this.mutedListeners.delete(listener);
647
+ };
648
+
649
+ private setMuted = (muted: boolean) => {
650
+ if (this.muted === muted) return;
651
+
652
+ this.muted = muted;
653
+
654
+ this.mutedListeners.forEach((listener) => {
655
+ try {
656
+ listener();
657
+ } catch (error) {
658
+ log_error(`Mute listener failed for ${this.playerId}`, { error });
659
+ }
660
+ });
661
+ };
585
662
 
586
663
  mute = () => {
587
- this.initiallyMuted = true;
664
+ this.setMuted(true);
588
665
  this.player?.mute();
589
666
  };
590
667
 
591
668
  unmute = () => {
592
- this.initiallyMuted = false;
669
+ this.setMuted(false);
593
670
  this.player?.unmute();
594
671
  };
595
672
 
673
+ onPlayerMute = () => this.setMuted(true);
674
+
675
+ onPlayerUnmute = () => this.setMuted(false);
676
+
677
+ onPlayerResume = () => {
678
+ this.playbackEnded = false;
679
+
680
+ LiveImageManager.instance.invokeListenersUpdate({
681
+ callbackName: "onPlaybackChange",
682
+ });
683
+ };
684
+
685
+ onPlayerPause = () => {
686
+ LiveImageManager.instance.invokeListenersUpdate({
687
+ callbackName: "onPlaybackChange",
688
+ });
689
+ };
690
+
596
691
  positionToString() {
597
692
  if (!this.position) {
598
693
  return "position not set";
@@ -617,6 +712,10 @@ export class LiveImage implements QuickBrickPlayer.SharedPlayerCallBacks {
617
712
  this.preloadHooks = props.preloadHooks;
618
713
  this.factoryConfig = props.factoryConfig;
619
714
  this.tag = props.tag || "untagged";
715
+
716
+ this.muted = isTV()
717
+ ? false
718
+ : !!getUserCellPlayerMutedPreference(props.audioMutedByDefault);
620
719
  }
621
720
 
622
721
  async prepareForPlayback(): Promise<boolean> {
@@ -670,7 +769,7 @@ export class LiveImage implements QuickBrickPlayer.SharedPlayerCallBacks {
670
769
  playerId: this.factoryConfig.playerId,
671
770
  autoplay: false,
672
771
  entry,
673
- muted: this.initiallyMuted,
772
+ muted: this.muted,
674
773
  playerPluginId: this.factoryConfig.playerPluginId,
675
774
  screenConfig: this.factoryConfig.screenConfig,
676
775
  playerRole: PlayerRole.Cell,
@@ -686,6 +785,11 @@ export class LiveImage implements QuickBrickPlayer.SharedPlayerCallBacks {
686
785
  this.component = factoryItem.Component;
687
786
  this.player.addListener({ id: "live-image", listener: this });
688
787
 
788
+ // A user toggle may have arrived while the async factory was pending.
789
+ if (this.player.getIsMuted() !== this.muted) {
790
+ this.muted ? this.player.mute() : this.player.unmute();
791
+ }
792
+
689
793
  return true;
690
794
  }
691
795
 
@@ -694,6 +798,8 @@ export class LiveImage implements QuickBrickPlayer.SharedPlayerCallBacks {
694
798
  };
695
799
 
696
800
  onLoad = (_event) => {
801
+ this.playbackEnded = false;
802
+
697
803
  log_info(
698
804
  `onLoad: live-image, video loaded, switching to video, ${playerInfo(
699
805
  this.player
@@ -704,6 +810,8 @@ export class LiveImage implements QuickBrickPlayer.SharedPlayerCallBacks {
704
810
  };
705
811
 
706
812
  onError = (error: Error) => {
813
+ this.playbackEnded = true;
814
+
707
815
  log_error(
708
816
  `onError: live-image, fail to play, switching back to image. error: ${
709
817
  error?.message
@@ -714,6 +822,8 @@ export class LiveImage implements QuickBrickPlayer.SharedPlayerCallBacks {
714
822
  };
715
823
 
716
824
  onVideoError = (error: Error) => {
825
+ this.playbackEnded = true;
826
+
717
827
  log_error(
718
828
  `onVideoError: live-image, fail to play, switching back to image. error: ${
719
829
  error?.message
@@ -724,6 +834,8 @@ export class LiveImage implements QuickBrickPlayer.SharedPlayerCallBacks {
724
834
  };
725
835
 
726
836
  onVideoEnd = (_event) => {
837
+ this.playbackEnded = true;
838
+
727
839
  log_info(
728
840
  `onVideoEnd: live-image, video completed, switching back to image, ${playerInfo(
729
841
  this.player
@@ -734,6 +846,8 @@ export class LiveImage implements QuickBrickPlayer.SharedPlayerCallBacks {
734
846
  };
735
847
 
736
848
  onPlayerClose = () => {
849
+ this.playbackEnded = true;
850
+
737
851
  log_info(
738
852
  `onPlayerClose: live-image, player closed, switching back to image, ${playerInfo(
739
853
  this.player