@applicaster/zapp-react-native-utils 14.0.0-alpha.1235043154 → 14.0.0-alpha.1322105203

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 (55) hide show
  1. package/actionsExecutor/ActionExecutorContext.tsx +60 -83
  2. package/actionsExecutor/ScreenActions.ts +163 -0
  3. package/actionsExecutor/StorageActions.ts +110 -0
  4. package/actionsExecutor/feedDecorator.ts +171 -0
  5. package/actionsExecutor/screenResolver.ts +11 -0
  6. package/analyticsUtils/AnalyticsEvents/helper.ts +81 -0
  7. package/analyticsUtils/AnalyticsEvents/sendHeaderClickEvent.ts +1 -1
  8. package/analyticsUtils/AnalyticsEvents/sendMenuClickEvent.ts +1 -2
  9. package/analyticsUtils/AnalyticsEvents/sendOnClickEvent.ts +14 -4
  10. package/analyticsUtils/__tests__/analyticsUtils.test.js +14 -0
  11. package/analyticsUtils/events.ts +8 -0
  12. package/analyticsUtils/index.tsx +4 -3
  13. package/analyticsUtils/manager.ts +1 -1
  14. package/appUtils/HooksManager/Hook.ts +4 -4
  15. package/appUtils/HooksManager/index.ts +11 -1
  16. package/appUtils/accessibilityManager/index.ts +3 -3
  17. package/appUtils/contextKeysManager/contextResolver.ts +14 -1
  18. package/appUtils/playerManager/OverlayObserver/OverlaysObserver.ts +0 -15
  19. package/appUtils/playerManager/useChapterMarker.tsx +0 -1
  20. package/appUtils/playerManager/usePlayerControllerSetup.tsx +16 -0
  21. package/arrayUtils/index.ts +1 -1
  22. package/componentsUtils/__tests__/isTabsScreen.test.ts +38 -0
  23. package/componentsUtils/index.ts +4 -1
  24. package/configurationUtils/__tests__/manifestKeyParser.test.ts +547 -0
  25. package/configurationUtils/manifestKeyParser.ts +57 -32
  26. package/focusManager/FocusManager.ts +26 -16
  27. package/focusManager/Tree.ts +25 -21
  28. package/focusManager/__tests__/FocusManager.test.ts +50 -8
  29. package/manifestUtils/defaultManifestConfigurations/player.js +8 -0
  30. package/package.json +2 -2
  31. package/playerUtils/getPlayerActionButtons.ts +1 -1
  32. package/playerUtils/index.ts +51 -0
  33. package/reactHooks/autoscrolling/__tests__/useTrackedView.test.tsx +13 -12
  34. package/reactHooks/cell-click/index.ts +8 -1
  35. package/reactHooks/feed/__tests__/useBatchLoading.test.tsx +88 -39
  36. package/reactHooks/feed/__tests__/useFeedLoader.test.tsx +20 -0
  37. package/reactHooks/feed/useBatchLoading.ts +1 -1
  38. package/reactHooks/feed/useFeedLoader.tsx +12 -5
  39. package/reactHooks/feed/usePipesCacheReset.ts +1 -1
  40. package/reactHooks/layout/isTablet/index.ts +12 -5
  41. package/reactHooks/navigation/index.ts +7 -3
  42. package/reactHooks/navigation/useIsScreenActive.ts +9 -5
  43. package/reactHooks/navigation/useRoute.ts +7 -2
  44. package/reactHooks/navigation/useScreenStateStore.ts +8 -0
  45. package/reactHooks/screen/useScreenContext.ts +1 -1
  46. package/reactHooks/state/__tests__/ZStoreProvider.test.tsx +2 -1
  47. package/riverComponetsMeasurementProvider/index.tsx +1 -1
  48. package/services/js2native.ts +1 -0
  49. package/storage/ScreenSingleValueProvider.ts +201 -0
  50. package/storage/ScreenStateMultiSelectProvider.ts +290 -0
  51. package/storage/StorageMultiSelectProvider.ts +192 -0
  52. package/storage/StorageSingleSelectProvider.ts +108 -0
  53. package/testUtils/index.tsx +8 -7
  54. package/time/BackgroundTimer.ts +5 -3
  55. package/utils/index.ts +4 -0
@@ -4,9 +4,12 @@ import {
4
4
  ANALYTICS_COMPONENT_EVENTS,
5
5
  ANALYTICS_CORE_EVENTS,
6
6
  ANALYTICS_ENTRY_EVENTS,
7
+ ANALYTICS_PREFERENCES_EVENTS,
7
8
  DOWNLOADS_EVENTS,
8
9
  } from "../events";
9
10
  import { isEmptyOrNil } from "../../cellUtils";
11
+ import { get } from "lodash";
12
+ import { StorageMultiSelectProvider } from "@applicaster/zapp-react-native-utils/storage/StorageMultiSelectProvider";
10
13
 
11
14
  export enum OfflineItemState {
12
15
  notExist = "NOT_EXISTS",
@@ -102,6 +105,84 @@ export function eventForComponent(
102
105
  return analyticsProps;
103
106
  }
104
107
 
108
+ /**
109
+ * Checks if an item is currently selected in localStorage based on its actions
110
+ * @param item - The item to check
111
+ * @returns boolean indicating if the item is currently selected
112
+ */
113
+ function isItemPreviouslySelected(item: any): boolean {
114
+ const actions = item?.extensions?.tap_actions?.actions;
115
+
116
+ if (!actions) {
117
+ return false;
118
+ }
119
+
120
+ const localStorageAction = actions.find(
121
+ (action) => action?.type === "localStorageToggleFlag"
122
+ );
123
+
124
+ if (!localStorageAction?.options?.key) {
125
+ return false;
126
+ }
127
+
128
+ const keyNamespace = localStorageAction.options.key;
129
+
130
+ const tag = localStorageAction.options?.selector
131
+ ? get(item, localStorageAction.options.selector)
132
+ : (item.extensions?.tag ?? item.id);
133
+
134
+ if (!tag) {
135
+ return false;
136
+ }
137
+
138
+ try {
139
+ const multiSelectProvider =
140
+ StorageMultiSelectProvider.getProvider(keyNamespace);
141
+
142
+ const selectedItems = multiSelectProvider.getSelectedItems();
143
+
144
+ return selectedItems.includes(tag);
145
+ } catch (error) {
146
+ return false;
147
+ }
148
+ }
149
+
150
+ export function getLocalStorageSetPayload(extraProps) {
151
+ const { item } = extraProps;
152
+
153
+ const hasLocalStorageSetAction = item?.extensions?.tap_actions?.actions?.some(
154
+ (action) => action?.type === "localStorageSet"
155
+ );
156
+
157
+ if (!hasLocalStorageSetAction) {
158
+ return null;
159
+ }
160
+
161
+ return {
162
+ [ANALYTICS_PREFERENCES_EVENTS.ITEM_SELECTED_STATUS]: true,
163
+ };
164
+ }
165
+
166
+ export function getLocalStorageToggleFlagPayload(extraProps) {
167
+ const { item } = extraProps;
168
+
169
+ const hasLocalStorageToggleAction =
170
+ item?.extensions?.tap_actions?.actions?.some(
171
+ (action) => action?.type === "localStorageToggleFlag"
172
+ );
173
+
174
+ if (!hasLocalStorageToggleAction) {
175
+ return null;
176
+ }
177
+
178
+ const previouslySelected = isItemPreviouslySelected(item);
179
+
180
+ return {
181
+ [ANALYTICS_PREFERENCES_EVENTS.ITEM_SELECTED_STATUS]: !previouslySelected,
182
+ [ANALYTICS_PREFERENCES_EVENTS.PREVIOUS_SELECTED_STATE]: previouslySelected,
183
+ };
184
+ }
185
+
105
186
  export function playEventForType(item) {
106
187
  const itemType = item?.type && item.type?.value;
107
188
 
@@ -4,7 +4,7 @@ import { postAnalyticEvent } from "../manager";
4
4
  import { ANALYTICS_CORE_EVENTS } from "../events";
5
5
 
6
6
  type SendHeaderClickEventProps = {
7
- extraProps: Record<string, any>;
7
+ extraProps: ExtraProps;
8
8
  component?: ZappUIComponent;
9
9
  zappPipesData?: ZappPipesData;
10
10
  item?: ZappEntry;
@@ -1,11 +1,10 @@
1
- /// <reference types="../../" />
2
1
  import { log_error, log_debug } from "../logger";
3
2
  import { replaceAnalyticsPropsNils } from "./helper";
4
3
  import { postAnalyticEvent } from "../manager";
5
4
 
6
5
  import { ANALYTICS_CORE_EVENTS } from "../events";
7
6
 
8
- type AnalyticsDefaultHelperProperties = {
7
+ declare type AnalyticsDefaultHelperProperties = {
9
8
  analyticsScreenData: AnalyticsScreenProperties;
10
9
  extraProps: any;
11
10
  props;
@@ -1,13 +1,13 @@
1
1
  import { log_error, log_debug } from "../logger";
2
-
3
- import { ANALYTICS_CORE_EVENTS } from "../events";
4
-
2
+ import { ANALYTICS_CORE_EVENTS, ACTION_TYPE } from "../events";
5
3
  import { postAnalyticEvent } from "../manager";
6
4
  import {
7
5
  replaceAnalyticsPropsNils,
8
6
  eventForEntry,
9
7
  eventForComponent,
10
8
  extensionsEvents,
9
+ getLocalStorageSetPayload,
10
+ getLocalStorageToggleFlagPayload,
11
11
  } from "./helper";
12
12
 
13
13
  declare type AnalyticsDefaultHelperProperties = {
@@ -26,7 +26,16 @@ export const sendOnClickEvent = ({
26
26
  const castedExtraProps: ExtraProps = extraProps;
27
27
  const componentData = component || extraProps.component;
28
28
  const data = zappPipesData || extraProps.zappPipesData;
29
- const eventName = ANALYTICS_CORE_EVENTS.TAP_CELL;
29
+
30
+ const actionCellPayload =
31
+ extraProps?.item?.type?.value === ACTION_TYPE
32
+ ? getLocalStorageSetPayload(extraProps) ||
33
+ getLocalStorageToggleFlagPayload(extraProps)
34
+ : null;
35
+
36
+ const eventName = actionCellPayload
37
+ ? ANALYTICS_CORE_EVENTS.TAP_SELECTABLE_CELL
38
+ : ANALYTICS_CORE_EVENTS.TAP_CELL;
30
39
 
31
40
  if (!analyticsScreenData) {
32
41
  log_error(
@@ -44,6 +53,7 @@ export const sendOnClickEvent = ({
44
53
  ...replaceAnalyticsPropsNils({
45
54
  ...analyticsScreenData,
46
55
  }),
56
+ ...actionCellPayload,
47
57
  };
48
58
 
49
59
  if (analyticsCustomProperties) {
@@ -3,8 +3,22 @@ import { ANALYTICS_CORE_EVENTS } from "../events";
3
3
 
4
4
  jest.mock("@applicaster/zapp-react-native-utils/reactUtils", () => ({
5
5
  isWeb: jest.fn(),
6
+ platformSelect: jest.fn(
7
+ (options) => options.android || options.ios || options.web
8
+ ),
6
9
  }));
7
10
 
11
+ jest.mock(
12
+ "@applicaster/zapp-react-native-bridge/ZappStorage/StorageMultiSelectProvider",
13
+ () => ({
14
+ StorageMultiSelectProvider: {
15
+ getProvider: jest.fn(() => ({
16
+ getSelectedItems: jest.fn(() => []),
17
+ })),
18
+ },
19
+ })
20
+ );
21
+
8
22
  const mock_postAnalyticEvent = jest.fn();
9
23
  const mock_startAnalyticsTimedEvent = jest.fn();
10
24
  const mock_endAnalyticsTimedEvent = jest.fn();
@@ -17,8 +17,11 @@ export const SCREEN_VIEW_EVENTS = {
17
17
  TIME_ON_SCREEN: "time_on_screen",
18
18
  };
19
19
 
20
+ export const ACTION_TYPE = "action";
21
+
20
22
  export const TAPPING_EVENTS = {
21
23
  TAP_CELL: "tap_cell",
24
+ TAP_SELECTABLE_CELL: "tap_selectable_cell",
22
25
  TAP_MENU: "tap_menu",
23
26
  TAP_NAVBAR_BACK_BUTTON: "tap_navbar_back_button",
24
27
  };
@@ -99,6 +102,11 @@ export const ANALYTICS_COMPONENT_EVENTS = {
99
102
  COMPONENT_SOURCE: "component_source",
100
103
  };
101
104
 
105
+ export const ANALYTICS_PREFERENCES_EVENTS = {
106
+ ITEM_SELECTED_STATUS: "item_selected_status",
107
+ PREVIOUS_SELECTED_STATE: "previous_selected_state",
108
+ };
109
+
102
110
  // ---------------- EVENTS ---------------------
103
111
  export const AD_EVENT = {
104
112
  ad_break_start: "player_ad_break_start",
@@ -1,3 +1,4 @@
1
+ /// <reference types="@applicaster/zapp-react-native-utils" />
1
2
  import * as R from "ramda";
2
3
  import * as React from "react";
3
4
  import { isWeb } from "@applicaster/zapp-react-native-utils/reactUtils";
@@ -30,7 +31,7 @@ import { ANALYTICS_CORE_EVENTS } from "./events";
30
31
  import { noop } from "../functionUtils";
31
32
 
32
33
  type ComponentWithChildrenProps = {
33
- children: React.ReactElement;
34
+ children: React.ReactChildren;
34
35
  };
35
36
 
36
37
  export function sendSelectCellEvent(item, component, headerTitle, itemIndex) {
@@ -119,11 +120,11 @@ export function getAnalyticsFunctions({
119
120
  export const AnalyticsContext =
120
121
  React.createContext<GetAnalyticsFunctions>(noop);
121
122
 
122
- export function AnalyticsProvider({ children }: ComponentWithChildrenProps) {
123
+ export function AnalyticsProvider(props: ComponentWithChildrenProps) {
123
124
  return (
124
125
  // @ts-ignore - this is a valid context provider
125
126
  <AnalyticsContext.Provider value={getAnalyticsFunctions}>
126
- {children}
127
+ {props?.children}
127
128
  </AnalyticsContext.Provider>
128
129
  );
129
130
  }
@@ -1,7 +1,7 @@
1
1
  /* eslint-disable @typescript-eslint/no-use-before-define */
2
2
  import * as R from "ramda";
3
3
  import { NativeModules } from "react-native";
4
- import { ANALYTICS_CORE_EVENTS } from "./events";
4
+ import { ANALYTICS_CORE_EVENTS } from "@applicaster/zapp-react-native-utils/analyticsUtils/events";
5
5
 
6
6
  import { analyticsUtilsLogger } from "./logger";
7
7
 
@@ -65,10 +65,6 @@ export class Hook implements HookInterface {
65
65
  event: (typeof HOOKS_EVENTS)[keyof typeof HOOKS_EVENTS],
66
66
  ...args
67
67
  ) {
68
- if (this.state === hookState(HOOKS_EVENTS.CANCEL)) {
69
- return;
70
- }
71
-
72
68
  this.state = hookState(event);
73
69
  this.manager.subscriber.invokeHandler(event, ...args);
74
70
  }
@@ -198,4 +194,8 @@ export class Hook implements HookInterface {
198
194
  R.eqProps("weight", nextHook, this)
199
195
  );
200
196
  }
197
+
198
+ isCancelled(): boolean {
199
+ return this.state === hookState(HOOKS_EVENTS.CANCEL);
200
+ }
201
201
  }
@@ -255,7 +255,7 @@ export function HooksManager({
255
255
  * @param {Array<Hook>} restOfHooks to run
256
256
  * @returns {function} callback function
257
257
  */
258
- function hookCallback(hookPlugin, restOfHooks, initialPayload) {
258
+ function hookCallback(hookPlugin: Hook, restOfHooks: Hook[], initialPayload) {
259
259
  /**
260
260
  * callback invoked after a hook is executed
261
261
  * @param {object} options
@@ -273,6 +273,16 @@ export function HooksManager({
273
273
  }) {
274
274
  let callback = callbackArg;
275
275
 
276
+ if (hookPlugin.isCancelled()) {
277
+ logHookEvent(
278
+ hooksManagerLogger.info,
279
+ `hookCallback: hook was cancelled: ${hookPlugin["identifier"]}`,
280
+ {}
281
+ );
282
+
283
+ return;
284
+ }
285
+
276
286
  if (error) {
277
287
  logHookEvent(
278
288
  hooksManagerLogger.error,
@@ -1,9 +1,9 @@
1
1
  import { BehaviorSubject } from "rxjs";
2
2
  import { accessibilityManagerLogger as logger } from "./logger";
3
- import { TTSManager } from "../platform/platformUtils";
3
+ import { TTSManager } from "../platform";
4
4
  import { BUTTON_ACCESSIBILITY_KEYS } from "./const";
5
5
  import { AccessibilityRole } from "react-native";
6
- import _ from "lodash";
6
+ import { toString } from "../../utils";
7
7
 
8
8
  export class AccessibilityManager {
9
9
  private static _instance: AccessibilityManager | null = null;
@@ -137,7 +137,7 @@ export class AccessibilityManager {
137
137
  }
138
138
 
139
139
  public getButtonAccessibilityProps(name: string): AccessibilityProps {
140
- const buttonName = _.toString(name);
140
+ const buttonName = toString(name);
141
141
 
142
142
  const buttonConfig = BUTTON_ACCESSIBILITY_KEYS[buttonName];
143
143
 
@@ -1,10 +1,11 @@
1
1
  import { ContextKeysManager } from "./index";
2
2
  import * as R from "ramda";
3
3
 
4
- interface IResolver {
4
+ export interface IResolver {
5
5
  resolve: (string) => Promise<string | number | object>;
6
6
  }
7
7
 
8
+ // TODO: Rename to ObjectKeyResolver or similar
8
9
  export class EntryResolver implements IResolver {
9
10
  entry: ZappEntry;
10
11
 
@@ -21,6 +22,18 @@ export class EntryResolver implements IResolver {
21
22
  }
22
23
  }
23
24
 
25
+ // TODO: Move to proper place
26
+
27
+ export class ScreenStateResolver implements IResolver {
28
+ constructor(private screenStateStore: ScreenStateStore) {}
29
+
30
+ async resolve(key: string) {
31
+ const screenState = this.screenStateStore.getState().data;
32
+
33
+ return screenState?.[key];
34
+ }
35
+ }
36
+
24
37
  export class ContextResolver implements IResolver {
25
38
  resolve = async (compositeKey: string) =>
26
39
  ContextKeysManager.instance.getKey(compositeKey);
@@ -18,13 +18,6 @@ export const { log_verbose, log_debug, log_info, log_error } = createLogger({
18
18
  parent: utilsLogger,
19
19
  });
20
20
 
21
- type ActionChapter = {
22
- type: string;
23
- options?: {
24
- title: string;
25
- };
26
- };
27
-
28
21
  type ChapterMarkerOriginal = {
29
22
  id: string;
30
23
  title: string;
@@ -33,14 +26,6 @@ type ChapterMarkerOriginal = {
33
26
  actions: ActionChapter[];
34
27
  };
35
28
 
36
- export type ChapterMarkerEvent = {
37
- id: string;
38
- title: string;
39
- start_time: number;
40
- end_time: number;
41
- actions: ActionChapter[];
42
- };
43
-
44
29
  export type TitleSummaryEvent = {
45
30
  title: string | number;
46
31
  summary: string | number;
@@ -1,4 +1,3 @@
1
- import { ChapterMarkerEvent } from "./OverlayObserver/OverlaysObserver";
2
1
  import { usePlayer } from "./usePlayer";
3
2
  import * as React from "react";
4
3
 
@@ -5,6 +5,9 @@ import { playerManager } from "./index";
5
5
  import { useValidatePlayerConfig } from "../../playerUtils/useValidatePlayerConfig";
6
6
  import { PlayerRole } from "./conts";
7
7
  import { isAppleTV } from "@applicaster/zapp-react-native-ui-components/Helpers/Platform";
8
+ import { TVSeekController } from "../../reactHooks/player/TVSeekControlller/TVSeekController";
9
+ import { KeyInputHandler } from "../keyInputHandler/KeyInputHandler";
10
+ import { isTV } from "../../reactUtils";
8
11
 
9
12
  // TODO: Rename to ControllerType
10
13
  export const usePlayerControllerSetup = ({
@@ -76,5 +79,18 @@ export const usePlayerControllerSetup = ({
76
79
  };
77
80
  }, [playerId, playerController]);
78
81
 
82
+ useEffect(() => {
83
+ if (!isTV()) {
84
+ return;
85
+ }
86
+
87
+ if (playerController) {
88
+ const seekController = new TVSeekController(playerController);
89
+ playerController.seekController = seekController;
90
+
91
+ return KeyInputHandler.getInstance().addListener(seekController);
92
+ }
93
+ }, [playerController]);
94
+
79
95
  return playerController;
80
96
  };
@@ -93,7 +93,7 @@ export const isIndexInRange = (index: number, length: number): boolean => {
93
93
  export const makeListOfIndexes = (size: number): number[] =>
94
94
  Array.from({ length: size }, (_, index) => index);
95
95
 
96
- export const makeListOf = (value: unknown, size: number): number[] => {
96
+ export const makeListOf = <T>(value: T, size: number): T[] => {
97
97
  return Array(size).fill(value);
98
98
  };
99
99
 
@@ -0,0 +1,38 @@
1
+ import { isTabsScreen } from "..";
2
+
3
+ describe("isTabsScreen", () => {
4
+ it("should return true if the component type is 'screen-picker-qb-tv' and tabs_screen=true", () => {
5
+ const item = { component_type: "screen-picker-qb-tv", tabs_screen: true };
6
+ expect(isTabsScreen(item)).toBe(true);
7
+ });
8
+
9
+ it("should return true if the component type is 'screen-picker-qb-tv' and tabs_screen=false", () => {
10
+ const item = { component_type: "screen-picker-qb-tv", tabs_screen: false };
11
+ expect(isTabsScreen(item)).toBe(false);
12
+ });
13
+
14
+ it("should return false if the component type is not 'screen-picker-qb-tv'", () => {
15
+ const item = { component_type: "other-component" };
16
+ expect(isTabsScreen(item)).toBe(false);
17
+ });
18
+
19
+ it("should return false if the component type is undefined", () => {
20
+ const item = { component_type: undefined };
21
+ expect(isTabsScreen(item)).toBe(false);
22
+ });
23
+
24
+ it("should return false if the item is null", () => {
25
+ const item = null;
26
+ expect(isTabsScreen(item)).toBe(false);
27
+ });
28
+
29
+ it("should return false if the item is undefined", () => {
30
+ const item = undefined;
31
+ expect(isTabsScreen(item)).toBe(false);
32
+ });
33
+
34
+ it("should return false if the item is an empty object", () => {
35
+ const item = {};
36
+ expect(isTabsScreen(item)).toBe(false);
37
+ });
38
+ });
@@ -5,7 +5,7 @@ const EMPTY_GROUP_COMPONENT = "empty_group_component";
5
5
 
6
6
  const GALLERY = "gallery-qb";
7
7
 
8
- const SCREEN_PICKER = "screen-picker-qb-tv";
8
+ export const SCREEN_PICKER = "screen-picker-qb-tv";
9
9
 
10
10
  const HORIZONTAL_LIST = "horizontal_list_qb";
11
11
 
@@ -37,3 +37,6 @@ export const isEmptyGroup = (item): boolean =>
37
37
  export const isGroupInfo = (item): boolean =>
38
38
  item?.component_type === GROUP_INFO ||
39
39
  item?.component_type === GROUP_INFO_OLD;
40
+
41
+ export const isTabsScreen = (item): boolean =>
42
+ isScreenPicker(item) && item?.tabs_screen;