@flatkit/types 0.14.4 → 0.15.0

package/dist/index.d.ts

@@ -324,6 +324,7 @@ type ResolveOpts = {
 };
 type Region = {
     id: string;
+    name?: string;
     color: string;
     path: Path;
     paint?: Paint;
@@ -445,6 +446,20 @@ type SymbolDef = {
     params?: ParamDef[];
     folderId?: string;
 };
+/**
+ * Text laid out ALONG a path (RFC: text-on-path). Present on a `Text` ⇒ glyphs follow `path`; the item's
+ * `transform`/`box`/`wrap` are ignored for layout. `ref` is authoring-only (the named shape the curve came
+ * from) and round-trips as `along "<ref>"`; `path` is the resolved/baked outline the runtime samples.
+ */
+type TextPath = {
+    ref?: string;
+    path: Path;
+    start?: number;
+    side?: 'over' | 'under';
+    spacing?: number;
+    startExpr?: string;
+    spacingExpr?: string;
+};
 /**
  * "live" (editable) text: a leaf item animatable like a container (transform/opacity/tint, pivot). LOCAL
  * origin = top-left corner; text flows toward (box.w, box.h). `box` = measured extent (updated by the
@@ -471,6 +486,7 @@ type Text = {
     wrap?: boolean;
     bind?: string;
     decimals?: number;
+    textPath?: TextPath;
     /** `id` explicitly set by the author via `text "…" as "<id>"` (≠ auto-generated id). Drives the
      *  printing of `as` in the flatFormat DSL. */
     idExplicit?: boolean;
@@ -556,4 +572,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, 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, TextPath, Timeline, TimelineTrack, Tint, Tool, Transform };

package/package.json

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