@applicaster/zapp-react-native-utils 15.0.0-alpha.4153840309 → 15.0.0-alpha.4200413542

package/cloudEventsUtils/index.ts

@@ -3,6 +3,41 @@ import { RequestBuilder } from "@applicaster/zapp-pipes-v2-client";
 import { sessionStorage } from "@applicaster/zapp-react-native-bridge/ZappStorage/SessionStorage";
 import { getAppUrlScheme } from "@applicaster/zapp-react-native-utils/appDataUtils";
 
+/**
+ * CloudEvents v1.0 compliant event object
+ * @see https://github.com/cloudevents/spec/blob/v1.0/spec.md
+ */
+export interface CloudEvent<T = any> {
+  /** CloudEvents specification version (always "1.0") */
+  specversion: "1.0";
+  /** Type of event (e.g., "user.action", "commerce.purchase") */
+  type: string;
+  /** Identifier for the entity that produced the event */
+  source: string;
+  /** Unique identifier for the event */
+  id: string;
+  /** Subject of the event in the context of the event producer */
+  subject: string;
+  /** Timestamp of when the event occurred (ISO 8601 format) */
+  time: string;
+  /** Content type of the data attribute (always "application/json") */
+  datacontenttype: "application/json";
+  /** Event payload */
+  data: T;
+}
+
+/**
+ * Parameters required to create a cloud event
+ */
+export interface CreateCloudEventParams<T = any> {
+  /** Type of event (e.g., "user.action", "commerce.purchase") */
+  type: string;
+  /** Subject of the event in the context of the event producer */
+  subject: string;
+  /** Event payload */
+  data: T;
+}
+
 let source: string | null = null;
 
 const addSource = async () => {
@@ -26,7 +61,36 @@ const addSource = async () => {
   return source;
 };
 
-export const createCloudEvent = async ({ type, subject, data }) => {
+/**
+ * Resets the cached CloudEvents source.
+ *
+ * @internal
+ * @testonly This function is intended for test use only and will only work in test environments.
+ *
+ * @remarks
+ * This function clears the cached source value, forcing the next call to `createCloudEvent`
+ * to regenerate the source from app metadata. It only operates when NODE_ENV is set to "test"
+ * to prevent accidental misuse in production code.
+ *
+ * @example
+ * ```typescript
+ * // In Jest tests
+ * beforeEach(() => {
+ *   resetCloudEventsSource();
+ * });
+ * ```
+ */
+export const resetCloudEventsSource = (): void => {
+  if (process.env.NODE_ENV === "test") {
+    source = null;
+  }
+};
+
+export const createCloudEvent = async <T = any>({
+  type,
+  subject,
+  data,
+}: CreateCloudEventParams<T>): Promise<CloudEvent<T>> => {
   return {
     specversion: "1.0",
     type,

package/configurationUtils/__tests__/imageSrcFromMediaItem.test.ts

@@ -31,4 +31,42 @@ describe("imageSrcFromMediaItem", () => {
 
     expect(imageSrcFromMediaItem(badEntry, ["image_base"])).toBeUndefined();
   });
+
+  it("returns undefined when fallback is false and key is not found", () => {
+    const result = imageSrcFromMediaItem(entry as ZappEntry, [
+      "does_not_exist",
+      false,
+    ]);
+
+    expect(result).toBeUndefined();
+  });
+
+  it("returns src when fallback is false and key is found", () => {
+    const result = imageSrcFromMediaItem(entry as ZappEntry, [
+      "logo_thumbnail",
+      false,
+    ]);
+
+    expect(result).toEqual(entry.media_group[1].media_item[0].src);
+  });
+
+  it("returns image_base as fallback when fallback is explicitly true and key is not found", () => {
+    const result = imageSrcFromMediaItem(entry as ZappEntry, [
+      "does_not_exist",
+      true,
+    ]);
+
+    const fallback = entry.media_group[0].media_item[0];
+    expect(result).toEqual(fallback.src);
+    expect(fallback.key).toBe("image_base");
+  });
+
+  it("returns src when fallback is explicitly true and key is found", () => {
+    const result = imageSrcFromMediaItem(entry as ZappEntry, [
+      "logo_thumbnail",
+      true,
+    ]);
+
+    expect(result).toEqual(entry.media_group[1].media_item[0].src);
+  });
 });

package/configurationUtils/__tests__/manifestKeyParser.test.ts

@@ -50,7 +50,7 @@ describe("getAllSpecificStyles", () => {
       });
 
       expect(outStyles).toHaveProperty("default");
-      expect(outStyles["default"]).toEqual({});
+      expect(outStyles.default).toEqual({});
     });
 
     it("should handle empty configuration", () => {
@@ -83,7 +83,7 @@ describe("getAllSpecificStyles", () => {
         outStyles,
       });
 
-      expect(outStyles["default"]).toEqual({
+      expect(outStyles.default).toEqual({
         backgroundColor: "#FF0000",
         borderWidth: 2,
       });
@@ -104,7 +104,7 @@ describe("getAllSpecificStyles", () => {
         outStyles,
       });
 
-      expect(outStyles["default"]).toEqual({
+      expect(outStyles.default).toEqual({
         backgroundColor: "#FF0000",
         textSize: 16,
       });
@@ -126,7 +126,7 @@ describe("getAllSpecificStyles", () => {
         outStyles,
       });
 
-      expect(outStyles["default"]).toEqual({
+      expect(outStyles.default).toEqual({
         backgroundColor: "#FF0000",
       });
     });
@@ -148,11 +148,11 @@ describe("getAllSpecificStyles", () => {
         outStyles,
       });
 
-      expect(outStyles["default"]).toEqual({
+      expect(outStyles.default).toEqual({
         backgroundColor: "#FF0000",
       });
 
-      expect(outStyles["pressed"]).toEqual({
+      expect(outStyles.pressed).toEqual({
         backgroundColor: "#00FF00",
       });
     });
@@ -171,7 +171,7 @@ describe("getAllSpecificStyles", () => {
         outStyles,
       });
 
-      expect(outStyles["focused"]).toEqual({
+      expect(outStyles.focused).toEqual({
         borderWidth: 3,
       });
     });
@@ -190,7 +190,7 @@ describe("getAllSpecificStyles", () => {
         outStyles,
       });
 
-      expect(outStyles["selected"]).toEqual({
+      expect(outStyles.selected).toEqual({
         opacity: 0.5,
       });
     });
@@ -209,7 +209,7 @@ describe("getAllSpecificStyles", () => {
         outStyles,
       });
 
-      expect(outStyles["focused_selected"]).toEqual({
+      expect(outStyles.focused_selected).toEqual({
         scale: 1.2,
       });
     });
@@ -232,21 +232,21 @@ describe("getAllSpecificStyles", () => {
         outStyles,
       });
 
-      expect(outStyles["default"]).toEqual({
+      expect(outStyles.default).toEqual({
         backgroundColor: "#FF0000",
         borderWidth: 1,
         opacity: 1,
       });
 
       // Pressed should have default styles merged with its specific override
-      expect(outStyles["pressed"]).toEqual({
+      expect(outStyles.pressed).toEqual({
         backgroundColor: "#00FF00", // Override
         borderWidth: 1, // From default
         opacity: 1, // From default
       });
 
       // Focused should have default styles merged with its specific override
-      expect(outStyles["focused"]).toEqual({
+      expect(outStyles.focused).toEqual({
         backgroundColor: "#FF0000", // From default
         borderWidth: 1, // From default
         opacity: 0.8, // Override
@@ -270,7 +270,7 @@ describe("getAllSpecificStyles", () => {
         outStyles,
       });
 
-      expect(outStyles["pressed"]).toEqual({
+      expect(outStyles.pressed).toEqual({
         existingKey: "existingValue", // Should be preserved
         backgroundColor: "#FF0000", // From default
         textColor: "#FFFFFF", // New pressed style
@@ -294,7 +294,7 @@ describe("getAllSpecificStyles", () => {
         outStyles,
       });
 
-      expect(outStyles["default"]).toEqual({
+      expect(outStyles.default).toEqual({
         backgroundColor: "#FF0000", // Samsung-specific should be included
       });
     });
@@ -317,7 +317,7 @@ describe("getAllSpecificStyles", () => {
         outStyles,
       });
 
-      expect(outStyles["default"]).toEqual({
+      expect(outStyles.default).toEqual({
         backgroundColor: "#FFFFFF", // Only non-platform specific
       });
     });
@@ -336,7 +336,7 @@ describe("getAllSpecificStyles", () => {
         outStyles,
       });
 
-      expect(outStyles["default"]).toEqual({
+      expect(outStyles.default).toEqual({
         color: "#FF0000",
       });
     });
@@ -356,7 +356,7 @@ describe("getAllSpecificStyles", () => {
         outStyles,
       });
 
-      expect(outStyles["pressed"]).toEqual({
+      expect(outStyles.pressed).toEqual({
         backgroundColor: "#FF0000", // Only samsung style
       });
     });
@@ -377,7 +377,7 @@ describe("getAllSpecificStyles", () => {
         outStyles,
       });
 
-      expect(outStyles["default"]).toEqual({
+      expect(outStyles.default).toEqual({
         backgroundColor: "#00FF00", // Samsung-specific should win
       });
     });
@@ -412,14 +412,14 @@ describe("getAllSpecificStyles", () => {
         outStyles,
       });
 
-      expect(outStyles["default"]).toEqual({
+      expect(outStyles.default).toEqual({
         backgroundColor: "#FFFFFF",
         textColor: "#000000",
         borderWidth: 1,
         padding: 10,
       });
 
-      expect(outStyles["pressed"]).toEqual({
+      expect(outStyles.pressed).toEqual({
         backgroundColor: "#EEEEEE",
         textColor: "#000000",
         borderWidth: 1,
@@ -427,7 +427,7 @@ describe("getAllSpecificStyles", () => {
         opacity: 0.8,
       });
 
-      expect(outStyles["focused"]).toEqual({
+      expect(outStyles.focused).toEqual({
         backgroundColor: "#FFFFFF",
         textColor: "#000000",
         borderWidth: 1,
@@ -453,7 +453,7 @@ describe("getAllSpecificStyles", () => {
         outStyles,
       });
 
-      expect(outStyles["default"]).toEqual({
+      expect(outStyles.default).toEqual({
         validKey: "included",
       });
     });
@@ -474,11 +474,11 @@ describe("getAllSpecificStyles", () => {
         outStyles,
       });
 
-      expect(outStyles["focused_selected"]).toEqual({
+      expect(outStyles.focused_selected).toEqual({
         test: "focused_selected_value",
       });
 
-      expect(outStyles["focused"]).toEqual({
+      expect(outStyles.focused).toEqual({
         another: "focused_value",
       });
     });
@@ -517,7 +517,7 @@ describe("getAllSpecificStyles", () => {
         outStyles,
       });
 
-      expect(outStyles["pressed"]["backgroundColor"]).toBe("#222222");
+      expect(outStyles.pressed.backgroundColor).toBe("#222222");
     });
 
     it("should handle frozen outStyles properties", () => {
@@ -537,7 +537,7 @@ describe("getAllSpecificStyles", () => {
       });
 
       // Should create new object instead of mutating frozen one
-      expect(outStyles["default"]).toEqual({
+      expect(outStyles.default).toEqual({
         existingProp: "value",
         backgroundColor: "#FF0000",
       });

package/configurationUtils/index.ts

@@ -155,9 +155,9 @@ export function getMediaItems(entry: ZappEntry): Option<ZappMediaItem[]> {
 
 /**
  * Retrieves the "src" value from a media item in the entry's media group,
- * based on a provided key, with fallback logic.
+ * based on a provided key, with optional fallback logic.
  *
- * Fallback order:
+ * Fallback order (when enabled):
  *   1. Attempts to find a media item with the specified key (or "image_base" if none provided).
  *   2. If not found, attempts to find a media item with the key "image_base".
  *   3. If still not found, falls back to the first available media item.
@@ -166,15 +166,19 @@ export function getMediaItems(entry: ZappEntry): Option<ZappMediaItem[]> {
  * since empty URIs are invalid in some platforms (e.g., React Native).
  *
  * @param {ZappEntry} entry - The entry object containing a media group.
- * @param {string[] | unknown} arg - A single-element array containing the key to look up, or any unknown value.
+ * @param {string[] | unknown} arg - Can be an array or any other value (treated as empty array).
+ *   When an array:
+ *   - First element: The key to look up. If omitted or undefined, defaults to "image_base".
+ *   - Second element: Boolean to enable/disable fallback logic. If omitted or undefined, defaults to true.
  * @returns {?string} The "src" URI from the matched media item, or undefined if not found or empty.
  */
 export function imageSrcFromMediaItem(
   entry: ZappEntry,
   arg: string[] | unknown
 ): Option<string> {
-  const args: unknown = R.unless(Array.isArray, Array)(arg || []);
+  const args: any = R.unless(Array.isArray, Array)(arg || []);
   const imageKey: string = args?.[0] || "image_base"; // always a single key in this function
+  const fallback: boolean = args?.[1] !== false;
 
   const mediaItems = getMediaItems(entry);
 
@@ -185,14 +189,16 @@ export function imageSrcFromMediaItem(
   // Try to find the item with the given key
   let foundItem = mediaItems.find((item) => item.key === imageKey);
 
-  // If not found and key was not "image_base", try to find "image_base"
-  if (!foundItem && imageKey !== "image_base") {
-    foundItem = mediaItems.find((item) => item.key === "image_base");
-  }
+  if (fallback) {
+    // If not found and key was not "image_base", try to find "image_base"
+    if (!foundItem && imageKey !== "image_base") {
+      foundItem = mediaItems.find((item) => item.key === "image_base");
+    }
 
-  // If still not found, default to first item
-  if (!foundItem) {
-    foundItem = mediaItems[0];
+    // If still not found, default to first item
+    if (!foundItem) {
+      foundItem = mediaItems[0];
+    }
   }
 
   const src = foundItem?.src;