refactor: typing improvements

Signed-off-by: Pedro Lamas <[email protected]>

Author: pedrolamas

src/components/widgets/job-queue/JobQueueMultiplyJobDialog.vue

@@ -25,7 +25,6 @@
 <script lang="ts">
 import { Component, Vue, VModel, Prop } from 'vue-property-decorator'
 import type { QueuedJob } from '@/store/jobQueue/types'
-import { isArray } from 'lodash-es'
 
 @Component({})
 export default class JobQueueMultiplyJobDialog extends Vue {
@@ -38,7 +37,7 @@ export default class JobQueueMultiplyJobDialog extends Vue {
   readonly job!: QueuedJob | QueuedJob[]
 
   get jobCount () {
-    return isArray(this.job)
+    return Array.isArray(this.job)
       ? this.job.length
       : 1
   }

src/store/chart_helpers.ts

@@ -3,7 +3,7 @@ import type { RootState } from './types'
 import type { ChartData } from './charts/types'
 import type { KlipperPrinterMcuState, KlipperPrinterState, KlipperPrinterSystemStatsState } from './printer/types'
 
-export const handleMcuStatsChange = (payload: KlipperPrinterState, state: RootState, commit: Commit) => {
+export const handleMcuStatsChange = (payload: Partial<KlipperPrinterState>, state: RootState, commit: Commit) => {
   for (const key in payload) {
     if (key.startsWith('mcu')) {
       // Combine existing with the update.
@@ -60,7 +60,7 @@ export const handleMcuStatsChange = (payload: KlipperPrinterState, state: RootSt
   }
 }
 
-export const handleSystemStatsChange = (payload: KlipperPrinterState, state: RootState, commit: Commit) => {
+export const handleSystemStatsChange = (payload: Partial<KlipperPrinterState>, state: RootState, commit: Commit) => {
   if (payload.system_stats != null) {
     // Combine existing with the update.
     const stats: KlipperPrinterSystemStatsState = {

src/store/helpers.ts

@@ -8,7 +8,7 @@ import getFilePaths from '@/util/get-file-paths'
 
 const isTmc = (item: string): item is TmcKey => /^tmc\d{4} /.test(item)
 
-export const handleTrinamicDriversChange = (payload: KlipperPrinterState, state: RootState, dispatch: Dispatch, getters: any) => {
+export const handleTrinamicDriversChange = (payload: Partial<KlipperPrinterState>, state: RootState, dispatch: Dispatch, getters: any) => {
   for (const item in payload) {
     if (
       isTmc(item) &&
@@ -37,7 +37,7 @@ export const handleTrinamicDriversChange = (payload: KlipperPrinterState, state:
   }
 }
 
-export const handlePrintStateChange = (payload: KlipperPrinterState, state: RootState, dispatch: Dispatch) => {
+export const handlePrintStateChange = (payload: Partial<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.
@@ -66,7 +66,7 @@ export const handlePrintStateChange = (payload: KlipperPrinterState, state: Root
   }
 }
 
-export const handleCurrentFileChange = (payload: KlipperPrinterState, state: RootState) => {
+export const handleCurrentFileChange = (payload: Partial<KlipperPrinterState>, state: RootState) => {
   if (
     payload.print_stats?.filename &&
     payload.print_stats.filename !== state.printer.printer.print_stats?.filename

src/store/printer/actions.ts

@@ -200,7 +200,7 @@ export const actions = {
    */
 
   /** Automated notify events via socket */
-  async onNotifyStatusUpdate ({ rootState, commit, getters, dispatch }, payload: KlipperPrinterState) {
+  async onNotifyStatusUpdate ({ rootState, commit, getters, dispatch }, payload: Partial<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

src/store/printer/mutations.ts

@@ -1,8 +1,7 @@
 import Vue from 'vue'
 import type { MutationTree } from 'vuex'
-import type { PrinterState } from './types'
+import type { KlipperPrinterState, PrinterState } from './types'
 import { defaultState } from './state'
-import { get } from 'lodash-es'
 
 export const mutations = {
   /**
@@ -62,28 +61,22 @@ export const mutations = {
     }
   },
 
-  setSocketNotify (state, payload) {
-    if (typeof payload.payload === 'object') {
-      const o = get(state.printer, payload.key)
-      if (o === undefined) {
-        // Object is not set yet, so create it.
-        Vue.set(state.printer, payload.key, payload.payload)
-      } else {
-        Object.keys(payload.payload).forEach((p) => {
-          // Leaving the if here, although it should
-          // always evaluate true since we never
-          // get an update unless something has changed.
-          if (
-            o[p] !== payload.payload[p]
-          ) {
-            Vue.set(state.printer[payload.key], p, payload.payload[p])
-          }
-        })
-      }
+  setSocketNotify<T extends keyof KlipperPrinterState> (state: PrinterState, payload: { key: T, payload: KlipperPrinterState[T] }) {
+    const { key: payloadKey, payload: payloadValue } = payload
+
+    const stateObject = state.printer[payloadKey]
+
+    if (stateObject == null) {
+      // Object is not set yet, so create it.
+      Vue.set(state.printer, payloadKey, payloadValue)
     } else {
-      // I don't think this'd get called.
-      if (get(state.printer, payload.key) !== payload.payload) {
-        Vue.set(state.printer, payload.key, payload.payload)
+      for (const key in payloadValue) {
+        // Leaving the if here, although it should
+        // always evaluate true since we never
+        // get an update unless something has changed.
+        if (stateObject[key] !== payloadValue[key]) {
+          Vue.set(stateObject, key, payloadValue[key])
+        }
       }
     }
   }

src/store/printer/types.ts

@@ -603,110 +603,111 @@ export interface KlipperPrinterBeaconState {
 export interface KlipperPrinterConfig extends Record<string, Record<string, string | undefined> | undefined> {
 }
 
-type KlipperPrinterSettingsBaseType = {
-  [key in ExtruderKey]?: KlipperPrinterExtruderSettings
-}
+type KlipperPrinterSettingsBaseType =
+  Partial<{
+    [key in ExtruderKey]: KlipperPrinterExtruderSettings;
+  } & {
+    mcu: KlipperPrinterMcuSettings;
 
-export interface KlipperPrinterSettings extends KlipperPrinterSettingsBaseType {
-  [key: string]: Record<string, any> | undefined;
+    [key: `mcu ${Lowercase<string>}`]: KlipperPrinterMcuSettings;
 
-  mcu?: KlipperPrinterMcuSettings;
+    [key: Lowercase<TmcKey>]: KlipperPrinterTmcSettings;
 
-  [key: `mcu ${Lowercase<string>}`]: KlipperPrinterMcuSettings | undefined;
+    fan: KlipperPrinterFanSettings;
 
-  [key: Lowercase<TmcKey>]: KlipperPrinterTmcSettings;
+    [key: `heater_fan ${Lowercase<string>}`]: KlipperPrinterHeaterFanSettings;
 
-  fan?: KlipperPrinterFanSettings;
+    [key: `controller_fan ${Lowercase<string>}`]: KlipperPrinterControllerFanSettings;
 
-  [key: `heater_fan ${Lowercase<string>}`]: KlipperPrinterHeaterFanSettings | undefined;
+    [key: `gcode_button ${string}`]: KlipperPrinterGcodeButtonSettings;
 
-  [key: `controller_fan ${Lowercase<string>}`]: KlipperPrinterControllerFanSettings | undefined;
+    [key: `output_pin ${Lowercase<string>}`]: KlipperPrinterOutputPinSettings;
 
-  [key: `gcode_button ${string}`]: KlipperPrinterGcodeButtonSettings | undefined;
+    [key: `${'led' | 'neopixel' | 'dotstar' | 'pca9533' | 'pca9632'} ${Lowercase<string>}`]: KlipperPrinterLedSettings;
 
-  [key: `output_pin ${Lowercase<string>}`]: KlipperPrinterOutputPinSettings | undefined;
+    [key: `temperature_sensor ${Lowercase<string>}`]: KlipperPrinterTemperatureSensorSettings;
 
-  [key: `${'led' | 'neopixel' | 'dotstar' | 'pca9533' | 'pca9632'} ${Lowercase<string>}`]: KlipperPrinterLedSettings | undefined;
+    safe_z_home: KlipperPrinterSafeZHomeSettings;
 
-  [key: `temperature_sensor ${Lowercase<string>}`]: KlipperPrinterTemperatureSensorSettings | undefined;
+    z_tilt: KlipperPrinterZTiltSettings;
 
-  safe_z_home?: KlipperPrinterSafeZHomeSettings;
+    bed_mesh: KlipperPrinterBedMeshSettings;
 
-  z_tilt?: KlipperPrinterZTiltSettings;
+    board_pins: KlipperPrinterBoardPinsSettings;
 
-  bed_mesh?: KlipperPrinterBedMeshSettings;
+    [key: `bed_mesh ${Lowercase<string>}`]: KlipperPrinterBedMeshModelSettings;
 
-  board_pins?: KlipperPrinterBoardPinsSettings;
+    bed_screws: KlipperPrinterBedScrewsSettings;
 
-  [key: `bed_mesh ${Lowercase<string>}`]: KlipperPrinterBedMeshModelSettings | undefined;
+    screws_tilt_adjust: KlipperPrinterScrewsTiltAdjustSettings;
 
-  bed_screws?: KlipperPrinterBedScrewsSettings;
+    firmware_retraction: KlipperPrinterFirmwareRetractionSettings;
 
-  screws_tilt_adjust?: KlipperPrinterScrewsTiltAdjustSettings;
+    force_move: KlipperPrinterForceMoveSettings;
 
-  firmware_retraction?: KlipperPrinterFirmwareRetractionSettings;
+    gcode_arcs: KlipperPrinterGcodeArcsSettings;
 
-  force_move?: KlipperPrinterForceMoveSettings;
+    respond: KlipperPrinterRespondSettings;
 
-  gcode_arcs?: KlipperPrinterGcodeArcsSettings;
+    virtual_sdcard: KlipperPrinterVirtualSdcardSettings;
 
-  respond?: KlipperPrinterRespondSettings;
+    pause_resume: KlipperPrinterPauseResumeSettings;
 
-  virtual_sdcard?: KlipperPrinterVirtualSdcardSettings;
+    delta_calibrate: KlipperPrinterDeltaCalibrateSettings;
 
-  pause_resume?: KlipperPrinterPauseResumeSettings;
+    [key: `gcode_macro ${Lowercase<string>}`]: KlipperPrinterGcodeMacroSettings;
 
-  delta_calibrate?: KlipperPrinterDeltaCalibrateSettings;
+    heater_bed: KlipperPrinterHeaterBedSettings;
 
-  [key: `gcode_macro ${Lowercase<string>}`]: KlipperPrinterGcodeMacroSettings | undefined;
+    [key: `verify_heater ${Lowercase<string>}`]: KlipperPrinterVerifyHeaterSettings;
 
-  heater_bed?: KlipperPrinterHeaterBedSettings;
+    probe: KlipperPrinterProbeSettings;
 
-  [key: `verify_heater ${Lowercase<string>}`]: KlipperPrinterVerifyHeaterSettings | undefined;
+    bltouch: KlipperPrinterBltouchSettings;
 
-  probe?: KlipperPrinterProbeSettings;
+    smart_effector: KlipperPrinterSmartEffectorSettings;
 
-  bltouch?: KlipperPrinterBltouchSettings;
+    [key: `probe_eddy_current ${Lowercase<string>}`]: KlipperPrinterProbeEddyCurrentSettings;
 
-  smart_effector?: KlipperPrinterSmartEffectorSettings;
+    input_shaper: KlipperPrinterInputShaperSettings;
 
-  [key: `probe_eddy_current ${Lowercase<string>}`]: KlipperPrinterProbeEddyCurrentSettings | undefined;
+    printer: KlipperPrinterPrinterSettings;
 
-  input_shaper?: KlipperPrinterInputShaperSettings;
+    [key: `stepper_${Lowercase<string>}`]: KlipperPrinterStepperSettings;
 
-  printer?: KlipperPrinterPrinterSettings;
+    [key: `extruder_stepper ${Lowercase<string>}`]: KlipperPrinterExtruderStepperSettings;
 
-  [key: `stepper_${Lowercase<string>}`]: KlipperPrinterStepperSettings | undefined;
+    idle_timeout: KlipperPrinterIdleTimeoutSettings;
 
-  [key: `extruder_stepper ${Lowercase<string>}`]: KlipperPrinterExtruderStepperSettings | undefined;
+    exclude_object: KlipperPrinterExcludeObjectSettings;
 
-  idle_timeout?: KlipperPrinterIdleTimeoutSettings;
+    [key: `endstop_phase ${Lowercase<string>}`]: KlipperPrinterEndstopPhaseSettings;
 
-  exclude_object?: KlipperPrinterExcludeObjectSettings;
+    [key: `display_template ${Lowercase<string>}`]: KlipperPrinterDisplayTemplateSettings;
 
-  [key: `endstop_phase ${Lowercase<string>}`]: KlipperPrinterEndstopPhaseSettings | undefined;
+    load_cell: KlipperPrinterLoadCellSettings;
 
-  [key: `display_template ${Lowercase<string>}`]: KlipperPrinterDisplayTemplateSettings | undefined;
+    [key: `load_cell ${Lowercase<string>}`]: KlipperPrinterLoadCellSettings;
 
-  load_cell?: KlipperPrinterLoadCellSettings;
+    // These keys are for kalico modules
 
-  [key: `load_cell ${Lowercase<string>}`]: KlipperPrinterLoadCellSettings | undefined;
+    danger_options: KalicoPrinterDangerOptionsSettings;
 
-  // These keys are for kalico modules
+    constants: KalicoPrinterConstantsSettings;
 
-  danger_options?: KalicoPrinterDangerOptionsSettings;
+    z_calibration: KalicoPrinterZCalibrationSettings;
 
-  constants?: KalicoPrinterConstantsSettings;
+    z_tilt_ng: KalicoPrinterZTiltNgSettings;
 
-  z_calibration?: KalicoPrinterZCalibrationSettings;
+    // These keys are for external modules
 
-  z_tilt_ng?: KalicoPrinterZTiltNgSettings;
+    beacon: KlipperPrinterBeaconSettings;
 
-  // These keys are for external modules
-
-  beacon?: KlipperPrinterBeaconSettings;
+    [key: `beacon model ${Lowercase<string>}`]: KlipperPrinterBeaconModelSettings;
+  }>
 
-  [key: `beacon model ${Lowercase<string>}`]: KlipperPrinterBeaconModelSettings | undefined;
+export interface KlipperPrinterSettings extends KlipperPrinterSettingsBaseType {
+  [key: string]: Record<string, any> | undefined;
 }
 
 export interface KlipperPrinterMcuSettings {