@laplace.live/persona-sdk 1.14.0 → 1.16.0

package/dist/values/limits.d.ts

@@ -1,4 +1,4 @@
-import type { AssetRef, Attach, EnvironmentLook, ModelFormat, MToonTuning, ObjectContent, ObjectSpace, SceneEnvironment, SceneLight, SceneLightCameraFollowOptions, SceneLightType, ScreenPlacement, VrmPlacement } from '../wire/types.ts';
+import type { AssetRef, Attach, AttachDepth, EnvironmentLook, ModelFormat, MToonTuning, ObjectContent, ObjectSpace, SceneEnvironment, SceneLight, SceneLightCameraFollowOptions, SceneLightType, ScreenPlacement, VrmPlacement } from '../wire/types.ts';
 export declare function clamp(v: number, min: number, max: number): number;
 /** Clamp to the unit interval. */
 export declare function clamp01(v: number): number;
@@ -178,6 +178,47 @@ export declare function contentAssetId(content: ObjectContent): string | null;
  * would z-fight by construction.
  */
 export declare function attachableParentFormat(space: ObjectSpace): ModelFormat;
+/**
+ * Every instance that rides `instanceId`, directly or through a chain of pins — the set it can
+ * never pin to itself, or the two would ride each other in a circle. Includes `instanceId`.
+ */
+export declare function pinRiders(items: readonly {
+    instanceId: string;
+    attach?: {
+        parentInstanceId: string;
+    } | null;
+}[], instanceId: string): Set<string>;
+/**
+ * Rows for the pin picker: every other Live2D model, each flagged when it already rides
+ * `instanceId` — picking one would put the two in a circle, so both apps offer it disabled
+ * rather than hidden. One rule, or the console offers a pin the desktop refuses.
+ */
+export declare function pinnableParents(models: readonly {
+    instanceId: string;
+    ref: {
+        kind: string;
+        name: string;
+    };
+}[], items: readonly {
+    instanceId: string;
+    attach?: {
+        parentInstanceId: string;
+    } | null;
+}[], instanceId: string): {
+    instanceId: string;
+    name: string;
+    ridesThis: boolean;
+}[];
+/**
+ * The depth control's stops, back to front: behind the model, above each of its ArtMeshes in
+ * paint order, then in front of it all. One continuous run, so depth is a slider over the host's
+ * stack rather than a list of ArtMesh ids nobody can read.
+ */
+export declare function depthStops(meshes: readonly string[]): AttachDepth[];
+/** Which stop a depth sits at; an ArtMesh the host no longer has reads as the frontmost. */
+export declare function depthStopIndex(meshes: readonly string[], depth: AttachDepth): number;
+/** A fresh pin onto `parentInstanceId`: root anchor, in front of the model, no response tuning. */
+export declare function defaultAttach(parentInstanceId: string): Attach;
 export declare const DEFAULT_HEAD_ANGLE: NonNullable<Attach['headAngle']>;
 export declare const ATTACH_MULTIPLIER_MIN = -2;
 export declare const ATTACH_MULTIPLIER_MAX = 2;

package/dist/values/limits.js

@@ -304,6 +304,71 @@ export function contentAssetId(content) {
 export function attachableParentFormat(space) {
     return space === '2d' ? 'live2d' : 'vrm';
 }
+/**
+ * Every instance that rides `instanceId`, directly or through a chain of pins — the set it can
+ * never pin to itself, or the two would ride each other in a circle. Includes `instanceId`.
+ */
+export function pinRiders(items, instanceId) {
+    const riders = new Set([instanceId]);
+    // One pass per item is enough for a chain of any depth: each pass adopts the next level down.
+    for (let i = 0; i < items.length; i++) {
+        let grew = false;
+        for (const item of items) {
+            const parent = item.attach?.parentInstanceId;
+            if (parent !== undefined && riders.has(parent) && !riders.has(item.instanceId)) {
+                riders.add(item.instanceId);
+                grew = true;
+            }
+        }
+        if (!grew)
+            break;
+    }
+    return riders;
+}
+/**
+ * Rows for the pin picker: every other Live2D model, each flagged when it already rides
+ * `instanceId` — picking one would put the two in a circle, so both apps offer it disabled
+ * rather than hidden. One rule, or the console offers a pin the desktop refuses.
+ */
+export function pinnableParents(models, items, instanceId) {
+    const riders = pinRiders(items, instanceId);
+    const out = [];
+    for (const m of models) {
+        if (m.ref.kind !== 'live2d' || m.instanceId === instanceId)
+            continue;
+        out.push({ instanceId: m.instanceId, name: m.ref.name, ridesThis: riders.has(m.instanceId) });
+    }
+    return out;
+}
+/**
+ * The depth control's stops, back to front: behind the model, above each of its ArtMeshes in
+ * paint order, then in front of it all. One continuous run, so depth is a slider over the host's
+ * stack rather than a list of ArtMesh ids nobody can read.
+ */
+export function depthStops(meshes) {
+    return [{ kind: 'behind' }, ...meshes.map((id) => ({ kind: 'artMesh', id })), { kind: 'front' }];
+}
+/** Which stop a depth sits at; an ArtMesh the host no longer has reads as the frontmost. */
+export function depthStopIndex(meshes, depth) {
+    if (depth.kind === 'behind')
+        return 0;
+    if (depth.kind === 'front')
+        return meshes.length + 1;
+    const at = meshes.indexOf(depth.id);
+    return at < 0 ? meshes.length + 1 : at + 1;
+}
+/** A fresh pin onto `parentInstanceId`: root anchor, in front of the model, no response tuning. */
+export function defaultAttach(parentInstanceId) {
+    return {
+        parentInstanceId,
+        anchor: { kind: 'root' },
+        followRotation: true,
+        depth: { kind: 'front' },
+        split: null,
+        headAngle: null,
+        elasticity: null,
+    };
+}
 export const DEFAULT_HEAD_ANGLE = {
     multiplier: 1,
     parallaxX: 0,

package/dist/wire/events.d.ts

@@ -31,10 +31,12 @@ export interface EventMap {
         active: string[];
         weights?: Record<string, number>;
     };
+    /** `oneShot`: the motion outranks the idle, so `motion.stop` would end it; hosts with `motion-stop` send it. */
     'motion.started': {
         instanceId: string;
         group: string;
         index: number;
+        oneShot?: boolean;
     };
     'motion.ended': {
         instanceId: string;

package/dist/wire/methods.d.ts

@@ -149,6 +149,16 @@ export interface InstanceSetPlacementRequest {
     vrm?: Partial<VrmPlacement>;
 }
 export type InstanceSetPlacementResponse = EmptyResponse;
+/**
+ * Pin a Live2D instance to another one as an item (VTS's Live2D Items): its placement becomes an
+ * offset from the anchor, and `attach.depth` says where it paints in the host's ArtMesh stack.
+ */
+export interface InstanceAttachRequest {
+    instanceId?: string;
+    /** Null detaches, leaving the instance where it stands. */
+    attach: AttachInput | null;
+}
+export type InstanceAttachResponse = EmptyResponse;
 export interface InstanceSetMToonRequest {
     instanceId?: string;
     tuning: Partial<MToonTuning>;
@@ -292,6 +302,16 @@ export interface MotionPlayingRequest {
 }
 export interface MotionPlayingResponse {
     playing: PlayingMotion | null;
+    /** `playing` outranks the idle — what `motion.stop` ends. Absent on hosts without `motion-stop`. */
+    oneShot?: boolean;
+}
+/** Fade the running motion out and let the idle resume; the idle itself is left alone. */
+export interface MotionStopRequest {
+    instanceId?: string;
+}
+export interface MotionStopResponse {
+    /** A motion above the idle was playing and is now fading out. */
+    stopped: boolean;
 }
 /** Play a clip with lip-sync. One utterance per model: a new play supersedes the current one. */
 export interface SpeechPlayRequest {
@@ -800,6 +820,10 @@ export interface MethodMap {
         request: InstanceSetPlacementRequest;
         response: InstanceSetPlacementResponse;
     };
+    'instance.attach': {
+        request: InstanceAttachRequest;
+        response: InstanceAttachResponse;
+    };
     'instance.setMToon': {
         request: InstanceSetMToonRequest;
         response: InstanceSetMToonResponse;
@@ -884,6 +908,11 @@ export interface MethodMap {
         request: MotionPlayingRequest;
         response: MotionPlayingResponse;
     };
+    /** Needs the `motion-stop` app capability. */
+    'motion.stop': {
+        request: MotionStopRequest;
+        response: MotionStopResponse;
+    };
     /**
      * Lip-synced audio on models advertising the `speech` capability. The response means
      * playback started (else `invalid-state`); `speech.started`/`speech.ended` bracket it.

package/dist/wire/types.d.ts

@@ -198,6 +198,12 @@ export interface SceneModelItem {
     breathDepth: number;
     /** MToon material fine-tuning, VRM only. */
     mtoon: MToonTuning;
+    /**
+     * Live2D only: this model rides another one as an item (VTS's Live2D Items) — its placement
+     * reads as an offset from the anchor, and `depth` says where it paints in the parent's stack.
+     * Null stands alone; a VRM instance ignores it, keeping it across a format switch.
+     */
+    attach: Attach | null;
 }
 export declare const OBJECT_SPACES: readonly ["2d", "3d"];
 export type ObjectSpace = (typeof OBJECT_SPACES)[number];
@@ -275,11 +281,41 @@ export interface AttachElasticity {
     damping: number;
     maxSpeed: number;
 }
+/**
+ * How deep a pinned item paints in its parent — VTube Studio's Between-Layer Item Pinning, as one
+ * value: the two ends clear the parent's whole stack, and `artMesh` slots the item in directly
+ * above that ArtMesh, so every parent mesh over it paints on top. Ids rather than positions,
+ * because Cubism re-sorts the stack as motions play, and an id carries to any rig that has it.
+ * Live2D parents on the three engine only: elsewhere an item always paints in front.
+ */
+export type AttachDepth = {
+    kind: 'front';
+} | {
+    kind: 'behind';
+} | {
+    kind: 'artMesh';
+    id: string;
+};
+/**
+ * VTube Studio's front/back splitting: the item is cut at one of its **own** ArtMeshes, and
+ * everything it paints below that goes to a second depth in the parent — so the parent's meshes
+ * in between wrap over it (a scarf in front of the chest and behind the hair). Live2D items only.
+ */
+export interface AttachSplit {
+    /** ArtMesh of the item it is cut at; the item paints everything under this as its back half. */
+    itemArtMesh: string;
+    /** How deep the back half paints — the same control as the item's own depth. */
+    depth: AttachDepth;
+}
 export interface Attach {
     /** Always a model instance in the same space; anything else is cleared on load. */
     parentInstanceId: string;
     anchor: AttachAnchor;
     followRotation: boolean;
+    /** Where it paints in the parent's ArtMesh stack; `front` is the plain "on top of the model". */
+    depth: AttachDepth;
+    /** Front/back splitting, independent of `depth`; null keeps the item in one piece. */
+    split: AttachSplit | null;
     headAngle: AttachHeadAngle | null;
     elasticity: AttachElasticity | null;
 }
@@ -1005,7 +1041,7 @@ export interface ScenePatch {
  * App-level features a client gates on (never version-sniff): `hello` and
  * `app.info` report them — the per-app mirror of {@link InstanceRuntime.capabilities}.
  */
-export declare const APP_CAPABILITIES: readonly ["storage", "speech", "automations", "controllers", "model-editing", "asset-inspection", "layer-effects", "scene-transitions", "area-lights", "spot-lights", "camera-follow-lights", "shadow-filters", "environment-map-model", "spawn", "tracking-lost"];
+export declare const APP_CAPABILITIES: readonly ["storage", "speech", "automations", "controllers", "model-editing", "asset-inspection", "layer-effects", "scene-transitions", "area-lights", "spot-lights", "camera-follow-lights", "shadow-filters", "environment-map-model", "spawn", "tracking-lost", "motion-stop"];
 export type AppCapability = (typeof APP_CAPABILITIES)[number];
 export declare function isAppCapability(v: unknown): v is AppCapability;
 /** What a loaded model instance can do; absent capabilities answer `unsupported-for-format`. */
@@ -1059,6 +1095,11 @@ export interface PlayingMotion {
 export interface AnchorOption {
     anchor: AttachAnchor;
     label: string;
+    /**
+     * Paint order when the list was taken, ascending from the backmost — what the depth control
+     * orders its stops by. Live2D only, and absent from hosts older than depth pinning.
+     */
+    order?: number;
 }
 export type { ModelInfo } from '../values/model-info.ts';
 export interface Hotkey {

package/dist/wire/types.js

@@ -49,6 +49,8 @@ export const APP_CAPABILITIES = [
     'spawn',
     /** `instance.setIdle` takes `trackingLostBehavior`, `trackingLostMotion` and `trackingLostDelay`. */
     'tracking-lost',
+    /** `motion.stop`; `motion.playing` and `motion.started` carry `oneShot`. */
+    'motion-stop',
 ];
 export function isAppCapability(v) {
     return isOneOf(v, APP_CAPABILITIES);

package/package.json

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