Support registering and unregistering preferences

Author: Ovenoboyo

wasm-extension-go/pkg/api/api.go

@@ -375,6 +375,16 @@ func OpenExternalUrl(url string) error {
 	return err
 }
 
+func RegisterUserPreference(prefs []types.PreferenceUIData) error {
+	err := sendMainCommandOptional("RegisterUserPreference", prefs)
+	return err
+}
+
+func UnregisterUserPreference(prefs []string) error {
+	err := sendMainCommandOptional("UnregisterUserPreference", prefs)
+	return err
+}
+
 // UpdateAccounts updates the accounts status.
 func UpdateAccounts(packageName string) error {
 	err := sendMainCommandOptional("UpdateAccounts", packageName)

wasm-extension-go/pkg/api/exports.go

@@ -335,8 +335,7 @@ func perform_account_login_wrapper() int32 {
 //go:wasmexport scrobble_wrapper
 func scrobble_wrapper() int32 {
 	var song types.Song
-	in := [...]any{&song}
-	return runWrapper(&in, func() (any, error) {
+	return runWrapper(&song, func() (any, error) {
 		return nil, extension.Scrobble(song)
 	})
 }

wasm-extension-go/pkg/types/types.go

@@ -234,3 +234,43 @@ const (
 	PlayerStateStopped PlayerState = "STOPPED"
 	PlayerStateLoading PlayerState = "LOADING"
 )
+
+type PreferenceTypes string
+
+const (
+	DirectoryGroup PreferenceTypes = "DirectoryGroup"
+	EditText       PreferenceTypes = "EditText"
+	FilePicker     PreferenceTypes = "FilePicker"
+	CheckboxGroup  PreferenceTypes = "CheckboxGroup"
+	ThemeSelector  PreferenceTypes = "ThemeSelector"
+	Extensions     PreferenceTypes = "Extensions"
+	ButtonGroup    PreferenceTypes = "ButtonGroup"
+	ProgressBar    PreferenceTypes = "ProgressBar"
+	TextField      PreferenceTypes = "TextField"
+	InfoField      PreferenceTypes = "InfoField"
+	Dropdown       PreferenceTypes = "Dropdown"
+)
+
+type InputType string
+
+const (
+	Text   InputType = "text"
+	Number InputType = "number"
+)
+
+type CheckboxItems struct {
+	Title string `json:"title"`
+	Key   string `json:"key"`
+}
+
+type PreferenceUIData struct {
+	Type        PreferenceTypes  `json:"type"`
+	Title       string           `json:"title"`
+	Key         string           `json:"key"`
+	Description string           `json:"description"`
+	InputType   *InputType       `json:"inputType,omitempty"`
+	Single      *bool            `json:"single,omitempty"`
+	Items       *[]CheckboxItems `json:"items,omitempty"`
+	Default     any              `json:"default,omitempty"`
+	Mobile      *bool            `json:"mobile,omitempty"`
+}

wasm-extension-js/src/types.ts

@@ -482,6 +482,42 @@ export interface ContextMenuReturnType {
   action_id: string;
 }
 
+export enum PreferenceTypes {
+  DirectoryGroup = "DirectoryGroup",
+  EditText = "EditText",
+  FilePicker = "FilePicker",
+  CheckboxGroup = "CheckboxGroup",
+  ThemeSelector = "ThemeSelector",
+  Extensions = "Extensions",
+  ButtonGroup = "ButtonGroup",
+  ProgressBar = "ProgressBar",
+  TextField = "TextField",
+  InfoField = "InfoField",
+  Dropdown = "Dropdown",
+}
+
+export enum InputType {
+  Text = "text",
+  Number = "number",
+}
+
+export interface CheckboxItems {
+  title: string;
+  key: string;
+}
+
+export interface PreferenceUIData {
+  type: PreferenceTypes;
+  title: string;
+  key: string;
+  description: string;
+  inputType?: InputType;
+  single?: boolean;
+  items?: CheckboxItems[];
+  default?: any;
+  mobile?: boolean;
+}
+
 /**
  * The API exposed to extensions
  */
@@ -838,6 +874,18 @@ export interface ExtensionAPI {
    */
   openExternalUrl(url: string): void;
 
+  /**
+   * Registers user preferences to show in settings.
+   * @param prefs An array of PreferenceUIData objects representing the preferences to register
+   */
+  registerUserPreferences(prefs: PreferenceUIData[]): void;
+
+  /**
+   * Unregisters user preferences from the main app.
+   * @param pref_keys An array of preference keys to unregister
+   */
+  unregisterUserPreferences(pref_keys: string[]): void;
+
   /**
    * Updates the list of accounts in the main app.
    */

wasm-extension-py/moosync_edk/__init__.py

@@ -45,7 +45,7 @@
 
 class EnhancedJSONEncoder(json.JSONEncoder):
         def default(self, o):
-            if dataclasses.is_dataclass(o):
+            if dataclasses.is_dataclass(o) and not isinstance(o, type):
                 return dataclasses.asdict(o)
             return super().default(o)
 
@@ -329,6 +329,24 @@ def update_accounts(self) -> None:
         }
         send_main_command(json.dumps(data, cls=EnhancedJSONEncoder))
 
+    def register_user_preferences(self, prefs: List[PreferenceUIData]) -> None:
+        """
+        Registered preferences will show up in settings
+        """
+        data = {
+            "RegisterUserPreference": prefs
+        }
+        send_main_command(json.dumps(data, cls=EnhancedJSONEncoder))
+
+    def unregister_user_preferences(self, pref_keys: List[str]) -> None:
+            """
+            Removes preferences from settings
+            """
+            data = {
+                "UnregisterUserPreference": pref_keys
+            }
+            send_main_command(json.dumps(data, cls=EnhancedJSONEncoder))
+
 class Extension:
     api = Api()
 

wasm-extension-py/moosync_edk/custom_types.py

@@ -1,6 +1,7 @@
 from dataclasses import dataclass, field
 from typing import Optional, List, Dict, Union, Any, Literal
 import inspect
+from enum import Enum
 
 ProviderScopes = Literal[
     "search",
@@ -387,3 +388,37 @@ def from_dict(cls, data: dict) -> 'AddToPlaylistRequest':
             k: v for k, v in data.items()
             if k in inspect.signature(cls).parameters
         })
+
+class PreferenceTypes(Enum):
+    DirectoryGroup = "DirectoryGroup"
+    EditText = "EditText"
+    FilePicker = "FilePicker"
+    CheckboxGroup = "CheckboxGroup"
+    ThemeSelector = "ThemeSelector"
+    Extensions = "Extensions"
+    ButtonGroup = "ButtonGroup"
+    ProgressBar = "ProgressBar"
+    TextField = "TextField"
+    InfoField = "InfoField"
+    Dropdown = "Dropdown"
+
+class InputType(Enum):
+    Text = "text"
+    Number = "number"
+
+@dataclass(frozen=True)
+class CheckboxItems:
+    title: str
+    key: str
+
+@dataclass
+class PreferenceUIData:
+    type: 'PreferenceTypes'  # Use string annotation for forward reference or import the actual class
+    title: str
+    key: str
+    description: str
+    inputType: Optional['InputType'] = None
+    single: Optional[bool] = None
+    items: Optional[List['CheckboxItems']] = None
+    default: Optional[Any] = None  # Replace Any with the actual Value type if available
+    mobile: Optional[bool] = None

wasm-extension-rs/src/api.rs

@@ -439,6 +439,20 @@ pub mod extension_api {
         ///
         /// * `package_name` - The optional package name to filter the accounts.
         update_accounts(UpdateAccounts, package_name: Option<String>) -> ();
+
+        /// Registers user preferences with the main app.
+        ///
+        /// # Arguments
+        ///
+        /// * `prefs` - A vector of `PreferenceUIData` representing the user preferences to register.
+        register_user_preferences(RegisterUserPreference, prefs: Vec<PreferenceUIData>) -> ();
+
+        /// Unregisters user preferences from the main app.
+        ///
+        /// # Arguments
+        ///
+        /// * `pref_keys` - A vector of strings representing the keys of the preferences to unregister.
+        unregister_user_preferences(UnregisterUserPreference, pref_keys: Vec<String>) -> ();
     }
 
     pub fn get_system_time() -> u64 {