chore: addressed comments

Author: snehaljha-sf

messages/assess.json

@@ -29,7 +29,7 @@
   "allVersionsDescription": "Migrate all versions of a component",
   "changeMessage": " %s will be changed from %s to %s",
   "angularOSWarning": " Angular OmniScript will not be migrated, please convert this to LWC based Omniscript",
-  "apexLwcGA": "Please select the type of component to assess: 'apex' for Apex classes, 'lwc' for Lightning Web Components, or 'apex,lwc' if you want to include both types.",
+  "relatedObjectGA": "Please select the type of component to assess: 'apex' for Apex classes, 'lwc' for Lightning Web Components, 'flexipage' for FlexiPages, or 'apex,lwc,flexipage' if you want to include all types.",
   "apexLwc": "Please select the type of component to assess: 'apex' for Apex classes.",
   "invalidNamespace": "The namespace you have passed is not valid namespace, the valid namespace of your org is ",
   "noPackageInstalled": "No package installed on given org.",
@@ -123,7 +123,8 @@
   "processingFlexiPage": "Processing flexipage file: %s",
   "startingFlexiPageProcessing": "Starting to process flexipage: %s",
   "readFlexiPageContent": "Read file content, size: %s characters",
-  "updatedModifiedContent": "Wrote modified content to file: %s",
+  "updatedModifiedContent": "updated content in file: %s",
   "generatedDiffForFile": "Generated diff for file: %s",
-  "errorProcessingFlexiPage": "Error processing flexipage file: %s, %s"
+  "errorProcessingFlexiPage": "Error processing flexipage file: %s, %s",
+  "flexipagesWithChanges": "Found %s flexipage files with changes"
 }

messages/migrate.json

@@ -29,7 +29,7 @@
   "errorWhileUploadingCard": "An error ocurred while uploading Card: ",
   "errorWhileCreatingElements": "An error ocurred while saving OmniScript elements: ",
   "allVersionsDescription": "Migrate all versions of a component",
-  "apexLwcGA": "Please select the type of components to migrate: 'apex' for Apex classes, 'lwc' for Lightning Web Components, or 'apex,lwc' if you want to include both types.",
+  "relatedObjectGA": "Please select the type of components to migrate: 'apex' for Apex classes, 'lwc' for Lightning Web Components, 'flexipage' for FlexiPages, or 'apex,lwc,flexipage' if you want to include all types.",
   "apexLwc": "Please select the type of components to migrate: 'apex' for Apex classes.",
   "invalidNamespace": "The namespace you have passed is not valid namespace, the valid namespace of your org is ",
   "noPackageInstalled": "No package installed on given org.",
@@ -118,7 +118,8 @@
   "processingFlexiPage": "Processing flexipage file: %s",
   "startingFlexiPageProcessing": "Starting to process flexipage: %s",
   "readFlexiPageContent": "Read file content, size: %s characters",
-  "updatedModifiedContent": "Wrote modified content to file: %s",
+  "updatedModifiedContent": "updated content in file: %s",
   "generatedDiffForFile": "Generated diff for file: %s",
-  "errorProcessingFlexiPage": "Error processing flexipage file: %s, %s"
+  "errorProcessingFlexiPage": "Error processing flexipage file: %s, %s",
+  "flexipagesWithChanges": "Found %s flexipage files with changes"
 }

package.json

@@ -15,7 +15,6 @@
     "@types/jsdom": "^21.1.7",
     "@types/lodash.chunk": "^4.2.9",
     "@types/shelljs": "^0.8.15",
-    "fast-xml-parser": "^5.2.5",
     "jsdom": "^25.0.0",
     "lodash.chunk": "^4.2.0",
     "open": "^8.4.2",

src/commands/omnistudio/migration/migrate.ts

@@ -57,7 +57,7 @@ export default class Migrate extends OmniStudioBaseCommand {
     }),
     relatedobjects: flags.string({
       char: 'r',
-      description: messages.getMessage('apexLwc'),
+      description: messages.getMessage('relatedObjectGA'),
     }),
     verbose: flags.builtin({
       type: 'builtin',
@@ -126,7 +126,7 @@ export default class Migrate extends OmniStudioBaseCommand {
     let targetApexNamespace: string;
     if (relatedObjects) {
       // To-Do: Add LWC to valid options when GA is released
-      const validOptions = [Constants.Apex];
+      const validOptions = [Constants.Apex, Constants.FlexiPage];
       objectsToProcess = relatedObjects.split(',').map((obj) => obj.trim());
       // Validate input
       for (const obj of objectsToProcess) {
@@ -178,7 +178,8 @@ export default class Migrate extends OmniStudioBaseCommand {
     const relatedObjectMigrationResult = omnistudioRelatedObjectsMigration.migrateAll(objectsToProcess);
     generatePackageXml.createChangeList(
       relatedObjectMigrationResult.apexAssessmentInfos,
-      relatedObjectMigrationResult.lwcAssessmentInfos
+      relatedObjectMigrationResult.lwcAssessmentInfos,
+      relatedObjectMigrationResult.flexipageAssessmentInfos
     );
 
     let actionItems = [];

src/migration/base.ts

@@ -7,19 +7,20 @@ import { Stringutil } from '../utils/StringValue/stringutil';
 import { Logger } from '../utils/logger';
 import { TransformData, UploadRecordResult } from './interfaces';
 
-export type ComponentType = 'Data Mapper' | 'Flexcard' | 'Omniscript and Integration Procedure' | 'Flexipage';
+export type ComponentType = 'Data Mapper' | 'Flexcard' | 'Omniscript and Integration Procedure';
+export type RelatedObjectType = 'Flexipage';
 
 /**
  * Creates a progress bar for migration/assessment operations
  *
  * @param action - The action being performed (e.g., 'Migrating', 'Assessing')
- * @param componentType - The type of component being processed
+ * @param type - The type of component being processed
  * @returns A configured cliProgress.SingleBar instance
  */
-export const createProgressBar = (action: string, componentType: ComponentType): cliProgress.SingleBar => {
+export const createProgressBar = (action: string, type: ComponentType | RelatedObjectType): cliProgress.SingleBar => {
   return new cliProgress.SingleBar({
-    format: `${action} ${componentType} |${
-      componentType === 'Omniscript and Integration Procedure' ? '' : '\t\t\t\t'
+    format: `${action} ${type} |${
+      type === 'Omniscript and Integration Procedure' ? '' : '\t\t\t\t'
     } {bar} | {percentage}% || {value}/{total} Tasks`,
     barCompleteChar: '\u2588',
     barIncompleteChar: '\u2591',

src/migration/related/FlexipageMigration.ts

@@ -14,7 +14,7 @@ import { Logger } from '../../utils/logger';
 import { Constants } from '../../utils/constants/stringContants';
 import { FlexiPageAssessmentInfo } from '../../utils/interfaces';
 import { createProgressBar } from '../base';
-import { xmlUtil } from '../../utils/XMLUtil';
+import { XMLUtil } from '../../utils/XMLUtil';
 import { FileDiffUtil } from '../../utils/lwcparser/fileutils/FileDiffUtil';
 import { transformFlexipageBundle } from '../../utils/flexipage/flexiPageTransformer';
 import { Flexipage } from '../interfaces';
@@ -41,6 +41,7 @@ import { BaseRelatedObjectMigration } from './BaseRealtedObjectMigration';
 export class FlexipageMigration extends BaseRelatedObjectMigration {
   /** Messages instance for internationalization */
   private messages: Messages;
+  private xmlUtil: XMLUtil;
 
   /**
    * Creates a new FlexipageMigration instance.
@@ -53,6 +54,7 @@ export class FlexipageMigration extends BaseRelatedObjectMigration {
   public constructor(projectPath: string, namespace: string, org: Org, messages: Messages) {
     super(projectPath, namespace, org);
     this.messages = messages;
+    this.xmlUtil = new XMLUtil(['flexiPageRegions', 'itemInstances', 'componentInstanceProperties']);
   }
 
   /**
@@ -123,18 +125,21 @@ export class FlexipageMigration extends BaseRelatedObjectMigration {
         );
       } catch (error) {
         Logger.error(this.messages.getMessage('errorProcessingFlexiPage', [file, error]));
+        Logger.error(error);
         flexPageAssessmentInfos.push({
           name: file,
           errors: [error instanceof Error ? error.message : JSON.stringify(error)],
           path: filePath,
           diff: '',
-          status: 'Errors',
+          status: mode === 'assess' ? 'Errors' : 'Failed',
         });
       }
       progressBar.increment();
     }
     progressBar.stop();
     Logger.info(this.messages.getMessage('completedProcessingAllFlexiPages', [flexPageAssessmentInfos.length]));
+    flexPageAssessmentInfos.filter((flexPageAssessmentInfo) => flexPageAssessmentInfo.status !== 'No Changes');
+    Logger.info(this.messages.getMessage('flexipagesWithChanges', [flexPageAssessmentInfos.length]));
     return flexPageAssessmentInfos;
   }
 
@@ -159,8 +164,9 @@ export class FlexipageMigration extends BaseRelatedObjectMigration {
     const fileContent = fs.readFileSync(filePath, 'utf8');
     Logger.logVerbose(this.messages.getMessage('readFlexiPageContent', [fileContent.length]));
 
-    const parent: { FlexiPage: Flexipage } = xmlUtil.parse(fileContent) as { FlexiPage: Flexipage };
-    const json = parent.FlexiPage;
+    const json = this.xmlUtil.parse(fileContent) as Flexipage;
+    const jsonPath = path.join(shell.pwd().toString(), 'json', fileName + '.json');
+    fs.writeFileSync(jsonPath.toString(), JSON.stringify(json) || '');
     const transformedFlexiPage = transformFlexipageBundle(json, this.namespace);
     if (transformedFlexiPage === false) {
       return {
@@ -171,8 +177,10 @@ export class FlexipageMigration extends BaseRelatedObjectMigration {
         status: 'No Changes',
       };
     }
-    parent.FlexiPage = transformedFlexiPage as Flexipage;
-    const modifiedContent = xmlUtil.build(parent);
+    const modifiedContent = this.xmlUtil.build(transformedFlexiPage, 'FlexiPage');
+
+    const xmlPath = path.join(shell.pwd().toString(), 'xml', fileName);
+    fs.writeFileSync(xmlPath.toString(), modifiedContent);
 
     if (mode === 'migrate') {
       fs.writeFileSync(filePath, modifiedContent);
@@ -187,7 +195,7 @@ export class FlexipageMigration extends BaseRelatedObjectMigration {
       name: fileName,
       diff: JSON.stringify(diff),
       errors: [],
-      status: 'Can be Automated',
+      status: mode === 'assess' ? 'Can be Automated' : 'Complete',
     };
   }
 }