@laplace.live/persona-sdk 1.4.0 → 1.5.0

package/dist/wire/types.js

@@ -3,6 +3,7 @@
 // filesystem-shaped — model refs are sanitized to ids, never directories.
 import { ARKIT_INPUT_NAMES } from "../values/arkit.js";
 import { BASE_CONTROLLER_INPUT_NAMES, BASE_CONTROLLER_INPUT_RANGES, controllerInputRange, isControllerInputName, } from "../values/controller.js";
+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";
 /**
@@ -13,8 +14,10 @@ import { VOICE_INPUT_NAMES, VOICE_INPUT_RANGES, } from "../values/lipsync.js";
 export const ASSET_KINDS = ['image', 'video', 'prop', 'ibl', 'lut', 'animation', 'cameraMotion'];
 /** Narrow a kind string to the set the asset registry owns — models and effects have their own. */
 export function isAssetKind(v) {
-    return typeof v === 'string' && ASSET_KINDS.includes(v);
+    return isOneOf(v, ASSET_KINDS);
 }
+// ---- Objects -------------------------------------------------------------------
+export const OBJECT_SPACES = ['2d', '3d'];
 /**
  * Per-light shadow tier. `off` is the old `castShadow: false`; the rest raise
  * shadow-map resolution. A point light pays 6 cube faces for the same tier a
@@ -29,42 +32,46 @@ export const SHADOW_QUALITY_LEVELS = ['off', 'low', 'medium', 'high', 'ultra'];
 export const APP_CAPABILITIES = [
     'storage',
     'speech',
-    'shortcuts',
+    'automations',
     'controllers',
     'model-editing',
     'asset-inspection',
     'layer-effects',
+    'scene-transitions',
 ];
 export function isAppCapability(v) {
-    return typeof v === 'string' && APP_CAPABILITIES.includes(v);
+    return isOneOf(v, APP_CAPABILITIES);
 }
-// ---- App shortcuts --------------------------------------------------------------
-/** Action kinds an app shortcut can carry today; servers may send kinds newer than this list. */
-export const SHORTCUT_ACTION_KINDS = [
+// ---- App automations --------------------------------------------------------------
+/** Action kinds an app automation can carry today; servers may send kinds newer than this list. */
+export const AUTOMATION_ACTION_KINDS = [
     'effect-toggle',
     'effect-params',
     'camera-pose',
     'reset-camera',
     'layer-visibility',
     'stream-mode',
+    'delay',
 ];
 // ---- Settings ------------------------------------------------------------------
+export const LIVE2D_ENGINES = ['pixi', 'three'];
 export const TRACKING_SOURCE_IDS = ['persona-ios', 'ifacialmocap', 'vts-ios'];
 /** Body-pose protocols. Every one so far is UDP with a configurable port. */
 export const POSE_SOURCE_IDS = ['vmc', 'mocopi'];
 /** Every protocol a tracking source instance can speak; face and body kinds. */
 export const TRACKING_SOURCE_KINDS = [...TRACKING_SOURCE_IDS, ...POSE_SOURCE_IDS, 'mediapipe'];
-export const TRACKING_CHANNELS = ['face', 'pose', 'hands'];
 /** The scene-item binding each channel reads and writes. */
 export const TRACKING_CHANNEL_FIELDS = {
     face: 'faceSourceId',
     pose: 'poseSourceId',
     hands: 'handSourceId',
 };
+export const TRACKING_CHANNELS = keysOf(TRACKING_CHANNEL_FIELDS);
 export const HAND_TRACKING_MODES = ['arms', 'fingers'];
 export function isHandTrackingMode(v) {
-    return HAND_TRACKING_MODES.includes(v);
+    return isOneOf(v, HAND_TRACKING_MODES);
 }
+export const MEDIAPIPE_DELEGATES = ['CPU', 'GPU'];
 export const DEFAULT_MEDIAPIPE_CONFIG = {
     deviceId: '',
     mirror: true,
@@ -75,11 +82,11 @@ export const DEFAULT_MEDIAPIPE_CONFIG = {
 };
 /** Whether a source kind uses a network face receiver. */
 export function isFaceSourceKind(kind) {
-    return TRACKING_SOURCE_IDS.includes(kind);
+    return isOneOf(kind, TRACKING_SOURCE_IDS);
 }
 /** Whether a source uses a network body receiver. */
 export function isPoseSource(source) {
-    return POSE_SOURCE_IDS.includes(source.kind);
+    return isOneOf(source.kind, POSE_SOURCE_IDS);
 }
 const FACE_ONLY = ['face'];
 const POSE_ONLY = ['pose'];
@@ -119,30 +126,41 @@ export const EFFECTS_QUALITY_LEVELS = ['low', 'medium', 'high'];
  */
 export const FPS_LIMIT_PRESETS = [0, 15, 30, 60, 90];
 // ---- Injection -----------------------------------------------------------------
+/**
+ * From VTS's own registry (`FaceTrackingParamInfo.paramNameDictionary`), which is both the
+ * range its editor seeds a new parameter with and what every `.vtube.json` was authored
+ * against. Two families differ deliberately:
+ *
+ * - **the brow inputs** are signed here. VTS lists them `0..1`; we derive them as
+ *   `brow-up − brow-down`, so a frown needs the lower half.
+ * - **`JawOpen`** is absent from VTS's registry — it exists there only as a plugin-created
+ *   parameter, which VTS then special-cases — so its span is the ARKit channel's.
+ */
+const VTS_INPUT_RANGES = {
+    FaceAngleX: [-30, 30],
+    FaceAngleY: [-30, 30],
+    FaceAngleZ: [-90, 90],
+    FacePositionX: [-15, 15],
+    FacePositionY: [-15, 15],
+    FacePositionZ: [-10, 10],
+    EyeOpenLeft: [0, 1],
+    EyeOpenRight: [0, 1],
+    EyeLeftX: [-1, 1],
+    EyeLeftY: [-1, 1],
+    EyeRightX: [-1, 1],
+    EyeRightY: [-1, 1],
+    Brows: [-1, 1],
+    BrowLeftY: [-1, 1],
+    BrowRightY: [-1, 1],
+    MouthSmile: [0, 1],
+    MouthOpen: [0, 1],
+    MouthX: [-1, 1],
+    CheekPuff: [0, 1],
+    JawOpen: [0, 1],
+    TongueOut: [0, 1],
+};
 /** VTS's input vocabulary, plus `JawOpen` — the derived half of {@link INPUT_NAMES}. */
-const VTS_INPUT_NAMES = [
-    'FaceAngleX',
-    'FaceAngleY',
-    'FaceAngleZ',
-    'FacePositionX',
-    'FacePositionY',
-    'FacePositionZ',
-    'EyeOpenLeft',
-    'EyeOpenRight',
-    'EyeLeftX',
-    'EyeLeftY',
-    'EyeRightX',
-    'EyeRightY',
-    'Brows',
-    'BrowLeftY',
-    'BrowRightY',
-    'MouthSmile',
-    'MouthOpen',
-    'MouthX',
-    'CheekPuff',
-    'JawOpen',
-    'TongueOut',
-];
+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.
@@ -180,39 +198,6 @@ export const BINDING_INPUT_NAMES = INPUT_NAMES.filter(n => !isArkitTwinAlias(n))
 export function arkitTwinOf(input) {
     return isArkitTwinAlias(input) ? ARKIT_TWINS[input] : input;
 }
-/**
- * From VTS's own registry (`FaceTrackingParamInfo.paramNameDictionary`), which is both the
- * range its editor seeds a new parameter with and what every `.vtube.json` was authored
- * against. Two families differ deliberately:
- *
- * - **the brow inputs** are signed here. VTS lists them `0..1`; we derive them as
- *   `brow-up − brow-down`, so a frown needs the lower half.
- * - **`JawOpen`** is absent from VTS's registry — it exists there only as a plugin-created
- *   parameter, which VTS then special-cases — so its span is the ARKit channel's.
- */
-const VTS_INPUT_RANGES = {
-    FaceAngleX: [-30, 30],
-    FaceAngleY: [-30, 30],
-    FaceAngleZ: [-90, 90],
-    FacePositionX: [-15, 15],
-    FacePositionY: [-15, 15],
-    FacePositionZ: [-10, 10],
-    EyeOpenLeft: [0, 1],
-    EyeOpenRight: [0, 1],
-    EyeLeftX: [-1, 1],
-    EyeLeftY: [-1, 1],
-    EyeRightX: [-1, 1],
-    EyeRightY: [-1, 1],
-    Brows: [-1, 1],
-    BrowLeftY: [-1, 1],
-    BrowRightY: [-1, 1],
-    MouthSmile: [0, 1],
-    MouthOpen: [0, 1],
-    MouthX: [-1, 1],
-    CheekPuff: [0, 1],
-    JawOpen: [0, 1],
-    TongueOut: [0, 1],
-};
 /** ARKit blendshapes are unit-scale by definition, so every raw channel shares one span. */
 const ARKIT_RANGE = [0, 1];
 /**
@@ -232,3 +217,12 @@ export const INPUT_RANGES = {
 export function getInputRange(name) {
     return isControllerInputName(name) ? controllerInputRange(name) : INPUT_RANGES[name];
 }
+/**
+ * What an injected value drives:
+ * - `input` — a VTS-vocabulary tracking input (`MouthOpen`, `FaceAngleX`, …), mapped
+ *   through the model's own tracking rules. Live2D only.
+ * - `live2d-param` — a Cubism parameter id, written directly.
+ * - `vrm-expression` — reserved, not implemented yet; the server answers
+ *   `unsupported-for-format`.
+ */
+export const INJECT_TARGET_TYPES = ['input', 'live2d-param', 'vrm-expression'];

package/package.json

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