feat: add mime types and "Open With" windows support

Author: THEGOLDENPRO

suap.example.toml

@@ -12,5 +12,12 @@ display-name = "Roseate"
 # "original.png" - when there's no platform specific icon suap falls back to
 icons = "./assets/icons"
 
+mime_types = [
+    "image/jpeg",
+    "image/gif",
+    "image/png",
+    "image/webp",
+]
+
 [project.cargo]
 bin-crate = "roseate" # The name of the cargo binary crate to target

suap/commands/packaging/nsis.py

@@ -7,6 +7,7 @@
 # just so we can get the root path of our library
 import suap
 
+from ...mime_type import MimeType
 from ...projects import ProjectData
 from ...formats import make_nsis_installer
 
@@ -24,6 +25,7 @@ def format_config_and_make_nsis_installer(
     temp_folder_path: Path,
     display_name: Optional[str],
     icon_path: Path,
+    mime_types: list[MimeType],
     project_data: ProjectData,
 ):
     logger.debug(
@@ -36,9 +38,8 @@ def format_config_and_make_nsis_installer(
     temp_folder_path.mkdir(exist_ok = True)
     nsis_installer_script_path = temp_folder_path.joinpath("nsis_installer.nsi")
 
-    installer_script_template_path = Path(suap.__file__).parent.joinpath(
-        "templates", "nsis_installer_script.nsi"
-    )
+    templates_path = Path(suap.__file__).parent.joinpath("templates")
+    installer_script_template_path = templates_path.joinpath("nsis_installer_script.nsi")
 
     logger.debug(
         f"Opening and reading NSIS template installer script at '{installer_script_template_path}'..."
@@ -50,19 +51,39 @@ def format_config_and_make_nsis_installer(
     logger.debug("Formatting template and creating custom install script...")
 
     semver = project_data.version
+    display_name = display_name if display_name is not None else project_data.name
 
     replace_map: dict[str, str] = {
         "suap-binary-name": binary_name,
         "suap-binary-path": str(binary_path.absolute()),
         "suap-binary-dist-path": str(binary_dist_path.absolute()),
-        "suap-display-name": display_name if display_name is not None else project_data.name,
+        "suap-display-name": display_name,
         "suap-icon-path": str(icon_path.absolute()),
         "suap-icon-file-name": icon_path.name,
 
         "suap-project-name": project_data.name,
         "suap-project-version": f"{semver.major}.{semver.minor}.{semver.patch}" \
             f".{semver.prerelease.split('.')[-1] if semver.prerelease is not None else 0}",
         "suap-project-description": project_data.description,
+
+        "suap-app-capabilities-macro": generate_app_capabilities_macro(
+            mime_types,
+            templates_path,
+            binary_name,
+            display_name,
+            icon_path,
+            project_data,
+            uninstall = False,
+        ),
+        "suap-app-capabilities-uni-macro": generate_app_capabilities_macro(
+            mime_types,
+            templates_path,
+            binary_name,
+            display_name,
+            icon_path,
+            project_data,
+            uninstall = True,
+        ),
     }
 
     for (suap_key, value) in replace_map.items():
@@ -78,4 +99,82 @@ def format_config_and_make_nsis_installer(
     if not make_nsis_installer(nsis_installer_script_path):
         raise Exit(1)
 
-    logger.info("Done making NSIS installer, installer executable should be in dist.")
+    logger.info("Done making NSIS installer, installer executable should be in dist.")
+
+def generate_app_capabilities_macro(
+    mime_types: list[MimeType],
+    templates_path: Path,
+    binary_name: str,
+    display_name: str,
+    icon_path: Path,
+    project_data: ProjectData,
+    uninstall: bool,
+) -> str:
+    if len(mime_types) == 0:
+        return ""
+
+    app_capabilities_template_path = templates_path.joinpath(
+        "nsis_app_capabilities_uni_macro.nsi" if uninstall else "nsis_app_capabilities_macro.nsi"
+    )
+
+    with open(app_capabilities_template_path, mode = "r") as file:
+        app_capabilities_macro_string = file.read()
+
+    file_associations_and_types_lines = []
+
+    for mime_type in mime_types:
+        file_extension = mime_type.get_file_extension()
+
+        project_name = project_data.name
+
+        if file_extension is None:
+            logger.warning(f"Mime type '{mime_type.mime_type_string}' not found, skipping...")
+            continue
+
+        if not uninstall:
+            file_associations_and_types_lines.append(
+                f'WriteRegStr HKCR "Applications\\{binary_name}.exe\\SupportedTypes" "{file_extension}" ""'
+            )
+
+            file_associations_and_types_lines.append(
+                f'WriteRegStr HKCR "{file_extension}\\OpenWithProgIds" "Cloudy.{project_name}.1" ""'
+            )
+
+            file_associations_and_types_lines.append(
+                f'WriteRegStr HKLM "SOFTWARE\\Cloudy\\{project_name}\\Capabilities\\FileAssociations" "{file_extension}" "Cloudy.{project_name}.1"'
+            )
+
+        else:
+            file_associations_and_types_lines.append(
+                f'DeleteRegValue HKCR "Applications\\{binary_name}.exe\\SupportedTypes" "{file_extension}"'
+            )
+
+            file_associations_and_types_lines.append(
+                f'DeleteRegValue HKCR "{file_extension}\\OpenWithProgIds" "Cloudy.{project_name}.1"'
+            )
+
+    replace_map: dict[str, str] = {
+        "suap-binary-name": binary_name,
+        "suap-display-name": display_name,
+        "suap-icon-file-name": icon_path.name,
+
+        "suap-project-name": project_data.name,
+        "suap-project-description": project_data.description,
+
+        "suap-file-associations-and-types-macro": "\n".join(file_associations_and_types_lines),
+    }
+
+    for (suap_key, value) in replace_map.items():
+        app_capabilities_macro_string = app_capabilities_macro_string.replace(
+            f"{{{suap_key}}}", value
+        )
+
+    formatted_macro_string = "".join([
+        f"    {line}" for line in app_capabilities_macro_string.splitlines(keepends = True)
+    ])
+
+    logger.debug(
+        f"Generated and formatted app capabilities macro: \n{formatted_macro_string}"
+    )
+
+    return formatted_macro_string

suap/commands/packaging/package.py

@@ -13,6 +13,7 @@
 from .nsis import format_config_and_make_nsis_installer
 from .icons import get_platform_icon_path, format_icon_with_project_name
 
+from ...mime_type import MimeType
 from ...config import get_config_data
 from ...project_type import ProjectType
 from ...platform_format import PlatformFormat, PlatformFormatOption
@@ -41,6 +42,7 @@ def package(
                 "(e.g: 'bin-name-linux-x86_64', 'bin-name-win-x86_64-setup.exe', 'bin-name-macos-x86_64')."
         )
     ] = None,
+    remove_temp: bool = True,
 ):
     platform_format: PlatformFormat = platform_format.get_platform_format()
 
@@ -55,8 +57,12 @@ def package(
     if config_data is None:
         raise Exit(1)
 
+    # TODO: move this stuff to some sort of Config class
     display_name: Optional[str] = config_data.get("display-name", None)
     icons_config_path: Optional[str] = config_data.get("icons", None)
+    mime_types: list[MimeType] = [
+        MimeType(mime_type_string = mime_type) for mime_type in config_data.get("mime_types", [])
+    ]
 
     if icons_config_path is None:
         logger.error(
@@ -156,10 +162,12 @@ def package(
                 temp_folder_path = temp_folder_path,
                 display_name = display_name,
                 icon_path = platform_icon_path,
-                project_data = project_data
+                mime_types = mime_types,
+                project_data = project_data,
             )
 
-    logger.debug("Removing temp dir...")
-    shutil.rmtree(temp_folder_path, ignore_errors = True)
+    if remove_temp:
+        logger.debug("Removing temp dir...")
+        shutil.rmtree(temp_folder_path, ignore_errors = True)
 
     logger.info("This command is WIP!")

suap/config/data.py

@@ -20,6 +20,7 @@ class ConfigProjectData(TypedDict):
         "version": int,
         "display-name": str,
         "icons": str,
+        "mime_types": list[str],
         "project": ConfigProjectData
     }
 )

suap/mime_type.py

@@ -0,0 +1,15 @@
+from typing import Optional
+
+import mimetypes
+from dataclasses import dataclass
+
+__all__ = ()
+
+@dataclass
+class MimeType:
+    mime_type_string: str
+
+    def get_file_extension(self) -> Optional[str]:
+        return mimetypes.guess_extension(
+            self.mime_type_string, strict = True
+        )

suap/templates/nsis_app_capabilities_macro.nsi

@@ -0,0 +1,20 @@
+# https://learn.microsoft.com/en-us/windows/win32/shell/app-registration
+WriteRegStr HKCR "Applications\{suap-binary-name}.exe" "DefaultIcon" "$INSTDIR\{suap-icon-file-name},0"
+WriteRegStr HKCR "Applications\{suap-binary-name}.exe\shell\open" "FriendlyAppName" "{suap-display-name}"
+WriteRegStr HKCR "Applications\{suap-binary-name}.exe\shell\open\command" "" '"$INSTDIR\{suap-binary-name}.exe" "%1"'
+
+WriteRegStr HKCR "Cloudy.{suap-project-name}.1" "" "{suap-display-name} File Associations"
+WriteRegStr HKCR "Cloudy.{suap-project-name}.1\DefaultIcon" "" "$INSTDIR\{suap-icon-file-name},0"
+WriteRegStr HKCR "Cloudy.{suap-project-name}.1\shell\open\command" "" '"$INSTDIR\{suap-binary-name}.exe" "%1"'
+
+# Adds supported and associate files for "OpenWithProgIds" 
+# and also adds "Capabilities\FileAssociations" for application
+{suap-file-associations-and-types-macro}
+
+# Adds application to registered applications so it can show in Windows default apps list:
+# https://learn.microsoft.com/en-us/windows/apps/develop/launch/launch-default-apps-settings
+WriteRegStr HKLM "SOFTWARE\Cloudy\{suap-project-name}\Capabilities" "ApplicationName" "{suap-display-name}"
+WriteRegStr HKLM "SOFTWARE\Cloudy\{suap-project-name}\Capabilities" "ApplicationDescription" "{suap-project-description}"
+
+# This is where it actually registers by pointing to the "Capabilities" reg
+WriteRegStr HKLM "SOFTWARE\RegisteredApplications" "{suap-project-name}" "SOFTWARE\Cloudy\{suap-project-name}\Capabilities"

suap/templates/nsis_app_capabilities_uni_macro.nsi

@@ -0,0 +1,12 @@
+DeleteRegKey HKCR "Applications\{suap-binary-name}.exe"
+
+DeleteRegKey HKCR "Cloudy.{suap-project-name}.1"
+
+# Removes application from "OpenWithProgIds" in supported and associate files
+{suap-file-associations-and-types-macro}
+
+# Deletes "Capabilities" as well as "Capabilities\FileAssociations" reg
+DeleteRegKey HKLM "SOFTWARE\Cloudy\{suap-project-name}"
+
+# Removes application from registered applications (e.g: default apps list)
+DeleteRegValue HKLM "SOFTWARE\RegisteredApplications" "{suap-project-name}"

suap/templates/nsis_installer_script.nsi

@@ -14,6 +14,9 @@ VIAddVersionKey "LegalCopyright" "© 2026 Goldy"
 
 SetCompressor /SOLID Lzma
 
+# Admin is required for some registries to apply, like "HKEY_LOCAL_MACHINE\Software\Cloudy".
+RequestExecutionLevel admin
+
 # Defining some MUI specific features, like icons for the installer executables
 !define MUI_ICON "{suap-icon-path}"
 !define MUI_UNICON "{suap-icon-path}"
@@ -32,6 +35,7 @@ SetCompressor /SOLID Lzma
 # installer, it's where the installation 
 # of the application and uninstaller happens.
 Section "MainSection"
+    SetRegView 64
     SetShellVarContext all
 
     # Where we place our application binary file and other files.
@@ -52,9 +56,19 @@ Section "MainSection"
     WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\{suap-project-name}" "DisplayName" "{suap-display-name}"
     WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\{suap-project-name}" "DisplayVersion" "{suap-project-version}"
     WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\{suap-project-name}" "UninstallString" "$INSTDIR\uninstall.exe"
+
+    # Allows the application to be called from the Windows Run Dialog or Command Prompt (CMD).
+    WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\App Paths\{suap-binary-name}.exe" "" "$INSTDIR\{suap-binary-name}.exe"
+    WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\App Paths\{suap-binary-name}.exe" "Path" "$INSTDIR"
+
+    # Add application to "Open With" dialog if the application has mime types it supports
+    {suap-app-capabilities-macro}
+
+    System::Call "shell32.dll::SHChangeNotify(i 0x08000000, i 0, i 0, i 0)"
 SectionEnd
 
 Section "Uninstall"
+    SetRegView 64
     SetShellVarContext all
 
     # Where we remove our application binary file and other files.
@@ -66,4 +80,10 @@ Section "Uninstall"
     Delete "$SMPROGRAMS\Cloudy\{suap-project-name}.lnk"
 
     DeleteRegKey HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\{suap-project-name}"
+
+    DeleteRegKey HKLM "Software\Microsoft\Windows\CurrentVersion\App Paths\{suap-binary-name}.exe"
+
+    {suap-app-capabilities-uni-macro}
+
+    System::Call "shell32.dll::SHChangeNotify(i 0x08000000, i 0, i 0, i 0)"
 SectionEnd