@godot-scene-web/layout 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Tomás Fox
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,127 @@
+import { GodotNode, GodotRect, GodotResourceRefValue, GodotVariant } from "@godot-scene-web/core";
+import { GodotResourceStatus, GodotSceneNodeBase, GodotTextRunMetric, SceneGraph, SceneGraphNode } from "@godot-scene-web/scene-graph";
+
+//#region src/anchor-grammar.d.ts
+interface GodotNodeAnchor {
+  anchorTo: string;
+  from: string;
+  to: string;
+  offset?: {
+    x?: number;
+    y?: number;
+  };
+}
+type GodotAnchorMap = Record<string, GodotNodeAnchor>;
+type GodotAnchorVerticalEdge = "top" | "bottom" | "vcenter" | "contentTop" | "contentBottom";
+type GodotAnchorHorizontalEdge = "left" | "right" | "hcenter" | "contentLeft" | "contentRight";
+interface GodotAnchorEdge {
+  vertical: GodotAnchorVerticalEdge;
+  horizontal: GodotAnchorHorizontalEdge;
+}
+declare function parseAnchorEdge(token: string): GodotAnchorEdge | undefined;
+declare function anchorEdgePoint(token: string, own: GodotRect, content: GodotRect): {
+  x: number;
+  y: number;
+} | undefined;
+//#endregion
+//#region src/types.d.ts
+interface GodotSceneTreeNode extends GodotSceneNodeBase {
+  rect: GodotRect;
+  /**
+   * The on-screen global rect with the node's own `scale` applied around
+   * `pivotOffset` (mirroring the CSS `transform: scale()` the HTML renderer
+   * emits). `rect` stays pre-scale because child layout is computed in the
+   * parent's unscaled local space; consumers that need the rendered geometry
+   * (e.g. a layout-diff against the live game's `get_global_rect()`, which
+   * includes scale) should read `renderedRect`.
+   */
+  renderedRect: GodotRect;
+  /**
+   * The cumulative scale+rotation+translate transform this node applies to its
+   * descendants (its own scale-and-rotation-about-pivot composed with its
+   * ancestors'), in global unscaled-layout space. Internal to layout: children read
+   * it to bake every ancestor's transform into their own `renderedRect`. Stored as a
+   * 2×3 affine `{ a, b, c, d, tx, ty }` (a pure scale+translate is `b=c=0`).
+   */
+  cumulativeTransform?: {
+    a: number;
+    b: number;
+    c: number;
+    d: number;
+    tx: number;
+    ty: number;
+  };
+}
+interface GodotSceneTreeDiagnostic {
+  severity: "warning" | "error";
+  code: string;
+  message: string;
+  nodePath?: string;
+}
+interface GodotSceneTree {
+  viewport: GodotRect;
+  nodes: GodotSceneTreeNode[];
+  diagnostics: GodotSceneTreeDiagnostic[];
+  resourceStatuses: GodotResourceStatus[];
+}
+type GodotLayoutModel = GodotSceneTree;
+type GodotLayoutNode = GodotSceneTreeNode;
+type GodotLayoutDiagnostic = GodotSceneTreeDiagnostic;
+/**
+ * Options for the computed rect engine. The structural fields (node inclusion,
+ * prop/type/instance overrides, repeated-node expansion, external-scene mounting)
+ * are inherited from {@link SceneStructureOptions} — they are consumed upstream by
+ * `deriveSceneGraph`; the rect engine receives the already-indexed
+ * {@link import("@godot-scene-web/core").SceneGraph} and only adds the
+ * rect-/resource-specific fields below.
+ */
+interface GodotLayoutOptions {
+  viewport?: Partial<GodotRect>;
+  resolveResource?: (ref: GodotResourceRefValue, node: GodotNode) => unknown;
+  /**
+   * Content-driven minimum size for a text node (`Label`/`RichTextLabel`), in
+   * logical px — the text analogue of {@link resolveResource} for `TextureRect`.
+   * The host measures the label's paragraph box from the actual font it paints
+   * with (same font + size + glyph spacing), so a label with no explicit width
+   * grows to fit its text the way Godot's `Label::get_minimum_size()` does.
+   * Return `undefined` when no measurement is available (preserves the prior
+   * behavior of collapsing to the explicit/custom size or 0).
+   *
+   * `availableWidth` is the laid-out column width when known (the layout pass for
+   * a node already placed in its container); the host uses it to word-wrap a
+   * reflowing label so its height matches the wrapped paragraph. It is omitted
+   * during the bottom-up minimum pass (no width assigned yet) — a wrapping label
+   * should then report a width that does not force its container wider.
+   */
+  resolveTextContentSize?: (node: GodotNode, path: string, props: Record<string, GodotVariant>, availableWidth?: number) => {
+    width: number;
+    height: number;
+  } | undefined;
+  resolveTheme?: (node: GodotNode, name: string) => GodotVariant | undefined;
+  /**
+   * Declarative post-layout anchors, keyed by the anchored node's engine path.
+   * Resolved after flow layout converges so a node can be placed relative to
+   * another node's rendered (or content) edge. See {@link GodotAnchorMap}.
+   */
+  anchorsByPath?: GodotAnchorMap;
+}
+//#endregion
+//#region src/membership.d.ts
+/**
+ * The nodes the rect cascade ({@link resolveGodotSceneTree}) would lay out, without
+ * running it. The cascade drops exactly one class of node: an invisible child of a
+ * Box/Grid/Flow container — and its whole subtree — because a hidden control takes
+ * no space in those containers (`visibleChildren` in minimum-size.ts; every other
+ * container type and plain parents lay out all children). Consumers that only need
+ * per-node structural fields (`drawOrder`, `type`, `source`, `properties`) can use
+ * this instead of the cascade and skip all rect math; `membership.test.ts` pins the
+ * equivalence against the cascade.
+ */
+declare function flattenSceneGraphNodes(graph: SceneGraph): SceneGraphNode[];
+//#endregion
+//#region src/index.d.ts
+declare function isGodotSceneTree(value: unknown): value is GodotSceneTree;
+declare function resolveGodotSceneTree(graph: SceneGraph, options?: GodotLayoutOptions): GodotSceneTree;
+//#endregion
+export { type GodotAnchorEdge, type GodotAnchorHorizontalEdge, type GodotAnchorMap, type GodotAnchorVerticalEdge, type GodotLayoutDiagnostic, type GodotLayoutModel, type GodotLayoutNode, type GodotLayoutOptions, type GodotNodeAnchor, type GodotRect, type GodotSceneTree, type GodotSceneTreeDiagnostic, type GodotSceneTreeNode, type GodotTextRunMetric, anchorEdgePoint, flattenSceneGraphNodes, isGodotSceneTree, parseAnchorEdge, resolveGodotSceneTree };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/anchor-grammar.ts","../src/types.ts","../src/membership.ts","../src/index.ts"],"mappings":";;;;UACiB,eAAA;EACf,QAAA;EACA,IAAA;EACA,EAAA;EACA,MAAA;IAAW,CAAA;IAAY,CAAA;EAAA;AAAA;AAAA,KAEb,cAAA,GAAiB,MAAM,SAAS,eAAA;AAAA,KAChC,uBAAA;AAAA,KAMA,yBAAA;AAAA,UAMK,eAAA;EACf,QAAA,EAAU,uBAAA;EACV,UAAA,EAAY,yBAAyB;AAAA;AAAA,iBAgBvB,eAAA,CAAgB,KAAA,WAAgB,eAAe;AAAA,iBAW/C,eAAA,CACd,KAAA,UACA,GAAA,EAAK,SAAA,EACL,OAAA,EAAS,SAAS;EACf,CAAA;EAAW,CAAA;AAAA;;;UCtCC,kBAAA,SAA2B,kBAAA;EAC1C,IAAA,EAAM,SAAA;EDdN;;;;;;;AAGwB;ECoBxB,YAAA,EAAc,SAAA;EDlBU;;;AAAiC;AAC3D;;;ECyBE,mBAAA;IACE,CAAA;IACA,CAAA;IACA,CAAA;IACA,CAAA;IACA,EAAA;IACA,EAAA;EAAA;AAAA;AAAA,UAGa,wBAAA;EACf,QAAA;EACA,IAAA;EACA,OAAA;EACA,QAAA;AAAA;AAAA,UAEe,cAAA;EACf,QAAA,EAAU,SAAA;EACV,KAAA,EAAO,kBAAA;EACP,WAAA,EAAa,wBAAA;EACb,gBAAA,EAAkB,mBAAA;AAAA;AAAA,KAER,gBAAA,GAAmB,cAAc;AAAA,KACjC,eAAA,GAAkB,kBAAkB;AAAA,KACpC,qBAAA,GAAwB,wBAAwB;;;;;;;;;UAU3C,kBAAA;EACf,QAAA,GAAW,OAAA,CAAQ,SAAA;EACnB,eAAA,IAAmB,GAAA,EAAK,qBAAA,EAAuB,IAAA,EAAM,SAAA;;;;AArDvD;;;;;;;;;;;;EAqEE,sBAAA,IACE,IAAA,EAAM,SAAA,EACN,IAAA,UACA,KAAA,EAAO,MAAA,SAAe,YAAA,GACtB,cAAA;IACK,KAAA;IAAe,MAAA;EAAA;EACtB,YAAA,IAAgB,IAAA,EAAM,SAAA,EAAW,IAAA,aAAiB,YAAA;EArDhD;;;;AAEE;EAyDJ,aAAA,GAAgB,cAAA;AAAA;;;;;;AD/FlB;;;;;;;iBEYgB,sBAAA,CAAuB,KAAA,EAAO,UAAA,GAAa,cAAc;;;iBC2BzD,gBAAA,CACd,KAAA,YACC,KAAA,IAF6B,cAEY;AAAA,iBAyF5B,qBAAA,CACd,KAAA,EAAO,UAAA,EACP,OAAA,GAAS,kBAAA,GACR,cAAA"}