refactor: typing improvements

pedrolamas · pedrolamas · commit b0bc76d5192a · 2025-02-13T21:21:24.000Z
Signed-off-by: Pedro Lamas &lt;pedrolamas@gmail.com&gt;
diff --git a/src/store/chart_helpers.ts b/src/store/chart_helpers.ts
@@ -1,21 +1,18 @@
 import type { Commit } from 'vuex'
 import type { RootState } from './types'
 import type { ChartData } from './charts/types'
+import type { KlipperPrinterMcuState, KlipperPrinterState, KlipperPrinterSystemStatsState } from './printer/types'
 
-export const handleMcuStatsChange = (payload: any, state: RootState, commit: Commit) => {
-  const keys = Object.keys(payload).filter(key => key.startsWith('mcu'))
-  if (keys.length > 0) {
-    keys.forEach(key => {
-      // swap underscores for spaces.
-      // const name = key.replace(' ', '_')
-
+export const handleMcuStatsChange = (payload: KlipperPrinterState, state: RootState, commit: Commit) => {
+  for (const key in Object.keys(payload)) {
+    if (key.startsWith('mcu')) {
       // Combine existing with the update.
-      const stats = {
+      const stats: KlipperPrinterMcuState = {
         ...state.printer.printer[key],
         ...payload[key]
       }
 
-      if (stats.last_stats) {
+      if (stats.last_stats != null) {
         // Datestamp for this chart entry.
         const date = new Date()
 
@@ -59,16 +56,14 @@ export const handleMcuStatsChange = (payload: any, state: RootState, commit: Com
           }
         }, { root: true })
       }
-    })
+    }
   }
 }
 
-export const handleSystemStatsChange = (payload: any, state: RootState, commit: Commit) => {
-  if (
-    'system_stats' in payload
-  ) {
+export const handleSystemStatsChange = (payload: KlipperPrinterState, state: RootState, commit: Commit) => {
+  if (payload.system_stats != null) {
     // Combine existing with the update.
-    const stats = {
+    const stats: KlipperPrinterSystemStatsState = {
       ...state.printer.printer.system_stats,
       ...payload.system_stats
     }
@@ -78,10 +73,10 @@ export const handleSystemStatsChange = (payload: any, state: RootState, commit:
 
     // Add an entry for the memory graph.
     if (
-      'memavail' in stats &&
+      stats.memavail != null &&
       state.server.system_info?.cpu_info?.total_memory
     ) {
-      const total_memory = state.server.system_info?.cpu_info?.total_memory || 0
+      const total_memory = state.server.system_info.cpu_info.total_memory || 0
       const mem_used = total_memory - stats.memavail
       const percent_mem_used = Math.ceil(mem_used / total_memory * 100)
 
@@ -98,8 +93,8 @@ export const handleSystemStatsChange = (payload: any, state: RootState, commit:
 
     // Add an entry for the cpu time and sysload.
     if (
-      'cputime' in stats &&
-      'sysload' in stats
+      stats.cputime != null &&
+      stats.sysload != null
     ) {
       const cputime = stats.cputime
       const last_cputime = state.printer.printer.system_stats?.cputime || stats.cputime || 0
diff --git a/src/store/helpers.ts b/src/store/helpers.ts
@@ -3,17 +3,18 @@ import type { RootState } from './types'
 import { SocketActions } from '@/api/socketActions'
 import type { AppPushNotification } from './notifications/types'
 import i18n from '@/plugins/i18n'
-import type { KlippyApp } from './printer/types'
+import type { KlipperPrinterState, KlippyApp, TmcKey } from './printer/types'
 
-export const handleTrinamicDriversChange = (payload: any, state: RootState, dispatch: Dispatch, getters: any) => {
-  for (const item in payload) {
-    const [type, nameFromSplit] = item.split(' ', 2)
+const isTmc = (item: string): item is TmcKey => /^tmc\d{4} /.test(item)
 
+export const handleTrinamicDriversChange = (payload: KlipperPrinterState, state: RootState, dispatch: Dispatch, getters: any) => {
+  for (const item in payload) {
     if (
-      /^tmc\d{4}$/.test(type) &&
+      isTmc(item) &&
       payload[item]?.drv_status?.otpw != null &&
       state.printer.printer?.[item]?.drv_status?.otpw == null
     ) {
+      const [, nameFromSplit] = item.split(' ', 2)
       const name = nameFromSplit ?? item
 
       const klippyApp: KlippyApp = getters.getKlippyApp
@@ -35,14 +36,11 @@ export const handleTrinamicDriversChange = (payload: any, state: RootState, disp
   }
 }
 
-export const handlePrintStateChange = (payload: any, state: RootState, dispatch: Dispatch) => {
+export const handlePrintStateChange = (payload: KlipperPrinterState, state: RootState, dispatch: Dispatch) => {
   // For every notify - if print_stats.state changes from standby -> printing,
   // then record an entry in our print history.
   // If the state changes from printing -> complete, then record the finish time.
-  if (
-    'print_stats' in payload &&
-    'state' in payload.print_stats
-  ) {
+  if (payload.print_stats?.state != null) {
     const currentPrintState = state.printer.printer.print_stats?.state
 
     if (
@@ -67,11 +65,9 @@ export const handlePrintStateChange = (payload: any, state: RootState, dispatch:
   }
 }
 
-export const handleCurrentFileChange = (payload: any, state: RootState) => {
+export const handleCurrentFileChange = (payload: KlipperPrinterState, state: RootState) => {
   if (
-    'print_stats' in payload &&
-    'filename' in payload.print_stats &&
-    payload.print_stats.filename &&
+    payload.print_stats?.filename &&
     payload.print_stats.filename !== state.printer.printer.print_stats?.filename
   ) {
     // This refreshes the metadata for the current file, which also
diff --git a/src/store/printer/actions.ts b/src/store/printer/actions.ts
@@ -1,5 +1,5 @@
 import type { ActionTree } from 'vuex'
-import type { KlippyApp, PrinterState } from './types'
+import type { KlipperPrinterState, KlippyApp, PrinterState } from './types'
 import type { RootState } from '../types'
 import { handlePrintStateChange, handleCurrentFileChange, handleTrinamicDriversChange } from '../helpers'
 import { handleAddChartEntry, handleSystemStatsChange, handleMcuStatsChange } from '../chart_helpers'
@@ -144,16 +144,21 @@ export const actions: ActionTree<PrinterState, RootState> = {
     SocketActions.printerObjectsSubscribe(intendedSubscriptions)
   },
 
-  async onPrinterObjectsSubscribe ({ commit, dispatch }, payload) {
+  async onPrinterObjectsSubscribe ({ commit, dispatch }, payload: { status: KlipperPrinterState }) {
     // Initial printer status
     const status = payload.status
 
-    if ('screws_tilt_adjust' in status) {
-      status.screws_tilt_adjust = {}
+    if (status.screws_tilt_adjust != null) {
+      status.screws_tilt_adjust = {
+        ...status.screws_tilt_adjust,
+        error: false,
+        max_deviation: null,
+        results: {}
+      }
     }
 
-    if ('toolhead' in status) {
-      if ('max_accel_to_decel' in status.toolhead) {
+    if (status.toolhead != null) {
+      if (status.toolhead.max_accel_to_decel != null) {
         status.toolhead.minimum_cruise_ratio = null
       } else {
         status.toolhead.max_accel_to_decel = null
@@ -178,7 +183,7 @@ export const actions: ActionTree<PrinterState, RootState> = {
    */
 
   /** Automated notify events via socket */
-  async onNotifyStatusUpdate ({ rootState, commit, getters, dispatch }, payload) {
+  async onNotifyStatusUpdate ({ rootState, commit, getters, dispatch }, payload: KlipperPrinterState) {
     // TODO: We potentially get many updates here.
     // Consider caching the updates and sending them every <interval>.
     // We don't want to miss an update - but also don't need all of them
diff --git a/src/store/printer/types.ts b/src/store/printer/types.ts
@@ -33,6 +33,8 @@ type Digit = '0' | NonZeroDigit
 
 export type ExtruderKey = 'extruder' | `extruder${NonZeroDigit}` | `extruder${NonZeroDigit}${Digit}`
 
+export type TmcKey = `tmc${'2130' | '2208' | '2209' | '2660' | '2240' | '5160'} ${string}`
+
 type KlipperPrinterStateBaseType = {
   [key in ExtruderKey]?: KlipperPrinterExtruderState
 }
@@ -136,7 +138,7 @@ export interface KlipperPrinterState extends KlipperPrinterStateBaseType {
 
   [key: `temperature_sensor ${string}`]: KlipperPrinterTemperatureSensorState;
 
-  [key: `tmc${'2130' | '2208' | '2209' | '2660' | '2240' | '5160'} ${string}`]: KlipperPrinterTmcState;
+  [key: TmcKey]: KlipperPrinterTmcState;
 
   dual_carriage?: KlipperDualCarriageState;
 
@@ -382,7 +384,7 @@ export interface KlipperPrinterMcuState {
   mcu_version?: string;
   mcu_build_versions?: string;
   mcu_constants?: Record<string, string | number>;
-  last_stats?: Record<string, string | number>;
+  last_stats?: Record<string, number>;
   app?: string;
   non_critical_disconnected?: boolean;
 }
@@ -476,7 +478,7 @@ export interface KlipperPrinterTmcState {
   phase_offset_position: number;
   run_current: number;
   hold_current: number;
-  drv_status: number | null;
+  drv_status: Record<string, number | null>;
   temperature: number | null;
 }
 
@@ -580,7 +582,7 @@ export interface KlipperPrinterSettings extends KlipperPrinterSettingsBaseType {
 
   [key: `mcu ${Lowercase<string>}`]: KlipperPrinterMcuSettings;
 
-  [key: `tmc${'2130' | '2208' | '2209' | '2660' | '2240' | '5160'} ${Lowercase<string>}`]: KlipperPrinterTmcSettings;
+  [key: Lowercase<TmcKey>]: KlipperPrinterTmcSettings;
 
   fan?: KlipperPrinterFanSettings;
 
