@ebowwa/osascript 1.1.0

package/src/types.ts

@@ -0,0 +1,189 @@
+/**
+ * @fileoverview Type definitions for osascript MCP
+ */
+
+/**
+ * Result from executing osascript
+ */
+export interface OsascriptResult {
+  success: boolean;
+  stdout: string;
+  stderr: string;
+  exitCode: number;
+}
+
+/**
+ * Script language type
+ */
+export type ScriptLanguage = "applescript" | "javascript";
+
+/**
+ * Options for executing scripts
+ */
+export interface ExecuteOptions {
+  /** Script language (default: applescript) */
+  language?: ScriptLanguage;
+  /** Timeout in milliseconds (default: 30000) */
+  timeout?: number;
+}
+
+/**
+ * Dialog button configuration
+ */
+export interface DialogButton {
+  /** Button label */
+  label: string;
+  /** Button action (default button) */
+  default?: boolean;
+}
+
+/**
+ * Dialog options
+ */
+export interface DialogOptions {
+  /** Dialog title */
+  title?: string;
+  /** Dialog message */
+  message: string;
+  /** Buttons to display */
+  buttons?: string[];
+  /** Default button index (1-based) */
+  defaultButton?: number;
+  /** Icon type: note, caution, stop */
+  icon?: "note" | "caution" | "stop";
+  /** Give up after seconds */
+  givingUpAfter?: number;
+}
+
+/**
+ * Dialog result
+ */
+export interface DialogResult {
+  /** Button that was clicked */
+  buttonReturned: string;
+  /** Text entered if text fields present */
+  textReturned?: string;
+  /** Whether dialog timed out */
+  gaveUp?: boolean;
+}
+
+/**
+ * Notification options
+ */
+export interface NotificationOptions {
+  /** Notification title */
+  title?: string;
+  /** Notification subtitle */
+  subtitle?: string;
+  /** Notification body text */
+  message: string;
+  /** Sound name */
+  soundName?: string;
+}
+
+/**
+ * Window information
+ */
+export interface WindowInfo {
+  /** Window name/title */
+  name: string | null;
+  /** Window ID */
+  id: number;
+  /** Window index (z-order) */
+  index: number;
+  /** Whether window is visible */
+  visible?: boolean;
+  /** Window bounds {x, y, width, height} */
+  bounds?: {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+  };
+}
+
+/**
+ * Application information
+ */
+export interface ApplicationInfo {
+  /** Application name */
+  name: string;
+  /** Display name */
+  displayName?: string;
+  /** Application path */
+  path?: string;
+  /** Whether app is running */
+  running: boolean;
+  /** Window count */
+  windowCount?: number;
+  /** Process ID */
+  processId?: number;
+}
+
+/**
+ * Keystroke options
+ */
+export interface KeystrokeOptions {
+  /** Key to press */
+  key: string;
+  /** Modifiers: command, shift, option, control */
+  modifiers?: ("command" | "shift" | "option" | "control")[];
+  /** Delay between keystrokes in seconds */
+  delay?: number;
+}
+
+/**
+ * Key code options (for special keys)
+ */
+export interface KeyCodeOptions {
+  /** Key code number */
+  keyCode: number;
+  /** Modifiers */
+  modifiers?: ("command" | "shift" | "option" | "control")[];
+}
+
+/**
+ * Volume info
+ */
+export interface VolumeInfo {
+  /** Volume level 0-100 */
+  volume: number;
+  /** Whether muted */
+  muted: boolean;
+}
+
+/**
+ * Display info
+ */
+export interface DisplayInfo {
+  /** Display name/ID */
+  id: number;
+  /** Width in pixels */
+  width: number;
+  /** Height in pixels */
+  height: number;
+  /** Color depth */
+  depth?: number;
+  /** Whether this is the main display */
+  main?: boolean;
+}
+
+/**
+ * File/folder item from Finder
+ */
+export interface FinderItem {
+  /** Item name */
+  name: string;
+  /** Full path */
+  path: string;
+  /** Type: file, folder, application, etc. */
+  type: "file" | "folder" | "application" | "disk" | "alias" | "unknown";
+  /** Size in bytes (files only) */
+  size?: number;
+  /** Creation date */
+  created?: string;
+  /** Modification date */
+  modified?: string;
+  /** Whether item exists */
+  exists: boolean;
+}