@photon-os/sdk 1.0.0-alpha.1 → 1.0.0-alpha.3

package/dist/index.d.mts

@@ -12,6 +12,37 @@ type RunningAppInstance = {
     isInBackground: boolean;
 };
 
+/** A registered Second Life device */
+interface SLDevice {
+    id: string;
+    objectKey: string;
+    objectName: string;
+    regionName?: string;
+    isOnline: boolean;
+    lastHeartbeatAt: Date;
+    registeredAt: Date;
+    metadata?: Record<string, unknown>;
+}
+/** A message received from a Second Life device */
+interface DeviceMessage {
+    deviceId: string;
+    objectKey: string;
+    objectName: string;
+    type: string;
+    payload: Record<string, unknown>;
+    timestamp: Date;
+}
+/** Result of sending a message to a device */
+interface SendMessageResult {
+    success: boolean;
+    error?: string;
+    deviceOffline?: boolean;
+}
+/** Callback for receiving device messages */
+type DeviceMessageCallback = (message: DeviceMessage) => void;
+/** Function to unsubscribe from device messages */
+type Unsubscribe = () => void;
+
 /**
  * Value types supported for preferences.
  * Stored as JSONB in the database.
@@ -69,6 +100,11 @@ type OperatingSystemAPI = {
     accounts_getLinkedSecondLifeAccounts: () => Promise<SecondLifeAccount[]>;
     accounts_unlinkSecondLifeAccount: (avatarUuid: string) => Promise<void>;
     accounts_generateLinkingCode: () => Promise<LinkingCode>;
+    devices_getRegistered: () => Promise<SLDevice[]>;
+    devices_sendMessage: (deviceId: string, type: string, payload: Record<string, unknown>) => Promise<SendMessageResult>;
+    devices_unregister: (deviceId: string) => Promise<void>;
+    devices_subscribe: (callback: (message: DeviceMessage) => void) => Promise<void>;
+    devices_unsubscribe: () => Promise<void>;
 };
 
 declare class AccountManager {
@@ -91,6 +127,25 @@ declare class AppManager {
     requestAppUninstall(app: AppDefinition): Promise<void>;
 }
 
+declare class DeviceManager {
+    private os;
+    private messageCallbacks;
+    private subscribed;
+    constructor(os: OS);
+    /** Get all registered Second Life devices for the current user */
+    getRegisteredDevices(): Promise<SLDevice[]>;
+    /** Send a message to a registered device */
+    sendMessage(deviceId: string, type: string, payload?: Record<string, unknown>): Promise<SendMessageResult>;
+    /** Unregister a device */
+    unregisterDevice(deviceId: string): Promise<void>;
+    /** Subscribe to messages from all registered devices */
+    subscribeToMessages(deviceId: string, callback: DeviceMessageCallback): Unsubscribe;
+    /** Internal: Start the message subscription via RPC */
+    private startSubscription;
+    /** Internal: Stop the message subscription */
+    private stopSubscription;
+}
+
 /**
  * Manages user preferences for apps.
  *
@@ -143,6 +198,7 @@ type OSConfig = {
 declare class OS {
     accounts: AccountManager;
     apps: AppManager;
+    devices: DeviceManager;
     prefs: PreferencesManager;
     user: UserManager;
     private config;
@@ -153,4 +209,4 @@ declare class OS {
 
 declare const VERSION = "1.0.0";
 
-export { type AppBundleId, type AppDefinition, type AppLaunchResult, type LinkingCode, OS, type OSConfig, type OperatingSystemAPI, type PhotonUser, type PreferenceValue, type RunningAppInstance, type SecondLifeAccount, VERSION };
+export { type AppBundleId, type AppDefinition, type AppLaunchResult, type DeviceMessage, type DeviceMessageCallback, type LinkingCode, OS, type OSConfig, type OperatingSystemAPI, type PhotonUser, type PreferenceValue, type RunningAppInstance, type SLDevice, type SecondLifeAccount, type SendMessageResult, type Unsubscribe, VERSION };

package/dist/index.d.ts

@@ -12,6 +12,37 @@ type RunningAppInstance = {
     isInBackground: boolean;
 };
 
+/** A registered Second Life device */
+interface SLDevice {
+    id: string;
+    objectKey: string;
+    objectName: string;
+    regionName?: string;
+    isOnline: boolean;
+    lastHeartbeatAt: Date;
+    registeredAt: Date;
+    metadata?: Record<string, unknown>;
+}
+/** A message received from a Second Life device */
+interface DeviceMessage {
+    deviceId: string;
+    objectKey: string;
+    objectName: string;
+    type: string;
+    payload: Record<string, unknown>;
+    timestamp: Date;
+}
+/** Result of sending a message to a device */
+interface SendMessageResult {
+    success: boolean;
+    error?: string;
+    deviceOffline?: boolean;
+}
+/** Callback for receiving device messages */
+type DeviceMessageCallback = (message: DeviceMessage) => void;
+/** Function to unsubscribe from device messages */
+type Unsubscribe = () => void;
+
 /**
  * Value types supported for preferences.
  * Stored as JSONB in the database.
@@ -69,6 +100,11 @@ type OperatingSystemAPI = {
     accounts_getLinkedSecondLifeAccounts: () => Promise<SecondLifeAccount[]>;
     accounts_unlinkSecondLifeAccount: (avatarUuid: string) => Promise<void>;
     accounts_generateLinkingCode: () => Promise<LinkingCode>;
+    devices_getRegistered: () => Promise<SLDevice[]>;
+    devices_sendMessage: (deviceId: string, type: string, payload: Record<string, unknown>) => Promise<SendMessageResult>;
+    devices_unregister: (deviceId: string) => Promise<void>;
+    devices_subscribe: (callback: (message: DeviceMessage) => void) => Promise<void>;
+    devices_unsubscribe: () => Promise<void>;
 };
 
 declare class AccountManager {
@@ -91,6 +127,25 @@ declare class AppManager {
     requestAppUninstall(app: AppDefinition): Promise<void>;
 }
 
+declare class DeviceManager {
+    private os;
+    private messageCallbacks;
+    private subscribed;
+    constructor(os: OS);
+    /** Get all registered Second Life devices for the current user */
+    getRegisteredDevices(): Promise<SLDevice[]>;
+    /** Send a message to a registered device */
+    sendMessage(deviceId: string, type: string, payload?: Record<string, unknown>): Promise<SendMessageResult>;
+    /** Unregister a device */
+    unregisterDevice(deviceId: string): Promise<void>;
+    /** Subscribe to messages from all registered devices */
+    subscribeToMessages(deviceId: string, callback: DeviceMessageCallback): Unsubscribe;
+    /** Internal: Start the message subscription via RPC */
+    private startSubscription;
+    /** Internal: Stop the message subscription */
+    private stopSubscription;
+}
+
 /**
  * Manages user preferences for apps.
  *
@@ -143,6 +198,7 @@ type OSConfig = {
 declare class OS {
     accounts: AccountManager;
     apps: AppManager;
+    devices: DeviceManager;
     prefs: PreferencesManager;
     user: UserManager;
     private config;
@@ -153,4 +209,4 @@ declare class OS {
 
 declare const VERSION = "1.0.0";
 
-export { type AppBundleId, type AppDefinition, type AppLaunchResult, type LinkingCode, OS, type OSConfig, type OperatingSystemAPI, type PhotonUser, type PreferenceValue, type RunningAppInstance, type SecondLifeAccount, VERSION };
+export { type AppBundleId, type AppDefinition, type AppLaunchResult, type DeviceMessage, type DeviceMessageCallback, type LinkingCode, OS, type OSConfig, type OperatingSystemAPI, type PhotonUser, type PreferenceValue, type RunningAppInstance, type SLDevice, type SecondLifeAccount, type SendMessageResult, type Unsubscribe, VERSION };

package/dist/index.js

@@ -1233,6 +1233,71 @@ var AppManager = class {
   }
 };
 
+// src/framework/DeviceManager.ts
+var DeviceManager = class {
+  constructor(os) {
+    this.messageCallbacks = {};
+    this.subscribed = false;
+    this.os = os;
+  }
+  /** Get all registered Second Life devices for the current user */
+  async getRegisteredDevices() {
+    const api2 = await this.os.getRPCAPI();
+    return await api2.devices_getRegistered();
+  }
+  /** Send a message to a registered device */
+  async sendMessage(deviceId, type, payload = {}) {
+    const api2 = await this.os.getRPCAPI();
+    return await api2.devices_sendMessage(deviceId, type, payload);
+  }
+  /** Unregister a device */
+  async unregisterDevice(deviceId) {
+    const api2 = await this.os.getRPCAPI();
+    await api2.devices_unregister(deviceId);
+  }
+  /** Subscribe to messages from all registered devices */
+  subscribeToMessages(deviceId, callback) {
+    this.messageCallbacks[deviceId] = this.messageCallbacks[deviceId] ?? [];
+    this.messageCallbacks[deviceId].add(callback);
+    if (!this.subscribed) {
+      this.startSubscription();
+    }
+    return () => {
+      if (this.messageCallbacks[deviceId]) {
+        this.messageCallbacks[deviceId].delete(callback);
+      }
+      const totalSubscriptions = Object.values(this.messageCallbacks).reduce(
+        (acc, cv) => acc + cv.size,
+        0
+      );
+      if (totalSubscriptions === 0 && this.subscribed) {
+        this.stopSubscription();
+      }
+    };
+  }
+  /** Internal: Start the message subscription via RPC */
+  async startSubscription() {
+    const api2 = await this.os.getRPCAPI();
+    await api2.devices_subscribe((message) => {
+      const callbacks = this.messageCallbacks[message.deviceId] ?? [];
+      for (const callback of callbacks) {
+        try {
+          callback(message);
+        } catch (error) {
+          console.error("Error in device message callback:", error);
+        }
+      }
+    });
+    this.subscribed = true;
+  }
+  /** Internal: Stop the message subscription */
+  async stopSubscription() {
+    const api2 = await this.os.getRPCAPI();
+    await api2.devices_unsubscribe();
+    this.subscribed = false;
+  }
+};
+
 // src/framework/PreferencesManager.ts
 var PreferencesManager = class {
   constructor(os) {
@@ -1304,6 +1369,7 @@ var OS = class {
     this.config = config;
     this.accounts = new AccountManager(this);
     this.apps = new AppManager(this);
+    this.devices = new DeviceManager(this);
     this.prefs = new PreferencesManager(this);
     this.user = new UserManager(this);
   }