applescript-node 1.0.1

package/dist/validator.d.ts

@@ -0,0 +1,106 @@
+import type { ApplicationDictionary, Class, Command } from './types.js';
+/**
+ * Validation severity levels
+ */
+export type ValidationSeverity = 'error' | 'warning' | 'info';
+/**
+ * Validation issue found in a script
+ */
+export interface ValidationIssue {
+    severity: ValidationSeverity;
+    message: string;
+    line?: number;
+    column?: number;
+    code?: string;
+    suggestion?: string;
+}
+/**
+ * Result of script validation
+ */
+export interface ValidationResult {
+    valid: boolean;
+    issues: ValidationIssue[];
+    errors: ValidationIssue[];
+    warnings: ValidationIssue[];
+    info: ValidationIssue[];
+}
+/**
+ * Options for script validation
+ */
+export interface ValidationOptions {
+    /**
+     * Strictness level for validation
+     * - 'strict': Treat warnings as errors
+     * - 'normal': Standard validation (default)
+     * - 'lenient': Only report errors, skip warnings
+     */
+    strictness?: 'strict' | 'normal' | 'lenient';
+    /**
+     * Whether to provide suggestions for fixes
+     */
+    provideSuggestions?: boolean;
+    /**
+     * Custom dictionary to validate against (otherwise fetched from appPath)
+     */
+    dictionary?: ApplicationDictionary;
+}
+/**
+ * Script validator for AppleScript validation against application sdef
+ */
+export declare class ScriptValidator {
+    private dictionary;
+    private appName;
+    constructor(dictionary: ApplicationDictionary, appName: string);
+    /**
+     * Create a validator for a specific application
+     */
+    static forApplication(appPath: string): Promise<ScriptValidator>;
+    /**
+     * Validate a script string
+     */
+    validate(script: string, options?: ValidationOptions): ValidationResult;
+    /**
+     * Extract tell application blocks from script
+     */
+    private extractTellBlocks;
+    /**
+     * Validate commands in script content
+     */
+    private validateCommands;
+    /**
+     * Validate property access in script content
+     */
+    private validateProperties;
+    /**
+     * Find a read-only property by name across all classes
+     */
+    private findReadOnlyProperty;
+    /**
+     * Suggest a similar command name using string similarity
+     */
+    private suggestSimilarCommand;
+    /**
+     * Calculate Levenshtein distance between two strings
+     */
+    private levenshteinDistance;
+    /**
+     * Validate a command and its parameters
+     */
+    validateCommand(commandName: string, parameters?: Record<string, unknown>): ValidationIssue[];
+    /**
+     * Validate property access on a class
+     */
+    validatePropertyAccess(className: string, propertyName: string, accessType: 'read' | 'write'): ValidationIssue[];
+    /**
+     * Get all available commands in the application
+     */
+    getAvailableCommands(): Command[];
+    /**
+     * Get all available classes in the application
+     */
+    getAvailableClasses(): Class[];
+}
+/**
+ * Quick validation helper function
+ */
+export declare function validateScript(script: string, appPath: string, options?: ValidationOptions): Promise<ValidationResult>;

package/package.json

@@ -0,0 +1,130 @@
+{
+  "name": "applescript-node",
+  "version": "1.0.1",
+  "description": "Node.js library for AppleScript integration",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "imports": {
+    "applescript-node": "./src/index.ts"
+  },
+  "scripts": {
+    "build": "pnpm run build:js && pnpm run build:types",
+    "build:js": "tsup",
+    "build:types": "rm -f tsconfig.build.tsbuildinfo && tsc -p tsconfig.build.json --emitDeclarationOnly",
+    "build:types:staged": "tsc --noEmit --skipLibCheck",
+    "dev": "tsup --watch",
+    "lint": "tsc --noEmit && eslint .",
+    "format": "prettier --write \"**/*.{ts,js,json}\"",
+    "format:fix": "prettier --write \"**/*.{ts,js,json}\" && eslint . --fix",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "pnpm run build",
+    "pretest": "pnpm run lint",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "test:coverage": "vitest run --coverage",
+    "example:basic": "tsx --tsconfig examples/tsconfig.json examples/basic-script.ts",
+    "example:builder": "tsx --tsconfig examples/tsconfig.json examples/fluent-builder.ts",
+    "example:compile": "tsx --tsconfig examples/tsconfig.json examples/script-compilation.ts",
+    "example:languages": "tsx --tsconfig examples/tsconfig.json examples/language-info.ts",
+    "example:decompile": "tsx --tsconfig examples/tsconfig.json examples/script-decompilation.ts",
+    "example:list-apps": "tsx --tsconfig examples/tsconfig.json examples/list-applications.ts",
+    "example:windows": "tsx --tsconfig examples/tsconfig.json examples/window-management.ts",
+    "example:messages": "tsx --tsconfig examples/tsconfig.json examples/messages-reader.ts",
+    "example:notes": "tsx --tsconfig examples/tsconfig.json examples/notes-automation.ts",
+    "example:notes-create": "tsx --tsconfig examples/tsconfig.json examples/notes-creation.ts",
+    "example:notes-json": "tsx --tsconfig examples/tsconfig.json examples/notes-latest-json.ts",
+    "example:contacts": "tsx --tsconfig examples/tsconfig.json examples/contacts-automation.ts",
+    "example:contacts-search": "tsx --tsconfig examples/tsconfig.json examples/contacts-search.ts",
+    "example:sdef": "tsx --tsconfig examples/tsconfig.json examples/sdef-introspection.ts",
+    "example:validation": "tsx --tsconfig examples/tsconfig.json examples/script-validation.ts",
+    "example:sources": "tsx --tsconfig examples/tsconfig.json examples/sources-demo.ts",
+    "example:ternary": "tsx --tsconfig examples/tsconfig.json examples/ternary-demo.ts",
+    "example:if-exists": "tsx --tsconfig examples/tsconfig.json examples/if-exists-demo.ts",
+    "example:first-or-default": "tsx --tsconfig examples/tsconfig.json examples/first-or-default-demo.ts",
+    "example:load-edit": "tsx --tsconfig examples/tsconfig.json examples/load-and-edit-script.ts",
+    "example:read-contacts": "tsx --tsconfig examples/tsconfig.json examples/read-contacts-list.ts",
+    "example:load-edit-save": "tsx --tsconfig examples/tsconfig.json examples/load-edit-save.ts",
+    "example:verify-load-save": "tsx --tsconfig examples/tsconfig.json examples/verify-load-save.ts",
+    "example:claude-process-gui": "tsx --tsconfig examples/tsconfig.json examples/claude-process-info-gui.ts",
+    "example:claude-process-complete": "tsx --tsconfig examples/tsconfig.json examples/claude-process-info-complete.ts",
+    "example:ui-explorer": "tsx --tsconfig examples/tsconfig.json examples/ui-explorer.ts",
+    "example:outline-explorer": "tsx --tsconfig examples/tsconfig.json examples/outline-explorer.ts",
+    "example:element-detail": "tsx --tsconfig examples/tsconfig.json examples/element-detail-explorer.ts",
+    "example:inspector-explorer": "tsx --tsconfig examples/tsconfig.json examples/inspector-explorer.ts",
+    "example:claude-open-files": "tsx --tsconfig examples/tsconfig.json examples/claude-open-files.ts",
+    "example:text-area-debug": "tsx --tsconfig examples/tsconfig.json examples/text-area-debug.ts",
+    "example:tab-structure": "tsx --tsconfig examples/tsconfig.json examples/tab-structure-explorer.ts",
+    "example:tab-group-content": "tsx --tsconfig examples/tsconfig.json examples/tab-group-content.ts",
+    "example:text-area-full": "tsx --tsconfig examples/tsconfig.json examples/text-area-full.ts",
+    "examples": "pnpm run example:basic && pnpm run example:languages && pnpm run example:compile && pnpm run example:builder && pnpm run example:decompile && pnpm run example:list-apps && pnpm run example:windows && pnpm run example:sdef && pnpm run example:validation",
+    "prepare": "husky",
+    "lint-staged": "lint-staged",
+    "typecheck": "tsc --noEmit --skipLibCheck",
+    "verify": "pnpm run lint && pnpm run test && pnpm run build",
+    "docs:dev": "cd docs && pnpm dev",
+    "docs:build": "cd docs && pnpm build",
+    "docs:serve": "cd docs && pnpm start"
+  },
+  "lint-staged": {
+    "src/**/*.{ts,tsx}": [
+      "eslint --fix",
+      "prettier --write",
+      "tsc --noEmit --skipLibCheck",
+      "vitest related --run",
+      "pnpm run build:types:staged"
+    ],
+    "examples/**/*.{ts,tsx}": [
+      "eslint --fix",
+      "prettier --write"
+    ],
+    "*.{json,md,yml,yaml}": [
+      "prettier --write"
+    ]
+  },
+  "keywords": [
+    "applescript",
+    "macos",
+    "automation",
+    "osascript",
+    "typescript"
+  ],
+  "author": "Matthew Herod",
+  "license": "MIT",
+  "engines": {
+    "node": ">=20"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "2.2.6",
+    "@eslint/eslintrc": "3.2.0",
+    "@eslint/js": "9.16.0",
+    "@types/node": "^22.10.1",
+    "@typescript-eslint/eslint-plugin": "^8.17.0",
+    "@typescript-eslint/parser": "^8.17.0",
+    "@vitest/coverage-v8": "2.1.8",
+    "eslint": "^9.16.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "globals": "15.13.0",
+    "husky": "9.1.7",
+    "lefthook": "1.13.6",
+    "lint-staged": "15.2.10",
+    "prettier": "^3.4.2",
+    "rollup": "4.28.0",
+    "tsup": "^8.3.5",
+    "tsx": "^4.7.0",
+    "typescript": "^5.7.2",
+    "ultracite": "5.6.4",
+    "vite": "6.4.1",
+    "vitest": "2.1.9"
+  },
+  "dependencies": {
+    "chalk": "5.6.2",
+    "cli-table3": "0.6.5",
+    "fast-xml-parser": "5.3.4"
+  }
+}