@bobfrankston/msgapidefs 0.1.4 → 0.1.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bobfrankston/msgapidefs",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "TypeScript definitions for msgapi JavaScript API (msgview/msger)",
   "type": "module",
   "main": "./msgapidefs.js",
@@ -30,6 +30,9 @@
     "access": "public"
   },
   "scripts": {
-    "release": "git add -A && git commit -m \"Pre-release commit\" && npm version patch && git push && git push --tags && npm publish --quiet"
+    "prerelease:local": "git add -A && (git diff-index --quiet HEAD || git commit -m \"Pre-release commit\")",
+    "preversion": "git add -A",
+    "postversion": "git push && git push --tags",
+    "release": "npm run prerelease:local && npm version patch && npm publish --quiet"
   }
 }

package/.vscode/settings.json

@@ -1,22 +0,0 @@
-{
-    "workbench.colorCustomizations": {
-        "activityBar.activeBackground": "#c3b9ff",
-        "activityBar.background": "#c3b9ff",
-        "activityBar.foreground": "#15202b",
-        "activityBar.inactiveForeground": "#15202b99",
-        "activityBarBadge.background": "#ff2400",
-        "activityBarBadge.foreground": "#e7e7e7",
-        "commandCenter.border": "#15202b99",
-        "sash.hoverBorder": "#c3b9ff",
-        "statusBar.background": "#9786ff",
-        "statusBar.foreground": "#15202b",
-        "statusBarItem.hoverBackground": "#6b53ff",
-        "statusBarItem.remoteBackground": "#9786ff",
-        "statusBarItem.remoteForeground": "#15202b",
-        "titleBar.activeBackground": "#9786ff",
-        "titleBar.activeForeground": "#15202b",
-        "titleBar.inactiveBackground": "#9786ff99",
-        "titleBar.inactiveForeground": "#15202b99"
-    },
-    "peacock.color": "#9786ff"
-}

package/.vscode/tasks.json

@@ -1,20 +0,0 @@
-{
-    "version": "2.0.0",
-    "tasks": [
-        {
-            "label": "tsc: watch",
-            "type": "shell",
-            "command": "tsc",
-            "args": ["--watch"],
-            "runOptions": {
-                "runOn": "folderOpen"
-            },
-            "problemMatcher": "$tsc-watch",
-            "isBackground": true,
-            "group": {
-                "kind": "build",
-                "isDefault": true
-            }
-        }
-    ]
-}

package/msgapidefs.d.ts

@@ -1,234 +0,0 @@
-/**
- * TypeScript definitions for the msgapi JavaScript API
- *
- * This module provides type-safe access to msgapi's window control,
- * data persistence, and file system features (used by msgview and msger).
- *
- * See README.md for complete usage documentation and examples.
- */
-/**
- * Result object returned when the window closes
- */
-export interface MsgResult {
-    /** 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;
-}
-/**
- * msgapi JavaScript API
- *
- * Available when running inside msgview/msger via window.msgapi
- */
-export interface MsgAPI {
-    /**
-     * Toggle fullscreen mode on/off
-     * @example
-     * msgapi.toggleFullscreen();
-     */
-    toggleFullscreen(): void;
-    /**
-     * Set fullscreen mode
-     * @param enabled - true to enter fullscreen, false to exit
-     * @example
-     * msgapi.setFullscreen(true);
-     */
-    setFullscreen(enabled: boolean): void;
-    /**
-     * Minimize the window
-     * @example
-     * msgapi.minimize();
-     */
-    minimize(): void;
-    /**
-     * Toggle maximize/restore window
-     * @example
-     * msgapi.maximize();
-     */
-    maximize(): void;
-    /**
-     * Set window size
-     * @param width - Window width in pixels
-     * @param height - Window height in pixels
-     * @example
-     * msgapi.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
-     * msgapi.setPosition(100, 100);
-     */
-    setPosition(x: number, y: number): void;
-    /**
-     * Set always-on-top behavior
-     * @param enabled - true to keep window on top
-     * @example
-     * msgapi.setAlwaysOnTop(true);
-     */
-    setAlwaysOnTop(enabled: boolean): void;
-    /**
-     * Close the window and return result to parent process
-     * @param result - Optional result to return to parent process
-     * @example
-     * // Close with default dismissed result
-     * msgapi.close();
-     *
-     * // Close with custom result
-     * msgapi.close({button: 'OK', value: 'user data'});
-     */
-    close(result?: Partial<MsgResult>): void;
-    /**
-     * 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 msgapi.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 msgapi.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 msgapi.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 msgapi.fs.selectFolder({
-         *     title: 'Select Output Folder'
-         * });
-         */
-        selectFolder(options?: FileDialogOptions): Promise<string | null>;
-        /**
-         * Read file contents
-         * Note: Requires allowFs: true flag when launching msgview/msger
-         * @param path - File path to read
-         * @returns File content as string
-         * @example
-         * const content = await msgapi.fs.read('/path/to/file.txt');
-         */
-        read(path: string): Promise<string>;
-        /**
-         * Write file contents
-         * Note: Requires allowFs: true flag when launching msgview/msger
-         * @param path - File path to write
-         * @param content - Content to write
-         * @example
-         * await msgapi.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 msgview/msger
-         * @param path - Directory path to list
-         * @returns Array of file information
-         * @example
-         * const files = await msgapi.fs.list('/path/to/dir');
-         */
-        list(path: string): Promise<FileInfo[]>;
-        /**
-         * Check if file or directory exists
-         * Note: Requires allowFs: true flag when launching msgview/msger
-         * @param path - Path to check
-         * @returns true if exists
-         * @example
-         * const exists = await msgapi.fs.exists('/path/to/file.txt');
-         */
-        exists(path: string): Promise<boolean>;
-        /**
-         * Delete file or directory
-         * Note: Requires allowFs: true flag when launching msgview/msger
-         * @param path - Path to delete
-         * @example
-         * await msgapi.fs.delete('/path/to/file.txt');
-         */
-        delete(path: string): Promise<void>;
-    };
-}
-/**
- * Declare global window.msgapi
- */
-declare global {
-    interface Window {
-        msgapi?: MsgAPI;
-    }
-}

package/msgapidefs.js

@@ -1,9 +0,0 @@
-/**
- * TypeScript definitions for the msgapi JavaScript API
- *
- * This module provides type-safe access to msgapi's window control,
- * data persistence, and file system features (used by msgview and msger).
- *
- * See README.md for complete usage documentation and examples.
- */
-export {};