@applicaster/zapp-react-native-utils 14.0.0-alpha.2345544020 → 14.0.0-alpha.3038031102

package/manifestUtils/progressBar/__tests__/mobileProgressBar.test.js

@@ -18,36 +18,6 @@ describe("mobileProgressBar", () => {
     ]),
   });
 
-  // const timeRemainingLabelConditions = (condition) => ({
-  //   rules: "all_conditions",
-  //   conditional_fields: compact([
-  //     {
-  //       key: "assets/progress_bar_switch",
-  //       condition_value: true,
-  //     },
-  //     {
-  //       key: "assets/progress_bar_time_remaining_label_enable",
-  //       condition_value: true,
-  //     },
-  //     condition,
-  //   ]),
-  // });
-
-  // const watchedLabelConditions = (condition) => ({
-  //   rules: "all_conditions",
-  //   conditional_fields: compact([
-  //     {
-  //       key: "assets/progress_bar_switch",
-  //       condition_value: true,
-  //     },
-  //     {
-  //       key: "assets/progress_bar_watched_label_enable",
-  //       condition_value: true,
-  //     },
-  //     condition,
-  //   ]),
-  // });
-
   it("generate progress-bar configuration - enabled and with bottom_of_cell", () => {
     const enable = true;
     const hideUnwatched = true;

package/manifestUtils/sharedConfiguration/screenPicker/stylesFields.js

@@ -8,7 +8,6 @@ const {
   conditional_horizontal_type,
   conditional_vertical_type,
   conditional_horizontal_type_item_fixed,
-  conditional_horizontal_type_item_dynamic,
   conditional_horizontal_asset_on,
   conditional_horizontal_display_type_fixed,
 } = require("./utils");
@@ -48,7 +47,7 @@ const componentConfigurationFields = [
       { text: "Right", value: "right" },
       { text: "Center", value: "center" },
     ],
-    ...conditional_horizontal_type_item_dynamic,
+    ...conditional_horizontal_type,
   },
   {
     type: "select",

package/navigationUtils/__tests__/mapContentTypesToRivers.test.ts

@@ -0,0 +1,130 @@
+import { mapContentTypesToRivers } from "../index";
+
+describe("mapContentTypesToRivers", () => {
+  it("should return the correct content types mapped to rivers", () => {
+    const state = {
+      rivers: {
+        "river-1": {
+          plugin_type: "river",
+        },
+      },
+      contentTypes: {
+        "content-type-1": {
+          screen_id: "river-1",
+        },
+      },
+    };
+
+    const result = mapContentTypesToRivers(state);
+
+    expect(result).toEqual({
+      "content-type-1": {
+        screenType: "river",
+        screen_id: "river-1",
+      },
+    });
+  });
+
+  it("should return null if contentTypes is undefined", () => {
+    const state = {
+      rivers: {
+        "river-1": {
+          plugin_type: "river",
+        },
+      },
+      // contentTypes is missing
+    };
+
+    const result = mapContentTypesToRivers(state);
+
+    expect(result).toBeNull();
+  });
+
+  it("should skip content types whose screen does not exist in rivers", () => {
+    const state = {
+      rivers: {
+        "river-1": {
+          plugin_type: "river",
+        },
+      },
+      contentTypes: {
+        "content-type-1": {
+          screen_id: "river-1",
+        },
+        "content-type-2": {
+          screen_id: "river-2", // river-2 does not exist
+        },
+      },
+    };
+
+    const result = mapContentTypesToRivers(state);
+
+    expect(result).toEqual({
+      "content-type-1": {
+        screenType: "river",
+        screen_id: "river-1",
+      },
+    });
+
+    // result is not null, but may be undefined for missing keys
+    expect(result && result["content-type-2"]).toBeUndefined();
+  });
+
+  it("should use 'type' if 'plugin_type' is not present in river", () => {
+    const state = {
+      rivers: {
+        "river-1": {
+          type: "custom-type",
+        },
+      },
+      contentTypes: {
+        "content-type-1": {
+          screen_id: "river-1",
+        },
+      },
+    };
+
+    const result = mapContentTypesToRivers(state);
+
+    expect(result).toEqual({
+      "content-type-1": {
+        screenType: "custom-type",
+        screen_id: "river-1",
+      },
+    });
+  });
+
+  it("should skip content types if neither plugin_type nor type is present in river", () => {
+    const state = {
+      rivers: {
+        "river-1": {
+          // no plugin_type or type
+        },
+      },
+      contentTypes: {
+        "content-type-1": {
+          screen_id: "river-1",
+        },
+      },
+    };
+
+    const result = mapContentTypesToRivers(state);
+
+    expect(result).toEqual({});
+  });
+
+  it("should handle empty contentTypes object", () => {
+    const state = {
+      rivers: {
+        "river-1": {
+          plugin_type: "river",
+        },
+      },
+      contentTypes: {},
+    };
+
+    const result = mapContentTypesToRivers(state);
+
+    expect(result).toEqual({});
+  });
+});

package/navigationUtils/index.ts

@@ -13,6 +13,7 @@ import {
   isPlayable,
   isV2River,
 } from "./itemTypeMatchers";
+import { RootState } from "@applicaster/zapp-react-native-redux/store";
 
 type PathAttribute = {
   screenType: string;
@@ -377,10 +378,11 @@ export const usesVideoModal = (
   return targetScreenConfiguration?.styles?.use_video_modal;
 };
 
-export const mapContentTypesToRivers = ({
-  rivers,
-  contentTypes,
-}): ZappContentTypesMapped | null => {
+export const mapContentTypesToRivers = (
+  state: Partial<RootState>
+): ZappContentTypesMapped | null => {
+  const { rivers, contentTypes } = state;
+
   if (!contentTypes) {
     return null;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applicaster/zapp-react-native-utils",
-  "version": "14.0.0-alpha.2345544020",
+  "version": "14.0.0-alpha.3038031102",
   "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": "14.0.0-alpha.2345544020",
+    "@applicaster/applicaster-types": "14.0.0-alpha.3038031102",
     "buffer": "^5.2.1",
     "camelize": "^1.0.0",
     "dayjs": "^1.11.10",

package/playerUtils/__tests__/configurationUtils.test.ts

@@ -1,72 +1,8 @@
 import * as utils from "../configurationUtils";
 
-const { modifyDefaultConfigValues, parseLanguageTracks } = utils;
-
-const configuration = {
-  general: { fields: [{ key: "general_1", initial_value: true }] },
-  styles: { fields: [{ key: "styles_1", initial_value: true }] },
-  localizations: {
-    fields: [{ key: "localizations_1", initial_value: true, label: "label" }],
-  },
-  custom_configuration_fields: [
-    { key: "custom_configuration_fields_1", initial_value: true },
-    { key: "custom_configuration_fields_2", initial_value: "black" },
-    {
-      group: true,
-      fields: [{ key: "custom_configuration_fields_3", initial_value: "red" }],
-    },
-  ],
-};
+const { parseLanguageTracks } = utils;
 
 describe("utilities", () => {
-  describe("modifyDefaultConfigValues", () => {
-    it("should not modify the configuration if a map key doesn't exist in configuration ", function () {
-      const res = modifyDefaultConfigValues(configuration, {
-        custom_configuration_fields: {
-          non_existing_key: { initial_value: "true" },
-        },
-      });
-
-      expect(res).toEqual(configuration);
-    });
-
-    it("should modify the key from mapping", function () {
-      const currentResult = modifyDefaultConfigValues(configuration, {
-        styles: { styles_1: { initial_value: false } },
-      });
-
-      expect(currentResult.styles.fields[0].initial_value).toBe(false);
-    });
-
-    it("should add extra keys the key from mapping", function () {
-      const currentResult = modifyDefaultConfigValues(configuration, {
-        styles: { styles_1: { extra_key: false } },
-      });
-
-      expect(currentResult.styles.fields[0].extra_key).toBeDefined();
-    });
-
-    it("should not remove existing keys that aren't being overwritten", function () {
-      const currentResult = modifyDefaultConfigValues(configuration, {
-        localizations: { localizations_1: { initial_value: false } },
-      });
-
-      expect(currentResult.localizations.fields[0].label).toBeDefined();
-    });
-
-    it("should modify values in groups as well", function () {
-      const currentResult = modifyDefaultConfigValues(configuration, {
-        custom_configuration_fields: {
-          custom_configuration_fields_3: { initial_value: "blue" },
-        },
-      });
-
-      expect(
-        currentResult.custom_configuration_fields[2].fields[0].initial_value
-      ).toBe("blue");
-    });
-  });
-
   describe("parseLanguageTracks", () => {
     const textTrack = { index: 0, id: "text-0" };
     const audioTrack = { index: 0, id: "audio-0" };

package/playerUtils/__tests__/getPlayerActionButtons.test.ts

@@ -0,0 +1,54 @@
+import { getPlayerActionButtons } from "../getPlayerActionButtons";
+import { selectActionButtons } from "../../conf/player/selectors";
+
+jest.mock("../../conf/player/selectors", () => ({
+  selectActionButtons: jest.fn(),
+}));
+
+describe("getPlayerActionButtons", () => {
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it("returns an empty array if selectActionButtons returns undefined", () => {
+    (selectActionButtons as jest.Mock).mockReturnValue(undefined);
+    const result = getPlayerActionButtons({});
+    expect(result).toEqual([]);
+  });
+
+  it("returns an empty array if selectActionButtons returns null", () => {
+    (selectActionButtons as jest.Mock).mockReturnValue(null);
+    const result = getPlayerActionButtons({});
+    expect(result).toEqual([]);
+  });
+
+  it("returns an empty array if selectActionButtons returns empty string", () => {
+    (selectActionButtons as jest.Mock).mockReturnValue("");
+    const result = getPlayerActionButtons({});
+    expect(result).toEqual([]);
+  });
+
+  it("returns the first two trimmed action buttons", () => {
+    (selectActionButtons as jest.Mock).mockReturnValue(" play , pause , stop ");
+    const result = getPlayerActionButtons({});
+    expect(result).toEqual(["play", "pause"]);
+  });
+
+  it("returns only one button if only one is present", () => {
+    (selectActionButtons as jest.Mock).mockReturnValue(" play ");
+    const result = getPlayerActionButtons({});
+    expect(result).toEqual(["play"]);
+  });
+
+  it("trims whitespace from button names", () => {
+    (selectActionButtons as jest.Mock).mockReturnValue("  play  ,   pause  ");
+    const result = getPlayerActionButtons({});
+    expect(result).toEqual(["play", "pause"]);
+  });
+
+  it("returns an empty array if selectActionButtons returns only commas", () => {
+    (selectActionButtons as jest.Mock).mockReturnValue(" , , ");
+    const result = getPlayerActionButtons({});
+    expect(result).toEqual(["", ""]);
+  });
+});

package/playerUtils/_internals/__tests__/utils.test.ts

@@ -0,0 +1,71 @@
+import { getAllFields, getConfigurationDiff } from "../utils";
+
+describe("getAllFields", () => {
+  it("should return all field keys from flat configs", () => {
+    const config1 = {
+      fields: [{ key: "foo" }, { key: "bar" }],
+    };
+
+    const config2 = {
+      fields: [{ key: "baz" }],
+    };
+
+    expect(getAllFields(config1, config2)).toEqual(["foo", "bar", "baz"]);
+  });
+
+  it("should handle grouped fields", () => {
+    const config = {
+      fields: [
+        {
+          group: true,
+          fields: [{ key: "grouped1" }, { key: "grouped2" }],
+        },
+        { key: "single" },
+      ],
+    };
+
+    expect(getAllFields(config)).toEqual(["grouped1", "grouped2", "single"]);
+  });
+
+  it("should filter out fields without a key", () => {
+    const config = {
+      fields: [{ key: "foo" }, { notAKey: "bar" }],
+    };
+
+    expect(getAllFields(config)).toEqual(["foo"]);
+  });
+
+  it("should return an empty array if no fields are present", () => {
+    expect(getAllFields({})).toEqual([]);
+  });
+});
+
+describe("getConfigurationDiff", () => {
+  it("should return keys in defaultConfig not present in config", () => {
+    const defaultConfig = ["foo", "bar", "baz"];
+    const config = { foo: 1, baz: 2 };
+
+    expect(getConfigurationDiff(defaultConfig, config)).toEqual(["bar"]);
+  });
+
+  it("should return all keys if config is empty", () => {
+    const defaultConfig = ["foo", "bar"];
+    const config = {};
+
+    expect(getConfigurationDiff(defaultConfig, config)).toEqual(["foo", "bar"]);
+  });
+
+  it("should return an empty array if all keys are present", () => {
+    const defaultConfig = ["foo"];
+    const config = { foo: 1 };
+
+    expect(getConfigurationDiff(defaultConfig, config)).toEqual([]);
+  });
+
+  it("should return defaultConfig if config has no matching keys", () => {
+    const defaultConfig = ["foo", "bar"];
+    const config = { baz: 1 };
+
+    expect(getConfigurationDiff(defaultConfig, config)).toEqual(["foo", "bar"]);
+  });
+});

package/playerUtils/_internals/index.ts

@@ -0,0 +1 @@
+export * from "./utils";

package/playerUtils/_internals/utils.ts

@@ -0,0 +1,31 @@
+import {
+  flatMap,
+  get,
+  flatten,
+  difference,
+} from "@applicaster/zapp-react-native-utils/utils";
+
+const extractFields = (field: any) => {
+  if (field.group === true) {
+    return field.fields;
+  }
+
+  return field;
+};
+
+export const getAllFields = (...configs: any[]) => {
+  const allFields = flatMap(configs, (config) => get(config, "fields", []));
+
+  const processedFields = flatten(allFields.map(extractFields))
+    .map((field) => get(field, "key"))
+    .filter(Boolean);
+
+  return processedFields;
+};
+
+export const getConfigurationDiff = (
+  defaultConfig,
+  config: Record<string, any>
+) => {
+  return difference(defaultConfig, Object.keys(config));
+};

package/playerUtils/configurationUtils.ts

@@ -1,50 +1,6 @@
 import { parseJsonIfNeeded } from "../functionUtils";
 import * as R from "ramda";
 
-import { getNativeName as nativeNameUtil } from "../localizationUtils/localeLanguage";
-
-export const modifyDefaultConfigValues = (
-  configuration: ConfigurationKeys,
-  mapping: ConfigValuesMapping
-): DefaultConfiguration => {
-  return R.mapObjIndexed((value, key) => {
-    const isFieldlessKey = key === "custom_configuration_fields";
-    const keyMapping = mapping[key];
-    const fields = value?.fields || value;
-
-    if (!keyMapping) {
-      return value;
-    }
-
-    const mapper = (obj) => {
-      if (obj.fields) {
-        return R.mergeLeft({ fields: R.map(mapper)(obj.fields) })(obj);
-      }
-
-      return R.mergeLeft(keyMapping?.[obj.key])(obj);
-    };
-
-    const mappedFields = R.map(mapper)(fields);
-
-    return R.unless(() => isFieldlessKey, R.objOf("fields"))(mappedFields);
-  })(configuration);
-};
-
-export function nativeName(localeCode) {
-  try {
-    const {
-      getNativeName,
-    } = require("@applicaster/zapp-react-native-utils/localizationUtils/localeLanguage");
-
-    return getNativeName(localeCode);
-  } catch (error) {
-    // eslint-disable-next-line no-console
-    console.warn("Could not load localeLanguage utils from QB", error);
-
-    return nativeNameUtil(localeCode);
-  }
-}
-
 const setTrackType = R.curry(
   (
     type: QuickBrickPlayer.TrackType,

package/playerUtils/getPlayerActionButtons.ts

@@ -0,0 +1,17 @@
+import { map, take, trim } from "../utils";
+import { selectActionButtons } from "../conf/player/selectors";
+
+/**
+ * Returns the first two action buttons from the configuration.
+ * @param {Object} configuration - The player configuration object.
+ * @returns {Array} An array containing the first two action buttons.
+ */
+export const getPlayerActionButtons = (configuration: any) => {
+  const buttonsString = selectActionButtons(configuration);
+
+  if (!buttonsString) {
+    return [];
+  }
+
+  return take(map(buttonsString.split(","), trim), 2);
+};

package/playerUtils/index.ts

@@ -6,6 +6,8 @@ import { isTV } from "@applicaster/zapp-react-native-utils/reactUtils";
 
 import { getBoolFromConfigValue } from "../configurationUtils";
 
+export { getPlayerActionButtons } from "./getPlayerActionButtons";
+
 /**
  * Gets duration value from player manager, and from extensions
  * then checks whether the value from either is a not a valid number

package/playerUtils/useValidatePlayerConfig.tsx

@@ -1,34 +1,37 @@
 import * as React from "react";
-import * as R from "ramda";
-import generateConfiguration from "./configurationGenerator";
 import { createLogger } from "../logger";
+import { createConfig } from "../manifestUtils/createConfig";
+import { getAllFields, getConfigurationDiff } from "./_internals";
 
 export const logger = createLogger({
   category: "useValidatePlayerConfig",
   subsystem: "useValidatePlayerConfig",
 });
 
-const configuration = generateConfiguration();
+/** Default Player Configuration */
+const {
+  styles,
+  general,
+  localizations,
+  custom_configuration_fields,
+}: DefaultConfiguration = createConfig(
+  () => {
+    return {};
+  },
+  { extend: "player" }
+) as any;
+
+const QBPlayerConfigFields = getAllFields(
+  styles,
+  general,
+  localizations,
+  custom_configuration_fields
+);
 
 export const useValidatePlayerConfig = (config) => {
   React.useEffect(() => {
     try {
-      const QBPlayerConfigFields = R.compose(
-        R.map(R.prop("key")),
-        R.flatten,
-        R.map(R.compose(R.when(R.propEq("group", true), R.prop("fields")))),
-        R.concat
-      )(
-        configuration.styles.fields,
-        configuration.general.fields,
-        configuration.localizations.fields,
-        configuration.custom_configuration_fields
-      );
-
-      const diff = R.compose(
-        R.difference(QBPlayerConfigFields),
-        R.keys
-      )(config);
+      const diff = getConfigurationDiff(QBPlayerConfigFields, config);
 
       logger.log_info(
         "Missing following configuration properties. Some elements of the player may not work correctly. Check QuickBrickPlayerPlugin for the configuration reference https://github.com/applicaster/QuickBrick/tree/main/plugins/zapp-react-native-default-player/manifests",

package/reactHooks/autoscrolling/__tests__/useTrackedView.test.tsx

@@ -21,7 +21,9 @@ jest.mock(
 
 jest.useFakeTimers({ legacyFakeTimers: true });
 
-jest.mock("@applicaster/zapp-react-native-utils/reactHooks/navigation");
+jest.mock(
+  "@applicaster/zapp-react-native-utils/reactHooks/navigation/useNavigation"
+);
 
 const mockStore = configureStore();
 

package/reactHooks/feed/useBatchLoading.ts

@@ -1,8 +1,10 @@
 import { complement, compose, isNil, map, min, prop, take, uniq } from "ramda";
-import { useDispatch } from "react-redux";
 import * as React from "react";
-import { useZappPipesFeeds } from "@applicaster/zapp-react-native-redux/hooks";
-import { loadPipesData } from "@applicaster/zapp-react-native-redux/ZappPipes";
+import {
+  ZappPipes,
+  useAppDispatch,
+  useZappPipesFeed,
+} from "@applicaster/zapp-react-native-redux";
 import { isNilOrEmpty } from "../../reactUtils/helpers";
 import { ZappPipesSearchContext } from "@applicaster/zapp-react-native-ui-components/Contexts";
 import {
@@ -10,7 +12,7 @@ import {
   getSearchContext,
 } from "@applicaster/zapp-react-native-utils/reactHooks";
 import { isGallery } from "@applicaster/zapp-react-native-utils/componentsUtils";
-import { useScreenContext } from "../screen/useScreenContext";
+import { useScreenContext } from "../screen";
 
 type Options = {
   initialBatchSize?: number;
@@ -63,7 +65,7 @@ export const useBatchLoading = (
   componentsToRender: { data?: ZappDataSource; component_type: string }[],
   options: Options
 ) => {
-  const dispatch = useDispatch();
+  const dispatch = useAppDispatch();
   const { screen: screenContext, entry: entryContext } = useScreenContext();
   const [searchContext] = ZappPipesSearchContext.useZappPipesContext();
   const [hasEverBeenReady, setHasEverBeenReady] = React.useState(false);
@@ -118,7 +120,7 @@ export const useBatchLoading = (
     []
   );
 
-  const feeds = useZappPipesFeeds(feedUrls);
+  const feeds = useZappPipesFeed(feedUrls);
 
   // dispatch loadPipesData for each feed that is not loaded
   const runBatchLoading = React.useCallback(() => {
@@ -139,16 +141,16 @@ export const useBatchLoading = (
         if (mappedFeedUrl) {
           // 4. load data
           return dispatch(
-            loadPipesData(mappedFeedUrl, { riverId: options.riverId })
+            ZappPipes.loadPipesData(mappedFeedUrl, { riverId: options.riverId })
           );
         }
       }
     });
-  }, [feedUrls]);
+  }, [feedUrls, feeds]);
 
   React.useEffect(() => {
     runBatchLoading();
-  }, []);
+  }, [runBatchLoading]); // Adding runBatchLoading as a dependency to ensure that it reloads feeds when clearPipesData is called
 
   React.useEffect(() => {
     // check if all feeds are ready and set hasEverBeenReady to true