lumiverse-spindle-types 0.4.18 → 0.4.20

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lumiverse-spindle-types",
-  "version": "0.4.18",
+  "version": "0.4.20",
   "types": "./src/index.ts",
   "keywords": [
     "lumiverse",

package/src/api.ts

@@ -1077,7 +1077,7 @@ export type WorkerToHost =
       result?: string;
       error?: string;
     }
-  | { type: "frontend_message"; payload: unknown }
+  | { type: "frontend_message"; payload: unknown; userId?: string }
   | { type: "user_storage_read"; requestId: string; path: string; userId?: string }
   | { type: "user_storage_write"; requestId: string; path: string; data: string; userId?: string }
   | { type: "user_storage_delete"; requestId: string; path: string; userId?: string }
@@ -1193,7 +1193,7 @@ export type WorkerToHost =
 
 export type HostToWorker =
   | { type: "init"; manifest: SpindleManifest; storagePath: string }
-  | { type: "event"; event: string; payload: unknown }
+  | { type: "event"; event: string; payload: unknown; userId?: string }
   | {
       type: "intercept_request";
       requestId: string;

package/src/spindle-api.ts

@@ -50,21 +50,21 @@ import type {
 /** The global `spindle` object available in backend extension workers */
 export interface SpindleAPI {
   /** Subscribe to generation-started events (requires `generation` permission). */
-  on(event: "GENERATION_STARTED", handler: (payload: GenerationStartedPayloadDTO) => void): () => void;
+  on(event: "GENERATION_STARTED", handler: (payload: GenerationStartedPayloadDTO, userId?: string) => void): () => void;
   /** Subscribe to streamed token events (requires `generation` permission). */
-  on(event: "STREAM_TOKEN_RECEIVED", handler: (payload: StreamTokenPayloadDTO) => void): () => void;
+  on(event: "STREAM_TOKEN_RECEIVED", handler: (payload: StreamTokenPayloadDTO, userId?: string) => void): () => void;
   /** Subscribe to generation-ended events (requires `generation` permission). */
-  on(event: "GENERATION_ENDED", handler: (payload: GenerationEndedPayloadDTO) => void): () => void;
+  on(event: "GENERATION_ENDED", handler: (payload: GenerationEndedPayloadDTO, userId?: string) => void): () => void;
   /** Subscribe to generation-stopped events (requires `generation` permission). */
-  on(event: "GENERATION_STOPPED", handler: (payload: GenerationStoppedPayloadDTO) => void): () => void;
+  on(event: "GENERATION_STOPPED", handler: (payload: GenerationStoppedPayloadDTO, userId?: string) => void): () => void;
   /**
    * Subscribe to swipe lifecycle events. The payload's `action` discriminator
    * tells you whether a swipe was added, updated, deleted, or navigated, and
    * `swipeId` identifies which slot the event concerns.
    */
-  on(event: "MESSAGE_SWIPED", handler: (payload: MessageSwipedPayloadDTO) => void): () => void;
+  on(event: "MESSAGE_SWIPED", handler: (payload: MessageSwipedPayloadDTO, userId?: string) => void): () => void;
   /** Subscribe to a Lumiverse event. */
-  on(event: string, handler: (payload: unknown) => void): () => void;
+  on(event: string, handler: (payload: unknown, userId?: string) => void): () => void;
 
   /** Register a macro */
   registerMacro(def: MacroDefinitionDTO): void;
@@ -515,8 +515,21 @@ export interface SpindleAPI {
     priority?: number
   ): void;
 
-  /** Send a message to the frontend module */
-  sendToFrontend(payload: unknown): void;
+  /**
+   * Send a message to the frontend module.
+   *
+   * @param payload  Arbitrary JSON-serializable data delivered to the
+   *                 extension's frontend module via the `SPINDLE_FRONTEND_MSG`
+   *                 WebSocket event.
+   * @param userId   Optional target user. When omitted on operator-scoped
+   *                 extensions the message is broadcast to **every connected
+   *                 user**, which is rarely what you want — pass the userId
+   *                 from the original `onFrontendMessage` handler (or any
+   *                 other API call site that surfaced one) to route the reply
+   *                 only to that user. User-scoped extensions always deliver
+   *                 to their installer regardless of this argument.
+   */
+  sendToFrontend(payload: unknown, userId?: string): void;
   /** Receive messages from the frontend module (userId is the sender) */
   onFrontendMessage(handler: (payload: unknown, userId: string) => void): () => void;