@applicaster/zapp-react-native-utils 14.0.0-alpha.1661204539 → 14.0.0-alpha.1718713411

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 (65) hide show
  1. package/actionsExecutor/ActionExecutorContext.tsx +82 -53
  2. package/analyticsUtils/AnalyticsEvents/helper.ts +81 -0
  3. package/analyticsUtils/AnalyticsEvents/sendOnClickEvent.ts +14 -4
  4. package/analyticsUtils/__tests__/analyticsUtils.test.js +14 -0
  5. package/analyticsUtils/events.ts +8 -0
  6. package/appUtils/accessibilityManager/index.ts +5 -2
  7. package/appUtils/contextKeysManager/contextResolver.ts +1 -15
  8. package/appUtils/playerManager/OverlayObserver/OverlaysObserver.ts +0 -15
  9. package/appUtils/playerManager/useChapterMarker.tsx +0 -1
  10. package/appUtils/playerManager/usePlayerControllerSetup.tsx +16 -0
  11. package/arrayUtils/__tests__/isEmptyArray.test.ts +63 -0
  12. package/arrayUtils/__tests__/isFilledArray.test.ts +1 -1
  13. package/arrayUtils/index.ts +7 -2
  14. package/audioPlayerUtils/__tests__/getArtworkImage.test.ts +144 -0
  15. package/audioPlayerUtils/__tests__/getBackgroundImage.test.ts +72 -0
  16. package/audioPlayerUtils/__tests__/getImageFromEntry.test.ts +110 -0
  17. package/audioPlayerUtils/assets/index.ts +2 -0
  18. package/audioPlayerUtils/index.ts +242 -0
  19. package/conf/player/__tests__/selectors.test.ts +34 -0
  20. package/conf/player/selectors.ts +10 -0
  21. package/configurationUtils/__tests__/configurationUtils.test.js +0 -31
  22. package/configurationUtils/__tests__/getMediaItems.test.ts +65 -0
  23. package/configurationUtils/__tests__/imageSrcFromMediaItem.test.ts +34 -0
  24. package/configurationUtils/index.ts +63 -34
  25. package/focusManager/FocusManager.ts +26 -16
  26. package/focusManager/Tree.ts +25 -21
  27. package/focusManager/__tests__/FocusManager.test.ts +50 -8
  28. package/manifestUtils/_internals/getDefaultConfiguration.js +28 -0
  29. package/manifestUtils/{_internals.js → _internals/index.js} +2 -25
  30. package/manifestUtils/createConfig.js +4 -1
  31. package/manifestUtils/defaultManifestConfigurations/player.js +2431 -1244
  32. package/manifestUtils/index.js +4 -0
  33. package/manifestUtils/keys.js +12 -0
  34. package/manifestUtils/progressBar/__tests__/mobileProgressBar.test.js +0 -30
  35. package/manifestUtils/sharedConfiguration/screenPicker/stylesFields.js +7 -2
  36. package/package.json +2 -2
  37. package/playerUtils/__tests__/configurationUtils.test.ts +1 -65
  38. package/playerUtils/__tests__/getPlayerActionButtons.test.ts +54 -0
  39. package/playerUtils/_internals/__tests__/utils.test.ts +71 -0
  40. package/playerUtils/_internals/index.ts +1 -0
  41. package/playerUtils/_internals/utils.ts +31 -0
  42. package/playerUtils/configurationUtils.ts +0 -44
  43. package/playerUtils/getPlayerActionButtons.ts +17 -0
  44. package/playerUtils/index.ts +59 -0
  45. package/playerUtils/useValidatePlayerConfig.tsx +22 -19
  46. package/reactHooks/cell-click/index.ts +1 -5
  47. package/reactHooks/feed/useBatchLoading.ts +3 -3
  48. package/reactHooks/feed/useFeedLoader.tsx +6 -13
  49. package/reactHooks/feed/usePipesCacheReset.ts +1 -1
  50. package/reactHooks/layout/isTablet/index.ts +12 -5
  51. package/reactHooks/navigation/useIsScreenActive.ts +9 -5
  52. package/reactHooks/screen/useScreenContext.ts +1 -1
  53. package/reactHooks/state/__tests__/ZStoreProvider.test.tsx +2 -1
  54. package/riverComponetsMeasurementProvider/index.tsx +1 -1
  55. package/services/js2native.ts +1 -0
  56. package/time/BackgroundTimer.ts +5 -3
  57. package/utils/index.ts +16 -1
  58. package/actionsExecutor/ScreenActions.ts +0 -90
  59. package/actionsExecutor/StorageActions.ts +0 -110
  60. package/actionsExecutor/screenResolver.ts +0 -8
  61. package/playerUtils/configurationGenerator.ts +0 -2572
  62. package/storage/ScreenSingleValueProvider.ts +0 -92
  63. package/storage/ScreenStateMultiSelectProvider.ts +0 -119
  64. package/storage/StorageMultiSelectProvider.ts +0 -192
  65. package/storage/StorageSingleSelectProvider.ts +0 -108
@@ -8,7 +8,6 @@ import { reactHooksLogger } from "../logger";
8
8
  import { shouldDispatchData, useIsInitialRender } from "../utils";
9
9
  import { useInflatedUrl } from "./useInflatedUrl";
10
10
  import { useRoute } from "../navigation";
11
- import { useScreenResolvers } from "@applicaster/zapp-react-native-utils/actionsExecutor/screenResolver";
12
11
 
13
12
  const logger = reactHooksLogger.addSubsystem("useFeedLoader");
14
13
 
@@ -51,8 +50,7 @@ export const useFeedLoader = ({
51
50
 
52
51
  const isInitialRender = useIsInitialRender();
53
52
  const dispatch = useDispatch();
54
- const { screenData, pathname } = useRoute();
55
- const resolvers = useScreenResolvers(pathname);
53
+ const { screenData } = useRoute();
56
54
 
57
55
  const callableFeedUrl = useInflatedUrl({ feedUrl, mapping });
58
56
 
@@ -71,12 +69,11 @@ export const useFeedLoader = ({
71
69
  silentRefresh,
72
70
  callback,
73
71
  riverId,
74
- resolvers,
75
72
  })
76
73
  );
77
74
  }
78
75
  },
79
- [callableFeedUrl, resolvers]
76
+ [callableFeedUrl]
80
77
  );
81
78
 
82
79
  const loadNext: FeedLoaderResponse["loadNext"] = React.useCallback(() => {
@@ -89,12 +86,11 @@ export const useFeedLoader = ({
89
86
  silentRefresh: true,
90
87
  parentFeed: callableFeedUrl,
91
88
  riverId,
92
- resolvers,
93
89
  })
94
90
  );
95
91
  }
96
92
  }
97
- }, [callableFeedUrl, currentFeed?.data?.next, resolvers]);
93
+ }, [callableFeedUrl, currentFeed?.data?.next]);
98
94
 
99
95
  useEffect(() => {
100
96
  if (
@@ -106,7 +102,6 @@ export const useFeedLoader = ({
106
102
  ...pipesOptions,
107
103
  clearCache: true,
108
104
  riverId,
109
- resolvers,
110
105
  })
111
106
  );
112
107
  } else if (!callableFeedUrl) {
@@ -131,16 +126,14 @@ export const useFeedLoader = ({
131
126
  jsOnly: true,
132
127
  });
133
128
  }
134
- }, [resolvers]);
129
+ }, []);
135
130
 
136
131
  // Reload feed when feedUrl changes, unless skipLoading is true
137
132
  useEffect(() => {
138
133
  if (!isInitialRender && callableFeedUrl && !pipesOptions.skipLoading) {
139
- dispatch(
140
- loadPipesData(callableFeedUrl, { ...pipesOptions, riverId, resolvers })
141
- );
134
+ dispatch(loadPipesData(callableFeedUrl, { ...pipesOptions, riverId }));
142
135
  }
143
- }, [callableFeedUrl, resolvers]);
136
+ }, [callableFeedUrl]);
144
137
 
145
138
  return React.useMemo(() => {
146
139
  if (!callableFeedUrl || !feedUrl) {
@@ -5,7 +5,7 @@ import { getDatasourceUrl } from "@applicaster/zapp-react-native-ui-components/D
5
5
  import { usePipesContexts } from "@applicaster/zapp-react-native-ui-components/Decorators/RiverFeedLoader/utils/usePipesContexts";
6
6
  import { clearPipesData } from "@applicaster/zapp-react-native-redux/ZappPipes";
7
7
 
8
- import { useRoute } from "../navigation/useRoute";
8
+ import { useRoute } from "../navigation";
9
9
 
10
10
  /**
11
11
  * reset river components cache when screen is unmounted
@@ -1,21 +1,28 @@
1
1
  import { NativeModules, Platform } from "react-native";
2
2
 
3
+ export const isAndroidTablet = () => {
4
+ const { initialProps } = NativeModules.QuickBrickCommunicationModule;
5
+
6
+ return initialProps?.is_tablet;
7
+ };
8
+
3
9
  /**
4
10
  * Determines wether the given device is a tablet based on dimensions, orientation, and platform
5
11
  * @param {Object} dimensions - Dimensions object passed to the function
6
12
  * @param {String} orientation - Orientation enum passed to the function
7
13
  * @returns {Boolean} isTablet - returns whether the given device is a tablet
8
14
  */
9
- export const isTablet = (dimensions, orientation) => {
15
+ export const isTablet = (
16
+ dimensions?: { width: number; height: number },
17
+ orientation?: string
18
+ ) => {
10
19
  if (Platform?.OS === "ios") {
11
20
  return Platform?.isPad;
12
21
  } else if (Platform?.OS === "android") {
13
- const { initialProps } = NativeModules.QuickBrickCommunicationModule;
14
-
15
- return initialProps?.is_tablet;
22
+ return isAndroidTablet();
16
23
  }
17
24
 
18
- const { width } = dimensions;
25
+ const { width } = dimensions || {};
19
26
 
20
27
  if (width < 600) return false;
21
28
  if (width >= 600 && width < 840) return orientation === "portrait";
@@ -1,3 +1,4 @@
1
+ import { ROUTE_TYPES } from "@applicaster/zapp-react-native-utils/navigationUtils/routeTypes";
1
2
  import { useNavigation } from "./useNavigation";
2
3
  import { usePathname } from "./usePathname";
3
4
 
@@ -6,11 +7,14 @@ export const useIsScreenActive = () => {
6
7
  const pathname = usePathname();
7
8
  const { currentRoute, videoModalState } = useNavigation();
8
9
 
9
- if (
10
- videoModalState.visible &&
11
- ["FULLSCREEN", "MAXIMIZED", "PIP"].includes(videoModalState.mode)
12
- ) {
13
- return false;
10
+ if (videoModalState.visible) {
11
+ if (pathname.includes(ROUTE_TYPES.VIDEO_MODAL)) {
12
+ return true;
13
+ }
14
+
15
+ if (["FULLSCREEN", "MAXIMIZED", "PIP"].includes(videoModalState.mode)) {
16
+ return false;
17
+ }
14
18
  }
15
19
 
16
20
  return pathname === currentRoute;
@@ -2,7 +2,7 @@ import { useContext, useMemo } from "react";
2
2
 
3
3
  import { useModalNavigationContext } from "@applicaster/zapp-react-native-ui-components/Contexts/ModalNavigationContext";
4
4
  import { useNestedNavigationContext } from "@applicaster/zapp-react-native-ui-components/Contexts/NestedNavigationContext";
5
- import { useNavigation } from "../navigation/useNavigation";
5
+ import { useNavigation } from "../navigation";
6
6
 
7
7
  import { ScreenContext } from "@applicaster/zapp-react-native-ui-components/Contexts/ScreenContext";
8
8
  import { ScreenDataContext } from "@applicaster/zapp-react-native-ui-components/Contexts/ScreenDataContext";
@@ -1,7 +1,8 @@
1
+ /* eslint-disable no-console */
1
2
  import React from "react";
2
3
  import { render, screen } from "@testing-library/react-native";
3
4
  import { Text } from "react-native";
4
- import { ZStoreProvider, useZStore } from "../ZStoreProvider";
5
+ import { useZStore, ZStoreProvider } from "../ZStoreProvider";
5
6
  import { useStore } from "zustand";
6
7
 
7
8
  interface TestState {
@@ -3,7 +3,7 @@ import { NativeModules, StyleSheet, View } from "react-native";
3
3
  import { getXray } from "@applicaster/zapp-react-native-utils/logger";
4
4
 
5
5
  import { isApplePlatform, isWeb } from "../reactUtils";
6
- import { useRivers } from "../reactHooks/state";
6
+ import { useRivers } from "../reactHooks";
7
7
 
8
8
  const layoutReducer = (state, { payload }) => {
9
9
  return state.map((item, index, _state) => ({
@@ -496,6 +496,7 @@ async function removeStorageListenerHandler(payload: { listenerId?: string }) {
496
496
  function log({ level, messages }) {
497
497
  try {
498
498
  const parsedMessages = parseJsonIfNeeded(messages);
499
+ // eslint-disable-next-line no-console
499
500
  const logFn = console[level] || console.log;
500
501
 
501
502
  if (Array.isArray(parsedMessages)) {
@@ -13,13 +13,15 @@ class BackgroundTimer {
13
13
 
14
14
  const EventEmitter = platformSelect({
15
15
  android: DeviceEventEmitter,
16
- ios: undefined,
16
+ android_tv: DeviceEventEmitter,
17
+ amazon: DeviceEventEmitter, // probably does not exist and uses android_tv
17
18
  default: undefined,
18
19
  });
19
20
 
20
21
  EventEmitter?.addListener("BackgroundTimer.timer.fired", (id: number) => {
21
- if (this.callbacks[id]) {
22
- const callback = this.callbacks[id];
22
+ const callback = this.callbacks[id];
23
+
24
+ if (callback) {
23
25
  delete this.callbacks[id];
24
26
  callback();
25
27
  }
package/utils/index.ts CHANGED
@@ -2,4 +2,19 @@ export { chunk } from "./chunk";
2
2
 
3
3
  export { times } from "./times";
4
4
 
5
- export { cloneDeep as clone, flatten, drop, size, isNil } from "lodash";
5
+ export {
6
+ cloneDeep as clone,
7
+ flatten,
8
+ drop,
9
+ size,
10
+ isNil,
11
+ isEmpty,
12
+ get,
13
+ has,
14
+ flatMap,
15
+ difference,
16
+ take,
17
+ map,
18
+ trim,
19
+ toString,
20
+ } from "lodash";
@@ -1,90 +0,0 @@
1
- // import { localStorage } from "@applicaster/zapp-react-native-bridge/ZappStorage/LocalStorage";
2
-
3
- import { log_error, log_info } from "./ActionExecutorContext";
4
- import { ActionResult } from "./ActionExecutor";
5
- import { get } from "lodash";
6
-
7
- import { onMaxTagsReached } from "./StorageActions";
8
- import { ScreenMultiSelectProvider } from "../storage/ScreenStateMultiSelectProvider";
9
-
10
- export const screenSetVariable = (
11
- _screenRoute: string,
12
- _key: string,
13
- _value: string
14
- ) => {};
15
-
16
- export const screenToggleFlag = async (
17
- screenRoute: string,
18
- context: Record<string, any>,
19
- action: ActionType
20
- ) => {
21
- if (!context) {
22
- log_error("handleAction: localStorageToggleFlag action missing context");
23
-
24
- return ActionResult.Error;
25
- }
26
-
27
- const entry = context?.entry as ZappEntry;
28
-
29
- if (!entry) {
30
- log_error(
31
- "handleAction: localStorageToggleFlag action missing entry. Entry is required to get the tag."
32
- );
33
-
34
- return ActionResult.Error;
35
- }
36
-
37
- const tag = action.options?.selector
38
- ? get(entry, action.options.selector)
39
- : (entry.extensions?.tag ?? entry.id);
40
-
41
- const keyNamespace = action.options?.key;
42
-
43
- if (keyNamespace && tag) {
44
- const multiSelectProvider = ScreenMultiSelectProvider.getProvider(
45
- keyNamespace,
46
- screenRoute
47
- );
48
-
49
- const selectedItems = await multiSelectProvider.getSelectedAsync();
50
- const isTagInSelectedItems = selectedItems.includes(tag);
51
-
52
- log_info(
53
- `handleAction: screenToggleFlag event will ${
54
- isTagInSelectedItems ? "remove" : "add"
55
- } tag: ${tag} for keyNamespace: ${keyNamespace}, current selectedItems: ${selectedItems}`
56
- );
57
-
58
- if (selectedItems.includes(tag)) {
59
- await multiSelectProvider.removeItem(tag);
60
- } else {
61
- const maxItems = action.options?.max_items;
62
-
63
- if (maxItems && selectedItems.length >= maxItems) {
64
- log_info(
65
- `handleAction: screenToggleFlag event reached max items limit: ${maxItems}, cannot add tag: ${tag}`
66
- );
67
-
68
- await onMaxTagsReached({
69
- selectedItems,
70
- maxItems,
71
- tag,
72
- keyNamespace,
73
- });
74
-
75
- return ActionResult.Cancel;
76
- }
77
-
78
- await multiSelectProvider.addItem(tag);
79
- }
80
- } else {
81
- log_error(
82
- "handleAction: screenToggleFlag event missing keyNamespace or tag",
83
- { keyNamespace, tag }
84
- );
85
-
86
- return ActionResult.Error;
87
- }
88
-
89
- return ActionResult.Success;
90
- };
@@ -1,110 +0,0 @@
1
- import { ActionResult } from "./ActionExecutor";
2
- import { get } from "lodash";
3
- import { StorageMultiSelectProvider } from "@applicaster/zapp-react-native-utils/storage/StorageMultiSelectProvider";
4
- import { log_error, log_info } from "./ActionExecutorContext";
5
- import { postEvent } from "../reactHooks/useSubscriberFor";
6
- import { TOGGLE_FLAG_MAX_ITEMS_REACHED_EVENT } from "./consts";
7
- import { StorageType } from "../appUtils/contextKeysManager/consts";
8
-
9
- // send all data just in case (like for message string formatting)
10
- // Type is not exported for now
11
- type MaxTagsReachedEvent = {
12
- selectedItems: string[];
13
- maxItems: number;
14
- tag: string;
15
- keyNamespace: string;
16
- };
17
-
18
- export async function onMaxTagsReached(data: MaxTagsReachedEvent) {
19
- postEvent(TOGGLE_FLAG_MAX_ITEMS_REACHED_EVENT, [data]);
20
- }
21
-
22
- export async function storageToggleFlag(
23
- context: Record<string, any>,
24
- action: ActionType,
25
- storageType: StorageType
26
- ) {
27
- if (!context) {
28
- log_error("handleAction: localStorageToggleFlag action missing context");
29
-
30
- return ActionResult.Error;
31
- }
32
-
33
- const entry = context?.entry as ZappEntry;
34
-
35
- if (!entry) {
36
- log_error(
37
- "handleAction: localStorageToggleFlag action missing entry. Entry is required to get the tag."
38
- );
39
-
40
- return ActionResult.Error;
41
- }
42
-
43
- const tag = action.options?.selector
44
- ? get(entry, action.options.selector)
45
- : (entry.extensions?.tag ?? entry.id);
46
-
47
- const keyNamespace = action.options?.key;
48
-
49
- if (keyNamespace && tag) {
50
- const multiSelectProvider = StorageMultiSelectProvider.getProvider(
51
- keyNamespace,
52
- storageType
53
- );
54
-
55
- const selectedItems = await multiSelectProvider.getSelectedAsync();
56
- const isTagInSelectedItems = selectedItems.includes(tag);
57
-
58
- log_info(
59
- `handleAction: localStorageToggleFlag event will ${
60
- isTagInSelectedItems ? "remove" : "add"
61
- } tag: ${tag} for keyNamespace: ${keyNamespace}, current selectedItems: ${selectedItems}`
62
- );
63
-
64
- if (selectedItems.includes(tag)) {
65
- await multiSelectProvider.removeItem(tag);
66
- } else {
67
- const maxItems = action.options?.max_items;
68
-
69
- if (maxItems && selectedItems.length >= maxItems) {
70
- log_info(
71
- `handleAction: localStorageToggleFlag event reached max items limit: ${maxItems}, cannot add tag: ${tag}`
72
- );
73
-
74
- await onMaxTagsReached({
75
- selectedItems,
76
- maxItems,
77
- tag,
78
- keyNamespace,
79
- });
80
-
81
- return ActionResult.Cancel;
82
- }
83
-
84
- await multiSelectProvider.addItem(tag);
85
- }
86
- } else {
87
- log_error(
88
- "handleAction: localStorageToggleFlag event missing keyNamespace or tag",
89
- { keyNamespace, tag }
90
- );
91
-
92
- return ActionResult.Error;
93
- }
94
-
95
- return ActionResult.Success;
96
- }
97
-
98
- export async function sessionStorageToggleFlag(
99
- context: Record<string, any>,
100
- action: ActionType
101
- ) {
102
- return storageToggleFlag(context, action, StorageType.session);
103
- }
104
-
105
- export async function localStorageToggleFlag(
106
- context: Record<string, any>,
107
- action: ActionType
108
- ) {
109
- return storageToggleFlag(context, action, StorageType.local);
110
- }
@@ -1,8 +0,0 @@
1
- import { useMemo } from "react";
2
- import { ScreenStateResolver } from "../appUtils/contextKeysManager/contextResolver";
3
-
4
- export const useScreenResolvers = (screenRoute: string) => {
5
- return useMemo(() => {
6
- return { screen: new ScreenStateResolver(screenRoute) };
7
- }, [screenRoute]);
8
- };