chore: improve types

IDEMSInternational · Sep 19, 2024 · c374ccc · c374ccc
1 parent 7ca238b
commit c374ccc
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 27 deletions.
diff --git a/packages/scripts/src/commands/app-data/convert/report/report.types.ts b/packages/scripts/src/commands/app-data/convert/report/report.types.ts
@@ -8,7 +8,7 @@ interface IReportBase {
   title: string;
 }
 
-interface IReportTable extends IReportBase {
+export interface IReportTable extends IReportBase {
   data: Record<string, any>[];
   type: "table";
 }

diff --git a/packages/scripts/src/commands/app-data/convert/report/reporters/flows-by-type.ts b/packages/scripts/src/commands/app-data/convert/report/reporters/flows-by-type.ts
@@ -1,5 +1,15 @@
 import { IParsedWorkbookData } from "../../types";
-import { IReport } from "../report.types";
+import { IReportTable } from "../report.types";
+
+interface IReportData {
+  type: string;
+  subtype: string;
+  total: number;
+}
+
+interface IFlowByTypeReport extends IReportTable {
+  data: IReportData[];
+}
 
 /** Generate a list of all flows by type and subtype */
 export class FlowByTypeReport {
@@ -13,22 +23,20 @@ export class FlowByTypeReport {
         countBySubtype[type]++;
       });
     });
-    const summary = Object.keys(countBySubtype)
+    const summary: IReportData[] = Object.keys(countBySubtype)
       .sort()
       .map((key) => {
         const [type, subtype] = key.split(".");
         return { type, subtype: subtype || null, total: countBySubtype[key] };
       });
 
-    const reports: Record<"flows_by_type", IReport> = {
-      flows_by_type: {
-        type: "table",
-        title: "Flows By Type",
-        level: "info",
-        data: summary,
-      },
+    const flows_by_type: IFlowByTypeReport = {
+      type: "table",
+      title: "Flows By Type",
+      level: "info",
+      data: summary,
     };
 
-    return reports;
+    return { flows_by_type };
   }
 }
diff --git a/packages/scripts/src/commands/app-data/convert/report/reporters/template-summary.ts b/packages/scripts/src/commands/app-data/convert/report/reporters/template-summary.ts
@@ -2,7 +2,16 @@ import { FlowTypes } from "data-models";
 import { sortJsonKeys } from "shared/src/utils";
 
 import { IParsedWorkbookData } from "../../types";
-import { IReport } from "../report.types";
+import { IReportTable } from "../report.types";
+
+interface IReportData {
+  type: string;
+  count: number;
+}
+
+interface ITemplateSummaryReport extends IReportTable {
+  data: IReportData[];
+}
 
 interface ITemplateSummary {
   components: Record<string, { count: number }>;
@@ -35,26 +44,24 @@ export class TemplateSummaryReport {
       }
     }
 
-    const reports: Record<"template_components" | "template_actions", IReport> = {
-      template_components: {
-        type: "table",
-        title: "Components",
-        level: "info",
-        data: this.getReportData(this.summary.components),
-      },
-      template_actions: {
-        type: "table",
-        title: "Actions",
-        level: "info",
-        data: this.getReportData(this.summary.actions),
-      },
+    const template_components: ITemplateSummaryReport = {
+      type: "table",
+      title: "Components",
+      level: "info",
+      data: this.getReportData(this.summary.components),
+    };
+    const template_actions: ITemplateSummaryReport = {
+      type: "table",
+      title: "Actions",
+      level: "info",
+      data: this.getReportData(this.summary.actions),
     };
 
-    return reports;
+    return { template_components, template_actions };
   }
 
   /** Convert type records to array for report */
-  private getReportData(data: Record<string, { count: number }>) {
+  private getReportData(data: Record<string, { count: number }>): IReportData[] {
     const sorted = sortJsonKeys(data);
     return Object.entries(sorted).map(([type, { count }]) => ({ type, count }));
   }