@flatkit/types 0.6.0 → 0.8.0

package/dist/index.d.ts

@@ -203,6 +203,11 @@ type Action = {
     name: string;
     index: string;
     value: string;
+} | {
+    do: 'setParam';
+    target: string;
+    param: string;
+    value: string;
 } | {
     do: 'if';
     cond: string;
@@ -322,7 +327,9 @@ type Region = {
     color: string;
     path: Path;
     paint?: Paint;
+    fillParam?: string;
     stroke?: Stroke;
+    strokeParam?: string;
     noFill?: boolean;
     xform?: Transform;
     opacity?: number;
@@ -356,6 +363,7 @@ type Group = {
         h: number;
     };
     expressions?: Partial<Record<ExprChannel, string>>;
+    clip?: ClipRect;
 };
 /** Instance of a reusable symbol: a transform + a reference to the symbol. */
 type Instance = {
@@ -373,6 +381,15 @@ type Instance = {
     filters?: Filter[];
     blend?: BlendMode;
     expressions?: Partial<Record<ExprChannel, string>>;
+    params?: Record<string, string>;
+    clip?: ClipRect;
+};
+/** A rectangular clip region in a container's LOCAL coordinates (`clip <x> <y> <w> <h>`). */
+type ClipRect = {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
 };
 /**
  * Library folder (pure organization, Flash style): a tree by `parent`. SYMBOLS stay FLAT (referenced by
@@ -384,12 +401,48 @@ type Folder = {
     parent?: string;
     collapsed?: boolean;
 };
+/** One named state of a symbol: a label on the symbol's timeline (e.g. `closed at 0`, `open at 24`). */
+type StateAnchor = {
+    name: string;
+    frame: number;
+};
+/**
+ * A symbol's exposed STATE MACHINE: the param `param` selects a named state, which drives the symbol's
+ * local playhead to that state's frame. A fractional/animated value between states plays the authored
+ * in-between animation (the timeline frames between the two anchors). `transition`/`ease` describe the
+ * default move between states (used by the live runtime; metadata for selection).
+ */
+type StateMachine = {
+    param: string;
+    states: StateAnchor[];
+    initial?: string;
+    transition?: number;
+    ease?: Easing;
+};
+/** Type of an exposed symbol param. `color` → a fill (`fill <name>`); `number`/`bool` → a scope variable. */
+type ParamType = 'color' | 'number' | 'bool';
+/**
+ * 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)
+ * at runtime (`Boat.wave = 1.5`). `color` params feed `fill <name>`; `number`/`bool` become variables in
+ * the symbol's expressions.
+ */
+type ParamDef = {
+    name: string;
+    type: ParamType;
+    default: string;
+    min?: number;
+    max?: number;
+    doc?: string;
+};
 /** Reusable definition (Flash MovieClip-style symbol) stored in the library. */
 type SymbolDef = {
     id: string;
     name: string;
     layers: Layer[];
     timeline?: Timeline;
+    states?: StateMachine[];
+    params?: ParamDef[];
     folderId?: string;
 };
 /**
@@ -503,4 +556,4 @@ type EditFrame = {
 };
 type Tool = 'brush' | 'rect' | 'ellipse' | 'eraser' | 'fill' | 'select' | 'transform' | 'text' | 'pan' | 'pen' | 'pathselect' | 'ink';
 
-export type { Action, Asset, BBox, BlendMode, Cel, 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, Path, PlaybackMode, Point, PolyGroup, Polygon, Pose, Region, ResolveOpts, Ring, Seg, SendPayload, Shape, SoundClip, SpinDir, Stop, Stroke, Subpath, SymbolDef, Text, Timeline, TimelineTrack, Tint, Tool, Transform };
+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, Timeline, TimelineTrack, Tint, Tool, Transform };

package/package.json

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