@applicaster/zapp-react-native-utils 15.0.0-rc.99 → 16.0.0-rc.1

package/manifestUtils/_internals/index.js

@@ -174,6 +174,36 @@ function generateFieldsFromDefaultsWithoutPrefixedLabel(
   )(fields);
 }
 
+/**
+ * Checks whether a generated manifest field key ends with the given suffix.
+ *
+ * @param {string} suffix
+ * @param {string} key
+ * @returns {boolean}
+ */
+const isKeyHasSuffix = (suffix, key) => key.endsWith(`_${suffix}`);
+
+/**
+ * Checks whether a generated manifest field key ends with any supported suffix.
+ *
+ * @param {string[]} suffixes
+ * @param {string} key
+ * @returns {boolean}
+ */
+const isKeyHasAnyOfSuffixes = (suffixes, key) =>
+  suffixes.some((suffix) => key.endsWith(`_${suffix}`));
+
+/**
+ * Creates a helper that prefixes a manifest field suffix with a shared key stem.
+ *
+ * @param {string} prefix
+ * @returns {(suffix: string) => string}
+ */
+function getKeyWithPrefixGenerator(prefix) {
+  // expect prefix as lower snake case, e.g. "mobile_buttons_container"
+  return (suffix) => `${prefix}_${suffix}`;
+}
+
 module.exports = {
   toSnakeCase,
   toCamelCase,
@@ -185,4 +215,7 @@ module.exports = {
   getDefaultConfiguration,
   compact,
   replaceUnderscoreToSpace,
+  isKeyHasSuffix,
+  isKeyHasAnyOfSuffixes,
+  getKeyWithPrefixGenerator,
 };

package/manifestUtils/defaultManifestConfigurations/player.js

@@ -123,6 +123,12 @@ function getPlayerConfiguration({ platform, version }) {
         key: "skip_button_localization_text_skip_intro",
         initial_value: "Skip Intro",
       },
+      {
+        type: "text_input",
+        label: "Stream error message",
+        key: "stream_error_message",
+        initial_value: "Cannot play stream",
+      },
       {
         type: "text_input",
         label: "Locked message",
@@ -707,22 +713,6 @@ function getPlayerConfiguration({ platform, version }) {
   }
 
   if (isMobile(platform)) {
-    localizations.fields.push(
-      {
-        type: "text_input",
-        label: "Restrict playback on mobile networks alert title",
-        key: "mobile_connection_restricted_alert_title",
-        initial_value: "Restricted Connection Type",
-      },
-      {
-        type: "text_input",
-        label: "Restrict playback on mobile networks alert message",
-        key: "mobile_connection_restricted_alert_message",
-        initial_value:
-          "This content can only be viewed over a Wi-Fi or LAN network.",
-      }
-    );
-
     general.fields.push(
       {
         section: "Default Timestamp Type",

package/manifestUtils/fieldUtils/__tests__/fieldUtils.test.js

@@ -0,0 +1,49 @@
+const {
+  withConditional,
+  getConditionalKey,
+  createConditionalField,
+} = require("..");
+
+describe("manifestUtils/fieldUtils", () => {
+  it("appends conditions and adds all_conditions when there is more than one condition", () => {
+    const config = {
+      key: "mobile_button_1_width",
+      conditional_fields: [
+        { key: "styles/mobile_button_1_button_enabled", condition_value: true },
+      ],
+    };
+
+    const result = withConditional([
+      { key: "styles/mobile_button_1_display_mode", condition_value: "fixed" },
+    ])(config);
+
+    expect(result.conditional_fields).toEqual([
+      { key: "styles/mobile_button_1_button_enabled", condition_value: true },
+      { key: "styles/mobile_button_1_display_mode", condition_value: "fixed" },
+    ]);
+
+    expect(result.rules).toBe("all_conditions");
+  });
+
+  it("creates category-prefixed conditional key", () => {
+    expect(
+      getConditionalKey("mobile_buttons_container_position", "styles")
+    ).toBe("styles/mobile_buttons_container_position");
+  });
+
+  it("creates conditional fields with default category and with raw key", () => {
+    expect(
+      createConditionalField("mobile_button_1_asset_enabled", true)
+    ).toEqual({
+      key: "styles/mobile_button_1_asset_enabled",
+      condition_value: true,
+    });
+
+    expect(
+      createConditionalField("mobile_button_1_asset_enabled", true, null)
+    ).toEqual({
+      key: "mobile_button_1_asset_enabled",
+      condition_value: true,
+    });
+  });
+});

package/manifestUtils/fieldUtils/index.js

@@ -0,0 +1,54 @@
+/**
+ * Appends new conditional_fields from conditions array
+ * to config.conditional_fields
+ * if there are more than 1 condition, sets rules to "all_conditions"
+ *
+ * @param {Array<{key: string, condition_value: unknown}>} conditions
+ * @returns {(config: object) => object}
+ */
+const withConditional = (conditions) => (config) => {
+  const conditional_fields = [
+    ...(config.conditional_fields || []),
+    ...conditions,
+  ];
+
+  const next = { ...config, conditional_fields };
+
+  if (conditional_fields.length > 1) {
+    return { ...next, rules: "all_conditions" };
+  }
+
+  return next;
+};
+
+/**
+ * Builds key for conditional fields prepending category, e.g. "styles/mobile_buttons_container_position"
+ *
+ * @param {string} key
+ * @param {string} category
+ * @returns {string}
+ */
+function getConditionalKey(key, category) {
+  return `${category}/${key}`;
+}
+
+/**
+ * Returns a conditional field object for manifest visibility rules.
+ *
+ * @param {string} key
+ * @param {unknown} condition_value
+ * @param {string|null} [category="styles"] Pass `null` to use the key as-is.
+ * @returns {{key: string, condition_value: unknown}}
+ */
+function createConditionalField(key, condition_value, category = "styles") {
+  return {
+    key: category ? getConditionalKey(key, category) : key,
+    condition_value,
+  };
+}
+
+module.exports = {
+  withConditional,
+  getConditionalKey,
+  createConditionalField,
+};

package/manifestUtils/index.js

@@ -8,6 +8,7 @@ const {
 
 const { tvActionButtonsContainer } = require("./tvAction/container");
 const { tvActionButton } = require("./tvAction/button");
+const { buildMobileActionButtonGroups } = require("./mobileAction/groups");
 const { compact } = require("./_internals");
 
 const { spacingKey, absolutePositionElement } = require("./containers");
@@ -43,6 +44,7 @@ module.exports = {
   tvMenuLabel,
   tvActionButtonsContainer,
   tvActionButton,
+  buildMobileActionButtonGroups,
   mobileCellLabel,
   tvCellLabel,
   tvBadges,

package/manifestUtils/keys.js

@@ -406,6 +406,232 @@ const TV_ACTION_BUTTON_FIELDS = [
   },
 ];
 
+const mobileActionButtonContainerFields = (positionOptions) => [
+  {
+    type: ZAPPIFEST_FIELDS.switch,
+    suffix: "buttons enabled",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.select,
+    suffix: "position",
+    options: positionOptions,
+  },
+  {
+    type: ZAPPIFEST_FIELDS.select,
+    suffix: "align",
+    options: ["left", "center", "right"],
+  },
+  {
+    type: ZAPPIFEST_FIELDS.select,
+    suffix: "over image position",
+    options: ["center", "top_left", "top_right", "bottom_left", "bottom_right"],
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "margin top",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "margin right",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "margin bottom",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "margin left",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.select,
+    suffix: "stacking",
+    options: ["horizontal", "vertical"],
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "horizontal gutter",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "vertical gutter",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.switch,
+    suffix: "independent styles",
+  },
+];
+
+const MOBILE_ACTION_BUTTON_FIELDS = [
+  {
+    type: ZAPPIFEST_FIELDS.switch,
+    suffix: "button enabled",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.select,
+    suffix: "assign action",
+    options: [
+      { text: "primary navigation", value: "navigation_action" },
+      { text: "secondary navigation", value: "secondary_navigation" },
+      { text: "favorite", value: "local_storage_favourites_action" },
+      { text: "more", value: "open-modal-bottom-sheet-cell-action" },
+      { text: "add to calendar", value: "add_to_calendar_action" },
+      { text: "share", value: "native_share_action" },
+      { text: "downloads", value: "offline-content-button" },
+      { text: "trailer", value: "trailer_action" },
+      { text: "mute/unmute", value: "mute_unmute" },
+    ],
+  },
+  {
+    type: ZAPPIFEST_FIELDS.select,
+    suffix: "display mode",
+    options: ["dynamic", "fixed", "fill"],
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "width",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.select,
+    suffix: "contents alignment",
+    options: ["left", "center", "right"],
+  },
+  {
+    type: ZAPPIFEST_FIELDS.color_picker,
+    suffix: "background color",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.color_picker,
+    suffix: "focused background color",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.color_picker,
+    suffix: "border color",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.color_picker,
+    suffix: "focused border color",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "border size",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "corner radius",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "padding top",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "padding right",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "padding bottom",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "padding left",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.switch,
+    suffix: "asset enabled",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.select,
+    suffix: "action asset flavour",
+    options: ["flavour_1", "flavour_2"],
+  },
+  {
+    type: ZAPPIFEST_FIELDS.select,
+    suffix: "asset alignment",
+    options: ["left", "right", "above", "below"],
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "asset height",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "asset width",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "asset margin top",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "asset margin right",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "asset margin bottom",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "asset margin left",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.switch,
+    suffix: "label enabled",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.color_picker,
+    suffix: "font color",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.color_picker,
+    suffix: "focused font color",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.font_selector.ios,
+    suffix: "iOS font family",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.font_selector.android,
+    suffix: "android font family",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "font size",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "line height",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "iOS letter spacing",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "android letter spacing",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.select,
+    suffix: "text transform",
+    options: ["default", "lowercase", "uppercase", "capitalize"],
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "margin top",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "margin right",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "margin bottom",
+  },
+  {
+    type: ZAPPIFEST_FIELDS.number_input,
+    suffix: "margin left",
+  },
+];
+
 const TV_MENU_LABEL_FIELDS = [
   {
     type: ZAPPIFEST_FIELDS.switch,
@@ -2134,6 +2360,8 @@ module.exports = {
   TV_COLOR_STATES,
   TV_ACTION_BUTTON_FIELDS,
   tvActionButtonContainerFields,
+  MOBILE_ACTION_BUTTON_FIELDS,
+  mobileActionButtonContainerFields,
   MOBILE_CELL_LABEL_FIELDS,
   TV_CELL_LABEL_FIELDS,
   TV_CELL_BADGE_FIELDS,

package/manifestUtils/mobileAction/button/__tests__/mobileActionButton.test.js

@@ -0,0 +1,168 @@
+import { mobileActionButton } from "..";
+
+describe("mobileActionButton", () => {
+  const defaults = {
+    buttonEnabled: true,
+    assignAction: "navigation_action",
+    displayMode: "dynamic",
+    width: 140,
+    contentsAlignment: "center",
+    backgroundColor: "rgba(1,1,1,1)",
+    focusedBackgroundColor: "rgba(2,2,2,1)",
+    borderColor: "rgba(0,0,0,0)",
+    focusedBorderColor: "rgba(0,0,0,0)",
+    borderSize: 0,
+    cornerRadius: 8,
+    paddingTop: 14,
+    paddingRight: 24,
+    paddingBottom: 14,
+    paddingLeft: 16,
+    assetEnabled: true,
+    actionAssetFlavour: "flavour_1",
+    assetAlignment: "left",
+    assetHeight: 24,
+    assetWidth: 24,
+    assetMarginTop: 0,
+    assetMarginRight: 6,
+    assetMarginBottom: 0,
+    assetMarginLeft: 0,
+    labelEnabled: true,
+    fontColor: "rgba(239,239,239,1)",
+    focusedFontColor: "rgba(239,239,239,1)",
+    iosFontFamily: "Ubuntu-Bold",
+    androidFontFamily: "Ubuntu-Bold",
+    fontSize: 15,
+    lineHeight: 24,
+    iosLetterSpacing: -0.2,
+    androidLetterSpacing: -0.2,
+    textTransform: "default",
+    marginTop: 0,
+    marginRight: 0,
+    marginBottom: 0,
+    marginLeft: 0,
+  };
+
+  it("generates button fields with inferred conditional rules", () => {
+    const result = mobileActionButton({
+      label: "Mobile Button 2",
+      description: "button 2",
+      defaults,
+      isFirstButton: false,
+    });
+
+    expect(result.group).toBe(true);
+
+    const enabledField = result.fields.find(
+      (field) => field.key === "mobile_button_2_button_enabled"
+    );
+
+    expect(enabledField).toBeTruthy();
+
+    expect(enabledField.conditional_fields).toEqual([
+      {
+        key: "styles/mobile_buttons_container_buttons_enabled",
+        condition_value: true,
+      },
+    ]);
+
+    const assignActionField = result.fields.find(
+      (field) => field.key === "mobile_button_2_assign_action"
+    );
+
+    expect(assignActionField).toBeTruthy();
+
+    expect(assignActionField.conditional_fields).toEqual([
+      {
+        key: "styles/mobile_button_2_button_enabled",
+        condition_value: true,
+      },
+    ]);
+
+    const widthField = result.fields.find(
+      (field) => field.key === "mobile_button_2_width"
+    );
+
+    expect(widthField.rules).toBe("all_conditions");
+
+    expect(widthField.conditional_fields).toEqual([
+      {
+        key: "styles/mobile_button_2_button_enabled",
+        condition_value: true,
+      },
+      {
+        key: "styles/mobile_buttons_container_independent_styles",
+        condition_value: true,
+      },
+      {
+        key: "styles/mobile_button_2_display_mode",
+        condition_value: "fixed",
+      },
+    ]);
+
+    const actionAssetFlavourField = result.fields.find(
+      (field) => field.key === "mobile_button_2_action_asset_flavour"
+    );
+
+    expect(actionAssetFlavourField.rules).toBe("all_conditions");
+
+    expect(actionAssetFlavourField.conditional_fields).toEqual([
+      {
+        key: "styles/mobile_button_2_button_enabled",
+        condition_value: true,
+      },
+      {
+        key: "styles/mobile_buttons_container_independent_styles",
+        condition_value: true,
+      },
+      {
+        key: "styles/mobile_button_2_asset_enabled",
+        condition_value: true,
+      },
+    ]);
+
+    const contentsAlignmentField = result.fields.find(
+      (field) => field.key === "mobile_button_2_contents_alignment"
+    );
+
+    expect(contentsAlignmentField.rules).toBe("all_conditions");
+
+    expect(contentsAlignmentField.conditional_fields).toEqual([
+      {
+        key: "styles/mobile_button_2_button_enabled",
+        condition_value: true,
+      },
+      {
+        key: "styles/mobile_buttons_container_independent_styles",
+        condition_value: true,
+      },
+      {
+        key: "styles/mobile_button_2_display_mode",
+        condition_value: ["fixed", "fill"],
+      },
+    ]);
+  });
+
+  it("keeps first-button fields independent-style agnostic", () => {
+    const result = mobileActionButton({
+      label: "Mobile Button 1",
+      description: "button 1",
+      defaults,
+      isFirstButton: true,
+    });
+
+    const widthField = result.fields.find(
+      (field) => field.key === "mobile_button_1_width"
+    );
+
+    expect(widthField.conditional_fields).toEqual([
+      {
+        key: "styles/mobile_button_1_button_enabled",
+        condition_value: true,
+      },
+      {
+        key: "styles/mobile_button_1_display_mode",
+        condition_value: "fixed",
+      },
+    ]);
+  });
+});