@applicaster/zapp-react-native-utils 15.0.0-rc.14 → 15.0.0-rc.140

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

package/manifestUtils/mobileAction/container/index.js

@@ -0,0 +1,73 @@
+const { mobileActionButtonContainerFields } = require("../../keys");
+
+const {
+  isKeyHasSuffix,
+  toSnakeCase,
+  generateFieldsFromDefaultsWithoutPrefixedLabel,
+  getKeyWithPrefixGenerator,
+} = require("../../_internals");
+
+const { withConditional, createConditionalField } = require("../../fieldUtils");
+
+const { fieldsGroup } = require("../../utils");
+
+/**
+ * Builds the manifest group for the mobile action buttons container and wires
+ * child field visibility to the container-level toggles and layout selections.
+ *
+ * @param {object} options
+ * @param {string} options.label
+ * @param {string} options.description
+ * @param {object} options.defaults
+ * @returns {object}
+ */
+function mobileActionButtonsContainer({ label, description, defaults }) {
+  const containerKeyFromLabel = toSnakeCase(label); // "Mobile Buttons Container" -> "mobile_buttons_container"
+
+  const generatedFields = generateFieldsFromDefaultsWithoutPrefixedLabel(
+    label,
+    defaults,
+    mobileActionButtonContainerFields(defaults.position)
+  );
+
+  const keyPrefixGenerator = getKeyWithPrefixGenerator(containerKeyFromLabel);
+
+  const enabledKey = keyPrefixGenerator("buttons_enabled");
+  const positionKey = keyPrefixGenerator("position");
+  const stackingKey = keyPrefixGenerator("stacking");
+
+  const defaultConditions = [createConditionalField(enabledKey, true)];
+
+  const fields = generatedFields.map((field) => {
+    const key = field.key;
+
+    if (isKeyHasSuffix("buttons_enabled", key)) {
+      return field;
+    }
+
+    const conditions = [...defaultConditions];
+
+    // over_image_position depends on [positionKey: over_image]
+    if (isKeyHasSuffix("over_image_position", key)) {
+      conditions.push(createConditionalField(positionKey, "over_image"));
+    }
+
+    // horizontal_gutter depends on [stackingKey: horizontal]
+    if (isKeyHasSuffix("horizontal_gutter", key)) {
+      conditions.push(createConditionalField(stackingKey, "horizontal"));
+    }
+
+    // vertical_gutter depends on [stackingKey: vertical]
+    if (isKeyHasSuffix("vertical_gutter", key)) {
+      conditions.push(createConditionalField(stackingKey, "vertical"));
+    }
+
+    return withConditional(conditions)(field);
+  });
+
+  return fieldsGroup(label, description, fields);
+}
+
+module.exports = {
+  mobileActionButtonsContainer,
+};

package/manifestUtils/mobileAction/groups/__tests__/buildMobileActionButtonGroups.test.js

@@ -0,0 +1,127 @@
+import { buildMobileActionButtonGroups } from "..";
+
+describe("buildMobileActionButtonGroups", () => {
+  it("builds the container and three button groups with shared defaults", () => {
+    const groups = buildMobileActionButtonGroups({
+      containerDefaults: {
+        position: ["over_image", "text_label_1", "text_label_2"],
+      },
+    });
+
+    expect(groups).toHaveLength(4);
+
+    expect(groups.map((group) => group.label)).toEqual([
+      "Mobile Buttons Container",
+      "Mobile Button 1",
+      "Mobile Button 2",
+      "Mobile Button 3",
+    ]);
+
+    const containerFields = groups[0].fields;
+
+    const positionField = containerFields.find(
+      (field) => field.key === "mobile_buttons_container_position"
+    );
+
+    const buttonsEnabledField = containerFields.find(
+      (field) => field.key === "mobile_buttons_container_buttons_enabled"
+    );
+
+    expect(positionField.options).toEqual([
+      "over_image",
+      "text_label_1",
+      "text_label_2",
+    ]);
+
+    expect(buttonsEnabledField.initial_value).toBe(false);
+
+    const button1Fields = groups[1].fields;
+
+    const button1EnabledField = button1Fields.find(
+      (field) => field.key === "mobile_button_1_button_enabled"
+    );
+
+    const button1AssignActionField = button1Fields.find(
+      (field) => field.key === "mobile_button_1_assign_action"
+    );
+
+    const button1BackgroundColorField = button1Fields.find(
+      (field) => field.key === "mobile_button_1_background_color"
+    );
+
+    expect(button1EnabledField.initial_value).toBe(true);
+    expect(button1AssignActionField.initial_value).toBe("navigation_action");
+
+    expect(button1BackgroundColorField.initial_value).toBe(
+      "rgba(254, 20, 72, 1)"
+    );
+
+    const button2Fields = groups[2].fields;
+
+    const button2EnabledField = button2Fields.find(
+      (field) => field.key === "mobile_button_2_button_enabled"
+    );
+
+    const button2AssignActionField = button2Fields.find(
+      (field) => field.key === "mobile_button_2_assign_action"
+    );
+
+    expect(button2EnabledField.initial_value).toBe(false);
+    expect(button2AssignActionField.initial_value).toBe("secondary_navigation");
+
+    const button3Fields = groups[3].fields;
+
+    const button3EnabledField = button3Fields.find(
+      (field) => field.key === "mobile_button_3_button_enabled"
+    );
+
+    const button3AssignActionField = button3Fields.find(
+      (field) => field.key === "mobile_button_3_assign_action"
+    );
+
+    expect(button3EnabledField.initial_value).toBe(false);
+
+    expect(button3AssignActionField.initial_value).toBe(
+      "local_storage_favourites_action"
+    );
+  });
+
+  it("merges container, shared button, and per-button overrides", () => {
+    const groups = buildMobileActionButtonGroups({
+      containerDefaults: {
+        align: "center",
+        position: ["over_image"],
+      },
+      sharedButtonDefaults: {
+        assetAlignment: "right",
+      },
+      buttonOverrides: {
+        2: {
+          buttonEnabled: true,
+          assignAction: "downloads",
+        },
+      },
+    });
+
+    const alignField = groups[0].fields.find(
+      (field) => field.key === "mobile_buttons_container_align"
+    );
+
+    const button1AssetAlignmentField = groups[1].fields.find(
+      (field) => field.key === "mobile_button_1_asset_alignment"
+    );
+
+    const button2EnabledField = groups[2].fields.find(
+      (field) => field.key === "mobile_button_2_button_enabled"
+    );
+
+    const button2AssignActionField = groups[2].fields.find(
+      (field) => field.key === "mobile_button_2_assign_action"
+    );
+
+    expect(alignField.initial_value).toBe("center");
+    expect(button1AssetAlignmentField.initial_value).toBe("right");
+    expect(button2EnabledField.initial_value).toBe(true);
+    expect(button2AssignActionField.initial_value).toBe("downloads");
+  });
+});

package/manifestUtils/mobileAction/groups/defaults.js

@@ -0,0 +1,76 @@
+const DEFAULT_MOBILE_ACTION_BUTTONS_CONTAINER_DEFAULTS = {
+  buttonsEnabled: false,
+
+  align: "left",
+  overImagePosition: "bottom_left",
+  marginTop: 0,
+  marginRight: 20,
+  marginBottom: 0,
+  marginLeft: 20,
+  stacking: "horizontal",
+  horizontalGutter: 8,
+  verticalGutter: 8,
+  independentStyles: true,
+};
+
+const DEFAULT_MOBILE_ACTION_BUTTON_SHARED_DEFAULTS = {
+  displayMode: "dynamic",
+  width: 140,
+  contentsAlignment: "center",
+  backgroundColor: "rgba(62, 62, 62, 1)",
+  focusedBackgroundColor: "rgba(46, 46, 46, 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,
+};
+
+const DEFAULT_MOBILE_ACTION_BUTTON_PRESETS = {
+  1: {
+    buttonEnabled: true,
+    assignAction: "navigation_action",
+    backgroundColor: "rgba(254, 20, 72, 1)",
+    focusedBackgroundColor: "rgba(213, 8, 54, 1)",
+  },
+  2: {
+    buttonEnabled: false,
+    assignAction: "secondary_navigation",
+  },
+  3: {
+    buttonEnabled: false,
+    assignAction: "local_storage_favourites_action",
+  },
+};
+
+module.exports = {
+  DEFAULT_MOBILE_ACTION_BUTTONS_CONTAINER_DEFAULTS,
+  DEFAULT_MOBILE_ACTION_BUTTON_SHARED_DEFAULTS,
+  DEFAULT_MOBILE_ACTION_BUTTON_PRESETS,
+};