refactor: typing improvements

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

Author: pedrolamas

src/mixins/files.ts

@@ -1,4 +1,4 @@
-import type { AppFile, FileUpload, AppFileThumbnail, KlipperFileMeta, FileDownload } from '@/store/files/types'
+import type { AppFile, FileUpload, AppFileThumbnail, MoonrakerFileMeta, FileDownload } from '@/store/files/types'
 import Vue from 'vue'
 import { Component } from 'vue-property-decorator'
 import type { AxiosRequestConfig, AxiosProgressEvent } from 'axios'
@@ -20,13 +20,13 @@ export default class FilesMixin extends Vue {
     return currentUser?.username === '_TRUSTED_USER_'
   }
 
-  getThumbUrl (meta: KlipperFileMeta, root: string, path: string, large: boolean, date?: number) {
+  getThumbUrl (meta: MoonrakerFileMeta, root: string, path: string, large: boolean, date?: number) {
     const thumb = this.getThumb(meta, root, path, large, date)
 
     return thumb?.url ?? ''
   }
 
-  getThumb (meta: KlipperFileMeta, root: string, path: string, large = true, date?: number): AppFileThumbnail | undefined {
+  getThumb (meta: MoonrakerFileMeta, root: string, path: string, large = true, date?: number): AppFileThumbnail | undefined {
     if (meta.thumbnails?.length) {
       const thumb = meta.thumbnails.reduce((a, b) => (a.size > b.size) === large ? a : b)
 

src/plugins/socketClient.ts

@@ -282,7 +282,7 @@ interface SocketPluginOptions {
 }
 
 export interface NotifyOptions {
-  params?: any;
+  params?: Record<string, any>;
   dispatch?: string;
   commit?: string;
   wait?: string;
@@ -292,15 +292,19 @@ interface Request {
   id: number;
   dispatch?: string;
   commit?: string;
-  params?: any;
+  params?: Record<string, any>;
   wait?: string;
 }
 
+export type ObjectWithRequest<T> = T & {
+  __request__: Request
+}
+
 interface SocketRequest {
   jsonrpc: string;
   id: number;
   method: string;
-  params?: any;
+  params?: Record<string, any>;
 }
 
 interface SocketResponse {

src/store/files/actions.ts

@@ -1,18 +1,19 @@
 import type { ActionTree } from 'vuex'
-import type { FilesState, KlipperFile, KlipperDir, FileChangeSocketResponse, KlipperFileWithMeta, DiskUsage, FileChangeItem, FilePaths } from './types'
+import type { FilesState, MoonrakerFile, MoonrakerDir, FileChange, MoonrakerFileWithMeta, FileChangeItem, FilePaths, DirectoryInformation } from './types'
 import type { RootState } from '../types'
 import getFilePaths from '@/util/get-file-paths'
 import { SocketActions } from '@/api/socketActions'
 import { Globals } from '@/globals'
+import type { ObjectWithRequest } from '@/plugins/socketClient'
 
-const itemAsKlipperFile = (item: FileChangeItem, paths: FilePaths): KlipperFile => ({
+const itemAsMoonrakerFile = (item: FileChangeItem, paths: FilePaths): MoonrakerFile => ({
   filename: paths.filename,
   modified: item.modified,
   size: item.size,
   permissions: item.permissions
 })
 
-const itemAsKlipperDir = (item: FileChangeItem, paths: FilePaths): KlipperDir => ({
+const itemAsMoonrakerDir = (item: FileChangeItem, paths: FilePaths): MoonrakerDir => ({
   dirname: paths.filename,
   modified: item.modified,
   size: item.size,
@@ -27,9 +28,9 @@ export const actions: ActionTree<FilesState, RootState> = {
     commit('setReset')
   },
 
-  async onServerFilesGetDirectory ({ commit }, payload: { disk_usage: DiskUsage; files: (KlipperFile | KlipperFileWithMeta)[]; dirs: KlipperDir[]; __request__: any }) {
-    const { disk_usage, files, dirs, __request__: request } = payload
-    const { path } = request.params
+  async onServerFilesGetDirectory ({ commit }, payload: ObjectWithRequest<DirectoryInformation>) {
+    const { disk_usage, files, dirs } = payload
+    const { path } = payload.__request__.params ?? {}
 
     const filteredDirs = dirs
       .filter(file =>
@@ -42,16 +43,16 @@ export const actions: ActionTree<FilesState, RootState> = {
     commit('setServerFilesGetDirectory', { path, content: { files, dirs: filteredDirs } })
   },
 
-  async onServerFilesListRoot ({ commit }, payload) {
-    const { root } = payload.__request__.params
+  async onServerFilesListRoot ({ commit }, payload: ObjectWithRequest<[]>) {
+    const { root } = payload.__request__.params ?? {}
 
     commit('setServerFilesListRoot', { root, files: [...payload] })
   },
 
   /**
    * If we request the metadata (a file..) then we load and update here.
    */
-  async onFileMetaData ({ commit }, payload: KlipperFileWithMeta) {
+  async onFileMetaData ({ commit }, payload: MoonrakerFileWithMeta) {
     const paths = getFilePaths(payload.filename, 'gcodes')
 
     if (!paths.filtered) {
@@ -69,17 +70,17 @@ export const actions: ActionTree<FilesState, RootState> = {
   async notifyUploadFile ({ dispatch }, payload) { dispatch('notifyCreateFile', payload) },
 
   // New notifications
-  async notifyRootUpdate ({ commit }, payload: FileChangeSocketResponse) {
+  async notifyRootUpdate ({ commit }, payload: FileChange) {
     const root = payload.item.root
 
     commit('setResetRoot', root)
 
     SocketActions.serverFilesGetDirectory(root)
   },
 
-  async notifyModifyFile ({ dispatch }, payload: FileChangeSocketResponse) { dispatch('notifyCreateFile', payload) },
+  async notifyModifyFile ({ dispatch }, payload: FileChange) { dispatch('notifyCreateFile', payload) },
 
-  async notifyCreateFile ({ commit, dispatch, rootState }, payload: FileChangeSocketResponse) {
+  async notifyCreateFile ({ commit, dispatch, rootState }, payload: FileChange) {
     const paths = getFilePaths(payload.item.path, payload.item.root)
 
     if (!paths.filtered) {
@@ -101,30 +102,30 @@ export const actions: ActionTree<FilesState, RootState> = {
         // For gcode files, get the metadata and the meta update will take care of the rest.
         SocketActions.serverFilesMetadata(paths.pathFilename)
       } else {
-        const file = itemAsKlipperFile(payload.item, paths)
+        const file = itemAsMoonrakerFile(payload.item, paths)
 
         commit('setFileUpdate', { paths, file })
       }
     }
   },
 
-  async notifyCreateDir ({ commit }, payload: FileChangeSocketResponse) {
+  async notifyCreateDir ({ commit }, payload: FileChange) {
     const paths = getFilePaths(payload.item.path, payload.item.root)
 
     if (!paths.filtered) {
-      const dir = itemAsKlipperDir(payload.item, paths)
+      const dir = itemAsMoonrakerDir(payload.item, paths)
 
       commit('setDirUpdate', { paths, dir })
     }
   },
 
-  async notifyMoveFile ({ commit }, payload: FileChangeSocketResponse) {
+  async notifyMoveFile ({ commit }, payload: FileChange) {
     const { item, source_item } = payload
 
     const paths = getFilePaths(item.path, item.root)
 
     if (!paths.filtered) {
-      const file = itemAsKlipperFile(payload.item, paths)
+      const file = itemAsMoonrakerFile(payload.item, paths)
 
       commit('setFileUpdate', { paths, file })
     }
@@ -138,13 +139,13 @@ export const actions: ActionTree<FilesState, RootState> = {
     }
   },
 
-  async notifyMoveDir ({ commit }, payload: FileChangeSocketResponse) {
+  async notifyMoveDir ({ commit }, payload: FileChange) {
     const { item, source_item } = payload
 
     const paths = getFilePaths(item.path, item.root)
 
     if (!paths.filtered) {
-      const dir = itemAsKlipperDir(payload.item, paths)
+      const dir = itemAsMoonrakerDir(payload.item, paths)
 
       commit('setDirUpdate', { paths, dir })
     }
@@ -160,15 +161,15 @@ export const actions: ActionTree<FilesState, RootState> = {
     }
   },
 
-  async notifyDeleteFile ({ commit }, payload: FileChangeSocketResponse) {
+  async notifyDeleteFile ({ commit }, payload: FileChange) {
     const paths = getFilePaths(payload.item.path, payload.item.root)
 
     if (!paths.filtered) {
       commit('setFileDelete', paths)
     }
   },
 
-  async notifyDeleteDir ({ commit }, payload: FileChangeSocketResponse) {
+  async notifyDeleteDir ({ commit }, payload: FileChange) {
     const paths = getFilePaths(payload.item.path, payload.item.root)
 
     if (!paths.filtered) {

src/store/files/mutations.ts

@@ -1,6 +1,6 @@
 import Vue from 'vue'
 import type { MutationTree } from 'vuex'
-import type { FilesState, MoonrakerRootFile, MoonrakerPathContent, KlipperFile, KlipperFileWithMeta, FilePaths, KlipperDir } from './types'
+import type { FilesState, MoonrakerRootFile, MoonrakerPathContent, MoonrakerFile, MoonrakerFileWithMeta, FilePaths, MoonrakerDir } from './types'
 import { defaultState } from './state'
 import { Globals } from '@/globals'
 
@@ -37,7 +37,7 @@ export const mutations: MutationTree<FilesState> = {
     Vue.set(state.rootFiles, root, files)
   },
 
-  setFileUpdate (state, payload: { paths: FilePaths, file: KlipperFile | KlipperFileWithMeta }) {
+  setFileUpdate (state, payload: { paths: FilePaths, file: MoonrakerFile | MoonrakerFileWithMeta }) {
     const { paths, file } = payload
 
     const isFiltered = (
@@ -61,7 +61,7 @@ export const mutations: MutationTree<FilesState> = {
     }
   },
 
-  setDirUpdate (state, payload: { paths: FilePaths, dir: KlipperDir }) {
+  setDirUpdate (state, payload: { paths: FilePaths, dir: MoonrakerDir }) {
     const { paths, dir } = payload
 
     const isFiltered = (

src/store/files/types.metadata.ts

@@ -1,4 +1,4 @@
-export interface KlipperFileMeta {
+export interface MoonrakerFileMeta {
   modified: number | string;
   size: number;
   uuid?: string;
@@ -19,10 +19,10 @@ export interface KlipperFileMeta {
   object_height?: number;
   slicer?: string;
   slicer_version?: string;
-  thumbnails?: KlipperFileMetaThumbnail[];
+  thumbnails?: MoonrakerFileMetaThumbnail[];
 }
 
-export interface KlipperFileMetaThumbnail {
+export interface MoonrakerFileMetaThumbnail {
   relative_path: string;
   height: number;
   width: number;

src/store/files/types.ts

@@ -1,7 +1,7 @@
-import type { KlipperFileMeta, KlipperFileMetaThumbnail } from './types.metadata'
+import type { MoonrakerFileMeta, MoonrakerFileMetaThumbnail } from './types.metadata'
 import type { HistoryItem } from '@/store/history/types'
 
-export type { KlipperFileMeta, KlipperFileMetaThumbnail }
+export type { MoonrakerFileMeta, MoonrakerFileMetaThumbnail }
 
 export interface FilesState {
   uploads: FileUpload[];
@@ -18,54 +18,75 @@ export interface DiskUsage {
   free: number;
 }
 
+export interface MoonrakerRootFile {
+  path: string;
+  modified: number;
+  size: number;
+  permissions: string;
+}
+
 export interface MoonrakerPathContent {
-  files: (KlipperFile | KlipperFileWithMeta) []
-  dirs: KlipperDir[]
+  files: (MoonrakerFile | MoonrakerFileWithMeta) []
+  dirs: MoonrakerDir[]
 }
 
-export interface KlipperFile {
+type MoonrakerFilePermissions = '' | 'r' | 'rw'
+
+export interface MoonrakerFile {
   filename: string;
   modified: number | string;
   size: number;
-  permissions?: '' | 'r' | 'rw';
+  permissions?: MoonrakerFilePermissions;
 }
 
-export interface KlipperFileWithMeta extends KlipperFile, KlipperFileMeta {
+export interface MoonrakerFileWithMeta extends MoonrakerFile, MoonrakerFileMeta {
   print_start_time?: number | null;
   job_id?: string | null;
 }
 
-export interface KlipperDir {
+export interface MoonrakerDir {
   dirname: string;
   modified: number | string;
   size: number;
-  permissions?: '' | 'r' | 'rw';
+  permissions?: MoonrakerFilePermissions;
 }
 
-export interface AppFile extends KlipperFile {
+export interface AppFile extends MoonrakerFile {
   type: 'file';
   name: string;
   extension: string;
   path: string;
   modified: number;
 }
 
-export interface AppFileWithMeta extends AppFile, KlipperFileWithMeta {
+export interface AppFileWithMeta extends AppFile, MoonrakerFileWithMeta {
   modified: number;
   history?: HistoryItem;
 }
 
-export interface AppFileThumbnail extends KlipperFileMetaThumbnail {
+export interface AppFileThumbnail extends MoonrakerFileMetaThumbnail {
   url: string;
 }
 
-export interface AppDirectory extends KlipperDir {
+export interface AppDirectory extends MoonrakerDir {
   type: 'directory';
   name: string;
   modified: number;
 }
 
-export interface FileChangeSocketResponse {
+export interface DirectoryInformation {
+  dirs: MoonrakerDir[];
+  files: (MoonrakerFile | MoonrakerFileWithMeta)[];
+  disk_usage: DiskUsage;
+  root_info: RootInfo;
+}
+
+export interface RootInfo {
+  name: string;
+  permissions?: MoonrakerFilePermissions;
+}
+
+export interface FileChange {
   action: 'create_file' | 'create_dir' | 'delete_file' | 'delete_dir' | 'move_file' | 'move_dir' | 'modify_file' | 'root_update';
   item: FileChangeItem;
   source_item?: {
@@ -79,7 +100,7 @@ export interface FileChangeItem {
   path: string;
   modified: number;
   size: number;
-  permissions?: '' | 'r' | 'rw';
+  permissions?: MoonrakerFilePermissions;
 }
 
 export interface FilePaths {
@@ -119,10 +140,3 @@ export interface RootProperties {
   canConfigure: boolean;
   filterTypes: FileFilterType[]
 }
-
-export interface MoonrakerRootFile {
-  path: string;
-  modified: number;
-  size: number;
-  permissions: string;
-}

src/store/history/types.ts

@@ -1,4 +1,4 @@
-import type { KlipperFileMeta } from '@/store/files/types.metadata'
+import type { MoonrakerFileMeta } from '@/store/files/types.metadata'
 
 export interface HistoryState {
   count: number;
@@ -12,7 +12,7 @@ export interface HistoryItem {
   end_time: string | null;
   filament_used: number;
   filename: string;
-  metadata?: KlipperFileMeta;
+  metadata?: MoonrakerFileMeta;
   print_duration: number;
   status: HistoryItemStatus;
   start_time: number;

src/store/server/actions.ts

@@ -8,6 +8,7 @@ import type { AppPushNotification } from '../notifications/types'
 import { EventBus } from '@/eventBus'
 import i18n from '@/plugins/i18n'
 import { gte, valid } from 'semver'
+import type { ObjectWithRequest } from '@/plugins/socketClient'
 
 let retryTimeout: number
 
@@ -171,8 +172,8 @@ export const actions: ActionTree<ServerState, RootState> = {
     commit('setMachinePeripherals', payload)
   },
 
-  async onMachinePeripheralsCanbus ({ commit }, payload: { can_uuids: CanbusUuid[], __request__: any }) {
-    const { interface: canbusInterface } = payload.__request__.params
+  async onMachinePeripheralsCanbus ({ commit }, payload: ObjectWithRequest<{ can_uuids: CanbusUuid[] }>) {
+    const { interface: canbusInterface } = payload.__request__.params ?? {}
 
     commit('setMachinePeripheralsCanbus', { canbusInterface, can_uuids: payload.can_uuids })
   },