feat: try support sequoia VO preferences being sandboxed

.github/workflows/resolutionFix.ts

@@ -3,7 +3,8 @@ import { execSync } from "child_process";
 if (process.platform === "darwin") {
   try {
     execSync(
-      `"/Library/Application Support/VMware Tools/vmware-resolutionSet" 1920 1080`
+      `"/Library/Application Support/VMware Tools/vmware-resolutionSet" 1920 1080`,
+      { encoding: "utf8" }
     );
   } catch (_) {
     // swallow

src/errors.ts

@@ -7,6 +7,8 @@ export const ERR_MACOS_UNSUPPORTED_VERSION =
   "Require macOS version 11 or later";
 export const ERR_MACOS_UNABLE_UPDATE_SYSTEM_DEFAULTS =
   "Unable to update system defaults";
+export const ERR_MACOS_UNABLE_UPDATE_VOICE_OVER_SANDBOXED_DEFAULTS =
+  "Unable to update VoiceOver sandboxed defaults - SIP might not be disabled";
 export const ERR_MACOS_UNABLE_TO_VERIFY_SIP =
   "Unable to verify macOS SIP status";
 export const ERR_MACOS_UNABLE_TO_WRITE_DATABASE_FILE =

src/macOS/disableDictationInputAutoEnable.ts

@@ -4,9 +4,12 @@ import { ERR_MACOS_UNABLE_UPDATE_SYSTEM_DEFAULTS } from "../errors";
 export function disableDictationInputAutoEnable(): void {
   try {
     execSync(
-      "defaults write com.apple.HIToolbox AppleDictationAutoEnable -bool false"
+      "defaults write com.apple.HIToolbox AppleDictationAutoEnable -bool false",
+      { encoding: "utf8" }
     );
   } catch (e) {
-    throw new Error(`${ERR_MACOS_UNABLE_UPDATE_SYSTEM_DEFAULTS}\n\n${e.message}`);
+    throw new Error(
+      `${ERR_MACOS_UNABLE_UPDATE_SYSTEM_DEFAULTS}\n\n${e.message}`
+    );
   }
 }

src/macOS/disableSplashScreenSystemDefaults.ts

@@ -4,9 +4,12 @@ import { ERR_MACOS_UNABLE_UPDATE_SYSTEM_DEFAULTS } from "../errors";
 export function disableSplashScreenSystemDefaults(): void {
   try {
     execSync(
-      "defaults write com.apple.VoiceOverTraining doNotShowSplashScreen -bool true"
+      "defaults write com.apple.VoiceOverTraining doNotShowSplashScreen -bool true",
+      { encoding: "utf8" }
     );
   } catch (e) {
-    throw new Error(`${ERR_MACOS_UNABLE_UPDATE_SYSTEM_DEFAULTS}\n\n${e.message}`);
+    throw new Error(
+      `${ERR_MACOS_UNABLE_UPDATE_SYSTEM_DEFAULTS}\n\n${e.message}`
+    );
   }
 }

src/macOS/enableAppleScriptControlSandboxedDefaults.ts

@@ -0,0 +1,26 @@
+import { execSync } from "child_process";
+import { getPlatformVersionMajor } from "./getPlatformVersionMajor";
+import { ERR_MACOS_UNABLE_UPDATE_VOICE_OVER_SANDBOXED_DEFAULTS } from "../errors";
+
+const VOICE_OVER_APPLESCRIPT_ENABLED_PLUTIL =
+  "plutil -replace SCREnableAppleScript -bool true ~/Library/Group\\ Containers/group.com.apple.VoiceOver/Library/Preferences/com.apple.VoiceOver4/default.plist";
+
+export function enableAppleScriptControlSandboxedDefaults(): void {
+  const platformMajor = getPlatformVersionMajor();
+
+  // For MacOS 14 Sonoma (Darwin 23) and earlier VoiceOver preferences are set via system defaults.
+  if (platformMajor < 24) {
+    return;
+  }
+
+  // From MacOS 15 Sequoia (Darwin 24) VoiceOver preferences are sandboxed.
+  try {
+    execSync(VOICE_OVER_APPLESCRIPT_ENABLED_PLUTIL, { encoding: "utf8" });
+
+    return;
+  } catch (e) {
+    throw new Error(
+      `${ERR_MACOS_UNABLE_UPDATE_VOICE_OVER_SANDBOXED_DEFAULTS}\n\n${e.message}`
+    );
+  }
+}

src/macOS/enableAppleScriptControlSystemDefaults.ts

@@ -1,12 +1,26 @@
 import { execSync } from "child_process";
+import { getPlatformVersionMajor } from "./getPlatformVersionMajor";
 import { ERR_MACOS_UNABLE_UPDATE_SYSTEM_DEFAULTS } from "../errors";
 
+const VOICE_OVER_APPLESCRIPT_ENABLED_DEFAULTS =
+  "defaults write com.apple.VoiceOver4/default SCREnableAppleScript -bool true";
+
 export function enableAppleScriptControlSystemDefaults(): void {
+  const platformMajor = getPlatformVersionMajor();
+
+  // From MacOS 15 Sequoia (Darwin 24) VoiceOver preferences are sandboxed.
+  if (platformMajor >= 24) {
+    return;
+  }
+
+  // For MacOS 14 Sonoma (Darwin 23) and earlier VoiceOver preferences are set via system defaults.
   try {
-    execSync(
-      "defaults write com.apple.VoiceOver4/default SCREnableAppleScript -bool true"
-    );
+    execSync(VOICE_OVER_APPLESCRIPT_ENABLED_DEFAULTS, { encoding: "utf8" });
+
+    return;
   } catch (e) {
-    throw new Error(`${ERR_MACOS_UNABLE_UPDATE_SYSTEM_DEFAULTS}\n\n${e.message}`);
+    throw new Error(
+      `${ERR_MACOS_UNABLE_UPDATE_SYSTEM_DEFAULTS}\n\n${e.message}`
+    );
   }
 }

src/macOS/enableDoNotDisturb.ts

@@ -1,9 +1,9 @@
 import { exec } from "child_process";
-import * as os from "os";
+import { promisify } from "util";
 import { ERR_MACOS_FAILED_TO_ENABLE_DO_NOT_DISTURB } from "../errors";
 import { runAppleScript } from "./runAppleScript";
-import { promisify } from "util";
 import { retryOnError } from "./retryOnError";
+import { getPlatformVersionMajor } from "./getPlatformVersionMajor";
 
 // REF: https://github.com/sindresorhus/do-not-disturb/issues/9
 const enableFocusModeShellscript = `defaults write com.apple.ncprefs.plist dnd_prefs -data 62706C6973743030D60102030405060708080A08085B646E644D6972726F7265645F100F646E64446973706C6179536C6565705F101E72657065617465644661636574696D6543616C6C73427265616B73444E445875736572507265665E646E64446973706C61794C6F636B5F10136661636574696D6543616E427265616B444E44090808D30B0C0D070F1057656E61626C6564546461746556726561736F6E093341C2B41C4FC9D3891001080808152133545D6C828384858C9499A0A1AAACAD00000000000001010000000000000013000000000000000000000000000000AE && killall usernoted && killall ControlCenter`;
@@ -88,22 +88,26 @@ my withTimeout(command, timeoutSeconds)
 };
 
 export async function enableDoNotDisturb() {
-  const platformMajor = Number(os.version().split("Version ")[1].split(".")[0]);
+  const platformMajor = getPlatformVersionMajor();
 
   try {
     if (platformMajor <= 20) {
       await promisify(exec)(enableFocusModeShellscript);
+
+      return;
     } else if (platformMajor === 21) {
       // From MacOS 12 Monterey (Darwin 21) there is no known way to enable DND via system defaults
       await retryOnError(() => runAppleScript(enableFocusModeAppleScript));
-    } else {
-      const { stdout: locale } = await promisify(exec)(getLocale);
 
-      // From MacOS 13 Ventura (Darwin 22) there is no known way to enable DND via system settings
-      await retryOnError(() =>
-        runAppleScript(enableFocusModeVenturaAppleScript(locale))
-      );
+      return;
     }
+
+    // From MacOS 13 Ventura (Darwin 22) there is no known way to enable DND via system settings
+    const { stdout: locale } = await promisify(exec)(getLocale);
+
+    await retryOnError(() =>
+      runAppleScript(enableFocusModeVenturaAppleScript(locale))
+    );
   } catch (e) {
     throw new Error(
       `${ERR_MACOS_FAILED_TO_ENABLE_DO_NOT_DISTURB}\n\n${e.message}`

src/macOS/getPlatformVersionMajor.ts

@@ -0,0 +1,4 @@
+import { version } from "os";
+
+export const getPlatformVersionMajor = () =>
+  Number(version().split("Version ")[1].split(".")[0]);

src/macOS/isAppleScriptControlEnabled/enabledDefaults.ts

@@ -1,16 +1,36 @@
-import { exec } from "child_process";
+import { execSync } from "child_process";
+import { getPlatformVersionMajor } from "../getPlatformVersionMajor";
 
 const VOICE_OVER_APPLESCRIPT_ENABLED_DEFAULTS =
   "defaults read com.apple.VoiceOver4/default SCREnableAppleScript";
 
-export async function enabledDefaults(): Promise<boolean> {
-  return await new Promise<boolean>((resolve) => {
-    exec(VOICE_OVER_APPLESCRIPT_ENABLED_DEFAULTS, (err, stdout) => {
-      if (err) {
-        resolve(false);
-      } else {
-        resolve(stdout.trim() === "1");
-      }
+const VOICE_OVER_APPLESCRIPT_ENABLED_PLUTIL =
+  "plutil -extract SCREnableAppleScript raw -o - ~/Library/Group\\ Containers/group.com.apple.VoiceOver/Library/Preferences/com.apple.VoiceOver4/default.plist";
+
+export function enabledDefaults(): boolean {
+  const platformMajor = getPlatformVersionMajor();
+
+  // For MacOS 14 Sonoma (Darwin 23) and earlier VoiceOver preferences are set via system defaults.
+  if (platformMajor < 24) {
+    try {
+      const result = execSync(VOICE_OVER_APPLESCRIPT_ENABLED_DEFAULTS, {
+        encoding: "utf8",
+      });
+
+      return result.trim() === "1";
+    } catch {
+      return false;
+    }
+  }
+
+  // From MacOS 15 Sequoia (Darwin 24) VoiceOver preferences are sandboxed.
+  try {
+    const result = execSync(VOICE_OVER_APPLESCRIPT_ENABLED_PLUTIL, {
+      encoding: "utf8",
     });
-  });
+
+    return result.trim() === "true";
+  } catch {
+    return false;
+  }
 }

src/macOS/setup.ts

@@ -3,6 +3,7 @@ import { macOSRecord } from "@guidepup/record";
 import chalk from "chalk";
 import { checkVersion } from "./checkVersion";
 import { enableAppleScriptControlSystemDefaults } from "./enableAppleScriptControlSystemDefaults";
+import { enableAppleScriptControlSandboxedDefaults } from "./enableAppleScriptControlSandboxedDefaults";
 import { disableSplashScreenSystemDefaults } from "./disableSplashScreenSystemDefaults";
 import { disableDictationInputAutoEnable } from "./disableDictationInputAutoEnable";
 import { isSipEnabled } from "./isSipEnabled";
@@ -61,6 +62,7 @@ export async function setup(): Promise<void> {
 
     if (!isSipEnabled() && !(await enabledDbFile())) {
       writeDatabaseFile();
+      enableAppleScriptControlSandboxedDefaults();
 
       return;
     }

src/macOS/updateTccDb.ts

@@ -241,7 +241,9 @@ export function updateTccDb(path: string): void {
     });`;
 
     try {
-      execSync(`sqlite3 "${path}" "${query}" >/dev/null 2>&1`);
+      execSync(`sqlite3 "${path}" "${query}" >/dev/null 2>&1`, {
+        encoding: "utf8",
+      });
     } catch (e) {
       throw new Error(
         `${ERR_MACOS_UNABLE_TO_WRITE_USER_TCC_DB}\n\n${e.message}`