@bobfrankston/msger 0.1.73 → 0.1.75

package/msgerdefs/msgerdefs.d.ts

@@ -0,0 +1,322 @@
+/**
+ * TypeScript definitions for the msger JavaScript API
+ *
+ * This module provides type-safe access to msger's window control,
+ * data persistence, and file system features.
+ *
+ * Usage:
+ * ```typescript
+ * import type { MsgerAPI } from '@bobfrankston/msgerdefs';
+ *
+ * declare global {
+ *     interface Window {
+ *         msger?: MsgerAPI;
+ *     }
+ * }
+ *
+ * // Check if running in msger
+ * if (window.msger) {
+ *     window.msger.setTitle('My App');
+ * }
+ * ```
+ */
+/**
+ * Result object returned when the window closes
+ */
+export interface MsgerResult {
+    /** Button that was clicked */
+    button: string;
+    /** Optional input field value */
+    value?: string;
+    /** Optional form data */
+    form?: Record<string, any>;
+    /** True if window was closed via close button */
+    closed?: boolean;
+    /** True if window was dismissed via Escape key */
+    dismissed?: boolean;
+    /** True if window was closed due to timeout */
+    timeout?: boolean;
+}
+/**
+ * File information returned by file system operations
+ */
+export interface FileInfo {
+    /** File name */
+    name: string;
+    /** Full file path */
+    path: string;
+    /** True if this is a directory */
+    isDir: boolean;
+    /** File size in bytes (0 for directories) */
+    size: number;
+    /** Last modified timestamp (ISO 8601 string) */
+    modified?: string;
+}
+/**
+ * Options for file selection dialogs
+ */
+export interface FileDialogOptions {
+    /** Dialog title */
+    title?: string;
+    /** Default filename for save dialogs */
+    defaultFilename?: string;
+    /** File filters (e.g., [{name: "Text", extensions: ["txt", "md"]}]) */
+    filters?: Array<{
+        name: string;
+        extensions: string[];
+    }>;
+    /** Default directory to open */
+    defaultPath?: string;
+}
+/**
+ * Selected file with content
+ */
+export interface SelectedFile {
+    /** File name */
+    name: string;
+    /** Full file path */
+    path: string;
+    /** File content as string */
+    content: string;
+}
+/**
+ * msger JavaScript API
+ *
+ * Available when running inside msger via window.msger
+ */
+export interface MsgerAPI {
+    /**
+     * Toggle fullscreen mode on/off
+     * @example
+     * msger.toggleFullscreen();
+     */
+    toggleFullscreen(): void;
+    /**
+     * Set fullscreen mode
+     * @param enabled - true to enter fullscreen, false to exit
+     * @example
+     * msger.setFullscreen(true);
+     */
+    setFullscreen(enabled: boolean): void;
+    /**
+     * Minimize the window
+     * @example
+     * msger.minimize();
+     */
+    minimize(): void;
+    /**
+     * Toggle maximize/restore window
+     * @example
+     * msger.maximize();
+     */
+    maximize(): void;
+    /**
+     * Set window size
+     * @param width - Window width in pixels
+     * @param height - Window height in pixels
+     * @example
+     * msger.setSize(800, 600);
+     */
+    setSize(width: number, height: number): void;
+    /**
+     * Set window position
+     * @param x - X coordinate in pixels
+     * @param y - Y coordinate in pixels
+     * @example
+     * msger.setPosition(100, 100);
+     */
+    setPosition(x: number, y: number): void;
+    /**
+     * Set always-on-top behavior
+     * @param enabled - true to keep window on top
+     * @example
+     * msger.setAlwaysOnTop(true);
+     */
+    setAlwaysOnTop(enabled: boolean): void;
+    /**
+     * Set window title
+     * @param title - New window title
+     * @example
+     * msger.setTitle("My Application");
+     */
+    setTitle(title: string): void;
+    /**
+     * Close the window
+     * @param result - Optional result to return to parent process
+     * @example
+     * // Close with default dismissed result
+     * msger.close();
+     *
+     * // Close with custom result
+     * msger.close({button: 'OK', value: 'user data'});
+     */
+    close(result?: Partial<MsgerResult>): void;
+    /**
+     * Send result and close window (legacy compatibility)
+     * @param result - Result to return to parent process
+     * @example
+     * msger.sendResult({button: 'Submit', value: 'form data'});
+     */
+    sendResult(result: Partial<MsgerResult>): void;
+    /**
+     * Save data to persistent storage
+     * Data is stored with 'msger_' prefix in localStorage
+     * @param key - Storage key
+     * @param value - Value to store (will be JSON.stringify'd)
+     * @returns true on success, false on failure
+     * @example
+     * msger.saveData('userPrefs', {theme: 'dark', fontSize: 14});
+     */
+    saveData(key: string, value: any): boolean;
+    /**
+     * Load data from persistent storage
+     * @param key - Storage key
+     * @param defaultValue - Default value if key not found
+     * @returns Stored value or defaultValue
+     * @example
+     * const prefs = msger.loadData('userPrefs', {theme: 'light'});
+     */
+    loadData<T = any>(key: string, defaultValue?: T): T;
+    /**
+     * Remove data from persistent storage
+     * @param key - Storage key to remove
+     * @returns true on success, false on failure
+     * @example
+     * msger.removeData('tempData');
+     */
+    removeData(key: string): boolean;
+    /**
+     * Clear all msger data from persistent storage
+     * Only removes items with 'msger_' prefix
+     * @returns true on success, false on failure
+     * @example
+     * msger.clearData();
+     */
+    clearData(): boolean;
+    /**
+     * File system operations namespace
+     */
+    fs?: {
+        /**
+         * Select a file using native file picker
+         * @param options - File dialog options
+         * @returns Selected file with content, or null if cancelled
+         * @example
+         * const file = await msger.fs.selectFile({
+         *     title: 'Open File',
+         *     filters: [{name: 'Text', extensions: ['txt', 'md']}]
+         * });
+         * if (file) {
+         *     console.log(file.content);
+         * }
+         */
+        selectFile(options?: FileDialogOptions): Promise<SelectedFile | null>;
+        /**
+         * Select multiple files using native file picker
+         * @param options - File dialog options
+         * @returns Array of selected files with content
+         * @example
+         * const files = await msger.fs.selectFiles({
+         *     title: 'Open Files'
+         * });
+         */
+        selectFiles(options?: FileDialogOptions): Promise<SelectedFile[]>;
+        /**
+         * Save file using native save dialog
+         * @param content - File content to save
+         * @param defaultFilename - Default filename
+         * @param options - Additional dialog options
+         * @returns Path where file was saved, or null if cancelled
+         * @example
+         * const path = await msger.fs.saveFileAs('Hello World', 'greeting.txt');
+         */
+        saveFileAs(content: string, defaultFilename?: string, options?: FileDialogOptions): Promise<string | null>;
+        /**
+         * Select a directory using native folder picker
+         * @param options - Dialog options
+         * @returns Selected directory path, or null if cancelled
+         * @example
+         * const dir = await msger.fs.selectFolder({
+         *     title: 'Select Output Folder'
+         * });
+         */
+        selectFolder(options?: FileDialogOptions): Promise<string | null>;
+        /**
+         * Read file contents
+         * Note: Requires allowFs: true flag when launching msger
+         * @param path - File path to read
+         * @returns File content as string
+         * @example
+         * const content = await msger.fs.read('/path/to/file.txt');
+         */
+        read(path: string): Promise<string>;
+        /**
+         * Write file contents
+         * Note: Requires allowFs: true flag when launching msger
+         * @param path - File path to write
+         * @param content - Content to write
+         * @example
+         * await msger.fs.write('/path/to/file.txt', 'Hello World');
+         */
+        write(path: string, content: string): Promise<void>;
+        /**
+         * List directory contents
+         * Note: Requires allowFs: true flag when launching msger
+         * @param path - Directory path to list
+         * @returns Array of file information
+         * @example
+         * const files = await msger.fs.list('/path/to/dir');
+         */
+        list(path: string): Promise<FileInfo[]>;
+        /**
+         * Check if file or directory exists
+         * Note: Requires allowFs: true flag when launching msger
+         * @param path - Path to check
+         * @returns true if exists
+         * @example
+         * const exists = await msger.fs.exists('/path/to/file.txt');
+         */
+        exists(path: string): Promise<boolean>;
+        /**
+         * Delete file or directory
+         * Note: Requires allowFs: true flag when launching msger
+         * @param path - Path to delete
+         * @example
+         * await msger.fs.delete('/path/to/file.txt');
+         */
+        delete(path: string): Promise<void>;
+    };
+}
+/**
+ * Helper to check if code is running in msger
+ * @returns true if running in msger environment
+ * @example
+ * if (isMsger()) {
+ *     msger.setTitle('Running in msger!');
+ * } else {
+ *     console.log('Running in browser');
+ * }
+ */
+export declare function isMsger(): boolean;
+/**
+ * Get msger API with fallback for browser compatibility
+ * @returns msger API if available, or stub implementation for browser
+ * @example
+ * const api = getMsgerAPI();
+ * api.saveData('key', 'value'); // Works in both msger and browser
+ */
+export declare function getMsgerAPI(): MsgerAPI;
+/**
+ * Declare global window.msger
+ */
+declare global {
+    interface Window {
+        msger?: MsgerAPI;
+    }
+}
+declare const _default: {
+    isMsger: typeof isMsger;
+    getMsgerAPI: typeof getMsgerAPI;
+};
+export default _default;
+//# sourceMappingURL=msgerdefs.d.ts.map

package/msgerdefs/msgerdefs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"msgerdefs.d.ts","sourceRoot":"","sources":["msgerdefs.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,8BAA8B;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yBAAyB;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC3B,iDAAiD;IACjD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,kDAAkD;IAClD,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,+CAA+C;IAC/C,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACrB,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,kCAAkC;IAClC,KAAK,EAAE,OAAO,CAAC;IACf,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,mBAAmB;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wCAAwC;IACxC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,uEAAuE;IACvE,OAAO,CAAC,EAAE,KAAK,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,EAAE,CAAA;KAAC,CAAC,CAAC;IACtD,gCAAgC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,6BAA6B;IAC7B,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IAKrB;;;;OAIG;IACH,gBAAgB,IAAI,IAAI,CAAC;IAEzB;;;;;OAKG;IACH,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IAEtC;;;;OAIG;IACH,QAAQ,IAAI,IAAI,CAAC;IAEjB;;;;OAIG;IACH,QAAQ,IAAI,IAAI,CAAC;IAEjB;;;;;;OAMG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7C;;;;;;OAMG;IACH,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC;;;;;OAKG;IACH,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IAEvC;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;;;;;;;OASG;IACH,KAAK,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;IAE3C;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;IAM/C;;;;;;;;OAQG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC;IAE3C;;;;;;;OAOG;IACH,QAAQ,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;IAEpD;;;;;;OAMG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;IAEjC;;;;;;OAMG;IACH,SAAS,IAAI,OAAO,CAAC;IAMrB;;OAEG;IACH,EAAE,CAAC,EAAE;QACD;;;;;;;;;;;;WAYG;QACH,UAAU,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;QAEtE;;;;;;;;WAQG;QACH,WAAW,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;QAElE;;;;;;;;WAQG;QACH,UAAU,CACN,OAAO,EAAE,MAAM,EACf,eAAe,CAAC,EAAE,MAAM,EACxB,OAAO,CAAC,EAAE,iBAAiB,GAC5B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;QAE1B;;;;;;;;WAQG;QACH,YAAY,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;QAElE;;;;;;;WAOG;QACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAEpC;;;;;;;WAOG;QACH,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAEpD;;;;;;;WAOG;QACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;QAExC;;;;;;;WAOG;QACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;QAEvC;;;;;;WAMG;QACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;KACvC,CAAC;CACL;AAED;;;;;;;;;GASG;AACH,wBAAgB,OAAO,IAAI,OAAO,CAEjC;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,IAAI,QAAQ,CA6DtC;AAED;;GAEG;AACH,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,MAAM;QACZ,KAAK,CAAC,EAAE,QAAQ,CAAC;KACpB;CACJ;;;;;AAED,wBAGE"}

package/msgerdefs/msgerdefs.js

@@ -0,0 +1,110 @@
+/**
+ * TypeScript definitions for the msger JavaScript API
+ *
+ * This module provides type-safe access to msger's window control,
+ * data persistence, and file system features.
+ *
+ * Usage:
+ * ```typescript
+ * import type { MsgerAPI } from '@bobfrankston/msgerdefs';
+ *
+ * declare global {
+ *     interface Window {
+ *         msger?: MsgerAPI;
+ *     }
+ * }
+ *
+ * // Check if running in msger
+ * if (window.msger) {
+ *     window.msger.setTitle('My App');
+ * }
+ * ```
+ */
+/**
+ * Helper to check if code is running in msger
+ * @returns true if running in msger environment
+ * @example
+ * if (isMsger()) {
+ *     msger.setTitle('Running in msger!');
+ * } else {
+ *     console.log('Running in browser');
+ * }
+ */
+export function isMsger() {
+    return typeof window !== 'undefined' && typeof window.msger !== 'undefined';
+}
+/**
+ * Get msger API with fallback for browser compatibility
+ * @returns msger API if available, or stub implementation for browser
+ * @example
+ * const api = getMsgerAPI();
+ * api.saveData('key', 'value'); // Works in both msger and browser
+ */
+export function getMsgerAPI() {
+    if (isMsger()) {
+        return window.msger;
+    }
+    // Return browser-compatible stub
+    return {
+        // Window control - no-op in browser
+        toggleFullscreen: () => { },
+        setFullscreen: () => { },
+        minimize: () => { },
+        maximize: () => { },
+        setSize: () => { },
+        setPosition: () => { },
+        setAlwaysOnTop: () => { },
+        setTitle: (title) => { document.title = title; },
+        close: () => { window.close(); },
+        sendResult: () => { window.close(); },
+        // Data persistence - use localStorage in browser
+        saveData: (key, value) => {
+            try {
+                localStorage.setItem('msger_' + key, JSON.stringify(value));
+                return true;
+            }
+            catch {
+                return false;
+            }
+        },
+        loadData: (key, defaultValue) => {
+            try {
+                const item = localStorage.getItem('msger_' + key);
+                return item ? JSON.parse(item) : defaultValue;
+            }
+            catch {
+                return defaultValue;
+            }
+        },
+        removeData: (key) => {
+            try {
+                localStorage.removeItem('msger_' + key);
+                return true;
+            }
+            catch {
+                return false;
+            }
+        },
+        clearData: () => {
+            try {
+                const keys = Object.keys(localStorage);
+                for (const key of keys) {
+                    if (key.startsWith('msger_')) {
+                        localStorage.removeItem(key);
+                    }
+                }
+                return true;
+            }
+            catch {
+                return false;
+            }
+        },
+        // File system - not available in browser
+        fs: undefined
+    };
+}
+export default {
+    isMsger,
+    getMsgerAPI
+};
+//# sourceMappingURL=msgerdefs.js.map

package/msgerdefs/msgerdefs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"msgerdefs.js","sourceRoot":"","sources":["msgerdefs.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAqTH;;;;;;;;;GASG;AACH,MAAM,UAAU,OAAO;IACnB,OAAO,OAAO,MAAM,KAAK,WAAW,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,WAAW,CAAC;AAChF,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW;IACvB,IAAI,OAAO,EAAE,EAAE,CAAC;QACZ,OAAO,MAAM,CAAC,KAAM,CAAC;IACzB,CAAC;IAED,iCAAiC;IACjC,OAAO;QACH,oCAAoC;QACpC,gBAAgB,EAAE,GAAG,EAAE,GAAE,CAAC;QAC1B,aAAa,EAAE,GAAG,EAAE,GAAE,CAAC;QACvB,QAAQ,EAAE,GAAG,EAAE,GAAE,CAAC;QAClB,QAAQ,EAAE,GAAG,EAAE,GAAE,CAAC;QAClB,OAAO,EAAE,GAAG,EAAE,GAAE,CAAC;QACjB,WAAW,EAAE,GAAG,EAAE,GAAE,CAAC;QACrB,cAAc,EAAE,GAAG,EAAE,GAAE,CAAC;QACxB,QAAQ,EAAE,CAAC,KAAa,EAAE,EAAE,GAAG,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC;QACxD,KAAK,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAChC,UAAU,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAErC,iDAAiD;QACjD,QAAQ,EAAE,CAAC,GAAW,EAAE,KAAU,EAAW,EAAE;YAC3C,IAAI,CAAC;gBACD,YAAY,CAAC,OAAO,CAAC,QAAQ,GAAG,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC5D,OAAO,IAAI,CAAC;YAChB,CAAC;YAAC,MAAM,CAAC;gBACL,OAAO,KAAK,CAAC;YACjB,CAAC;QACL,CAAC;QACD,QAAQ,EAAE,CAAU,GAAW,EAAE,YAAgB,EAAK,EAAE;YACpD,IAAI,CAAC;gBACD,MAAM,IAAI,GAAG,YAAY,CAAC,OAAO,CAAC,QAAQ,GAAG,GAAG,CAAC,CAAC;gBAClD,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAE,YAAkB,CAAC;YACzD,CAAC;YAAC,MAAM,CAAC;gBACL,OAAO,YAAiB,CAAC;YAC7B,CAAC;QACL,CAAC;QACD,UAAU,EAAE,CAAC,GAAW,EAAW,EAAE;YACjC,IAAI,CAAC;gBACD,YAAY,CAAC,UAAU,CAAC,QAAQ,GAAG,GAAG,CAAC,CAAC;gBACxC,OAAO,IAAI,CAAC;YAChB,CAAC;YAAC,MAAM,CAAC;gBACL,OAAO,KAAK,CAAC;YACjB,CAAC;QACL,CAAC;QACD,SAAS,EAAE,GAAY,EAAE;YACrB,IAAI,CAAC;gBACD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBACvC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;oBACrB,IAAI,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;wBAC3B,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;oBACjC,CAAC;gBACL,CAAC;gBACD,OAAO,IAAI,CAAC;YAChB,CAAC;YAAC,MAAM,CAAC;gBACL,OAAO,KAAK,CAAC;YACjB,CAAC;QACL,CAAC;QAED,yCAAyC;QACzC,EAAE,EAAE,SAAS;KAChB,CAAC;AACN,CAAC;AAWD,eAAe;IACX,OAAO;IACP,WAAW;CACd,CAAC"}