@auroraview/sdk 0.3.21

package/dist/bridge-CRwRGPq-.d.cts

@@ -0,0 +1,306 @@
+/**
+ * AuroraView SDK Core Types
+ *
+ * Type definitions for the AuroraView bridge API.
+ */
+/** Event handler function */
+type EventHandler<T = unknown> = (data: T) => void;
+/** Unsubscribe function returned by event subscriptions */
+type Unsubscribe = () => void;
+/** State change handler function */
+type StateChangeHandler = (key: string, value: unknown, source: 'python' | 'javascript') => void;
+/** IPC message payload types */
+type IPCMessageType = 'call' | 'event' | 'invoke';
+/** Base IPC message structure */
+interface IPCMessage {
+    type: IPCMessageType;
+    id?: string;
+}
+/** Call message (JS -> Python RPC) */
+interface CallMessage extends IPCMessage {
+    type: 'call';
+    id: string;
+    method: string;
+    params?: unknown;
+}
+/** Event message (JS -> Python fire-and-forget) */
+interface EventMessage extends IPCMessage {
+    type: 'event';
+    event: string;
+    detail?: unknown;
+}
+/** Invoke message (JS -> Python plugin command) */
+interface InvokeMessage extends IPCMessage {
+    type: 'invoke';
+    id: string;
+    cmd: string;
+    args: Record<string, unknown>;
+}
+/** Call result from Python */
+interface CallResult<T = unknown> {
+    id: string;
+    ok: boolean;
+    result?: T;
+    error?: CallErrorInfo;
+}
+/** Error information from failed calls */
+interface CallErrorInfo {
+    name?: string;
+    message: string;
+    code?: string | number;
+    data?: unknown;
+}
+/** Plugin invoke result */
+interface PluginResult<T = unknown> {
+    success?: boolean;
+    error?: string;
+    code?: string;
+    [key: string]: T | boolean | string | undefined;
+}
+/** Directory entry from readDir */
+interface DirEntry {
+    name: string;
+    path: string;
+    isDir: boolean;
+    isFile: boolean;
+    size?: number;
+    modified?: number;
+    created?: number;
+}
+/** File stat result */
+interface FileStat {
+    size: number;
+    isDir: boolean;
+    isFile: boolean;
+    isSymlink: boolean;
+    modified?: number;
+    created?: number;
+    accessed?: number;
+    readonly?: boolean;
+}
+/** File filter for dialogs */
+interface FileFilter {
+    name: string;
+    extensions: string[];
+}
+/** Open file dialog options */
+interface OpenFileOptions {
+    title?: string;
+    defaultPath?: string;
+    filters?: FileFilter[];
+}
+/** Open file result */
+interface OpenFileResult {
+    path: string | null;
+    cancelled: boolean;
+}
+/** Open files result */
+interface OpenFilesResult {
+    paths: string[];
+    cancelled: boolean;
+}
+/** Save file dialog options */
+interface SaveFileOptions {
+    title?: string;
+    defaultPath?: string;
+    defaultName?: string;
+    filters?: FileFilter[];
+}
+/** Message dialog options */
+interface MessageOptions {
+    message: string;
+    title?: string;
+    level?: 'info' | 'warning' | 'error';
+    buttons?: 'ok' | 'ok_cancel' | 'yes_no' | 'yes_no_cancel';
+}
+/** Message dialog result */
+interface MessageResult {
+    response: 'ok' | 'cancel' | 'yes' | 'no';
+}
+/** Confirm dialog result */
+interface ConfirmResult {
+    confirmed: boolean;
+}
+/** Shell execute options */
+interface ExecuteOptions {
+    cwd?: string;
+    env?: Record<string, string>;
+}
+/** Shell execute result */
+interface ExecuteResult {
+    code: number | null;
+    stdout: string;
+    stderr: string;
+}
+/** Shell spawn result */
+interface SpawnResult {
+    success: boolean;
+    pid: number;
+}
+/** Process output event data */
+interface ProcessOutput {
+    pid: number;
+    data: string;
+}
+/** Process exit event data */
+interface ProcessExit {
+    pid: number;
+    code: number | null;
+}
+/** Window event types */
+type WindowEventType = 'shown' | 'hidden' | 'focused' | 'blurred' | 'resized' | 'moved' | 'minimized' | 'maximized' | 'restored' | 'closing' | 'closed';
+/** Window event data */
+interface WindowEventData {
+    type: WindowEventType;
+    x?: number;
+    y?: number;
+    width?: number;
+    height?: number;
+    timestamp?: number;
+}
+declare global {
+    interface Window {
+        auroraview?: AuroraViewBridge;
+        ipc?: {
+            postMessage(message: string): void;
+        };
+    }
+}
+/** Raw bridge interface exposed on window.auroraview */
+interface AuroraViewBridge {
+    _ready: boolean;
+    _isStub?: boolean;
+    _pendingCalls: unknown[];
+    _boundMethods: Record<string, boolean>;
+    call<T = unknown>(method: string, params?: unknown): Promise<T>;
+    invoke<T = unknown>(cmd: string, args?: Record<string, unknown>): Promise<T>;
+    send_event(event: string, detail?: unknown): void;
+    on(event: string, handler: EventHandler): Unsubscribe;
+    off?(event: string, handler?: EventHandler): void;
+    trigger(event: string, detail?: unknown): void;
+    whenReady(): Promise<AuroraViewBridge>;
+    isReady(): boolean;
+    isMethodBound?(fullMethodName: string): boolean;
+    getBoundMethods?(): string[];
+    _registerApiMethods?(namespace: string, methods: string[], options?: {
+        allowRebind?: boolean;
+    }): void;
+    /** Start native window drag (for frameless windows) */
+    startDrag?(): void;
+    api?: Record<string, (params?: unknown) => Promise<unknown>>;
+    state?: AuroraViewState;
+    fs?: FileSystemAPI;
+    dialog?: DialogAPI;
+    clipboard?: ClipboardAPI;
+    shell?: ShellAPI;
+}
+/** State proxy interface */
+interface AuroraViewState {
+    [key: string]: unknown;
+    onChange(handler: StateChangeHandler): Unsubscribe;
+    offChange(handler: StateChangeHandler): void;
+    toJSON(): Record<string, unknown>;
+    keys(): string[];
+}
+/** File system API interface */
+interface FileSystemAPI {
+    readFile(path: string, encoding?: string): Promise<string>;
+    readFileBinary(path: string): Promise<string>;
+    readFileBuffer(path: string): Promise<ArrayBuffer>;
+    writeFile(path: string, contents: string, append?: boolean): Promise<void>;
+    writeFileBinary(path: string, contents: ArrayBuffer | Uint8Array, append?: boolean): Promise<void>;
+    readDir(path: string, recursive?: boolean): Promise<DirEntry[]>;
+    createDir(path: string, recursive?: boolean): Promise<void>;
+    remove(path: string, recursive?: boolean): Promise<void>;
+    copy(from: string, to: string): Promise<void>;
+    rename(from: string, to: string): Promise<void>;
+    exists(path: string): Promise<boolean>;
+    stat(path: string): Promise<FileStat>;
+}
+/** Dialog API interface */
+interface DialogAPI {
+    openFile(options?: OpenFileOptions): Promise<OpenFileResult>;
+    openFiles(options?: OpenFileOptions): Promise<OpenFilesResult>;
+    openFolder(options?: OpenFileOptions): Promise<OpenFileResult>;
+    openFolders(options?: OpenFileOptions): Promise<OpenFilesResult>;
+    saveFile(options?: SaveFileOptions): Promise<OpenFileResult>;
+    message(options: MessageOptions): Promise<MessageResult>;
+    confirm(options: {
+        message: string;
+        title?: string;
+    }): Promise<ConfirmResult>;
+    info(message: string, title?: string): Promise<MessageResult>;
+    warning(message: string, title?: string): Promise<MessageResult>;
+    error(message: string, title?: string): Promise<MessageResult>;
+    ask(message: string, title?: string): Promise<boolean>;
+}
+/** Clipboard API interface */
+interface ClipboardAPI {
+    readText(): Promise<string>;
+    writeText(text: string): Promise<void>;
+    clear(): Promise<void>;
+    hasText(): Promise<boolean>;
+    readImage(): Promise<string | null>;
+    writeImage(base64: string): Promise<void>;
+}
+/** Shell API interface */
+interface ShellAPI {
+    open(url: string): Promise<void>;
+    openPath(path: string): Promise<void>;
+    showInFolder(path: string): Promise<void>;
+    execute(command: string, args?: string[], options?: ExecuteOptions): Promise<ExecuteResult>;
+    spawn(command: string, args?: string[], options?: ExecuteOptions): Promise<SpawnResult>;
+    which(command: string): Promise<string | null>;
+    getEnv(name: string): Promise<string | null>;
+    getEnvAll(): Promise<Record<string, string>>;
+}
+
+/**
+ * AuroraView SDK Bridge Client
+ *
+ * Provides a type-safe wrapper around the native bridge API.
+ */
+
+/**
+ * AuroraView client interface
+ */
+interface AuroraViewClient {
+    /** Call a Python method (RPC-style) */
+    call<T = unknown>(method: string, params?: unknown): Promise<T>;
+    /** Invoke a plugin command */
+    invoke<T = unknown>(cmd: string, args?: Record<string, unknown>): Promise<T>;
+    /** Send an event to Python (fire-and-forget) */
+    emit(event: string, data?: unknown): void;
+    /** Subscribe to an event from Python */
+    on<T = unknown>(event: string, handler: EventHandler<T>): Unsubscribe;
+    /** Subscribe to an event once */
+    once<T = unknown>(event: string, handler: EventHandler<T>): Unsubscribe;
+    /** Unsubscribe from an event */
+    off(event: string, handler?: EventHandler): void;
+    /** Check if bridge is ready */
+    isReady(): boolean;
+    /** Wait for bridge to be ready */
+    whenReady(): Promise<AuroraViewClient>;
+    /** Get the raw bridge object */
+    getRawBridge(): AuroraViewBridge | undefined;
+    /** File system API */
+    readonly fs: FileSystemAPI | undefined;
+    /** Dialog API */
+    readonly dialog: DialogAPI | undefined;
+    /** Clipboard API */
+    readonly clipboard: ClipboardAPI | undefined;
+    /** Shell API */
+    readonly shell: ShellAPI | undefined;
+    /** Shared state */
+    readonly state: AuroraViewState | undefined;
+}
+/**
+ * Create or get the AuroraView client instance
+ */
+declare function createAuroraView(): AuroraViewClient;
+/**
+ * Get the AuroraView client instance (alias for createAuroraView)
+ */
+declare function getAuroraView(): AuroraViewClient;
+
+export { type AuroraViewClient as A, type CallMessage as C, type DirEntry as D, type EventHandler as E, type FileStat as F, type IPCMessage as I, type MessageOptions as M, type OpenFileOptions as O, type PluginResult as P, type StateChangeHandler as S, type Unsubscribe as U, type WindowEventType as W, type EventMessage as a, type InvokeMessage as b, createAuroraView as c, type CallResult as d, type CallErrorInfo as e, type FileFilter as f, getAuroraView as g, type OpenFileResult as h, type OpenFilesResult as i, type SaveFileOptions as j, type MessageResult as k, type ConfirmResult as l, type ExecuteOptions as m, type ExecuteResult as n, type SpawnResult as o, type ProcessOutput as p, type ProcessExit as q, type WindowEventData as r, type AuroraViewBridge as s, type AuroraViewState as t, type FileSystemAPI as u, type DialogAPI as v, type ClipboardAPI as w, type ShellAPI as x };

package/dist/bridge-CRwRGPq-.d.ts

@@ -0,0 +1,306 @@
+/**
+ * AuroraView SDK Core Types
+ *
+ * Type definitions for the AuroraView bridge API.
+ */
+/** Event handler function */
+type EventHandler<T = unknown> = (data: T) => void;
+/** Unsubscribe function returned by event subscriptions */
+type Unsubscribe = () => void;
+/** State change handler function */
+type StateChangeHandler = (key: string, value: unknown, source: 'python' | 'javascript') => void;
+/** IPC message payload types */
+type IPCMessageType = 'call' | 'event' | 'invoke';
+/** Base IPC message structure */
+interface IPCMessage {
+    type: IPCMessageType;
+    id?: string;
+}
+/** Call message (JS -> Python RPC) */
+interface CallMessage extends IPCMessage {
+    type: 'call';
+    id: string;
+    method: string;
+    params?: unknown;
+}
+/** Event message (JS -> Python fire-and-forget) */
+interface EventMessage extends IPCMessage {
+    type: 'event';
+    event: string;
+    detail?: unknown;
+}
+/** Invoke message (JS -> Python plugin command) */
+interface InvokeMessage extends IPCMessage {
+    type: 'invoke';
+    id: string;
+    cmd: string;
+    args: Record<string, unknown>;
+}
+/** Call result from Python */
+interface CallResult<T = unknown> {
+    id: string;
+    ok: boolean;
+    result?: T;
+    error?: CallErrorInfo;
+}
+/** Error information from failed calls */
+interface CallErrorInfo {
+    name?: string;
+    message: string;
+    code?: string | number;
+    data?: unknown;
+}
+/** Plugin invoke result */
+interface PluginResult<T = unknown> {
+    success?: boolean;
+    error?: string;
+    code?: string;
+    [key: string]: T | boolean | string | undefined;
+}
+/** Directory entry from readDir */
+interface DirEntry {
+    name: string;
+    path: string;
+    isDir: boolean;
+    isFile: boolean;
+    size?: number;
+    modified?: number;
+    created?: number;
+}
+/** File stat result */
+interface FileStat {
+    size: number;
+    isDir: boolean;
+    isFile: boolean;
+    isSymlink: boolean;
+    modified?: number;
+    created?: number;
+    accessed?: number;
+    readonly?: boolean;
+}
+/** File filter for dialogs */
+interface FileFilter {
+    name: string;
+    extensions: string[];
+}
+/** Open file dialog options */
+interface OpenFileOptions {
+    title?: string;
+    defaultPath?: string;
+    filters?: FileFilter[];
+}
+/** Open file result */
+interface OpenFileResult {
+    path: string | null;
+    cancelled: boolean;
+}
+/** Open files result */
+interface OpenFilesResult {
+    paths: string[];
+    cancelled: boolean;
+}
+/** Save file dialog options */
+interface SaveFileOptions {
+    title?: string;
+    defaultPath?: string;
+    defaultName?: string;
+    filters?: FileFilter[];
+}
+/** Message dialog options */
+interface MessageOptions {
+    message: string;
+    title?: string;
+    level?: 'info' | 'warning' | 'error';
+    buttons?: 'ok' | 'ok_cancel' | 'yes_no' | 'yes_no_cancel';
+}
+/** Message dialog result */
+interface MessageResult {
+    response: 'ok' | 'cancel' | 'yes' | 'no';
+}
+/** Confirm dialog result */
+interface ConfirmResult {
+    confirmed: boolean;
+}
+/** Shell execute options */
+interface ExecuteOptions {
+    cwd?: string;
+    env?: Record<string, string>;
+}
+/** Shell execute result */
+interface ExecuteResult {
+    code: number | null;
+    stdout: string;
+    stderr: string;
+}
+/** Shell spawn result */
+interface SpawnResult {
+    success: boolean;
+    pid: number;
+}
+/** Process output event data */
+interface ProcessOutput {
+    pid: number;
+    data: string;
+}
+/** Process exit event data */
+interface ProcessExit {
+    pid: number;
+    code: number | null;
+}
+/** Window event types */
+type WindowEventType = 'shown' | 'hidden' | 'focused' | 'blurred' | 'resized' | 'moved' | 'minimized' | 'maximized' | 'restored' | 'closing' | 'closed';
+/** Window event data */
+interface WindowEventData {
+    type: WindowEventType;
+    x?: number;
+    y?: number;
+    width?: number;
+    height?: number;
+    timestamp?: number;
+}
+declare global {
+    interface Window {
+        auroraview?: AuroraViewBridge;
+        ipc?: {
+            postMessage(message: string): void;
+        };
+    }
+}
+/** Raw bridge interface exposed on window.auroraview */
+interface AuroraViewBridge {
+    _ready: boolean;
+    _isStub?: boolean;
+    _pendingCalls: unknown[];
+    _boundMethods: Record<string, boolean>;
+    call<T = unknown>(method: string, params?: unknown): Promise<T>;
+    invoke<T = unknown>(cmd: string, args?: Record<string, unknown>): Promise<T>;
+    send_event(event: string, detail?: unknown): void;
+    on(event: string, handler: EventHandler): Unsubscribe;
+    off?(event: string, handler?: EventHandler): void;
+    trigger(event: string, detail?: unknown): void;
+    whenReady(): Promise<AuroraViewBridge>;
+    isReady(): boolean;
+    isMethodBound?(fullMethodName: string): boolean;
+    getBoundMethods?(): string[];
+    _registerApiMethods?(namespace: string, methods: string[], options?: {
+        allowRebind?: boolean;
+    }): void;
+    /** Start native window drag (for frameless windows) */
+    startDrag?(): void;
+    api?: Record<string, (params?: unknown) => Promise<unknown>>;
+    state?: AuroraViewState;
+    fs?: FileSystemAPI;
+    dialog?: DialogAPI;
+    clipboard?: ClipboardAPI;
+    shell?: ShellAPI;
+}
+/** State proxy interface */
+interface AuroraViewState {
+    [key: string]: unknown;
+    onChange(handler: StateChangeHandler): Unsubscribe;
+    offChange(handler: StateChangeHandler): void;
+    toJSON(): Record<string, unknown>;
+    keys(): string[];
+}
+/** File system API interface */
+interface FileSystemAPI {
+    readFile(path: string, encoding?: string): Promise<string>;
+    readFileBinary(path: string): Promise<string>;
+    readFileBuffer(path: string): Promise<ArrayBuffer>;
+    writeFile(path: string, contents: string, append?: boolean): Promise<void>;
+    writeFileBinary(path: string, contents: ArrayBuffer | Uint8Array, append?: boolean): Promise<void>;
+    readDir(path: string, recursive?: boolean): Promise<DirEntry[]>;
+    createDir(path: string, recursive?: boolean): Promise<void>;
+    remove(path: string, recursive?: boolean): Promise<void>;
+    copy(from: string, to: string): Promise<void>;
+    rename(from: string, to: string): Promise<void>;
+    exists(path: string): Promise<boolean>;
+    stat(path: string): Promise<FileStat>;
+}
+/** Dialog API interface */
+interface DialogAPI {
+    openFile(options?: OpenFileOptions): Promise<OpenFileResult>;
+    openFiles(options?: OpenFileOptions): Promise<OpenFilesResult>;
+    openFolder(options?: OpenFileOptions): Promise<OpenFileResult>;
+    openFolders(options?: OpenFileOptions): Promise<OpenFilesResult>;
+    saveFile(options?: SaveFileOptions): Promise<OpenFileResult>;
+    message(options: MessageOptions): Promise<MessageResult>;
+    confirm(options: {
+        message: string;
+        title?: string;
+    }): Promise<ConfirmResult>;
+    info(message: string, title?: string): Promise<MessageResult>;
+    warning(message: string, title?: string): Promise<MessageResult>;
+    error(message: string, title?: string): Promise<MessageResult>;
+    ask(message: string, title?: string): Promise<boolean>;
+}
+/** Clipboard API interface */
+interface ClipboardAPI {
+    readText(): Promise<string>;
+    writeText(text: string): Promise<void>;
+    clear(): Promise<void>;
+    hasText(): Promise<boolean>;
+    readImage(): Promise<string | null>;
+    writeImage(base64: string): Promise<void>;
+}
+/** Shell API interface */
+interface ShellAPI {
+    open(url: string): Promise<void>;
+    openPath(path: string): Promise<void>;
+    showInFolder(path: string): Promise<void>;
+    execute(command: string, args?: string[], options?: ExecuteOptions): Promise<ExecuteResult>;
+    spawn(command: string, args?: string[], options?: ExecuteOptions): Promise<SpawnResult>;
+    which(command: string): Promise<string | null>;
+    getEnv(name: string): Promise<string | null>;
+    getEnvAll(): Promise<Record<string, string>>;
+}
+
+/**
+ * AuroraView SDK Bridge Client
+ *
+ * Provides a type-safe wrapper around the native bridge API.
+ */
+
+/**
+ * AuroraView client interface
+ */
+interface AuroraViewClient {
+    /** Call a Python method (RPC-style) */
+    call<T = unknown>(method: string, params?: unknown): Promise<T>;
+    /** Invoke a plugin command */
+    invoke<T = unknown>(cmd: string, args?: Record<string, unknown>): Promise<T>;
+    /** Send an event to Python (fire-and-forget) */
+    emit(event: string, data?: unknown): void;
+    /** Subscribe to an event from Python */
+    on<T = unknown>(event: string, handler: EventHandler<T>): Unsubscribe;
+    /** Subscribe to an event once */
+    once<T = unknown>(event: string, handler: EventHandler<T>): Unsubscribe;
+    /** Unsubscribe from an event */
+    off(event: string, handler?: EventHandler): void;
+    /** Check if bridge is ready */
+    isReady(): boolean;
+    /** Wait for bridge to be ready */
+    whenReady(): Promise<AuroraViewClient>;
+    /** Get the raw bridge object */
+    getRawBridge(): AuroraViewBridge | undefined;
+    /** File system API */
+    readonly fs: FileSystemAPI | undefined;
+    /** Dialog API */
+    readonly dialog: DialogAPI | undefined;
+    /** Clipboard API */
+    readonly clipboard: ClipboardAPI | undefined;
+    /** Shell API */
+    readonly shell: ShellAPI | undefined;
+    /** Shared state */
+    readonly state: AuroraViewState | undefined;
+}
+/**
+ * Create or get the AuroraView client instance
+ */
+declare function createAuroraView(): AuroraViewClient;
+/**
+ * Get the AuroraView client instance (alias for createAuroraView)
+ */
+declare function getAuroraView(): AuroraViewClient;
+
+export { type AuroraViewClient as A, type CallMessage as C, type DirEntry as D, type EventHandler as E, type FileStat as F, type IPCMessage as I, type MessageOptions as M, type OpenFileOptions as O, type PluginResult as P, type StateChangeHandler as S, type Unsubscribe as U, type WindowEventType as W, type EventMessage as a, type InvokeMessage as b, createAuroraView as c, type CallResult as d, type CallErrorInfo as e, type FileFilter as f, getAuroraView as g, type OpenFileResult as h, type OpenFilesResult as i, type SaveFileOptions as j, type MessageResult as k, type ConfirmResult as l, type ExecuteOptions as m, type ExecuteResult as n, type SpawnResult as o, type ProcessOutput as p, type ProcessExit as q, type WindowEventData as r, type AuroraViewBridge as s, type AuroraViewState as t, type FileSystemAPI as u, type DialogAPI as v, type ClipboardAPI as w, type ShellAPI as x };