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

package/Components/MasterCell/DefaultComponents/mobile/MobileActionButtons/utils/index.ts

@@ -0,0 +1,238 @@
+import {
+  insertBetweenLabelContainers,
+  insertBetweenLabels,
+} from "../../../ActionButtonsCore/placement";
+import { toNumberWithDefaultZero } from "@applicaster/zapp-react-native-utils/numberUtils";
+import { Platform } from "react-native";
+
+export const insertButtonsBetweenLabels = (
+  configuration: Record<string, unknown>,
+  buttons,
+  labels = []
+) =>
+  insertBetweenLabels(
+    {
+      position: configuration?.mobile_buttons_container_position as
+        | string
+        | undefined,
+      allowOnTop: false,
+      appendWhenMissing: false,
+    },
+    buttons,
+    labels // "text_label_1", "text_label_2", "text_label_3", "text_label_4"
+  );
+
+export const insertButtonsBetweenLabelContainers = (
+  configuration: Record<string, unknown>,
+  buttons,
+  labelContainers = []
+) =>
+  insertBetweenLabelContainers(
+    {
+      position: configuration?.mobile_buttons_container_position as
+        | string
+        | undefined,
+      allowOnTop: false,
+      appendWhenMissing: true,
+    },
+    buttons,
+    labelContainers // top_label_1, top_label_2, bottom_label_1, bottom_label_2, etc.
+  );
+
+export const mobileOverImagePositionStyles = (position: string) => {
+  switch (position) {
+    case "top_left":
+      return {
+        justifyContent: "flex-start",
+        alignItems: "flex-start",
+      };
+    case "top_right":
+      return {
+        justifyContent: "flex-start",
+        alignItems: "flex-end",
+      };
+    case "bottom_left":
+      return {
+        justifyContent: "flex-end",
+        alignItems: "flex-start",
+      };
+    case "bottom_right":
+      return {
+        justifyContent: "flex-end",
+        alignItems: "flex-end",
+      };
+    case "center":
+    default:
+      return {
+        justifyContent: "center",
+        alignItems: "center",
+        top: 0,
+        left: 0,
+        right: 0,
+        bottom: 0,
+      };
+  }
+};
+
+export function getContentDirection(alignment = "left") {
+  switch (alignment) {
+    case "right":
+      return "row-reverse";
+    case "above":
+      return "column";
+    case "below":
+      return "column-reverse";
+    case "left":
+    default:
+      return "row";
+  }
+}
+
+export function getContentsAlignment(alignment = "center", direction = "left") {
+  switch (alignment) {
+    case "left":
+      return direction === "left" ? "flex-start" : "flex-end";
+    case "right":
+      return direction === "left" ? "flex-end" : "flex-start";
+    case "center":
+    default:
+      return "center";
+  }
+}
+
+export function resolveLabelText(label) {
+  if (typeof label === "string") {
+    return label;
+  }
+
+  return label?.label_1 || "";
+}
+
+export function buildLegacySelection(item, actionContext) {
+  // Some state are not array. In this case we fallback to the default value provided by the action or false
+  const defaultIsSelected = Array.isArray(actionContext?.state)
+    ? (actionContext?.state || []).includes(item)
+    : false;
+
+  return actionContext?.masterCell?.isSelected
+    ? actionContext?.masterCell?.isSelected(item)
+    : defaultIsSelected;
+}
+
+export const getMarginStyles = (value) => ({
+  marginTop: toNumberWithDefaultZero(value("margin_top")),
+  marginRight: toNumberWithDefaultZero(value("margin_right")),
+  marginBottom: toNumberWithDefaultZero(value("margin_bottom")),
+  marginLeft: toNumberWithDefaultZero(value("margin_left")),
+});
+
+export const getPaddingStyles = (value) => ({
+  paddingTop: toNumberWithDefaultZero(value("padding_top")),
+  paddingRight: toNumberWithDefaultZero(value("padding_right")),
+  paddingBottom: toNumberWithDefaultZero(value("padding_bottom")),
+  paddingLeft: toNumberWithDefaultZero(value("padding_left")),
+});
+
+export const getBorderStyles = (value) => ({
+  borderWidth: toNumberWithDefaultZero(value("border_size")),
+  borderRadius: toNumberWithDefaultZero(value("corner_radius")),
+  borderColor: value("border_color"),
+});
+
+export const getPressableStyles = (value) => ({
+  ...getMarginStyles(value),
+  ...getPaddingStyles(value),
+  ...getBorderStyles(value),
+  backgroundColor: value("background_color"),
+});
+
+export const getAssetStyles = (value) => ({
+  ...getMarginStyles((suffix) => value(`asset_${suffix}`)),
+  width: toNumberWithDefaultZero(value("asset_width")),
+  height: toNumberWithDefaultZero(value("asset_height")),
+  backgroundColor: "transparent",
+});
+
+export const getTextLabelStyles = (value) => ({
+  color: value("font_color"),
+  fontSize: toNumberWithDefaultZero(value("font_size")),
+  lineHeight: toNumberWithDefaultZero(value("line_height")),
+  ...getMarginStyles(value),
+  fontFamily:
+    Platform.OS === "ios"
+      ? value("ios_font_family")
+      : value("android_font_family"),
+  letterSpacing: toNumberWithDefaultZero(
+    Platform.OS === "ios"
+      ? value("ios_letter_spacing")
+      : value("android_letter_spacing")
+  ),
+});
+
+/** retrieves asset uri for a given flavour,
+ * if flavour is not provided, returns the default asset from `asset` or selected state asset (if available)
+ * asset can be:
+ *  provided as asset path,
+ *  provided as [default || flavour_1, alternative || flavour_2] array.
+ * mobileButtonAssets asset can be:
+ *  provided as asset path,
+ *  provided as [default || flavour_1, alternative || flavour_2] array,
+ *  provided as [[] as flavour_1, [] as flavour_2] array for multiple flavours, where each flavour can be either a path or [default, alternative] array,
+ *  provided as a React component accepting flavour as prop.
+ *
+ * isActive reflect the state of the action and can be used to render different asset for active/inactive state if asset is provided as array
+ *
+ * */
+export const selectByAssetFlavour = (
+  actionState: {
+    asset?: string | [string, string] | CellActionAssetComponent;
+    mobileButtonAssets?:
+      | [string, string]
+      | [string, string][]
+      | CellActionAssetComponent;
+  },
+  flavour?: "flavour_1" | "flavour_2",
+  isActive?: boolean
+): string | CellActionAssetComponent => {
+  if (actionState.mobileButtonAssets) {
+    if (typeof actionState.mobileButtonAssets === "function") {
+      return actionState.mobileButtonAssets;
+    }
+
+    if (flavour) {
+      if (flavour === "flavour_1") {
+        if (typeof actionState.mobileButtonAssets[0] === "string") {
+          return actionState.mobileButtonAssets[0];
+        }
+
+        if (Array.isArray(actionState.mobileButtonAssets[0])) {
+          return actionState.mobileButtonAssets[0][isActive ? 1 : 0];
+        }
+
+        return actionState.mobileButtonAssets[0];
+      } else if (flavour === "flavour_2") {
+        if (typeof actionState.mobileButtonAssets[1] === "string") {
+          return actionState.mobileButtonAssets[1];
+        }
+
+        if (Array.isArray(actionState.mobileButtonAssets[1])) {
+          return actionState.mobileButtonAssets[1][isActive ? 1 : 0];
+        }
+
+        return actionState.mobileButtonAssets[1];
+      }
+    }
+
+    return Array.isArray(actionState.mobileButtonAssets[0])
+      ? actionState.mobileButtonAssets[0][isActive ? 1 : 0]
+      : actionState.mobileButtonAssets[0];
+  } else {
+    if (typeof actionState?.asset === "function") {
+      return actionState.asset;
+    }
+
+    return typeof actionState?.asset === "string"
+      ? actionState.asset
+      : actionState.asset[isActive ? 1 : 0];
+  }
+};

package/Components/MasterCell/DefaultComponents/tv/TvActionButtons/Asset.ts

@@ -1,31 +1,17 @@
-import * as R from "ramda";
-import { toNumber } from "@applicaster/zapp-react-native-utils/numberUtils";
-
 const Image = "Image";
 
 type Props = {
-  prefix: string;
-  value: Function;
   pluginIdentifier: string;
+  style?: Record<string, unknown>;
 };
 
-export const Asset = ({ prefix, value, pluginIdentifier }: Props) => {
-  if (!value(`${prefix}_asset_enabled`)) return null;
-
+export const Asset = ({ pluginIdentifier, style }: Props) => {
   return {
     type: Image,
-    style: {
-      marginTop: value(`${prefix}_asset_margin_top`),
-      marginRight: value(`${prefix}_asset_margin_right`),
-      marginBottom: value(`${prefix}_asset_margin_bottom`),
-      marginLeft: value(`${prefix}_asset_margin_left`),
-
-      width: toNumber(value(`${prefix}_asset_width`)) || 40,
-      height: toNumber(value(`${prefix}_asset_height`)) || 40,
-    },
+    style: style,
     data: [
       {
-        func: R.identity,
+        func: "identity",
         args: [],
         propName: "entry",
       },

package/Components/MasterCell/DefaultComponents/tv/TvActionButtons/Button.ts

@@ -1,13 +1,14 @@
-import {
-  toNumberWithDefaultZero,
-  toNumberWithDefault,
-} from "@applicaster/zapp-react-native-utils/numberUtils";
-
 import { compact } from "@applicaster/zapp-react-native-utils/cellUtils";
 
 import { TextLabelsContainer } from "./TextLabelsContainer";
 import { Asset } from "./Asset";
 import { Spacer } from "./Spacer";
+import {
+  getAssetStyles,
+  getBorderStyles,
+  getDisplayModeStyles,
+  getPaddingStyles,
+} from "./utils";
 
 const compactAndSort = ({ value, prefix, asset, labels, spacer }) => {
   const assetAlignment = value(`${prefix}_asset_alignment`) || "left";
@@ -19,31 +20,6 @@ const compactAndSort = ({ value, prefix, asset, labels, spacer }) => {
   return compact([asset, labels]);
 };
 
-const displayMode = ({ value, prefix }) => {
-  const mode = value(`${prefix}_display_mode`) || "dynamic";
-
-  const width = toNumberWithDefault(
-    240,
-    value(`${prefix}_fixed_and_fixed_center_width`)
-  );
-
-  if (mode === "fixed") {
-    return {
-      width,
-    };
-  }
-
-  if (mode === "fixed_center") {
-    return {
-      width,
-      justifyContent: "center",
-    };
-  }
-
-  // dynamic mode
-  return {};
-};
-
 type Props = {
   prefix: string;
   value: Function;
@@ -63,55 +39,30 @@ export const Button = ({
 }: Props) => {
   if (!value(`${suffixId}_button_enabled`)) return null;
 
+  const getValue = (suffix: string) => value(`${prefix}_${suffix}`);
+
   return {
-    type: "FocusableView", // container
+    type: "TvActionButton",
     style: {
       flexDirection: "row",
       alignItems: "center",
       display: "flex",
-
-      paddingTop: toNumberWithDefaultZero(
-        value(`${prefix}_background_padding_top`)
-      ),
-      paddingRight: toNumberWithDefaultZero(
-        value(`${prefix}_background_padding_right`)
-      ),
-      paddingBottom: toNumberWithDefaultZero(
-        value(`${prefix}_background_padding_bottom`)
-      ),
-      paddingLeft: toNumberWithDefaultZero(
-        value(`${prefix}_background_padding_left`)
-      ),
-
-      // BORDER
-      borderRadius: toNumberWithDefaultZero(
-        value(`${prefix}_background_corner_radius`)
-      ),
-      borderWidth: value(`${prefix}_background_border_thickness`),
-      borderStyle: "solid",
-      // BORDER
-
-      ...displayMode({ value, prefix }),
+      ...getPaddingStyles((suffix) => getValue(`background_${suffix}`)),
+      ...getBorderStyles((suffix) => getValue(`background_${suffix}`)),
+      ...getDisplayModeStyles(getValue),
     },
-    data: [
-      {
-        func: (x) => x,
-        args: [],
-        propName: "item",
-      },
-    ],
     elements: compactAndSort({
       prefix,
       value,
-      asset: Asset({
-        prefix,
-        value,
-        pluginIdentifier,
-      }),
+      asset: getValue("asset_enabled")
+        ? Asset({
+            style: getAssetStyles((suffix) => getValue(`asset_${suffix}`)),
+            pluginIdentifier,
+          })
+        : null,
       labels: TextLabelsContainer({
-        prefix,
-        value,
-        platformValue,
+        value: getValue,
+        platformValue: (suffix: string) => platformValue(`${prefix}_${suffix}`),
         pluginIdentifier,
       }),
       spacer: Spacer(),
@@ -119,12 +70,12 @@ export const Button = ({
     additionalProps: {
       suffixId,
       focusedStyles: {
-        backgroundColor: value(`${prefix}_focused_background_color`),
-        borderColor: value(`${prefix}_focused_background_border_color`),
+        backgroundColor: getValue("focused_background_color"),
+        borderColor: getValue("focused_background_border_color"),
       },
       normalStyles: {
-        backgroundColor: value(`${prefix}_background_color`),
-        borderColor: value(`${prefix}_background_border_color`),
+        backgroundColor: getValue("background_color"),
+        borderColor: getValue("background_border_color"),
       },
       pluginIdentifier,
       preferredFocus,

package/Components/MasterCell/DefaultComponents/tv/TvActionButtons/TextLabelsContainer.ts

@@ -1,10 +1,10 @@
-import { TextLabel } from "./TextLabel";
 import { compact } from "@applicaster/zapp-react-native-utils/cellUtils";
+import { getTextLabelStyles } from "./utils";
 
 const View = "View";
+const Text = "Text";
 
 export const TextLabelsContainer = ({
-  prefix,
   value,
   platformValue,
   pluginIdentifier,
@@ -14,21 +14,40 @@ export const TextLabelsContainer = ({
     style: {
       flexDirection: "column",
     },
-    elements: compact([
-      TextLabel({
-        prefix: `${prefix}_label_1`,
-        value,
-        platformValue,
-        pluginIdentifier,
-        name: "label_1",
-      }),
-      TextLabel({
-        prefix: `${prefix}_label_2`,
-        value,
-        platformValue,
-        pluginIdentifier,
-        name: "label_2",
-      }),
-    ]),
+    elements: compact(
+      ["label_1", "label_2"].map((name) => {
+        const getValue = (suffix: string) => value(`${name}_${suffix}`);
+
+        const getPlatformValue = (suffix: string) =>
+          platformValue(`${name}_${suffix}`);
+
+        return getValue("toggle")
+          ? {
+              type: Text,
+              style: getTextLabelStyles(getValue, getPlatformValue),
+              data: [
+                {
+                  func: "identity",
+                  args: [],
+                  propName: "entry",
+                },
+              ],
+              additionalProps: {
+                label: { context: pluginIdentifier, name },
+                numberOfLines: getValue("number_of_lines"),
+                transformText: getValue("text_transform"),
+                focusedStyles: {
+                  backgroundColor: getValue("focused_background_color"),
+                  color: getValue("focused_font_color"),
+                },
+                normalStyles: {
+                  backgroundColor: getValue("background_color"),
+                  color: getValue("font_color"),
+                },
+              },
+            }
+          : null;
+      })
+    ),
   };
 };

package/Components/MasterCell/DefaultComponents/tv/TvActionButtons/TvActionButton.tsx

@@ -0,0 +1,27 @@
+import React from "react";
+import { ActionButtonController } from "../../ActionButtonsCore/components";
+import { FocusableView } from "../../FocusableView";
+
+type Props = Record<string, any> & {
+  children?: React.ReactNode;
+  style?: object;
+  entry?: any;
+};
+
+export function TvActionButton({
+  children,
+  pluginIdentifier,
+  style,
+  entry,
+  ...props
+}: Props) {
+  return (
+    <ActionButtonController pluginIdentifier={pluginIdentifier} entry={entry}>
+      {({ onPress }) => (
+        <FocusableView {...props} style={style} onPress={onPress}>
+          {children}
+        </FocusableView>
+      )}
+    </ActionButtonController>
+  );
+}

package/Components/MasterCell/DefaultComponents/tv/TvActionButtons/__tests__/index.test.ts

@@ -0,0 +1,89 @@
+import { TvActionButtons } from "..";
+
+describe("TvActionButtons", () => {
+  const baseConfiguration = {
+    tv_buttons_container_buttons_enabled: true,
+    tv_buttons_container_align: "middle",
+    tv_buttons_container_margin_top: 1,
+    tv_buttons_container_margin_right: 2,
+    tv_buttons_container_margin_bottom: 3,
+    tv_buttons_container_margin_left: 4,
+    tv_buttons_container_horizontal_gutter: 10,
+    tv_buttons_container_independent_styles: false,
+    tv_buttons_button_1_button_enabled: true,
+    tv_buttons_button_1_assign_action: "action_1",
+    tv_buttons_button_1_background_padding_top: 11,
+    tv_buttons_button_1_background_padding_right: 12,
+    tv_buttons_button_1_background_padding_bottom: 13,
+    tv_buttons_button_1_background_padding_left: 14,
+    tv_buttons_button_3_button_enabled: true,
+    tv_buttons_button_3_assign_action: "action_3",
+    tv_buttons_button_3_background_padding_top: 31,
+    tv_buttons_button_3_background_padding_right: 32,
+    tv_buttons_button_3_background_padding_bottom: 33,
+    tv_buttons_button_3_background_padding_left: 34,
+  };
+
+  const platformValue = jest.fn();
+
+  it("renders sparse enabled slots with slot-based action lookup and ids", () => {
+    const value = (key) => baseConfiguration[key];
+
+    const result = TvActionButtons({
+      value,
+      platformValue,
+      configuration: baseConfiguration,
+      state: "focused",
+      skipButtons: false,
+    });
+
+    expect(result.type).toBe("ButtonContainerView");
+    expect(result.style.justifyContent).toBe("center");
+    expect(result.additionalProps.buttonsCount).toBe(2);
+    expect(result.elements).toHaveLength(2);
+    expect(result.elements[0].type).toBe("DataProvider");
+
+    expect(result.elements[0].data).toEqual([
+      {
+        func: "identity",
+        args: [],
+        propName: "entry",
+      },
+    ]);
+
+    const firstButton = result.elements[0].elements[0];
+    const secondButton = result.elements[1].elements[0];
+
+    expect(firstButton.additionalProps.pluginIdentifier).toBe("action_1");
+
+    expect(firstButton.additionalProps.suffixId).toBe("tv_buttons_button_1");
+
+    expect(firstButton.additionalProps.preferredFocus).toBe(true);
+
+    expect(secondButton.additionalProps.pluginIdentifier).toBe("action_3");
+
+    expect(secondButton.additionalProps.suffixId).toBe("tv_buttons_button_3");
+
+    expect(secondButton.additionalProps.preferredFocus).toBe(false);
+  });
+
+  it("keeps shared button styles from slot 1 while preserving slot 3 identity", () => {
+    const value = (key) => baseConfiguration[key];
+
+    const result = TvActionButtons({
+      value,
+      platformValue,
+      configuration: baseConfiguration,
+      state: "focused",
+      skipButtons: false,
+    });
+
+    const secondButton = result.elements[1].elements[0];
+
+    expect(secondButton.style.paddingTop).toBe(11);
+
+    expect(secondButton.additionalProps.pluginIdentifier).toBe("action_3");
+
+    expect(secondButton.additionalProps.suffixId).toBe("tv_buttons_button_3");
+  });
+});