├── README.md ├── .gitignore ├── lib.applescript └── LICENSE /README.md: -------------------------------------------------------------------------------- 1 | # AppleScript utility handlers 2 | 3 | A small library of utility handlers, or functions, for use in modern AppleScript. This library is tested in recent versions of MacOS (Ventura). 4 | 5 | The goal of this library is to provide an easy drop-in set of handlers that account for multiple cases, and at the very least catch errors in case of an issue. Much of the AppleScript on the internet comes from an outdated source, so it's often untested in the context of new MacOS. 6 | 7 | ### Roadmap 8 | 9 | TODO 10 | 11 | This is a work in progress, I'm currently adding my old AppleScript to the `lib.applescript` file and in the process of adjusting them for the new(er) MacOS. 12 | 13 | - Add additional handlers 14 | - Sort by category 15 | - Provide usage docs 16 | - Compile and provide binary file 17 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | .pnpm-debug.log* 9 | 10 | # Diagnostic reports (https://nodejs.org/api/report.html) 11 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 12 | 13 | # Runtime data 14 | pids 15 | *.pid 16 | *.seed 17 | *.pid.lock 18 | 19 | # Directory for instrumented libs generated by jscoverage/JSCover 20 | lib-cov 21 | 22 | # Coverage directory used by tools like istanbul 23 | coverage 24 | *.lcov 25 | 26 | # nyc test coverage 27 | .nyc_output 28 | 29 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 30 | .grunt 31 | 32 | # Bower dependency directory (https://bower.io/) 33 | bower_components 34 | 35 | # node-waf configuration 36 | .lock-wscript 37 | 38 | # Compiled binary addons (https://nodejs.org/api/addons.html) 39 | build/Release 40 | 41 | # Dependency directories 42 | node_modules/ 43 | jspm_packages/ 44 | 45 | # Snowpack dependency directory (https://snowpack.dev/) 46 | web_modules/ 47 | 48 | # TypeScript cache 49 | *.tsbuildinfo 50 | 51 | # Optional npm cache directory 52 | .npm 53 | 54 | # Optional eslint cache 55 | .eslintcache 56 | 57 | # Optional stylelint cache 58 | .stylelintcache 59 | 60 | # Microbundle cache 61 | .rpt2_cache/ 62 | .rts2_cache_cjs/ 63 | .rts2_cache_es/ 64 | .rts2_cache_umd/ 65 | 66 | # Optional REPL history 67 | .node_repl_history 68 | 69 | # Output of 'npm pack' 70 | *.tgz 71 | 72 | # Yarn Integrity file 73 | .yarn-integrity 74 | 75 | # dotenv environment variable files 76 | .env 77 | .env.development.local 78 | .env.test.local 79 | .env.production.local 80 | .env.local 81 | 82 | # parcel-bundler cache (https://parceljs.org/) 83 | .cache 84 | .parcel-cache 85 | 86 | # Next.js build output 87 | .next 88 | out 89 | 90 | # Nuxt.js build / generate output 91 | .nuxt 92 | dist 93 | 94 | # Gatsby files 95 | .cache/ 96 | # Comment in the public line in if your project uses Gatsby and not Next.js 97 | # https://nextjs.org/blog/next-9-1#public-directory-support 98 | # public 99 | 100 | # vuepress build output 101 | .vuepress/dist 102 | 103 | # vuepress v2.x temp and cache directory 104 | .temp 105 | .cache 106 | 107 | # Docusaurus cache and generated files 108 | .docusaurus 109 | 110 | # Serverless directories 111 | .serverless/ 112 | 113 | # FuseBox cache 114 | .fusebox/ 115 | 116 | # DynamoDB Local files 117 | .dynamodb/ 118 | 119 | # TernJS port file 120 | .tern-port 121 | 122 | # Stores VSCode versions used for testing VSCode extensions 123 | .vscode-test 124 | 125 | # yarn v2 126 | .yarn/cache 127 | .yarn/unplugged 128 | .yarn/build-state.yml 129 | .yarn/install-state.gz 130 | .pnp.* 131 | -------------------------------------------------------------------------------- /lib.applescript: -------------------------------------------------------------------------------- 1 | (* 2 | AppleScript utility handlers 3 | A drop-in library of modern AppleScript utility functions 4 | 5 | Version 0.1 6 | APL 2.0 7 | *) 8 | 9 | -- Compile AppleScript 10 | -- Perform compilation on .AppleScript file to make it into a binary 11 | on compileAppleScript(sourcePath, destPath) 12 | set shellCommand to "osacompile -o " & destPath & " " & sourcePath 13 | try 14 | do shell script shellCommand 15 | on error errMsg number errNum 16 | display dialog "An error occurred: " & errMsg & " (Error " & errNum & ")" 17 | end try 18 | end compileAppleScript 19 | 20 | -- Macintosh-flavor paths 21 | -- Convert between classic macintosh-style and unix-style paths, and vice-versa 22 | on convertPathToUnixStyle(macPath) 23 | try 24 | set oldDelims to AppleScript's text item delimiters 25 | set AppleScript's text item delimiters to ":" 26 | set pathItems to text items of macPath 27 | set AppleScript's text item delimiters to "/" 28 | set unixPath to "/" & pathItems as text 29 | set AppleScript's text item delimiters to oldDelims 30 | return unixPath 31 | on error errMsg number errNum 32 | display dialog "An error occurred: " & errMsg & " (Error " & errNum & ")" 33 | end try 34 | end convertPathToUnixStyle 35 | 36 | on convertPathToMacStyle(unixPath) 37 | try 38 | set oldDelims to AppleScript's text item delimiters 39 | set AppleScript's text item delimiters to "/" 40 | set pathItems to text items of unixPath 41 | set AppleScript's text item delimiters to ":" 42 | set macPath to pathItems as text 43 | set AppleScript's text item delimiters to oldDelims 44 | return macPath 45 | on error errMsg number errNum 46 | display dialog "An error occurred: " & errMsg & " (Error " & errNum & ")" 47 | end try 48 | end convertPathToMacStyle 49 | 50 | -- Switch the current app 51 | -- Switch to a particular app name, and optionally start the app if it isn't open yet 52 | on switchApp(appName, startApp) 53 | try 54 | tell application "System Events" 55 | if exists application process appName then 56 | if not (exists (process appName)) then 57 | if startApp is true then 58 | tell application appName to activate 59 | else 60 | display dialog appName & " is not currently running, and the script is set not to open it." 61 | end if 62 | else 63 | set frontmost of process appName to true 64 | end if 65 | else 66 | display dialog "The application " & appName & " could not be found." 67 | end if 68 | end tell 69 | on error errMsg 70 | display dialog "Error switching to app: " & errMsg 71 | end try 72 | end switchApp 73 | 74 | -- Cycle through windows of an app 75 | -- Switch to a window number, or to a particular matching window title string 76 | on switchWindow(appName, targetTitle, windowNumber) 77 | try 78 | set targetApp to "" 79 | if appName is "" then 80 | tell application "System Events" 81 | set targetApp to name of first application process whose frontmost is true 82 | end tell 83 | else 84 | set targetApp to appName 85 | end if 86 | tell application targetApp 87 | set windowCount to count of windows 88 | if windowCount > 1 then 89 | if targetTitle is not "" then 90 | repeat with i from 1 to windowCount 91 | if name of window i is targetTitle then 92 | set index of window i to 1 93 | return "Switched to window '" & targetTitle & "' in " & targetApp & "." 94 | end if 95 | end repeat 96 | return "No window with title '" & targetTitle & "' found in " & targetApp & "." 97 | else if windowNumber is not "" then 98 | if windowNumber > 0 and windowNumber <= windowCount then 99 | set index of window windowNumber to 1 100 | return "Switched to window " & windowNumber & " in " & targetApp & "." 101 | else 102 | return "Invalid window number. Choose a number between 1 and " & windowCount & "." 103 | end if 104 | else 105 | set index of window 1 to windowCount 106 | return "Switched to window " & windowCount & " in " & targetApp & "." 107 | end if 108 | else 109 | return "There's only one window open for " & targetApp & "." 110 | end if 111 | end tell 112 | on error errMsg 113 | return "Error switching window: " & errMsg 114 | end try 115 | end switchWindow 116 | 117 | -- Get file or folder size 118 | -- Use Finder to get the size of a file or folder, as an integer 119 | on getSize(itemPath) 120 | try 121 | tell application "Finder" 122 | get size of (POSIX file itemPath as alias) 123 | end tell 124 | on error errMsg 125 | display dialog "Error getting size of the item: " & errMsg 126 | end try 127 | end getSize 128 | 129 | -- Read file 130 | -- Safely read from a file 131 | on readTextFile(filePath) 132 | try 133 | set fileContent to read file filePath as text 134 | on error errMsg number errNum 135 | display dialog "Error reading file: " & filePath & return & "Error Message: " & errMsg & " | Error Number: " & errNum 136 | return "" 137 | end try 138 | return fileContent 139 | end readTextFile 140 | 141 | -- Write to file 142 | -- Safely write content to a text file, with an option to either overwrite or append to an existing file's contents 143 | on writeTextToFile(content, filePath, overwrite) 144 | try 145 | set fileDescriptor to open for access file filePath with write permission 146 | if overwrite is true then 147 | set eof of fileDescriptor to 0 -- if overwrite is true, reset the end of file marker to 0 148 | end if 149 | write content to fileDescriptor starting at eof -- write content, if overwrite is false, it will start at eof and append 150 | close access fileDescriptor 151 | on error errMsg 152 | display dialog "Error writing to file: " & errMsg 153 | try 154 | close access file filePath 155 | end try 156 | end try 157 | end writeTextToFile 158 | 159 | -- Delete file 160 | -- Either move a file to trash or skip the trash, deleting it permanently 161 | on deleteItem(itemPath, permanent) 162 | try 163 | if permanent is true then 164 | do shell script "rm " & quoted form of POSIX path of itemPath 165 | else 166 | tell application "Finder" 167 | delete POSIX file itemPath 168 | end tell 169 | end if 170 | on error errMsg 171 | display dialog "Error deleting item: " & errMsg 172 | end try 173 | end deleteItem 174 | 175 | -- Create notification 176 | on showNotification(title, message) 177 | if title is not "" and message is not "" then 178 | try 179 | display notification message with title title 180 | on error errMsg 181 | display dialog "Failed to display notification: " & errMsg 182 | end try 183 | else 184 | display dialog "Error: Both title and message must be non-empty strings." 185 | end if 186 | end showNotification 187 | 188 | -- Toggle dark mode 189 | -- Switch between dark and light mode, including forcing any apps that adhere to the system setting for color mode 190 | on toggleDarkMode() 191 | try 192 | tell application "System Events" 193 | tell appearance preferences 194 | set dark mode to not dark mode 195 | end tell 196 | end tell 197 | on error errMsg 198 | display dialog "Error toggling dark mode: " & errMsg 199 | end try 200 | end toggleDarkMode 201 | 202 | -- Timer 203 | -- Display a timed dialog box, setting a timer in seconds 204 | on displayTimedDialog(message, seconds) 205 | try 206 | if seconds < 0 then error "Negative time is not valid" 207 | display dialog message giving up after seconds 208 | on error errMsg 209 | display dialog "Error displaying timed dialog: " & errMsg 210 | end try 211 | end displayTimedDialog 212 | 213 | -- Set volume 214 | -- Set system volume as a 0 to 100 integer value 215 | on setVolume(level) 216 | try 217 | if level < 0 or level > 100 then error 218 | set volume output volume level 219 | on error 220 | display dialog "Error: Invalid volume level. Please enter a number between 0 and 100." 221 | end try 222 | end setVolume 223 | 224 | -- Open URL 225 | -- Open an address in the default browser, or specify a browser 226 | on openURL(url, browser) 227 | try 228 | if browser is "" or browser is missing value then 229 | -- use default browser 230 | tell application "System Events" 231 | open location url 232 | end tell 233 | else 234 | -- use custom browser 235 | tell application browser 236 | open location url 237 | end tell 238 | end if 239 | on error errMsg 240 | display dialog "Error opening URL: " & errMsg 241 | end try 242 | end openURL 243 | 244 | -- Set desktop background 245 | on setDesktopPicture(filePath) 246 | try 247 | tell application "Finder" 248 | set desktop picture to POSIX file filePath 249 | end tell 250 | on error errMsg 251 | display dialog "Error setting desktop picture: " & errMsg 252 | end try 253 | end setDesktopPicture 254 | 255 | -- Eject all external disks 256 | on ejectAllDisks() 257 | try 258 | tell application "Finder" 259 | eject (every disk whose ejectable is true) 260 | end tell 261 | on error errMsg 262 | display dialog "Error ejecting disks: " & errMsg 263 | end try 264 | end ejectAllDisks 265 | 266 | -- Set custom sleep 267 | on setSleepSettings(displaySleepMinutes, diskSleepMinutes) 268 | try 269 | do shell script "sudo pmset displaysleep " & displaySleepMinutes & " disksleep " & diskSleepMinutes with administrator privileges 270 | on error errMsg 271 | display dialog "Error setting sleep settings: " & errMsg 272 | end try 273 | end setSleepSettings 274 | 275 | -- Quit all apps 276 | on quitAllApps() 277 | try 278 | tell application "System Events" 279 | set allApps to name of every application process whose background only is false 280 | repeat with appName in allApps 281 | tell application appName to quit 282 | end repeat 283 | end tell 284 | on error errMsg 285 | display dialog "Error quitting apps: " & errMsg 286 | end try 287 | end quitAllApps 288 | 289 | -- Return the current wifi network 290 | on getCurrentWiFi() 291 | try 292 | do shell script "/System/Library/PrivateFrameworks/Apple80211.framework/Versions/A/Resources/airport -I | awk '/ SSID/ {print substr($0, index($0, $2))}'" 293 | on error errMsg 294 | 295 | -- Convert image 296 | -- Convert an image into another image, changing the types, most often used to convert HEIC to PNG or JPG 297 | on convertImage(sourcePath, destinationPath, format) 298 | try 299 | if format is not in {"jpeg", "png"} then error "Invalid format. Please specify 'jpeg' or 'png'." 300 | do shell script "sips -s format " & format & " " & quoted form of sourcePath & " --out " & quoted form of destinationPath 301 | on error errMsg 302 | display dialog "Error converting image: " & errMsg 303 | end try 304 | end convertImage 305 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------