chore(docs): update code docs

Author: jellyrock[bot]

docs/components_settings_settings.bs.html

@@ -99,7 +99,7 @@
 
 ' Called when reset button is selected in HexKeyboard
 sub onHexResetRequested()
-  m.global.sceneManager.callFunc("optionDialog", tr("Reset Setting"), tr("Are you sure? This will reset the setting to its default value."), [tr("Yes"), tr("No")])
+  m.global.sceneManager.callFunc("optionDialog", tr("Reset Setting"), tr("Are you sure? This will reset the setting to its default value."), [tr("Cancel"), tr("Reset")])
   m.global.sceneManager.observeFieldScoped("dataReturned", "onResetDialogResponse")
 end sub
 
@@ -110,8 +110,8 @@
   returnData = m.global.sceneManager.returnData
   if not isValid(returnData) then return
 
-  ' User selected "No" or closed dialog
-  if returnData.indexSelected <> 0
+  ' User selected "Cancel" or closed dialog
+  if returnData.indexSelected <> 1
     m.hexSetting.findNode("resetButton").setFocus(true)
     return
   end if
@@ -177,7 +177,7 @@
 
 ' Called when reset button is selected in AlphaKeyboard
 sub onAlphaResetRequested()
-  m.global.sceneManager.callFunc("optionDialog", tr("Reset Setting"), tr("Are you sure? This will reset the setting to its default value."), [tr("Yes"), tr("No")])
+  m.global.sceneManager.callFunc("optionDialog", tr("Reset Setting"), tr("Are you sure? This will reset the setting to its default value."), [tr("Cancel"), tr("Reset")])
   m.global.sceneManager.observeFieldScoped("dataReturned", "onAlphaResetDialogResponse")
 end sub
 
@@ -188,8 +188,8 @@
   returnData = m.global.sceneManager.returnData
   if not isValid(returnData) then return
 
-  ' User selected "No" or closed dialog
-  if returnData.indexSelected <> 0
+  ' User selected "Cancel" or closed dialog
+  if returnData.indexSelected <> 1
     m.alphaSetting.findNode("resetButton").setFocus(true)
     return
   end if
@@ -244,6 +244,21 @@
     listItem.id = item.id
   end for
 
+  ' Inject "Reset User Settings" action at root level only
+  if m.userLocation.Count() = 1
+    resetItem = {
+      title: "Reset User Settings",
+      description: "Reset all settings to their default values. Your login session will not be affected.",
+      type: "action",
+      actionId: "resetUserSettings"
+    }
+    filteredChildren.push(resetItem)
+    listItem = result.CreateChild("ContentNode")
+    listItem.title = tr(resetItem.title)
+    listItem.Description = tr(resetItem.description)
+    listItem.id = "resetUserSettings"
+  end if
+
   m.settingsMenu.content = result
 
   if isValid(configSection.selectedIndex) and configSection.selectedIndex > -1
@@ -332,6 +347,8 @@
       m.alphaSetting.text = ""
     end if
     m.alphaSetting.visible = true
+  else if selectedSetting.type = "action"
+    ' Action items show description only, no setting controls
   else
     m.log.warn("Unknown setting type", selectedSetting.type)
   end if
@@ -343,6 +360,12 @@
 
   selectedItem = m.userLocation.peek().filteredChildren[m.settingsMenu.itemFocused]
 
+  ' Handle action items (e.g., Reset User Settings)
+  if isValid(selectedItem.actionId) and selectedItem.actionId = "resetUserSettings"
+    confirmResetUserSettings()
+    return
+  end if
+
   if isValid(selectedItem.type) ' Show setting
     if selectedItem.type = "bool"
       m.boolSetting.setFocus(true)
@@ -470,6 +493,22 @@
     listItem.Description = tr(item.description)
     listItem.id = item.id
   end for
+
+  ' Re-inject reset button at root level
+  if m.userLocation.Count() = 1
+    resetItem = {
+      title: "Reset User Settings",
+      description: "Reset all settings to their default values. Your login session will not be affected.",
+      type: "action",
+      actionId: "resetUserSettings"
+    }
+    filteredChildren.push(resetItem)
+    listItem = result.CreateChild("ContentNode")
+    listItem.title = tr(resetItem.title)
+    listItem.Description = tr(resetItem.description)
+    listItem.id = "resetUserSettings"
+  end if
+
   m.settingsMenu.content = result
 
   ' Restore focus, clamping to new list bounds
@@ -517,6 +556,75 @@
   return false
 end function
 
+' Show confirmation dialog before resetting all user settings
+sub confirmResetUserSettings()
+  m.global.sceneManager.callFunc("optionDialog", tr("Reset User Settings"), tr("Are you sure you want to reset all settings to their default values? Your login session will not be affected."), [tr("Cancel"), tr("Reset")])
+  m.global.sceneManager.observeFieldScoped("dataReturned", "onResetUserSettingsResponse")
+end sub
+
+' Handle user response from reset user settings confirmation dialog
+sub onResetUserSettingsResponse()
+  m.global.sceneManager.unobserveFieldScoped("dataReturned")
+
+  returnData = m.global.sceneManager.returnData
+  if not isValid(returnData) or returnData.indexSelected <> 1
+    ' User selected "Cancel" or closed dialog
+    m.settingsMenu.setFocus(true)
+    return
+  end if
+
+  executeResetUserSettings()
+end sub
+
+' Reset all user settings to defaults from settings.json
+' Preserves session keys (authToken, username, serverId, primaryImageTag, LastRunVersion)
+sub executeResetUserSettings()
+  localUser = m.global.user
+  userId = localUser.id
+  if not isValid(userId) or userId = ""
+    m.log.warn("Cannot reset settings - user ID is invalid")
+    m.settingsMenu.setFocus(true)
+    return
+  end if
+
+  m.log.info("Resetting all user settings to defaults")
+
+  ' Disable auto-sync to prevent observers from firing during cleanup
+  localUser.settings.callFunc("disableAutoSync")
+
+  ' Delete all non-session keys from user registry
+  sessionKeys = ["authToken", "username", "serverId", "primaryImageTag", "LastRunVersion"]
+  allRegistryData = RegistryReadAll(userId)
+  keysToDelete = getSettingKeysToDelete(allRegistryData, sessionKeys)
+
+  for each key in keysToDelete
+    registry_delete(key, userId)
+  end for
+
+  ' Reload all defaults from settings.json onto the settings node
+  user.settings.SaveDefaults()
+
+  ' globalRememberMe was reset to false — clear auto-login state
+  unset_setting("active_user")
+
+  ' Clear per-library display settings
+  localUser.settings.displaySettings = {}
+
+  ' Re-enable auto-sync for future changes
+  localUser.settings.callFunc("enableAutoSync")
+
+  ' Theme colors were reset to defaults - flag for refresh on exit
+  m.themeColorsChanged = true
+
+  m.log.info("User settings reset complete", { deletedKeys: keysToDelete.Count() })
+
+  ' Show success feedback (toast lives on JRScene, persists across scene transitions)
+  m.top.getScene().callFunc("showToast", tr("Settings reset to defaults"), "success")
+
+  ' Exit settings and reload home with fresh theme colors
+  performSettingsExit()
+end sub
+
 ' JRScreen hook that gets ran when the screen is shown.
 sub OnScreenShown()
   ' Clear backdrop on settings screens

docs/data/search.json

@@ -148,6 +148,29 @@
   return key.StartsWith("global")
 end function
 
+' Filter registry keys to find those that should be deleted during a settings reset
+' Preserves session/identity keys, deletes everything else
+' @param {object} allKeys - associative array of all registry key-value pairs
+' @param {object} preserveKeys - array of key names to preserve
+' @return {object} - array of key names that should be deleted
+function getSettingKeysToDelete(allKeys as object, preserveKeys as object) as object
+  keysToDelete = []
+  for each key in allKeys
+    shouldPreserve = false
+    for each preserveKey in preserveKeys
+      ' Case-insensitive compare: roAssociativeArray iteration returns lowercase keys
+      if LCase(key) = LCase(preserveKey)
+        shouldPreserve = true
+        exit for
+      end if
+    end for
+    if not shouldPreserve
+      keysToDelete.push(key)
+    end if
+  end for
+  return keysToDelete
+end function
+
 ' Recursivly search the config tree for entry with settingname equal to key
 function findConfigTreeKey(key as string, tree)
   for each item in tree