@mentra/sdk 1.1.19 → 2.0.0

package/dist/{tpa → app}/session/index.d.ts

@@ -2,16 +2,16 @@ import { EventManager, EventData } from './events';
 import { LayoutManager } from './layouts';
 import { SettingsManager } from './settings';
 import { StreamingModule } from './modules/streaming';
-import { ExtendedStreamType, ButtonPress, HeadPosition, PhoneNotification, TranscriptionData, TranslationData, AppSettings, AppSetting, TpaConfig, VpsCoordinates, PhotoTaken } from '../../types';
+import { ExtendedStreamType, ButtonPress, HeadPosition, PhoneNotification, TranscriptionData, TranslationData, AppSettings, AppSetting, AppConfig, VpsCoordinates, PhotoTaken, Capabilities } from '../../types';
 import { DashboardAPI } from '../../types/dashboard';
 import { Logger } from 'pino';
-import { TpaServer } from '../server';
+import { AppServer } from '../server';
 /**
- * ⚙️ Configuration options for TPA Session
+ * ⚙️ Configuration options for App Session
  *
  * @example
  * ```typescript
- * const config: TpaSessionConfig = {
+ * const config: AppSessionConfig = {
  *   packageName: 'org.example.myapp',
  *   apiKey: 'your_api_key',
  *   // Auto-reconnection is enabled by default
@@ -19,12 +19,12 @@ import { TpaServer } from '../server';
  * };
  * ```
  */
-export interface TpaSessionConfig {
-    /** 📦 Unique identifier for your TPA (e.g., 'org.company.appname') */
+export interface AppSessionConfig {
+    /** 📦 Unique identifier for your App (e.g., 'org.company.appname') */
     packageName: string;
     /** 🔑 API key for authentication with AugmentOS Cloud */
     apiKey: string;
-    /** 🔌 WebSocket server URL (default: 'ws://localhost:7002/tpa-ws') */
+    /** 🔌 WebSocket server URL (default: 'ws://localhost:7002/app-ws') */
     augmentOSWebsocketUrl?: string;
     /** 🔄 Automatically attempt to reconnect on disconnect (default: true) */
     autoReconnect?: boolean;
@@ -33,12 +33,12 @@ export interface TpaSessionConfig {
     /** ⏱️ Base delay between reconnection attempts in ms (default: 1000) */
     reconnectDelay?: number;
     userId: string;
-    tpaServer: TpaServer;
+    appServer: AppServer;
 }
 /**
- * 🚀 TPA Session Implementation
+ * 🚀 App Session Implementation
  *
- * Manages a live connection between your TPA and AugmentOS Cloud.
+ * Manages a live connection between your App and AugmentOS Cloud.
  * Provides interfaces for:
  * - 🎮 Event handling (transcription, head position, etc.)
  * - 📱 Display management in AR view
@@ -47,7 +47,7 @@ export interface TpaSessionConfig {
  *
  * @example
  * ```typescript
- * const session = new TpaSession({
+ * const session = new AppSession({
  *   packageName: 'org.example.myapp',
  *   apiKey: 'your_api_key'
  * });
@@ -61,7 +61,7 @@ export interface TpaSessionConfig {
  * await session.connect('session_123');
  * ```
  */
-export declare class TpaSession {
+export declare class AppSession {
     private config;
     /** WebSocket connection to AugmentOS Cloud */
     private ws;
@@ -75,8 +75,8 @@ export declare class TpaSession {
     private resources;
     /** Internal settings storage - use public settings API instead */
     private settingsData;
-    /** TPA configuration loaded from tpa_config.json */
-    private tpaConfig;
+    /** App configuration loaded from app_config.json */
+    private appConfig;
     /** Whether to update subscriptions when settings change */
     private shouldUpdateSubscriptionsOnSettingsChange;
     /** Custom subscription handler for settings-based subscriptions */
@@ -99,19 +99,21 @@ export declare class TpaSession {
     readonly dashboard: DashboardAPI;
     /** 📹 RTMP streaming interface */
     readonly streaming: StreamingModule;
-    readonly tpaServer: TpaServer;
+    readonly appServer: AppServer;
     readonly logger: Logger;
     readonly userId: string;
-    /** Dedicated emitter for TPA-to-TPA events */
-    private tpaEvents;
-    constructor(config: TpaSessionConfig);
+    /** 🔧 Device capabilities available for this session */
+    capabilities: Capabilities | null;
+    /** Dedicated emitter for App-to-App events */
+    private appEvents;
+    constructor(config: AppSessionConfig);
     /**
      * Get the current session ID
      * @returns The current session ID or 'unknown-session-id' if not connected
      */
     getSessionId(): string;
     /**
-     * Get the package name for this TPA
+     * Get the package name for this App
      * @returns The package name
      */
     getPackageName(): string;
@@ -217,7 +219,7 @@ export declare class TpaSession {
     getSetting<T>(key: string): T | undefined;
     /**
      * ⚙️ Configure settings-based subscription updates
-     * This allows TPAs to automatically update their subscriptions when certain settings change
+     * This allows Apps to automatically update their subscriptions when certain settings change
      * @param options Configuration options for settings-based subscriptions
      */
     setSubscriptionSettings(options: {
@@ -237,16 +239,16 @@ export declare class TpaSession {
     updateSettingsForTesting(newSettings: AppSettings): void;
     /**
      * 📝 Load configuration from a JSON file
-     * @param jsonData JSON string containing TPA configuration
+     * @param jsonData JSON string containing App configuration
      * @returns The loaded configuration
      * @throws Error if the configuration is invalid
      */
-    loadConfigFromJson(jsonData: string): TpaConfig;
+    loadConfigFromJson(jsonData: string): AppConfig;
     /**
-     * 📋 Get the loaded TPA configuration
-     * @returns The current TPA configuration or null if not loaded
+     * 📋 Get the loaded App configuration
+     * @returns The current App configuration or null if not loaded
      */
-    getConfig(): TpaConfig | null;
+    getConfig(): AppConfig | null;
     /**
      * 🔌 Get the WebSocket server URL for this session
      * @returns The WebSocket server URL used by this session
@@ -255,7 +257,7 @@ export declare class TpaSession {
     getHttpsServerUrl(): string | undefined;
     private static convertToHttps;
     /**
-     * 🔍 Get default settings from the TPA configuration
+     * 🔍 Get default settings from the App configuration
      * @returns Array of settings with default values
      * @throws Error if configuration is not loaded
      */
@@ -311,11 +313,11 @@ export declare class TpaSession {
      */
     getInstructions(): Promise<string | null>;
     /**
-     * 👥 Discover other users currently using the same TPA
+     * 👥 Discover other users currently using the same App
      * @param includeProfiles - Whether to include user profile information
      * @returns Promise that resolves with list of active users
      */
-    discoverTpaUsers(domain: string, includeProfiles?: boolean): Promise<any>;
+    discoverAppUsers(domain: string, includeProfiles?: boolean): Promise<any>;
     /**
      * 🔍 Check if a specific user is currently active
      * @param userId - User ID to check for
@@ -323,17 +325,17 @@ export declare class TpaSession {
      */
     isUserActive(userId: string): Promise<boolean>;
     /**
-     * 📊 Get user count for this TPA
+     * 📊 Get user count for this App
      * @returns Promise that resolves with number of active users
      */
     getUserCount(domain: string): Promise<number>;
     /**
-     * 📢 Send broadcast message to all users with same TPA active
+     * 📢 Send broadcast message to all users with same App active
      * @param payload - Message payload to send
      * @param roomId - Optional room ID for room-based messaging
      * @returns Promise that resolves when message is sent
      */
-    broadcastToTpaUsers(payload: any, roomId?: string): Promise<void>;
+    broadcastToAppUsers(payload: any, roomId?: string): Promise<void>;
     /**
      * 📤 Send direct message to specific user
      * @param targetUserId - User ID to send message to
@@ -347,7 +349,7 @@ export declare class TpaSession {
      * @param roomConfig - Optional room configuration
      * @returns Promise that resolves when room is joined
      */
-    joinTpaRoom(roomId: string, roomConfig?: {
+    joinAppRoom(roomId: string, roomConfig?: {
         maxUsers?: number;
         isPrivate?: boolean;
         metadata?: any;
@@ -357,31 +359,31 @@ export declare class TpaSession {
      * @param roomId - Room ID to leave
      * @returns Promise that resolves when room is left
      */
-    leaveTpaRoom(roomId: string): Promise<void>;
+    leaveAppRoom(roomId: string): Promise<void>;
     /**
-     * 📨 Listen for messages from other TPA users
+     * 📨 Listen for messages from other App users
      * @param handler - Function to handle incoming messages
      * @returns Cleanup function to remove the handler
      */
-    onTpaMessage(handler: (message: any) => void): () => void;
+    onAppMessage(handler: (message: any) => void): () => void;
     /**
      * 👋 Listen for user join events
      * @param handler - Function to handle user join events
      * @returns Cleanup function to remove the handler
      */
-    onTpaUserJoined(handler: (data: any) => void): () => void;
+    onAppUserJoined(handler: (data: any) => void): () => void;
     /**
      * 🚪 Listen for user leave events
      * @param handler - Function to handle user leave events
      * @returns Cleanup function to remove the handler
      */
-    onTpaUserLeft(handler: (data: any) => void): () => void;
+    onAppUserLeft(handler: (data: any) => void): () => void;
     /**
      * 🏠 Listen for room update events
      * @param handler - Function to handle room updates
      * @returns Cleanup function to remove the handler
      */
-    onTpaRoomUpdated(handler: (data: any) => void): () => void;
+    onAppRoomUpdated(handler: (data: any) => void): () => void;
     /**
      * 🔧 Generate unique message ID
      * @returns Unique message identifier

package/dist/app/session/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/app/session/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAmB,MAAM,UAAU,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAEtD,OAAO,EAYL,kBAAkB,EAClB,WAAW,EACX,YAAY,EACZ,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EAYf,WAAW,EACX,UAAU,EACV,SAAS,EAQT,cAAc,EACd,UAAU,EACV,YAAY,EACb,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAQtC;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,gBAAgB;IAC/B,sEAAsE;IACtE,WAAW,EAAE,MAAM,CAAC;IACpB,yDAAyD;IACzD,MAAM,EAAE,MAAM,CAAC;IACf,sEAAsE;IACtE,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,0EAA0E;IAC1E,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,8DAA8D;IAC9D,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,wEAAwE;IACxE,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,SAAS,CAAC;CACtB;AAWD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,UAAU;IA0DT,OAAO,CAAC,MAAM;IAzD1B,8CAA8C;IAC9C,OAAO,CAAC,EAAE,CAA0B;IACpC,iCAAiC;IACjC,OAAO,CAAC,SAAS,CAAuB;IACxC,2CAA2C;IAC3C,OAAO,CAAC,iBAAiB,CAAK;IAC9B,iCAAiC;IACjC,OAAO,CAAC,aAAa,CAAiC;IACtD,6CAA6C;IAC7C,OAAO,CAAC,SAAS,CAAyB;IAC1C,kEAAkE;IAClE,OAAO,CAAC,YAAY,CAAmB;IACvC,oDAAoD;IACpD,OAAO,CAAC,SAAS,CAA0B;IAC3C,2DAA2D;IAC3D,OAAO,CAAC,yCAAyC,CAAS;IAC1D,mEAAmE;IACnE,OAAO,CAAC,2BAA2B,CAAC,CAAkD;IACtF,qEAAqE;IACrE,OAAO,CAAC,0BAA0B,CAAgB;IAClD,mDAAmD;IACnD,OAAO,CAAC,oBAAoB,CAGvB;IACL,4DAA4D;IAC5D,OAAO,CAAC,4BAA4B,CAG/B;IACL,4DAA4D;IAC5D,OAAO,CAAC,qBAAqB,CAGxB;IAEL,oCAAoC;IACpC,SAAgB,MAAM,EAAE,YAAY,CAAC;IACrC,qCAAqC;IACrC,SAAgB,OAAO,EAAE,aAAa,CAAC;IACvC,uCAAuC;IACvC,SAAgB,QAAQ,EAAE,eAAe,CAAC;IAC1C,wCAAwC;IACxC,SAAgB,SAAS,EAAE,YAAY,CAAC;IACxC,kCAAkC;IAClC,SAAgB,SAAS,EAAE,eAAe,CAAC;IAE3C,SAAgB,SAAS,EAAE,SAAS,CAAC;IACrC,SAAgB,MAAM,EAAE,MAAM,CAAC;IAC/B,SAAgB,MAAM,EAAE,MAAM,CAAC;IAE/B,wDAAwD;IACjD,YAAY,EAAE,YAAY,GAAG,IAAI,CAAQ;IAEhD,8CAA8C;IAC9C,OAAO,CAAC,SAAS,CAAsB;gBAEnB,MAAM,EAAE,gBAAgB;IA4F5C;;;OAGG;IACH,YAAY,IAAI,MAAM;IAItB;;;OAGG;IACH,cAAc,IAAI,MAAM;IAQxB;;;;OAIG;IACH,eAAe,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,iBAAiB,KAAK,IAAI,GAAG,MAAM,IAAI;IAIvE;;;;;;OAMG;IACH,0BAA0B,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,IAAI,EAAE,iBAAiB,KAAK,IAAI,GAAG,MAAM,IAAI;IAIpG;;;;;;;OAOG;IACH,wBAAwB,CAAC,cAAc,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,IAAI,GAAG,MAAM,IAAI;IAI9H;;;;OAIG;IACH,cAAc,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,GAAG,MAAM,IAAI;IAIjE;;;;OAIG;IACH,aAAa,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,GAAG,MAAM,IAAI;IAI/D;;;;OAIG;IACH,oBAAoB,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,iBAAiB,KAAK,IAAI,GAAG,MAAM,IAAI;IAI5E;;;;OAIG;IACH,gBAAgB,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,GAAG,MAAM,IAAI;IAKrE;;;;OAIG;IACH,YAAY,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,IAAI,GAAG,MAAM,IAAI;IAS7D;;;OAGG;IACH,SAAS,CAAC,IAAI,EAAE,kBAAkB,GAAG,IAAI;IAWzC;;;OAGG;IACH,WAAW,CAAC,IAAI,EAAE,kBAAkB,GAAG,IAAI;IAW3C;;;;OAIG;IACH,EAAE,CAAC,CAAC,SAAS,kBAAkB,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,MAAM,IAAI;IAQ7F;;;;OAIG;IACG,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgQ/C;;OAEG;IACH,UAAU,IAAI,IAAI;IAWlB;;;;OAIG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE;QAAE,aAAa,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAoCpE;;;;OAIG;IACH,WAAW,IAAI,WAAW;IAI1B;;;;;OAKG;IACH,UAAU,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAIzC;;;;OAIG;IACH,uBAAuB,CAAC,OAAO,EAAE;QAC/B,cAAc,EAAE,MAAM,EAAE,CAAC;QACzB,OAAO,EAAE,CAAC,QAAQ,EAAE,WAAW,KAAK,kBAAkB,EAAE,CAAC;KAC1D,GAAG,IAAI;IAWR;;;OAGG;IACH,OAAO,CAAC,+BAA+B;IAwBvC;;;;OAIG;IACH,wBAAwB,CAAC,WAAW,EAAE,WAAW,GAAG,IAAI;IAexD;;;;;OAKG;IACH,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS;IAgB/C;;;OAGG;IACH,SAAS,IAAI,SAAS,GAAG,IAAI;IAI7B;;;OAGG;IACH,YAAY,IAAI,MAAM,GAAG,SAAS;IAIlC,iBAAiB,IAAI,MAAM,GAAG,SAAS;IAOvC,OAAO,CAAC,MAAM,CAAC,cAAc;IAU7B;;;;OAIG;IACH,kBAAkB,IAAI,WAAW;IAajC;;;;OAIG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAcrD;;OAEG;IACH,OAAO,CAAC,aAAa;IA6RrB;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAoBvB;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IA8B3B;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IA+CzB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAW1B;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAY3B;;OAEG;YACW,kBAAkB;IA8DhC;;;OAGG;IACH,OAAO,CAAC,IAAI;IAwDZ;;;OAGG;IACU,eAAe,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IActD;;;;OAIG;IACG,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,eAAe,UAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAgC7E;;;;OAIG;IACG,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAUpD;;;OAGG;IACG,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAUnD;;;;;OAKG;IACG,mBAAmB,CAAC,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBvE;;;;;OAKG;IACG,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAoC7E;;;;;OAKG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE;QAC7C,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,QAAQ,CAAC,EAAE,GAAG,CAAC;KAChB,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBjB;;;;OAIG;IACG,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBjD;;;;OAIG;IACH,YAAY,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,GAAG,MAAM,IAAI;IAKzD;;;;OAIG;IACH,eAAe,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,GAAG,MAAM,IAAI;IAKzD;;;;OAIG;IACH,aAAa,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,GAAG,MAAM,IAAI;IAKvD;;;;OAIG;IACH,gBAAgB,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI,GAAG,MAAM,IAAI;IAK1D;;;OAGG;IACH,OAAO,CAAC,iBAAiB;CAG1B"}