@laplace.live/persona-sdk 1.18.0 → 1.19.0

package/dist/values/hotkeys.d.ts

@@ -9,6 +9,17 @@ export declare function hasCommandModifier(accelerator: string | null): boolean;
 export declare function canRunInBackground(accelerator: string | null): boolean;
 /** True when a model hotkey is meant to fire while Persona sits in the background — what main registers on, and what the globe shows. */
 export declare function hotkeyRunsInBackground(h: Hotkey): boolean;
+/**
+ * Why a `hold` hotkey toggles instead of holding, or null when it can hold. A combo registered with
+ * the OS reaches Persona as a press alone — Electron reports no key-up for it — and one registration
+ * serves every hotkey on the combo: `'own'` when this hotkey asks for the background itself,
+ * `'shared'` when only another one on its combo does, which `registered` (main's list) alone can tell.
+ */
+export declare function holdBlockedBy(h: Pick<Hotkey, 'hold' | 'global' | 'accelerator'>, registered: boolean): 'own' | 'shared' | null;
+/** VTS's editor limits for a hotkey's fade and auto-off times, in seconds; healing clamps API input to them. */
+export declare const HOTKEY_FADE_SECONDS_MAX = 2;
+export declare const HOTKEY_DEACTIVATE_SECONDS_MIN = 0.1;
+export declare const HOTKEY_DEACTIVATE_SECONDS_MAX = 3600;
 /** Automations are enabled unless explicitly paused. */
 export declare function automationEnabled(s: {
     enabled?: boolean;
@@ -27,3 +38,25 @@ export declare function automationBindable<T extends {
 export declare function duplicateAccelerators(bindings: readonly {
     accelerator: string | null;
 }[]): Set<string>;
+/** The slice of a scene model item the ordering reads; a full `SceneModelItem` comes back as itself. */
+interface HotkeyModelLike {
+    kind: 'model';
+    instanceId: string;
+    ref: {
+        id: string;
+    };
+}
+/**
+ * The models whose hotkeys are live — every model in the scene, the primary first, one per model id
+ * (a model on two layers lists once). The desktop fires all of them, VTS-style, and every shortcut
+ * list shows them in this order; `hotkey.list`/`hotkey.trigger` take each one's `ref.id` as `modelId`.
+ * Generic over the item union so a scene document and the desktop's loaded runtimes both infer.
+ */
+export declare function hotkeyModels<T extends HotkeyModelLike | {
+    kind: 'object';
+    instanceId: string;
+}>(scene: {
+    items: readonly T[];
+    primaryInstanceId: string | null;
+}): Extract<T, HotkeyModelLike>[];
+export {};

package/dist/values/hotkeys.js

@@ -25,6 +25,23 @@ export function canRunInBackground(accelerator) {
 export function hotkeyRunsInBackground(h) {
     return h.global && h.active && h.action !== null && canRunInBackground(h.accelerator);
 }
+/**
+ * Why a `hold` hotkey toggles instead of holding, or null when it can hold. A combo registered with
+ * the OS reaches Persona as a press alone — Electron reports no key-up for it — and one registration
+ * serves every hotkey on the combo: `'own'` when this hotkey asks for the background itself,
+ * `'shared'` when only another one on its combo does, which `registered` (main's list) alone can tell.
+ */
+export function holdBlockedBy(h, registered) {
+    if (h.hold !== true)
+        return null;
+    if (h.global && hasCommandModifier(h.accelerator))
+        return 'own';
+    return registered ? 'shared' : null;
+}
+/** VTS's editor limits for a hotkey's fade and auto-off times, in seconds; healing clamps API input to them. */
+export const HOTKEY_FADE_SECONDS_MAX = 2;
+export const HOTKEY_DEACTIVATE_SECONDS_MIN = 0.1;
+export const HOTKEY_DEACTIVATE_SECONDS_MAX = 3600;
 /** Automations are enabled unless explicitly paused. */
 export function automationEnabled(s) {
     return s.enabled !== false;
@@ -49,3 +66,22 @@ export function duplicateAccelerators(bindings) {
     }
     return dupes;
 }
+/**
+ * The models whose hotkeys are live — every model in the scene, the primary first, one per model id
+ * (a model on two layers lists once). The desktop fires all of them, VTS-style, and every shortcut
+ * list shows them in this order; `hotkey.list`/`hotkey.trigger` take each one's `ref.id` as `modelId`.
+ * Generic over the item union so a scene document and the desktop's loaded runtimes both infer.
+ */
+export function hotkeyModels(scene) {
+    const models = scene.items.filter((i) => i.kind === 'model');
+    const primary = models.find(i => i.instanceId === scene.primaryInstanceId);
+    const out = [];
+    const seen = new Set();
+    for (const item of primary ? [primary, ...models] : models) {
+        if (seen.has(item.ref.id))
+            continue;
+        seen.add(item.ref.id);
+        out.push(item);
+    }
+    return out;
+}

package/dist/wire/events.d.ts

@@ -6,6 +6,10 @@ export interface EventMap {
     'settings.changed': {
         settings: Settings;
     };
+    /**
+     * One model's live hotkey set changed — every model on stage has one, and a model that just left the
+     * stage arrives empty. Older hosts sent `modelId: null` for an empty stage instead.
+     */
     'hotkey.state': {
         modelId: string | null;
         config: HotkeyState;

package/dist/wire/methods.d.ts

@@ -340,6 +340,8 @@ export interface HotkeySetRequest {
 export type HotkeySetResponse = HotkeyState;
 export interface HotkeyTriggerRequest {
     hotkeyId: string;
+    /** The model that owns the hotkey — every model on stage has a live set; defaults to the primary. */
+    modelId?: string;
 }
 export type HotkeyTriggerResponse = EmptyResponse;
 export type AutomationListRequest = EmptyRequest;

package/dist/wire/schemas/requests.d.ts

@@ -163,6 +163,7 @@ export declare const requestSchemas: {
     }, z.core.$strip>;
     'hotkey.trigger': z.ZodObject<{
         hotkeyId: z.ZodString;
+        modelId: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>;
     'automation.run': z.ZodObject<{
         automationId: z.ZodString;

package/dist/wire/schemas/requests.js

@@ -107,7 +107,7 @@ export const requestSchemas = {
         modelId: nonEmpty.optional(),
         config: z.custom(isRecord, 'config must be a hotkey config'),
     }),
-    'hotkey.trigger': z.object({ hotkeyId: nonEmpty }),
+    'hotkey.trigger': z.object({ hotkeyId: nonEmpty, modelId: nonEmpty.optional() }),
     'automation.run': z.object({ automationId: nonEmpty }),
     'tracking.addSource': z.object({
         // Straight off the kind registry, for the same reason as ASSET_KINDS below: a schema

package/dist/wire/types.d.ts

@@ -1011,7 +1011,7 @@ export interface Scene {
     name: string;
     /** Models and objects in one list; array order = z-order (bottom to top) within each space. */
     items: SceneItem[];
-    /** Hotkey target and the default instance for model-scoped methods. null only when `items` holds no model. */
+    /** The default hotkey target and the default instance for model-scoped methods. null only when `items` holds no model. */
     primaryInstanceId: string | null;
     background: SceneBackground;
     vrmCamera: SceneCamera;
@@ -1115,13 +1115,21 @@ export interface Hotkey {
     accelerator: string | null;
     global: boolean;
     active: boolean;
+    /** Expression: on only while the combo is held down (VTS `DeactivateAfterKeyUp`). Default false. */
+    hold?: boolean;
+    /** Fade time in seconds, in and out, of the expression or motion; null uses the file's own. 0–2. */
+    fadeSeconds?: number | null;
+    /** Expression: switches itself off after this many seconds. Motion: plays at most this long. null is off. 0.1–3600. */
+    deactivateAfterSeconds?: number | null;
+    /** Motion: holds its last frame until the hotkey fires again (VTS `StopsOnLastFrame`). Default false. */
+    stopsOnLastFrame?: boolean;
 }
 export interface HotkeyConfig {
     keyboardEnabled: boolean;
     hotkeys: Hotkey[];
 }
 export interface HotkeyState extends HotkeyConfig {
-    /** Hotkey ids currently registered with the OS (active model only). */
+    /** Hotkey ids currently registered with the OS (models on stage only). */
     registered: string[];
 }
 /** Action kinds an app automation can carry today; servers may send kinds newer than this list. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@laplace.live/persona-sdk",
-  "version": "1.18.0",
+  "version": "1.19.0",
   "description": "TypeScript SDK and wire schema for the LAPLACE Persona plugin API",
   "license": "MIT",
   "type": "module",