@capillarytech/creatives-library 9.0.56-alpha.4 → 9.0.56-alpha.5

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@capillarytech/creatives-library",
   "author": "meharaj",
-  "version": "9.0.56-alpha.4",
+  "version": "9.0.56-alpha.5",
   "description": "Capillary creatives ui",
   "main": "./index.js",
   "module": "./index.es.js",

package/services/api.js

@@ -701,21 +701,23 @@ export const createCentralCommsMetaId = (payload, metaType = TRANSACTION) => {
   return request(url, getAPICallObject('POST', payload, false, false, false, true));
 };
 
-// CCS CommDefinition API (new Veyron /api/v1/commdefinition surface, proxied through cap-creatives-api /comm-definitions); used by CommunicationFlow's Save, while legacy messageMeta functions remain for CreativesContainer's save flow (Cap/sagas.js).
+// CCS CommDefinition API, proxied through cap-creatives-api; used by CommunicationFlow's Save, while legacy messageMeta functions remain for CreativesContainer's save flow.
+const COMM_DEFINITIONS_PATH = `${API_ENDPOINT}/comm-definitions`;
+
 export const createCommDefinition = (payload) => {
-  const url = `${API_ENDPOINT}/comm-definitions`;
+  const url = COMM_DEFINITIONS_PATH;
   return request(url, getAPICallObject('POST', payload, false, false, false, true));
 };
 
-// Opens a new DRAFT version with the supplied content on an existing CommDefinition (same id/referenceId); used by CommunicationFlow edit-mode saves to preserve the alert's identity instead of creating a new CommDefinition. Route verified against Veyron's /commdefinition/{id}/edit endpoint.
+// Opens a new DRAFT version on an existing CommDefinition, preserving its id/referenceId.
 export const editCommDefinition = (commDefinitionId, payload) => {
-  const url = `${API_ENDPOINT}/comm-definitions/${commDefinitionId}/edit`;
+  const url = `${COMM_DEFINITIONS_PATH}/${commDefinitionId}/edit`;
   return request(url, getAPICallObject('POST', payload, false, false, false, true));
 };
 
-// Sends a real transactional comm via CCS (notify/ui's "Send test" action uses this instead of the legacy createMessageMeta/sendTestMessage flow — see CommonTestAndPreview's handleSendTestMessage).
+// notify/ui's "Send test" uses this instead of the legacy createMessageMeta/sendTestMessage flow.
 export const sendTransactionalComm = (payload) => {
-  const url = `${API_ENDPOINT}/comm-definitions/send/transaction`;
+  const url = `${COMM_DEFINITIONS_PATH}/send/transaction`;
   return request(url, getAPICallObject('POST', payload, false, false, false, true));
 };
 

package/v2Components/CommonTestAndPreview/UnifiedPreview/index.js

@@ -140,7 +140,8 @@ const UnifiedPreview = ({
       }
 
       case CHANNELS.LINE:
-        // LINE currently carries a single text message; CCS stores lineMessageContent.messageBody as JSON for LINE's native messages[] (see testAndPreviewDataTransform.js), already reduced to plain text before this point, so reuse the SMS chat-bubble preview. Rich LINE types (image/video/sticker/imageMap/carousel/flex) are not specially rendered yet.
+        // LINE carries a single plain-text message today, so it reuses the SMS chat-bubble
+        // preview. Rich types (image/video/sticker/imageMap/carousel/flex) aren't rendered yet.
         return (
           <SmsPreviewContent
             content={typeof content === 'string' ? content : (content?.resolvedBody || '')}

package/v2Components/CommonTestAndPreview/index.js

@@ -209,7 +209,7 @@ const CommonTestAndPreview = (props) => {
     wecrmAccounts = [],
     isLoadingSenderDetails = false,
     orgUnitId = -1,
-    // notify/ui only: { commDefinitionId, referenceId } — when present, "Send test" calls CCS's send/transaction endpoint directly instead of the legacy createMessageMeta/sendTestMessage flow.
+    // notify/ui only: { commDefinitionId, referenceId } — routes "Send test" to CCS's send/transaction endpoint.
     ccsSendTransaction,
     // Email-specific props
     beeInstance,

package/v2Containers/CommunicationFlow/CommunicationFlow.js

@@ -46,11 +46,8 @@ import { getEnabledSteps } from './utils/getEnabledSteps';
 import messages from './messages';
 import './CommunicationFlow.scss';
 
-// Self-injects the same 'cap' reducer CreativesContainer already injects under this key
-// (see CreativesContainer/index.js's withCapReducer) — idempotent, so it's a no-op if the
-// consumer's own store already provides it. Guarantees makeSelectAuthenticated() below never
-// reads an undefined domain, regardless of whether a given consumer (e.g. coupons,
-// cartPromotions) wires up its own 'cap' slice.
+// Self-injects the same 'cap' reducer CreativesContainer already injects under this key;
+// idempotent, so it's a no-op if the consumer's own store already provides it.
 const withCapReducer = injectReducer({ key: 'cap', reducer: capReducer });
 
 const getDeliveryChannels = (contentItems) => {
@@ -64,7 +61,7 @@ const hasDeliverySettingForChannel = (channelSetting, channel) => {
   return !!settings && Object.values(settings).some((v) => v !== null && v !== '' && v !== undefined);
 };
 
-// createCommDefinition resolves with the CCS error envelope for 4xx/5xx responses (see api.js request()/checkStatus); duplicate referenceId within the org returns a 409.
+// Duplicate referenceId within the org returns a 409 CCS error envelope.
 const isDuplicateReferenceIdError = (res) => res?.success === false && res?.status?.message === REFERENCE_ID_EXISTS;
 
 const CommunicationFlow = ({
@@ -162,12 +159,10 @@ const CommunicationFlow = ({
     if (shouldUseCCS) {
       const isMultiChannel = [CHANNEL_PRIORITY, AB_TEST].includes(aggregatedData.communicationStrategy);
       const contentItem = (aggregatedData.contentItems || [])[0];
-      // Consumer-supplied name (e.g. CapNotify's Alert Name field) — CommunicationFlow
-      // has no name input of its own, so this is mandatory input from config.context.
+      // Consumer-supplied (e.g. CapNotify's Alert Name field) — CommunicationFlow has no name input of its own.
       const name = config?.context?.name;
 
-      // CCS create is SINGLE-strategy only this phase (D1); CHANNEL_PRIORITY/AB_TEST
-      // carry multiple content items with no CCS equivalent yet.
+      // CCS create only supports SINGLE strategy; CHANNEL_PRIORITY/AB_TEST have no CCS equivalent yet.
       if (!isMultiChannel && contentItem && name) {
         const rawChannel = (contentItem.channel || '').toUpperCase();
         const channel = CCS_CHANNEL_NAME_MAP[rawChannel] || rawChannel;
@@ -177,8 +172,7 @@ const CommunicationFlow = ({
         const contentPayload = contentTransform ? contentTransform(contentItem.templateData) : contentItem.templateData;
         const { dynamicControls = {} } = aggregatedData;
         const channelSettings = aggregatedData.deliverySetting?.channelSetting?.[channel] || {};
-        // referenceId/description are user-editable, optional fields (up until Send for
-        // approval) — sent as '' rather than auto-generated/omitted when left blank.
+        // Optional fields — sent as '' rather than omitted when left blank.
         const referenceId = config?.context?.referenceId || '';
         const description = config?.context?.description || '';
 
@@ -199,29 +193,35 @@ const CommunicationFlow = ({
           singleChannelStrategy: {
             variant: {
               channel,
-              // `channel` must be spread last in both objects so CCS's normalized enum (e.g. `PUSH`) overrides the UI's internal identifier (e.g. `MOBILEPUSH`) from templateData.
+              // `channel` spread last so CCS's normalized enum overrides the UI's internal identifier.
               ...(contentKey && { [contentKey]: { ...contentPayload, channel } }),
               ...(deliveryKey && { [deliveryKey]: { channelSettings: { ...channelSettings, channel } } }),
             },
           },
         };
 
-        // Editing an existing alert (e.g. rejected) uses config.context.existingCommDefinitionId to create a new DRAFT version on the same CommDefinition, preserving its id/referenceId instead of creating a new alert.
+        // existingCommDefinitionId (set when editing, e.g. a rejected alert) creates a new
+        // DRAFT version on the same CommDefinition instead of a new one.
         const { existingCommDefinitionId } = config?.context || {};
+        const {
+          referenceId: payloadReferenceId,
+          description: payloadDescription,
+          strategyType,
+          settings,
+          singleChannelStrategy,
+        } = payload;
 
         try {
           const res = existingCommDefinitionId
             ? await editCommDefinition(existingCommDefinitionId, {
-              referenceId: payload.referenceId,
-              description: payload.description,
-              strategyType: payload.strategyType,
-              settings: payload.settings,
-              singleChannelStrategy: payload.singleChannelStrategy,
+              referenceId: payloadReferenceId,
+              description: payloadDescription,
+              strategyType,
+              settings,
+              singleChannelStrategy,
             })
             : await createCommDefinition(payload);
           if (isDuplicateReferenceIdError(res)) {
-            // Duplicate referenceId in this org — block the save so the user can
-            // change it, rather than silently proceeding without a CCS comm.
             setSaveError(formatMessage(messages.duplicateReferenceIdError));
             return;
           }
@@ -291,10 +291,8 @@ const CommunicationFlow = ({
           </CapRow>
         );
       case STEPS.COMMUNICATION_STRATEGY: {
-        // No visible divider line when there's no content yet (matches the empty-state
-        // design), but the vertical gap above the Channel card must stay either way —
-        // see the `.communication-strategy-row` spacing rule in CommunicationFlow.scss,
-        // which is not tied to whether the divider itself renders.
+        // No divider when there's no content yet, but the spacing above the Channel
+        // card must stay either way — see .communication-strategy-row in the scss.
         const templateStepFollows = enabledSteps.includes(STEPS.CHANNEL_SELECTION);
         const hasContent = stepData.contentItems?.length > 0;
         return (

package/v2Containers/CommunicationFlow/CommunicationFlowCard.js

@@ -111,10 +111,8 @@ const CommunicationFlowCard = ({
     const senderIdValue = getSenderIdValue(firstItem, savedData);
     const controls = config?.features?.dynamicControlsData?.controls || DYNAMIC_CONTROLS_CONFIG;
     const dynamicControlKeys = Object.keys(savedData?.dynamicControls || {});
-    // Mirrors getEnabledSteps.js's own gate on this flag (which skips the in-slidebox
-    // DynamicControlsStep) — consumers like CapNotify that set showDynamicControls:
-    // false render their own "Advanced controls" section elsewhere, so this summary
-    // card's right column would otherwise show a redundant, always-empty control list.
+    // Consumers that set showDynamicControls: false render their own "Advanced
+    // controls" section elsewhere, so skip this card's redundant control list.
     const showDynamicControls = config?.features?.showDynamicControls !== false;
     const channel = firstItem.channel?.toUpperCase();
     const senderLabel = [WHATSAPP, RCS].includes(channel)

package/v2Containers/CommunicationFlow/constants.js

@@ -38,15 +38,16 @@ 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.
+// CCS create is only supported for SINGLE (CHANNEL_PRIORITY/AB_TEST skip CCS entirely).
 export const CCS_STRATEGY_TYPE_SINGLE = 'SINGLE';
 
-// Mirrors CCS SingleChannelStrategy field names exactly (per Cap Notify API design samples and real create responses); kept separate from the legacy messageMeta CHANNEL_CONTENT_KEY_MAP/CHANNEL_DELIVERY_KEY_MAP.
+// Mirrors CCS SingleChannelStrategy field names; kept separate from the legacy
+// messageMeta CHANNEL_CONTENT_KEY_MAP/CHANNEL_DELIVERY_KEY_MAP.
 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*'.
+  // CCS's channel enum for mobile push is 'PUSH', but content/delivery keys stay 'mpush*'.
   PUSH: 'mpushMessageContent',
   INAPP: 'inAppMessageContent',
   ANDROID: 'androidMessageContent',
@@ -58,17 +59,16 @@ export const CCS_CHANNEL_CONTENT_KEY_MAP = {
   RCS: 'rcsMessageContent',
 };
 
-// contentItem.templateData uses legacy messageMeta field names, so transform mismatched channel fields before sending to CCS; for EMAIL, map legacy `emailSubject`/`emailBody` to CCS's `messageSubject`/`messageBody`.
+// Transforms legacy messageMeta field names to CCS's before sending, for channels
+// where the two shapes don't already match.
 export const CCS_CONTENT_TRANSFORMS = {
   EMAIL: (templateData = {}) => ({
     messageSubject: templateData.emailSubject,
     messageBody: templateData.emailBody || templateData.emailHtml,
   }),
-  // SMS: legacy stores text as `messageBody`, while CCS expects `message`; map the field explicitly to avoid CCS returning smsMessageContent.message as null.
   SMS: (templateData = {}) => ({
     message: templateData.messageBody || '',
   }),
-  // WEBPUSH: the legacy editor nests data under messageContent.content; flatten it to CCS's { messageSubject, accountId, content } shape and drop the legacy-only `offers` field.
   WEBPUSH: (templateData = {}) => {
     const inner = templateData.messageContent?.content || templateData;
     return {
@@ -94,12 +94,14 @@ export const CCS_CHANNEL_DELIVERY_KEY_MAP = {
   RCS: 'rcsDeliverySettings',
 };
 
-// The UI uses `MOBILEPUSH`, while CCS uses `PUSH` for the channel enum (verified against real create responses); normalize this value before building the CCS payload, while retaining the `mpush*` content/delivery keys. All other channel identifiers pass through unchanged.
+// UI uses `MOBILEPUSH`; CCS uses `PUSH` for the channel enum. Other channels pass through.
 export const CCS_CHANNEL_NAME_MAP = {
   MOBILEPUSH: 'PUSH',
 };
 
-// Channel config — single source of truth for CreativesContainer and TemplatesV2; paneKey is the TemplatesV2 defaultPanes key used by channelsToHide, and channelProp is the CreativesContainer channel prop that must match pane.key for the tab to be active.
+// Channel config — single source of truth for CreativesContainer and TemplatesV2.
+// paneKey: TemplatesV2 defaultPanes key used by channelsToHide.
+// channelProp: CreativesContainer channel prop that must match pane.key for the tab to be active.
 export const CHANNELS = [
   {
     value: 'SMS',

package/v2Containers/CommunicationFlow/index.js

@@ -80,15 +80,13 @@ CommunicationFlowContainer.propTypes = {
         controls: PropTypes.array,
       }),
     }),
-    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.
+    context: PropTypes.object, // ouId, campaignId, programId, name, referenceId, description
+    useCCS: PropTypes.bool, // skips the CCS createCommDefinition call on save when false; defaults to true
   }).isRequired,
   initialData: PropTypes.object, // for edit/preview mode
-  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
+  onSave: PropTypes.func.isRequired, // (data) => void, data.ccsCommDefinition set when CCS create succeeded
+  onCancel: PropTypes.func.isRequired, // () => void
+  onChange: PropTypes.func, // (data) => void
 };
 
 CommunicationFlowContainer.defaultProps = {