@mentra/sdk 1.1.19

package/dist/tpa/session/layouts.d.ts

@@ -0,0 +1,150 @@
+/**
+ * 🎨 Layout Manager Module
+ *
+ * Manages AR display layouts for TPAs. This class provides an easy-to-use interface
+ * for showing different types of content in the user's AR view.
+ *
+ * @example
+ * ```typescript
+ * const layouts = new LayoutManager('org.example.myapp', sendMessage);
+ *
+ * // Show a simple message
+ * layouts.showTextWall('Hello AR World!');
+ *
+ * // Show a card with title
+ * layouts.showReferenceCard('Weather', 'Sunny and 75°F');
+ * ```
+ */
+import { DisplayRequest, ViewType } from '../../types';
+export declare class LayoutManager {
+    private packageName;
+    private sendMessage;
+    /**
+     * 🎯 Creates a new LayoutManager instance
+     *
+     * @param packageName - TPA package identifier
+     * @param sendMessage - Function to send display requests to AugmentOS
+     */
+    constructor(packageName: string, sendMessage: (message: DisplayRequest) => void);
+    /**
+     * 📦 Creates a display event request with validation
+     *
+     * @param layout - Layout configuration to display
+     * @param view - View type (main or dashboard)
+     * @param durationMs - How long to show the layout (optional)
+     * @returns Formatted display request
+     * @throws Error if layout is invalid
+     */
+    private createDisplayEvent;
+    /**
+     * 📝 Shows a single block of text
+     *
+     * Best for:
+     * - Simple messages
+     * - Status updates
+     * - Notifications
+     *
+     * @param text - Text content to display
+     * @param options - Optional parameters (view, duration, priority)
+     *   - priority: If true, this display will not be overridden by other requests (default: false)
+     *
+     * @example
+     * ```typescript
+     * layouts.showTextWall('Connected to server');
+     * layouts.showTextWall('Onboarding!', { priority: true });
+     * ```
+     */
+    showTextWall(text: string, options?: {
+        view?: ViewType;
+        durationMs?: number;
+    }): void;
+    /**
+     * ↕️ Shows two sections of text, one above the other
+     *
+     * Best for:
+     * - Before/After content
+     * - Question/Answer displays
+     * - Two-part messages
+     * - Comparisons
+     *
+     * @param topText - Text to show in top section
+     * @param bottomText - Text to show in bottom section
+     * @param options - Optional parameters (view, duration)
+     *
+     * @example
+     * ```typescript
+     * layouts.showDoubleTextWall(
+     *   'Original: Hello',
+     *   'Translated: Bonjour'
+     * );
+     * ```
+     */
+    showDoubleTextWall(topText: string, bottomText: string, options?: {
+        view?: ViewType;
+        durationMs?: number;
+    }): void;
+    /**
+     * 📇 Shows a card with a title and content
+     *
+     * Best for:
+     * - Titled content
+     * - Important information
+     * - Structured data
+     * - Notifications with context
+     *
+     * @param title - Card title
+     * @param text - Main content text
+     * @param options - Optional parameters (view, duration)
+     *
+     * @example
+     * ```typescript
+     * layouts.showReferenceCard(
+     *   'Meeting Reminder',
+     *   'Team standup in 5 minutes'
+     * );
+     * ```
+     */
+    showReferenceCard(title: string, text: string, options?: {
+        view?: ViewType;
+        durationMs?: number;
+    }): void;
+    /**
+   * 📇 Shows a bitmap
+   *
+   * @param data - base64 encoded bitmap data
+   * @param options - Optional parameters (view, duration)
+   *
+   * @example
+   * ```typescript
+   * layouts.showBitmapView(
+   *   yourBase64EncodedBitmapDataString
+   * );
+   * ```
+   */
+    showBitmapView(data: string, options?: {
+        view?: ViewType;
+        durationMs?: number;
+    }): void;
+    /**
+     * 📊 Shows a dashboard card with left and right text
+     *
+     * Best for:
+     * - Key-value pairs
+     * - Dashboard displays
+     * - Metrics
+     *
+     * @param leftText - Left side text (typically label/key)
+     * @param rightText - Right side text (typically value)
+     * @param options - Optional parameters (view, duration)
+     *
+     * @example
+     * ```typescript
+     * layouts.showDashboardCard('Weather', '72°F');
+     * ```
+     */
+    showDashboardCard(leftText: string, rightText: string, options?: {
+        view?: ViewType;
+        durationMs?: number;
+    }): void;
+}
+//# sourceMappingURL=layouts.d.ts.map

package/dist/tpa/session/layouts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"layouts.d.ts","sourceRoot":"","sources":["../../../src/tpa/session/layouts.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,EACL,cAAc,EAOd,QAAQ,EAGT,MAAM,aAAa,CAAC;AAErB,qBAAa,aAAa;IAQtB,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,WAAW;IARrB;;;;;OAKG;gBAEO,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI;IAGxD;;;;;;;;OAQG;IACH,OAAO,CAAC,kBAAkB;IAmG1B;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,CACV,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,QAAQ,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAC;IAuCnD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,kBAAkB,CAChB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,QAAQ,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE;IAcpD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,iBAAiB,CACf,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,QAAQ,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE;IAclD;;;;;;;;;;;;KAYC;IACH,cAAc,CACZ,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,QAAQ,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE;IAapD;;;;;;;;;;;;;;;;OAgBG;IACH,iBAAiB,CACf,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,QAAQ,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE;CAarD"}

package/dist/tpa/session/layouts.js

@@ -0,0 +1,282 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LayoutManager = void 0;
+/**
+ * 🎨 Layout Manager Module
+ *
+ * Manages AR display layouts for TPAs. This class provides an easy-to-use interface
+ * for showing different types of content in the user's AR view.
+ *
+ * @example
+ * ```typescript
+ * const layouts = new LayoutManager('org.example.myapp', sendMessage);
+ *
+ * // Show a simple message
+ * layouts.showTextWall('Hello AR World!');
+ *
+ * // Show a card with title
+ * layouts.showReferenceCard('Weather', 'Sunny and 75°F');
+ * ```
+ */
+const types_1 = require("../../types");
+class LayoutManager {
+    /**
+     * 🎯 Creates a new LayoutManager instance
+     *
+     * @param packageName - TPA package identifier
+     * @param sendMessage - Function to send display requests to AugmentOS
+     */
+    constructor(packageName, sendMessage) {
+        this.packageName = packageName;
+        this.sendMessage = sendMessage;
+    }
+    /**
+     * 📦 Creates a display event request with validation
+     *
+     * @param layout - Layout configuration to display
+     * @param view - View type (main or dashboard)
+     * @param durationMs - How long to show the layout (optional)
+     * @returns Formatted display request
+     * @throws Error if layout is invalid
+     */
+    createDisplayEvent(layout, view = types_1.ViewType.MAIN, durationMs) {
+        try {
+            // Validate layout data before sending
+            if (!layout) {
+                throw new Error("Layout cannot be null or undefined");
+            }
+            if (!layout.layoutType) {
+                throw new Error("Layout must have a layoutType property");
+            }
+            // Layout-specific validations
+            switch (layout.layoutType) {
+                case types_1.LayoutType.TEXT_WALL:
+                    if (typeof layout.text !== 'string') {
+                        throw new Error("TextWall layout must have a text property");
+                    }
+                    // Ensure text is not too long (prevent performance issues)
+                    if (layout.text.length > 1000) {
+                        console.warn("TextWall text is very long, this may cause performance issues");
+                    }
+                    break;
+                case types_1.LayoutType.DOUBLE_TEXT_WALL:
+                    const doubleText = layout;
+                    if (typeof doubleText.topText !== 'string') {
+                        throw new Error("DoubleTextWall layout must have a topText property");
+                    }
+                    if (typeof doubleText.bottomText !== 'string') {
+                        throw new Error("DoubleTextWall layout must have a bottomText property");
+                    }
+                    break;
+                case types_1.LayoutType.REFERENCE_CARD:
+                    const refCard = layout;
+                    if (typeof refCard.title !== 'string') {
+                        throw new Error("ReferenceCard layout must have a title property");
+                    }
+                    if (typeof refCard.text !== 'string') {
+                        throw new Error("ReferenceCard layout must have a text property");
+                    }
+                    break;
+                case types_1.LayoutType.DASHBOARD_CARD:
+                    const dashCard = layout;
+                    if (typeof dashCard.leftText !== 'string') {
+                        throw new Error("DashboardCard layout must have a leftText property");
+                    }
+                    if (typeof dashCard.rightText !== 'string') {
+                        throw new Error("DashboardCard layout must have a rightText property");
+                    }
+                    break;
+                case types_1.LayoutType.BITMAP_VIEW:
+                    const bitmapView = layout;
+                    if (typeof bitmapView.data !== 'string') {
+                        throw new Error("BitmapView layout must have a data property");
+                    }
+                    // Check if data is too large (prevent OOM errors)
+                    if (bitmapView.data.length > 1000000) { // 1MB limit
+                        throw new Error("Bitmap data is too large (>1MB), please reduce size");
+                    }
+                    break;
+            }
+            // Validate view type
+            if (view !== types_1.ViewType.MAIN && view !== types_1.ViewType.DASHBOARD) {
+                console.warn(`Invalid view type: ${view}, defaulting to MAIN`);
+                view = types_1.ViewType.MAIN;
+            }
+            // Validate duration if provided
+            if (durationMs !== undefined) {
+                if (typeof durationMs !== 'number' || durationMs < 0) {
+                    console.warn(`Invalid duration: ${durationMs}, ignoring`);
+                    durationMs = undefined;
+                }
+            }
+            // Create the display request with validated data
+            return {
+                timestamp: new Date(),
+                sessionId: '', // Will be filled by session
+                type: types_1.TpaToCloudMessageType.DISPLAY_REQUEST,
+                packageName: this.packageName,
+                view,
+                layout,
+                durationMs
+            };
+        }
+        catch (error) {
+            console.error("Error creating display event:", error);
+            throw error; // Re-throw to notify caller
+        }
+    }
+    /**
+     * 📝 Shows a single block of text
+     *
+     * Best for:
+     * - Simple messages
+     * - Status updates
+     * - Notifications
+     *
+     * @param text - Text content to display
+     * @param options - Optional parameters (view, duration, priority)
+     *   - priority: If true, this display will not be overridden by other requests (default: false)
+     *
+     * @example
+     * ```typescript
+     * layouts.showTextWall('Connected to server');
+     * layouts.showTextWall('Onboarding!', { priority: true });
+     * ```
+     */
+    showTextWall(text, options) {
+        try {
+            // Validate input before processing
+            if (text === undefined || text === null) {
+                text = ""; // Default to empty string instead of crashing
+                console.warn("showTextWall called with null/undefined text");
+            }
+            // Ensure text is a string
+            if (typeof text !== 'string') {
+                text = String(text); // Convert to string
+                console.warn("showTextWall: Non-string input converted to string");
+            }
+            // Create layout with validated text
+            const layout = {
+                layoutType: types_1.LayoutType.TEXT_WALL,
+                text
+            };
+            // Create and send display event with error handling
+            try {
+                const displayEvent = this.createDisplayEvent(layout, options?.view, options?.durationMs);
+                this.sendMessage(displayEvent);
+            }
+            catch (error) {
+                console.error("Failed to display text wall:", error);
+                // Don't re-throw - prevent app crashes
+            }
+        }
+        catch (error) {
+            console.error("Error in showTextWall:", error);
+            // Don't crash the TPA - fail gracefully
+        }
+    }
+    /**
+     * ↕️ Shows two sections of text, one above the other
+     *
+     * Best for:
+     * - Before/After content
+     * - Question/Answer displays
+     * - Two-part messages
+     * - Comparisons
+     *
+     * @param topText - Text to show in top section
+     * @param bottomText - Text to show in bottom section
+     * @param options - Optional parameters (view, duration)
+     *
+     * @example
+     * ```typescript
+     * layouts.showDoubleTextWall(
+     *   'Original: Hello',
+     *   'Translated: Bonjour'
+     * );
+     * ```
+     */
+    showDoubleTextWall(topText, bottomText, options) {
+        const layout = {
+            layoutType: types_1.LayoutType.DOUBLE_TEXT_WALL,
+            topText,
+            bottomText
+        };
+        this.sendMessage(this.createDisplayEvent(layout, options?.view, options?.durationMs));
+    }
+    /**
+     * 📇 Shows a card with a title and content
+     *
+     * Best for:
+     * - Titled content
+     * - Important information
+     * - Structured data
+     * - Notifications with context
+     *
+     * @param title - Card title
+     * @param text - Main content text
+     * @param options - Optional parameters (view, duration)
+     *
+     * @example
+     * ```typescript
+     * layouts.showReferenceCard(
+     *   'Meeting Reminder',
+     *   'Team standup in 5 minutes'
+     * );
+     * ```
+     */
+    showReferenceCard(title, text, options) {
+        const layout = {
+            layoutType: types_1.LayoutType.REFERENCE_CARD,
+            title,
+            text
+        };
+        this.sendMessage(this.createDisplayEvent(layout, options?.view, options?.durationMs));
+    }
+    /**
+   * 📇 Shows a bitmap
+   *
+   * @param data - base64 encoded bitmap data
+   * @param options - Optional parameters (view, duration)
+   *
+   * @example
+   * ```typescript
+   * layouts.showBitmapView(
+   *   yourBase64EncodedBitmapDataString
+   * );
+   * ```
+   */
+    showBitmapView(data, options) {
+        const layout = {
+            layoutType: types_1.LayoutType.BITMAP_VIEW,
+            data
+        };
+        this.sendMessage(this.createDisplayEvent(layout, options?.view, options?.durationMs));
+    }
+    /**
+     * 📊 Shows a dashboard card with left and right text
+     *
+     * Best for:
+     * - Key-value pairs
+     * - Dashboard displays
+     * - Metrics
+     *
+     * @param leftText - Left side text (typically label/key)
+     * @param rightText - Right side text (typically value)
+     * @param options - Optional parameters (view, duration)
+     *
+     * @example
+     * ```typescript
+     * layouts.showDashboardCard('Weather', '72°F');
+     * ```
+     */
+    showDashboardCard(leftText, rightText, options) {
+        const layout = {
+            layoutType: types_1.LayoutType.DASHBOARD_CARD,
+            leftText,
+            rightText
+        };
+        this.sendMessage(this.createDisplayEvent(layout, options?.view || types_1.ViewType.DASHBOARD, options?.durationMs));
+    }
+}
+exports.LayoutManager = LayoutManager;

package/dist/tpa/session/modules/streaming.d.ts

@@ -0,0 +1,100 @@
+/**
+ * 📹 RTMP Streaming Module
+ *
+ * Provides functionality for TPAs to request and manage RTMP streams from smart glasses.
+ * Handles stream lifecycle, status monitoring, and cleanup.
+ */
+import { RtmpStreamStatus } from '../../../types';
+import { VideoConfig, AudioConfig, StreamConfig, StreamStatusHandler } from '../../../types/rtmp-stream';
+export { VideoConfig, AudioConfig, StreamConfig, StreamStatusHandler };
+/**
+ * Configuration options for an RTMP stream
+ */
+export interface RtmpStreamOptions {
+    /** The RTMP URL to stream to (e.g., rtmp://server.example.com/live/stream-key) */
+    rtmpUrl: string;
+    /** Optional video configuration settings */
+    video?: VideoConfig;
+    /** Optional audio configuration settings */
+    audio?: AudioConfig;
+    /** Optional stream configuration settings */
+    stream?: StreamConfig;
+}
+/**
+ * StreamingModule provides functionality for TPAs to request and manage RTMP streams.
+ *
+ * Streams can be requested with configurable parameters for video quality,
+ * audio settings, and stream constraints. Status updates are received through
+ * the standard subscription mechanism.
+ */
+export declare class StreamingModule {
+    private send;
+    private packageName;
+    private sessionId;
+    private session?;
+    private isStreaming;
+    private currentStreamUrl?;
+    private currentStreamState?;
+    /**
+     * Create a new StreamingModule
+     *
+     * @param packageName - The TPA package name
+     * @param sessionId - The current session ID
+     * @param send - Function to send messages to the cloud
+     * @param session - Reference to the parent TpaSession (optional)
+     */
+    constructor(packageName: string, sessionId: string, send: (message: any) => void, session?: any);
+    /**
+     * Begin an RTMP stream to the specified URL
+     *
+     * @param options - Configuration options for the stream
+     * @returns Promise that resolves when the stream request is sent (not when streaming begins)
+     */
+    requestStream(options: RtmpStreamOptions): Promise<void>;
+    /**
+     * Stop the current RTMP stream
+     *
+     * @returns Promise that resolves when the stop request is sent
+     */
+    stopStream(): Promise<void>;
+    /**
+     * Check if currently streaming
+     *
+     * @returns True if a stream is active or initializing
+     */
+    isCurrentlyStreaming(): boolean;
+    /**
+     * Get the URL of the current stream (if any)
+     *
+     * @returns The RTMP URL of the current stream, or undefined if not streaming
+     */
+    getCurrentStreamUrl(): string | undefined;
+    /**
+     * Get the current stream status
+     *
+     * @returns The current stream status, or undefined if not available
+     */
+    getStreamStatus(): RtmpStreamStatus | undefined;
+    /**
+     * Subscribe to RTMP stream status updates
+     * This uses the standard stream subscription mechanism
+     */
+    subscribeToStatusUpdates(): void;
+    /**
+     * Unsubscribe from RTMP stream status updates
+     */
+    unsubscribeFromStatusUpdates(): void;
+    /**
+     * Listen for status updates using the standard event system
+     * @param handler - Function to call when stream status changes
+     * @returns Cleanup function to remove the handler
+     */
+    onStatus(handler: StreamStatusHandler): () => void;
+    /**
+     * Update internal stream state based on a status message
+     * For internal use by TpaSession
+     * @param message - The status message from the cloud
+     */
+    updateStreamState(message: any): void;
+}
+//# sourceMappingURL=streaming.d.ts.map

package/dist/tpa/session/modules/streaming.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"streaming.d.ts","sourceRoot":"","sources":["../../../../src/tpa/session/modules/streaming.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAKL,gBAAgB,EAEjB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,WAAW,EACX,WAAW,EACX,YAAY,EAEZ,mBAAmB,EACpB,MAAM,4BAA4B,CAAC;AAGpC,OAAO,EACL,WAAW,EACX,WAAW,EACX,YAAY,EAEZ,mBAAmB,EACpB,CAAC;AAKF;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,kFAAkF;IAClF,OAAO,EAAE,MAAM,CAAC;IAChB,4CAA4C;IAC5C,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,4CAA4C;IAC5C,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB;AAID;;;;;;GAMG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,IAAI,CAAyB;IACrC,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,OAAO,CAAC,CAAM;IACtB,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,gBAAgB,CAAC,CAAS;IAClC,OAAO,CAAC,kBAAkB,CAAC,CAAmB;IAE9C;;;;;;;OAOG;gBACS,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,EAAE,OAAO,CAAC,EAAE,GAAG;IAO/F;;;;;OAKG;IACG,aAAa,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IA8E9D;;;;OAIG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAuCjC;;;;OAIG;IACH,oBAAoB,IAAI,OAAO;IAI/B;;;;OAIG;IACH,mBAAmB,IAAI,MAAM,GAAG,SAAS;IAIzC;;;;OAIG;IACH,eAAe,IAAI,gBAAgB,GAAG,SAAS;IAI/C;;;OAGG;IACH,wBAAwB,IAAI,IAAI;IAQhC;;OAEG;IACH,4BAA4B,IAAI,IAAI;IAMpC;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,mBAAmB,GAAG,MAAM,IAAI;IAUlD;;;;OAIG;IACH,iBAAiB,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI;CA2DtC"}