@mentra/sdk 2.0.4 → 2.1.1

package/package.json

@@ -1,7 +1,6 @@
 {
-
   "name": "@mentra/sdk",
-  "version": "2.0.4",
+  "version": "2.1.1",
   "description": "Build apps for MentraOS smartglasses. This SDK provides everything you need to create real-time smartglasses applications.",
   "source": "src/index.ts",
   "main": "dist/index.js",
@@ -32,6 +31,7 @@
     "express": "^4.18.2",
     "jsonwebtoken": "^8.5.1",
     "jsrsasign": "^11.1.0",
+    "multer": "^2.0.1",
     "pino": "^9.6.0",
     "pino-pretty": "^13.0.0",
     "ws": "^8.18.2"

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

@@ -1,100 +0,0 @@
-/**
- * 📹 RTMP Streaming Module
- *
- * Provides functionality for Apps 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 Apps 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 App package name
-     * @param sessionId - The current session ID
-     * @param send - Function to send messages to the cloud
-     * @param session - Reference to the parent AppSession (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 AppSession
-     * @param message - The status message from the cloud
-     */
-    updateStreamState(message: any): void;
-}
-//# sourceMappingURL=streaming.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"streaming.d.ts","sourceRoot":"","sources":["../../../../src/app/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"}

package/dist/app/session/modules/streaming.js

@@ -1,270 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StreamingModule = void 0;
-/**
- * 📹 RTMP Streaming Module
- *
- * Provides functionality for Apps to request and manage RTMP streams from smart glasses.
- * Handles stream lifecycle, status monitoring, and cleanup.
- */
-const types_1 = require("../../../types");
-const streams_1 = require("../../../types/streams");
-// Stream status information and handler types are imported from '../../../types/rtmp-stream'
-/**
- * StreamingModule provides functionality for Apps 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.
- */
-class StreamingModule {
-    /**
-     * Create a new StreamingModule
-     *
-     * @param packageName - The App package name
-     * @param sessionId - The current session ID
-     * @param send - Function to send messages to the cloud
-     * @param session - Reference to the parent AppSession (optional)
-     */
-    constructor(packageName, sessionId, send, session) {
-        this.isStreaming = false;
-        this.packageName = packageName;
-        this.sessionId = sessionId;
-        this.send = send;
-        this.session = session;
-    }
-    /**
-     * 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)
-     */
-    async requestStream(options) {
-        console.log(`[RTMP_STREAM_REQUEST] StreamingModule.requestStream called`, {
-            debugKey: 'RTMP_STREAM_REQUEST',
-            packageName: this.packageName,
-            sessionId: this.sessionId,
-            rtmpUrl: options.rtmpUrl,
-            isCurrentlyStreaming: this.isStreaming,
-            currentStreamUrl: this.currentStreamUrl,
-            currentStreamState: this.currentStreamState
-        });
-        if (!options.rtmpUrl) {
-            throw new Error('rtmpUrl is required');
-        }
-        if (this.isStreaming) {
-            console.error(`[RTMP_STREAM_ALREADY_ACTIVE] Already streaming error`, {
-                debugKey: 'RTMP_STREAM_ALREADY_ACTIVE',
-                packageName: this.packageName,
-                sessionId: this.sessionId,
-                currentStreamUrl: this.currentStreamUrl,
-                requestedUrl: options.rtmpUrl,
-                currentStreamState: this.currentStreamState,
-                isStreaming: this.isStreaming
-            });
-            throw new Error('Already streaming. Stop the current stream before starting a new one.');
-        }
-        // Create stream request message
-        const message = {
-            type: types_1.AppToCloudMessageType.RTMP_STREAM_REQUEST,
-            packageName: this.packageName,
-            sessionId: this.sessionId,
-            rtmpUrl: options.rtmpUrl,
-            video: options.video,
-            audio: options.audio,
-            stream: options.stream,
-            timestamp: new Date()
-        };
-        // Save stream URL for reference
-        this.currentStreamUrl = options.rtmpUrl;
-        // Send the request
-        try {
-            console.log(`[RTMP_STREAM_SENDING] Sending RTMP stream request`, {
-                debugKey: 'RTMP_STREAM_SENDING',
-                packageName: this.packageName,
-                sessionId: this.sessionId,
-                rtmpUrl: options.rtmpUrl,
-                messageType: message.type
-            });
-            this.send(message);
-            this.isStreaming = true;
-            console.log(`[RTMP_STREAM_REQUEST_SENT] RTMP stream request sent successfully`, {
-                debugKey: 'RTMP_STREAM_REQUEST_SENT',
-                packageName: this.packageName,
-                sessionId: this.sessionId,
-                isStreaming: this.isStreaming,
-                currentStreamUrl: this.currentStreamUrl
-            });
-            return Promise.resolve();
-        }
-        catch (error) {
-            console.error(`[RTMP_STREAM_REQUEST_FAIL] Failed to send RTMP stream request`, {
-                debugKey: 'RTMP_STREAM_REQUEST_FAIL',
-                packageName: this.packageName,
-                sessionId: this.sessionId,
-                error,
-                rtmpUrl: options.rtmpUrl
-            });
-            const errorMessage = error instanceof Error ? error.message : String(error);
-            return Promise.reject(new Error(`Failed to request RTMP stream: ${errorMessage}`));
-        }
-    }
-    /**
-     * Stop the current RTMP stream
-     *
-     * @returns Promise that resolves when the stop request is sent
-     */
-    async stopStream() {
-        console.log(`[RTMP_STREAM_STOP_REQUEST] StreamingModule.stopStream called`, {
-            debugKey: 'RTMP_STREAM_STOP_REQUEST',
-            packageName: this.packageName,
-            sessionId: this.sessionId,
-            isCurrentlyStreaming: this.isStreaming,
-            currentStreamUrl: this.currentStreamUrl,
-            currentStreamState: this.currentStreamState
-        });
-        if (!this.isStreaming) {
-            console.log(`[RTMP_STREAM_STOP_NOOP] Not streaming - no-op`, {
-                debugKey: 'RTMP_STREAM_STOP_NOOP',
-                packageName: this.packageName,
-                sessionId: this.sessionId
-            });
-            // Not an error - just a no-op if not streaming
-            return Promise.resolve();
-        }
-        // Create stop request message
-        const message = {
-            type: types_1.AppToCloudMessageType.RTMP_STREAM_STOP,
-            packageName: this.packageName,
-            sessionId: this.sessionId,
-            streamId: this.currentStreamState?.streamId, // Include streamId if available
-            timestamp: new Date()
-        };
-        // Send the request
-        try {
-            this.send(message);
-            return Promise.resolve();
-        }
-        catch (error) {
-            const errorMessage = error instanceof Error ? error.message : String(error);
-            return Promise.reject(new Error(`Failed to stop RTMP stream: ${errorMessage}`));
-        }
-    }
-    /**
-     * Check if currently streaming
-     *
-     * @returns True if a stream is active or initializing
-     */
-    isCurrentlyStreaming() {
-        return this.isStreaming;
-    }
-    /**
-     * Get the URL of the current stream (if any)
-     *
-     * @returns The RTMP URL of the current stream, or undefined if not streaming
-     */
-    getCurrentStreamUrl() {
-        return this.currentStreamUrl;
-    }
-    /**
-     * Get the current stream status
-     *
-     * @returns The current stream status, or undefined if not available
-     */
-    getStreamStatus() {
-        return this.currentStreamState;
-    }
-    /**
-     * Subscribe to RTMP stream status updates
-     * This uses the standard stream subscription mechanism
-     */
-    subscribeToStatusUpdates() {
-        if (this.session) {
-            this.session.subscribe(streams_1.StreamType.RTMP_STREAM_STATUS);
-        }
-        else {
-            console.error('Cannot subscribe to status updates: session reference not available');
-        }
-    }
-    /**
-     * Unsubscribe from RTMP stream status updates
-     */
-    unsubscribeFromStatusUpdates() {
-        if (this.session) {
-            this.session.unsubscribe(streams_1.StreamType.RTMP_STREAM_STATUS);
-        }
-    }
-    /**
-     * 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) {
-        if (!this.session) {
-            console.error('Cannot listen for status updates: session reference not available');
-            return () => { };
-        }
-        this.subscribeToStatusUpdates();
-        return this.session.on(streams_1.StreamType.RTMP_STREAM_STATUS, handler);
-    }
-    /**
-     * Update internal stream state based on a status message
-     * For internal use by AppSession
-     * @param message - The status message from the cloud
-     */
-    updateStreamState(message) {
-        console.log(`[RTMP_STREAM_STATE_UPDATE] StreamingModule.updateStreamState called`, {
-            debugKey: 'RTMP_STREAM_STATE_UPDATE',
-            packageName: this.packageName,
-            sessionId: this.sessionId,
-            messageType: message?.type,
-            messageStatus: message?.status,
-            currentIsStreaming: this.isStreaming
-        });
-        // Verify this is a valid stream response
-        if (!(0, types_1.isRtmpStreamStatus)(message)) {
-            console.warn('[RTMP_STREAM_INVALID_STATUS] Received invalid stream status message', {
-                debugKey: 'RTMP_STREAM_INVALID_STATUS',
-                packageName: this.packageName,
-                sessionId: this.sessionId,
-                message
-            });
-            return;
-        }
-        // Convert to StreamStatus format
-        const status = {
-            type: message.type,
-            streamId: message.streamId,
-            status: message.status,
-            errorDetails: message.errorDetails,
-            appId: message.appId,
-            stats: message.stats,
-            timestamp: message.timestamp || new Date()
-        };
-        console.log(`[RTMP_STREAM_STATUS_PROCESSED] Stream status processed`, {
-            debugKey: 'RTMP_STREAM_STATUS_PROCESSED',
-            packageName: this.packageName,
-            sessionId: this.sessionId,
-            streamId: status.streamId,
-            oldStatus: this.currentStreamState?.status,
-            newStatus: status.status,
-            wasStreaming: this.isStreaming
-        });
-        // Updated logic to check for timeout to handle resetting state.
-        // Update local state based on status
-        if (status.status === 'stopped' || status.status === 'error' || status.status === 'timeout') {
-            console.log(`[RTMP_STREAM_STATE_STOPPED] Stream stopped - updating local state`, {
-                debugKey: 'RTMP_STREAM_STATE_STOPPED',
-                packageName: this.packageName,
-                sessionId: this.sessionId,
-                status: status.status,
-                wasStreaming: this.isStreaming
-            });
-            this.isStreaming = false;
-            this.currentStreamUrl = undefined;
-        }
-        // Save the latest status
-        this.currentStreamState = status;
-    }
-}
-exports.StreamingModule = StreamingModule;