@applicaster/zapp-react-native-utils 13.0.0-alpha.3003916059 → 13.0.0-alpha.3013095924

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.
@@ -5,11 +5,9 @@ import {
5
5
  actionExecutor as _actionExecutor,
6
6
  ActionResult,
7
7
  } from "./ActionExecutor";
8
- import { batchSave } from "../zappFrameworkUtils/localStorageHelper";
9
- import { sessionStorage } from "@applicaster/zapp-react-native-bridge/ZappStorage/SessionStorage";
10
-
11
- import * as QuickBrickManager from "@applicaster/zapp-react-native-bridge/QuickBrick";
8
+ import { batchSaveToLocalStorage } from "../zappFrameworkUtils/localStorageHelper";
12
9
  import { QUICK_BRICK_EVENTS } from "@applicaster/zapp-react-native-bridge/QuickBrick";
10
+ import * as QuickBrickManager from "@applicaster/zapp-react-native-bridge/QuickBrick";
13
11
  import { showConfirmationDialog } from "../alertUtils";
14
12
  import { createCloudEvent, sendCloudEvent } from "../cloudEventsUtils";
15
13
  import { createLogger } from "../logger";
@@ -94,15 +92,7 @@ async function onMaxTagsReached(data: MaxTagsReachedEvent) {
94
92
  const prepareDefaultActions = (actionExecutor) => {
95
93
  actionExecutor.registerAction("localStorageSet", async (action) => {
96
94
  const namespaces = action.options.content;
97
- await batchSave(namespaces, localStorage);
98
- // TODO: Add support for ownershipKey and ownershipNamespace
99
-
100
- return ActionResult.Success;
101
- });
102
-
103
- actionExecutor.registerAction("sessionStorageSet", async (action) => {
104
- const namespaces = action.options.content;
105
- await batchSave(namespaces, sessionStorage);
95
+ await batchSaveToLocalStorage(namespaces);
106
96
  // TODO: Add support for ownershipKey and ownershipNamespace
107
97
 
108
98
  return ActionResult.Success;
@@ -159,13 +149,15 @@ const prepareDefaultActions = (actionExecutor) => {
159
149
  actionExecutor.registerAction("confirmDialog", async (action) => {
160
150
  log_info("handleAction: confirmDialog event");
161
151
 
162
- return new Promise<ActionResult>((resolve) => {
152
+ const confirmationPromise = new Promise<ActionResult>((resolve) => {
163
153
  showConfirmationDialog({
164
154
  ...action.options,
165
155
  confirmCompletion: () => resolve(ActionResult.Success),
166
156
  cancelCompletion: () => resolve(ActionResult.Cancel),
167
157
  });
168
158
  });
159
+
160
+ return confirmationPromise;
169
161
  });
170
162
 
171
163
  actionExecutor.registerAction("sendCloudEvent", async (action, context) => {
@@ -8,7 +8,6 @@ const {
8
8
 
9
9
  const { tvActionButtonsContainer } = require("./tvAction/container");
10
10
  const { tvActionButton } = require("./tvAction/button");
11
- const { compact } = require("./_internals");
12
11
 
13
12
  const { spacingKey, absolutePositionElement } = require("./containers");
14
13
 
@@ -47,5 +46,4 @@ module.exports = {
47
46
  tvProgressBar,
48
47
  secondaryImage,
49
48
  getUpdatedSecondaryImageKeys,
50
- compact,
51
49
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@applicaster/zapp-react-native-utils",
3
- "version": "13.0.0-alpha.3003916059",
3
+ "version": "13.0.0-alpha.3013095924",
4
4
  "description": "Applicaster Zapp React Native utilities package",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
@@ -27,7 +27,7 @@
27
27
  },
28
28
  "homepage": "https://github.com/applicaster/quickbrick#readme",
29
29
  "dependencies": {
30
- "@applicaster/applicaster-types": "13.0.0-alpha.3003916059",
30
+ "@applicaster/applicaster-types": "13.0.0-alpha.3013095924",
31
31
  "buffer": "^5.2.1",
32
32
  "camelize": "^1.0.0",
33
33
  "dayjs": "^1.11.10",
@@ -1,19 +1,12 @@
1
1
  import { useGetNavBarTopBorderWidth } from "./useGetNavBarTopBorderWidth";
2
- import { getTabBarHeight } from "./getTabBarHeight";
3
- import { useNavigation } from "./useNavigation";
2
+ import { useGetTabBarHeight } from "./useGetTabBarHeight";
4
3
  import { MenuTypes, useNavigationType } from "./useNavigationType";
5
- import { useNavigationPluginData } from "./useNavigationPluginData";
6
4
 
7
5
  export const useGetBottomTabBarHeight = (): number => {
8
- const { activeRiver } = useNavigation();
9
-
10
- const navigationPluginData = useNavigationPluginData(activeRiver);
11
- const navigationType = useNavigationType(navigationPluginData);
12
-
13
6
  const topBorderWidth = useGetNavBarTopBorderWidth();
14
- const tabBarHeight = getTabBarHeight();
7
+ const tabBarHeight = useGetTabBarHeight();
15
8
 
16
- const isBottomBarNavigation = navigationType === MenuTypes.bottomTabBar;
9
+ const isBottomBarNavigation = useNavigationType() === MenuTypes.bottomTabBar;
17
10
 
18
11
  return !isBottomBarNavigation ? 0 : tabBarHeight + topBorderWidth;
19
12
  };
@@ -3,7 +3,7 @@ import { platformSelect } from "../../reactUtils";
3
3
  const TAB_BAR_HEIGHT_IOS = 49;
4
4
  const TAB_BAR_HEIGHT_ANDROID = 56;
5
5
 
6
- export const getTabBarHeight = () =>
6
+ export const useGetTabBarHeight = () =>
7
7
  platformSelect({
8
8
  ios: TAB_BAR_HEIGHT_IOS,
9
9
  android: TAB_BAR_HEIGHT_ANDROID,
@@ -1,17 +1,13 @@
1
1
  import { useRoute } from "./useRoute";
2
2
 
3
- export const useNavigationPluginData = (
4
- screenData?: LegacyNavigationScreenData | null
5
- ): ZappNavigation | undefined => {
3
+ export const useNavigationPluginData = (): ZappNavigation | undefined => {
6
4
  const {
7
5
  screenData: useRouteScreenData,
8
6
  }: { screenData: QuickBrickNavigationData | null } = useRoute();
9
7
 
10
- const activeScreenData = screenData ?? useRouteScreenData;
11
-
12
- const navigations = activeScreenData?.targetScreen
13
- ? (activeScreenData.targetScreen as ZappRiver).navigations
14
- : (activeScreenData as ZappRiver).navigations;
8
+ const navigations = useRouteScreenData?.targetScreen
9
+ ? (useRouteScreenData.targetScreen as ZappRiver).navigations
10
+ : (useRouteScreenData as ZappRiver).navigations;
15
11
 
16
12
  const navigationMenu = navigations?.find((nav) => nav.category === "menu");
17
13
 
@@ -5,10 +5,8 @@ export enum MenuTypes {
5
5
  bottomTabBar = "BOTTOM_TAB_BAR",
6
6
  }
7
7
 
8
- export const useNavigationType = (navigation?: ZappNavigation): MenuTypes => {
9
- const navigationPluginData = useNavigationPluginData();
10
-
11
- const navigationMenu = navigation ?? navigationPluginData;
8
+ export const useNavigationType = (): MenuTypes => {
9
+ const navigationMenu = useNavigationPluginData();
12
10
 
13
11
  return !navigationMenu ||
14
12
  navigationMenu.navigation_type === "quick_brick_side_menu"
@@ -1,5 +1,3 @@
1
1
  export { useRivers } from "./useRivers";
2
2
 
3
3
  export { useHomeRiver } from "./useHomeRiver";
4
-
5
- export { ZStoreProvider, useZStore } from "./ZStoreProvider";
package/utils/index.ts CHANGED
@@ -2,4 +2,4 @@ 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 { cloneDeep as clone, flatten, drop, size } from "lodash";
@@ -7,7 +7,6 @@ import {
7
7
  StorageValuesToRemove,
8
8
  StorageValuesToAdd,
9
9
  } from "./types";
10
- import { Storage } from "@applicaster/zapp-react-native-bridge/ZappStorage/Storage";
11
10
 
12
11
  const defaultOwnedKey = "owned_keys";
13
12
  const DEFAULT_NAMESPACE = "applicaster.v2";
@@ -51,9 +50,8 @@ function mapOwnedKeysToAdd(
51
50
  return mappedData;
52
51
  }
53
52
 
54
- export async function batchSave(
55
- storageValues: StorageValuesToAdd,
56
- storage: Storage
53
+ export async function batchSaveToLocalStorage(
54
+ storageValues: StorageValuesToAdd
57
55
  ) {
58
56
  if (isNilOrEmpty(storageValues)) {
59
57
  return false;
@@ -66,18 +64,12 @@ export async function batchSave(
66
64
  const value = namespaceData[key];
67
65
 
68
66
  if (!isNilOrEmpty(value)) {
69
- await storage.setItem(key, value, namespace);
67
+ await localStorage.setItem(key, value, namespace);
70
68
  }
71
69
  }
72
70
  }
73
71
  }
74
72
 
75
- export async function batchSaveToLocalStorage(
76
- storageValues: StorageValuesToAdd
77
- ) {
78
- return await batchSave(storageValues, localStorage);
79
- }
80
-
81
73
  export async function batchRemoveFromLocalStorage(
82
74
  storageValues: StorageValuesToRemove
83
75
  ) {
@@ -1,79 +0,0 @@
1
- # ZStoreProvider and useZStore
2
-
3
- This module provides a React context-based solution for managing Zustand stores with named access.
4
-
5
- ## Usage
6
-
7
- ### ZStoreProvider
8
-
9
- The `ZStoreProvider` component creates a Zustand store from the provided value and makes it available to child components.
10
-
11
- ```tsx
12
- import { ZStoreProvider } from "@applicaster/zapp-react-native-utils/reactHooks/state";
13
-
14
- // In your component
15
- <ZStoreProvider name="playerConfiguration" value={controller?.config}>
16
- <YourComponent />
17
- </ZStoreProvider>
18
- ```
19
-
20
- ### useZStore
21
-
22
- The `useZStore` hook allows you to access a Zustand store by name from within a `ZStoreProvider`.
23
-
24
- ```tsx
25
- import { useZStore } from "@applicaster/zapp-react-native-utils/reactHooks/state";
26
- import { useStore } from "zustand";
27
-
28
- // In your component
29
- const MyComponent = () => {
30
- const store = useZStore("playerConfiguration");
31
- const config = useStore(store, (state) => state.someProperty);
32
-
33
- return <Text>{config}</Text>;
34
- };
35
- ```
36
-
37
- ## Example
38
-
39
- ```tsx
40
- import React from "react";
41
- import { ZStoreProvider, useZStore } from "@applicaster/zapp-react-native-utils/reactHooks/state";
42
- import { useStore } from "zustand";
43
-
44
- // Component that uses the store
45
- const PlayerConfigDisplay = () => {
46
- const store = useZStore("playerConfiguration");
47
- const config = useStore(store, (state) => state);
48
-
49
- return (
50
- <View>
51
- <Text>Player Config: {JSON.stringify(config)}</Text>
52
- </View>
53
- );
54
- };
55
-
56
- // Main component that provides the store
57
- const PlayerComponent = ({ controller }) => {
58
- return (
59
- <ZStoreProvider name="playerConfiguration" value={controller?.config}>
60
- <PlayerConfigDisplay />
61
- </ZStoreProvider>
62
- );
63
- };
64
- ```
65
-
66
- ## Features
67
-
68
- - **Named Stores**: Access stores by name instead of importing them directly
69
- - **Context-based**: Uses React Context for store management
70
- - **Zustand Integration**: Seamlessly works with existing Zustand stores
71
- - **Type Safety**: Full TypeScript support
72
- - **Error Handling**: Clear error messages when stores are not found or used outside providers
73
-
74
- ## Error Handling
75
-
76
- The `useZStore` hook will throw errors in the following cases:
77
-
78
- 1. **Used outside provider**: "useZStore must be used within a ZStoreProvider"
79
- 2. **Store not found**: "Store with name 'storeName' not found. Make sure it's provided by a ZStoreProvider"
@@ -1,71 +0,0 @@
1
- import React, { createContext, useContext, ReactNode, useMemo } from "react";
2
- import { create, UseBoundStore } from "zustand";
3
-
4
- interface ZStoreContextType {
5
- stores: Map<string, UseBoundStore<any>>;
6
- registerStore: (name: string, store: UseBoundStore<any>) => void;
7
- getStore: (name: string) => UseBoundStore<any> | undefined;
8
- }
9
-
10
- const ZStoreContext = createContext<ZStoreContextType | null>(null);
11
-
12
- interface ZStoreProviderProps {
13
- children: ReactNode;
14
- name: string;
15
- value: any;
16
- }
17
-
18
- export const ZStoreProvider: React.FC<ZStoreProviderProps> = ({
19
- children,
20
- name,
21
- value,
22
- }) => {
23
- const parentContext = useContext(ZStoreContext);
24
-
25
- const context = useMemo(() => {
26
- if (parentContext) {
27
- // If parent context exists, create a new store and register it
28
- const store = create(() => value);
29
- parentContext.registerStore(name, store);
30
-
31
- return parentContext;
32
- }
33
-
34
- // Create a new context if none exists
35
- const stores = new Map<string, UseBoundStore<any>>();
36
-
37
- // Create a store from the provided value
38
- const store = create(() => value);
39
- stores.set(name, store);
40
-
41
- return {
42
- stores,
43
- registerStore: (storeName: string, storeInstance: UseBoundStore<any>) => {
44
- stores.set(storeName, storeInstance);
45
- },
46
- getStore: (storeName: string) => stores.get(storeName),
47
- };
48
- }, [parentContext, name, value]);
49
-
50
- return (
51
- <ZStoreContext.Provider value={context}>{children}</ZStoreContext.Provider>
52
- );
53
- };
54
-
55
- export const useZStore = (name: string): UseBoundStore<any> => {
56
- const context = useContext(ZStoreContext);
57
-
58
- if (!context) {
59
- throw new Error("useZStore must be used within a ZStoreProvider");
60
- }
61
-
62
- const store = context.getStore(name);
63
-
64
- if (!store) {
65
- throw new Error(
66
- `Store with name "${name}" not found. Make sure it's provided by a ZStoreProvider.`
67
- );
68
- }
69
-
70
- return store;
71
- };
@@ -1,66 +0,0 @@
1
- import React from "react";
2
- import { render, screen } from "@testing-library/react-native";
3
- import { Text } from "react-native";
4
- import { ZStoreProvider, useZStore } from "../ZStoreProvider";
5
- import { useStore } from "zustand";
6
-
7
- interface TestState {
8
- value: string;
9
- }
10
-
11
- // Test component that uses the store
12
- const TestComponent = ({ storeName }: { storeName: string }) => {
13
- const store = useZStore(storeName);
14
- const value = useStore(store, (state: any) => (state as TestState).value);
15
-
16
- return <Text testID="test-value">{value}</Text>;
17
- };
18
-
19
- // Test component that provides a store
20
- const TestProvider = ({ children }: { children: React.ReactNode }) => {
21
- return (
22
- <ZStoreProvider name="testStore" value={{ value: "test-value" }}>
23
- {children}
24
- </ZStoreProvider>
25
- );
26
- };
27
-
28
- describe("ZStoreProvider and useZStore", () => {
29
- it("should provide a store and allow access via useZStore", () => {
30
- render(
31
- <TestProvider>
32
- <TestComponent storeName="testStore" />
33
- </TestProvider>
34
- );
35
-
36
- expect(screen.getByTestId("test-value").props.children).toBe("test-value");
37
- });
38
-
39
- it("should throw error when useZStore is used outside provider", () => {
40
- // Suppress console.error for this test
41
- const originalError = console.error;
42
- console.error = jest.fn();
43
-
44
- expect(() => {
45
- render(<TestComponent storeName="testStore" />);
46
- }).toThrow("useZStore must be used within a ZStoreProvider");
47
-
48
- console.error = originalError;
49
- });
50
-
51
- it("should throw error when store name is not found", () => {
52
- // Suppress console.error for this test
53
- const originalError = console.error;
54
- console.error = jest.fn();
55
-
56
- expect(() => {
57
- render(
58
- <TestProvider>
59
- <TestComponent storeName="nonExistentStore" />
60
- </TestProvider>
61
- );
62
- }).toThrow('Store with name "nonExistentStore" not found');
63
-
64
- console.error = originalError;
65
- });
66
- });