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

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",
+      },
+    ]);
+  });
+});

package/manifestUtils/mobileAction/button/index.js

@@ -0,0 +1,140 @@
+const { MOBILE_ACTION_BUTTON_FIELDS } = require("../../keys");
+
+const {
+  isKeyHasSuffix,
+  toSnakeCase,
+  generateFieldsFromDefaultsWithoutPrefixedLabel,
+  getKeyWithPrefixGenerator,
+  isKeyHasAnyOfSuffixes,
+} = require("../../_internals");
+
+const { withConditional, createConditionalField } = require("../../fieldUtils");
+
+const { fieldsGroup } = require("../../utils");
+
+/**
+ * Builds a manifest group for a single mobile action button and applies the
+ * conditional visibility rules between container, button, asset, and label fields.
+ *
+ * @param {object} options
+ * @param {string} options.label
+ * @param {string} options.description
+ * @param {object} options.defaults
+ * @param {boolean} options.isFirstButton
+ * @returns {object}
+ */
+function mobileActionButton({ label, description, defaults, isFirstButton }) {
+  const buttonKeyFromLabel = toSnakeCase(label); // "Mobile Button 1" -> "mobile_button_1"
+
+  const generatedFields = generateFieldsFromDefaultsWithoutPrefixedLabel(
+    label,
+    defaults,
+    MOBILE_ACTION_BUTTON_FIELDS
+  );
+
+  const keyPrefixGenerator = getKeyWithPrefixGenerator(buttonKeyFromLabel);
+
+  const containerKeyPrefixGenerator = getKeyWithPrefixGenerator(
+    "mobile_buttons_container"
+  );
+
+  const containerEnabledKey = containerKeyPrefixGenerator("buttons_enabled");
+
+  const independentStylesKey =
+    containerKeyPrefixGenerator("independent_styles");
+
+  const buttonEnabledKey = keyPrefixGenerator("button_enabled");
+  const displayModeKey = keyPrefixGenerator("display_mode");
+  const assetEnabledKey = keyPrefixGenerator("asset_enabled");
+  const labelEnabledKey = keyPrefixGenerator("label_enabled");
+
+  const defaultButtonConditions = [
+    createConditionalField(buttonEnabledKey, true),
+  ];
+
+  const fields = generatedFields.map((field) => {
+    const key = field.key;
+
+    // button_enabled has to be always visible when the container is enabled, as it's the main toggle for the button
+    if (isKeyHasSuffix("button_enabled", key)) {
+      return withConditional([
+        createConditionalField(containerEnabledKey, true),
+      ])(field);
+    }
+
+    // for button at index 1(isFirstButton) return `defaultButtonsConditions`,
+    // the rest buttons lookup depends on independent styles toggle
+    const stylesConditions = isFirstButton
+      ? defaultButtonConditions
+      : [
+          ...defaultButtonConditions,
+          createConditionalField(independentStylesKey, true),
+        ];
+
+    // assign_action depends only on button_enabled
+    if (isKeyHasSuffix("assign_action", key)) {
+      return withConditional(defaultButtonConditions)(field);
+    }
+
+    const conditions = [...stylesConditions];
+
+    // width depends on [display_mode: fixed]
+    if (isKeyHasSuffix("width", key)) {
+      conditions.push(createConditionalField(displayModeKey, "fixed"));
+    }
+
+    // contents_alignment depends on [display_mode: fixed or display_mode: fill]
+    if (isKeyHasSuffix("contents_alignment", key)) {
+      conditions.push(
+        createConditionalField(displayModeKey, ["fixed", "fill"])
+      );
+    }
+
+    // asset styling fields depend on [asset_enabled: true]
+    if (
+      isKeyHasAnyOfSuffixes(
+        [
+          "action_asset_flavour",
+          "asset_alignment",
+          "asset_height",
+          "asset_width",
+          "asset_margin_top",
+          "asset_margin_right",
+          "asset_margin_bottom",
+          "asset_margin_left",
+        ],
+        key
+      )
+    ) {
+      conditions.push(createConditionalField(assetEnabledKey, true));
+    }
+
+    // label styling fields depend on [label_enabled: true]
+    if (
+      isKeyHasAnyOfSuffixes(
+        [
+          "font_color",
+          "focused_font_color",
+          "ios_font_family",
+          "android_font_family",
+          "font_size",
+          "line_height",
+          "ios_letter_spacing",
+          "android_letter_spacing",
+          "text_transform",
+        ],
+        key
+      )
+    ) {
+      conditions.push(createConditionalField(labelEnabledKey, true));
+    }
+
+    return withConditional(conditions)(field);
+  });
+
+  return fieldsGroup(label, description, fields);
+}
+
+module.exports = {
+  mobileActionButton,
+};

package/manifestUtils/mobileAction/container/__tests__/mobileActionButtonsContainer.test.js

@@ -0,0 +1,102 @@
+import { mobileActionButtonsContainer } from "..";
+
+describe("mobileActionButtonsContainer", () => {
+  it("generates container fields with inferred conditionals", () => {
+    const result = mobileActionButtonsContainer({
+      label: "Mobile Buttons Container",
+      description: "container",
+      defaults: {
+        buttonsEnabled: false,
+        position: ["over_image", "text_label_1", "text_label_2"],
+        align: "left",
+        overImagePosition: "bottom_left",
+        marginTop: 0,
+        marginRight: 20,
+        marginBottom: 0,
+        marginLeft: 20,
+        stacking: "horizontal",
+        horizontalGutter: 8,
+        verticalGutter: 8,
+        independentStyles: true,
+      },
+    });
+
+    expect(result.group).toBe(true);
+    expect(result.label).toBe("Mobile Buttons Container");
+
+    const enabledField = result.fields.find(
+      (field) => field.key === "mobile_buttons_container_buttons_enabled"
+    );
+
+    expect(enabledField).toBeTruthy();
+    expect(enabledField.type).toBe("switch");
+
+    const positionField = result.fields.find(
+      (field) => field.key === "mobile_buttons_container_position"
+    );
+
+    expect(positionField.options).toEqual([
+      "over_image",
+      "text_label_1",
+      "text_label_2",
+    ]);
+
+    expect(positionField.conditional_fields).toEqual([
+      {
+        key: "styles/mobile_buttons_container_buttons_enabled",
+        condition_value: true,
+      },
+    ]);
+
+    const overImagePositionField = result.fields.find(
+      (field) => field.key === "mobile_buttons_container_over_image_position"
+    );
+
+    expect(overImagePositionField.rules).toBe("all_conditions");
+
+    expect(overImagePositionField.conditional_fields).toEqual([
+      {
+        key: "styles/mobile_buttons_container_buttons_enabled",
+        condition_value: true,
+      },
+      {
+        key: "styles/mobile_buttons_container_position",
+        condition_value: "over_image",
+      },
+    ]);
+
+    const horizontalGutterField = result.fields.find(
+      (field) => field.key === "mobile_buttons_container_horizontal_gutter"
+    );
+
+    expect(horizontalGutterField.rules).toBe("all_conditions");
+
+    expect(horizontalGutterField.conditional_fields).toEqual([
+      {
+        key: "styles/mobile_buttons_container_buttons_enabled",
+        condition_value: true,
+      },
+      {
+        key: "styles/mobile_buttons_container_stacking",
+        condition_value: "horizontal",
+      },
+    ]);
+
+    const verticalGutterField = result.fields.find(
+      (field) => field.key === "mobile_buttons_container_vertical_gutter"
+    );
+
+    expect(verticalGutterField.rules).toBe("all_conditions");
+
+    expect(verticalGutterField.conditional_fields).toEqual([
+      {
+        key: "styles/mobile_buttons_container_buttons_enabled",
+        condition_value: true,
+      },
+      {
+        key: "styles/mobile_buttons_container_stacking",
+        condition_value: "vertical",
+      },
+    ]);
+  });
+});