@capillarytech/creatives-library 8.0.125 → 8.0.127-alpha.0

package/utils/createPayload.js

@@ -0,0 +1,272 @@
+// Utility to create the Mobile Push payload for rich media, with validation
+import { DEEP_LINK } from "../v2Components/CapInAppCTA/constants";
+import { EXTERNAL_URL } from "../v2Components/CapMpushCTA/constants";
+import {
+  IMAGE, VIDEO, GIF, CAROUSEL, TEXT, BIG_TEXT, BIG_PICTURE, MOBILE_PUSH_CHANNEL,
+  EXTERNAL_LINK,
+  ANDROID,
+  IOS,
+  MANUAL_CAROUSEL,
+  AUTO_CAROUSEL,
+  FILMSTRIP_CAROUSEL,
+} from "../v2Containers/MobilePushNew/constants";
+import { NONE } from "../v2Containers/Whatsapp/constants";
+/**
+ * Constructs the payload for Mobile Push, supporting both legacy and rich media as per backend contract.
+ * - Trims and validates templateName
+ * - Handles legacy and rich media (VIDEO, GIF, CAROUSEL, etc.)
+ * - Builds androidContent and iosContent with correct structure
+ * @param {Object} params - All required params
+ * @param {string} params.templateName
+ * @param {Object} params.androidContent
+ * @param {Object} params.iosContent
+ * @param {Object} params.accountData
+ * @param {Object} [params.options] - Optional extra options (ouId, actionId, etc.)
+ * @returns {Object} - Payload ready for backend
+ */
+function createPayload({
+  templateName, androidContent, iosContent, imageSrc = {}, mpushVideoSrcAndPreview = {}, accountData, options = {}, sameContent = false,
+} = {}) {
+  // Platform support checks must be at the top
+  const isAndroidSupported = accountData?.configs?.android === '1';
+  const isIosSupported = accountData?.configs?.ios === '1';
+  // Validate and trim template name
+  const trimmedTemplateName = (templateName || "").trim();
+  if (!trimmedTemplateName) {
+    throw new Error("Template name is empty or contains only white spaces");
+  }
+
+  // Validate androidContent and iosContent
+  if (androidContent && (!androidContent?.title || !androidContent?.message)) {
+    throw new Error("Android content must have title and message");
+  }
+
+  if (iosContent && (!iosContent?.title || !iosContent?.message)) {
+    throw new Error("iOS content must have title and message");
+  }
+
+  // Validate accountData
+  if (!accountData) {
+    throw new Error("Account data is required. Please select a MobilePush account.");
+  }
+
+  const accountId = accountData?.accountId || accountData?.id;
+  const licenseCode = accountData?.licenseCode || accountData?.sourceAccountIdentifier;
+  const sourceType = accountData?.sourceType || accountData?.sourceTypeName;
+
+  // Ensure imageSrc has the required properties
+  const safeImageSrc = {
+    androidImageSrc: imageSrc?.androidImageSrc || "",
+    iosImageSrc: imageSrc?.iosImageSrc || "",
+  };
+
+  // Helper to build expandableDetails for legacy and rich media
+  function buildExpandableDetails(content, contentImageSrc, platform = ANDROID) {
+    const style = content?.expandableDetails?.style || content?.mediaType || BIG_TEXT;
+    const expandableDetails = { style };
+
+    if (style === IMAGE || style === BIG_PICTURE) {
+      expandableDetails.style = BIG_PICTURE;
+      expandableDetails.message = content?.message;
+      expandableDetails.image = contentImageSrc || "";
+    } else if (style === VIDEO) {
+      expandableDetails.message = content?.message;
+      // Always build media array for VIDEO
+      let url = '';
+      let text = '';
+      let videoPreviewUrl = '';
+      if (mpushVideoSrcAndPreview?.mpushVideoSrc) {
+        url = mpushVideoSrcAndPreview?.mpushVideoSrc;
+        videoPreviewUrl = mpushVideoSrcAndPreview?.mpushVideoPreviewImg || '';
+      } else if (content?.mediaList && content?.mediaList[0]) {
+        const { url: mediaUrl = '', text: mediaText = '' } = content?.mediaList[0];
+        url = mediaUrl;
+        text = mediaText;
+      }
+      expandableDetails.media = [
+        {
+          url,
+          text,
+          type: VIDEO,
+          videoPreviewUrl,
+        },
+      ];
+    } else if (style === GIF) {
+      expandableDetails.message = content?.message;
+      // Handle GIF: preserve original type from mediaList if available, otherwise convert to VIDEO
+      let url = '';
+      let text = '';
+      let mediaType = VIDEO; // Default to VIDEO for backend compatibility
+
+      if (content?.mediaList && content?.mediaList[0]) {
+        // If mediaList exists, use it and preserve the original type
+        const { url: mediaUrl = '', text: mediaText = '', type: originalType = VIDEO } = content?.mediaList[0];
+        url = mediaUrl;
+        text = mediaText;
+        mediaType = originalType; // Preserve original type from mediaList
+      } else if (mpushVideoSrcAndPreview?.mpushVideoSrc) {
+        // If no mediaList but mpushVideoSrc exists, convert to VIDEO
+        url = mpushVideoSrcAndPreview?.mpushVideoSrc;
+        mediaType = VIDEO;
+      }
+
+      expandableDetails.media = [
+        {
+          url,
+          text,
+          type: mediaType,
+        },
+      ];
+    } else if (style === BIG_TEXT || style === TEXT || style === NONE) {
+      expandableDetails.style = BIG_TEXT;
+      expandableDetails.message = content?.message;
+    } else if ((style === CAROUSEL || style === MANUAL_CAROUSEL || style === AUTO_CAROUSEL || style === FILMSTRIP_CAROUSEL)) {
+      // Handle carousel data
+      expandableDetails.style = 'MANUAL_CAROUSEL';
+      expandableDetails.message = content?.message;
+
+      // Add carousel data if it exists
+      if (content?.carouselData && Array.isArray(content?.carouselData) && content?.carouselData.length > 0) {
+        expandableDetails.carouselData = content?.carouselData.map((card) => ({
+          mediaType: card.mediaType || 'image',
+          imageUrl: card.imageUrl || '',
+          videoSrc: card.videoSrc || '',
+          buttons: card.buttons || [],
+        }));
+      }
+
+      // Handle mediaList for carousel (used in tests and some scenarios)
+      if (content?.mediaList && Array.isArray(content?.mediaList) && content?.mediaList.length > 0) {
+        expandableDetails.media = content?.mediaList.map((m) => ({
+          url: m.url,
+          text: m.text || "",
+          type: m.type,
+        }));
+      }
+    } else if ([GIF].includes(style) && content?.mediaList) {
+      expandableDetails.media = (content?.mediaList || []).map((m) => ({
+        url: m.url,
+        text: m.text || "",
+        type: m.type,
+      }));
+    }
+
+    // iOS always needs ctas array
+    if (platform === IOS) {
+      expandableDetails.ctas = content?.expandableDetails?.ctas || [];
+    }
+
+    // Add any additional expandableDetails fields
+    if (content?.expandableDetails) {
+      Object.entries(content?.expandableDetails).forEach(([k, v]) => {
+        if (!(k in expandableDetails)) expandableDetails[k] = v;
+      });
+    }
+    return expandableDetails;
+  }
+
+  // Helper to build custom fields array (legacy)
+  function buildCustomFields(content) {
+    // If content.custom is already an array, return as is
+    if (Array.isArray(content?.custom)) return content?.custom;
+    // If it's an object, map to array
+    if (content?.custom && typeof content?.custom === 'object') {
+      return Object.entries(content?.custom).map(([key, value]) => ({ key, value }));
+    }
+    return [];
+  }
+
+  // Compose androidContent for legacy payload
+  let androidLegacy;
+  if (isAndroidSupported && isValidContent(androidContent)) {
+    androidLegacy = {
+      luid: "{{luid}}",
+      cuid: "{{cuid}}",
+      communicationId: "{{communicationId}}",
+      title: androidContent.title,
+      message: androidContent.message,
+      expandableDetails: buildExpandableDetails(androidContent, safeImageSrc.androidImageSrc),
+      custom: buildCustomFields(androidContent),
+      type: androidContent.mediaType,
+      deviceType: 'ANDROID',
+    };
+    if (androidContent?.actionOnClick && (androidContent?.deepLinkValue || androidContent?.externalLinkValue)) {
+      const actionLink = androidContent?.linkType === EXTERNAL_LINK ? androidContent?.externalLinkValue : androidContent?.deepLinkValue;
+      androidLegacy.cta = {
+        type: androidContent.linkType === EXTERNAL_LINK ? EXTERNAL_URL : DEEP_LINK,
+        actionLink,
+      };
+    }
+  }
+
+  // Compose iosContent for legacy payload
+  let iosLegacy;
+  if (isIosSupported && isValidContent(iosContent)) {
+    iosLegacy = {
+      luid: "{{luid}}",
+      cuid: "{{cuid}}",
+      communicationId: "{{communicationId}}",
+      title: iosContent.title,
+      message: iosContent.message,
+      expandableDetails: buildExpandableDetails(iosContent, safeImageSrc.iosImageSrc, 'IOS'),
+      custom: buildCustomFields(iosContent),
+      type: iosContent.mediaType,
+      deviceType: 'IOS',
+    };
+    if (iosContent?.actionOnClick && (iosContent?.deepLinkValue || iosContent?.externalLinkValue)) {
+      const actionLink = iosContent?.linkType === EXTERNAL_LINK ? iosContent?.externalLinkValue : iosContent?.deepLinkValue;
+      iosLegacy.cta = {
+        type: iosContent?.linkType === EXTERNAL_LINK ? EXTERNAL_URL : DEEP_LINK,
+        actionLink,
+      };
+    }
+  }
+
+  // Helper to check if content is non-empty and valid
+  function isValidContent(content) {
+    return content && typeof content === 'object' && content.title && content.message;
+  }
+
+  // Determine platform support from accountData
+  // const isAndroidSupported = accountData?.configs?.android === '1';
+  // const isIosSupported = accountData?.configs?.ios === '1';
+
+  if (isAndroidSupported && (!androidContent || !androidContent?.title || !androidContent?.message)) {
+    console.error('Android content missing or invalid:', androidContent);
+    throw new Error("Android content must have title and message");
+  }
+  if (isIosSupported && (!iosContent || !iosContent?.title || !iosContent?.message)) {
+    console.error('iOS content missing or invalid:', iosContent);
+    throw new Error("iOS content must have title and message");
+  }
+
+  // Compose the full payload in legacy format
+  const versionsBase = {};
+  if (androidLegacy) versionsBase.ANDROID = androidLegacy;
+  if (iosLegacy) versionsBase.IOS = iosLegacy;
+
+  // Fallback template name to platform title if not provided
+  let finalTemplateName = trimmedTemplateName;
+  if (!finalTemplateName) {
+    finalTemplateName = (androidContent && androidContent.title) || (iosContent && iosContent.title) || '';
+  }
+
+  const payload = {
+    versions: {
+      base: versionsBase,
+    },
+    type: MOBILE_PUSH_CHANNEL,
+    name: finalTemplateName,
+    definition: {
+      accountId,
+      licenseCode,
+      mode: options?.mode || TEXT.toLowerCase(),
+      sourceType,
+      sameContent,
+    },
+  };
+
+  return payload;
+}
+
+export { createPayload };