@contentstack/cli-variants 2.0.0-beta.11 → 2.0.0-beta.12

package/lib/export/attributes.js

@@ -27,7 +27,7 @@ class ExportAttributes extends utils_1.PersonalizationAdapter {
         this.exportConfig = exportConfig;
         this.personalizeConfig = exportConfig.modules.personalize;
         this.attributesConfig = exportConfig.modules.attributes;
-        this.attributesFolderPath = (0, node_path_1.resolve)((0, cli_utilities_1.sanitizePath)(exportConfig.exportDir), (0, cli_utilities_1.sanitizePath)(exportConfig.branchName || ''), (0, cli_utilities_1.sanitizePath)(this.personalizeConfig.dirName), (0, cli_utilities_1.sanitizePath)(this.attributesConfig.dirName));
+        this.attributesFolderPath = (0, node_path_1.resolve)((0, cli_utilities_1.sanitizePath)(exportConfig.exportDir), (0, cli_utilities_1.sanitizePath)(this.personalizeConfig.dirName), (0, cli_utilities_1.sanitizePath)(this.attributesConfig.dirName));
         this.attributes = [];
         this.exportConfig.context.module = constants_1.MODULE_CONTEXTS.ATTRIBUTES;
     }

package/lib/export/audiences.js

@@ -27,7 +27,7 @@ class ExportAudiences extends utils_1.PersonalizationAdapter {
         this.exportConfig = exportConfig;
         this.personalizeConfig = exportConfig.modules.personalize;
         this.audiencesConfig = exportConfig.modules.audiences;
-        this.audiencesFolderPath = (0, node_path_1.resolve)((0, cli_utilities_1.sanitizePath)(exportConfig.exportDir), (0, cli_utilities_1.sanitizePath)(exportConfig.branchName || ''), (0, cli_utilities_1.sanitizePath)(this.personalizeConfig.dirName), (0, cli_utilities_1.sanitizePath)(this.audiencesConfig.dirName));
+        this.audiencesFolderPath = (0, node_path_1.resolve)((0, cli_utilities_1.sanitizePath)(exportConfig.exportDir), (0, cli_utilities_1.sanitizePath)(this.personalizeConfig.dirName), (0, cli_utilities_1.sanitizePath)(this.audiencesConfig.dirName));
         this.audiences = [];
         this.exportConfig.context.module = constants_1.MODULE_CONTEXTS.AUDIENCES;
     }

package/lib/export/events.js

@@ -27,7 +27,7 @@ class ExportEvents extends utils_1.PersonalizationAdapter {
         this.exportConfig = exportConfig;
         this.personalizeConfig = exportConfig.modules.personalize;
         this.eventsConfig = exportConfig.modules.events;
-        this.eventsFolderPath = (0, node_path_1.resolve)((0, cli_utilities_1.sanitizePath)(exportConfig.exportDir), (0, cli_utilities_1.sanitizePath)(exportConfig.branchName || ''), (0, cli_utilities_1.sanitizePath)(this.personalizeConfig.dirName), (0, cli_utilities_1.sanitizePath)(this.eventsConfig.dirName));
+        this.eventsFolderPath = (0, node_path_1.resolve)((0, cli_utilities_1.sanitizePath)(exportConfig.exportDir), (0, cli_utilities_1.sanitizePath)(this.personalizeConfig.dirName), (0, cli_utilities_1.sanitizePath)(this.eventsConfig.dirName));
         this.events = [];
         this.exportConfig.context.module = constants_1.MODULE_CONTEXTS.EVENTS;
     }

package/lib/export/experiences.js

@@ -59,7 +59,7 @@ class ExportExperiences extends utils_1.PersonalizationAdapter {
         });
         this.exportConfig = exportConfig;
         this.personalizeConfig = exportConfig.modules.personalize;
-        this.experiencesFolderPath = path.resolve((0, cli_utilities_1.sanitizePath)(exportConfig.exportDir), (0, cli_utilities_1.sanitizePath)(exportConfig.branchName || ''), (0, cli_utilities_1.sanitizePath)(this.personalizeConfig.dirName), 'experiences');
+        this.experiencesFolderPath = path.resolve((0, cli_utilities_1.sanitizePath)(exportConfig.exportDir), (0, cli_utilities_1.sanitizePath)(this.personalizeConfig.dirName), 'experiences');
         this.exportConfig.context.module = constants_1.MODULE_CONTEXTS.EXPERIENCES;
     }
     start() {

package/lib/export/projects.js

@@ -22,7 +22,7 @@ class ExportProjects extends utils_1.PersonalizationAdapter {
         });
         this.exportConfig = exportConfig;
         this.personalizeConfig = exportConfig.modules.personalize;
-        this.projectsFolderPath = (0, node_path_1.resolve)((0, cli_utilities_1.sanitizePath)(exportConfig.exportDir), (0, cli_utilities_1.sanitizePath)(exportConfig.branchName || ''), (0, cli_utilities_1.sanitizePath)(this.personalizeConfig.dirName), 'projects');
+        this.projectsFolderPath = (0, node_path_1.resolve)((0, cli_utilities_1.sanitizePath)(exportConfig.exportDir), (0, cli_utilities_1.sanitizePath)(this.personalizeConfig.dirName), 'projects');
         this.projectsData = [];
         this.exportConfig.context.module = constants_1.MODULE_CONTEXTS.PROJECTS;
     }

package/lib/export/variant-entries.js

@@ -68,7 +68,7 @@ class VariantEntries extends variant_api_adapter_1.default {
         this.processInitialized = false;
         this.totalVariantCount = 0;
         this.processedVariantCount = 0;
-        this.entriesDirPath = (0, path_1.resolve)((0, cli_utilities_1.sanitizePath)(config.exportDir), (0, cli_utilities_1.sanitizePath)(config.branchName || ''), (0, cli_utilities_1.sanitizePath)(config.modules.entries.dirName));
+        this.entriesDirPath = (0, path_1.resolve)((0, cli_utilities_1.sanitizePath)(config.exportDir), (0, cli_utilities_1.sanitizePath)(config.modules.entries.dirName));
         if (this.config && this.config.context) {
             this.config.context.module = 'variant-entries';
         }

package/lib/import/audiences.js

@@ -39,7 +39,7 @@ class Audiences extends utils_1.PersonalizationAdapter {
      */
     import() {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
+            var _a, _b, _c;
             try {
                 cli_utilities_1.log.debug('Starting audiences import...', this.config.context);
                 const [canImport, audiencesCount] = yield this.analyzeAudiences();
@@ -73,9 +73,14 @@ class Audiences extends utils_1.PersonalizationAdapter {
                         progress.updateStatus(constants_1.IMPORT_PROCESS_STATUS[constants_1.PROCESS_NAMES.AUDIENCES].CREATING);
                     }
                     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.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);
@@ -87,7 +92,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 : '';
                         this.updateProgress(true, `audience: ${name}`, undefined, constants_1.PROCESS_NAMES.AUDIENCES);
                         cli_utilities_1.log.debug(`Created audience: ${uid} -> ${audienceRes === null || audienceRes === void 0 ? void 0 : audienceRes.uid}`, this.config.context);
                     }

package/lib/types/export-config.d.ts

@@ -226,7 +226,6 @@ export interface ExportConfig extends DefaultConfig {
     contentTypes?: string[];
     branches?: branch[];
     branchEnabled?: boolean;
-    branchDir?: string;
     singleModuleExport?: boolean;
     moduleName?: Modules;
     master_locale: masterLocale;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-variants",
-  "version": "2.0.0-beta.11",
+  "version": "2.0.0-beta.12",
   "description": "Variants plugin",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -28,10 +28,10 @@
     "typescript": "^5.8.3"
   },
   "dependencies": {
-    "@contentstack/cli-utilities": "~2.0.0-beta.5",
+    "@contentstack/cli-utilities": "~2.0.0-beta.7",
     "@oclif/core": "^4.3.0",
     "@oclif/plugin-help": "^6.2.28",
-    "lodash": "^4.17.23",
+    "lodash": "^4.18.1",
     "mkdirp": "^1.0.4",
     "winston": "^3.17.0"
   }

package/src/export/attributes.ts

@@ -23,7 +23,6 @@ export default class ExportAttributes extends PersonalizationAdapter<ExportConfi
     this.attributesConfig = exportConfig.modules.attributes;
     this.attributesFolderPath = pResolve(
       sanitizePath(exportConfig.exportDir),
-      sanitizePath(exportConfig.branchName || ''),
       sanitizePath(this.personalizeConfig.dirName),
       sanitizePath(this.attributesConfig.dirName),
     );

package/src/export/audiences.ts

@@ -23,7 +23,6 @@ export default class ExportAudiences extends PersonalizationAdapter<ExportConfig
     this.audiencesConfig = exportConfig.modules.audiences;
     this.audiencesFolderPath = pResolve(
       sanitizePath(exportConfig.exportDir),
-      sanitizePath(exportConfig.branchName || ''),
       sanitizePath(this.personalizeConfig.dirName),
       sanitizePath(this.audiencesConfig.dirName),
     );

package/src/export/events.ts

@@ -23,7 +23,6 @@ export default class ExportEvents extends PersonalizationAdapter<ExportConfig> {
     this.eventsConfig = exportConfig.modules.events;
     this.eventsFolderPath = pResolve(
       sanitizePath(exportConfig.exportDir),
-      sanitizePath(exportConfig.branchName || ''),
       sanitizePath(this.personalizeConfig.dirName),
       sanitizePath(this.eventsConfig.dirName),
     );

package/src/export/experiences.ts

@@ -23,7 +23,6 @@ export default class ExportExperiences extends PersonalizationAdapter<ExportConf
     this.personalizeConfig = exportConfig.modules.personalize;
     this.experiencesFolderPath = path.resolve(
       sanitizePath(exportConfig.exportDir),
-      sanitizePath(exportConfig.branchName || ''),
       sanitizePath(this.personalizeConfig.dirName),
       'experiences',
     );

package/src/export/projects.ts

@@ -20,7 +20,6 @@ export default class ExportProjects extends PersonalizationAdapter<ExportConfig>
     this.personalizeConfig = exportConfig.modules.personalize;
     this.projectsFolderPath = pResolve(
       sanitizePath(exportConfig.exportDir),
-      sanitizePath(exportConfig.branchName || ''),
       sanitizePath(this.personalizeConfig.dirName),
       'projects',
     );

package/src/export/variant-entries.ts

@@ -32,7 +32,6 @@ export default class VariantEntries extends VariantAdapter<VariantHttpClient<Exp
     super(Object.assign(config, conf));
     this.entriesDirPath = resolve(
       sanitizePath(config.exportDir),
-      sanitizePath(config.branchName || ''),
       sanitizePath(config.modules.entries.dirName),
     );
     if (this.config && this.config.context) {

package/src/import/audiences.ts

@@ -89,6 +89,12 @@ export default class Audiences extends PersonalizationAdapter<ImportConfig> {
         }
         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) {

package/src/types/export-config.ts

@@ -252,7 +252,6 @@ export interface ExportConfig extends DefaultConfig {
   contentTypes?: string[];
   branches?: branch[];
   branchEnabled?: boolean;
-  branchDir?: string;
   singleModuleExport?: boolean;
   moduleName?: Modules;
   master_locale: masterLocale;

package/test/unit/export/variant-entries.test.ts

@@ -24,6 +24,19 @@ describe('Variant Entries Export', () => {
     config = exportConf as unknown as ExportConfig;
   });
 
+  describe('path construction', () => {
+    test.it('should use exportDir as base path (no branch segment in path)', () => {
+      const configWithExportDir = {
+        ...config,
+        exportDir: '/base/export',
+        branchName: 'dev',
+      } as ExportConfig;
+      const instance = new Export.VariantEntries(configWithExportDir);
+      expect(instance.entriesDirPath).to.not.include('dev');
+      expect(instance.entriesDirPath).to.include('entries');
+    });
+  });
+
   describe('exportVariantEntry method', () => {
     test
       .stub(VariantHttpClient.prototype, 'variantEntries', async () => {})

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": []
+    }
+  }
+]