Merge pull request #264 from salesforcecli/t/kumar-ankita/W-17258174/tncChanges

W-17258174 - feat: tnc changes

Author: AbhinavKumar-sf

README.md

@@ -59,4 +59,11 @@ OPTIONS
   -a, --allversions                                                                 migrate all versions and not
                                                                                     and not just the active ones.
 
+  --relatedobjects=relatedobjects                                                   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.
+
 ```
+
+Terms:
+Notwithstanding anything stated in the terms and conditions agreed between Salesforce (‘SFDC’) and you (‘Customer’), the use of the OmniStudio Migration Tool (‘Tool’) is designed to facilitate the migration and it’s going to modify your custom code and by deploying and using the Tool you hereby provide your consent to automate the migration process and enable a smooth transition. Customer shall access and use the Tool only as permitted to the Customer and shall not compromise, break or circumvent any technical processes or security measures associated with the services provided by SFDC.
+The Customer agrees to hold harmless, indemnify, and defend SFDC, and its officers, directors, agents, employees, licensees, successors and assigns (collectively, the “Indemnified Parties”) against any and all damages, penalties, losses, liabilities, judgments, settlements, awards, costs, and expenses (including reasonable attorneys’ fees and expenses) to the extent arising out of or in connection with any claims related to the Customers use of the Tool or any willful misconduct, fraud or grossly negligent acts or omissions by the Customer.

command-snapshot.json

@@ -1,55 +1,26 @@
 [
-    {
-        "command": "basecommand",
-        "plugin": "@salesforce/plugin-omnistudio-migration-tool",
-        "flags": [
-            "apiversion",
-            "json",
-            "loglevel",
-            "targetusername"
-        ],
-        "alias": []
-    },
-    {
-        "command": "omnistudio:migration:assess",
-        "plugin": "@salesforce/plugin-omnistudio-migration-tool",
-        "flags": [
-            "allversions",
-            "apiversion",
-            "json",
-            "loglevel",
-            "namespace",
-            "only",
-            "targetusername"
-        ],
-        "alias": []
-    },
-    {
-        "command": "omnistudio:migration:info",
-        "plugin": "@salesforce/plugin-omnistudio-migration-tool",
-        "flags": [
-            "allversions",
-            "apiversion",
-            "json",
-            "loglevel",
-            "name",
-            "targetdevhubusername",
-            "targetusername"
-        ],
-        "alias": []
-    },
-    {
-        "command": "omnistudio:migration:migrate",
-        "plugin": "@salesforce/plugin-omnistudio-migration-tool",
-        "flags": [
-            "allversions",
-            "apiversion",
-            "json",
-            "loglevel",
-            "namespace",
-            "only",
-            "targetusername"
-        ],
-        "alias": []
-    }
-]
+  {
+    "command": "basecommand",
+    "plugin": "@salesforce/plugin-omnistudio-migration-tool",
+    "flags": ["apiversion", "json", "loglevel", "targetusername"],
+    "alias": []
+  },
+  {
+    "command": "omnistudio:migration:assess",
+    "plugin": "@salesforce/plugin-omnistudio-migration-tool",
+    "flags": ["allversions", "apiversion", "json", "loglevel", "namespace", "only", "targetusername"],
+    "alias": []
+  },
+  {
+    "command": "omnistudio:migration:info",
+    "plugin": "@salesforce/plugin-omnistudio-migration-tool",
+    "flags": ["allversions", "apiversion", "json", "loglevel", "name", "targetdevhubusername", "targetusername"],
+    "alias": []
+  },
+  {
+    "command": "omnistudio:migration:migrate",
+    "plugin": "@salesforce/plugin-omnistudio-migration-tool",
+    "flags": ["allversions", "apiversion", "json", "loglevel", "namespace", "only", "relatedobjects", "targetusername"],
+    "alias": []
+  }
+]

messages/assess.json

@@ -28,5 +28,6 @@
   "errorWhileCreatingElements": "An error ocurred while saving OmniScript elements: ",
   "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"
+  "angularOSWarning": " Angular OmniScript will not be migrated, please convert this to LWC based Omniscript",
+  "apexLwc": "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."
 }

messages/info.json

@@ -7,5 +7,6 @@
     "sfdx omnistudio:migration:info --targetusername [email protected] --targetdevhubusername [email protected]",
     "sfdx omnistudio:migration:info --name myname --targetusername [email protected]"
   ],
-  "allVersionsDescription": "Migrate all versions of a component"
+  "allVersionsDescription": "Migrate all versions of a component",
+  "apexLwc": "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."
 }

messages/migrate.json

@@ -4,7 +4,10 @@
     "omnistudio:migration:migrate -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE --only=dr",
     "omnistudio:migration:migrate -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE --only=ip",
     "omnistudio:migration:migrate -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE --only=os",
-    "omnistudio:migration:migrate -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE --only=fc"
+    "omnistudio:migration:migrate -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE --only=fc",
+    "omnistudio:migration:migrate -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE -r apex,lwc",
+    "omnistudio:migration:migrate -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE -r apex",
+    "omnistudio:migration:migrate -u [email protected] --namespace=YOUR_PACKAGE_NAMESPACE -r lwc"
   ],
   "commandDescription": "print a greeting and your org IDs",
   "namespaceFlagDescription": "The namespaced of the package",
@@ -25,5 +28,6 @@
   "errorWhileActivatingCard": "Could not activate Card: ",
   "errorWhileUploadingCard": "An error ocurred while uploading Card: ",
   "errorWhileCreatingElements": "An error ocurred while saving OmniScript elements: ",
-  "allVersionsDescription": "Migrate all versions of a component"
+  "allVersionsDescription": "Migrate all versions of a component",
+  "apexLwc": "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."
 }

src/commands/omnistudio/migration/migrate.ts

@@ -50,6 +50,10 @@ export default class Migrate extends OmniStudioBaseCommand {
       description: messages.getMessage('allVersionsDescription'),
       required: false,
     }),
+    relatedobjects: flags.string({
+      char: 'r',
+      description: messages.getMessage('apexLwc'),
+    }),
   };
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -58,6 +62,7 @@ export default class Migrate extends OmniStudioBaseCommand {
     const apiVersion = (this.flags.apiversion || '55.0') as string;
     const migrateOnly = (this.flags.only || '') as string;
     const allVersions = this.flags.allversions || false;
+    const relatedObjects = (this.flags.relatedobjects || '') as string;
 
     Logger.initialiseLogger(this.ux, this.logger);
     this.logger = Logger.logger;
@@ -67,7 +72,33 @@ export default class Migrate extends OmniStudioBaseCommand {
 
     // Let's time every step
     DebugTimer.getInstance().start();
+    // const includeApex = this.flags.apex
+    //   ? await this.ux.confirm('Do you want to include Apex migration? (yes/no)')
+    //   : false;
 
+    if (relatedObjects) {
+      const validOptions = ['apex', 'lwc'];
+      const objectsToProcess = relatedObjects.split(',').map((obj) => obj.trim());
+      // Validate input
+      for (const obj of objectsToProcess) {
+        if (!validOptions.includes(obj)) {
+          Logger.logger.warn(`Invalid option provided for -r: ${obj}. Valid options are apex, lwc.`);
+        }
+      }
+      // Ask for user consent
+      const consent = await this.ux.confirm(
+        'By proceeding further, you hereby consent to the use, accept changes to your custom code, and the accompanying terms and conditions associated with the use of the OmniStudio Migration Tool. Do you want to proceed?'
+      );
+      if (!consent) {
+        this.ux.log('User declined consent. Aborting the process.');
+      } else {
+        const projectPath = await this.ux.prompt('Enter the project path for processing:');
+        this.ux.log(`Using project path: ${projectPath}`);
+        OmnistudioRelatedObjectMigrationFacade.intializeProject(projectPath);
+      }
+    }
+
+    // const includeLwc = this.flags.lwc ? await this.ux.confirm('Do you want to include LWC migration? (yes/no)') : false;
     // Register the migration objects
     let migrationObjects: MigrationTool[] = [];
     if (!migrateOnly) {
@@ -122,7 +153,6 @@ export default class Migrate extends OmniStudioBaseCommand {
           throw new Error(messages.getMessage('invalidOnlyFlag'));
       }
     }
-
     // Migrate individual objects
     const debugTimer = DebugTimer.getInstance();
     let objectMigrationResults: MigratedObject[] = [];

src/migration/related/ApexMigration.ts

@@ -12,7 +12,6 @@ import {
   SingleTokenUpdate,
   TokenUpdater,
 } from '../../utils/apex/parser/apexparser';
-import { MigrationResult } from '../interfaces';
 import { sfProject } from '../../utils/sfcli/project/sfProject';
 import { fileutil, File } from '../../utils/file/fileutil';
 import { Logger } from '../../utils/logger';
@@ -41,12 +40,12 @@ export class ApexMigration extends BaseRelatedObjectMigration {
   public processObjectType(): string {
     return 'apex';
   }
-  public identifyObjects(migrationResults: MigrationResult[]): Promise<JSON[]> {
-    throw new Error('Method not implemented.');
-  }
-  public migrateRelatedObjects(migrationResults: MigrationResult[], migrationCandidates: JSON[]): ApexAssessmentInfo[] {
-    return this.migrate();
-  }
+  // public identifyObjects(migrationResults: MigrationResult[]): Promise<JSON[]> {
+  //   throw new Error('Method not implemented.');
+  // }
+  // public migrateRelatedObjects(migrationResults: MigrationResult[], migrationCandidates: JSON[]): ApexAssessmentInfo[] {
+  //   return this.migrate();
+  // }
   public migrate(): ApexAssessmentInfo[] {
     const pwd = shell.pwd();
     shell.cd(this.projectPath);

src/migration/related/LwcMigration.ts

@@ -2,7 +2,6 @@
 import * as shell from 'shelljs';
 import { Org } from '@salesforce/core';
 import { fileutil, File } from '../../utils/file/fileutil';
-import { MigrationResult } from '../interfaces';
 import { sfProject } from '../../utils/sfcli/project/sfProject';
 import { Logger } from '../../utils/logger';
 import { FileProcessorFactory } from '../../utils/lwcparser/fileutils/FileProcessorFactory';
@@ -16,13 +15,13 @@ export class LwcMigration extends BaseRelatedObjectMigration {
   public processObjectType(): string {
     return 'lwc';
   }
-  public identifyObjects(migrationResults: MigrationResult[]): Promise<JSON[]> {
-    this.assessment();
-    throw new Error('Method not implemented.');
-  }
-  public migrateRelatedObjects(migrationResults: MigrationResult[], migrationCandidates: JSON[]): string[] {
-    return this.mapToName(this.migrate());
-  }
+  // public identifyObjects(migrationResults: MigrationResult[]): Promise<JSON[]> {
+  //   this.assessment();
+  //   throw new Error('Method not implemented.');
+  // }
+  // public migrateRelatedObjects(migrationResults: MigrationResult[], migrationCandidates: JSON[]): string[] {
+  //   return this.mapToName(this.migrate());
+  // }
   public assessment(): LWCAssessmentInfo[] {
     const type = 'assessment';
     const pwd = shell.pwd();
@@ -104,10 +103,4 @@ export class LwcMigration extends BaseRelatedObjectMigration {
   private isValideFile(filename: string): boolean {
     return !filename.includes('_def') && !filename.includes('styleDefinition') && !filename.includes('definition');
   }
-
-  private mapToName(lwcAssessmentInfos: LWCAssessmentInfo[]): string[] {
-    return lwcAssessmentInfos.map((lwcAssessmentInfo) => {
-      return lwcAssessmentInfo.name;
-    });
-  }
 }

src/migration/related/OmnistudioRelatedObjectMigrationFacade.ts

@@ -49,12 +49,17 @@ export default class OmnistudioRelatedObjectMigrationFacade {
       return process.cwd() + '/' + defaultProjectName;
     }
   }
-  public migrateAll(migrationResult: MigratedObject[], relatedObjects: string[]): RelatedObjectAssesmentInfo {
+
+  public migrateAll(
+    migrationResult: MigratedObject[],
+    relatedObjects: string[],
+    projectPath?: string
+  ): RelatedObjectAssesmentInfo {
     // Start the debug timer
     DebugTimer.getInstance().start();
 
     // Declare an array of MigrationTool
-    const projectDirectory: string = OmnistudioRelatedObjectMigrationFacade.intializeProject();
+    const projectDirectory: string = OmnistudioRelatedObjectMigrationFacade.intializeProject(projectPath);
     const debugTimer = DebugTimer.getInstance();
     debugTimer.start();
     // Initialize migration tools based on the relatedObjects parameter