@applicaster/zapp-react-native-utils 16.0.0-alpha.4416921324 → 16.0.0-alpha.4548770949

package/actionsExecutor/actions/sendCloudEvent.ts

@@ -62,10 +62,15 @@ export const sendCloudEventAction: ActionHandler<
       subject: options.subject || String((entry as ZappEntry)?.id || ""),
     });
 
-    log_info("handleAction: sendCloudEvent event", { cloudEvent });
+    log_info("handleAction: sending sendCloudEvent to URL", {
+      url: options.url,
+      cloudEvent,
+    });
 
     const { error, code } = await sendCloudEvent(cloudEvent, options.url);
 
+    log_info("handleAction: sendCloudEvent result", { code, error });
+
     if (error) {
       log_error("sendCloudEvent: error sending cloud event", { error });
 

package/actionsExecutor/actions/showAlert.ts

@@ -0,0 +1,51 @@
+/// <reference types="@applicaster/applicaster-types" />
+import { showAlertDialog } from "../../alertUtils";
+import { ActionResult } from "../ActionExecutor";
+import { ActionHandler } from "../types";
+import { createLogger } from "../../logger";
+
+const { log_info } = createLogger({
+  subsystem: "ActionExecutorContext",
+  category: "General",
+});
+
+/**
+ * Options for the showAlert action.
+ */
+export interface ShowAlertOptions {
+  /** Dialog title (required) */
+  title: string;
+
+  /** Dialog message */
+  message?: string;
+
+  /** Dismiss button text. Defaults to "OK" */
+  okButtonText?: string;
+}
+
+/**
+ * Tells the user something and waits for them to acknowledge it.
+ *
+ * One button, because there is nothing to decide. Use `confirmDialog` when the
+ * user is choosing between going on and backing out; a `confirmDialog` without
+ * a cancel label still renders two buttons, the second one blank.
+ *
+ * Always resolves to Success: dismissing a notice is not a cancellation, so the
+ * rest of the chain runs.
+ */
+export const showAlertAction: ActionHandler<ShowAlertOptions> = async (
+  action
+): Promise<ActionResult> => {
+  log_info("handleAction: showAlert event");
+
+  const options = action.options as ShowAlertOptions;
+
+  return new Promise<ActionResult>((resolve) => {
+    showAlertDialog({
+      title: options?.title,
+      message: options?.message,
+      okButtonText: options?.okButtonText || "OK",
+      completion: () => resolve(ActionResult.Success),
+    });
+  });
+};

package/actionsExecutor/actions/showToast.ts

@@ -3,12 +3,65 @@ import { ActionResult } from "../ActionExecutor";
 import { ActionHandler } from "../types";
 import { postEvent } from "../../reactHooks/useSubscriberFor";
 
+export const CONFIRMATION_TOAST_SOURCE = "confirmation";
+
+export const CONFIRMATION_TOAST_DEFAULT_TIMEOUT = 5000;
+
 /**
- * Options for showToast action.
+ * Shows a mobile confirmation toast with Theme defaults from
+ * `Confirmation Toast / Message` in the base theme plugin.
+ *
+ * This action is confirmation-only by design: it always stamps
+ * `source: "confirmation"` (so Theme confirmation styles apply) and defaults
+ * `timeout` to 5000 ms. Non-confirmation toasts (e.g. Offline Experience)
+ * must post on the shared `"showToast"` event bus directly and omit `source`.
+ * Callers may override individual style fields; Theme supplies the rest.
+ *
+ * @example From React via ActionExecutorContext
+ * ```tsx
+ * import React, { useContext } from "react";
+ * import { ActionExecutorContext } from "@applicaster/zapp-react-native-utils/actionsExecutor/ActionExecutorContext";
+ *
+ * function QueueButton() {
+ *   const { handleAction } = useContext(ActionExecutorContext);
+ *
+ *   const onPress = () => {
+ *     void handleAction({
+ *       type: "showToast",
+ *       options: { message: "Added to queue" },
+ *     });
+ *   };
+ *
+ *   return <Button onPress={onPress} title="Add to queue" />;
+ * }
+ * ```
+ *
+ * @example From code via the actionExecutor singleton
+ * ```ts
+ * import { actionExecutor } from "@applicaster/zapp-react-native-utils/actionsExecutor/ActionExecutor";
+ *
+ * await actionExecutor.handleAction({
+ *   type: "showToast",
+ *   options: {
+ *     message: "Playlist created",
+ *     style: { backgroundColor: "#00AA55" }, // optional partial override
+ *   },
+ * });
+ * ```
+ *
+ * @example From entry / pipes actions JSON
+ * ```json
+ * {
+ *   "type": "showToast",
+ *   "options": {
+ *     "message": "Item removed from playlist"
+ *   }
+ * }
+ * ```
  */
 export interface ShowToastActionOptions {
-  id: string;
-  message: string;
+  id?: string;
+  message?: string;
   extraMessage?: string;
   style?: any;
   timeout?: number;
@@ -17,13 +70,16 @@ export interface ShowToastActionOptions {
 export const showToastAction: ActionHandler<ShowToastActionOptions> = async (
   action
 ): Promise<ActionResult> => {
+  const options = action?.options;
+
   postEvent("showToast", [
     {
-      id: action.options.id,
-      message: action.options.message,
-      extraMessage: action.options.extraMessage,
-      style: action.options.style,
-      timeout: action.options.timeout,
+      id: options?.id,
+      message: options?.message,
+      extraMessage: options?.extraMessage,
+      style: options?.style,
+      timeout: options?.timeout ?? CONFIRMATION_TOAST_DEFAULT_TIMEOUT,
+      source: CONFIRMATION_TOAST_SOURCE,
     },
   ]);
 

package/actionsExecutor/consts.ts

@@ -2,3 +2,30 @@ export const TOGGLE_FLAG_MAX_ITEMS_REACHED_EVENT =
   "action.localStorageToggleFlag.maxItemsReached";
 
 export const ACTION_EXECUTOR_EVENT_SOURCE = "ActionExecutor";
+
+export const ACTION_TYPES = {
+  OPEN_BOTTOM_SHEET: "openBottomSheet",
+  DISMISS_BOTTOM_SHEET: "dismissBottomSheet",
+  PRESENT_SUB_MENU: "presentSubMenu",
+  SEND_CLOUD_EVENT: "sendCloudEvent",
+  NAVIGATE_TO_SCREEN: "navigateToScreen",
+  PRESENT_SCREEN: "presentScreen",
+  GO_BACK: "goBack",
+  GO_HOME: "goHome",
+  SHOW_TOAST: "showToast",
+  LOCAL_STORAGE_SET: "localStorageSet",
+  LOCAL_STORAGE_REMOVE: "localStorageRemove",
+  LOCAL_STORAGE_TOGGLE_FLAG: "localStorageToggleFlag",
+  SESSION_STORAGE_SET: "sessionStorageSet",
+  SESSION_STORAGE_REMOVE: "sessionStorageRemove",
+  SESSION_STORAGE_TOGGLE_FLAG: "sessionStorageToggleFlag",
+  REFRESH_COMPONENT: "refreshComponent",
+  SWITCH_LAYOUT: "switchLayout",
+  APP_RESTART: "appRestart",
+  CONFIRM_DIALOG: "confirmDialog",
+  SHOW_ALERT: "showAlert",
+  SCREEN_SET_VARIABLE: "screenSetVariable",
+  SCREEN_TOGGLE_FLAG: "screenToggleFlag",
+} as const;
+
+export type KnownActionType = (typeof ACTION_TYPES)[keyof typeof ACTION_TYPES];

package/actionsExecutor/feedDecorator.ts

@@ -47,6 +47,11 @@ function makeMultiSelect(feed: ZappFeed, key, decoratedFeed) {
         ? "sessionStorageToggleFlag"
         : "localStorageToggleFlag";
 
+  // the toggle actions read their limit from their own options
+  const maxItems = Number(
+    decoratedFeed.extensions?.preference_editor_options?.max_items
+  );
+
   decoratedFeed.entry?.forEach((entry: ZappEntry) => {
     entry.type.value = "action";
     entry.id = entry.extensions?.tag || entry.id;
@@ -59,6 +64,7 @@ function makeMultiSelect(feed: ZappFeed, key, decoratedFeed) {
             type: actionType,
             options: {
               key,
+              ...(maxItems > 0 && { max_items: maxItems }),
             },
           },
         ],
@@ -159,13 +165,13 @@ export const decorateFeed = (feed: ZappFeed) => {
 
   const decoratedFeed = R.clone(feed);
 
-  const isSingleSelect =
-    (feed.extensions?.preference_editor_options?.select_mode ||
-      feed.extensions?.behavior?.select_mode) === "single";
+  const selectMode =
+    feed.extensions?.preference_editor_options?.select_mode ||
+    feed.extensions?.behavior?.select_mode;
 
-  if (isSingleSelect) {
+  if (selectMode === "single") {
     return makeSingleSelect(feed, key, decoratedFeed);
-  } else {
-    return makeMultiSelect(feed, key, decoratedFeed);
   }
+
+  return makeMultiSelect(feed, key, decoratedFeed);
 };

package/analyticsUtils/PlayerAnalyticsManager.ts

@@ -8,7 +8,7 @@ import {
 } from "../appUtils/playerManager";
 import { Player } from "../appUtils/playerManager/player";
 import { AnalyticPlayerListener } from "./AnalyticPlayerListener";
-import { PlayerRole } from "../appUtils/playerManager/conts";
+import { PlayerRole } from "../appUtils/playerManager/const";
 
 enum PlayerAnalyticsTrackerType {
   PlayerAnalyticsTracker = "PlayerAnalyticsTracker",

package/appUtils/HooksManager/index.ts

@@ -498,6 +498,15 @@ export function HooksManager({
         presentUI
       );
     } catch (e) {
+      // Without this the failure is invisible: the hook stops right after the
+      // "Executing hook" line, with nothing in the log explaining why and no
+      // remaining hook ever running.
+      logHookEvent(
+        hooksManagerLogger.error,
+        `runInBackground: hook ${hookPlugin.identifier} threw: ${e?.message}`,
+        { hook: hookPlugin, payload, error: e, stack: e?.stack }
+      );
+
       hookPlugin.setStateAndNotify(HOOKS_EVENTS.ERROR, {
         error: e,
         hookPlugin,

package/appUtils/contextKeysManager/__tests__/getKey/failure.test.ts

@@ -1,4 +1,4 @@
-import { ContextKeysManager, NOTHING } from "../..";
+import { ContextKeysManager } from "../..";
 
 describe("Context Keys Manager - getKey", () => {
   it("returns null if key is invalid", async () => {
@@ -34,8 +34,6 @@ describe("Context Keys Manager - getKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const getKeyByReference = jest.spyOn(contextManager, "getKeyByReference");
-
     // run
     const result = await contextManager.getKey(invalidKey);
 
@@ -50,7 +48,6 @@ describe("Context Keys Manager - getKey", () => {
       data: { key: invalidKey },
     });
 
-    expect(getKeyByReference).not.toHaveBeenCalled();
     expect(mockedSessionStorage.getItem).not.toHaveBeenCalled();
     expect(mockedLocalStorage.getItem).not.toHaveBeenCalled();
     expect(mockedSecureStorage.getItem).not.toHaveBeenCalled();
@@ -90,10 +87,6 @@ describe("Context Keys Manager - getKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const getKeyByReference = jest
-      .spyOn(contextManager, "getKeyByReference")
-      .mockResolvedValueOnce(NOTHING);
-
     // run
     const result = await contextManager.getKey(key);
 
@@ -107,8 +100,6 @@ describe("Context Keys Manager - getKey", () => {
       data: { key },
     });
 
-    expect(getKeyByReference).toHaveBeenCalledWith("key", "namespace");
-
     expect(mockedSessionStorage.getItem).toHaveBeenCalledWith(
       "key",
       "namespace"
@@ -152,10 +143,6 @@ describe("Context Keys Manager - getKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const getKeyByReference = jest
-      .spyOn(contextManager, "getKeyByReference")
-      .mockResolvedValueOnce(NOTHING);
-
     // run
     const result = await contextManager.getKey(key);
 
@@ -169,8 +156,6 @@ describe("Context Keys Manager - getKey", () => {
       data: { key },
     });
 
-    expect(getKeyByReference).toHaveBeenCalledWith("key", "namespace");
-
     expect(mockedSessionStorage.getItem).toHaveBeenCalledWith(
       "key",
       "namespace"
@@ -214,10 +199,6 @@ describe("Context Keys Manager - getKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const getKeyByReference = jest
-      .spyOn(contextManager, "getKeyByReference")
-      .mockResolvedValueOnce(NOTHING);
-
     // run
     const result = await contextManager.getKey(key);
 
@@ -231,8 +212,6 @@ describe("Context Keys Manager - getKey", () => {
       data: { key },
     });
 
-    expect(getKeyByReference).toHaveBeenCalledWith("key", "namespace");
-
     expect(mockedSessionStorage.getItem).toHaveBeenCalledWith(
       "key",
       "namespace"

package/appUtils/contextKeysManager/__tests__/getKey/success/fullSearch.test.ts

@@ -1,4 +1,4 @@
-import { ContextKeysManager, NOTHING } from "../../..";
+import { ContextKeysManager } from "../../..";
 
 describe("Context Keys Manager - getKey", () => {
   it("returns value if found in session-storage", async () => {
@@ -35,10 +35,6 @@ describe("Context Keys Manager - getKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const getKeyByReference = jest
-      .spyOn(contextManager, "getKeyByReference")
-      .mockResolvedValueOnce(NOTHING);
-
     // run
     const result = await contextManager.getKey(key);
 
@@ -47,8 +43,6 @@ describe("Context Keys Manager - getKey", () => {
 
     expect(mockedLogger.warn).not.toHaveBeenCalled();
 
-    expect(getKeyByReference).toHaveBeenCalledWith("key", "namespace");
-
     expect(mockedSessionStorage.getItem).toHaveBeenCalledWith(
       "key",
       "namespace"
@@ -92,10 +86,6 @@ describe("Context Keys Manager - getKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const getKeyByReference = jest
-      .spyOn(contextManager, "getKeyByReference")
-      .mockResolvedValueOnce(NOTHING);
-
     // run
     const result = await contextManager.getKey(key);
 
@@ -104,8 +94,6 @@ describe("Context Keys Manager - getKey", () => {
 
     expect(mockedLogger.warn).not.toHaveBeenCalled();
 
-    expect(getKeyByReference).toHaveBeenCalledWith("key", "namespace");
-
     expect(mockedSessionStorage.getItem).toHaveBeenCalledWith(
       "key",
       "namespace"
@@ -149,10 +137,6 @@ describe("Context Keys Manager - getKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const getKeyByReference = jest
-      .spyOn(contextManager, "getKeyByReference")
-      .mockResolvedValueOnce(NOTHING);
-
     // run
     const result = await contextManager.getKey(key);
 
@@ -161,8 +145,6 @@ describe("Context Keys Manager - getKey", () => {
 
     expect(mockedLogger.warn).not.toHaveBeenCalled();
 
-    expect(getKeyByReference).toHaveBeenCalledWith("key", "namespace");
-
     expect(mockedSessionStorage.getItem).toHaveBeenCalledWith(
       "key",
       "namespace"
@@ -209,10 +191,6 @@ describe("Context Keys Manager - getKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const getKeyByReference = jest
-      .spyOn(contextManager, "getKeyByReference")
-      .mockResolvedValueOnce(NOTHING);
-
     // run
     const result = await contextManager.getKey(key);
 
@@ -221,8 +199,6 @@ describe("Context Keys Manager - getKey", () => {
 
     expect(mockedLogger.warn).not.toHaveBeenCalled();
 
-    expect(getKeyByReference).toHaveBeenCalledWith("key", "namespace");
-
     expect(mockedSessionStorage.getItem).toHaveBeenCalledWith(
       "key",
       "namespace"

package/appUtils/contextKeysManager/__tests__/getKey/success/searchInSecure.test.ts

@@ -1,4 +1,4 @@
-import { ContextKeysManager, NOTHING } from "../../..";
+import { ContextKeysManager } from "../../..";
 import { DEFAULT_NAMESPACE } from "../../../consts";
 
 describe("Context Keys Manager - getKey", () => {
@@ -36,10 +36,6 @@ describe("Context Keys Manager - getKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const getKeyByReference = jest
-      .spyOn(contextManager, "getKeyByReference")
-      .mockResolvedValueOnce(NOTHING);
-
     // run
     const result = await contextManager.getKey(key);
 
@@ -48,8 +44,6 @@ describe("Context Keys Manager - getKey", () => {
 
     expect(mockedLogger.warn).not.toHaveBeenCalled();
 
-    expect(getKeyByReference).toHaveBeenCalledWith("key", DEFAULT_NAMESPACE);
-
     expect(mockedSessionStorage.getItem).toHaveBeenCalledWith(
       "key",
       DEFAULT_NAMESPACE

package/appUtils/contextKeysManager/__tests__/removeKey/failure.test.ts

@@ -34,11 +34,6 @@ describe("Context Keys Manager - removeKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const removeReferenceForKey = jest.spyOn(
-      contextManager,
-      "removeReferenceForKey"
-    );
-
     // run
     const result = await contextManager.removeKey(key);
 
@@ -51,8 +46,6 @@ describe("Context Keys Manager - removeKey", () => {
       data: { key },
     });
 
-    expect(removeReferenceForKey).not.toHaveBeenCalled();
-
     expect(mockedSessionStorage.removeItem).not.toHaveBeenCalled();
     expect(mockedLocalStorage.removeItem).not.toHaveBeenCalled();
     expect(mockedSecureStorage.removeItem).not.toHaveBeenCalled();
@@ -92,10 +85,6 @@ describe("Context Keys Manager - removeKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const removeReferenceForKey = jest
-      .spyOn(contextManager, "removeReferenceForKey")
-      .mockResolvedValueOnce(true);
-
     // run
     const result = await contextManager.removeKey(key);
 
@@ -107,8 +96,6 @@ describe("Context Keys Manager - removeKey", () => {
       data: { key },
     });
 
-    expect(removeReferenceForKey).toHaveBeenCalledWith("key", "namespace");
-
     expect(mockedSessionStorage.removeItem).toHaveBeenCalledWith(
       "key",
       "namespace"
@@ -159,10 +146,6 @@ describe("Context Keys Manager - removeKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const removeReferenceForKey = jest
-      .spyOn(contextManager, "removeReferenceForKey")
-      .mockResolvedValueOnce(true);
-
     // run
     const result = await contextManager.removeKey(key);
 
@@ -174,8 +157,6 @@ describe("Context Keys Manager - removeKey", () => {
       data: { key },
     });
 
-    expect(removeReferenceForKey).toHaveBeenCalledWith("key", "namespace");
-
     expect(mockedSessionStorage.removeItem).toHaveBeenCalledWith(
       "key",
       "namespace"
@@ -226,10 +207,6 @@ describe("Context Keys Manager - removeKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const removeReferenceForKey = jest
-      .spyOn(contextManager, "removeReferenceForKey")
-      .mockResolvedValueOnce(true);
-
     // run
     const result = await contextManager.removeKey(key);
 
@@ -241,8 +218,6 @@ describe("Context Keys Manager - removeKey", () => {
       data: { key },
     });
 
-    expect(removeReferenceForKey).toHaveBeenCalledWith("key", "namespace");
-
     expect(mockedSessionStorage.removeItem).toHaveBeenCalledWith(
       "key",
       "namespace"

package/appUtils/contextKeysManager/__tests__/removeKey/success.test.ts

@@ -34,10 +34,6 @@ describe("Context Keys Manager - removeKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const removeReferenceForKey = jest
-      .spyOn(contextManager, "removeReferenceForKey")
-      .mockResolvedValueOnce(true);
-
     // run
     const result = await contextManager.removeKey(key);
 
@@ -46,8 +42,6 @@ describe("Context Keys Manager - removeKey", () => {
 
     expect(mockedLogger.warn).not.toHaveBeenCalled();
 
-    expect(removeReferenceForKey).toHaveBeenCalledWith("key", "namespace");
-
     expect(mockedSessionStorage.removeItem).toHaveBeenCalledWith(
       "key",
       "namespace"

package/appUtils/contextKeysManager/__tests__/setKey/failure/failedToSaveInStorage.test.ts

@@ -38,10 +38,6 @@ describe("Context Keys Manager - setKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const setReferenceForKey = jest
-      .spyOn(contextManager, "setReferenceForKey")
-      .mockResolvedValueOnce(true);
-
     // run
     const result = await contextManager.setKey({ key, value, storageLevel });
 
@@ -68,12 +64,6 @@ describe("Context Keys Manager - setKey", () => {
 
     expect(mockedSecureStorage.getItem).not.toHaveBeenCalled();
     expect(mockedSecureStorage.setItem).not.toHaveBeenCalled();
-
-    expect(setReferenceForKey).toHaveBeenCalledWith(
-      "key",
-      "namespace",
-      storageLevel
-    );
   });
 
   it("returns false if failed to saved with storage-level=persisted", async () => {
@@ -112,10 +102,6 @@ describe("Context Keys Manager - setKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const setReferenceForKey = jest
-      .spyOn(contextManager, "setReferenceForKey")
-      .mockResolvedValueOnce(true);
-
     // run
     const result = await contextManager.setKey({ key, value, storageLevel });
 
@@ -142,12 +128,6 @@ describe("Context Keys Manager - setKey", () => {
 
     expect(mockedSecureStorage.getItem).not.toHaveBeenCalled();
     expect(mockedSecureStorage.setItem).not.toHaveBeenCalled();
-
-    expect(setReferenceForKey).toHaveBeenCalledWith(
-      "key",
-      "namespace",
-      storageLevel
-    );
   });
 
   it("returns false if failed to saved with storage-level=secure", async () => {
@@ -186,10 +166,6 @@ describe("Context Keys Manager - setKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const setReferenceForKey = jest
-      .spyOn(contextManager, "setReferenceForKey")
-      .mockResolvedValueOnce(true);
-
     // run
     const result = await contextManager.setKey({ key, value, storageLevel });
 
@@ -216,12 +192,6 @@ describe("Context Keys Manager - setKey", () => {
       value,
       "namespace"
     );
-
-    expect(setReferenceForKey).toHaveBeenCalledWith(
-      "key",
-      "namespace",
-      storageLevel
-    );
   });
 
   it("returns false if failed to saved with storage-level=undefined", async () => {
@@ -259,10 +229,6 @@ describe("Context Keys Manager - setKey", () => {
       secureStorage: mockedSecureStorage,
     });
 
-    const setReferenceForKey = jest
-      .spyOn(contextManager, "setReferenceForKey")
-      .mockResolvedValueOnce(true);
-
     // run
     const result = await contextManager.setKey({ key, value });
 
@@ -289,11 +255,5 @@ describe("Context Keys Manager - setKey", () => {
 
     expect(mockedSecureStorage.getItem).not.toHaveBeenCalled();
     expect(mockedSecureStorage.setItem).not.toHaveBeenCalled();
-
-    expect(setReferenceForKey).toHaveBeenCalledWith(
-      "key",
-      "namespace",
-      StorageLevel.default
-    );
   });
 });