@flatkit/types 0.35.3 → 0.36.0

package/dist/index.d.ts

@@ -362,11 +362,19 @@ type Cel = {
     shapeTween?: boolean;
     ease?: Easing;
 };
-/** Per-object interaction state exposed to channel expressions as `self.hovered`/`self.grabbed`/`self.pressed` (0/1). */
+/** Per-object interaction state exposed to channel expressions as `self.hovered`/`self.grabbed`/`self.pressed`/`self.focused` (0/1). */
 type ItemInteractionState = {
     hovered: number;
     grabbed: number;
     pressed: number;
+    focused?: number;
+};
+/** `focusable [order <n>] [noring]`: the object takes the KEYBOARD focus (Tab reaches it, Enter/Space click it).
+ *  `order` = its rank (lower first; unranked ones follow, in document order). `noRing` = the player does not
+ *  draw its default focus ring on it (the scene draws its own from `self.focused`). */
+type Focusable = {
+    order?: number;
+    noRing?: boolean;
 };
 /** 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).
@@ -390,6 +398,12 @@ type Region = {
     name?: string;
     color: string;
     path: Path;
+    poly?: {
+        xs: string;
+        ys: string;
+        count?: string;
+        closed?: boolean;
+    };
     paint?: Paint;
     fillParam?: string;
     stroke?: Stroke;
@@ -433,6 +447,7 @@ type Group = {
     expressions?: Partial<Record<BindChannel, string>>;
     modifiers?: Partial<Record<ExprChannel, ChannelModifier>>;
     clip?: ClipRect;
+    focusable?: Focusable;
 };
 /** Instance of a reusable symbol: a transform + a reference to the symbol. */
 type Instance = {
@@ -447,12 +462,17 @@ type Instance = {
     noHit?: boolean;
     pivot?: Point;
     playback?: InstancePlayback;
+    hitbox?: {
+        w: number;
+        h: number;
+    };
     filters?: Filter[];
     blend?: BlendMode;
     expressions?: Partial<Record<BindChannel, string>>;
     modifiers?: Partial<Record<ExprChannel, ChannelModifier>>;
     params?: Record<string, string>;
     clip?: ClipRect;
+    focusable?: Focusable;
 };
 /** A rectangular clip region in a container's LOCAL coordinates (`clip <x> <y> <w> <h>`). */
 type ClipRect = {
@@ -490,7 +510,7 @@ type StateMachine = {
     ease?: Easing;
 };
 /** Type of an exposed symbol param. `color` → a fill (`fill <name>`); `number`/`bool` → a scope variable. */
-type ParamType = 'color' | 'number' | 'bool';
+type ParamType = 'color' | 'number' | 'bool' | 'text';
 /**
  * One exposed param of a symbol — its public, named, defaulted, documented interface. A consumer sets it
  * at the instance call-site (`instance "Boat" { hull = #fff }`), in `--preview --set`, or (number/bool)
@@ -540,6 +560,7 @@ type Text = {
     name: string;
     transform: Transform;
     content: string;
+    contentParam?: string;
     font: string;
     size: number;
     align: 'left' | 'center' | 'right';
@@ -568,6 +589,7 @@ type Text = {
     blend?: BlendMode;
     expressions?: Partial<Record<BindChannel, string>>;
     modifiers?: Partial<Record<ExprChannel, ChannelModifier>>;
+    focusable?: Focusable;
 };
 /** Bitmap image: a leaf item animatable like text. References an asset; `w`/`h` = intrinsic size in px
  * (local coords, origin = top-left corner). */
@@ -588,6 +610,7 @@ type Image = {
     blend?: BlendMode;
     expressions?: Partial<Record<BindChannel, string>>;
     modifiers?: Partial<Record<ExprChannel, ChannelModifier>>;
+    focusable?: Focusable;
 };
 /** Layer content: material, one-off group, symbol instance, text, or image. */
 type Item = Region | Group | Instance | Text | Image;
@@ -643,4 +666,4 @@ type EditFrame = {
 };
 type Tool = 'brush' | 'rect' | 'ellipse' | 'eraser' | 'fill' | 'select' | 'transform' | 'text' | 'pan' | 'pen' | 'pathselect' | 'ink';
 
-export type { Action, Asset, BBox, BindChannel, 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, OffsetChannel, 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, BindChannel, BlendMode, Cel, ChannelModifier, ClipRect, ContentKey, ContentTrack, Doc, Easing, EditFrame, ExprChannel, ExprContext, Filter, Focusable, Folder, FrameAction, FrameLabel, FuncDef, Group, Image, Instance, InstanceBind, InstancePlayback, Interaction, Interactor, Item, ItemEvent, ItemInteractionState, Keyframe, Layer, OffsetChannel, 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.35.3",
+  "version": "0.36.0",
   "description": "Shared types for the FlatInk format (Doc, Layer, Item, …). The leaf of the dependency graph.",
   "license": "MIT",
   "author": "Zwyk Studio",