@contentstack/cli-variants 1.3.6 → 1.3.8

package/lib/import/audiences.js

@@ -37,7 +37,7 @@ class Audiences extends utils_1.PersonalizationAdapter {
      */
     import() {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
+            var _a, _b, _c;
             yield this.init();
             yield utils_1.fsUtil.makeDirectory(this.audienceMapperDirPath);
             cli_utilities_1.log.debug(`Created mapper directory: ${this.audienceMapperDirPath}`, this.config.context);
@@ -53,9 +53,14 @@ class Audiences extends utils_1.PersonalizationAdapter {
                     for (const audience of audiences) {
                         let { name, definition, description, uid } = audience;
                         cli_utilities_1.log.debug(`Processing audience: ${name} (${uid})`, this.config.context);
+                        // Skip Lytics audiences - they cannot be created via API (synced from Lytics)
+                        if (((_a = audience.source) === null || _a === void 0 ? void 0 : _a.toUpperCase()) === 'LYTICS') {
+                            cli_utilities_1.log.debug(`Skipping Lytics audience: ${name} (${uid})`, this.config.context);
+                            continue;
+                        }
                         try {
                             //check whether reference attributes exists or not
-                            if ((_a = definition.rules) === null || _a === void 0 ? void 0 : _a.length) {
+                            if ((_b = definition === null || definition === void 0 ? void 0 : definition.rules) === null || _b === void 0 ? void 0 : _b.length) {
                                 cli_utilities_1.log.debug(`Processing ${definition.rules.length} definition rules for audience: ${name}`, this.config.context);
                                 definition.rules = (0, utils_1.lookUpAttributes)(definition.rules, attributesUid);
                                 cli_utilities_1.log.debug(`Processed definition rules, remaining rules: ${definition.rules.length}`, this.config.context);
@@ -67,7 +72,7 @@ class Audiences extends utils_1.PersonalizationAdapter {
                             const audienceRes = yield this.createAudience({ definition, name, description });
                             //map old audience uid to new audience uid
                             //mapper file is used to check whether audience created or not before creating experience
-                            this.audiencesUidMapper[uid] = (_b = audienceRes === null || audienceRes === void 0 ? void 0 : audienceRes.uid) !== null && _b !== void 0 ? _b : '';
+                            this.audiencesUidMapper[uid] = (_c = audienceRes === null || audienceRes === void 0 ? void 0 : audienceRes.uid) !== null && _c !== void 0 ? _c : '';
                             cli_utilities_1.log.debug(`Created audience: ${uid} -> ${audienceRes === null || audienceRes === void 0 ? void 0 : audienceRes.uid}`, this.config.context);
                         }
                         catch (error) {

package/lib/import/experiences.js

@@ -156,12 +156,16 @@ class Experiences extends utils_1.PersonalizationAdapter {
             };
             // Process each version and map them by status
             versions.forEach((version) => {
+                var _a, _b, _c, _d;
                 let versionReqObj = (0, utils_1.lookUpAudiences)(version, this.audiencesUid);
                 versionReqObj = (0, utils_1.lookUpEvents)(version, this.eventsUid);
-                if (versionReqObj && versionReqObj.status) {
+                if (versionReqObj && versionReqObj.status && ((_b = (_a = versionReqObj.variants) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0) > 0) {
                     versionMap[versionReqObj.status] = versionReqObj;
                     cli_utilities_1.log.debug(`Mapped version with status: ${versionReqObj.status}`, this.config.context);
                 }
+                else if ((versionReqObj === null || versionReqObj === void 0 ? void 0 : versionReqObj.status) && !((_d = (_c = versionReqObj.variants) === null || _c === void 0 ? void 0 : _c.length) !== null && _d !== void 0 ? _d : 0)) {
+                    cli_utilities_1.log.warn(`Skipping version ${versionReqObj.status}: no valid variants (all had unmapped Lytics audiences)`, this.config.context);
+                }
             });
             // Prioritize updating or creating versions based on the order: ACTIVE -> DRAFT -> PAUSE
             return yield this.handleVersionUpdateOrCreate(experience, versionMap);

package/lib/utils/audiences-helper.js

@@ -30,7 +30,7 @@ function updateAudiences(audiences, audiencesUid) {
  * @returns
  */
 const lookUpAudiences = (experience, audiencesUid) => {
-    var _a, _b, _c, _d, _e, _f, _g, _h;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
     cli_utilities_1.log.debug('Starting audience lookup for experience');
     cli_utilities_1.log.debug(`Available audience mappings: ${(_a = Object.keys(audiencesUid)) === null || _a === void 0 ? void 0 : _a.length}`);
     // Update experience variations
@@ -57,10 +57,13 @@ const lookUpAudiences = (experience, audiencesUid) => {
         for (let index = experience.variants.length - 1; index >= 0; index--) {
             const expVariations = experience.variants[index];
             cli_utilities_1.log.debug(`Processing variant ${index + 1}/${experience.variants.length} of type: ${expVariations['__type']}`);
-            if (expVariations['__type'] === 'SegmentedVariant' && ((_d = expVariations === null || expVariations === void 0 ? void 0 : expVariations.audiences) === null || _d === void 0 ? void 0 : _d.length)) {
-                cli_utilities_1.log.debug(`Found ${expVariations.audiences.length} audiences in SegmentedVariant`);
-                updateAudiences(expVariations.audiences, audiencesUid);
-                if (!expVariations.audiences.length) {
+            if (expVariations['__type'] === 'SegmentedVariant' && (((_d = expVariations === null || expVariations === void 0 ? void 0 : expVariations.audiences) === null || _d === void 0 ? void 0 : _d.length) || ((_e = expVariations === null || expVariations === void 0 ? void 0 : expVariations.lyticsAudiences) === null || _e === void 0 ? void 0 : _e.length))) {
+                cli_utilities_1.log.debug(`Found ${(_g = (_f = expVariations.audiences) === null || _f === void 0 ? void 0 : _f.length) !== null && _g !== void 0 ? _g : 0} audiences in SegmentedVariant`);
+                if ((_h = expVariations === null || expVariations === void 0 ? void 0 : expVariations.audiences) === null || _h === void 0 ? void 0 : _h.length)
+                    updateAudiences(expVariations.audiences, audiencesUid);
+                if ((_j = expVariations === null || expVariations === void 0 ? void 0 : expVariations.lyticsAudiences) === null || _j === void 0 ? void 0 : _j.length)
+                    updateAudiences(expVariations.lyticsAudiences, audiencesUid);
+                if (!(((_k = expVariations.audiences) === null || _k === void 0 ? void 0 : _k.length) || ((_l = expVariations === null || expVariations === void 0 ? void 0 : expVariations.lyticsAudiences) === null || _l === void 0 ? void 0 : _l.length))) {
                     cli_utilities_1.log.warn('No audiences remaining after mapping. Removing variant.');
                     experience.variants.splice(index, 1);
                 }
@@ -73,7 +76,7 @@ const lookUpAudiences = (experience, audiencesUid) => {
     else {
         cli_utilities_1.log.debug('No variations or variants found in experience');
     }
-    if (((_e = experience === null || experience === void 0 ? void 0 : experience.targeting) === null || _e === void 0 ? void 0 : _e.hasOwnProperty('audience')) && ((_h = (_g = (_f = experience === null || experience === void 0 ? void 0 : experience.targeting) === null || _f === void 0 ? void 0 : _f.audience) === null || _g === void 0 ? void 0 : _g.audiences) === null || _h === void 0 ? void 0 : _h.length)) {
+    if (((_m = experience === null || experience === void 0 ? void 0 : experience.targeting) === null || _m === void 0 ? void 0 : _m.hasOwnProperty('audience')) && ((_q = (_p = (_o = experience === null || experience === void 0 ? void 0 : experience.targeting) === null || _o === void 0 ? void 0 : _o.audience) === null || _p === void 0 ? void 0 : _p.audiences) === null || _q === void 0 ? void 0 : _q.length)) {
         cli_utilities_1.log.debug(`Processing ${experience.targeting.audience.audiences.length} targeting audiences`);
         // Update targeting audiences
         updateAudiences(experience.targeting.audience.audiences, audiencesUid);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-variants",
-  "version": "1.3.6",
+  "version": "1.3.8",
   "description": "Variants plugin",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -27,11 +27,11 @@
     "typescript": "^5.8.3"
   },
   "dependencies": {
-    "@contentstack/cli-utilities": "~1.16.0",
+    "@contentstack/cli-utilities": "~1.17.4",
     "@oclif/core": "^4.3.0",
     "@oclif/plugin-help": "^6.2.28",
-    "lodash": "^4.17.21",
+    "lodash": "^4.17.23",
     "mkdirp": "^1.0.4",
     "winston": "^3.17.0"
   }
-}
+}

package/src/import/audiences.ts

@@ -70,10 +70,16 @@ export default class Audiences extends PersonalizationAdapter<ImportConfig> {
         for (const audience of audiences) {
           let { name, definition, description, uid } = audience;
           log.debug(`Processing audience: ${name} (${uid})`, this.config.context);
-          
+
+          // Skip Lytics audiences - they cannot be created via API (synced from Lytics)
+          if (audience.source?.toUpperCase() === 'LYTICS') {
+            log.debug(`Skipping Lytics audience: ${name} (${uid})`, this.config.context);
+            continue;
+          }
+
           try {
             //check whether reference attributes exists or not
-            if (definition.rules?.length) {
+            if (definition?.rules?.length) {
               log.debug(`Processing ${definition.rules.length} definition rules for audience: ${name}`, this.config.context);
               definition.rules = lookUpAttributes(definition.rules, attributesUid);
               log.debug(`Processed definition rules, remaining rules: ${definition.rules.length}`, this.config.context);

package/src/import/experiences.ts

@@ -203,9 +203,11 @@ export default class Experiences extends PersonalizationAdapter<ImportConfig> {
       let versionReqObj = lookUpAudiences(version, this.audiencesUid) as CreateExperienceVersionInput;
       versionReqObj = lookUpEvents(version, this.eventsUid) as CreateExperienceVersionInput;
 
-      if (versionReqObj && versionReqObj.status) {
+      if (versionReqObj && versionReqObj.status && (versionReqObj.variants?.length ?? 0) > 0) {
         versionMap[versionReqObj.status] = versionReqObj;
         log.debug(`Mapped version with status: ${versionReqObj.status}`, this.config.context);
+      } else if (versionReqObj?.status && !(versionReqObj.variants?.length ?? 0)) {
+        log.warn(`Skipping version ${versionReqObj.status}: no valid variants (all had unmapped Lytics audiences)`, this.config.context);
       }
     });
 

package/src/utils/audiences-helper.ts

@@ -65,11 +65,11 @@ export const lookUpAudiences = (
       const expVariations = experience.variants[index];
       log.debug(`Processing variant ${index + 1}/${experience.variants.length} of type: ${expVariations['__type']}`);
       
-      if (expVariations['__type'] === 'SegmentedVariant' && expVariations?.audiences?.length) {
-        log.debug(`Found ${expVariations.audiences.length} audiences in SegmentedVariant`);
-        updateAudiences(expVariations.audiences, audiencesUid);
-        
-        if (!expVariations.audiences.length) {
+      if (expVariations['__type'] === 'SegmentedVariant' && (expVariations?.audiences?.length || expVariations?.lyticsAudiences?.length)) {
+        log.debug(`Found ${expVariations.audiences?.length ?? 0} audiences in SegmentedVariant`);
+        if (expVariations?.audiences?.length) updateAudiences(expVariations.audiences, audiencesUid);
+        if (expVariations?.lyticsAudiences?.length) updateAudiences(expVariations.lyticsAudiences, audiencesUid);
+        if (!(expVariations.audiences?.length || expVariations?.lyticsAudiences?.length)) {
           log.warn('No audiences remaining after mapping. Removing variant.');
           experience.variants.splice(index, 1);
         }

package/test/unit/import/audiences.test.ts

@@ -0,0 +1,118 @@
+import { expect } from '@oclif/test';
+import cloneDeep from 'lodash/cloneDeep';
+import { fancy } from '@contentstack/cli-dev-dependencies';
+
+import importConf from '../mock/import-config.json';
+import { Import, ImportConfig } from '../../../src';
+
+describe('Audiences Import', () => {
+  let config: ImportConfig;
+  let createAudienceCalls: Array<{ name: string }> = [];
+
+  const test = fancy.stdout({ print: process.env.PRINT === 'true' || false });
+
+  beforeEach(() => {
+    config = cloneDeep(importConf) as unknown as ImportConfig;
+    createAudienceCalls = [];
+    // Audiences uses modules.personalize and region - add them for tests
+    config.modules.personalize = {
+      ...(config.modules as any).personalization,
+      dirName: 'personalize',
+      baseURL: {
+        na: 'https://personalization.na-api.contentstack.com',
+        eu: 'https://personalization.eu-api.contentstack.com',
+      },
+    } as any;
+    config.region = { name: 'eu' } as any;
+    config.context = config.context || {};
+  });
+
+  describe('import method - Lytics audience skip', () => {
+    test
+      .stub(Import.Audiences.prototype, 'init', async () => {})
+      .stub(Import.Audiences.prototype, 'createAudience', (async (payload: any) => {
+        createAudienceCalls.push({ name: payload.name });
+        return { uid: `new-${payload.name.replace(/\s/g, '-')}`, name: payload.name };
+      }) as any)
+      .it('should skip Lytics audiences and not call createAudience for them', async () => {
+        const audiencesInstance = new Import.Audiences(config);
+        await audiencesInstance.import();
+
+        const lyticsNames = createAudienceCalls.filter(
+          (c) => c.name === 'Lytics Audience' || c.name === 'Lytics Lowercase',
+        );
+        expect(lyticsNames.length).to.equal(0);
+      });
+
+    test
+      .stub(Import.Audiences.prototype, 'init', async () => {})
+      .stub(Import.Audiences.prototype, 'createAudience', (async (payload: any) => {
+        createAudienceCalls.push({ name: payload.name });
+        return { uid: `new-${payload.name.replace(/\s/g, '-')}`, name: payload.name };
+      }) as any)
+      .it('should process audiences with undefined source', async () => {
+        const audiencesInstance = new Import.Audiences(config);
+        await audiencesInstance.import();
+
+        const noSourceCall = createAudienceCalls.find((c) => c.name === 'No Source Audience');
+        expect(noSourceCall).to.not.be.undefined;
+      });
+
+    test
+      .stub(Import.Audiences.prototype, 'init', async () => {})
+      .stub(Import.Audiences.prototype, 'createAudience', (async (payload: any) => {
+        createAudienceCalls.push({ name: payload.name });
+        return { uid: `new-${payload.name.replace(/\s/g, '-')}`, name: payload.name };
+      }) as any)
+      .it('should skip audience with source "lytics" (lowercase)', async () => {
+        const audiencesInstance = new Import.Audiences(config);
+        await audiencesInstance.import();
+
+        const lyticsLowercaseCall = createAudienceCalls.find((c) => c.name === 'Lytics Lowercase');
+        expect(lyticsLowercaseCall).to.be.undefined;
+      });
+
+    test
+      .stub(Import.Audiences.prototype, 'init', async () => {})
+      .stub(Import.Audiences.prototype, 'createAudience', (async (payload: any) => {
+        createAudienceCalls.push({ name: payload.name });
+        return { uid: `new-uid-${payload.name}`, name: payload.name };
+      }) as any)
+      .it('should call createAudience only for non-Lytics audiences', async () => {
+        const audiencesInstance = new Import.Audiences(config);
+        await audiencesInstance.import();
+
+        // 4 audiences in mock: 2 Lytics (skip), 2 non-Lytics (Contentstack Test, No Source)
+        expect(createAudienceCalls.length).to.equal(2);
+      });
+
+    test
+      .stub(Import.Audiences.prototype, 'init', async () => {})
+      .stub(Import.Audiences.prototype, 'createAudience', (async (payload: any) => {
+        createAudienceCalls.push({ name: payload.name });
+        return { uid: 'new-contentstack-uid', name: payload.name };
+      }) as any)
+      .it('should not add Lytics audiences to audiencesUidMapper', async () => {
+        const audiencesInstance = new Import.Audiences(config);
+        await audiencesInstance.import();
+
+        const mapper = (audiencesInstance as any).audiencesUidMapper;
+        expect(mapper['lytics-audience-001']).to.be.undefined;
+        expect(mapper['lytics-lowercase-001']).to.be.undefined;
+      });
+
+    test
+      .stub(Import.Audiences.prototype, 'init', async () => {})
+      .stub(Import.Audiences.prototype, 'createAudience', (async (payload: any) => {
+        createAudienceCalls.push({ name: payload.name });
+        return { uid: 'new-contentstack-uid', name: payload.name };
+      }) as any)
+      .it('should add Contentstack audiences to audiencesUidMapper', async () => {
+        const audiencesInstance = new Import.Audiences(config);
+        await audiencesInstance.import();
+
+        const mapper = (audiencesInstance as any).audiencesUidMapper;
+        expect(mapper['contentstack-audience-001']).to.equal('new-contentstack-uid');
+      });
+  });
+});

package/test/unit/mock/contents/mapper/personalize/attributes/uid-mapping.json

@@ -0,0 +1 @@
+{}

package/test/unit/mock/contents/mapper/personalize/audiences/uid-mapping.json

@@ -0,0 +1 @@
+{"contentstack-audience-001":"new-contentstack-uid","no-source-audience-001":"new-contentstack-uid"}

package/test/unit/mock/contents/personalize/audiences/audiences.json

@@ -0,0 +1,44 @@
+[
+  {
+    "uid": "contentstack-audience-001",
+    "name": "Contentstack Test Audience",
+    "description": "Audience with rules",
+    "definition": {
+      "__type": "RuleCombination",
+      "combinationType": "AND",
+      "rules": [
+        {
+          "__type": "Rule",
+          "attribute": { "__type": "PresetAttributeReference", "ref": "DEVICE_TYPE" },
+          "attributeMatchOptions": { "__type": "StringMatchOptions", "value": "MOBILE" },
+          "attributeMatchCondition": "STRING_EQUALS",
+          "invertCondition": false
+        }
+      ]
+    }
+  },
+  {
+    "uid": "lytics-audience-001",
+    "name": "Lytics Audience",
+    "description": "From Lytics",
+    "slug": "lytics_audience",
+    "source": "LYTICS"
+  },
+  {
+    "uid": "lytics-lowercase-001",
+    "name": "Lytics Lowercase",
+    "description": "source is lowercase",
+    "slug": "lytics_lowercase",
+    "source": "lytics"
+  },
+  {
+    "uid": "no-source-audience-001",
+    "name": "No Source Audience",
+    "description": "Audience without source field",
+    "definition": {
+      "__type": "RuleCombination",
+      "combinationType": "AND",
+      "rules": []
+    }
+  }
+]