@capillarytech/creatives-library 9.0.54 → 9.0.55-alpha.0

package/v2Containers/CommunicationFlow/constants.js

@@ -38,6 +38,95 @@ export const CHANNEL_PRIORITY = 'CHANNEL_PRIORITY';
 export const AB_TEST = 'AB_TEST';
 export const SINGLE_TEMPLATE = 'SINGLE_TEMPLATE';
 
+// CCS CommDefinition strategyType — distinct from SINGLE_TEMPLATE above, which
+// is this UI's own communicationStrategy value. Only SINGLE is supported this
+// phase; CCS create is skipped entirely for CHANNEL_PRIORITY/AB_TEST.
+export const CCS_STRATEGY_TYPE_SINGLE = 'SINGLE';
+
+// Mirrors CCS's SingleChannelStrategy field names exactly (Cap Notify API
+// Design doc sample payloads, verified against real create responses). Kept
+// separate from CHANNEL_CONTENT_KEY_MAP/CHANNEL_DELIVERY_KEY_MAP below, which
+// are the legacy messageMeta payload's keys.
+export const CCS_CHANNEL_CONTENT_KEY_MAP = {
+  SMS: 'smsMessageContent',
+  EMAIL: 'emailMessageContent',
+  WHATSAPP: 'whatsappMessageContent',
+  // CCS's channel enum value for mobile push is 'PUSH' (verified against real
+  // create responses), even though the content/delivery keys stay 'mpush*'.
+  PUSH: 'mpushMessageContent',
+  INAPP: 'inAppMessageContent',
+  ANDROID: 'androidMessageContent',
+  IOS: 'iosMessageContent',
+  ZALO: 'zaloMessageContent',
+  VIBER: 'viberMessageContent',
+  LINE: 'lineMessageContent',
+  WEBPUSH: 'webPushMessageContent',
+  RCS: 'rcsMessageContent',
+};
+
+// contentItem.templateData is built by the legacy CreativesContainer content
+// editor (messageMeta-oriented field names) — for channels whose legacy field
+// names don't match CCS's own content schema, transform before sending rather
+// than dumping templateData as-is. EMAIL: legacy stores the subject as
+// `emailSubject` and the HTML body as `emailBody` (see
+// extractContentForPreview.js and CreativesContainer/index.js, where the Bee
+// editor's output is written back into templateData.emailBody — also
+// mirrored by the existing legacy emailMessageContent builder in
+// utils/transformerUtils.js). CCS expects `messageSubject`/`messageBody`.
+export const CCS_CONTENT_TRANSFORMS = {
+  EMAIL: (templateData = {}) => ({
+    messageSubject: templateData.emailSubject,
+    messageBody: templateData.emailBody || templateData.emailHtml,
+  }),
+  // SMS: legacy stores the typed text as `messageBody` (see
+  // CreativesContainer/index.js's getCreativesData SMS case, and the existing
+  // legacy smsMessageContent builder in utils/transformerUtils.js, both of
+  // which read/write this same field) — CCS's schema expects it as `message`
+  // (confirmed against a real CCS response showing smsMessageContent.message
+  // stayed null when messageBody was sent instead).
+  SMS: (templateData = {}) => ({
+    message: templateData.messageBody || '',
+  }),
+  // WEBPUSH: the legacy editor nests the real data under
+  // messageContent.content (see CommunicationFlowCard.js's own comment on
+  // this same wrapping, for the edit-mode case) — extracting it flat here
+  // matches CCS's shape ({ messageSubject, accountId, content }); `offers`
+  // (a legacy-only field) is deliberately dropped, not part of CCS's schema.
+  WEBPUSH: (templateData = {}) => {
+    const inner = templateData.messageContent?.content || templateData;
+    return {
+      messageSubject: inner.messageSubject,
+      accountId: inner.accountId,
+      content: inner.content,
+    };
+  },
+};
+
+export const CCS_CHANNEL_DELIVERY_KEY_MAP = {
+  SMS: 'smsDeliverySettings',
+  EMAIL: 'emailDeliverySettings',
+  WHATSAPP: 'whatsappDeliverySettings',
+  PUSH: 'mpushDeliverySettings',
+  INAPP: 'inAppDeliverySettings',
+  ANDROID: 'androidDeliverySettings',
+  IOS: 'iosDeliverySettings',
+  ZALO: 'zaloDeliverySettings',
+  VIBER: 'viberDeliverySettings',
+  LINE: 'lineDeliverySettings',
+  WEBPUSH: 'webPushDeliverySettings',
+  RCS: 'rcsDeliverySettings',
+};
+
+// The UI's own internal channel identifier for mobile push is 'MOBILEPUSH'
+// (see CreativesContainer/constants.js MOBILE_PUSH), but CCS's channel enum
+// value is 'PUSH' (verified against real create responses — the content/
+// delivery KEYS still say 'mpush*', only the enum VALUE is 'PUSH') —
+// normalize before building the CCS payload. Every other channel identifier
+// matches CCS as-is.
+export const CCS_CHANNEL_NAME_MAP = {
+  MOBILEPUSH: 'PUSH',
+};
+
 // Channel config - single source of truth for CreativesContainer and TemplatesV2
 // paneKey: TemplatesV2 defaultPanes object key (for channelsToHide)
 // channelProp: CreativesContainer channel prop (must match pane.key for tab to be active)
@@ -232,4 +321,4 @@ export const INCENTIVE_TYPES = [
   {
     value: 'badges', label: <FormattedMessage {...messages.badges} />, isActive: false, disabled: false,
   },
-];
+];

package/v2Containers/CommunicationFlow/index.js

@@ -9,7 +9,6 @@
 import React from 'react';
 import PropTypes from 'prop-types';
 import CommunicationFlow from './CommunicationFlow';
-import { hasSupportEngagementModule } from '../../utils/common';
 
 const CommunicationFlowContainer = ({
   config,
@@ -18,22 +17,16 @@ const CommunicationFlowContainer = ({
   onCancel,
   onChange,
   ...otherProps
-}) => {
-  if (!hasSupportEngagementModule()) {
-    return null;
-  }
-
-  return (
-    <CommunicationFlow
-      config={config}
-      initialData={initialData}
-      onSave={onSave}
-      onCancel={onCancel}
-      onChange={onChange}
-      {...otherProps}
-    />
-  );
-};
+}) => (
+  <CommunicationFlow
+    config={config}
+    initialData={initialData}
+    onSave={onSave}
+    onCancel={onCancel}
+    onChange={onChange}
+    {...otherProps}
+  />
+);
 
 CommunicationFlowContainer.propTypes = {
   config: PropTypes.shape({
@@ -87,11 +80,13 @@ CommunicationFlowContainer.propTypes = {
         controls: PropTypes.array,
       }),
     }),
-    context: PropTypes.object, // ouId, campaignId, programId, etc.
-    useCCS: PropTypes.bool, // If false, skips CCS bulk-claim-approve on save. Defaults to true.
+    context: PropTypes.object, // ouId, campaignId, programId; name (required for CCS create),
+    // referenceId (optional, auto-generated from name if absent), description (optional).
+    useCCS: PropTypes.bool, // If false, skips the CCS createCommDefinition call on save. Defaults to true.
   }).isRequired,
   initialData: PropTypes.object, // for edit/preview mode
-  onSave: PropTypes.func.isRequired, // (data) => void - called when user saves
+  onSave: PropTypes.func.isRequired, // (data) => void - called when user saves; data.ccsCommDefinition
+  // ({id, referenceId, version, status}) is present when the CCS create succeeded
   onCancel: PropTypes.func.isRequired, // () => void - called when user cancels
   onChange: PropTypes.func, // (data) => void - optional, called on data changes
 };

package/v2Containers/CommunicationFlow/messages.js

@@ -363,4 +363,8 @@ export default {
     id: `${prefix}.senderNotConfiguredError`,
     defaultMessage: 'Selected domain gateway id is not correct. Please change the domain id or contact the gateway team to register them with Capillary.',
   },
+  duplicateReferenceIdError: {
+    id: `${prefix}.duplicateReferenceIdError`,
+    defaultMessage: 'This reference ID is already in use in your organization. Please use a different reference ID.',
+  },
 };

package/v2Containers/CommunicationFlow/steps/DeliverySettingsStep/SenderDetails.js

@@ -29,6 +29,7 @@ import {
   getEmailDefaultsForDomainId,
   getSmsDefaultsForDomainId,
   getRcsAccountName,
+  getEmailDomainGatewayMapIdByDomainId,
 } from './deliverySettingsConfig';
 import messages from '../../messages';
 import './SenderDetails.scss';
@@ -151,6 +152,11 @@ const SenderDetails = ({
           saveValues.whatsappDomainId = matchedDomain?.domainProperties?.id ?? matchedDomain?.domainId ?? matchedDomain?.id;
         }
       }
+      // Include EMAIL domainGatewayMapId derived from the selected domain for persistence -
+      // CCS needs it alongside domainId, but it's not a user-facing field.
+      if (entity && fieldValues.emailDomain != null && fieldValues.emailDomain !== '') {
+        saveValues.emailDomainGatewayMapId = getEmailDomainGatewayMapIdByDomainId(entity, fieldValues.emailDomain);
+      }
       onSave(saveValues);
     }
     onClose();

package/v2Containers/CommunicationFlow/steps/DeliverySettingsStep/Tests/SenderDetails.test.js

@@ -83,6 +83,7 @@ const ENTITIES = {
   emailTwoDomains: {
     EMAIL: [
       {
+        id: 'gwmap-a',
         domainProperties: {
           id: 'em-a',
           domainName: 'Mail Alpha',
@@ -101,6 +102,7 @@ const ENTITIES = {
         },
       },
       {
+        id: 'gwmap-b',
         domainProperties: {
           id: 'em-b',
           domainName: 'Mail Beta',
@@ -322,6 +324,29 @@ describe('SenderDetails', () => {
     });
   });
 
+  it('persists emailDomainGatewayMapId derived from the selected email domain on save', async () => {
+    const { onSave } = renderSenderDetails({
+      channels: ['EMAIL'],
+      preloadedDomainProperties: ENTITIES.emailTwoDomains,
+    });
+    const root = document.querySelector('.sender-details');
+    await waitFor(() => expect(within(root).getByText('Mail Alpha')).toBeInTheDocument());
+
+    await openSelectAndChoose(root, 0, 'Mail Beta');
+    await waitFor(() => expect(within(root).getByText('beta@other.com')).toBeInTheDocument());
+
+    const saveBtn = within(root).getByRole('button', { name: /save changes/i });
+    await waitFor(() => expect(saveBtn).not.toBeDisabled());
+    fireEvent.click(saveBtn);
+
+    expect(onSave).toHaveBeenCalledWith(
+      expect.objectContaining({
+        emailDomain: 'em-b',
+        emailDomainGatewayMapId: 'gwmap-b',
+      }),
+    );
+  });
+
   it('resets email domain row back to the first gateway', async () => {
     renderSenderDetails({
       channels: ['EMAIL'],

package/v2Containers/CommunicationFlow/steps/DeliverySettingsStep/Tests/deliverySettingsConfig.test.js

@@ -438,6 +438,7 @@ describe('deliverySettingsConfig — user-facing flows', () => {
         smsDomain: 'd1',
         smsSenderId: 'g1',
         emailDomain: 'ed',
+        emailDomainGatewayMapId: 'gwmap-1',
         emailSenderId: 'mail@x.com',
         emailSenderName: 'N',
         emailReplyToId: 'r@x.com',
@@ -455,9 +456,10 @@ describe('deliverySettingsConfig — user-facing flows', () => {
         SMS: { domainId: 'd1', gsmSenderId: 'g1' },
         EMAIL: {
           domainId: 'ed',
-          senderEmail: 'mail@x.com',
+          domainGatewayMapId: 'gwmap-1',
+          senderId: 'mail@x.com',
           senderLabel: 'N',
-          senderReplyTo: 'r@x.com',
+          replyToId: 'r@x.com',
         },
         WHATSAPP: { domainId: 'wd', senderMobNum: '+w' },
         RCS: { senderMobNum: '+r', rcsSender: '+r' },
@@ -472,9 +474,10 @@ describe('deliverySettingsConfig — user-facing flows', () => {
         SMS: { domainId: 'd', gsmSenderId: 'g' },
         EMAIL: {
           domainId: 'ed',
-          senderEmail: 'e@e.com',
+          domainGatewayMapId: 'gwmap-2',
+          senderId: 'e@e.com',
           senderLabel: 'L',
-          senderReplyTo: 'r@e.com',
+          replyToId: 'r@e.com',
         },
         WHATSAPP: { senderMobNum: '+w', domainId: 'wid' },
         RCS: { rcsSender: '+r' },
@@ -486,6 +489,10 @@ describe('deliverySettingsConfig — user-facing flows', () => {
         smsDomain: 'd',
         smsSenderId: 'g',
         emailDomain: 'ed',
+        emailDomainGatewayMapId: 'gwmap-2',
+        emailSenderId: 'e@e.com',
+        emailSenderName: 'L',
+        emailReplyToId: 'r@e.com',
         whatsappDomainId: 'wid',
         viberSenderId: 'vx',
       });

package/v2Containers/CommunicationFlow/steps/DeliverySettingsStep/deliverySettingsConfig.js

@@ -181,6 +181,14 @@ const getEmailDomainValue = (entity) => {
   return emailData.domainProperties?.id ?? emailData.domainId ?? emailData.id ?? '';
 };
 
+// CCS's domainGatewayMapId is the domainProperties API's own outer `id`
+// (distinct from `domainProperties.id`, which is the numeric domainId) - the
+// domain-gateway-mapping id for the selected domain entry.
+const getEmailDomainGatewayMapIdByDomainId = (entity, domainId) => {
+  const domainEntry = getEmailDomainById(entity, domainId);
+  return domainEntry?.id ?? '';
+};
+
 /** Domain name for summary display (parseEntityForDisplay) */
 const getEmailDomainNameForDisplay = (entity) => {
   const emailData = getEmailData(entity);
@@ -262,6 +270,8 @@ const getEmailDefaultsForDomain = (domainData) => {
  * context.fieldValues has current form state (e.g. selected emailDomain)
  * Aligned with adiona-ui/cap-campaigns-v2: default = contactInfo item with default:true, or first
  */
+export { getEmailDomainGatewayMapIdByDomainId };
+
 export const getDefaultValueForField = (fieldKey, entity, context = {}) => {
   if (!entity) return '';
   const fieldValues = context?.fieldValues || {};
@@ -574,7 +584,11 @@ export const parseEntityForDisplay = (entity, context = {}) => {
     senderDetails: entity,
     smsSenderId: getSmsSenderIdValue(entity),
     smsDomain: getSmsDomainValue(entity),
+    // emailDomain here is the domain NAME (for display only) - buildChannelSettingFromFieldValues
+    // needs the numeric domainId/domainGatewayMapId, sourced separately below.
     emailDomain: getEmailDomainNameForDisplay(entity),
+    emailDomainId: getEmailDomainValue(entity),
+    emailDomainGatewayMapId: getEmailDomainGatewayMapIdByDomainId(entity, getEmailDomainValue(entity)),
     emailSenderId: getEmailSenderIdValue(entity),
     viberSenderId: getSenderIdFromContactInfo(entity, 'VIBER'),
     zaloSenderId: getSenderIdFromContactInfo(entity, 'ZALO'),
@@ -600,10 +614,14 @@ export const buildChannelSettingFromFieldValues = (fieldValues = {}) => {
   }
   if (fieldValues.emailDomain != null || fieldValues.emailSenderId != null || fieldValues.emailSenderName != null || fieldValues.emailReplyToId != null) {
     channelSetting.EMAIL = {
-      domainId: fieldValues.emailDomain,
-      senderEmail: fieldValues.emailSenderId,
+      // emailDomainId (numeric, from the auto-save-defaults path via parseEntityForDisplay)
+      // takes priority over emailDomain, which is numeric when sourced from SenderDetails'
+      // own field state but a display NAME string when sourced from parseEntityForDisplay.
+      domainId: fieldValues.emailDomainId ?? fieldValues.emailDomain,
+      domainGatewayMapId: fieldValues.emailDomainGatewayMapId,
+      senderId: fieldValues.emailSenderId,
       senderLabel: fieldValues.emailSenderName,
-      senderReplyTo: fieldValues.emailReplyToId,
+      replyToId: fieldValues.emailReplyToId,
     };
   }
   if (fieldValues.whatsappSenderNumber != null || fieldValues.whatsappAccount != null) {
@@ -673,9 +691,10 @@ export const parseChannelSettingForDisplay = (channelSetting = {}) => {
   }
   if (channelSetting.EMAIL) {
     out.emailDomain = channelSetting.EMAIL.domainId;
-    out.emailSenderId = channelSetting.EMAIL.senderEmail;
+    out.emailDomainGatewayMapId = channelSetting.EMAIL.domainGatewayMapId;
+    out.emailSenderId = channelSetting.EMAIL.senderId;
     out.emailSenderName = channelSetting.EMAIL.senderLabel;
-    out.emailReplyToId = channelSetting.EMAIL.senderReplyTo;
+    out.emailReplyToId = channelSetting.EMAIL.replyToId;
   }
   if (channelSetting.WHATSAPP) {
     out.whatsappSenderNumber = channelSetting.WHATSAPP.senderMobNum;

package/v2Containers/CreativesContainer/index.js

@@ -2456,7 +2456,7 @@ export class Creatives extends React.Component {
           )}
           handleClose={this.handleCloseSlideBox}
           show={showSlideBox}
-          size="size-xl"
+          size="size-l"
         />
       </SlideBoxWrapper>
     );