@flatkit/types 0.19.5 → 0.19.7

package/dist/index.d.ts

@@ -122,6 +122,20 @@ type Keyframe = {
 };
 /** Channels animatable by expression (= the decomposed components + opacity). */
 type ExprChannel = 'x' | 'y' | 'scaleX' | 'scaleY' | 'rotation' | 'opacity';
+/** A STATEFUL channel modifier: instead of a pure expression, the channel INTEGRATES over time toward
+ *  `target` (a normal expression). State lives per (instance, channel) in the player, advanced at a fixed
+ *  step, independent of `onEnterFrame`/input; on random access (seek/render) it snaps to `target` (the rest
+ *  pose). Pure & bounded — cannot diverge. See docs/design-channel-modifiers-spike.md. */
+type ChannelModifier = {
+    kind: 'smooth';
+    target: string;
+    k: number;
+} | {
+    kind: 'spring';
+    target: string;
+    stiffness: number;
+    damping: number;
+};
 type TimelineTrack = {
     id: string;
     targetId: string;
@@ -330,7 +344,10 @@ type ItemInteractionState = {
     pressed: number;
 };
 /** Resolution context (container expressions + guide layer). `itemState` lets channel expressions read the
- *  object's own interaction state (`self.hovered`…); the PLAYER provides it, absent elsewhere (flags → 0). */
+ *  object's own interaction state (`self.hovered`…); the PLAYER provides it, absent elsewhere (flags → 0).
+ *  `statePath` is the composed ancestor-instance path of the current scope (empty at the root) and
+ *  `channelValue` returns the PLAYER's integrated value for a stateful channel modifier (`smooth`/`spring`)
+ *  keyed by `statePath+itemId`; absent (random access: seek/render) → the channel snaps to its target. */
 type ResolveOpts = {
     fps?: number;
     ctx?: ExprContext;
@@ -338,6 +355,9 @@ type ResolveOpts = {
     orient?: boolean;
     parent?: Transform;
     itemState?: (id: string) => ItemInteractionState | undefined;
+    statePath?: string;
+    channelValue?: (key: string, ch: ExprChannel) => number | undefined;
+    onModifierTarget?: (key: string, ch: ExprChannel, mod: ChannelModifier, target: number) => void;
 };
 type Region = {
     id: string;
@@ -381,6 +401,7 @@ type Group = {
         h: number;
     };
     expressions?: Partial<Record<ExprChannel, string>>;
+    modifiers?: Partial<Record<ExprChannel, ChannelModifier>>;
     clip?: ClipRect;
 };
 /** Instance of a reusable symbol: a transform + a reference to the symbol. */
@@ -399,6 +420,7 @@ type Instance = {
     filters?: Filter[];
     blend?: BlendMode;
     expressions?: Partial<Record<ExprChannel, string>>;
+    modifiers?: Partial<Record<ExprChannel, ChannelModifier>>;
     params?: Record<string, string>;
     clip?: ClipRect;
 };
@@ -515,6 +537,7 @@ type Text = {
     filters?: Filter[];
     blend?: BlendMode;
     expressions?: Partial<Record<ExprChannel, string>>;
+    modifiers?: Partial<Record<ExprChannel, ChannelModifier>>;
 };
 /** Bitmap image: a leaf item animatable like text. References an asset; `w`/`h` = intrinsic size in px
  * (local coords, origin = top-left corner). */
@@ -534,6 +557,7 @@ type Image = {
     filters?: Filter[];
     blend?: BlendMode;
     expressions?: Partial<Record<ExprChannel, string>>;
+    modifiers?: Partial<Record<ExprChannel, ChannelModifier>>;
 };
 /** Layer content: material, one-off group, symbol instance, text, or image. */
 type Item = Region | Group | Instance | Text | Image;
@@ -589,4 +613,4 @@ type EditFrame = {
 };
 type Tool = 'brush' | 'rect' | 'ellipse' | 'eraser' | 'fill' | 'select' | 'transform' | 'text' | 'pan' | 'pen' | 'pathselect' | 'ink';
 
-export type { Action, Asset, BBox, BlendMode, Cel, ClipRect, ContentKey, ContentTrack, Doc, Easing, EditFrame, ExprChannel, ExprContext, Filter, Folder, FrameAction, FrameLabel, FuncDef, Group, Image, Instance, InstanceBind, InstancePlayback, Interaction, Interactor, Item, ItemEvent, ItemInteractionState, Keyframe, Layer, Paint, ParamDef, ParamType, Path, PlaybackMode, Point, PolyGroup, Polygon, Pose, Region, ResolveOpts, Ring, Seg, SendPayload, Shape, SoundClip, SpinDir, StateAnchor, StateMachine, Stop, Stroke, Subpath, SymbolDef, Text, TextPath, Timeline, TimelineTrack, Tint, Tool, Transform };
+export type { Action, Asset, BBox, BlendMode, Cel, ChannelModifier, ClipRect, ContentKey, ContentTrack, Doc, Easing, EditFrame, ExprChannel, ExprContext, Filter, Folder, FrameAction, FrameLabel, FuncDef, Group, Image, Instance, InstanceBind, InstancePlayback, Interaction, Interactor, Item, ItemEvent, ItemInteractionState, Keyframe, Layer, Paint, ParamDef, ParamType, Path, PlaybackMode, Point, PolyGroup, Polygon, Pose, Region, ResolveOpts, Ring, Seg, SendPayload, Shape, SoundClip, SpinDir, StateAnchor, StateMachine, Stop, Stroke, Subpath, SymbolDef, Text, TextPath, Timeline, TimelineTrack, Tint, Tool, Transform };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flatkit/types",
-  "version": "0.19.5",
+  "version": "0.19.7",
   "description": "Shared types for the FlatInk format (Doc, Layer, Item, …). The leaf of the dependency graph.",
   "license": "MIT",
   "author": "Zwyk Studio",