@applicaster/zapp-react-native-utils 14.0.0-alpha.7900711229 → 14.0.0-alpha.9567513212

package/actionsExecutor/ActionExecutorContext.tsx

@@ -16,6 +16,7 @@ import { QUICK_BRICK_EVENTS } from "@applicaster/zapp-react-native-bridge/QuickB
 import { showConfirmationDialog } from "../alertUtils";
 import { createCloudEvent, sendCloudEvent } from "../cloudEventsUtils";
 import { createLogger } from "../logger";
+import { StorageMultiSelectProvider } from "@applicaster/zapp-react-native-bridge/ZappStorage/StorageMultiSelectProvider";
 import { ACTIVE_LAYOUT_ID_STORAGE_KEY } from "@applicaster/quick-brick-core/App/remoteContextReloader/consts";
 import { appStore } from "@applicaster/zapp-react-native-redux/AppStore";
 import { loadPipesData } from "@applicaster/zapp-react-native-redux/ZappPipes";
@@ -24,19 +25,15 @@ import {
   resolveObjectValues,
 } from "../appUtils/contextKeysManager/contextResolver";
 import { useNavigation } from "../reactHooks";
+import { get } from "lodash";
 
 import {
   useContentTypes,
   usePickFromState,
 } from "@applicaster/zapp-react-native-redux/hooks";
-import { useSubscriberFor } from "../reactHooks/useSubscriberFor";
+import { TOGGLE_FLAG_MAX_ITEMS_REACHED_EVENT } from "./consts";
+import { postEvent, useSubscriberFor } from "../reactHooks/useSubscriberFor";
 import { APP_EVENTS } from "../appUtils/events";
-import {
-  localStorageToggleFlag,
-  sessionStorageToggleFlag,
-} from "./StorageActions";
-
-import { screenSetVariable, screenToggleFlag } from "./ScreenActions";
 
 export const { log_error, log_info, log_debug } = createLogger({
   subsystem: "ActionExecutorContext",
@@ -85,6 +82,19 @@ function findParentComponent(
   return null;
 }
 
+// send all data just in case (like for message string formatting)
+// Type is not exported for now
+type MaxTagsReachedEvent = {
+  selectedItems: string[];
+  maxItems: number;
+  tag: string;
+  keyNamespace: string;
+};
+
+async function onMaxTagsReached(data: MaxTagsReachedEvent) {
+  postEvent(TOGGLE_FLAG_MAX_ITEMS_REACHED_EVENT, [data]);
+}
+
 const prepareDefaultActions = (actionExecutor) => {
   actionExecutor.registerAction("localStorageSet", async (action) => {
     const namespaces = action.options.content;
@@ -168,15 +178,10 @@ const prepareDefaultActions = (actionExecutor) => {
 
       const entry = context?.entry || {};
       const entryResolver = new EntryResolver(entry);
-      const screenData = context?.screenStateStore.getState().data || {};
-      const screenResolver = new EntryResolver(screenData || {});
 
       const data =
         options?.data && options.inflateData
-          ? await resolveObjectValues(options.data, {
-              entry: entryResolver,
-              screen: screenResolver,
-            })
+          ? await resolveObjectValues(options.data, { entry: entryResolver })
           : options?.data || entry;
 
       const cloudEvent = await createCloudEvent({
@@ -210,63 +215,81 @@ const prepareDefaultActions = (actionExecutor) => {
     return ActionResult.Error;
   });
 
-  actionExecutor.registerAction(
-    "sessionStorageToggleFlag",
-    async (
-      action: ActionType,
-      context?: Record<string, any>
-    ): Promise<ActionResult> => {
-      return await sessionStorageToggleFlag(context, action);
-    }
-  );
-
   actionExecutor.registerAction(
     "localStorageToggleFlag",
     async (
       action: ActionType,
       context?: Record<string, any>
     ): Promise<ActionResult> => {
-      return await localStorageToggleFlag(context, action);
-    }
-  );
+      if (!context) {
+        log_error(
+          "handleAction: localStorageToggleFlag action missing context"
+        );
 
-  actionExecutor.registerAction(
-    "screenSetVariable",
-    async (
-      action: ActionType,
-      context?: Record<string, any>
-    ): Promise<ActionResult> => {
-      const route = context?.screenRoute;
-      const screenStateStore = context?.screenStateStore;
-
-      await screenSetVariable(
-        route,
-        screenStateStore,
-        { entry: context?.entry, options: action.options },
-        action
-      );
+        return ActionResult.Error;
+      }
 
-      return Promise.resolve(ActionResult.Success);
-    }
-  );
+      const entry = context?.entry as ZappEntry;
 
-  actionExecutor.registerAction(
-    "screenToggleFlag",
-    async (
-      action: ActionType,
-      context?: Record<string, any>
-    ): Promise<ActionResult> => {
-      const screenRoute = context?.screenRoute;
-      const screenStateStore = context?.screenStateStore;
-
-      await screenToggleFlag(
-        screenRoute,
-        screenStateStore,
-        { entry: context?.entry, options: action.options },
-        action
-      );
+      if (!entry) {
+        log_error(
+          "handleAction: localStorageToggleFlag action missing entry. Entry is required to get the tag."
+        );
+
+        return ActionResult.Error;
+      }
+
+      const tag = action.options?.selector
+        ? get(entry, action.options.selector)
+        : (entry.extensions?.tag ?? entry.id);
+
+      const keyNamespace = action.options?.key;
+
+      if (keyNamespace && tag) {
+        const multiSelectProvider =
+          StorageMultiSelectProvider.getProvider(keyNamespace);
+
+        const selectedItems = await multiSelectProvider.getSelectedAsync();
+        const isTagInSelectedItems = selectedItems.includes(tag);
 
-      return Promise.resolve(ActionResult.Success);
+        log_info(
+          `handleAction: localStorageToggleFlag event will ${
+            isTagInSelectedItems ? "remove" : "add"
+          } tag: ${tag} for keyNamespace: ${keyNamespace}, current selectedItems: ${selectedItems}`
+        );
+
+        if (selectedItems.includes(tag)) {
+          await multiSelectProvider.removeItem(tag);
+        } else {
+          const maxItems = action.options?.max_items;
+
+          if (maxItems && selectedItems.length >= maxItems) {
+            log_info(
+              `handleAction: localStorageToggleFlag event reached max items limit: ${maxItems}, cannot add tag: ${tag}`
+            );
+
+            await onMaxTagsReached({
+              selectedItems,
+              maxItems,
+              tag,
+              keyNamespace,
+            });
+
+            return ActionResult.Cancel;
+          }
+
+          await multiSelectProvider.addItem(tag);
+        }
+      } else {
+        log_error(
+          "handleAction: localStorageToggleFlag event missing keyNamespace or tag",
+          { keyNamespace, tag }
+        );
+
+        return ActionResult.Error;
+      }
+
+      return ActionResult.Success;
     }
   );
 };

package/appUtils/contextKeysManager/contextResolver.ts

@@ -1,11 +1,10 @@
 import { ContextKeysManager } from "./index";
 import * as R from "ramda";
 
-export interface IResolver {
+interface IResolver {
   resolve: (string) => Promise<string | number | object>;
 }
 
-// TODO: Rename to ObjectKeyResolver or similar
 export class EntryResolver implements IResolver {
   entry: ZappEntry;
 
@@ -22,18 +21,6 @@ export class EntryResolver implements IResolver {
   }
 }
 
-// TODO: Move to proper place
-
-export class ScreenStateResolver implements IResolver {
-  constructor(private screenStateStore: ScreenStateStore) {}
-
-  async resolve(key: string) {
-    const screenState = this.screenStateStore.getState().data;
-
-    return screenState?.[key];
-  }
-}
-
 export class ContextResolver implements IResolver {
   resolve = async (compositeKey: string) =>
     ContextKeysManager.instance.getKey(compositeKey);

package/arrayUtils/__tests__/isFilledArray.test.ts

@@ -32,7 +32,7 @@ describe("isFilledArray", () => {
   });
 
   it("NaN is not array", () => {
-    const value = NaN;
+    const value = "";
 
     expect(isFilledArray(value)).toBe(false);
   });

package/arrayUtils/index.ts

@@ -99,17 +99,12 @@ export const makeListOf = (value: unknown, size: number): number[] => {
 
 /** Checks if a value is a non-empty array */
 export function isFilledArray(value: unknown): boolean {
-  return Array.isArray(value) && value.length > 0;
-}
-
-/** Checks if a value is a empty array */
-export function isEmptyArray(value: unknown): boolean {
-  return Array.isArray(value) && value.length === 0;
+  return R.is(Array, value) && R.length(value) > 0;
 }
 
 // get random item from the list
 export const sample = (xs: unknown[]): unknown => {
-  invariant(Array.isArray(xs), `input value is not an array: ${xs}`);
+  invariant(R.is(Array, xs), `input value is not a array: ${xs}`);
   invariant(isFilledArray(xs), `input array is empty: ${xs}`);
 
   const index = Math.floor(Math.random() * xs.length);

package/configurationUtils/__tests__/configurationUtils.test.js

@@ -1,8 +1,11 @@
+import * as R from "ramda";
 import {
   populateConfigurationValues,
+  imageSrcFromMediaItem,
   getBoolFromConfigValue,
   remapUpdatedKeys,
 } from "../";
+import { entry } from "./testEntry";
 
 describe("getBoolFromConfigValue", () => {
   it('returns true if value is "true" string', () => {
@@ -54,6 +57,34 @@ describe("getBoolFromConfigValue", () => {
   });
 });
 
+describe("imageSrcFromMediaItem", () => {
+  describe("returns the src value of first media_item", () => {
+    it("when the matching key is found and the src is not empty", () => {
+      const result = imageSrcFromMediaItem(entry, ["logo_thumbnail"]);
+
+      expect(result).toEqual(entry.media_group[1].media_item[0].src);
+      expect(result).not.toEqual("");
+    });
+  });
+
+  it("returns a media item with the 'image_base' key as a fallback", () => {
+    const result = imageSrcFromMediaItem(entry, ["does_not_exist"]);
+    const fallback = entry.media_group[0].media_item[0];
+    expect(result).toEqual(fallback.src);
+    expect(fallback.key).toBe("image_base");
+  });
+
+  it("returns undefined if the key was found but the source was empty", () => {
+    const badEntry = R.set(
+      R.lensPath(["media_group", 0, "media_item", 0, "src"]),
+      "",
+      entry
+    );
+
+    expect(imageSrcFromMediaItem(badEntry, ["image_base"])).toBeUndefined();
+  });
+});
+
 describe("populateConfigurationValues", () => {
   it("transforms and returns the valid values", () => {
     const fields = [

package/configurationUtils/index.ts

@@ -1,12 +1,6 @@
 /// <reference types="@applicaster/applicaster-types" />
 import * as R from "ramda";
 import { Platform } from "react-native";
-import {
-  isFilledArray,
-  isEmptyArray,
-} from "@applicaster/zapp-react-native-utils/arrayUtils";
-import { isEmpty } from "@applicaster/zapp-react-native-utils/utils";
-
 import { applyTransform } from "../transform";
 import { ManifestField } from "../types";
 import { isNilOrEmpty } from "../reactUtils/helpers";
@@ -128,77 +122,54 @@ export function flattenFields(
 }
 
 /**
- * Retrieves all media items from the entry's media_group that are of type "image" or "thumbnail".
- *
- * @param {ZappEntry} entry - The entry object containing the media_group array.
- * @returns {Option<ZappMediaItem[]>} An array of media items of type "image" or "thumbnail", or undefined if no media_group is present.
- */
-export function getMediaItems(entry: ZappEntry): Option<ZappMediaItem[]> {
-  const mediaGroup = entry?.media_group || [];
-
-  if (isEmptyArray(mediaGroup)) {
-    return undefined;
-  }
-
-  const mediaItems = mediaGroup
-    .filter((group) => ["image", "thumbnail"].includes(group.type))
-    .flatMap((group) =>
-      Array.isArray(group.media_item) ? group.media_item : [group.media_item]
-    );
-
-  if (isFilledArray(mediaItems)) {
-    return mediaItems;
-  }
-
-  return undefined;
-}
-
-/**
- * Retrieves the "src" value from a media item in the entry's media group,
- * based on a provided key, with fallback logic.
- *
- * Fallback order:
- *   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.
- *
- * Special handling: If the resolved item's "src" is an empty string, returns undefined,
- * 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.
- * @returns {?string} The "src" URI from the matched media item, or undefined if not found or empty.
+ * Retrieves the value of the "src" in the first media_item
+ * that has the matching key provided in args.
+ * Fallbacks: "image_base" key, or first media_item that has any "src"
+ * @param {Object} entry    Single entry from a feed
+ * @param {Array} arg      Array with a single element - the key of the media item
+ *                          from which the "src" should be retrieved
+ * @returns {?String}       Value of "src", usually a URI
  */
 export function imageSrcFromMediaItem(
   entry: ZappEntry,
   arg: string[] | unknown
-): Option<string> {
+) {
   const args: unknown = R.unless(Array.isArray, Array)(arg || []);
   const imageKey: string = args?.[0] || "image_base"; // always a single key in this function
+  const mediaGroup = R.path<ZappMediaGroup[]>(["media_group"], entry);
 
-  const mediaItems = getMediaItems(entry);
-
-  if (!mediaItems) {
+  if (!mediaGroup) {
     return undefined;
   }
 
-  // Try to find the item with the given key
-  let foundItem = mediaItems.find((item) => item.key === imageKey);
+  const hasTypeImageOrThumbnail = R.either(
+    R.propEq("type", "image"),
+    R.propEq("type", "thumbnail")
+  );
+
+  const pickMediaItemProp = R.prop<ZappMediaItem>("media_item");
 
-  // 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");
-  }
+  const mediaItems = R.compose(
+    R.flatten,
+    R.map(pickMediaItemProp),
+    R.filter(hasTypeImageOrThumbnail)
+  )(mediaGroup);
 
-  // If still not found, default to first item
-  if (!foundItem) {
-    foundItem = mediaItems[0];
+  if (!mediaItems) {
+    return undefined;
   }
 
-  const src = foundItem?.src;
-
-  // React Native quirk: empty string is invalid for URIs
-  return isEmpty(src) ? undefined : src;
+  const src = R.compose(
+    R.prop("src"),
+    R.defaultTo(R.head(mediaItems)),
+    R.when(R.isNil, () => R.find(R.propEq("key", "image_base"), mediaItems)),
+    R.find(R.propEq("key", imageKey))
+  )(mediaItems);
+
+  // Special case for react native - uri cannot be an empty string (yellow warning).
+  // R.isEmpty is tailored specifically for checks like these,
+  // it returns false for undefined values.
+  return R.isEmpty(src) ? undefined : src;
 }
 
 /**

package/manifestUtils/{_internals/index.js → _internals.js}

@@ -1,7 +1,6 @@
 const R = require("ramda");
 const camelize = require("camelize");
-
-const { getDefaultConfiguration } = require("./getDefaultConfiguration");
+const { defaultConfigurations } = require("./defaultManifestConfigurations");
 
 const toSnakeCase = R.compose(R.replace(/\s/g, "_"), R.toLower, R.trim);
 
@@ -174,6 +173,30 @@ function generateFieldsFromDefaultsWithoutPrefixedLabel(
   )(fields);
 }
 
+/**
+ * returns default configuration keys for provided plugin type
+ * @param {('general-content'|'player')} pluginType
+ * @param options manifest generator information
+ * @param {string} options.version manifest version
+ * @param {string} options.platform qb platform value
+ */
+function getDefaultConfiguration(pluginType, options) {
+  const defConfig = R.compose(
+    R.unless(R.isNil, (fn) => fn(options)),
+    R.propOr(null, pluginType)
+  )(defaultConfigurations);
+
+  if (!defConfig) {
+    const availableKeys = R.keys(defaultConfigurations);
+
+    const message = `Requested key "${pluginType}" doesn't exist in the default configuration\nAvailable keys: ${availableKeys}`;
+    // eslint-disable-next-line no-console
+    console.warn(message);
+  }
+
+  return defConfig;
+}
+
 module.exports = {
   toSnakeCase,
   toCamelCase,

package/manifestUtils/createConfig.js

@@ -1,8 +1,5 @@
 const R = require("ramda");
-
-const {
-  getDefaultConfiguration,
-} = require("./_internals/getDefaultConfiguration");
+const { getDefaultConfiguration } = require("./_internals");
 
 const indexByKey = R.indexBy((obj) => R.prop(obj.group ? "label" : "key", obj));
 const propIfExist = R.curry((prop) => R.when(R.prop(prop), R.prop(prop)));