@contentstack/cli-variants 1.3.2 → 2.0.0-beta

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

@@ -9,6 +9,8 @@ import {
   managementSDKClient,
   authenticationHandler,
   log,
+  CLIProgressManager,
+  configHandler,
 } from '@contentstack/cli-utilities';
 
 import {
@@ -39,23 +41,24 @@ export class VariantHttpClient<C> extends AdapterHelper<C, HttpClient> implement
     super(config, options);
     this.baseURL = config.baseURL?.includes('http') ? `${config.baseURL}/v3` : `https://${config.baseURL}/v3`;
     this.apiClient.baseUrl(this.baseURL);
-    log.debug(`VariantHttpClient initialized with base URL: ${this.baseURL}`, this.exportConfig?.context );
+    log.debug(`VariantHttpClient initialized with base URL: ${this.baseURL}`, this.exportConfig?.context);
   }
 
   async init(): Promise<void> {
-    log.debug('Initializing VariantHttpClient...', this.exportConfig?.context );
+    log.debug('Initializing VariantHttpClient...', this.exportConfig?.context);
     await authenticationHandler.getAuthDetails();
     const token = authenticationHandler.accessToken;
-    log.debug(`Authentication type: ${authenticationHandler.isOauthEnabled ? 'OAuth' : 'Token'}`, this.exportConfig?.context );
-    
+    log.debug(
+      `Authentication type: ${authenticationHandler.isOauthEnabled ? 'OAuth' : 'Token'}`,
+      this.exportConfig?.context,
+    );
     if (authenticationHandler.isOauthEnabled) {
-      log.debug('Setting OAuth authorization header', this.exportConfig?.context );
+      log.debug('Setting OAuth authorization header', this.exportConfig?.context);
       this.apiClient.headers({ authorization: token });
     } else {
-      log.debug('Setting authtoken header', this.exportConfig?.context );
+      log.debug('Setting authtoken header', this.exportConfig?.context);
       this.apiClient.headers({ authtoken: token });
     }
-    log.debug('VariantHttpClient initialization completed', this.exportConfig?.context );
   }
 
   async variantEntry(options: VariantOptions) {
@@ -96,22 +99,28 @@ export class VariantHttpClient<C> extends AdapterHelper<C, HttpClient> implement
       include_publish_details = variantConfig.query.include_publish_details || true,
     } = options;
 
-    log.debug(`Fetching variant entries for content type: ${content_type_uid}, entry: ${entry_uid}, locale: ${locale}`, this.exportConfig?.context );
-    log.debug(`Query parameters - skip: ${skip}, limit: ${limit}, include_variant: ${include_variant}, include_count: ${include_count}, include_publish_details: ${include_publish_details}`, this.exportConfig?.context );
+    log.debug(
+      `Fetching variant entries for content type: ${content_type_uid}, entry: ${entry_uid}, locale: ${locale}`,
+      this.exportConfig?.context,
+    );
+    log.debug(
+      `Query parameters - skip: ${skip}, limit: ${limit}, include_variant: ${include_variant}, include_count: ${include_count}, include_publish_details: ${include_publish_details}`,
+      this.exportConfig?.context,
+    );
 
     if (variantConfig.serveMockData && callback) {
-      log.debug('Using mock data for variant entries', this.exportConfig?.context );
+      log.debug('Using mock data for variant entries', this.exportConfig?.context);
       let data = [] as Record<string, any>[];
 
       if (existsSync(variantConfig.mockDataPath)) {
-        log.debug(`Loading mock data from: ${variantConfig.mockDataPath}`, this.exportConfig?.context );
+        log.debug(`Loading mock data from: ${variantConfig.mockDataPath}`, this.exportConfig?.context);
         data = require(variantConfig.mockDataPath) as Record<string, any>[];
       }
       callback(data);
       return;
     }
     if (!locale) {
-      log.debug('No locale provided, skipping variant entries fetch', this.exportConfig?.context );
+      log.debug('No locale provided, skipping variant entries fetch', this.exportConfig?.context);
       return;
     }
 
@@ -153,19 +162,22 @@ export class VariantHttpClient<C> extends AdapterHelper<C, HttpClient> implement
       endpoint = endpoint.concat(query);
     }
 
-    log.debug(`Making API call to: ${endpoint}`, this.exportConfig?.context );
+    log.debug(`Making API call to: ${endpoint}`, this.exportConfig?.context);
     const data = await this.apiClient.get(endpoint);
     const response = (await this.handleVariantAPIRes(data)) as { entries: VariantEntryStruct[]; count: number };
-    
+
     if (response?.entries?.length) {
-      log.debug(`Received ${response.entries?.length} variant entries out of total ${response.count}`, this.exportConfig?.context );
+      log.debug(
+        `Received ${response.entries?.length} variant entries out of total ${response.count}`,
+        this.exportConfig?.context,
+      );
     }
 
     if (callback) {
-      log.debug('Executing callback with variant entries', this.exportConfig?.context );
+      log.debug('Executing callback with variant entries', this.exportConfig?.context);
       callback(response.entries);
     } else {
-      log.debug('Adding variant entries to collection', this.exportConfig?.context );
+      log.debug('Adding variant entries to collection', this.exportConfig?.context);
       entries = entries.concat(response.entries);
     }
 
@@ -206,12 +218,15 @@ export class VariantHttpClient<C> extends AdapterHelper<C, HttpClient> implement
     options: CreateVariantEntryOptions,
     apiParams: Record<string, any>,
   ): Promise<VariantEntryStruct | string | void> {
-    const { reject, resolve, variantUid, log } = apiParams;
+    const { reject, resolve, variantUid } = apiParams;
     const variantConfig = (this.config as ImportConfig).modules.variantEntry;
     const { locale = variantConfig.query.locale || 'en-us', variant_id, entry_uid, content_type_uid } = options;
-    
-    log.debug(`Creating variant entry for content type: ${content_type_uid}, entry: ${entry_uid}, variant: ${variant_id}`, this.exportConfig?.context );
-    
+
+    log.debug(
+      `Creating variant entry for content type: ${content_type_uid}, entry: ${entry_uid}, variant: ${variant_id}`,
+      this.exportConfig?.context,
+    );
+
     let endpoint = `content_types/${content_type_uid}/entries/${entry_uid}/variants/${variant_id}?locale=${locale}`;
 
     const query = this.constructQuery(omit(variantConfig.query, ['locale']));
@@ -220,14 +235,12 @@ export class VariantHttpClient<C> extends AdapterHelper<C, HttpClient> implement
       endpoint = endpoint.concat(query);
     }
 
-    log.debug(`Making API call to: ${endpoint}`, this.exportConfig?.context );
+    log.debug(`Making API call to: ${endpoint}`, this.exportConfig?.context);
 
     const onSuccess = (response: any) => {
-      log.debug(`Variant entry created successfully: ${variantUid}`, this.exportConfig?.context );
       resolve({ response, apiData: { variantUid, entryUid: entry_uid }, log });
     };
     const onReject = (error: any) => {
-      log.debug(`Failed to create variant entry: ${variantUid}`, this.exportConfig?.context );
       reject({
         error,
         apiData: { variantUid, entryUid: entry_uid },
@@ -263,14 +276,17 @@ export class VariantHttpClient<C> extends AdapterHelper<C, HttpClient> implement
     options: PublishVariantEntryOptions,
     apiParams: Record<string, any>,
   ) {
-    const { reject, resolve, log, variantUid } = apiParams;
+    const { reject, resolve, variantUid } = apiParams;
     const { entry_uid, content_type_uid } = options;
-    
-    log.debug(`Publishing variant entry for content type: ${content_type_uid}, entry: ${entry_uid}`, this.exportConfig?.context );
-    
+
+    log.debug(
+      `Publishing variant entry for content type: ${content_type_uid}, entry: ${entry_uid}`,
+      this.exportConfig?.context,
+    );
+
     let endpoint = `content_types/${content_type_uid}/entries/${entry_uid}/publish`;
 
-    log.debug(`Making API call to: ${endpoint}`, this.exportConfig?.context );
+    log.debug(`Making API call to: ${endpoint}`, this.exportConfig?.context);
 
     const onSuccess = (response: any) => {
       log.debug(`Variant entry published successfully: ${entry_uid}`, this.exportConfig?.context );
@@ -310,22 +326,20 @@ export class VariantHttpClient<C> extends AdapterHelper<C, HttpClient> implement
     res: APIResponse,
   ): Promise<VariantEntryStruct | { entries: VariantEntryStruct[]; count: number } | string | any> {
     const { status, data } = res;
-    log.debug(`API response status: ${status}`, this.exportConfig?.context );
+    log.debug(`API response status: ${status}`, this.exportConfig?.context);
 
     if (status >= 200 && status < 300) {
-      log.debug('API request successful', this.exportConfig?.context );
+      log.debug('API request successful', this.exportConfig?.context);
       return data;
     }
 
-    log.debug(`API request failed with status: ${status}`, this.exportConfig?.context );
+    log.debug(`API request failed with status: ${status}`, this.exportConfig?.context);
     // 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 || data;
+    const errorMsg = data?.errors ? formatErrors(data.errors) : data?.error_message || data?.message || data;
 
-    log.debug(`API error: ${errorMsg}`, this.exportConfig?.context );
+    log.debug(`API error: ${errorMsg}`, this.exportConfig?.context);
     throw errorMsg;
   }
 }
@@ -338,19 +352,15 @@ export class VariantManagementSDK<T>
   public exportConfig?: any;
 
   async init(): Promise<void> {
-    log.debug('Initializing VariantManagementSDK...', this.exportConfig?.context );
     this.apiClient = await managementSDKClient(this.config);
-    log.debug('VariantManagementSDK initialized successfully', this.exportConfig?.context );
   }
 
   async variantEntry(options: VariantOptions) {
-    log.debug('VariantEntry method called (SDK placeholder implementation)', this.exportConfig?.context );
     // TODO SDK implementation
     return { entry: {} };
   }
 
   async variantEntries(options: VariantsOption) {
-    log.debug('VariantEntries method called (SDK placeholder implementation)', this.exportConfig?.context );
     // TODO SDK implementation
     return { entries: [{}] };
   }
@@ -360,7 +370,6 @@ export class VariantManagementSDK<T>
     options: CreateVariantEntryOptions,
     apiParams: Record<string, any>,
   ): Promise<VariantEntryStruct | string | void> {
-    log.debug('CreateVariantEntry method called (SDK placeholder implementation)', this.exportConfig?.context );
     // FIXME placeholder
     return Promise.resolve({} as VariantEntryStruct);
   }
@@ -368,16 +377,15 @@ export class VariantManagementSDK<T>
   async handleVariantAPIRes(
     res: APIResponse,
   ): Promise<VariantEntryStruct | { entries: VariantEntryStruct[]; count: number } | string> {
-    log.debug('HandleVariantAPIRes method called (SDK implementation)', this.exportConfig?.context );
     return res.data;
   }
 
   constructQuery(query: Record<string, any>): string | void {
-    log.debug('ConstructQuery method called (SDK placeholder implementation)', this.exportConfig?.context );
+    log.debug('ConstructQuery method called (SDK placeholder implementation)', this.exportConfig?.context);
   }
 
   async delay(ms: number): Promise<void> {
-    log.debug(`Delay method called for ${ms}ms (SDK placeholder implementation)`, this.exportConfig?.context );
+    log.debug(`Delay method called for ${ms}ms (SDK placeholder implementation)`, this.exportConfig?.context);
   }
 }
 
@@ -385,6 +393,9 @@ export class VariantAdapter<T> {
   protected variantInstance;
   public readonly messages: typeof messages;
   public exportConfig?: any;
+  protected progressManager: CLIProgressManager | null = null;
+  protected parentProgressManager: CLIProgressManager | null = null;
+  protected currentModuleName: string = '';
 
   constructor(config: ContentstackConfig & AnyProperty & AdapterType<T, ContentstackConfig>);
   constructor(config: APIConfig & AdapterType<T, APIConfig & AnyProperty>, options?: HttpClientOptions);
@@ -392,21 +403,97 @@ export class VariantAdapter<T> {
     config: APIConfig & AdapterType<T, (APIConfig & AnyProperty) | ContentstackConfig>,
     options?: HttpClientOptions,
   ) {
-    log.debug('Initializing VariantAdapter...', this.exportConfig?.context );
-    
+    log.debug('Initializing VariantAdapter...', this.exportConfig?.context);
+
     if (config.httpClient) {
-      log.debug('Using HTTP client variant instance', this.exportConfig?.context );
+      log.debug('Using HTTP client variant instance', this.exportConfig?.context);
       const { httpClient, Adapter, ...restConfig } = config;
       this.variantInstance = new Adapter(restConfig, options);
     } else {
-      log.debug('Using SDK variant instance', this.exportConfig?.context );
+      log.debug('Using SDK variant instance', this.exportConfig?.context);
       const { Adapter, ...restConfig } = config;
       this.variantInstance = new Adapter(restConfig);
     }
 
     this.messages = messages;
-    log.debug('VariantAdapter initialized successfully', this.exportConfig?.context );
+    log.debug('VariantAdapter initialized successfully', this.exportConfig?.context);
+  }
+
+  /**
+   * Set parent progress manager for sub-module integration
+   */
+  public setParentProgressManager(parentProgress: CLIProgressManager): void {
+    this.parentProgressManager = parentProgress;
+    this.progressManager = parentProgress;
+  }
+
+  /**
+   * Create simple progress manager for single process tracking
+   */
+  protected createSimpleProgress(moduleName: string, total?: number): CLIProgressManager {
+    this.currentModuleName = moduleName;
+    
+    // If we have a parent progress manager, use it instead of creating a new one
+    if (this.parentProgressManager) {
+      this.progressManager = this.parentProgressManager;
+      return this.progressManager;
+    }
+    
+    const logConfig = configHandler.get('log') || {};
+    const showConsoleLogs = logConfig.showConsoleLogs ?? false;
+    this.progressManager = CLIProgressManager.createSimple(moduleName, total, showConsoleLogs);
+    return this.progressManager;
+  }
+
+  /**
+   * Create nested progress manager for multi-process tracking
+   */
+  protected createNestedProgress(moduleName: string): CLIProgressManager {
+    this.currentModuleName = moduleName;
+    
+    // If we have a parent progress manager, use it instead of creating a new one
+    if (this.parentProgressManager) {
+      this.progressManager = this.parentProgressManager;
+      return this.progressManager;
+    }
+    
+    const logConfig = configHandler.get('log') || {};
+    const showConsoleLogs = logConfig.showConsoleLogs ?? false;
+    this.progressManager = CLIProgressManager.createNested(moduleName, showConsoleLogs);
+    return this.progressManager;
+  }
+
+  /**
+   * Complete progress manager
+   */
+  protected completeProgress(success: boolean = true, error?: string): void {
+    // Only complete progress if we own the progress manager (no parent)
+    if (!this.parentProgressManager) {
+      this.progressManager?.complete(success, error);
+    }
+    this.progressManager = null;
+  }
+
+  /**
+   * Execute action with loading spinner for initial setup tasks
+   */
+  protected async withLoadingSpinner<T>(message: string, action: () => Promise<T>): Promise<T> {
+    const logConfig = configHandler.get('log') || {};
+    const showConsoleLogs = logConfig.showConsoleLogs ?? false;
+
+    if (showConsoleLogs) {
+      // If console logs are enabled, don't show spinner, just execute the action
+      return await action();
+    }
+    return await CLIProgressManager.withLoadingSpinner(message, action);
+  }
+
+  /**
+   * Update progress for a specific item
+   */
+  protected updateProgress(success: boolean, itemName: string, error?: string, processName?: string): void {
+    this.progressManager?.tick(success, itemName, error, processName);
   }
 }
 
-export default VariantAdapter;
+export default VariantAdapter;

package/tsconfig.json

@@ -15,5 +15,5 @@
       "es2020.promise"
     ],
   },
-  "include": ["src/*"]
+  "include": ["src/*", "src/utils/constants.ts"]
 }