@contentstack/cli-variants 0.0.1-alpha → 1.0.0

package/src/import/variant-entries.ts

@@ -29,7 +29,7 @@ export default class VariantEntries extends VariantAdapter<VariantHttpClient<Imp
   public entriesMapperPath: string;
   public variantEntryBasePath!: string;
   public variantIdList!: Record<string, unknown>;
-  public personalizationConfig: ImportConfig['modules']['personalization'];
+  public personalizeConfig: ImportConfig['modules']['personalize'];
 
   public taxonomies!: Record<string, unknown>;
   public assetUrlMapper!: Record<string, any>;
@@ -51,13 +51,22 @@ export default class VariantEntries extends VariantAdapter<VariantHttpClient<Imp
         branch: config.branchName,
         authtoken: config.auth_token,
         organization_uid: config.org_uid,
-        'X-Project-Uid': config.modules.personalization.project_id,
+        'X-Project-Uid': config.modules.personalize.project_id,
       },
-    }; 
+    };
     super(Object.assign(omit(config, ['helpers']), conf));
-    this.entriesMapperPath = resolve(sanitizePath(config.backupDir), sanitizePath(config.branchName || ''), 'mapper', 'entries');
-    this.personalizationConfig = this.config.modules.personalization;
-    this.entriesDirPath = resolve(sanitizePath(config.backupDir), sanitizePath(config.branchName || ''), sanitizePath(config.modules.entries.dirName));
+    this.entriesMapperPath = resolve(
+      sanitizePath(config.backupDir),
+      sanitizePath(config.branchName || ''),
+      'mapper',
+      'entries',
+    );
+    this.personalizeConfig = this.config.modules.personalize;
+    this.entriesDirPath = resolve(
+      sanitizePath(config.backupDir),
+      sanitizePath(config.branchName || ''),
+      sanitizePath(config.modules.entries.dirName),
+    );
     this.failedVariantPath = resolve(sanitizePath(this.entriesMapperPath), 'failed-entry-variants.json');
     this.failedVariantEntries = new Map();
   }
@@ -75,8 +84,8 @@ export default class VariantEntries extends VariantAdapter<VariantHttpClient<Imp
     const variantIdPath = resolve(
       sanitizePath(this.config.backupDir),
       'mapper',
-      sanitizePath(this.personalizationConfig.dirName),
-      sanitizePath(this.personalizationConfig.experiences.dirName),
+      sanitizePath(this.personalizeConfig.dirName),
+      sanitizePath(this.personalizeConfig.experiences.dirName),
       'variants-uid-mapping.json',
     );
 
@@ -107,7 +116,12 @@ export default class VariantEntries extends VariantAdapter<VariantHttpClient<Imp
       'terms',
       'success.json',
     );
-    const marketplaceAppMapperPath = resolve(sanitizePath(this.config.backupDir), 'mapper', 'marketplace_apps', 'uid-mapping.json');
+    const marketplaceAppMapperPath = resolve(
+      sanitizePath(this.config.backupDir),
+      'mapper',
+      'marketplace_apps',
+      'uid-mapping.json',
+    );
     const envPath = resolve(sanitizePath(this.config.backupDir), 'environments', 'environments.json');
     // NOTE Read and store list of variant IDs
     this.variantIdList = (fsUtil.readFile(variantIdPath, true) || {}) as Record<string, unknown>;
@@ -141,9 +155,22 @@ export default class VariantEntries extends VariantAdapter<VariantHttpClient<Imp
     const { content_type, locale, entry_uid } = entriesForVariant;
     const ctConfig = this.config.modules['content-types'];
     const contentType: ContentTypeStruct = JSON.parse(
-      readFileSync(resolve(sanitizePath(this.config.backupDir), sanitizePath(ctConfig.dirName), `${sanitizePath(content_type)}.json`), 'utf8'),
+      readFileSync(
+        resolve(
+          sanitizePath(this.config.backupDir),
+          sanitizePath(ctConfig.dirName),
+          `${sanitizePath(content_type)}.json`,
+        ),
+        'utf8',
+      ),
+    );
+    const variantEntryBasePath = join(
+      sanitizePath(this.entriesDirPath),
+      sanitizePath(content_type),
+      sanitizePath(locale),
+      sanitizePath(variantEntry.dirName),
+      sanitizePath(entry_uid),
     );
-    const variantEntryBasePath = join(sanitizePath(this.entriesDirPath), sanitizePath(content_type), sanitizePath(locale), sanitizePath(variantEntry.dirName), sanitizePath(entry_uid));
     const fs = new FsUtility({ basePath: variantEntryBasePath });
 
     for (const _ in fs.indexFileContent) {
@@ -202,7 +229,7 @@ export default class VariantEntries extends VariantAdapter<VariantHttpClient<Imp
           log(this.config, error, 'error');
         };
         // NOTE Find new variant Id by old Id
-        const variant_id = this.variantIdList[variantEntry.variant_id] as string;
+        const variantId = this.variantIdList[variantEntry._variant._uid] as string;
         // NOTE Replace all the relation data UID's
         variantEntry = this.handleVariantEntryRelationalData(contentType, variantEntry);
         const changeSet = this.serializeChangeSet(variantEntry);
@@ -211,19 +238,19 @@ export default class VariantEntries extends VariantAdapter<VariantHttpClient<Imp
           ...changeSet,
         };
 
-        if (variant_id) {
+        if (variantId) {
           const promise = this.variantInstance.createVariantEntry(
             createVariantReq,
             {
               locale,
               entry_uid: entryUid,
-              variant_id,
+              variant_id: variantId,
               content_type_uid: content_type,
             },
             {
               reject: onReject.bind(this),
               resolve: onSuccess.bind(this),
-              variantUid: variantEntry.uid,
+              variantUid: variantId,
               log: log,
             },
           );
@@ -380,23 +407,19 @@ export default class VariantEntries extends VariantAdapter<VariantHttpClient<Imp
   async publishVariantEntries(batch: VariantEntryStruct[], entryUid: string, content_type: string) {
     const allPromise = [];
     for (let [, variantEntry] of entries(batch)) {
-      const variantUid = variantEntry.uid;
-      const oldVariantUid = variantEntry.variant_id || '';
+      const variantEntryUID = variantEntry.uid;
+      const oldVariantUid = variantEntry._variant._uid || '';
       const newVariantUid = this.variantIdList[oldVariantUid] as string;
 
       if (!newVariantUid) {
-        log(
-          this.config,
-          `${this.messages.VARIANT_ID_NOT_FOUND}. Skipping entry variant publish for ${variantUid}`,
-          'info',
-        );
+        log(this.config, `${this.messages.VARIANT_ID_NOT_FOUND}. Skipping entry variant publish`, 'info');
         continue;
       }
 
-      if (this.failedVariantEntries.has(variantUid)) {
+      if (this.failedVariantEntries.has(variantEntryUID)) {
         log(
           this.config,
-          `${this.messages.VARIANT_UID_NOT_FOUND}. Skipping entry variant publish for ${variantUid}`,
+          `${this.messages.VARIANT_UID_NOT_FOUND}. Skipping entry variant publish for ${variantEntryUID}`,
           'info',
         );
         continue;
@@ -440,7 +463,7 @@ export default class VariantEntries extends VariantAdapter<VariantHttpClient<Imp
           reject: onReject.bind(this),
           resolve: onSuccess.bind(this),
           log: log,
-          variantUid,
+          variantUid: newVariantUid,
         },
       );
 

package/src/messages/index.ts

@@ -23,7 +23,7 @@ const expImportMsg = {
   UPDATING_CT_IN_EXP: 'Updating content types in experiences...',
   UPDATED_CT_IN_EXP: 'Successfully updated content types in experiences!',
   VALIDATE_VARIANT_AND_VARIANT_GRP: 'Validating variant group and variants creation...',
-  PERSONALIZATION_JOB_FAILURE: 'Something went wrong with personalization background job! Failed to fetch some variant & variant groups',
+  PERSONALIZE_JOB_FAILURE: 'Something went wrong with personalize background job! Failed to fetch some variant & variant groups',
 };
 
 const messages: typeof errors & typeof commonMsg & typeof migrationMsg & typeof variantEntry & typeof expImportMsg = {
@@ -50,7 +50,8 @@ function $t(msg: string, args: Record<string, string>): string {
 
     for (const key of Object.keys(args)) {
       const escapedKey = key.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
-      msg = msg.replace(new RegExp(`{${escapedKey}}`, 'g'), args[key] || escapedKey);
+      const placeholder = `{${escapedKey}}`;
+      msg = msg.split(placeholder).join(args[key]);
     }
 
     return msg;

package/src/types/export-config.ts

@@ -20,7 +20,7 @@ export type Modules =
   | 'labels'
   | 'marketplace-apps'
   | 'taxonomies'
-  | 'personalization';
+  | 'personalize';
 
 export type branch = {
   uid: string;
@@ -155,7 +155,7 @@ export interface DefaultConfig {
         include_publish_details: boolean;
       } & AnyProperty;
     } & AnyProperty;
-    personalization: {
+    personalize: {
       dirName: string;
       baseURL: Record<string, string>;
     } & AnyProperty;
@@ -269,7 +269,7 @@ export interface ExportConfig extends DefaultConfig {
   region: any;
 }
 
-export interface PersonalizationConfig {
+export interface PersonalizeConfig {
   dirName: string;
   baseURL: Record<string, string>;
 }

package/src/types/import-config.ts

@@ -12,7 +12,7 @@ export interface ImportDefaultConfig extends AnyProperty {
       dirName: string;
       fileName: string;
     };
-    personalization: {
+    personalize: {
       baseURL: Record<string, string>;
       dirName: string;
       importData: boolean;

package/src/types/personalization-api-adapter.ts

@@ -130,6 +130,18 @@ export type ExperienceStruct = {
   content_types?: string[];
 } & AnyProperty;
 
+export interface CreateExperienceVersionInput {
+  name: string;
+  __type: string;
+  description: string;
+  targeting?: ExpTargeting;
+  variations: ExpVariations[];
+  variationSplit?: string;
+  metrics?: ExpMetric[];
+  status: string;
+  metadata?: object;
+  variants: Array<ExpVariations>;
+}
 export interface CreateExperienceInput {
   name: string;
   __type: string;
@@ -140,6 +152,7 @@ export interface CreateExperienceInput {
   metrics?: ExpMetric[];
   status: string;
   metadata?: object;
+  variants?: Array<ExpVariations>;
 }
 
 export interface UpdateExperienceInput {

package/src/types/variant-entry.ts

@@ -3,11 +3,11 @@ import { AnyProperty } from './utils';
 export type VariantEntryStruct = {
   uid: string;
   title: string;
-  variant_id: string;
   locale: string;
   _version: number;
   _variant: {
-    uid: string;
+    _uid: string;
+    _instance_uid: string;
     _change_set: string[];
     _base_entry_version: number;
   };

package/src/utils/audiences-helper.ts

@@ -1,4 +1,4 @@
-import { CreateExperienceInput } from '../types';
+import { CreateExperienceInput, CreateExperienceVersionInput } from '../types';
 
 /**
  * function for substituting an old audience UID with a new one or deleting the audience information if it does not exist
@@ -37,10 +37,20 @@ export const lookUpAudiences = (
         }
       }
     }
+  } else if (experience.variants) {
+    for (let index = experience.variants.length - 1; index >= 0; index--) {
+      const expVariations = experience.variants[index];
+      if (expVariations['__type'] === 'SegmentedVariant' && expVariations?.audiences?.length) {
+        updateAudiences(expVariations.audiences, audiencesUid);
+        if (!expVariations.audiences.length) {
+          experience.variants.splice(index, 1);
+        }
+      }
+    }
   }
 
-  // Update targeting audiences
   if (experience?.targeting?.hasOwnProperty('audience') && experience?.targeting?.audience?.audiences?.length) {
+    // Update targeting audiences
     updateAudiences(experience.targeting.audience.audiences, audiencesUid);
     if (!experience.targeting.audience.audiences.length) {
       experience.targeting = {};

package/src/utils/error-helper.ts

@@ -22,5 +22,5 @@ function formatError(error: any): string {
   if (typeof error === 'object') {
     return Object.values(error).join(' ');
   }
-  return String(error);
+  return error;
 }

package/src/utils/personalization-api-adapter.ts

@@ -22,6 +22,7 @@ import {
   APIResponse,
   VariantGroupStruct,
   VariantGroup,
+  CreateExperienceVersionInput,
 } from '../types';
 import { formatErrors } from './error-helper';
 
@@ -77,6 +78,35 @@ export class PersonalizationAdapter<T> extends AdapterHelper<T, HttpClient> impl
     return this.handleVariantAPIRes(data) as ExperienceStruct;
   }
 
+  async getExperienceVersions(experienceUid: string): Promise<ExperienceStruct | void> {
+    const getExperiencesVersionsEndPoint = `/experiences/${experienceUid}/versions`;
+    const data = await this.apiClient.get(getExperiencesVersionsEndPoint);
+    return this.handleVariantAPIRes(data) as ExperienceStruct;
+  }
+
+  async createExperienceVersion(
+    experienceUid: string,
+    input: CreateExperienceVersionInput,
+  ): Promise<ExperienceStruct | void> {
+    const createExperiencesVersionsEndPoint = `/experiences/${experienceUid}/versions`;
+    const data = await this.apiClient.post(createExperiencesVersionsEndPoint, input);
+    return this.handleVariantAPIRes(data) as ExperienceStruct;
+  }
+
+  async updateExperienceVersion(
+    experienceUid: string,
+    versionId: string,
+    input: CreateExperienceVersionInput,
+  ): Promise<ExperienceStruct | void> {
+    // loop through input and remove shortId from variant
+    if (input?.variants) {
+      input.variants = input.variants.map(({ shortUid, ...rest }) => rest);
+    }
+    const updateExperiencesVersionsEndPoint = `/experiences/${experienceUid}/versions/${versionId}`;
+    const data = await this.apiClient.put(updateExperiencesVersionsEndPoint, input);
+    return this.handleVariantAPIRes(data) as ExperienceStruct;
+  }
+
   async getVariantGroup(input: GetVariantGroupInput): Promise<VariantGroupStruct | void> {
     if (this.cmaAPIClient) {
       const getVariantGroupEndPoint = `/variant_groups`;
@@ -178,10 +208,10 @@ export class PersonalizationAdapter<T> extends AdapterHelper<T, HttpClient> impl
     if (status >= 200 && status < 300) {
       return data;
     }
-
+    
     const errorMsg = data?.errors
       ? formatErrors(data.errors)
-      : data?.error_message || data?.message || 'Something went wrong while processing variant entries request!';
+      : data?.error || data?.error_message || data?.message || 'Something went wrong while processing variant entries request!';
 
     throw errorMsg;
   }

package/src/utils/variant-api-adapter.ts

@@ -184,6 +184,7 @@ export class VariantHttpClient<C> extends AdapterHelper<C, HttpClient> implement
       });
 
     try {
+      this.apiClient.headers({ api_version: undefined });
       const res = await this.apiClient.put<VariantEntryStruct>(endpoint, { entry: input });
       const data = this.handleVariantAPIRes(res);
 
@@ -214,8 +215,7 @@ export class VariantHttpClient<C> extends AdapterHelper<C, HttpClient> implement
     const { entry_uid, content_type_uid } = options;
     let endpoint = `content_types/${content_type_uid}/entries/${entry_uid}/publish`;
 
-    const onSuccess = (response: any) =>
-      resolve({ response, apiData: { entryUid: entry_uid, variantUid }, log });
+    const onSuccess = (response: any) => resolve({ response, apiData: { entryUid: entry_uid, variantUid }, log });
     const onReject = (error: any) =>
       reject({
         error,