scriptable-typings 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Meadowsys
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# scriptable-types
+
+Type definitions for [Scriptable](https://scriptable.app), using their [official documentation](https://docs.scriptable.app) as a reference

package/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "scriptable-typings",
+  "version": "0.1.0",
+  "license": "MIT",
+  "types": "src/types.d.ts",
+  "files": [
+    "src"
+  ],
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  }
+}

package/src/types.d.ts

@@ -0,0 +1,125 @@
+declare class Alert {
+	title: string;
+	message: string;
+
+	constructor();
+
+	addAction(title: string);
+	addDestructiveAction(title: string);
+	addCancelAction(title: string);
+	addTextField(placeholder: string, text: string): TextField;
+	addSecureTextField(placeholder: string, text: string): TextField;
+	textFieldValue(index: number): string;
+	present(): Promise<number>;
+	presentAlert(): Promise<number>;
+	presentSheet(): Promise<number>;
+};
+
+declare const args: Args;
+declare type Args = {
+	/**
+	 * @deprecated
+	 */
+	readonly length: number;
+
+	/**
+	 * @deprecated
+	 */
+	readonly all: Array<unknown>;
+
+	readonly plainTexts: Array<string>;
+	readonly urls: Array<string>;
+	readonly fileURLs: Array<string>;
+	readonly images: Array<string>;
+	readonly queryParameters: { [k: string]: string };
+
+	/**
+	 * @deprecated
+	 */
+	readonly siriShortcutArguments: { [k: string]: string };
+
+	readonly shortcutParameter: unknown;
+	readonly widgetParameter: unknown;
+	readonly notification: Notification;
+};
+
+declare class Calendar {
+	readonly identifier: string;
+	title: string;
+	readonly isSubscribed: boolean;
+	readonly allowsContentModifications: boolean;
+	color: Color;
+
+	supportsAvailability(availability: string): boolean;
+	save();
+	remove();
+	static forReminders(): Promise<Array<Calendar>>;
+	static forEvents(): Promise<Array<Calendar>>;
+	static forRemindersByTitle(title: string): Promise<Calendar>;
+	static forEventsByTitle(title: string): Promise<Calendar>;
+	static createForReminders(title: string): Promise<Calendar>;
+	static findOrCreateForReminders(title: string): Promise<Calendar>;
+	static defaultForReminders(): Promise<Calendar>;
+	static defaultForEvents(): Promise<Calendar>;
+	// todo i'm guessing these, need to test
+	static presentPicker(allowMultiple: true): Promise<Array<Calendar>>;
+	static presentPicker(allowMultiple: false): Promise<[Calendar?]>;
+};
+
+// todo CalendarEvent
+// todo CallbackURL
+// todo Color
+// todo config
+// todo console
+// todo Contact
+// todo ContactsContainer
+// todo ContactsGroup
+// todo Data
+// todo DateFormatter
+// todo DatePicker
+// todo Device
+// todo Dictation
+// todo DocumentPicker
+// todo DrawContext
+// todo FileManager
+// todo Font
+// todo Image
+// todo importModule
+// todo Keychain
+// todo LinearGradient
+// todo ListWidget
+// todo Location
+// todo Mail
+// todo Message
+// todo module
+// todo Notification
+// todo Pasteboard
+// todo Path
+// todo Photos
+// todo Point
+// todo QuickLook
+// todo Rect
+// todo RecurrenceRule
+// todo RelativeDateTimeFormatter
+// todo Reminder
+// todo Request
+// todo Safari
+// todo Script
+// todo SFSymbol
+// todo ShareSheet
+// todo Size
+// todo Speech
+// todo TextField
+// todo Timer
+// todo UITable
+// todo UITableCell
+// todo UITableRow
+// todo URLScheme
+// todo UUID
+// todo WebView
+// todo WidgetDate
+// todo WidgetImage
+// todo WidgetSpacer
+// todo WidgetStack
+// todo WidgetText
+// todo XMLParser