@yahoo/uds-create-config 5.34.3 → 5.35.0

package/dist/spec/cell.d.ts

@@ -27,6 +27,7 @@ declare class Cell {
   private memoDefaults;
   private memoConditional;
   private memoProps;
+  private memoContent;
   private memoEntry;
   private memoHolding;
   private memoOwn;
@@ -40,6 +41,16 @@ declare class Cell {
   get conditional(): Record<string, unknown>;
   /** The values in force: the defaults, what holds for the cell, then the coordinate itself. */
   get props(): Record<string, unknown>;
+  /** The preview content the cell shows: the `*` entry, then every entry that holds for it. What a
+   *  drop seeds and a placed instance compares its own content against; no declared or code
+   *  default is in it. */
+  get content(): Record<string, unknown>;
+  /**
+   * Whether this is the component's default on the canvas: the cell "Set as default" chose, where a
+   * drop lands. Every axis the coordinate names matches the default cell's, the coordinate names at
+   * least one, and no modifier is forced. {@link isDefaults} asks about the defaults in code.
+   */
+  isCanvasDefault(modifiers?: readonly string[]): boolean;
   /** The `preview` entry whose condition is exactly this coordinate, or `undefined`. */
   get entry(): IndexedPreviewCondition | undefined;
   /** The conditional `preview` entries that hold for this cell, in stored order. */
@@ -167,5 +178,25 @@ declare function cellAt({
   path: string;
   cell: SlotCell;
 }): Cell;
+/** The props and states whose values pick a cell of a component's grid: its variants, its booleans
+ *  and its states. */
+declare function cellAxes(config: Config, path: string): readonly string[];
+/**
+ * The coordinate of a component's default cell on the canvas: the preview's defaults, with each
+ * boolean prop and each state they leave unset at its rest value, the way the grid spells that cell
+ * (`busy: false`).
+ */
+declare function canvasDefaultCoordinate(config: Config, path: string): Readonly<SlotCell>;
+/** The cell a placed instance's props pick: the default cell's coordinate with the instance's own
+ *  axis values over it. With no props, the default cell itself. */
+declare function canvasCellAt({
+  config,
+  path,
+  props
+}: {
+  config: Config;
+  path: string;
+  props?: Readonly<Record<string, unknown>>;
+}): Cell;
 //#endregion
-export { Cell, CellSlot, GoverningCondition, cellAt };
+export { Cell, CellSlot, GoverningCondition, canvasCellAt, canvasDefaultCoordinate, cellAt, cellAxes };

package/dist/spec/cell.js

@@ -1,4 +1,7 @@
 import { canonicalCondition, refLeaf } from "../framework/utils/refs.js";
+import { createSliceMemo } from "../framework/memo.js";
+import { componentStates } from "../framework/component-states.js";
+import { unconditionalPreviewProps } from "../framework/preview-store.js";
 import { holdingPreviewConditions, previewConditionalProps, previewDefaults } from "../framework/projections.js";
 import { propApplies, surfaceProps } from "../framework/prop-surface.js";
 import { ruleApplies } from "../framework/layer-styles.js";
@@ -32,6 +35,7 @@ var Cell = class {
 	memoDefaults = UNSET;
 	memoConditional = UNSET;
 	memoProps = UNSET;
+	memoContent = UNSET;
 	memoEntry = UNSET;
 	memoHolding = UNSET;
 	memoOwn = UNSET;
@@ -62,6 +66,31 @@ var Cell = class {
 		};
 		return this.memoProps;
 	}
+	/** The preview content the cell shows: the `*` entry, then every entry that holds for it. What a
+	*  drop seeds and a placed instance compares its own content against; no declared or code
+	*  default is in it. */
+	get content() {
+		if (this.memoContent === UNSET) this.memoContent = {
+			...unconditionalPreviewProps(this.config.resolve("component", this.component)?.body) ?? {},
+			...this.conditional
+		};
+		return this.memoContent;
+	}
+	/**
+	* Whether this is the component's default on the canvas: the cell "Set as default" chose, where a
+	* drop lands. Every axis the coordinate names matches the default cell's, the coordinate names at
+	* least one, and no modifier is forced. {@link isDefaults} asks about the defaults in code.
+	*/
+	isCanvasDefault(modifiers = []) {
+		if (modifiers.length > 0) return false;
+		const entries = Object.entries(this.coordinate);
+		if (entries.length === 0) return false;
+		const defaults = canvasDefaultCoordinate(this.config, this.component);
+		return entries.every(([prop, value]) => {
+			const held = defaults[prop];
+			return held !== void 0 && String(held) === String(value);
+		});
+	}
 	/** The `preview` entry whose condition is exactly this coordinate, or `undefined`. */
 	get entry() {
 		if (this.memoEntry === UNSET) this.memoEntry = previewConditionAt({
@@ -357,5 +386,59 @@ function cellAt({ config, path, cell }) {
 	byKey.set(key, made);
 	return made;
 }
+/** The props and states whose values pick a cell of a component's grid: its variants, its booleans
+*  and its states. */
+function cellAxes(config, path) {
+	const cache = canvasCache(config);
+	const hit = cache.axes.get(path);
+	if (hit) return hit;
+	const axes = [];
+	const props = (config.resolve("component", path)?.body)?.props;
+	for (const [prop, decl] of Object.entries(props ?? {})) {
+		const type = decl?.type;
+		if (type === "variant" || type === "boolean") axes.push(prop);
+	}
+	for (const state of componentStates(config, path)) axes.push(state.name);
+	cache.axes.set(path, axes);
+	return axes;
+}
+/**
+* The coordinate of a component's default cell on the canvas: the preview's defaults, with each
+* boolean prop and each state they leave unset at its rest value, the way the grid spells that cell
+* (`busy: false`).
+*/
+function canvasDefaultCoordinate(config, path) {
+	const cache = canvasCache(config);
+	const hit = cache.coordinates.get(path);
+	if (hit) return hit;
+	const coordinate = {};
+	const props = (config.resolve("component", path)?.body)?.props;
+	for (const [prop, decl] of Object.entries(props ?? {})) if (decl?.type === "boolean") coordinate[prop] = false;
+	for (const state of componentStates(config, path)) coordinate[state.name] = state.type === "boolean" ? false : state.default;
+	const defaults = previewDefaults(config, path);
+	for (const axis of cellAxes(config, path)) if (defaults[axis] !== void 0) coordinate[axis] = defaults[axis];
+	const made = coordinate;
+	cache.coordinates.set(path, made);
+	return made;
+}
+/** The cell a placed instance's props pick: the default cell's coordinate with the instance's own
+*  axis values over it. With no props, the default cell itself. */
+function canvasCellAt({ config, path, props }) {
+	const coordinate = { ...canvasDefaultCoordinate(config, path) };
+	for (const axis of cellAxes(config, path)) if (props?.[axis] !== void 0) coordinate[axis] = props[axis];
+	return cellAt({
+		config,
+		path,
+		cell: coordinate
+	});
+}
+/** Per component slice, each component's cell axes and default coordinate asked for so far. */
+const canvasCache = createSliceMemo({
+	kinds: ["component"],
+	compute: (_config) => ({
+		axes: /* @__PURE__ */ new Map(),
+		coordinates: /* @__PURE__ */ new Map()
+	})
+});
 //#endregion
-export { cellAt };
+export { canvasCellAt, canvasDefaultCoordinate, cellAt, cellAxes };