Scriptable-abstract NPM

Scriptable Abstract

Abstract class definitions and type structures for Scriptable-iOS, providing the foundation for building mock implementations and type-safe Scriptable development tools.

Features

Complete type definitions extracted from @types/scriptable-ios
Abstract class implementations with structural information
Automatic code generation for class structures
Used as the foundation for scriptable-mocks and other tools
ESM and CommonJS module support
Version tracking of source type definitions

Installation

npm install scriptable-abstract
# or
pnpm add scriptable-abstract

Usage

Building Mock Implementations

import { AbsAlert } from 'scriptable-abstract';

class MockAlert extends AbsAlert {
  private _title: string = '';
  private _message: string = '';

  get title(): string {
    return this._title;
  }

  set title(value: string) {
    this._title = value;
  }

  get message(): string {
    return this._message;
  }

  set message(value: string) {
    this._message = value;
  }

  async present(): Promise<number> {
    // Mock implementation
    return 0;
  }
}

Using Generic Types

import { AbsCallbackURL } from 'scriptable-abstract';

// With type parameter for shortcuts
const shortcutURL = new AbsCallbackURL<`shortcuts://x-callback-url/${string}`>();

Project Structure

scriptable-abstract/
├── src/
│   ├── core/           # Core parsing and generation
│   ├── generators/     # Structure generators
│   └── types/         # Type definitions
├── generated/         # Generated class structures
└── dist/             # Compiled output

Scripts

pnpm generate - Generate abstract structures
pnpm build - Build the project
pnpm clean - Clean generated files
pnpm format - Format code
pnpm lint - Lint code

License

MIT

Version Compatibility

This package uses semantic versioning independently from @types/scriptable-ios. Each version specifies the compatible version of @types/scriptable-ios in its dependencies.

For example: