@contentstack/cli-variants 1.0.0 → 1.1.1

package/src/import/variant-entries.ts

@@ -49,7 +49,6 @@ export default class VariantEntries extends VariantAdapter<VariantHttpClient<Imp
       headers: {
         api_key: config.apiKey,
         branch: config.branchName,
-        authtoken: config.auth_token,
         organization_uid: config.org_uid,
         'X-Project-Uid': config.modules.personalize.project_id,
       },
@@ -57,14 +56,12 @@ export default class VariantEntries extends VariantAdapter<VariantHttpClient<Imp
     super(Object.assign(omit(config, ['helpers']), conf));
     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');
@@ -90,7 +87,7 @@ export default class VariantEntries extends VariantAdapter<VariantHttpClient<Imp
     );
 
     if (!existsSync(filePath)) {
-      log(this.config, this.messages.IMPORT_ENTRY_NOT_FOUND, 'info');
+      log(this.config, this.messages.VARIANT_ENTRY_FILE_NOT_FOUND, 'info');
       return;
     }
 
@@ -138,7 +135,8 @@ export default class VariantEntries extends VariantAdapter<VariantHttpClient<Imp
     this.assetUidMapper = (fsUtil.readFile(assetUidMapperPath, true) || {}) as Record<string, any>;
     this.assetUrlMapper = (fsUtil.readFile(assetUrlMapperPath, true) || {}) as Record<string, any>;
     this.environments = (fsUtil.readFile(envPath, true) || {}) as Record<string, any>;
-
+    // set the token
+    await this.variantInstance.init();
     for (const entriesForVariant of entriesForVariants) {
       await this.importVariantEntries(entriesForVariant);
     }
@@ -368,7 +366,7 @@ export default class VariantEntries extends VariantAdapter<VariantHttpClient<Imp
    * @param variantEntry - The entry variant to update.
    */
   updateFileFields(variantEntry: VariantEntryStruct) {
-    const setValue = (currentObj: VariantEntryStruct, keys: Array<string>) => {
+    const setValue = (currentObj: VariantEntryStruct, keys: string[]) => {
       if (!currentObj || keys.length === 0) return;
 
       const [firstKey, ...restKeys] = keys;
@@ -380,7 +378,14 @@ export default class VariantEntries extends VariantAdapter<VariantHttpClient<Imp
       } else if (currentObj && typeof currentObj === 'object') {
         if (firstKey in currentObj) {
           if (keys.length === 1) {
-            currentObj[firstKey] = { uid: currentObj[firstKey], filename: 'dummy.jpeg' };
+            // Check if the current property is already an object with uid and filename
+            const existingValue = currentObj[firstKey];
+
+            if (existingValue && typeof existingValue === 'object' && existingValue.uid) {
+              currentObj[firstKey] = { uid: existingValue.uid, filename: 'dummy.jpeg' };
+            } else {
+              currentObj[firstKey] = { uid: currentObj[firstKey], filename: 'dummy.jpeg' };
+            }
           } else {
             setValue(currentObj[firstKey], restKeys);
           }
@@ -388,13 +393,12 @@ export default class VariantEntries extends VariantAdapter<VariantHttpClient<Imp
       }
     };
 
-    const pathsToUpdate = variantEntry?._metadata?.references
-      .filter((ref: any) => ref._content_type_uid === 'sys_assets')
-      .map((ref: any) => ref.path);
+    const pathsToUpdate =
+      variantEntry?._metadata?.references
+        ?.filter((ref: any) => ref._content_type_uid === 'sys_assets')
+        .map((ref: any) => ref.path) || [];
 
-    if (pathsToUpdate) {
-      pathsToUpdate.forEach((path: string) => setValue(variantEntry, path.split('.')));
-    }
+    pathsToUpdate.forEach((path: string) => setValue(variantEntry, path.split('.')));
   }
 
   /**
@@ -406,6 +410,11 @@ export default class VariantEntries extends VariantAdapter<VariantHttpClient<Imp
    */
   async publishVariantEntries(batch: VariantEntryStruct[], entryUid: string, content_type: string) {
     const allPromise = [];
+    log(
+      this.config,
+      `Publishing variant entries for entry uid '${entryUid}' of Content Type '${content_type}'`,
+      'info',
+    );
     for (let [, variantEntry] of entries(batch)) {
       const variantEntryUID = variantEntry.uid;
       const oldVariantUid = variantEntry._variant._uid || '';
@@ -446,11 +455,9 @@ export default class VariantEntries extends VariantAdapter<VariantHttpClient<Imp
         entry: {
           environments,
           locales,
-          publish_with_base_entry: false,
           variants: [{ uid: newVariantUid, version: 1 }],
         },
         locale: variantEntry.locale,
-        version: 1,
       };
 
       const promise = this.variantInstance.publishVariantEntry(
@@ -470,6 +477,7 @@ export default class VariantEntries extends VariantAdapter<VariantHttpClient<Imp
       allPromise.push(promise);
     }
     await Promise.allSettled(allPromise);
+    log(this.config, `Published variant entries for entry uid '${entryUid}' of Content Type '${content_type}'`, 'info');
   }
 
   /**

package/src/messages/index.ts

@@ -13,6 +13,7 @@ const migrationMsg = {
 };
 
 const variantEntry = {
+  VARIANT_ENTRY_FILE_NOT_FOUND: 'Variant entry file not found!',
   IMPORT_ENTRY_NOT_FOUND: 'Entries data not found to import variant entries',
   EMPTY_VARIANT_UID_DATA: 'Empty variants entry mapper found!',
   VARIANT_ID_NOT_FOUND: 'Variant ID not found',
@@ -23,7 +24,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...',
-  PERSONALIZE_JOB_FAILURE: 'Something went wrong with personalize background job! Failed to fetch some variant & variant groups',
+  PERSONALIZE_JOB_FAILURE: 'Something went wrong! Failed to fetch some variant and variant groups.',
 };
 
 const messages: typeof errors & typeof commonMsg & typeof migrationMsg & typeof variantEntry & typeof expImportMsg = {

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

@@ -206,5 +206,5 @@ export interface Personalization<T> extends AdapterHelperInterface<T, HttpClient
 
   updateCTsInExperience(experience: UpdateExperienceInput, experienceUid: string): Promise<CMSExperienceStruct | void>;
 
-  handleVariantAPIRes(res: any): VariantAPIRes;
+  handleVariantAPIRes(res: any): Promise<VariantAPIRes>;
 }

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

@@ -42,6 +42,8 @@ export type VariantOptions = VariantsOption & {
 };
 
 export interface VariantInterface<T, ApiClient> extends AdapterHelperInterface<T, ApiClient> {
+  init(): Promise<void>;
+
   variantEntry(options: VariantOptions): Promise<{ entry: Record<string, any> }>;
 
   variantEntries(options: VariantsOption): Promise<{ entries?: Record<string, any>[] | unknown[] } | void>;
@@ -52,5 +54,5 @@ export interface VariantInterface<T, ApiClient> extends AdapterHelperInterface<T
     apiParams: Record<string, any>,
   ): Promise<VariantEntryStruct | string | void>;
 
-  handleVariantAPIRes(res: APIResponse): VariantEntryStruct | { entries: VariantEntryStruct[]; count: number } | string;
+  handleVariantAPIRes(res: APIResponse): Promise<VariantEntryStruct | { entries: VariantEntryStruct[]; count: number } | string>;
 }

package/src/types/variant-entry.ts

@@ -50,7 +50,6 @@ export type PublishVariantEntryDto = {
   entry: {
     environments: string[];
     locales: string[];
-    publish_with_base_entry: boolean;
     variants: {
       uid: string;
       version?: number;

package/src/utils/attributes-helper.ts

@@ -12,8 +12,8 @@ export const lookUpAttributes = (attributeRules: Record<string, any>[], attribut
       // Check if attribute reference exists in attributesUid
       const attributeRef = rule.attribute?.ref;
       const attributeType = rule.attribute['__type'];
-      // check if type is UserAttributeReference
-      if (attributeType === 'UserAttributeReference') {
+      // check if type is CustomAttributeReference
+      if (attributeType === 'CustomAttributeReference') {
         if (attributeRef && attributesUid.hasOwnProperty(attributeRef) && attributesUid[attributeRef]) {
           rule.attribute.ref = attributesUid[attributeRef];
         } else {

package/src/utils/error-helper.ts

@@ -9,18 +9,18 @@ export function formatErrors(errors: any): string {
   for (const errorKey in errors) {
     const errorValue = errors[errorKey];
     if (Array.isArray(errorValue)) {
-      errorMessages.push(...errorValue.map((error: any) => formatError(error)));
+      errorMessages.push(...errorValue.map((error: any) => formatError(errorKey, error)));
     } else {
-      errorMessages.push(formatError(errorValue));
+      errorMessages.push(formatError(errorKey, errorValue));
     }
   }
 
   return errorMessages.join(' ');
 }
 
-function formatError(error: any): string {
-  if (typeof error === 'object') {
-    return Object.values(error).join(' ');
+function formatError(errorKey: string, error: any): string {
+  if (typeof error === 'object' && error !== null) {
+    return `${errorKey}: ${Object.values(error).join(' ')}`;
   }
-  return error;
+  return `${errorKey}: ${error}`;
 }

package/src/utils/logger.ts

@@ -51,9 +51,9 @@ let errorLogger: winston.Logger;
 let successTransport;
 let errorTransport;
 
-function init(_logPath: string) {
+function init(_logPath: string, module: string) {
   if (!logger || !errorLogger) {
-    const logsDir = path.resolve(sanitizePath(_logPath), 'logs', 'export');
+    const logsDir = path.resolve(sanitizePath(_logPath), 'logs', sanitizePath(module));
     // Create dir if doesn't already exist
     mkdirp.sync(logsDir);
 
@@ -131,11 +131,12 @@ function init(_logPath: string) {
 export const log = (config: ExportConfig | ImportConfig, message: any, type: 'info' | 'error' | 'success') => {
   const logsPath = config.data;
   // ignoring the type argument, as we are not using it to create a logfile anymore
+  const module = (config as ImportConfig)['backupDir'] ? 'import' : 'export';
   if (type !== 'error') {
     // removed type argument from init method
-    init(logsPath).log(message);
+    init(logsPath, module).log(message);
   } else {
-    init(logsPath).error(message);
+    init(logsPath, module).error(message);
   }
 };
 

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

@@ -1,5 +1,5 @@
 import { AdapterHelper } from './adapter-helper';
-import { HttpClient } from '@contentstack/cli-utilities';
+import { HttpClient, authenticationHandler } from '@contentstack/cli-utilities';
 
 import {
   ProjectStruct,
@@ -31,10 +31,27 @@ export class PersonalizationAdapter<T> extends AdapterHelper<T, HttpClient> impl
     super(options);
   }
 
+  async init(): Promise<void> {
+    await authenticationHandler.getAuthDetails();
+    const token = authenticationHandler.accessToken;
+    if (authenticationHandler.isOauthEnabled) {
+      this.apiClient.headers({ authorization: token });
+      if(this.adapterConfig.cmaConfig) {
+        this.cmaAPIClient?.headers({ authorization: token });
+      }
+    } else {
+      this.apiClient.headers({ authtoken: token });
+      if(this.adapterConfig.cmaConfig) {
+        this.cmaAPIClient?.headers({ authtoken: token });
+      }
+    }
+  }
+
   async projects(options: GetProjectsParams): Promise<ProjectStruct[]> {
+    await this.init();
     const getProjectEndPoint = `/projects?connectedStackApiKey=${options.connectedStackApiKey}`;
     const data = await this.apiClient.get(getProjectEndPoint);
-    return this.handleVariantAPIRes(data) as ProjectStruct[];
+    return (await this.handleVariantAPIRes(data)) as ProjectStruct[];
   }
 
   /**
@@ -49,7 +66,7 @@ export class PersonalizationAdapter<T> extends AdapterHelper<T, HttpClient> impl
    */
   async createProject(project: CreateProjectInput): Promise<ProjectStruct> {
     const data = await this.apiClient.post<ProjectStruct>('/projects', project);
-    return this.handleVariantAPIRes(data) as ProjectStruct;
+    return (await this.handleVariantAPIRes(data)) as ProjectStruct;
   }
 
   /**
@@ -63,25 +80,25 @@ export class PersonalizationAdapter<T> extends AdapterHelper<T, HttpClient> impl
    */
   async createAttribute(attribute: CreateAttributeInput): Promise<AttributeStruct> {
     const data = await this.apiClient.post<AttributeStruct>('/attributes', attribute);
-    return this.handleVariantAPIRes(data) as AttributeStruct;
+    return (await this.handleVariantAPIRes(data)) as AttributeStruct;
   }
 
   async getExperiences(): Promise<ExperienceStruct[]> {
     const getExperiencesEndPoint = `/experiences`;
     const data = await this.apiClient.get(getExperiencesEndPoint);
-    return this.handleVariantAPIRes(data) as ExperienceStruct[];
+    return (await this.handleVariantAPIRes(data)) as ExperienceStruct[];
   }
 
   async getExperience(experienceUid: string): Promise<ExperienceStruct | void> {
     const getExperiencesEndPoint = `/experiences/${experienceUid}`;
     const data = await this.apiClient.get(getExperiencesEndPoint);
-    return this.handleVariantAPIRes(data) as ExperienceStruct;
+    return (await 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;
+    return (await this.handleVariantAPIRes(data)) as ExperienceStruct;
   }
 
   async createExperienceVersion(
@@ -90,7 +107,7 @@ export class PersonalizationAdapter<T> extends AdapterHelper<T, HttpClient> impl
   ): Promise<ExperienceStruct | void> {
     const createExperiencesVersionsEndPoint = `/experiences/${experienceUid}/versions`;
     const data = await this.apiClient.post(createExperiencesVersionsEndPoint, input);
-    return this.handleVariantAPIRes(data) as ExperienceStruct;
+    return (await this.handleVariantAPIRes(data)) as ExperienceStruct;
   }
 
   async updateExperienceVersion(
@@ -104,7 +121,7 @@ export class PersonalizationAdapter<T> extends AdapterHelper<T, HttpClient> impl
     }
     const updateExperiencesVersionsEndPoint = `/experiences/${experienceUid}/versions/${versionId}`;
     const data = await this.apiClient.put(updateExperiencesVersionsEndPoint, input);
-    return this.handleVariantAPIRes(data) as ExperienceStruct;
+    return (await this.handleVariantAPIRes(data)) as ExperienceStruct;
   }
 
   async getVariantGroup(input: GetVariantGroupInput): Promise<VariantGroupStruct | void> {
@@ -113,7 +130,7 @@ export class PersonalizationAdapter<T> extends AdapterHelper<T, HttpClient> impl
       const data = await this.cmaAPIClient
         .queryParams({ experience_uid: input.experienceUid })
         .get(getVariantGroupEndPoint);
-      return this.handleVariantAPIRes(data) as VariantGroupStruct;
+      return (await this.handleVariantAPIRes(data)) as VariantGroupStruct;
     }
   }
 
@@ -121,28 +138,28 @@ export class PersonalizationAdapter<T> extends AdapterHelper<T, HttpClient> impl
     if (this.cmaAPIClient) {
       const updateVariantGroupEndPoint = `/variant_groups/${input.uid}`;
       const data = await this.cmaAPIClient.put(updateVariantGroupEndPoint, input);
-      return this.handleVariantAPIRes(data) as VariantGroup;
+      return (await this.handleVariantAPIRes(data)) as VariantGroup;
     }
   }
 
   async getEvents(): Promise<EventStruct[] | void> {
     const data = await this.apiClient.get<EventStruct>('/events');
-    return this.handleVariantAPIRes(data) as EventStruct[];
+    return (await this.handleVariantAPIRes(data)) as EventStruct[];
   }
 
   async createEvents(event: CreateEventInput): Promise<void | EventStruct> {
     const data = await this.apiClient.post<EventStruct>('/events', event);
-    return this.handleVariantAPIRes(data) as EventStruct;
+    return (await this.handleVariantAPIRes(data)) as EventStruct;
   }
 
   async getAudiences(): Promise<AudienceStruct[] | void> {
     const data = await this.apiClient.get<AudienceStruct>('/audiences');
-    return this.handleVariantAPIRes(data) as AudienceStruct[];
+    return (await this.handleVariantAPIRes(data)) as AudienceStruct[];
   }
 
   async getAttributes(): Promise<AttributeStruct[] | void> {
     const data = await this.apiClient.get<AttributeStruct>('/attributes');
-    return this.handleVariantAPIRes(data) as AttributeStruct[];
+    return (await this.handleVariantAPIRes(data)) as AttributeStruct[];
   }
 
   /**
@@ -155,7 +172,7 @@ export class PersonalizationAdapter<T> extends AdapterHelper<T, HttpClient> impl
    */
   async createAudience(audience: CreateAudienceInput): Promise<void | AudienceStruct> {
     const data = await this.apiClient.post<AudienceStruct>('/audiences', audience);
-    return this.handleVariantAPIRes(data) as AudienceStruct;
+    return (await this.handleVariantAPIRes(data)) as AudienceStruct;
   }
 
   /**
@@ -168,7 +185,7 @@ export class PersonalizationAdapter<T> extends AdapterHelper<T, HttpClient> impl
    */
   async createExperience(experience: CreateExperienceInput): Promise<void | ExperienceStruct> {
     const data = await this.apiClient.post<ExperienceStruct>('/experiences', experience);
-    return this.handleVariantAPIRes(data) as ExperienceStruct;
+    return (await this.handleVariantAPIRes(data)) as ExperienceStruct;
   }
 
   /**
@@ -182,7 +199,7 @@ export class PersonalizationAdapter<T> extends AdapterHelper<T, HttpClient> impl
   ): Promise<void | CMSExperienceStruct> {
     const updateCTInExpEndPoint = `/experiences/${experienceUid}/cms-integration/variant-group`;
     const data = await this.apiClient.post<CMSExperienceStruct>(updateCTInExpEndPoint, experience);
-    return this.handleVariantAPIRes(data) as CMSExperienceStruct;
+    return (await this.handleVariantAPIRes(data)) as CMSExperienceStruct;
   }
 
   /**
@@ -193,7 +210,7 @@ export class PersonalizationAdapter<T> extends AdapterHelper<T, HttpClient> impl
   async getCTsFromExperience(experienceUid: string): Promise<void | CMSExperienceStruct> {
     const getCTFromExpEndPoint = `/experiences/${experienceUid}/cms-integration/variant-group`;
     const data = await this.apiClient.get<CMSExperienceStruct>(getCTFromExpEndPoint);
-    return this.handleVariantAPIRes(data) as CMSExperienceStruct;
+    return (await this.handleVariantAPIRes(data)) as CMSExperienceStruct;
   }
 
   /**
@@ -202,16 +219,22 @@ export class PersonalizationAdapter<T> extends AdapterHelper<T, HttpClient> impl
    * @returns The variant API response data.
    * @throws If the API response status is not within the success range, an error message is thrown.
    */
-  handleVariantAPIRes(res: APIResponse): VariantAPIRes {
+  async handleVariantAPIRes(res: APIResponse): Promise<VariantAPIRes> {
     const { status, data } = res;
 
     if (status >= 200 && status < 300) {
       return data;
     }
-    
+
+    // Refresh the access token if it has expired
+    await authenticationHandler.refreshAccessToken(res);
+
     const errorMsg = data?.errors
       ? formatErrors(data.errors)
-      : data?.error || 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

@@ -7,6 +7,7 @@ import {
   ContentstackClient,
   ContentstackConfig,
   managementSDKClient,
+  authenticationHandler,
 } from '@contentstack/cli-utilities';
 
 import {
@@ -37,6 +38,16 @@ export class VariantHttpClient<C> extends AdapterHelper<C, HttpClient> implement
     this.apiClient.baseUrl(this.baseURL);
   }
 
+  async init(): Promise<void> {
+    await authenticationHandler.getAuthDetails();
+    const token = authenticationHandler.accessToken;
+    if (authenticationHandler.isOauthEnabled) {
+      this.apiClient.headers({ authorization: token });
+    } else {
+      this.apiClient.headers({ authtoken: token });
+    }
+  }
+
   async variantEntry(options: VariantOptions) {
     // TODO single entry variant
     return { entry: {} };
@@ -124,7 +135,7 @@ export class VariantHttpClient<C> extends AdapterHelper<C, HttpClient> implement
     }
 
     const data = await this.apiClient.get(endpoint);
-    const response = this.handleVariantAPIRes(data) as { entries: VariantEntryStruct[]; count: number };
+    const response = (await this.handleVariantAPIRes(data)) as { entries: VariantEntryStruct[]; count: number };
 
     if (callback) {
       callback(response.entries);
@@ -244,15 +255,18 @@ export class VariantHttpClient<C> extends AdapterHelper<C, HttpClient> implement
    * @returns The variant API response data.
    * @throws If the API response status is not within the success range, an error message is thrown.
    */
-  handleVariantAPIRes(
+  async handleVariantAPIRes(
     res: APIResponse,
-  ): VariantEntryStruct | { entries: VariantEntryStruct[]; count: number } | string | any {
+  ): Promise<VariantEntryStruct | { entries: VariantEntryStruct[]; count: number } | string | any> {
     const { status, data } = res;
 
     if (status >= 200 && status < 300) {
       return data;
     }
 
+    // Refresh the access token if the response status is 401
+    await authenticationHandler.refreshAccessToken(res);
+
     const errorMsg = data?.errors
       ? formatErrors(data.errors)
       : data?.error_message || data?.message || 'Something went wrong while processing entry variant request!';
@@ -290,9 +304,9 @@ export class VariantManagementSDK<T>
     return Promise.resolve({} as VariantEntryStruct);
   }
 
-  handleVariantAPIRes(
+  async handleVariantAPIRes(
     res: APIResponse,
-  ): VariantEntryStruct | { entries: VariantEntryStruct[]; count: number } | string {
+  ): Promise<VariantEntryStruct | { entries: VariantEntryStruct[]; count: number } | string> {
     return res.data;
   }