@applicaster/zapp-react-native-utils 16.0.0-rc.54 → 16.0.0-rc.55

package/actionsExecutor/actions/__tests__/showToast.test.ts

@@ -11,14 +11,13 @@ describe("showToastAction", () => {
     jest.clearAllMocks();
   });
 
-  it("calls postEvent with showToast payload and returns ActionResult.Success", async () => {
+  it("calls postEvent with confirmation source, default timeout, and returns Success", async () => {
     const action = {
       type: "showToast",
       options: {
         id: "toast-1",
         message: "Added to queue",
         extraMessage: "Extra info",
-        timeout: 3000,
       },
     };
 
@@ -32,13 +31,38 @@ describe("showToastAction", () => {
         message: "Added to queue",
         extraMessage: "Extra info",
         style: undefined,
-        timeout: 3000,
+        timeout: 1000,
+        source: "confirmation",
       },
     ]);
 
     expect(result).toBe(ActionResult.Success);
   });
 
+  it("preserves an explicit timeout and style override", async () => {
+    const action = {
+      type: "showToast",
+      options: {
+        message: "Playlist created",
+        timeout: 3000,
+        style: { backgroundColor: "#00FF00" },
+      },
+    };
+
+    await showToastAction(action);
+
+    expect(postEvent).toHaveBeenCalledWith("showToast", [
+      {
+        id: undefined,
+        message: "Playlist created",
+        extraMessage: undefined,
+        style: { backgroundColor: "#00FF00" },
+        timeout: 3000,
+        source: "confirmation",
+      },
+    ]);
+  });
+
   it("handles missing or empty options without throwing", async () => {
     const action = {
       type: "showToast",
@@ -54,7 +78,8 @@ describe("showToastAction", () => {
         message: undefined,
         extraMessage: undefined,
         style: undefined,
-        timeout: undefined,
+        timeout: 1000,
+        source: "confirmation",
       },
     ]);
 

package/actionsExecutor/actions/showToast.ts

@@ -3,8 +3,61 @@ 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 = 1000;
+
 /**
- * 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 1000 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;
@@ -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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applicaster/zapp-react-native-utils",
-  "version": "16.0.0-rc.54",
+  "version": "16.0.0-rc.55",
   "description": "Applicaster Zapp React Native utilities package",
   "main": "index.js",
   "types": "index.d.ts",
@@ -27,7 +27,7 @@
   },
   "homepage": "https://github.com/applicaster/quickbrick#readme",
   "dependencies": {
-    "@applicaster/applicaster-types": "16.0.0-rc.54",
+    "@applicaster/applicaster-types": "16.0.0-rc.55",
     "buffer": "^5.2.1",
     "camelize": "^1.0.0",
     "dayjs": "^1.11.10",