refactor: unify type definitions

Author: Crauzer

src-tauri/src/overlay/mod.rs

@@ -8,12 +8,23 @@ use camino::Utf8PathBuf;
 use std::path::PathBuf;
 use tauri::Emitter;
 
+#[derive(Clone, serde::Serialize, ts_rs::TS)]
+#[ts(export)]
+#[serde(rename_all = "camelCase")]
+pub enum OverlayStage {
+    Indexing,
+    Collecting,
+    Patching,
+    Strings,
+    Complete,
+}
+
 /// Progress event emitted during overlay building.
 #[derive(Clone, serde::Serialize, ts_rs::TS)]
 #[ts(export)]
 #[serde(rename_all = "camelCase")]
 pub struct OverlayProgress {
-    pub stage: String,
+    pub stage: OverlayStage,
     pub current_file: Option<String>,
     pub current: u32,
     pub total: u32,
@@ -72,17 +83,17 @@ pub fn ensure_overlay(library: &ModLibrary, settings: &Settings) -> AppResult<Pa
             .with_progress(move |progress| {
                 // Convert ltk_overlay progress to our format
                 let stage = match progress.stage {
-                    ltk_overlay::OverlayStage::Indexing => "indexing",
-                    ltk_overlay::OverlayStage::CollectingOverrides => "collecting",
-                    ltk_overlay::OverlayStage::PatchingWad => "patching",
-                    ltk_overlay::OverlayStage::ApplyingStringOverrides => "strings",
-                    ltk_overlay::OverlayStage::Complete => "complete",
+                    ltk_overlay::OverlayStage::Indexing => OverlayStage::Indexing,
+                    ltk_overlay::OverlayStage::CollectingOverrides => OverlayStage::Collecting,
+                    ltk_overlay::OverlayStage::PatchingWad => OverlayStage::Patching,
+                    ltk_overlay::OverlayStage::ApplyingStringOverrides => OverlayStage::Strings,
+                    ltk_overlay::OverlayStage::Complete => OverlayStage::Complete,
                 };
 
                 let _ = app_handle_clone.emit(
                     "overlay-progress",
                     OverlayProgress {
-                        stage: stage.to_string(),
+                        stage,
                         current_file: progress.current_file,
                         current: progress.current,
                         total: progress.total,

src-tauri/src/workshop/mod.rs

@@ -113,12 +113,22 @@ pub struct ImportFantomeArgs {
     pub display_name: String,
 }
 
+#[derive(Debug, Clone, Serialize, TS)]
+#[ts(export)]
+#[serde(rename_all = "camelCase")]
+pub enum FantomeImportStage {
+    Extracting,
+    Finalizing,
+    Complete,
+    Error,
+}
+
 /// Progress event emitted during fantome import.
 #[derive(Debug, Clone, Serialize, TS)]
 #[ts(export)]
 #[serde(rename_all = "camelCase")]
 pub struct FantomeImportProgress {
-    pub stage: String,
+    pub stage: FantomeImportStage,
     pub current_wad: Option<String>,
     pub current: u32,
     pub total: u32,
@@ -134,12 +144,22 @@ pub struct ImportGitRepoArgs {
     pub branch: Option<String>,
 }
 
+#[derive(Debug, Clone, Serialize, TS)]
+#[ts(export)]
+#[serde(rename_all = "camelCase")]
+pub enum GitImportStage {
+    Downloading,
+    Extracting,
+    Complete,
+    Error,
+}
+
 /// Progress event emitted during git repo import.
 #[derive(Debug, Clone, Serialize, TS)]
 #[ts(export)]
 #[serde(rename_all = "camelCase")]
 pub struct GitImportProgress {
-    pub stage: String,
+    pub stage: GitImportStage,
     pub message: Option<String>,
 }
 

src-tauri/src/workshop/projects.rs

@@ -1,7 +1,8 @@
 use super::{
     find_config_file, is_valid_project_name, load_mod_project, load_workshop_project,
-    CreateProjectArgs, FantomeImportProgress, FantomePeekResult, GitImportProgress,
-    ImportFantomeArgs, ImportGitRepoArgs, SaveProjectConfigArgs, Workshop, WorkshopProject,
+    CreateProjectArgs, FantomeImportProgress, FantomeImportStage, FantomePeekResult,
+    GitImportProgress, GitImportStage, ImportFantomeArgs, ImportGitRepoArgs, SaveProjectConfigArgs,
+    Workshop, WorkshopProject,
 };
 use crate::error::{AppError, AppResult};
 use crate::state::Settings;
@@ -274,11 +275,21 @@ impl Workshop {
             fs::create_dir_all(&base_dir)?;
 
             for (idx, wad_name) in wad_names.iter().enumerate() {
-                self.emit_fantome_progress("extracting", Some(wad_name), idx as u32, total_wads);
+                self.emit_fantome_progress(
+                    FantomeImportStage::Extracting,
+                    Some(wad_name),
+                    idx as u32,
+                    total_wads,
+                );
                 extract_fantome_wad(&mut archive, wad_name, &base_dir)?;
             }
 
-            self.emit_fantome_progress("finalizing", None, total_wads, total_wads);
+            self.emit_fantome_progress(
+                FantomeImportStage::Finalizing,
+                None,
+                total_wads,
+                total_wads,
+            );
 
             let readme_path = project_dir.join("README.md");
             extract_fantome_file(&mut archive, "meta/readme.md", &readme_path);
@@ -336,13 +347,13 @@ impl Workshop {
             let config_path = project_dir.join("mod.config.json");
             fs::write(&config_path, serde_json::to_string_pretty(&mod_project)?)?;
 
-            self.emit_fantome_progress("complete", None, total_wads, total_wads);
+            self.emit_fantome_progress(FantomeImportStage::Complete, None, total_wads, total_wads);
 
             load_workshop_project(&project_dir)
         })();
 
         if result.is_err() {
-            self.emit_fantome_progress("error", None, 0, total_wads);
+            self.emit_fantome_progress(FantomeImportStage::Error, None, 0, total_wads);
             let _ = fs::remove_dir_all(&project_dir);
         }
 
@@ -351,15 +362,15 @@ impl Workshop {
 
     fn emit_fantome_progress(
         &self,
-        stage: &str,
+        stage: FantomeImportStage,
         current_wad: Option<&str>,
         current: u32,
         total: u32,
     ) {
         let _ = self.app_handle.emit(
             "fantome-import-progress",
             FantomeImportProgress {
-                stage: stage.to_string(),
+                stage,
                 current_wad: current_wad.map(String::from),
                 current,
                 total,
@@ -480,7 +491,7 @@ impl Workshop {
             owner, repo, branch
         );
 
-        self.emit_git_progress("downloading", None);
+        self.emit_git_progress(GitImportStage::Downloading, None);
 
         let response = reqwest::blocking::get(&tarball_url)
             .map_err(|e| AppError::Other(format!("Failed to download repository: {}", e)))?;
@@ -496,7 +507,7 @@ impl Workshop {
             .bytes()
             .map_err(|e| AppError::Other(format!("Failed to read response: {}", e)))?;
 
-        self.emit_git_progress("extracting", None);
+        self.emit_git_progress(GitImportStage::Extracting, None);
 
         let temp_dir = workshop_path.join(format!(".git-import-{}", uuid::Uuid::new_v4()));
         fs::create_dir_all(&temp_dir)?;
@@ -543,12 +554,12 @@ impl Workshop {
 
             fs::rename(&extracted_dir, &project_dir)?;
 
-            self.emit_git_progress("complete", None);
+            self.emit_git_progress(GitImportStage::Complete, None);
             load_workshop_project(&project_dir)
         })();
 
         if result.is_err() {
-            self.emit_git_progress("error", None);
+            self.emit_git_progress(GitImportStage::Error, None);
         }
 
         if temp_dir.exists() {
@@ -557,11 +568,11 @@ impl Workshop {
         result
     }
 
-    fn emit_git_progress(&self, stage: &str, message: Option<&str>) {
+    fn emit_git_progress(&self, stage: GitImportStage, message: Option<&str>) {
         let _ = self.app_handle.emit(
             "git-import-progress",
             GitImportProgress {
-                stage: stage.to_string(),
+                stage,
                 message: message.map(String::from),
             },
         );

src/lib/bindings/FantomeImportProgress.ts

@@ -1,10 +1,11 @@
 // This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { FantomeImportStage } from "./FantomeImportStage";
 
 /**
  * Progress event emitted during fantome import.
  */
 export type FantomeImportProgress = {
-  stage: string;
+  stage: FantomeImportStage;
   currentWad: string | null;
   current: number;
   total: number;

src/lib/bindings/FantomeImportStage.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type FantomeImportStage = "extracting" | "finalizing" | "complete" | "error";

src/lib/bindings/GitImportProgress.ts

@@ -1,6 +1,7 @@
 // This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { GitImportStage } from "./GitImportStage";
 
 /**
  * Progress event emitted during git repo import.
  */
-export type GitImportProgress = { stage: string; message: string | null };
+export type GitImportProgress = { stage: GitImportStage; message: string | null };

src/lib/bindings/GitImportStage.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type GitImportStage = "downloading" | "extracting" | "complete" | "error";

src/lib/bindings/OverlayProgress.ts

@@ -1,10 +1,11 @@
 // This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { OverlayStage } from "./OverlayStage";
 
 /**
  * Progress event emitted during overlay building.
  */
 export type OverlayProgress = {
-  stage: string;
+  stage: OverlayStage;
   currentFile: string | null;
   current: number;
   total: number;

src/lib/bindings/OverlayStage.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type OverlayStage = "indexing" | "collecting" | "patching" | "strings" | "complete";

src/lib/bindings/index.ts

@@ -7,8 +7,10 @@ export type { CreateProjectArgs } from "./CreateProjectArgs";
 export type { CslolModInfo } from "./CslolModInfo";
 export type { ErrorCode } from "./ErrorCode";
 export type { FantomeImportProgress } from "./FantomeImportProgress";
+export type { FantomeImportStage } from "./FantomeImportStage";
 export type { FantomePeekResult } from "./FantomePeekResult";
 export type { GitImportProgress } from "./GitImportProgress";
+export type { GitImportStage } from "./GitImportStage";
 export type { ImportFantomeArgs } from "./ImportFantomeArgs";
 export type { ImportGitRepoArgs } from "./ImportGitRepoArgs";
 export type { InstalledMod } from "./InstalledMod";
@@ -19,6 +21,7 @@ export type { MigrationProgress } from "./MigrationProgress";
 export type { ModLayer } from "./ModLayer";
 export type { ModpkgInfo } from "./ModpkgInfo";
 export type { OverlayProgress } from "./OverlayProgress";
+export type { OverlayStage } from "./OverlayStage";
 export type { PackFormat } from "./PackFormat";
 export type { PackProjectArgs } from "./PackProjectArgs";
 export type { PackResult } from "./PackResult";