@applicaster/zapp-react-native-utils 14.0.0-alpha.4517121861 → 14.0.0-alpha.4596155133

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 (53) 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 +1 -1
  7. package/analyticsUtils/AnalyticsEvents/sendHeaderClickEvent.ts +1 -1
  8. package/analyticsUtils/AnalyticsEvents/sendMenuClickEvent.ts +2 -1
  9. package/analyticsUtils/index.tsx +3 -4
  10. package/analyticsUtils/manager.ts +1 -1
  11. package/appUtils/HooksManager/Hook.ts +4 -4
  12. package/appUtils/HooksManager/index.ts +11 -1
  13. package/appUtils/accessibilityManager/index.ts +3 -3
  14. package/appUtils/contextKeysManager/contextResolver.ts +31 -1
  15. package/appUtils/focusManager/treeDataStructure/Tree/index.js +1 -1
  16. package/appUtils/playerManager/OverlayObserver/OverlaysObserver.ts +0 -15
  17. package/appUtils/playerManager/useChapterMarker.tsx +0 -1
  18. package/appUtils/playerManager/usePlayerControllerSetup.tsx +16 -0
  19. package/arrayUtils/index.ts +1 -1
  20. package/componentsUtils/__tests__/isTabsScreen.test.ts +38 -0
  21. package/componentsUtils/index.ts +4 -1
  22. package/configurationUtils/__tests__/manifestKeyParser.test.ts +547 -0
  23. package/configurationUtils/manifestKeyParser.ts +57 -32
  24. package/index.d.ts +0 -9
  25. package/navigationUtils/__tests__/mapContentTypesToRivers.test.ts +130 -0
  26. package/navigationUtils/index.ts +6 -4
  27. package/package.json +2 -3
  28. package/playerUtils/index.ts +51 -0
  29. package/reactHooks/autoscrolling/__tests__/useTrackedView.test.tsx +15 -14
  30. package/reactHooks/cell-click/index.ts +8 -1
  31. package/reactHooks/feed/__tests__/useBatchLoading.test.tsx +39 -88
  32. package/reactHooks/feed/__tests__/useFeedLoader.test.tsx +20 -0
  33. package/reactHooks/feed/useBatchLoading.ts +8 -6
  34. package/reactHooks/feed/useFeedLoader.tsx +25 -12
  35. package/reactHooks/feed/usePipesCacheReset.ts +2 -2
  36. package/reactHooks/flatList/useSequentialRenderItem.tsx +3 -3
  37. package/reactHooks/layout/__tests__/index.test.tsx +3 -1
  38. package/reactHooks/layout/isTablet/index.ts +12 -5
  39. package/reactHooks/layout/useDimensions/__tests__/useDimensions.test.ts +34 -36
  40. package/reactHooks/layout/useDimensions/useDimensions.ts +2 -3
  41. package/reactHooks/layout/useLayoutVersion.ts +5 -5
  42. package/reactHooks/navigation/index.ts +7 -5
  43. package/reactHooks/navigation/useRoute.ts +7 -2
  44. package/reactHooks/navigation/useScreenStateStore.ts +8 -0
  45. package/reactHooks/resolvers/__tests__/useCellResolver.test.tsx +4 -0
  46. package/reactHooks/state/useRivers.ts +7 -8
  47. package/storage/ScreenSingleValueProvider.ts +201 -0
  48. package/storage/ScreenStateMultiSelectProvider.ts +290 -0
  49. package/storage/StorageMultiSelectProvider.ts +192 -0
  50. package/storage/StorageSingleSelectProvider.ts +108 -0
  51. package/testUtils/index.tsx +7 -8
  52. package/time/BackgroundTimer.ts +1 -1
  53. package/utils/index.ts +1 -0
@@ -1,13 +1,16 @@
1
1
  import React, { useEffect } from "react";
2
- import { useDispatch } from "react-redux";
3
2
 
4
- import { loadPipesData } from "@applicaster/zapp-react-native-redux/ZappPipes";
5
- import { useZappPipesFeed } from "@applicaster/zapp-react-native-redux/hooks";
3
+ import {
4
+ ZappPipes,
5
+ useAppDispatch,
6
+ useZappPipesFeed,
7
+ } from "@applicaster/zapp-react-native-redux";
6
8
 
7
9
  import { reactHooksLogger } from "../logger";
8
10
  import { shouldDispatchData, useIsInitialRender } from "../utils";
9
11
  import { useInflatedUrl } from "./useInflatedUrl";
10
12
  import { useRoute } from "../navigation";
13
+ import { useScreenResolvers } from "@applicaster/zapp-react-native-utils/actionsExecutor/screenResolver";
11
14
 
12
15
  const logger = reactHooksLogger.addSubsystem("useFeedLoader");
13
16
 
@@ -49,8 +52,9 @@ export const useFeedLoader = ({
49
52
  }, []);
50
53
 
51
54
  const isInitialRender = useIsInitialRender();
52
- const dispatch = useDispatch();
55
+ const dispatch = useAppDispatch();
53
56
  const { screenData } = useRoute();
57
+ const resolvers = useScreenResolvers();
54
58
 
55
59
  const callableFeedUrl = useInflatedUrl({ feedUrl, mapping });
56
60
 
@@ -64,16 +68,17 @@ export const useFeedLoader = ({
64
68
  (silentRefresh = true, callback) => {
65
69
  if (callableFeedUrl) {
66
70
  dispatch(
67
- loadPipesData(callableFeedUrl, {
71
+ ZappPipes.loadPipesData(callableFeedUrl, {
68
72
  clearCache: true,
69
73
  silentRefresh,
70
74
  callback,
71
75
  riverId,
76
+ resolvers,
72
77
  })
73
78
  );
74
79
  }
75
80
  },
76
- [callableFeedUrl]
81
+ [callableFeedUrl, resolvers]
77
82
  );
78
83
 
79
84
  const loadNext: FeedLoaderResponse["loadNext"] = React.useCallback(() => {
@@ -82,15 +87,16 @@ export const useFeedLoader = ({
82
87
 
83
88
  if (nextFeed) {
84
89
  dispatch(
85
- loadPipesData(nextFeed, {
90
+ ZappPipes.loadPipesData(nextFeed, {
86
91
  silentRefresh: true,
87
92
  parentFeed: callableFeedUrl,
88
93
  riverId,
94
+ resolvers,
89
95
  })
90
96
  );
91
97
  }
92
98
  }
93
- }, [callableFeedUrl, currentFeed?.data?.next]);
99
+ }, [callableFeedUrl, currentFeed?.data?.next, resolvers]);
94
100
 
95
101
  useEffect(() => {
96
102
  if (
@@ -98,10 +104,11 @@ export const useFeedLoader = ({
98
104
  ) {
99
105
  if (callableFeedUrl && !pipesOptions.skipLoading) {
100
106
  dispatch(
101
- loadPipesData(callableFeedUrl, {
107
+ ZappPipes.loadPipesData(callableFeedUrl, {
102
108
  ...pipesOptions,
103
109
  clearCache: true,
104
110
  riverId,
111
+ resolvers,
105
112
  })
106
113
  );
107
114
  } else if (!callableFeedUrl) {
@@ -126,14 +133,20 @@ export const useFeedLoader = ({
126
133
  jsOnly: true,
127
134
  });
128
135
  }
129
- }, []);
136
+ }, [resolvers]);
130
137
 
131
138
  // Reload feed when feedUrl changes, unless skipLoading is true
132
139
  useEffect(() => {
133
140
  if (!isInitialRender && callableFeedUrl && !pipesOptions.skipLoading) {
134
- dispatch(loadPipesData(callableFeedUrl, { ...pipesOptions, riverId }));
141
+ dispatch(
142
+ ZappPipes.loadPipesData(callableFeedUrl, {
143
+ ...pipesOptions,
144
+ riverId,
145
+ resolvers,
146
+ })
147
+ );
135
148
  }
136
- }, [callableFeedUrl]);
149
+ }, [callableFeedUrl, resolvers]);
137
150
 
138
151
  return React.useMemo(() => {
139
152
  if (!callableFeedUrl || !feedUrl) {
@@ -1,11 +1,11 @@
1
1
  import React from "react";
2
- import { useDispatch } from "react-redux";
3
2
 
4
3
  import { getDatasourceUrl } from "@applicaster/zapp-react-native-ui-components/Decorators/RiverFeedLoader/utils/getDatasourceUrl";
5
4
  import { usePipesContexts } from "@applicaster/zapp-react-native-ui-components/Decorators/RiverFeedLoader/utils/usePipesContexts";
6
5
  import { clearPipesData } from "@applicaster/zapp-react-native-redux/ZappPipes";
7
6
 
8
7
  import { useRoute } from "../navigation";
8
+ import { useAppDispatch } from "@applicaster/zapp-react-native-redux";
9
9
 
10
10
  /**
11
11
  * reset river components cache when screen is unmounted
@@ -13,7 +13,7 @@ import { useRoute } from "../navigation";
13
13
  * @param {Array} riverComponents list of UI components
14
14
  */
15
15
  export const usePipesCacheReset = (riverId, riverComponents) => {
16
- const dispatch = useDispatch();
16
+ const dispatch = useAppDispatch();
17
17
  const { screenData, pathname } = useRoute();
18
18
  const pipesContexts = usePipesContexts(riverId, pathname);
19
19
 
@@ -1,6 +1,6 @@
1
1
  import * as React from "react";
2
2
  import * as R from "ramda";
3
- import { View } from "react-native";
3
+ import { View, ViewStyle } from "react-native";
4
4
 
5
5
  import { platformSelect } from "../../reactUtils";
6
6
 
@@ -49,13 +49,13 @@ export const useSequentialRenderItem = (data: Data) => {
49
49
  const readyToDisplay =
50
50
  index === 0 ? true : arePreviousComponentsReady(index);
51
51
 
52
- const displayStyle = {
52
+ const displayStyle: ViewStyle = {
53
53
  display: readyToDisplay ? "flex" : "none",
54
54
  };
55
55
 
56
56
  const readyStyle = {
57
57
  visibility: readyToDisplay ? "visible" : "hidden",
58
- };
58
+ } as ViewStyle;
59
59
 
60
60
  const style = platformSelect({
61
61
  tvos: readyStyle,
@@ -42,15 +42,17 @@ jest.mock("react-native-safe-area-context", () => ({
42
42
  }));
43
43
 
44
44
  jest.mock("../../../reactUtils", () => ({
45
+ ...jest.requireActual("../../../reactUtils"),
45
46
  platformSelect: jest.fn((specs) => specs[platform] || specs.default),
46
47
  isTV: jest.fn(() => mock_tv_flag),
47
48
  }));
48
49
 
49
50
  jest.mock("../../navigation", () => ({
50
- useNavigation: () => null,
51
51
  useIsScreenActive: () => true,
52
52
  }));
53
53
 
54
+ jest.mock("../../navigation/useNavigation");
55
+
54
56
  const { Dimensions } = require("react-native");
55
57
  const { useDimensions } = require("..");
56
58
 
@@ -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,46 +1,48 @@
1
1
  import { renderHook } from "@testing-library/react-hooks";
2
2
  import { Dimensions, StatusBar } from "react-native";
3
+ import { useDimensions } from "../useDimensions";
4
+ import { usePickFromState } from "@applicaster/zapp-react-native-redux";
3
5
 
4
- const mockUsePickFromState = jest.fn();
5
- const mockUseIsScreenActive = jest.fn();
6
- const mockGetInitialDimensions = jest.fn();
7
- const mockGetDeviceInfo = jest.fn();
6
+ import { useIsScreenActive } from "@applicaster/zapp-react-native-utils/reactHooks/navigation/useIsScreenActive";
8
7
 
9
- jest.mock("@applicaster/zapp-react-native-redux/hooks", () => ({
10
- ...(jest.requireActual("@applicaster/zapp-react-native-redux/hooks") as {}),
11
- usePickFromState: mockUsePickFromState,
12
- }));
13
-
14
- jest.mock("../../../navigation", () => ({
15
- useIsScreenActive: mockUseIsScreenActive,
16
- }));
8
+ jest.mock("@applicaster/zapp-react-native-redux/hooks", () => {
9
+ return {
10
+ ...jest.requireActual("@applicaster/zapp-react-native-redux/hooks"),
11
+ usePickFromState: jest.fn(),
12
+ };
13
+ });
17
14
 
18
- jest.mock("../helpers", () => ({
19
- getInitialDimensions: mockGetInitialDimensions,
15
+ jest.mock(
16
+ "@applicaster/zapp-react-native-utils/reactHooks/navigation/useIsScreenActive",
17
+ () => ({
18
+ useIsScreenActive: jest.fn().mockReturnValue(true),
19
+ })
20
+ );
21
+
22
+ jest.doMock("../helpers", () => ({
23
+ getInitialDimensions: jest
24
+ .fn()
25
+ .mockReturnValue({ width: 100, height: 200, scale: 1, fontScale: 1 }),
20
26
  }));
21
27
 
22
28
  jest.mock("../../getDeviceInfo", () => ({
23
- getDeviceInfo: mockGetDeviceInfo,
29
+ getDeviceInfo: jest.fn().mockReturnValue({ deviceInfo: "testDeviceInfo" }),
24
30
  }));
25
31
 
26
- const { useDimensions } = require("../useDimensions");
32
+ const mockDimensions = { width: 100, height: 200, scale: 1, fontScale: 1 };
33
+
34
+ Dimensions.get = jest.fn().mockReturnValue(mockDimensions);
35
+
36
+ Dimensions.addEventListener = jest.fn().mockReturnValue({
37
+ remove: jest.fn(),
38
+ });
27
39
 
28
40
  describe("useDimensions", () => {
29
- const mockDimensions = { width: 100, height: 200, scale: 1, fontScale: 1 };
30
41
  const mockAppData = { someData: "test" };
31
42
 
32
43
  beforeEach(() => {
33
- jest.clearAllMocks();
34
- Dimensions.get = jest.fn().mockReturnValue(mockDimensions);
35
-
36
- Dimensions.addEventListener = jest.fn().mockReturnValue({
37
- remove: jest.fn(),
38
- });
39
-
40
- mockUsePickFromState.mockReturnValue({ appData: mockAppData });
41
- mockUseIsScreenActive.mockReturnValue(true);
42
- mockGetInitialDimensions.mockReturnValue(mockDimensions);
43
- mockGetDeviceInfo.mockReturnValue({ deviceInfo: "testDeviceInfo" });
44
+ StatusBar.currentHeight = 20;
45
+ (usePickFromState as jest.Mock).mockReturnValue({ appData: mockAppData });
44
46
  });
45
47
 
46
48
  it("returns correct initial dimensions", () => {
@@ -48,12 +50,9 @@ describe("useDimensions", () => {
48
50
  useDimensions("window", { fullDimensions: false })
49
51
  );
50
52
 
51
- expect(result.current).toEqual({
52
- ...mockDimensions,
53
+ expect(result.current).toMatchObject({
53
54
  statusBarHeight: StatusBar.currentHeight,
54
55
  });
55
-
56
- expect(mockGetInitialDimensions).toHaveBeenCalledWith("window");
57
56
  });
58
57
 
59
58
  it("calls handler on mount", () => {
@@ -70,7 +69,7 @@ describe("useDimensions", () => {
70
69
  useDimensions("window", { fullDimensions: false })
71
70
  );
72
71
 
73
- mockUseIsScreenActive.mockReturnValue(false);
72
+ (useIsScreenActive as jest.Mock).mockReturnValue(false);
74
73
  rerender();
75
74
 
76
75
  expect(Dimensions.addEventListener).toHaveBeenCalledWith(
@@ -84,8 +83,7 @@ describe("useDimensions", () => {
84
83
  useDimensions("window", { fullDimensions: true })
85
84
  );
86
85
 
87
- expect(result.current).toEqual({
88
- ...mockDimensions,
86
+ expect(result.current).toMatchObject({
89
87
  scale: 1,
90
88
  fontScale: 1,
91
89
  statusBarHeight: StatusBar.currentHeight,
@@ -98,7 +96,7 @@ describe("useDimensions", () => {
98
96
  );
99
97
 
100
98
  expect(result.current.height).toBe(
101
- mockDimensions.height - StatusBar.currentHeight ?? 0
99
+ mockDimensions.height - (StatusBar?.currentHeight ?? 0)
102
100
  );
103
101
  });
104
102
 
@@ -10,7 +10,7 @@ import { isTV } from "../../../reactUtils";
10
10
  import { Options, UseDimensions } from "../types";
11
11
  import { getDeviceInfo } from "../getDeviceInfo";
12
12
  import { getInitialDimensions } from "./helpers";
13
- import { useIsScreenActive } from "../../navigation";
13
+ import { useIsScreenActive } from "../../navigation/useIsScreenActive";
14
14
 
15
15
  function compensateForScaleIfNeeded(context) {
16
16
  return function () {
@@ -24,8 +24,6 @@ const applyScaleToDimensions = R.unless(R.propEq("scale", 1), (dimensions) => ({
24
24
  scale: 1,
25
25
  }));
26
26
 
27
- const statusBarHeight = StatusBar?.currentHeight;
28
-
29
27
  /**
30
28
  * Returns React-native Dimensions object and updates it on any dimension change
31
29
  * @param {('screen'|'window')} [context=window] - Dimensions context passed to Dimensions.get method
@@ -37,6 +35,7 @@ export const useDimensions: UseDimensions = (
37
35
  context = "window",
38
36
  fullDimensions = { fullDimensions: false, updateForInactiveScreens: true }
39
37
  ) => {
38
+ const statusBarHeight = StatusBar?.currentHeight;
40
39
  const isActive = useIsScreenActive();
41
40
  const { appData } = usePickFromState(["appData"]);
42
41
 
@@ -1,6 +1,8 @@
1
1
  /* eslint-disable no-redeclare */
2
- import { useSelector } from "react-redux";
3
- import * as R from "ramda";
2
+ import {
3
+ useAppSelector,
4
+ selectLayoutVersion,
5
+ } from "@applicaster/zapp-react-native-redux";
4
6
 
5
7
  export function useLayoutVersion(): ZappLayoutVersions;
6
8
 
@@ -23,9 +25,7 @@ export function useLayoutVersion({
23
25
  isV2?: boolean;
24
26
  isV1?: boolean;
25
27
  } = {}): boolean | ZappLayoutVersions {
26
- const layoutVersion = useSelector<any, ZappLayoutVersions>(
27
- R.path(["appData", "layoutVersion"])
28
- );
28
+ const layoutVersion = useAppSelector(selectLayoutVersion);
29
29
 
30
30
  if (isV2) {
31
31
  return layoutVersion === "v2";
@@ -14,7 +14,7 @@ import { HOOKS_EVENTS } from "../../appUtils/HooksManager/constants";
14
14
  import { getRiverFromRoute, getTargetRoute } from "../../navigationUtils";
15
15
  import { useConnectionInfo } from "../connection";
16
16
 
17
- import { isTV } from "@applicaster/zapp-react-native-utils/reactUtils";
17
+ import { isTV, isWeb } from "@applicaster/zapp-react-native-utils/reactUtils";
18
18
  import { useNavbarState } from "../screen";
19
19
 
20
20
  export { useNavigation } from "./useNavigation";
@@ -127,11 +127,13 @@ export function isNavBarVisible(
127
127
 
128
128
  export const useBackHandler = (cb: () => boolean) => {
129
129
  useEffect(() => {
130
- BackHandler.addEventListener("hardwareBackPress", cb);
130
+ if (!isWeb()) {
131
+ const unsubscribe = BackHandler.addEventListener("hardwareBackPress", cb);
131
132
 
132
- return () => {
133
- BackHandler.removeEventListener("hardwareBackPress", cb);
134
- };
133
+ return () => {
134
+ unsubscribe.remove();
135
+ };
136
+ }
135
137
  }, [cb]);
136
138
  };
137
139
 
@@ -28,14 +28,19 @@ const isHookPathname = (pathname: string) => /^\/hooks\//.test(pathname);
28
28
 
29
29
  type VariousScreenData = LegacyNavigationScreenData | ZappRiver | ZappEntry;
30
30
 
31
- export const useRoute = (): {
31
+ export const useRoute = (
32
+ useLegacy = true
33
+ ): {
32
34
  screenData: VariousScreenData;
33
35
  pathname: string;
34
36
  } => {
35
37
  const pathname = usePathname() || "";
36
38
  const navigator = useNavigation();
39
+ const screenContext = useContext(ScreenDataContext);
37
40
 
38
- const screenDataContext = legacyScreenData(useContext(ScreenDataContext));
41
+ const screenDataContext = useLegacy
42
+ ? legacyScreenData(screenContext)
43
+ : screenContext;
39
44
 
40
45
  const { plugins, contentTypes, rivers } = usePickFromState([
41
46
  "plugins",
@@ -0,0 +1,8 @@
1
+ import { useRoute } from "./useRoute";
2
+ import { useMemo } from "react";
3
+
4
+ export const useScreenStateStore = () => {
5
+ const route = useRoute(false);
6
+
7
+ return useMemo(() => route.screenData["screenStateStore"], [route.pathname]);
8
+ };
@@ -14,6 +14,10 @@ jest.mock("@applicaster/zapp-react-native-utils/localizationUtils", () => ({
14
14
 
15
15
  jest.mock("@applicaster/zapp-react-native-utils/reactHooks/navigation");
16
16
 
17
+ jest.mock(
18
+ "@applicaster/zapp-react-native-utils/reactHooks/navigation/useNavigation"
19
+ );
20
+
17
21
  const { useCellResolver } = require("../useCellResolver");
18
22
 
19
23
  describe("cellResolver", () => {
@@ -1,9 +1,8 @@
1
- import { usePickFromState } from "@applicaster/zapp-react-native-redux/hooks";
1
+ import {
2
+ useAppSelector,
3
+ selectRivers,
4
+ } from "@applicaster/zapp-react-native-redux";
2
5
 
3
- const riversSelector = ["rivers"];
4
-
5
- export const useRivers = () => {
6
- const { rivers } = usePickFromState(riversSelector as any);
7
-
8
- return rivers;
9
- };
6
+ export function useRivers(): Record<string, ZappRiver> {
7
+ return useAppSelector(selectRivers);
8
+ }
@@ -0,0 +1,201 @@
1
+ import { BehaviorSubject } from "rxjs";
2
+ import { SingleValueProvider } from "./StorageSingleSelectProvider";
3
+ import { createLogger } from "../logger";
4
+ import { bridgeLogger } from "../../zapp-react-native-bridge/logger";
5
+
6
+ export const { log_debug, log_error } = createLogger({
7
+ category: "ScreenSingleValueProvider",
8
+ subsystem: "zapp-react-native-bridge",
9
+ parent: bridgeLogger,
10
+ });
11
+
12
+ export class ScreenSingleValueProvider implements SingleValueProvider {
13
+ // @ts-ignore
14
+ private valueSubject: BehaviorSubject<string | null>;
15
+ private screenStateStoreUnsubscribe: (() => void) | null = null;
16
+
17
+ private static providers: Record<
18
+ string,
19
+ Record<string, SingleValueProvider>
20
+ > = {};
21
+
22
+ public static getProvider(
23
+ key: string,
24
+ screenRoute: string,
25
+ screenStateStore: ScreenStateStore
26
+ ): SingleValueProvider {
27
+ if (!key) {
28
+ throw new Error("ScreenSingleValueProvider: Key is required");
29
+ }
30
+
31
+ if (!screenRoute) {
32
+ throw new Error("ScreenSingleValueProvider: Screen route is required");
33
+ }
34
+
35
+ if (!screenStateStore) {
36
+ throw new Error(
37
+ "ScreenSingleValueProvider: screen state store is required"
38
+ );
39
+ }
40
+
41
+ if (!this.providers[screenRoute]) {
42
+ this.providers[screenRoute] = {};
43
+ }
44
+
45
+ try {
46
+ if (!this.providers[screenRoute][key]) {
47
+ this.providers[screenRoute][key] = new ScreenSingleValueProvider(
48
+ key,
49
+ screenRoute,
50
+ screenStateStore
51
+ );
52
+ } else {
53
+ (
54
+ this.providers[screenRoute][key] as ScreenSingleValueProvider
55
+ ).updateStore(screenStateStore);
56
+ }
57
+ } catch (error) {
58
+ log_error("Failed to create provider", { key, screenRoute, error });
59
+ throw error;
60
+ }
61
+
62
+ return this.providers[screenRoute][key];
63
+ }
64
+
65
+ // @ts-ignore
66
+ private constructor(
67
+ private key: string,
68
+ route: string,
69
+ private screenStateStore: ScreenStateStore
70
+ ) {
71
+ if (!key) {
72
+ throw new Error("ScreenSingleValueProvider: Key is required");
73
+ }
74
+
75
+ if (!screenStateStore) {
76
+ throw new Error(
77
+ "ScreenSingleValueProvider: screen state store is required"
78
+ );
79
+ }
80
+
81
+ this.key = key;
82
+ this.valueSubject = new BehaviorSubject<string | null>(null);
83
+
84
+ this.setupScreenStateSubscription();
85
+
86
+ void this.getValueAsync();
87
+
88
+ log_debug("ScreenSingleValueProvider: Initializing", { key, route });
89
+ }
90
+
91
+ private updateStore(screenStateStore: ScreenStateStore): void {
92
+ this.cleanup();
93
+ this.screenStateStore = screenStateStore;
94
+ this.setupScreenStateSubscription();
95
+ void this.getValueAsync();
96
+ }
97
+
98
+ private setupScreenStateSubscription(): void {
99
+ this.screenStateStoreUnsubscribe = this.screenStateStore.subscribe(
100
+ (state) => ({
101
+ value: state.data[this.key],
102
+ exists: this.key in state.data,
103
+ }),
104
+ (current, previous) => {
105
+ if (!current.exists && previous.exists) {
106
+ log_debug(
107
+ `ScreenSingleValueProvider: Key deleted from store: ${this.key}`
108
+ );
109
+
110
+ // TODO: If we need to handle deletion, we can do it here
111
+ }
112
+
113
+ if (current.value !== previous.value) {
114
+ this.valueSubject.next(current.value || null);
115
+
116
+ log_debug(`ScreenSingleValueProvider: Key updated: ${this.key}`, {
117
+ previous: previous.value,
118
+ current: current.value,
119
+ });
120
+ }
121
+ }
122
+ );
123
+
124
+ log_debug(
125
+ `ScreenSingleValueProvider: screen state store subscription setup for key: ${this.key}`
126
+ );
127
+ }
128
+
129
+ private cleanup(): void {
130
+ if (this.screenStateStoreUnsubscribe) {
131
+ this.screenStateStoreUnsubscribe();
132
+ this.screenStateStoreUnsubscribe = null;
133
+
134
+ log_debug(
135
+ `ScreenSingleValueProvider: Unsubscribed from screen state store for key: ${this.key}`
136
+ );
137
+ }
138
+ }
139
+
140
+ clearValue(): Promise<void> {
141
+ this.screenStateStore.getState().removeValue(this.key);
142
+ this.valueSubject.next(null);
143
+
144
+ log_debug(`clearValue: value cleared for key: ${this.key}`);
145
+
146
+ return Promise.resolve();
147
+ }
148
+
149
+ getObservable(): BehaviorSubject<string | null> {
150
+ return this.valueSubject;
151
+ }
152
+
153
+ getValue(): string | null {
154
+ return this.valueSubject.value;
155
+ }
156
+
157
+ getValueAsync(): Promise<string | null> {
158
+ const currentValue = this.screenStateStore.getState().data[this.key];
159
+ const value = currentValue || null;
160
+ const selected = this.getValue();
161
+ const valuesAreEqual = value === selected;
162
+
163
+ const bothEmpty =
164
+ (value === null || value === "") &&
165
+ (selected === null || selected === "");
166
+
167
+ if (!this.valueSubject.closed && !valuesAreEqual && !bothEmpty) {
168
+ this.valueSubject.next(value);
169
+ }
170
+
171
+ return Promise.resolve(value);
172
+ }
173
+
174
+ setValue(value: string): Promise<void> {
175
+ this.screenStateStore.getState().setValue(this.key, value);
176
+ this.valueSubject.next(value);
177
+
178
+ log_debug(`setValue: value set for key: ${this.key}`, { value });
179
+
180
+ return Promise.resolve();
181
+ }
182
+
183
+ // TODO: remove if not needed
184
+
185
+ public static cleanupRoute(screenRoute: string): void {
186
+ if (this.providers[screenRoute]) {
187
+ Object.values(this.providers[screenRoute]).forEach((provider) => {
188
+ (provider as ScreenSingleValueProvider).destroy();
189
+ });
190
+
191
+ delete this.providers[screenRoute];
192
+ }
193
+ }
194
+
195
+ // TODO: remove if not needed
196
+
197
+ public destroy(): void {
198
+ this.valueSubject.complete();
199
+ this.cleanup();
200
+ }
201
+ }