@bobfrankston/msgapidefs 0.1.2 → 0.1.3

package/README.md

@@ -10,47 +10,28 @@ npm install @bobfrankston/msgapidefs
 
 ## Usage
 
-### TypeScript
-
 ```typescript
-import type { MsgAPI } from '@bobfrankston/msgapidefs';
-import { isMsgAPI, getMsgAPI } from '@bobfrankston/msgapidefs';
-
-// Option 1: Type the global window.msgapi
-declare global {
-    interface Window {
-        msgapi?: MsgAPI;
-    }
-}
-
-// Check if running in msgview/msger
-if (isMsgAPI()) {
-    window.msgapi!.setTitle('My Application');
-    window.msgapi!.saveData('lastOpened', new Date().toISOString());
-}
-
-// Option 2: Use getMsgAPI() for cross-platform compatibility
-const msgapi = getMsgAPI();
-msgapi.saveData('userPrefs', { theme: 'dark' });  // Works in both msgview/msger and browser!
-msgapi.setTitle('My App');  // Only works in msgview/msger, no-op in browser
-```
-
-### JavaScript
+// Import to register global window.msgapi type
+import '../node_modules/@bobfrankston/msgapidefs/msgapidefs.js';
+// Note: '../node_modules/@bobfrankston/msgapidefs/index.js' may also work via package.json exports
 
-```javascript
-import { isMsgAPI, getMsgAPI } from '@bobfrankston/msgapidefs';
+// Or import types explicitly
+import type { MsgAPI, MsgResult } from '../node_modules/@bobfrankston/msgapidefs/msgapidefs.js';
 
-const msgapi = getMsgAPI();
+// msgapi provides APIs not available in browsers/webviews
+if (window.msgapi) {
+    // Window control beyond browser capabilities
+    window.msgapi.setFullscreen(true);
+    window.msgapi.setAlwaysOnTop(true);
 
-// Data persistence (works in both msgview/msger and browser)
-msgapi.saveData('userSettings', { fontSize: 14, theme: 'dark' });
-const settings = msgapi.loadData('userSettings', { fontSize: 12 });
-
-// Window control (msgview/msger only, gracefully degrades in browser)
-if (isMsgAPI()) {
-    msgapi.toggleFullscreen();
-    msgapi.setAlwaysOnTop(true);
+    // File system access (requires allowFs flag)
+    const file = await window.msgapi.fs?.selectFile();
 }
+
+// For standard browser APIs, use native methods:
+document.title = 'My App';  // Instead of msgapi.setTitle()
+localStorage.setItem('key', 'value');  // Instead of msgapi.saveData()
+window.close();  // Instead of msgapi.close() if not passing result
 ```
 
 ## API Reference
@@ -64,17 +45,9 @@ if (isMsgAPI()) {
 - `setSize(width, height)` - Set window size
 - `setPosition(x, y)` - Set window position
 - `setAlwaysOnTop(enabled: boolean)` - Keep window on top
-- `setTitle(title: string)` - Set window title
-- `close(result?)` - Close window with optional result
-
-### Data Persistence
-
-- `saveData(key, value)` - Save data to localStorage
-- `loadData(key, defaultValue?)` - Load data from localStorage
-- `removeData(key)` - Remove data
-- `clearData()` - Clear all msgapi data
+- `close(result?)` - Close window and return result to parent process
 
-### File System (Coming Soon)
+### File System
 
 - `fs.selectFile(options?)` - Open file picker
 - `fs.selectFiles(options?)` - Open multi-file picker
@@ -112,15 +85,6 @@ The samples demonstrate:
 - Session management
 - And more!
 
-## Browser Compatibility
-
-The `getMsgAPI()` function returns a browser-compatible implementation:
-
-- **Data persistence**: Uses localStorage in both msgview/msger and browser
-- **Window control**: No-op in browser (except `setTitle` updates document.title)
-- **File system**: Not available in browser (`fs` is undefined)
-
-This allows you to write code once that works in both environments!
 
 ## Related Packages
 

package/msgapidefs.d.ts

@@ -4,20 +4,7 @@
  * This module provides type-safe access to msgapi's window control,
  * data persistence, and file system features (used by msgview and msger).
  *
- * Usage:
- * ```typescript
- * // Import to register global window.msgapi type (browser direct import)
- * import '../node_modules/@bobfrankston/msgapidefs/msgapidefs.js';
- * // Note: '../node_modules/@bobfrankston/msgapidefs/index.js' may also work via package.json exports
- *
- * // Or import types explicitly
- * import type { MsgAPI, MsgResult } from '../node_modules/@bobfrankston/msgapidefs/msgapidefs.js';
- *
- * // window.msgapi is now typed automatically
- * if (window.msgapi) {
- *     window.msgapi.setTitle('My App');
- * }
- * ```
+ * See README.md for complete usage documentation and examples.
  */
 /**
  * Result object returned when the window closes
@@ -133,14 +120,7 @@ export interface MsgAPI {
      */
     setAlwaysOnTop(enabled: boolean): void;
     /**
-     * Set window title
-     * @param title - New window title
-     * @example
-     * msgapi.setTitle("My Application");
-     */
-    setTitle(title: string): void;
-    /**
-     * Close the window
+     * Close the window and return result to parent process
      * @param result - Optional result to return to parent process
      * @example
      * // Close with default dismissed result
@@ -150,48 +130,6 @@ export interface MsgAPI {
      * msgapi.close({button: 'OK', value: 'user data'});
      */
     close(result?: Partial<MsgResult>): void;
-    /**
-     * Send result and close window (legacy compatibility)
-     * @param result - Result to return to parent process
-     * @example
-     * msgapi.sendResult({button: 'Submit', value: 'form data'});
-     */
-    sendResult(result: Partial<MsgResult>): void;
-    /**
-     * Save data to persistent storage
-     * Data is stored with 'msgapi_' 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
-     * msgapi.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 = msgapi.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
-     * msgapi.removeData('tempData');
-     */
-    removeData(key: string): boolean;
-    /**
-     * Clear all msgapi data from persistent storage
-     * Only removes items with 'msgapi_' prefix
-     * @returns true on success, false on failure
-     * @example
-     * msgapi.clearData();
-     */
-    clearData(): boolean;
     /**
      * File system operations namespace
      */

package/msgapidefs.js

@@ -4,19 +4,6 @@
  * This module provides type-safe access to msgapi's window control,
  * data persistence, and file system features (used by msgview and msger).
  *
- * Usage:
- * ```typescript
- * // Import to register global window.msgapi type (browser direct import)
- * import '../node_modules/@bobfrankston/msgapidefs/msgapidefs.js';
- * // Note: '../node_modules/@bobfrankston/msgapidefs/index.js' may also work via package.json exports
- *
- * // Or import types explicitly
- * import type { MsgAPI, MsgResult } from '../node_modules/@bobfrankston/msgapidefs/msgapidefs.js';
- *
- * // window.msgapi is now typed automatically
- * if (window.msgapi) {
- *     window.msgapi.setTitle('My App');
- * }
- * ```
+ * See README.md for complete usage documentation and examples.
  */
 export {};

package/msgapidefs.ts

@@ -4,20 +4,7 @@
  * This module provides type-safe access to msgapi's window control,
  * data persistence, and file system features (used by msgview and msger).
  *
- * Usage:
- * ```typescript
- * // Import to register global window.msgapi type (browser direct import)
- * import '../node_modules/@bobfrankston/msgapidefs/msgapidefs.js';
- * // Note: '../node_modules/@bobfrankston/msgapidefs/index.js' may also work via package.json exports
- *
- * // Or import types explicitly
- * import type { MsgAPI, MsgResult } from '../node_modules/@bobfrankston/msgapidefs/msgapidefs.js';
- *
- * // window.msgapi is now typed automatically
- * if (window.msgapi) {
- *     window.msgapi.setTitle('My App');
- * }
- * ```
+ * See README.md for complete usage documentation and examples.
  */
 
 /**
@@ -146,15 +133,7 @@ export interface MsgAPI {
     setAlwaysOnTop(enabled: boolean): void;
 
     /**
-     * Set window title
-     * @param title - New window title
-     * @example
-     * msgapi.setTitle("My Application");
-     */
-    setTitle(title: string): void;
-
-    /**
-     * Close the window
+     * Close the window and return result to parent process
      * @param result - Optional result to return to parent process
      * @example
      * // Close with default dismissed result
@@ -165,59 +144,8 @@ export interface MsgAPI {
      */
     close(result?: Partial<MsgResult>): void;
 
-    /**
-     * Send result and close window (legacy compatibility)
-     * @param result - Result to return to parent process
-     * @example
-     * msgapi.sendResult({button: 'Submit', value: 'form data'});
-     */
-    sendResult(result: Partial<MsgResult>): void;
-
-    // ========================================
-    // Data Persistence (localStorage wrapper)
-    // ========================================
-
-    /**
-     * Save data to persistent storage
-     * Data is stored with 'msgapi_' 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
-     * msgapi.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 = msgapi.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
-     * msgapi.removeData('tempData');
-     */
-    removeData(key: string): boolean;
-
-    /**
-     * Clear all msgapi data from persistent storage
-     * Only removes items with 'msgapi_' prefix
-     * @returns true on success, false on failure
-     * @example
-     * msgapi.clearData();
-     */
-    clearData(): boolean;
-
     // ========================================
-    // File System Access (to be implemented)
+    // File System Access
     // ========================================
 
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bobfrankston/msgapidefs",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "TypeScript definitions for msgapi JavaScript API (msgview/msger)",
   "type": "module",
   "main": "./msgapidefs.js",