@applicaster/zapp-react-native-utils 16.0.0-alpha.3043581530 → 16.0.0-alpha.3112220329

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 (177) hide show
  1. package/actionsExecutor/ActionExecutor.ts +47 -11
  2. package/actionsExecutor/ActionExecutorContext.tsx +109 -314
  3. package/actionsExecutor/__tests__/feedDecorator.test.ts +61 -0
  4. package/actionsExecutor/actions/__tests__/dismissBottomSheet.test.ts +25 -0
  5. package/actionsExecutor/actions/__tests__/goBack.test.ts +62 -0
  6. package/actionsExecutor/actions/__tests__/goHome.test.ts +19 -0
  7. package/actionsExecutor/actions/__tests__/loadItemsFromSource.test.ts +88 -0
  8. package/actionsExecutor/actions/__tests__/navigateToScreen.test.ts +133 -0
  9. package/actionsExecutor/actions/__tests__/openBottomSheet.customContent.test.ts +76 -0
  10. package/actionsExecutor/actions/__tests__/openBottomSheet.inlineItems.test.ts +212 -0
  11. package/actionsExecutor/actions/__tests__/presentScreen.test.ts +127 -0
  12. package/actionsExecutor/actions/__tests__/showToast.test.ts +88 -0
  13. package/actionsExecutor/actions/appRestart.ts +24 -0
  14. package/actionsExecutor/actions/confirmDialog.ts +53 -0
  15. package/actionsExecutor/actions/dismissBottomSheet.ts +23 -0
  16. package/actionsExecutor/actions/goBack.ts +60 -0
  17. package/actionsExecutor/actions/goHome.ts +31 -0
  18. package/actionsExecutor/actions/index.ts +40 -0
  19. package/actionsExecutor/actions/localStorageRemove.ts +27 -0
  20. package/actionsExecutor/actions/localStorageSet.ts +28 -0
  21. package/actionsExecutor/actions/localStorageToggleFlag.ts +28 -0
  22. package/actionsExecutor/actions/navigateToScreen.ts +137 -0
  23. package/actionsExecutor/actions/openBottomSheet.ts +325 -0
  24. package/actionsExecutor/actions/presentScreen.ts +78 -0
  25. package/actionsExecutor/actions/refreshComponent.ts +85 -0
  26. package/actionsExecutor/actions/screenSetVariable.ts +35 -0
  27. package/actionsExecutor/actions/screenToggleFlag.ts +38 -0
  28. package/actionsExecutor/actions/sendCloudEvent.ts +93 -0
  29. package/actionsExecutor/actions/sessionStorageRemove.ts +19 -0
  30. package/actionsExecutor/actions/sessionStorageSet.ts +20 -0
  31. package/actionsExecutor/actions/sessionStorageToggleFlag.ts +15 -0
  32. package/actionsExecutor/actions/showToast.ts +87 -0
  33. package/actionsExecutor/actions/switchLayout.ts +40 -0
  34. package/actionsExecutor/consts.ts +26 -0
  35. package/actionsExecutor/feedDecorator.ts +6 -6
  36. package/actionsExecutor/types.ts +59 -0
  37. package/analyticsUtils/AnalyticsEvents/sendMenuClickEvent.ts +2 -2
  38. package/analyticsUtils/PlayerAnalyticsManager.ts +1 -1
  39. package/appUtils/HooksManager/index.ts +9 -0
  40. package/appUtils/contextKeysManager/__tests__/getKey/failure.test.ts +1 -1
  41. package/appUtils/contextKeysManager/__tests__/removeKey/failure.test.ts +1 -1
  42. package/appUtils/contextKeysManager/__tests__/setKey/failure/invalidKey.test.ts +4 -4
  43. package/appUtils/contextKeysManager/index.ts +1 -1
  44. package/appUtils/playerManager/OverlayObserver/OverlaysObserver.ts +143 -53
  45. package/appUtils/playerManager/OverlayObserver/__tests__/liveContent.test.ts +205 -0
  46. package/appUtils/playerManager/OverlayObserver/__tests__/utils.test.ts +49 -0
  47. package/appUtils/playerManager/OverlayObserver/getUpcomingQueue.android.tv.ts +4 -0
  48. package/appUtils/playerManager/OverlayObserver/getUpcomingQueue.ios.tv.ts +4 -0
  49. package/appUtils/playerManager/OverlayObserver/getUpcomingQueue.ts +11 -0
  50. package/appUtils/playerManager/OverlayObserver/getUpcomingQueue.web.ts +4 -0
  51. package/appUtils/playerManager/OverlayObserver/utils.ts +54 -20
  52. package/appUtils/playerManager/__tests__/playerContent.test.ts +403 -0
  53. package/appUtils/playerManager/__tests__/playerFactory.test.ts +1 -1
  54. package/appUtils/playerManager/__tests__/playerNative.test.ts +38 -0
  55. package/appUtils/playerManager/__tests__/usePlayerContent.test.tsx +64 -0
  56. package/appUtils/playerManager/{conts.ts → const.ts} +20 -0
  57. package/appUtils/playerManager/index.ts +1 -1
  58. package/appUtils/playerManager/player.ts +115 -3
  59. package/appUtils/playerManager/playerFactory.ts +1 -1
  60. package/appUtils/playerManager/playerNative.ts +6 -4
  61. package/appUtils/playerManager/usePlayerContent.tsx +43 -0
  62. package/appUtils/playerManager/usePlayerControllerSetup.tsx +1 -1
  63. package/appUtils/playerManager/userLanguagePreference.ts +1 -1
  64. package/arrayUtils/__tests__/{anyThruthy.test.ts → anyTruthy.test.ts} +8 -0
  65. package/arrayUtils/__tests__/arrayUtils.test.ts +165 -108
  66. package/arrayUtils/__tests__/isEmptyArray.test.ts +11 -0
  67. package/arrayUtils/__tests__/isFilledArray.test.ts +12 -0
  68. package/arrayUtils/__tests__/isFirst.test.ts +17 -0
  69. package/arrayUtils/__tests__/isIndexInRange.test.ts +14 -0
  70. package/arrayUtils/__tests__/isLast.test.ts +31 -0
  71. package/arrayUtils/__tests__/makeListOf.test.ts +31 -0
  72. package/arrayUtils/__tests__/makeListOfIndexes.test.ts +20 -0
  73. package/arrayUtils/__tests__/reorderByIds.test.ts +50 -0
  74. package/arrayUtils/__tests__/sample.test.ts +61 -0
  75. package/arrayUtils/index.ts +136 -20
  76. package/bottomSheet/__tests__/scrollContext.test.tsx +35 -0
  77. package/bottomSheet/index.ts +17 -0
  78. package/cellUtils/index.ts +33 -8
  79. package/colorUtils/__tests__/isTransparentColor.test.ts +76 -0
  80. package/colorUtils/__tests__/isValidColor.test.ts +70 -0
  81. package/colorUtils/index.ts +50 -0
  82. package/configurationUtils/__tests__/manifestKeyParser.test.ts +21 -0
  83. package/configurationUtils/__tests__/modalBlocksParser.test.ts +260 -0
  84. package/configurationUtils/manifestKeyParser.ts +50 -10
  85. package/configurationUtils/modalBlocksParser.ts +296 -0
  86. package/entryActions/__tests__/buildEntryActions.test.ts +156 -0
  87. package/entryActions/aliasPresentation.ts +124 -0
  88. package/entryActions/buildEntryActions.ts +166 -0
  89. package/entryActions/index.ts +17 -0
  90. package/entryActions/types.ts +39 -0
  91. package/manifestUtils/__tests__/player.audioControls.test.js +158 -0
  92. package/manifestUtils/_internals/index.js +14 -3
  93. package/manifestUtils/defaultManifestConfigurations/generalContent.js +6 -0
  94. package/manifestUtils/defaultManifestConfigurations/player.js +349 -20
  95. package/manifestUtils/fieldUtils/__tests__/fieldUtils.test.js +84 -0
  96. package/manifestUtils/fieldUtils/index.js +125 -0
  97. package/manifestUtils/index.js +3 -0
  98. package/manifestUtils/keys.js +9 -0
  99. package/manifestUtils/mobileAction/button/index.js +16 -0
  100. package/manifestUtils/mobileAction/container/index.js +3 -1
  101. package/manifestUtils/mobileAction/groups/defaults.js +3 -1
  102. package/manifestUtils/modalBlocks.js +304 -0
  103. package/manifestUtils/platformIsTV.js +1 -0
  104. package/modalState/ContentViewModel.ts +113 -0
  105. package/modalState/EditableCollection.ts +17 -0
  106. package/modalState/EditableCollectionRegistry.ts +51 -0
  107. package/modalState/ModalOrchestrator.ts +211 -0
  108. package/modalState/RemoteEditableCollection.ts +227 -0
  109. package/modalState/__tests__/ContentViewModel.editable.test.ts +69 -0
  110. package/modalState/__tests__/ContentViewModel.test.ts +165 -0
  111. package/modalState/__tests__/EditableCollectionRegistry.test.ts +112 -0
  112. package/modalState/__tests__/ModalOrchestrator.phase3.test.ts +47 -0
  113. package/modalState/__tests__/RemoteEditableCollection.test.ts +326 -0
  114. package/modalState/__tests__/index.test.ts +30 -1
  115. package/modalState/__tests__/useBottomSheetContent.test.ts +349 -0
  116. package/modalState/index.ts +35 -83
  117. package/modalState/store.ts +102 -0
  118. package/modalState/types.ts +159 -0
  119. package/modalState/useBottomSheetContent.ts +104 -0
  120. package/numberUtils/__tests__/isMinusZero.test.ts +20 -0
  121. package/numberUtils/__tests__/isZero.test.ts +27 -0
  122. package/numberUtils/__tests__/requireNumber.test.ts +50 -0
  123. package/numberUtils/__tests__/toNumber.test.ts +27 -0
  124. package/numberUtils/__tests__/toNumberWithDefault.test.ts +64 -0
  125. package/numberUtils/__tests__/toNumberWithDefaultZero.test.ts +48 -0
  126. package/numberUtils/index.ts +27 -8
  127. package/package.json +2 -2
  128. package/pipesUtils/__tests__/buildUrlWithQuery.test.ts +33 -0
  129. package/pipesUtils/__tests__/withPipesEndpoint.test.tsx +56 -0
  130. package/pipesUtils/index.ts +1 -0
  131. package/pipesUtils/withPipesEndpoint.tsx +54 -0
  132. package/playerUtils/__tests__/contentDataKeys.test.ts +297 -0
  133. package/playerUtils/__tests__/resolvePlayerActions.test.ts +138 -0
  134. package/playerUtils/__tests__/resolvePlayerTitleSubtitle.test.ts +180 -0
  135. package/playerUtils/contentDataKeys.ts +134 -0
  136. package/playerUtils/index.ts +37 -16
  137. package/playerUtils/isAudioItem.ts +26 -0
  138. package/playerUtils/resolvePlayerActions.ts +71 -0
  139. package/playerUtils/resolvePlayerTitleSubtitle.ts +76 -0
  140. package/reactHooks/actions/index.ts +117 -2
  141. package/reactHooks/cell-click/index.ts +3 -3
  142. package/reactHooks/feed/__mocks__/useMarkPipesDataStale.ts +4 -0
  143. package/reactHooks/feed/__tests__/useInflatedUrl.test.tsx +25 -0
  144. package/reactHooks/feed/index.ts +5 -1
  145. package/reactHooks/feed/useBatchLoading.ts +9 -1
  146. package/reactHooks/feed/{usePipesCacheReset.ts → useMarkPipesDataStale.ts} +12 -4
  147. package/reactHooks/index.ts +2 -0
  148. package/reactHooks/layout/index.ts +1 -1
  149. package/reactHooks/navigation/__mocks__/index.ts +4 -0
  150. package/reactHooks/navigation/__tests__/index.test.tsx +48 -0
  151. package/reactHooks/navigation/__tests__/useIsScreenActive.test.ts +42 -0
  152. package/reactHooks/navigation/__tests__/usePresentScreen.test.ts +154 -0
  153. package/reactHooks/navigation/index.ts +3 -1
  154. package/reactHooks/navigation/useIsScreenActive.ts +29 -8
  155. package/reactHooks/navigation/usePresentScreen.ts +157 -0
  156. package/reactHooks/navigation/useRoute.ts +14 -1
  157. package/reactHooks/state/useComponentScreenState.ts +1 -1
  158. package/reactHooks/usePluginConfiguration.ts +4 -1
  159. package/reactHooks/utils/__tests__/index.test.js +22 -2
  160. package/reactHooks/utils/index.ts +13 -2
  161. package/riverComponetsMeasurementProvider/index.tsx +12 -8
  162. package/stringUtils/__tests__/stringUtils.test.js +42 -0
  163. package/stringUtils/index.ts +2 -2
  164. package/uiActionsRegistrator/__tests__/resolveActionIdentifiers.test.ts +93 -0
  165. package/uiActionsRegistrator/__tests__/subscribe.test.ts +107 -0
  166. package/uiActionsRegistrator/__tests__/usableActionItems.test.ts +52 -0
  167. package/uiActionsRegistrator/index.ts +25 -0
  168. package/uiActionsRegistrator/registry.ts +335 -0
  169. package/uiActionsRegistrator/resolveActionIdentifiers.ts +100 -0
  170. package/uiActionsRegistrator/usableActionItems.ts +66 -0
  171. package/zappFrameworkUtils/__tests__/localStorageHelper.test.ts +146 -0
  172. package/zappFrameworkUtils/localStorageHelper.ts +19 -15
  173. package/appUtils/playerManager/usePlayerTitleSummaryOverlay.tsx +0 -56
  174. package/playerUtils/__tests__/getPlayerActionButtons.test.ts +0 -54
  175. package/playerUtils/getPlayerActionButtons.ts +0 -17
  176. package/reactHooks/feed/__mocks__/usePipesCacheReset.ts +0 -1
  177. /package/reactHooks/actions/__tests__/{index.test.js → index.test.tsx} +0 -0
@@ -0,0 +1,15 @@
1
+ /// <reference types="@applicaster/applicaster-types" />
2
+ import { sessionStorageToggleFlag } from "../StorageActions";
3
+ import { ActionResult } from "../ActionExecutor";
4
+ import { ActionHandler, ActionExecutionContext } from "../types";
5
+ import { StorageToggleFlagOptions } from "./localStorageToggleFlag";
6
+
7
+ /**
8
+ * Toggles a flag in session storage (adds or removes an item from a collection).
9
+ * Values persist only for the current app session.
10
+ */
11
+ export const sessionStorageToggleFlagAction: ActionHandler<
12
+ StorageToggleFlagOptions
13
+ > = async (action, context?: ActionExecutionContext): Promise<ActionResult> => {
14
+ return await sessionStorageToggleFlag(context, action);
15
+ };
@@ -0,0 +1,87 @@
1
+ /// <reference types="@applicaster/applicaster-types" />
2
+ import { ActionResult } from "../ActionExecutor";
3
+ import { ActionHandler } from "../types";
4
+ import { postEvent } from "../../reactHooks/useSubscriberFor";
5
+
6
+ export const CONFIRMATION_TOAST_SOURCE = "confirmation";
7
+
8
+ export const CONFIRMATION_TOAST_DEFAULT_TIMEOUT = 1000;
9
+
10
+ /**
11
+ * Shows a mobile confirmation toast with Theme defaults from
12
+ * `Confirmation Toast / Message` in the base theme plugin.
13
+ *
14
+ * This action is confirmation-only by design: it always stamps
15
+ * `source: "confirmation"` (so Theme confirmation styles apply) and defaults
16
+ * `timeout` to 1000 ms. Non-confirmation toasts (e.g. Offline Experience)
17
+ * must post on the shared `"showToast"` event bus directly and omit `source`.
18
+ * Callers may override individual style fields; Theme supplies the rest.
19
+ *
20
+ * @example From React via ActionExecutorContext
21
+ * ```tsx
22
+ * import React, { useContext } from "react";
23
+ * import { ActionExecutorContext } from "@applicaster/zapp-react-native-utils/actionsExecutor/ActionExecutorContext";
24
+ *
25
+ * function QueueButton() {
26
+ * const { handleAction } = useContext(ActionExecutorContext);
27
+ *
28
+ * const onPress = () => {
29
+ * void handleAction({
30
+ * type: "showToast",
31
+ * options: { message: "Added to queue" },
32
+ * });
33
+ * };
34
+ *
35
+ * return <Button onPress={onPress} title="Add to queue" />;
36
+ * }
37
+ * ```
38
+ *
39
+ * @example From code via the actionExecutor singleton
40
+ * ```ts
41
+ * import { actionExecutor } from "@applicaster/zapp-react-native-utils/actionsExecutor/ActionExecutor";
42
+ *
43
+ * await actionExecutor.handleAction({
44
+ * type: "showToast",
45
+ * options: {
46
+ * message: "Playlist created",
47
+ * style: { backgroundColor: "#00AA55" }, // optional partial override
48
+ * },
49
+ * });
50
+ * ```
51
+ *
52
+ * @example From entry / pipes actions JSON
53
+ * ```json
54
+ * {
55
+ * "type": "showToast",
56
+ * "options": {
57
+ * "message": "Item removed from playlist"
58
+ * }
59
+ * }
60
+ * ```
61
+ */
62
+ export interface ShowToastActionOptions {
63
+ id?: string;
64
+ message?: string;
65
+ extraMessage?: string;
66
+ style?: any;
67
+ timeout?: number;
68
+ }
69
+
70
+ export const showToastAction: ActionHandler<ShowToastActionOptions> = async (
71
+ action
72
+ ): Promise<ActionResult> => {
73
+ const options = action?.options;
74
+
75
+ postEvent("showToast", [
76
+ {
77
+ id: options?.id,
78
+ message: options?.message,
79
+ extraMessage: options?.extraMessage,
80
+ style: options?.style,
81
+ timeout: options?.timeout ?? CONFIRMATION_TOAST_DEFAULT_TIMEOUT,
82
+ source: CONFIRMATION_TOAST_SOURCE,
83
+ },
84
+ ]);
85
+
86
+ return ActionResult.Success;
87
+ };
@@ -0,0 +1,40 @@
1
+ /// <reference types="@applicaster/applicaster-types" />
2
+ import { localStorage } from "@applicaster/zapp-react-native-bridge/ZappStorage/LocalStorage";
3
+ import * as QuickBrickManager from "@applicaster/zapp-react-native-bridge/QuickBrick";
4
+ import { QUICK_BRICK_EVENTS } from "@applicaster/zapp-react-native-bridge/QuickBrick";
5
+ import { ACTIVE_LAYOUT_ID_STORAGE_KEY } from "@applicaster/quick-brick-core/App/remoteContextReloader/consts";
6
+ import { ActionResult } from "../ActionExecutor";
7
+ import { ActionHandler } from "../types";
8
+ import { createLogger } from "../../logger";
9
+
10
+ const { log_info } = createLogger({
11
+ subsystem: "ActionExecutorContext",
12
+ category: "General",
13
+ });
14
+
15
+ /**
16
+ * Options for the switchLayout action.
17
+ */
18
+ export interface SwitchLayoutOptions {
19
+ /** The ID of the layout to switch to */
20
+ layoutId: string;
21
+ }
22
+
23
+ /**
24
+ * Switches the active layout and triggers an app reload.
25
+ * Saves the new layout ID to local storage before reloading.
26
+ */
27
+ export const switchLayoutAction: ActionHandler<SwitchLayoutOptions> = async (
28
+ action
29
+ ): Promise<ActionResult> => {
30
+ log_info("handleAction: switchLayout event");
31
+
32
+ await localStorage.setItem(
33
+ ACTIVE_LAYOUT_ID_STORAGE_KEY,
34
+ action.options.layoutId
35
+ );
36
+
37
+ QuickBrickManager.sendQuickBrickEvent(QUICK_BRICK_EVENTS.FORCE_APP_RELOAD);
38
+
39
+ return ActionResult.Success;
40
+ };
@@ -2,3 +2,29 @@ export const TOGGLE_FLAG_MAX_ITEMS_REACHED_EVENT =
2
2
  "action.localStorageToggleFlag.maxItemsReached";
3
3
 
4
4
  export const ACTION_EXECUTOR_EVENT_SOURCE = "ActionExecutor";
5
+
6
+ export const ACTION_TYPES = {
7
+ OPEN_BOTTOM_SHEET: "openBottomSheet",
8
+ DISMISS_BOTTOM_SHEET: "dismissBottomSheet",
9
+ PRESENT_SUB_MENU: "presentSubMenu",
10
+ SEND_CLOUD_EVENT: "sendCloudEvent",
11
+ NAVIGATE_TO_SCREEN: "navigateToScreen",
12
+ PRESENT_SCREEN: "presentScreen",
13
+ GO_BACK: "goBack",
14
+ GO_HOME: "goHome",
15
+ SHOW_TOAST: "showToast",
16
+ LOCAL_STORAGE_SET: "localStorageSet",
17
+ LOCAL_STORAGE_REMOVE: "localStorageRemove",
18
+ LOCAL_STORAGE_TOGGLE_FLAG: "localStorageToggleFlag",
19
+ SESSION_STORAGE_SET: "sessionStorageSet",
20
+ SESSION_STORAGE_REMOVE: "sessionStorageRemove",
21
+ SESSION_STORAGE_TOGGLE_FLAG: "sessionStorageToggleFlag",
22
+ REFRESH_COMPONENT: "refreshComponent",
23
+ SWITCH_LAYOUT: "switchLayout",
24
+ APP_RESTART: "appRestart",
25
+ CONFIRM_DIALOG: "confirmDialog",
26
+ SCREEN_SET_VARIABLE: "screenSetVariable",
27
+ SCREEN_TOGGLE_FLAG: "screenToggleFlag",
28
+ } as const;
29
+
30
+ export type KnownActionType = (typeof ACTION_TYPES)[keyof typeof ACTION_TYPES];
@@ -159,13 +159,13 @@ export const decorateFeed = (feed: ZappFeed) => {
159
159
 
160
160
  const decoratedFeed = R.clone(feed);
161
161
 
162
- const isSingleSelect =
163
- (feed.extensions?.preference_editor_options?.select_mode ||
164
- feed.extensions?.behavior?.select_mode) === "single";
162
+ const selectMode =
163
+ feed.extensions?.preference_editor_options?.select_mode ||
164
+ feed.extensions?.behavior?.select_mode;
165
165
 
166
- if (isSingleSelect) {
166
+ if (selectMode === "single") {
167
167
  return makeSingleSelect(feed, key, decoratedFeed);
168
- } else {
169
- return makeMultiSelect(feed, key, decoratedFeed);
170
168
  }
169
+
170
+ return makeMultiSelect(feed, key, decoratedFeed);
171
171
  };
@@ -0,0 +1,59 @@
1
+ /// <reference types="@applicaster/applicaster-types" />
2
+ import { ActionResult } from "./ActionExecutor";
3
+ import { useScreenStateStore } from "../reactHooks/navigation/useScreenStateStore";
4
+
5
+ /**
6
+ * Base context object passed to action handlers during execution.
7
+ * Contains references to the current entry, screen, and other execution state.
8
+ */
9
+ export interface ActionExecutionContext {
10
+ /** The entry associated with this action (e.g., the item that was tapped) */
11
+ entry?: ZappEntry;
12
+
13
+ /** The current screen/river data */
14
+ screenData?: ZappRiver;
15
+
16
+ /** The entry that defines the screen (if screen was opened from an entry) */
17
+ screenEntry?: ZappEntry;
18
+
19
+ /** The UI component that triggered the action.
20
+ * From UIComponentContext as `{ ...component, parent }`.
21
+ */
22
+ component?: ZappUIComponent & { parent?: ZappUIComponent };
23
+
24
+ /** The route identifier for the current screen */
25
+ screenRoute?: string;
26
+
27
+ /** The screen state store for managing screen-level state (Zustand store) */
28
+ screenStateStore?: ReturnType<typeof useScreenStateStore>;
29
+
30
+ /** Context entry for additional data */
31
+ entryContext?: ZappEntry;
32
+
33
+ /** Callback function for action completion */
34
+ callback?: (result: { success: boolean; error: any; abort: boolean }) => void;
35
+
36
+ screenState?: Record<any, any>;
37
+ }
38
+
39
+ /**
40
+ * Type for action handler functions.
41
+ * Handlers receive the action (which may have typed options) and execution context.
42
+ *
43
+ * @template _TOptions - Optional type hint for the action's options object (for documentation/intellisense)
44
+ * @param action - The action to execute
45
+ * @param context - The execution context
46
+ * @returns A promise that resolves to the action result
47
+ */
48
+ export type ActionHandler<_TOptions = any> = (
49
+ action: ActionType,
50
+ context?: ActionExecutionContext
51
+ ) => Promise<ActionResult>;
52
+
53
+ /**
54
+ * Factory function that creates an action handler.
55
+ * Used for actions that need to capture dependencies at registration time.
56
+ */
57
+ export type ActionHandlerFactory<_TOptions = any> = (
58
+ ...dependencies: any[]
59
+ ) => ActionHandler<_TOptions>;
@@ -6,9 +6,9 @@ import { postAnalyticEvent } from "../manager";
6
6
  import { ANALYTICS_CORE_EVENTS } from "../events";
7
7
 
8
8
  type AnalyticsDefaultHelperProperties = {
9
- analyticsScreenData: AnalyticsScreenProperties;
9
+ analyticsScreenData?: AnalyticsScreenProperties;
10
10
  extraProps: any;
11
- props;
11
+ props?: any;
12
12
  };
13
13
 
14
14
  export const sendMenuClickEvent = ({
@@ -8,7 +8,7 @@ import {
8
8
  } from "../appUtils/playerManager";
9
9
  import { Player } from "../appUtils/playerManager/player";
10
10
  import { AnalyticPlayerListener } from "./AnalyticPlayerListener";
11
- import { PlayerRole } from "../appUtils/playerManager/conts";
11
+ import { PlayerRole } from "../appUtils/playerManager/const";
12
12
 
13
13
  enum PlayerAnalyticsTrackerType {
14
14
  PlayerAnalyticsTracker = "PlayerAnalyticsTracker",
@@ -498,6 +498,15 @@ export function HooksManager({
498
498
  presentUI
499
499
  );
500
500
  } catch (e) {
501
+ // Without this the failure is invisible: the hook stops right after the
502
+ // "Executing hook" line, with nothing in the log explaining why and no
503
+ // remaining hook ever running.
504
+ logHookEvent(
505
+ hooksManagerLogger.error,
506
+ `runInBackground: hook ${hookPlugin.identifier} threw: ${e?.message}`,
507
+ { hook: hookPlugin, payload, error: e, stack: e?.stack }
508
+ );
509
+
501
510
  hookPlugin.setStateAndNotify(HOOKS_EVENTS.ERROR, {
502
511
  error: e,
503
512
  hookPlugin,
@@ -46,7 +46,7 @@ describe("Context Keys Manager - getKey", () => {
46
46
 
47
47
  expect(mockedLogger.warn).toHaveBeenCalledWith({
48
48
  message:
49
- "Provided key is not valid - expecing an object with namespace and key properties",
49
+ "Provided key is not valid - expecting an object with namespace and key properties",
50
50
  data: { key: invalidKey },
51
51
  });
52
52
 
@@ -47,7 +47,7 @@ describe("Context Keys Manager - removeKey", () => {
47
47
 
48
48
  expect(mockedLogger.warn).toHaveBeenCalledWith({
49
49
  message:
50
- "Provided key is not valid - expecing an object with namespace and key properties",
50
+ "Provided key is not valid - expecting an object with namespace and key properties",
51
51
  data: { key },
52
52
  });
53
53
 
@@ -48,7 +48,7 @@ describe("Context Keys Manager - setKey", () => {
48
48
 
49
49
  expect(mockedLogger.warn).toHaveBeenCalledWith({
50
50
  message:
51
- "Provided key is not valid - expecing an object with namespace and key properties",
51
+ "Provided key is not valid - expecting an object with namespace and key properties",
52
52
  data: { key },
53
53
  });
54
54
 
@@ -105,7 +105,7 @@ describe("Context Keys Manager - setKey", () => {
105
105
 
106
106
  expect(mockedLogger.warn).toHaveBeenCalledWith({
107
107
  message:
108
- "Provided key is not valid - expecing an object with namespace and key properties",
108
+ "Provided key is not valid - expecting an object with namespace and key properties",
109
109
  data: { key },
110
110
  });
111
111
 
@@ -162,7 +162,7 @@ describe("Context Keys Manager - setKey", () => {
162
162
 
163
163
  expect(mockedLogger.warn).toHaveBeenCalledWith({
164
164
  message:
165
- "Provided key is not valid - expecing an object with namespace and key properties",
165
+ "Provided key is not valid - expecting an object with namespace and key properties",
166
166
  data: { key },
167
167
  });
168
168
 
@@ -217,7 +217,7 @@ describe("Context Keys Manager - setKey", () => {
217
217
 
218
218
  expect(mockedLogger.warn).toHaveBeenCalledWith({
219
219
  message:
220
- "Provided key is not valid - expecing an object with namespace and key properties",
220
+ "Provided key is not valid - expecting an object with namespace and key properties",
221
221
  data: { key },
222
222
  });
223
223
 
@@ -109,7 +109,7 @@ export class ContextKeysManager {
109
109
  if (!keyIsValid(parsedKey)) {
110
110
  this._logger.warn({
111
111
  message:
112
- "Provided key is not valid - expecing an object with namespace and key properties",
112
+ "Provided key is not valid - expecting an object with namespace and key properties",
113
113
  data: { key },
114
114
  });
115
115
 
@@ -3,8 +3,8 @@ import { distinctUntilChanged } from "rxjs/operators";
3
3
  import { Player } from "../player";
4
4
  import { createLogger, utilsLogger } from "../../../logger";
5
5
  import { appStore } from "@applicaster/zapp-react-native-redux/AppStore";
6
+ import { findPluginByIdentifier } from "../../../pluginUtils";
6
7
  import {
7
- findPluginByIdentifier,
8
8
  loadFeedEntry,
9
9
  loadFeedAndPrefetchThumbnailImage,
10
10
  parseTimeToSeconds,
@@ -19,6 +19,12 @@ export const { log_verbose, log_debug, log_info, log_error } = createLogger({
19
19
  parent: utilsLogger,
20
20
  });
21
21
 
22
+ /**
23
+ * Mirrors `initial_value` for `audio_live_player_update_interval` in
24
+ * `defaultManifestConfigurations/player.js`.
25
+ */
26
+ const DEFAULT_LIVE_CONTENT_UPDATE_INTERVAL_SECONDS = 60;
27
+
22
28
  type ChapterMarkerOriginal = {
23
29
  id: string;
24
30
  title: string;
@@ -40,11 +46,6 @@ export type LiveMetadataConfig = {
40
46
  updateInterval: number;
41
47
  };
42
48
 
43
- export type TitleSummaryEvent = {
44
- title: string | number;
45
- summary: string | number;
46
- };
47
-
48
49
  type ChapterMarkersObserverProps = {
49
50
  player: Player;
50
51
  };
@@ -59,24 +60,23 @@ type PlayNextConfig = {
59
60
  export type PlayNextState = PlayNextConfig & {
60
61
  triggerTime: number;
61
62
  handleUserCancelPlayNext: () => void;
63
+ hidePlayNext: () => void;
62
64
  };
63
65
 
64
66
  export class OverlaysObserver {
65
67
  readonly chapterSubject: BehaviorSubject<ChapterMarkerEvent>;
66
68
  private playNextSubject: BehaviorSubject<PlayNextState>;
67
69
  private liveMetadataSubject: BehaviorSubject<LiveMetadataEvent>;
68
- private titleSummarySubject: BehaviorSubject<TitleSummaryEvent>;
69
- private feedUrl: string;
70
- private reloadData: () => void;
71
- private updateTitleAndDescription: (data: any) => void;
72
- private feedDataInterval: any;
70
+ private liveContentInterval: any;
71
+ private liveContentGeneration = 0;
72
+ private _liveEntry: ZappEntry | null = null;
73
73
  private liveMetadataUpdateInterval: any;
74
74
  private releasePlayerObserver?: () => void;
75
75
  readonly entry: ZappEntry;
76
76
  private chapterMarkerEvents: ChapterMarkerEvent[];
77
77
  readonly player: Player;
78
78
  private playNextConfig?: PlayNextConfig;
79
- private isCanceledByUser = false;
79
+ private isPlayNextSuppressed = false;
80
80
 
81
81
  constructor({ player }: ChapterMarkersObserverProps) {
82
82
  this.chapterSubject = new BehaviorSubject(null);
@@ -85,41 +85,140 @@ export class OverlaysObserver {
85
85
  this.player = player;
86
86
  this.entry = player.getEntry();
87
87
 
88
- this.titleSummarySubject = new BehaviorSubject<TitleSummaryEvent>({
89
- title: this.entry?.title || "",
90
- summary: this.entry?.summary || "",
91
- });
92
-
93
88
  this.liveMetadataSubject = new BehaviorSubject<LiveMetadataEvent>(
94
89
  this.entry?.extensions?.liveMetadata || null
95
90
  );
96
91
 
97
92
  this.chapterMarkerEvents = this.prepareChapterMarkers();
98
93
  this.releasePlayerObserver = this.subscribeToPlayerEvents();
99
- this.feedUrl = "";
100
- this.reloadData = () => {};
101
- this.updateTitleAndDescription = () => {};
102
- this.feedDataInterval = null;
94
+ this.liveContentInterval = null;
103
95
  this.liveMetadataUpdateInterval = null;
104
96
  void this.preparePlayNext();
105
97
  void this.prepareLiveMetadata();
106
98
  }
107
99
 
108
- private setupFeedDataInterval(interval: number) {
109
- if (this.feedUrl && this.reloadData && this.updateTitleAndDescription) {
110
- this.feedDataInterval = setInterval(() => {
111
- this.reloadData();
112
- }, interval * 1000);
100
+ /**
101
+ * Polls the live feed and pushes each loaded entry into the player, which
102
+ * re-resolves its Title/Subtitle and publishes on its content channel.
103
+ *
104
+ * Runs entirely outside React: `loadFeedEntry` builds its request through
105
+ * `RequestBuilder.setUrl`, which inflates URL macros with the entry and
106
+ * screen contexts, so no `useInflatedUrl` is needed. `prepareLiveMetadata`
107
+ * below already polls this way.
108
+ */
109
+ public startLiveContentUpdates() {
110
+ this.stopLiveContentUpdates();
111
+
112
+ if (!this.player?.isLive?.()) {
113
+ log_debug("startLiveContentUpdates: Player is not live. Skipping...");
114
+
115
+ return;
116
+ }
117
+
118
+ const feedUrl = this.getLiveContentFeedUrl();
119
+
120
+ if (!feedUrl) {
121
+ log_debug(
122
+ "startLiveContentUpdates: Entry carries no live channel feed. Skipping..."
123
+ );
124
+
125
+ return;
113
126
  }
127
+
128
+ const intervalSeconds = this.getLiveContentUpdateInterval();
129
+
130
+ // Clearing the interval cannot cancel a request already in flight, so each
131
+ // run carries the generation it started in. A response that arrives after
132
+ // a stop or a restart belongs to a channel that is no longer playing and
133
+ // is dropped, rather than publishing the previous programme's title over
134
+ // the current one.
135
+ const generation = ++this.liveContentGeneration;
136
+
137
+ const load = async () => {
138
+ try {
139
+ const entry = await loadFeedEntry(feedUrl, this.entry);
140
+
141
+ if (generation !== this.liveContentGeneration) {
142
+ return;
143
+ }
144
+
145
+ this._liveEntry = entry;
146
+ this.player.publishContent();
147
+ } catch {
148
+ // `loadFeedEntry` already logs the failure. Keep whatever content is
149
+ // currently published rather than blanking the title on a transient
150
+ // network error.
151
+ }
152
+ };
153
+
154
+ void load();
155
+
156
+ this.liveContentInterval = setInterval(load, intervalSeconds * 1000);
114
157
  }
115
158
 
116
- public clearFeedDataInterval() {
117
- if (this.feedDataInterval) {
118
- clearInterval(this.feedDataInterval);
119
- this.feedDataInterval = null;
159
+ public stopLiveContentUpdates() {
160
+ // Invalidates any in-flight request as well as the interval.
161
+ this.liveContentGeneration += 1;
162
+
163
+ if (this.liveContentInterval) {
164
+ clearInterval(this.liveContentInterval);
165
+ this.liveContentInterval = null;
120
166
  }
121
167
  }
122
168
 
169
+ /**
170
+ * The programme feed for the channel currently playing. Derived here rather
171
+ * than by the caller so no UI component needs to know where a live channel
172
+ * keeps its feed, or that the URL has to be rewritten to reach the
173
+ * programme ("livePage") view of it.
174
+ */
175
+ private getLiveContentFeedUrl(): string {
176
+ const channelSrc =
177
+ this.player.getEntry()?.extensions?.live?.channel_src ?? "";
178
+
179
+ return channelSrc.replace(new RegExp("subClass", "g"), "livePage");
180
+ }
181
+
182
+ /**
183
+ * Falls back to the manifest's own `initial_value` when the app ships no
184
+ * value: `intervalSeconds * 1000` would otherwise be `NaN`, and
185
+ * `setInterval` treats `NaN` as `0` - a tight loop hammering the feed.
186
+ */
187
+ private getLiveContentUpdateInterval(): number {
188
+ const configured =
189
+ this.player.getPluginConfiguration()?.audio_live_player_update_interval;
190
+
191
+ const seconds = Number(configured);
192
+
193
+ return Number.isFinite(seconds) && seconds > 0
194
+ ? seconds
195
+ : DEFAULT_LIVE_CONTENT_UPDATE_INTERVAL_SECONDS;
196
+ }
197
+
198
+ /**
199
+ * The entry most recently loaded from the live channel feed - the programme
200
+ * currently on air, as opposed to `player.entry`, which is the channel and
201
+ * stays put for the whole listening session.
202
+ *
203
+ * Read by `Player.getContent()`, which prefers it over the player's own
204
+ * entry. It lives here rather than on `Player` because it is live-feed
205
+ * state, like `liveMetadata` and play-next: a VOD or cast player never has
206
+ * an observer at all, so it never carries this either.
207
+ */
208
+ public get liveEntry(): ZappEntry | null {
209
+ return this._liveEntry;
210
+ }
211
+
212
+ /**
213
+ * Called by `Player`'s `entry` setter. The live entry is an overlay on the
214
+ * current entry, so its lifetime is scoped to that entry: without this, a
215
+ * programme from a previous channel would shadow the new one forever - the
216
+ * content would change but the title would not.
217
+ */
218
+ public clearLiveEntry() {
219
+ this._liveEntry = null;
220
+ }
221
+
123
222
  public clearLiveMetadataUpdateInterval() {
124
223
  if (this.liveMetadataUpdateInterval) {
125
224
  clearInterval(this.liveMetadataUpdateInterval);
@@ -127,25 +226,13 @@ export class OverlaysObserver {
127
226
  }
128
227
  }
129
228
 
130
- public setFeedDataHandlers(
131
- feedUrl: string,
132
- reloadData: () => void,
133
- interval: number,
134
- updateTitleAndDescription: (data: any) => void
135
- ) {
136
- this.feedUrl = feedUrl;
137
- this.reloadData = reloadData;
138
- this.updateTitleAndDescription = updateTitleAndDescription;
139
- this.setupFeedDataInterval(interval);
140
- }
141
-
142
- public getTitleSummaryObservable(): Observable<TitleSummaryEvent> {
143
- return this.titleSummarySubject.asObservable().pipe(distinctUntilChanged());
144
- }
229
+ hidePlayNext = () => {
230
+ this.isPlayNextSuppressed = true;
231
+ this.playNextSubject.next(null);
232
+ };
145
233
 
146
234
  handleUserCancelPlayNext = () => {
147
- this.isCanceledByUser = true;
148
- this.playNextSubject.next(null);
235
+ this.hidePlayNext();
149
236
  };
150
237
 
151
238
  preparePlayNext = async () => {
@@ -165,7 +252,10 @@ export class OverlaysObserver {
165
252
  return;
166
253
  }
167
254
 
168
- const playNextFeedUrl: string = retrieveFeedUrl(this.entry);
255
+ const playNextFeedUrl: string = await retrieveFeedUrl(
256
+ this.entry,
257
+ plugins
258
+ );
169
259
 
170
260
  if (!playNextFeedUrl || typeof playNextFeedUrl !== "string") {
171
261
  log_debug(
@@ -270,7 +360,7 @@ export class OverlaysObserver {
270
360
 
271
361
  // TODO: Hack for video end, will be replaced with playlist prev/next in the future
272
362
  getPlayNextEntry = () =>
273
- !this.isCanceledByUser ? this.playNextConfig?.entry : null;
363
+ !this.isPlayNextSuppressed ? this.playNextConfig?.entry : null;
274
364
 
275
365
  prepareChapterMarkers = () => {
276
366
  const chapterMarkers: ChapterMarkerOriginal[] =
@@ -353,7 +443,7 @@ export class OverlaysObserver {
353
443
  const shouldPlayNextBeVisible = currentTime > triggerTime;
354
444
 
355
445
  if (shouldPlayNextBeVisible) {
356
- if (this.isCanceledByUser) {
446
+ if (this.isPlayNextSuppressed) {
357
447
  return;
358
448
  }
359
449
 
@@ -361,10 +451,11 @@ export class OverlaysObserver {
361
451
  ...this.playNextConfig,
362
452
  triggerTime,
363
453
  handleUserCancelPlayNext: this.handleUserCancelPlayNext,
454
+ hidePlayNext: this.hidePlayNext,
364
455
  });
365
456
  } else {
366
457
  this.playNextSubject.next(null);
367
- this.isCanceledByUser = false;
458
+ this.isPlayNextSuppressed = false;
368
459
  }
369
460
  };
370
461
 
@@ -389,9 +480,8 @@ export class OverlaysObserver {
389
480
  this.chapterSubject.complete();
390
481
  this.playNextSubject.complete();
391
482
  this.liveMetadataSubject.complete();
392
- this.titleSummarySubject.complete();
393
483
  this.releasePlayerObserver?.();
394
- this.clearFeedDataInterval();
484
+ this.stopLiveContentUpdates();
395
485
  this.clearLiveMetadataUpdateInterval();
396
486
  this.releasePlayerObserver = null;
397
487
  };