Feat: IP on boarding to reports framework (#277)

Author: sf-pranav-varshney

src/commands/omnistudio/migration/assess.ts

@@ -94,7 +94,8 @@ export default class Assess extends OmniStudioBaseCommand {
       flexCardAssessmentInfos,
       omniAssessmentInfo,
     };
-    await AssessmentReporter.generate(assesmentInfo, conn.instanceUrl);
+
+    await AssessmentReporter.generate(assesmentInfo, conn.instanceUrl, orgs);
     return assesmentInfo;
   }
 }

src/migration/omniscript.ts

@@ -307,6 +307,14 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
           : '') +
         `_${omniscript[this.namespacePrefix + 'Version__c']}`;
 
+        const oldName =
+        `${existingTypeVal.val}_` +
+        `${existingSubTypeVal.val}` +
+        (omniscript[this.namespacePrefix + 'Language__c']
+          ? `_${omniscript[this.namespacePrefix + 'Language__c']}`
+          : '') +
+        `_${omniscript[this.namespacePrefix + 'Version__c']}`;
+
       if (!existingTypeVal.isNameCleaned()) {
         warnings.push(
           this.messages.getMessage('changeMessage', [
@@ -342,12 +350,15 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
 
       if (omniProcessType === 'OmniScript') {
         const type = omniscript[this.namespacePrefix + 'IsLwcEnabled__c'] ? 'LWC' : 'Angular';
+        let migrationStatus = 'Can be Automated';
         if (type === 'Angular') {
           warnings.unshift(this.messages.getMessage('angularOSWarning'));
+          migrationStatus = 'Need Manual Intervention';
         }
         const osAssessmentInfo: OSAssessmentInfo = {
           name: recordName,
           type: type,
+          oldName: oldName,
           id: omniscript['Id'],
           dependenciesIP: dependencyIP,
           missingIP: [],
@@ -360,12 +371,14 @@ export class OmniScriptMigrationTool extends BaseMigrationTool implements Migrat
           infos: [],
           warnings: warnings,
           errors: [],
+          migrationStatus: migrationStatus
         };
         osAssessmentInfos.push(osAssessmentInfo);
       } else {
         const ipAssessmentInfo: IPAssessmentInfo = {
           name: recordName,
           id: omniscript['Id'],
+          oldName: oldName,
           dependenciesIP: dependencyIP,
           dependenciesDR: dependencyDR,
           dependenciesOS: dependencyOS,

src/styles/reportGenerator.css

@@ -101,9 +101,9 @@
 
 .slds-table td,
 .slds-table th {
-  white-space: normal;
   position: relative;
   max-width: 250px;
+  text-align: center;
 }
 
 .slds-table--bordered,

src/utils/interfaces.ts

@@ -25,10 +25,12 @@ export interface LWCAssessmentInfo {
 export interface OSAssessmentInfo {
   name: string;
   id: string;
+  oldName: string;
   dependenciesIP: nameLocation[];
   missingIP: string[];
   dependenciesDR: nameLocation[];
   missingDR: string[];
+  migrationStatus: string;
   dependenciesOS: nameLocation[];
   missingOS: string[];
   dependenciesRemoteAction: nameLocation[];
@@ -42,6 +44,7 @@ export interface OSAssessmentInfo {
 export interface IPAssessmentInfo {
   name: string;
   id: string;
+  oldName: string;
   dependenciesIP: nameLocation[];
   dependenciesDR: nameLocation[];
   dependenciesOS: nameLocation[];

src/utils/orgUtils/index.ts

@@ -10,9 +10,16 @@ interface InstalledPackage {
   Name: string;
 }
 
+interface OrgDetails {
+  Name: string;
+  Id: string;
+}
+
 export interface OmnistudioOrgDetails {
   packageDetails: PackageDetail[];
   omniStudioOrgPermissionEnabled: boolean;
+  orgDetails: OrgDetails;
+  dataModel: string;
 }
 
 export interface PackageDetail {
@@ -260,6 +267,15 @@ export class OrgUtils {
   // Define the object name for querying installed packages
   private static readonly objectName = 'Publisher';
 
+
+  // Define the fields to retrieve from the Organization object
+  private static readonly orgFields = ['Name'];
+
+  // Define the object name for querying installed packages
+  private static readonly orgObjectName = 'Organization';
+
+  private static readonly standardDataModel = "Standard";
+  private static readonly customDataModel = "Custom";
   /**
    * Fetches package details (version and namespace) for specific installed packages.
    *
@@ -269,7 +285,6 @@ export class OrgUtils {
   public static async getOrgDetails(connection: Connection, namespace: string): Promise<OmnistudioOrgDetails> {
     //Execute apex rest resource to get omnistudio org permission
     const omniStudioOrgPermissionEnabled: boolean = await this.isOmniStudioOrgPermissionEnabled(connection, namespace);
-
     // Query all installed packages and cast the result to InstalledPackage[]
     const allInstalledPackages = (await QueryTools.queryAll(
       connection,
@@ -278,6 +293,13 @@ export class OrgUtils {
       this.fields
     )) as unknown as InstalledPackage[];
 
+    const orgDetails = (await QueryTools.queryAll(
+      connection,
+      '',
+      this.orgObjectName,
+      this.orgFields
+    ))as unknown as OrgDetails;
+
     const packageDetails: PackageDetail[] = allInstalledPackages
       // Filter packages to only include those with a namespace in the predefined list
       .filter((pkg) => this.namespaces.has(pkg.NamespacePrefix))
@@ -290,6 +312,8 @@ export class OrgUtils {
     return {
       packageDetails: packageDetails,
       omniStudioOrgPermissionEnabled: omniStudioOrgPermissionEnabled,
+      orgDetails: orgDetails[0],
+      dataModel: omniStudioOrgPermissionEnabled ? this.standardDataModel : this.customDataModel
     };
   }
 

src/utils/reportGenerator/reportGenerator.ts

@@ -1,34 +1,35 @@
-import { Filter, ReportHeader, TableColumn, TableHeaderCell } from './reportInterfaces';
+import { Filter, HeaderColumn, ReportHeader, TableColumn, TableHeaderCell } from './reportInterfaces';
 
 export function generateHtmlTable<T>(
-  headerRows: TableHeaderCell[][],
+  headerRows: HeaderColumn[],
   columns: Array<TableColumn<T>>,
   rows: T[],
   reportHeader: ReportHeader[],
   filters: Filter[] = [],
   tableClass = 'slds-table slds-table_cell-buffer slds-table_bordered slds-table_striped slds-table_col-bordered',
   ariaLabel = ''
 ): string {
+  const transformedHeader: TableHeaderCell[][] = transform(headerRows);
+
   const thead = `
     <thead>
-      ${headerRows
+      ${transformedHeader
         .map(
           (row) => `
         <tr>
           ${row
-            .map(
-              (cell) => `
-              <th
-                ${cell.colspan ? `colspan="${cell.colspan}"` : ''}
-                ${cell.rowspan ? `rowspan="${cell.rowspan}"` : ''}
-                style="width:${cell?.width || 'auto'}"
-              >
-                <div class="filter-header">
-                  <span class="filter-label">${cell.label}</span>
-                </div>
-              </th>
-            `
-            )
+            .map((cell: TableHeaderCell) => {
+              const colspanAttr = cell.colspan ? `colspan="${cell.colspan}"` : '';
+              const rowspanAttr = cell.rowspan ? `rowspan="${cell.rowspan}"` : '';
+              const styleAttr = `style="${cell.styles ?? 'width:auto;'}"`;
+              return `
+                <th ${colspanAttr} ${rowspanAttr} ${styleAttr}>
+                  <div class="filter-header">
+                    <span class="filter-label">${cell.label}</span>
+                  </div>
+                </th>
+              `;
+            })
             .join('')}
         </tr>
       `
@@ -58,7 +59,7 @@ export function generateHtmlTable<T>(
         oninput="filterAndSearchTable()"
       />
     </div>
-
+ 
     <div class="filter-toggle-button" onclick="toggleFilterDropdown()">
       Filters
       <svg id="chevron-down" class="chevron-icon" xmlns="http://www.w3.org/2000/svg" width="10" height="10" fill="currentColor" viewBox="0 0 16 16">
@@ -118,8 +119,9 @@ export function generateHtmlTable<T>(
               const title: string = col.title ? col.title(row) : '';
               const value: string = col.filterValue(row).toString();
               const cellContent: string = col.cell(row);
+              const style: string = col.styles ? col.styles(row) : '';
               const dataAttr: string = ['name', 'oldName'].includes(key) ? `data-name="${value.toLowerCase()}"` : '';
-              return `<td ${dataAttr} title="${title}" key="${key}" value="${value}">${cellContent}</td>`;
+              return `<td ${dataAttr} title="${title}" key="${key}" value="${value}" style="${style}">${cellContent}</td>`;
             })
             .join('')}
         </tr>
@@ -172,3 +174,35 @@ export function generateHtmlTable<T>(
     </div>
   `;
 }
+
+function transform(columnInput): TableHeaderCell[][] {
+  const row1 = [];
+  const row2 = [];
+
+  columnInput.forEach((item) => {
+    if (item.subColumn && item.subColumn.length > 0) {
+      row1.push({
+        label: item.label,
+        colspan: item.subColumn.length,
+      });
+
+      item.subColumn.forEach((sub) => {
+        row2.push({
+          label: sub.label,
+          key: sub.key,
+        });
+      });
+    } else {
+      const row1Entry: TableHeaderCell = {
+        label: item.label,
+      };
+
+      if (item.rowspan) row1Entry.rowspan = Number(item.rowspan);
+      if (item.key) row1Entry.key = item.key;
+
+      row1.push(row1Entry);
+    }
+  });
+
+  return [row1, row2] as unknown as TableHeaderCell[][];
+}

src/utils/reportGenerator/reportInterfaces.ts

@@ -1,17 +1,10 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-export interface TableHeaderCell {
-  label: string;
-  colspan?: number;
-  rowspan?: number;
-  key: string;
-  width?: string;
-}
-
 export interface TableColumn<T> {
   key: string;
   cell: any;
   filterValue: any;
   title?: any;
+  styles?: any;
 }
 
 export interface Filter {
@@ -24,3 +17,26 @@ export interface ReportHeader {
   key: string;
   value: string;
 }
+
+export interface ReportHeaderFormat {
+  key: string;
+  value: string;
+}
+
+export interface HeaderColumn {
+  label: string;
+  key?: string;
+  colspan?: number;
+  rowspan?: number;
+  styles?: string;
+  subColumn?: HeaderColumn[]; // Recursive definition
+}
+
+export interface TableHeaderCell {
+  label: string;
+  colspan?: number;
+  rowspan?: number;
+  key?: string;
+  width?: string;
+  styles?: string;
+}