@laplace.live/persona-sdk 1.12.0 → 1.13.0

package/dist/index.d.ts

@@ -17,6 +17,7 @@ export * from './values/limits.ts';
 export * from './values/lipsync.ts';
 export * from './values/locale.ts';
 export * from './values/model-info.ts';
+export * from './values/mouse.ts';
 export * from './values/scene-transition.ts';
 export * from './values/stage-info.ts';
 export * from './values/terms.ts';

package/dist/index.js

@@ -19,6 +19,7 @@ export * from "./values/limits.js";
 export * from "./values/lipsync.js";
 export * from "./values/locale.js";
 export * from "./values/model-info.js";
+export * from "./values/mouse.js";
 export * from "./values/scene-transition.js";
 export * from "./values/stage-info.js";
 export * from "./values/terms.js";

package/dist/values/bindings.d.ts

@@ -1,3 +1,4 @@
+import type { BindingInput } from '../wire/types.ts';
 import type { Curve } from './curve.ts';
 import type { BindingTerm } from './terms.ts';
 /** A saved input-to-parameter rule shared by the rig editor and plugin API. */
@@ -21,6 +22,13 @@ export interface BindableParameter {
     max: number;
     default: number;
 }
+/** The editor's live readout, polled as one sample. */
+export interface BindingLiveValues {
+    /** What each tracking input reads right now; empty while nothing is measured. */
+    inputs: Partial<Record<BindingInput, number>>;
+    /** What each bound parameter reads on the model right now, by output id; empty for a host that cannot read it back. */
+    outputs: Record<string, number>;
+}
 /** Metadata read from a rig's display and physics sidecars. */
 export interface BindingEditorData {
     connections: Binding[];

package/dist/values/mouse.d.ts

@@ -0,0 +1,12 @@
+/**
+ * The OS cursor as a tracking input, in VTS's own names and span: −1..1 across the display the
+ * cursor is on, x growing rightward and y growing upward like `FacePositionY`.
+ */
+export declare const MOUSE_INPUT_RANGES: {
+    readonly MousePositionX: readonly [-1, 1];
+    readonly MousePositionY: readonly [-1, 1];
+};
+export declare const MOUSE_INPUT_NAMES: readonly MouseInputName[];
+export type MouseInputName = keyof typeof MOUSE_INPUT_RANGES;
+export type MouseInputs = Partial<Record<MouseInputName, number>>;
+export declare function isMouseInputName(v: string): v is MouseInputName;

package/dist/values/mouse.js

@@ -0,0 +1,14 @@
+import { keysOf } from "./guards.js";
+/**
+ * The OS cursor as a tracking input, in VTS's own names and span: −1..1 across the display the
+ * cursor is on, x growing rightward and y growing upward like `FacePositionY`.
+ */
+export const MOUSE_INPUT_RANGES = {
+    MousePositionX: [-1, 1],
+    MousePositionY: [-1, 1],
+};
+export const MOUSE_INPUT_NAMES = keysOf(MOUSE_INPUT_RANGES);
+const MOUSE_INPUT_SET = new Set(MOUSE_INPUT_NAMES);
+export function isMouseInputName(v) {
+    return MOUSE_INPUT_SET.has(v);
+}

package/dist/wire/methods.d.ts

@@ -1,4 +1,4 @@
-import type { Binding, BindingEditorData } from '../values/bindings.ts';
+import type { Binding, BindingEditorData, BindingLiveValues } from '../values/bindings.ts';
 import type { ControllerMovementConfig, ControllerState } from '../values/controller.ts';
 import type { SpawnTransition } from '../values/item-transition.ts';
 import type { LipSyncCalibrationCommand, LipSyncConfig, LipSyncMode, LipSyncState } from '../values/lipsync.ts';
@@ -581,9 +581,7 @@ export interface BindingSetResponse {
     saved: boolean;
 }
 export type BindingInputsRequest = BindingTarget;
-export interface BindingInputsResponse {
-    inputs: Partial<Record<BindingInput, number>>;
-}
+export type BindingInputsResponse = BindingLiveValues;
 export interface BindingOverrideRequest extends BindingTarget {
     input: BindingInput;
     value: number | null;

package/dist/wire/types.d.ts

@@ -7,6 +7,7 @@ import { type ArkitInputName } from '../values/arkit.ts';
 import { type BaseControllerInputName, type ControllerInputName, type ControllerMovementConfig } from '../values/controller.ts';
 import { type HandInputName } from '../values/hands.ts';
 import { type LipSyncMode, type VoiceInputName } from '../values/lipsync.ts';
+import { type MouseInputName } from '../values/mouse.ts';
 export type ModelFormat = 'live2d' | 'vrm';
 /** Where an item came from: shipped with the app, or added by the user. */
 export type ContentOrigin = 'bundled' | 'user';
@@ -1226,11 +1227,12 @@ declare const VTS_INPUT_RANGES: {
 };
 type VtsInputName = keyof typeof VTS_INPUT_RANGES;
 /**
- * Default input vocabulary: face and hand inputs, raw ARKit channels and controller profile 1.
- * Additional controller profile ids are accepted by isInputName without appearing in this list.
+ * Default input vocabulary: face, hand and cursor inputs, raw ARKit channels and controller
+ * profile 1. Additional controller profile ids are accepted by isInputName without appearing
+ * in this list.
  */
-export declare const INPUT_NAMES: readonly (VtsInputName | HandInputName | VoiceInputName | ArkitInputName | BaseControllerInputName)[];
-export type InputName = VtsInputName | HandInputName | VoiceInputName | ArkitInputName | ControllerInputName;
+export declare const INPUT_NAMES: readonly (VtsInputName | HandInputName | VoiceInputName | MouseInputName | ArkitInputName | BaseControllerInputName)[];
+export type InputName = VtsInputName | HandInputName | VoiceInputName | MouseInputName | ArkitInputName | ControllerInputName;
 /** Whether an untrusted string names a tracking input — the guard every wire boundary needs. */
 export declare function isInputName(v: string): v is InputName;
 /**
@@ -1258,7 +1260,7 @@ export declare function arkitTwinOf(input: InputName): BindingInput;
  * Default inputs' natural spans. Use getInputRange for a dynamically numbered controller input.
  * Head angles are degrees; the rest are unitless.
  */
-export declare const INPUT_RANGES: Record<VtsInputName | HandInputName | VoiceInputName | ArkitInputName | BaseControllerInputName, readonly [number, number]>;
+export declare const INPUT_RANGES: Record<VtsInputName | HandInputName | VoiceInputName | MouseInputName | ArkitInputName | BaseControllerInputName, readonly [number, number]>;
 /** Natural span of any valid input, including dynamically numbered controller profiles. */
 export declare function getInputRange(name: InputName): readonly [number, number];
 /**

package/dist/wire/types.js

@@ -6,6 +6,7 @@ import { BASE_CONTROLLER_INPUT_NAMES, BASE_CONTROLLER_INPUT_RANGES, controllerIn
 import { isOneOf, keysOf } from "../values/guards.js";
 import { HAND_INPUT_NAMES, HAND_INPUT_RANGES } from "../values/hands.js";
 import { VOICE_INPUT_NAMES, VOICE_INPUT_RANGES } from "../values/lipsync.js";
+import { MOUSE_INPUT_NAMES, MOUSE_INPUT_RANGES } from "../values/mouse.js";
 /**
  * How a registered file is labelled. Wider than an object's content kinds: `.hdr` is only
  * ever an environment map, and a `.vmd` splits by content — `cameraMotion` for one that
@@ -185,13 +186,15 @@ const VTS_INPUT_RANGES = {
 /** VTS's input vocabulary, plus `JawOpen` — the derived half of {@link INPUT_NAMES}. */
 const VTS_INPUT_NAMES = keysOf(VTS_INPUT_RANGES);
 /**
- * Default input vocabulary: face and hand inputs, raw ARKit channels and controller profile 1.
- * Additional controller profile ids are accepted by isInputName without appearing in this list.
+ * Default input vocabulary: face, hand and cursor inputs, raw ARKit channels and controller
+ * profile 1. Additional controller profile ids are accepted by isInputName without appearing
+ * in this list.
  */
 export const INPUT_NAMES = [
     ...VTS_INPUT_NAMES,
     ...VOICE_INPUT_NAMES,
     ...HAND_INPUT_NAMES,
+    ...MOUSE_INPUT_NAMES,
     ...ARKIT_INPUT_NAMES,
     ...BASE_CONTROLLER_INPUT_NAMES,
 ];
@@ -231,6 +234,7 @@ export const INPUT_RANGES = {
     ...VTS_INPUT_RANGES,
     ...VOICE_INPUT_RANGES,
     ...HAND_INPUT_RANGES,
+    ...MOUSE_INPUT_RANGES,
     ...BASE_CONTROLLER_INPUT_RANGES,
     // `fromEntries` widens the key type back to `string`; the annotation above is what keeps
     // this exhaustive, and it fails to typecheck if a name ever lacks a range.

package/package.json

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