feat: namespcce, cta and code refactoring (#285)

Author: sf-pranav-varshney

messages/assess.json

@@ -29,5 +29,8 @@
   "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",
-  "apexLwc": "Please select the type of components to assess: 'apex' for Apex classes, 'lwc' for Lightning Web Components, or 'apex,lwc' if you want to include both types."
+  "apexLwc": "Please select the type of components to assess: 'apex' for Apex classes, 'lwc' for Lightning Web Components, or 'apex,lwc' if you want to include both types.",
+  "invalidNamespace": "The namespace you have passed is not valid namespace, the valid namespace of your org is ",
+  "noPackageInstalled": "No package installed on given org.",
+  "alreadyStandardModel": "The org is already on standard data model."
 }

messages/migrate.json

@@ -29,5 +29,8 @@
   "errorWhileUploadingCard": "An error ocurred while uploading Card: ",
   "errorWhileCreatingElements": "An error ocurred while saving OmniScript elements: ",
   "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."
+  "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.",
+  "invalidNamespace": "The namespace you have passed is not valid namespace, the valid namespace of your org is ",
+  "noPackageInstalled": "No package installed on given org.",
+  "alreadyStandardModel": "The org is already on standard data model."
 }

src/commands/omnistudio/migration/__tests__/assess.test.ts

@@ -10,6 +10,7 @@ import { OmniScriptMigrationTool } from '../../../../migration/omniscript';
 import OmnistudioRelatedObjectMigrationFacade from '../../../../migration/related/OmnistudioRelatedObjectMigrationFacade';
 import { OrgUtils } from '../../../../utils/orgUtils';
 import { OmnistudioOrgDetails } from '../../../../utils/orgUtils';
+import { Constants } from '../../../../utils/constants/stringContants';
 
 // Helper function to normalize paths for comparison
 
@@ -19,18 +20,17 @@ describe('omnistudio:migration:assess', () => {
 
   // Mock org details
   const mockOrgDetailsStandardModel: OmnistudioOrgDetails = {
-    packageDetails: [
-      {
-        version: '1.0.0',
-        namespace: 'vlocity_ins',
-      },
-    ],
+    packageDetails: {
+      version: '1.0.0',
+      namespace: 'vlocity_ins',
+    },
     omniStudioOrgPermissionEnabled: false,
     orgDetails: {
       Name: 'Test Org',
       Id: '00D000000000001',
     },
     dataModel: 'Standard',
+    hasValidNamespace: true,
   };
 
   // Sample data for DataRaptor assessment
@@ -187,8 +187,8 @@ describe('omnistudio:migration:assess', () => {
     stubMethod(sandbox, OmnistudioRelatedObjectMigrationFacade.prototype, 'assessAll').callsFake(
       (relatedObjects: string[]) => {
         const result = {
-          apexAssessmentInfos: relatedObjects.includes('apex') ? sampleApexAssessment : [],
-          lwcAssessmentInfos: relatedObjects.includes('lwc') ? sampleLwcAssessment : [],
+          apexAssessmentInfos: relatedObjects.includes(Constants.Apex) ? sampleApexAssessment : [],
+          lwcAssessmentInfos: relatedObjects.includes(Constants.LWC) ? sampleLwcAssessment : [],
         };
         return result;
       }
@@ -246,7 +246,7 @@ describe('omnistudio:migration:assess', () => {
     .withOrg({ username: '[email protected]' }, true)
     .stdout()
     .stderr()
-    .command(['omnistudio:migration:assess', '-o', 'dr'])
+    .command(['omnistudio:migration:assess', '-o', Constants.DataMapper])
     .it('generates assessment files with content only for DataRaptor components', () => {
       const dataRaptorContent = fs.readFileSync(
         path.join(process.cwd(), 'assessment_reports/datamapper_assessment.html'),
@@ -279,7 +279,7 @@ describe('omnistudio:migration:assess', () => {
     .withOrg({ username: '[email protected]' }, true)
     .stdout()
     .stderr()
-    .command(['omnistudio:migration:assess', '-o', 'fc'])
+    .command(['omnistudio:migration:assess', '-o', Constants.Flexcard])
     .it('generates assessment files with content only for FlexCard components', () => {
       const dataRaptorContent = fs.readFileSync(
         path.join(process.cwd(), 'assessment_reports/datamapper_assessment.html'),
@@ -312,7 +312,7 @@ describe('omnistudio:migration:assess', () => {
     .withOrg({ username: '[email protected]' }, true)
     .stdout()
     .stderr()
-    .command(['omnistudio:migration:assess', '-o', 'os'])
+    .command(['omnistudio:migration:assess', '-o', Constants.Omniscript])
     .it('generates assessment files with content only for OmniScript components', () => {
       const dataRaptorContent = fs.readFileSync(
         path.join(process.cwd(), 'assessment_reports/datamapper_assessment.html'),
@@ -345,7 +345,7 @@ describe('omnistudio:migration:assess', () => {
     .withOrg({ username: '[email protected]' }, true)
     .stdout()
     .stderr()
-    .command(['omnistudio:migration:assess', '-o', 'ip'])
+    .command(['omnistudio:migration:assess', '-o', Constants.IntegrationProcedure])
     .it('generates assessment files with content only for Integration Procedure components', () => {
       const dataRaptorContent = fs.readFileSync(
         path.join(process.cwd(), 'assessment_reports/datamapper_assessment.html'),
@@ -397,7 +397,7 @@ describe('omnistudio:migration:assess', () => {
   //   .withOrg({ username: 'test@org.com' }, true)
   //   .stdout()
   //   .stderr()
-  //   .command(['omnistudio:migration:assess', '-r', 'apex'])
+  //   .command(['omnistudio:migration:assess', '-r', ''])
   //   .it('generates assessment files with content only for Apex components', () => {
   //     const apexContent = fs.readFileSync(path.join(process.cwd(), 'assessment_reports/apex_assessment.html'), 'utf8');
   //     void expect(apexContent).to.include('TestApexClass');
@@ -437,7 +437,7 @@ describe('omnistudio:migration:assess', () => {
     .withOrg({ username: '[email protected]' }, true)
     .stdout()
     .stderr()
-    .command(['omnistudio:migration:assess', '-r', 'lwc'])
+    .command(['omnistudio:migration:assess', '-r', Constants.LWC])
     .it('does not generate LWC assessment file when lwc option is passed since functionality is disabled', () => {
       // LWC assessment file should not exist since LWC functionality is disabled
       const lwcFilePath = path.join(process.cwd(), 'assessment_reports/lwc_assessment.html');

src/commands/omnistudio/migration/assess.ts

@@ -11,6 +11,7 @@ import { DebugTimer } from '../../../utils';
 import { Logger } from '../../../utils/logger';
 import OmnistudioRelatedObjectMigrationFacade from '../../../migration/related/OmnistudioRelatedObjectMigrationFacade';
 import { OmnistudioOrgDetails, OrgUtils } from '../../../utils/orgUtils';
+import { Constants } from '../../../utils/constants/stringContants';
 
 Messages.importMessagesDirectory(__dirname);
 const messages = Messages.loadMessages('@salesforce/plugin-omnistudio-migration-tool', 'assess');
@@ -45,24 +46,28 @@ export default class Assess extends OmniStudioBaseCommand {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   public async run(): Promise<any> {
     DebugTimer.getInstance().start();
-    const namespace = (this.flags.namespace || 'vlocity_ins') as string;
     const apiVersion = (this.flags.apiversion || '55.0') as string;
     const allVersions = (this.flags.allversions || false) as boolean;
     const assessOnly = (this.flags.only || '') as string;
     const relatedObjects = (this.flags.relatedobjects || '') as string;
     const conn = this.org.getConnection();
-    const orgs: OmnistudioOrgDetails = await OrgUtils.getOrgDetails(conn, namespace);
+    const orgs: OmnistudioOrgDetails = await OrgUtils.getOrgDetails(conn, this.flags.namespace);
 
-    if (orgs.packageDetails.length === 0) {
-      this.ux.log('No package installed on given org.');
+    if (!orgs.hasValidNamespace) {
+      this.ux.warn(messages.getMessage('invalidNamespace') + orgs.packageDetails.namespace);
+    }
+
+    if (!orgs.packageDetails) {
+      this.ux.error(messages.getMessage('noPackageInstalled'));
       return;
     }
 
     if (orgs.omniStudioOrgPermissionEnabled) {
-      this.ux.log('The org is already on standard data model.');
+      this.ux.error(messages.getMessage('alreadyStandardModel'));
       return;
     }
 
+    const namespace = orgs.packageDetails.namespace;
     Logger.initialiseLogger(this.ux, this.logger);
     conn.setApiVersion(apiVersion);
 
@@ -80,10 +85,11 @@ export default class Assess extends OmniStudioBaseCommand {
     // Assess OmniStudio components
     await this.assessOmniStudioComponents(assesmentInfo, assessOnly, namespace, conn, allVersions);
 
+    let objectsToProcess: string[];
     // Assess related objects if specified
     if (relatedObjects) {
-      const validOptions = ['apex', 'lwc'];
-      const objectsToProcess = relatedObjects.split(',').map((obj) => obj.trim());
+      const validOptions = [Constants.Apex, Constants.LWC];
+      objectsToProcess = relatedObjects.split(',').map((obj) => obj.trim());
 
       // Validate input
       for (const obj of objectsToProcess) {
@@ -103,7 +109,7 @@ export default class Assess extends OmniStudioBaseCommand {
       assesmentInfo.apexAssessmentInfos = relatedObjectAssessmentResult.apexAssessmentInfos;
     }
 
-    await AssessmentReporter.generate(assesmentInfo, conn.instanceUrl, orgs);
+    await AssessmentReporter.generate(assesmentInfo, conn.instanceUrl, orgs, assessOnly, objectsToProcess);
     return assesmentInfo;
   }
 
@@ -125,16 +131,16 @@ export default class Assess extends OmniStudioBaseCommand {
     }
 
     switch (assessOnly) {
-      case 'dr':
+      case Constants.DataMapper:
         await this.assessDataRaptors(assesmentInfo, namespace, conn);
         break;
-      case 'fc':
+      case Constants.Flexcard:
         await this.assessFlexCards(assesmentInfo, namespace, conn, allVersions);
         break;
-      case 'os':
+      case Constants.Omniscript:
         await this.assessOmniScripts(assesmentInfo, namespace, conn, allVersions, OmniScriptExportType.OS);
         break;
-      case 'ip':
+      case Constants.IntegrationProcedure:
         await this.assessOmniScripts(assesmentInfo, namespace, conn, allVersions, OmniScriptExportType.IP);
         break;
       default:

src/commands/omnistudio/migration/migrate.ts

@@ -22,6 +22,7 @@ import { Logger } from '../../../utils/logger';
 import OmnistudioRelatedObjectMigrationFacade from '../../../migration/related/OmnistudioRelatedObjectMigrationFacade';
 import { generatePackageXml } from '../../../utils/generatePackageXml';
 import { OmnistudioOrgDetails, OrgUtils } from '../../../utils/orgUtils';
+import { Constants } from '../../../utils/constants/stringContants';
 
 // Initialize Messages with the current plugin directory
 Messages.importMessagesDirectory(__dirname);
@@ -59,7 +60,6 @@ export default class Migrate extends OmniStudioBaseCommand {
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   public async run(): Promise<any> {
-    const namespace = (this.flags.namespace || 'vlocity_ins') as string;
     const apiVersion = (this.flags.apiversion || '55.0') as string;
     const migrateOnly = (this.flags.only || '') as string;
     const allVersions = this.flags.allversions || false;
@@ -71,25 +71,30 @@ export default class Migrate extends OmniStudioBaseCommand {
     const conn = this.org.getConnection();
     conn.setApiVersion(apiVersion);
 
-    const orgs: OmnistudioOrgDetails = await OrgUtils.getOrgDetails(conn, namespace);
+    const orgs: OmnistudioOrgDetails = await OrgUtils.getOrgDetails(conn, this.flags.namespace);
 
-    if (orgs.packageDetails.length === 0) {
-      this.ux.log('No package installed on given org.');
+    if (!orgs.hasValidNamespace) {
+      this.ux.warn(messages.getMessage('invalidNamespace') + orgs.packageDetails.namespace);
+    }
+
+    if (!orgs.packageDetails) {
+      this.ux.error(messages.getMessage('noPackageInstalled'));
       return;
     }
 
     if (orgs.omniStudioOrgPermissionEnabled) {
-      this.ux.log('The org is already on standard data model.');
+      this.ux.error(messages.getMessage('alreadyStandardModel'));
       return;
     }
 
+    const namespace = orgs.packageDetails.namespace;
     // Let's time every step
     DebugTimer.getInstance().start();
     let projectPath: string;
     let objectsToProcess: string[] = [];
     let targetApexNamespace: string;
     if (relatedObjects) {
-      const validOptions = ['apex', 'lwc'];
+      const validOptions = [Constants.Apex, Constants.LWC];
       objectsToProcess = relatedObjects.split(',').map((obj) => obj.trim());
       // Validate input
       for (const obj of objectsToProcess) {
@@ -207,7 +212,7 @@ export default class Migrate extends OmniStudioBaseCommand {
       ];
     } else {
       switch (migrateOnly) {
-        case 'os':
+        case Constants.Omniscript:
           migrationObjects.push(
             new OmniScriptMigrationTool(
               OmniScriptExportType.OS,
@@ -220,7 +225,7 @@ export default class Migrate extends OmniStudioBaseCommand {
             )
           );
           break;
-        case 'ip':
+        case Constants.IntegrationProcedure:
           migrationObjects.push(
             new OmniScriptMigrationTool(
               OmniScriptExportType.IP,
@@ -233,10 +238,10 @@ export default class Migrate extends OmniStudioBaseCommand {
             )
           );
           break;
-        case 'fc':
+        case Constants.Flexcard:
           migrationObjects.push(new CardMigrationTool(namespace, conn, this.logger, messages, this.ux, allVersions));
           break;
-        case 'dr':
+        case Constants.DataMapper:
           migrationObjects.push(new DataRaptorMigrationTool(namespace, conn, this.logger, messages, this.ux));
           break;
         default:
@@ -262,7 +267,7 @@ export default class Migrate extends OmniStudioBaseCommand {
   }
 
   private async getTargetApexNamespace(objectsToProcess: string[], targetApexNamespace: string): Promise<string> {
-    if (objectsToProcess.includes('apex')) {
+    if (objectsToProcess.includes(Constants.Apex)) {
       targetApexNamespace = await this.ux.prompt(
         'Enter the target namespace to be used for calling package Apex classes'
       );

src/javascripts/reportGeneratorUtility.js

@@ -110,6 +110,22 @@ function filterAndSearchTable(tableId) {
   }`;
 }
 
+function toggleCtaSummaryPanel() {
+        const panel = document.getElementById('cta-summary-panel');
+        const main = document.getElementById('main-panel');
+        const wrapper = document.getElementById('scrollable-wrapper');
+
+        const isVisible = panel.classList.contains('visible');
+        panel.classList.toggle('visible');
+        main.classList.toggle('shrunk');
+
+        // Ensure smooth scroll into view when opened
+        if (!isVisible) {
+          setTimeout(() => {
+            wrapper.scrollLeft = wrapper.scrollWidth;
+          }, 200); // wait for transition
+        }
+      }
 function hideOrShowData(reportTable, rowClass, show) {
   const rows = Array.from(reportTable.querySelectorAll(`.${rowClass}`));
   rows.forEach((row) => {
@@ -145,3 +161,4 @@ document.addEventListener('DOMContentLoaded', () => {
 // Expose globally so HTML inline event handlers can access them
 window.toggleFilterDropdown = toggleFilterDropdown;
 window.filterAndSearchTable = filterAndSearchTable;
+window.toggleCtaSummaryPanel = toggleCtaSummaryPanel;

src/migration/related/ApexMigration.ts

@@ -18,6 +18,7 @@ import { Logger } from '../../utils/logger';
 import { ApexAssessmentInfo } from '../../utils';
 import { FileDiffUtil } from '../../utils/lwcparser/fileutils/FileDiffUtil';
 import { Stringutil } from '../../utils/StringValue/stringutil';
+import { Constants } from '../../utils/constants/stringContants';
 import { BaseRelatedObjectMigration } from './BaseRealtedObjectMigration';
 
 const APEXCLASS = 'Apexclass';
@@ -39,7 +40,7 @@ export class ApexMigration extends BaseRelatedObjectMigration {
     this.vlocityOpenInterface = new InterfaceImplements(VLOCITY_OPEN_INTERFACE, this.namespace);
   }
   public processObjectType(): string {
-    return 'apex';
+    return Constants.Apex;
   }
   // public identifyObjects(migrationResults: MigrationResult[]): Promise<JSON[]> {
   //   throw new Error('Method not implemented.');

src/migration/related/LwcMigration.ts

@@ -6,14 +6,15 @@ import { sfProject } from '../../utils/sfcli/project/sfProject';
 import { Logger } from '../../utils/logger';
 import { FileProcessorFactory } from '../../utils/lwcparser/fileutils/FileProcessorFactory';
 import { FileChangeInfo, LWCAssessmentInfo } from '../../utils';
+import { Constants } from '../../utils/constants/stringContants';
 import { BaseRelatedObjectMigration } from './BaseRealtedObjectMigration';
 
 const LWC_DIR_PATH = '/force-app/main/default/lwc';
 const LWCTYPE = 'LightningComponentBundle';
 
 export class LwcMigration extends BaseRelatedObjectMigration {
   public processObjectType(): string {
-    return 'lwc';
+    return Constants.LWC;
   }
   // public identifyObjects(migrationResults: MigrationResult[]): Promise<JSON[]> {
   //   this.assessment();
@@ -65,7 +66,7 @@ export class LwcMigration extends BaseRelatedObjectMigration {
       fileMap.forEach((fileList, dir) => {
         const changeInfos: FileChangeInfo[] = [];
         if (
-          dir !== 'lwc' &&
+          dir !== Constants.LWC &&
           !dir.endsWith('MultiLanguage') &&
           !dir.endsWith('English') &&
           !dir.includes('_') &&