@needle-tools/addressing 0.3.2 → 0.3.3

package/dist/resolve.js

@@ -2,28 +2,53 @@ import { parseAnchorValue } from "./anchor.js";
 import { collectionKeyForType } from "./address.js";
 import { NEEDLE_ID_KEY, STAMPED_COLLECTIONS } from "./gltf.js";
 /**
- * Resolve an address inside glTF JSON. Tries id → anchor → namePath (nodes), in that
- * order; returns null when nothing matches exactly (reconciliation is a separate,
- * explicit step — resolution never guesses).
+ * Resolve an address inside glTF JSON. Same ladder as the live graph —
+ * **anchor → id → namePath** (nodes) — with the anchor winning only when it matches
+ * exactly one element. Returns null when nothing matches exactly (reconciliation is a
+ * separate, explicit step — resolution never guesses).
  */
-export function resolveInGltf(address, json) {
+export function resolveInGltf(address, json, options) {
+    const report = options?.report;
     const searched = address.type
         ? [[address.type, collectionKeyForType(address.type)]]
         : [...STAMPED_COLLECTIONS];
+    let byAnchor = null;
+    if (address.anchor) {
+        const matches = [];
+        for (const [type, key] of searched) {
+            for (const found of collectInJsonCollection(json, key, el => parseAnchorValue(el.name) === address.anchor)) {
+                matches.push({ type, index: found.index, element: found.element });
+                if (matches.length > 1 && !report)
+                    break;
+            }
+            if (matches.length > 1 && !report)
+                break;
+        }
+        if (matches.length === 1)
+            byAnchor = matches[0];
+        else if (matches.length > 1)
+            report?.({ kind: "ambiguous-anchor", anchor: address.anchor, count: matches.length });
+    }
+    if (byAnchor && !report)
+        return byAnchor;
+    let byId = null;
     if (address.id) {
         for (const [type, key] of searched) {
             const found = findInCollection(json, key, el => el.extras?.[NEEDLE_ID_KEY] === address.id);
-            if (found)
-                return { type, index: found.index, element: found.element };
+            if (found) {
+                byId = { type, index: found.index, element: found.element };
+                break;
+            }
         }
     }
-    if (address.anchor) {
-        for (const [type, key] of searched) {
-            const found = findInCollection(json, key, el => parseAnchorValue(el.name) === address.anchor);
-            if (found)
-                return { type, index: found.index, element: found.element };
+    if (byAnchor) {
+        if (byId && (byId.type !== byAnchor.type || byId.index !== byAnchor.index)) {
+            report?.({ kind: "conflict", preferred: "anchor", other: "id" });
         }
+        return byAnchor;
     }
+    if (byId)
+        return byId;
     if (address.namePath?.length && (!address.type || address.type === "node")) {
         const index = walkGltfNamePath(json, address.namePath);
         if (index !== null) {
@@ -35,19 +60,37 @@ export function resolveInGltf(address, json) {
 }
 /**
  * Resolve an address inside a live scene graph (duck-typed — any three.js).
- * Same order as glTF resolution: id → anchor → namePath.
+ *
+ * Ladder: **anchor → id → namePath**. The anchor comes first because it is a deliberate,
+ * human-authored declaration, while an id may be a derived value whose basis shifted when
+ * the content changed. It only wins when it resolves UNIQUELY: anchors are labels and may
+ * legally repeat, and an ambiguous label must never outrank an exact key.
  */
-export function resolveInGraph(address, root) {
-    if (address.id) {
-        const byId = findInGraph(root, n => n.userData?.[NEEDLE_ID_KEY] === address.id);
-        if (byId)
-            return byId;
-    }
+export function resolveInGraph(address, root, options) {
+    const report = options?.report;
+    let byAnchor = null;
     if (address.anchor) {
-        const byAnchor = findInGraph(root, n => parseAnchorValue(n.name) === address.anchor);
-        if (byAnchor)
-            return byAnchor;
+        // without a reporter, stop at two — "exactly one" vs "more than one" is all the
+        // ladder needs, and the count only matters for the message
+        const matches = collectInGraph(root, n => parseAnchorValue(n.name) === address.anchor, report ? Infinity : 2);
+        if (matches.length === 1)
+            byAnchor = matches[0];
+        else if (matches.length > 1)
+            report?.({ kind: "ambiguous-anchor", anchor: address.anchor, count: matches.length });
     }
+    // fast path: nothing left to learn unless the caller wants the disagreement reported
+    if (byAnchor && !report)
+        return byAnchor;
+    let byId = null;
+    if (address.id)
+        byId = findInGraph(root, n => n.userData?.[NEEDLE_ID_KEY] === address.id);
+    if (byAnchor) {
+        if (byId && byId !== byAnchor)
+            report?.({ kind: "conflict", preferred: "anchor", other: "id" });
+        return byAnchor;
+    }
+    if (byId)
+        return byId;
     if (address.namePath?.length) {
         let current = root;
         for (const segment of address.namePath) {
@@ -60,6 +103,45 @@ export function resolveInGraph(address, root) {
     }
     return null;
 }
+/**
+ * Resolve an address against a FLAT collection of live elements — materials, textures and
+ * anything else that carries a name and `userData` but is not part of the scene graph.
+ *
+ * Same ladder as the graph, minus `namePath` (there is no hierarchy to walk) plus `name`
+ * as the final rung, since a flat collection has no positional fallback. This exists so
+ * every element type resolves through ONE implementation: materials previously had their
+ * own ladders, could not be anchored at all, and disagreed with each other about whether a
+ * name match had to be unique.
+ */
+export function resolveInCollection(address, elements, options) {
+    const report = options?.report;
+    let byAnchor = null;
+    if (address.anchor) {
+        const matches = elements.filter(e => parseAnchorValue(e.name) === address.anchor);
+        if (matches.length === 1)
+            byAnchor = matches[0];
+        else if (matches.length > 1)
+            report?.({ kind: "ambiguous-anchor", anchor: address.anchor, count: matches.length });
+    }
+    if (byAnchor && !report)
+        return byAnchor;
+    const byId = address.id ? elements.find(e => e.userData?.[NEEDLE_ID_KEY] === address.id) ?? null : null;
+    if (byAnchor) {
+        if (byId && byId !== byAnchor)
+            report?.({ kind: "conflict", preferred: "anchor", other: "id" });
+        return byAnchor;
+    }
+    if (byId)
+        return byId;
+    if (address.name) {
+        const named = elements.filter(e => e.name === address.name);
+        if (named.length === 1)
+            return named[0];
+        if (named.length > 1)
+            report?.({ kind: "ambiguous-name", name: address.name, count: named.length });
+    }
+    return null;
+}
 /**
  * When exact resolution fails (the asset changed), propose candidates instead of
  * guessing: nodes matching the address's name, ranked by how much of the recorded
@@ -89,6 +171,20 @@ export function reconcileInGraph(address, root) {
     }
     return candidates.sort((a, b) => b.confidence - a.confidence);
 }
+/** every element of one glTF collection matching `predicate` */
+function collectInJsonCollection(json, key, predicate) {
+    const collection = json[key];
+    if (!Array.isArray(collection))
+        return [];
+    const found = [];
+    for (let i = 0; i < collection.length; i++) {
+        const element = collection[i];
+        if (element != null && typeof element === "object" && predicate(element)) {
+            found.push({ index: i, element });
+        }
+    }
+    return found;
+}
 function findInCollection(json, key, predicate) {
     const collection = json[key];
     if (!Array.isArray(collection))
@@ -118,6 +214,30 @@ function walkGltfNamePath(json, namePath) {
     }
     return match;
 }
+/** every node matching `predicate`, stopping once `limit` are found (cycle-safe) */
+function collectInGraph(root, predicate, limit) {
+    const found = [];
+    const visited = new Set();
+    const walk = (node) => {
+        if (found.length >= limit || visited.has(node))
+            return;
+        visited.add(node);
+        if (predicate(node)) {
+            found.push(node);
+            if (found.length >= limit)
+                return;
+        }
+        if (!node.children)
+            return;
+        for (let i = 0; i < node.children.length; i++) {
+            const child = node.children[i];
+            if (child != null)
+                walk(child);
+        }
+    };
+    walk(root);
+    return found;
+}
 function findInGraph(root, predicate, visited = new Set()) {
     if (visited.has(root))
         return null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@needle-tools/addressing",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "Persistent addressing for Needle assets: deterministic needle-id computation, #needle anchors, and address resolution over glTF JSON and live scene graphs.",
   "type": "module",
   "main": "./src/index.ts",

package/src/address.ts

@@ -1,106 +1,111 @@
-import { parseAnchorValue } from "./anchor.js";
-import { getElementId, NEEDLE_ID_KEY, type GltfJson, type StampedElementType } from "./gltf.js";
-
-/**
- * A persistent pointer to an element inside an asset — the "fat address": every
- * fallback the resolver may need is captured at CREATION time, while the target is
- * known, instead of being reconstructed later.
- *
- * Resolution order: `id` (exact) → `anchor` (survives asset updates) → `namePath`
- * (best-effort) → reconciliation (candidates + confidence, never a silent guess).
- */
-export type NeedleAddress = {
-    /** the element's needle-id (deterministic for file-backed content, random for scratch) */
-    id?: string;
-    /** `#needle` anchor value, when the target's name carries one */
-    anchor?: string;
-    /** element type (`node`, `material`, …) — narrows resolution and validates matches */
-    type?: StampedElementType | (string & {});
-    /** the target's name at address-creation time */
-    name?: string;
-    /** node names from the asset root (exclusive) down to the target (inclusive); nodes only */
-    namePath?: string[];
-};
-
-/** Structural (duck-typed) view of a live scene-graph node — works with any three.js. */
-export type GraphNode = {
-    name?: string;
-    children?: readonly GraphNode[];
-    userData?: Record<string, unknown>;
-};
-
-/** Build an address for a glTF root-collection element. `namePath` only applies to nodes. */
-export function createGltfElementAddress(json: GltfJson, type: StampedElementType | string, index: number): NeedleAddress | null {
-    const collection = json[collectionKeyForType(type)];
-    if (!Array.isArray(collection)) return null;
-    const element = collection[index];
-    if (element == null || typeof element !== "object") return null;
-
-    const name = typeof element.name === "string" ? element.name : undefined;
-    const address: NeedleAddress = { type };
-    const id = getElementId(element);
-    if (id) address.id = id;
-    const anchor = parseAnchorValue(name);
-    if (anchor) address.anchor = anchor;
-    if (name !== undefined) address.name = name;
-    if (type === "node") {
-        const path = gltfNodeNamePath(json, index);
-        if (path) address.namePath = path;
-    }
-    return address;
-}
-
-/** Build an address for a live scene-graph object under `root`. */
-export function createObjectAddress(root: GraphNode, target: GraphNode): NeedleAddress | null {
-    const path = findPath(root, target);
-    if (!path) return null;
-
-    const address: NeedleAddress = { type: "node" };
-    const id = target.userData?.[NEEDLE_ID_KEY];
-    if (typeof id === "string") address.id = id;
-    const anchor = parseAnchorValue(target.name);
-    if (anchor) address.anchor = anchor;
-    if (typeof target.name === "string") address.name = target.name;
-    address.namePath = path.map(n => n.name ?? "");
-    return address;
-}
-
-export function collectionKeyForType(type: string): string {
-    // glTF collection keys are the pluralized type names; only "mesh" is irregular
-    return type === "mesh" ? "meshes" : `${type}s`;
-}
-
-/** names from root (exclusive) to the node at `nodeIndex` (inclusive), via the scene tree */
-function gltfNodeNamePath(json: GltfJson, nodeIndex: number): string[] | null {
-    const nodes = json["nodes"];
-    if (!Array.isArray(nodes)) return null;
-    const parents = new Map<number, number>();
-    for (let i = 0; i < nodes.length; i++) {
-        const children = nodes[i]?.children;
-        if (Array.isArray(children)) for (const c of children) parents.set(c, i);
-    }
-    const path: string[] = [];
-    let current: number | undefined = nodeIndex;
-    const seen = new Set<number>();
-    while (current !== undefined) {
-        if (seen.has(current)) return null; // malformed (cyclic) input
-        seen.add(current);
-        path.unshift(typeof nodes[current]?.name === "string" ? nodes[current].name : "");
-        current = parents.get(current);
-    }
-    return path;
-}
-
-/** path from root (exclusive) to target (inclusive), or null if target is not under root */
-export function findPath(root: GraphNode, target: GraphNode): GraphNode[] | null {
-    if (root === target) return [];
-    const children = root.children;
-    if (!children) return null;
-    for (let i = 0; i < children.length; i++) {
-        const child = children[i];
-        if (child == null) continue;
-        const sub = findPath(child, target);
-        if (sub) return [child, ...sub];
-    }
-    return null;
-}
+import { parseAnchorValue } from "./anchor.js";
+import { getElementId, NEEDLE_ID_KEY, type GltfJson, type StampedElementType } from "./gltf.js";
+
+/**
+ * A persistent pointer to an element inside an asset — the "fat address": every
+ * fallback the resolver may need is captured at CREATION time, while the target is
+ * known, instead of being reconstructed later.
+ *
+ * Resolution order: `id` (exact) → `anchor` (survives asset updates) → `namePath`
+ * (best-effort) → reconciliation (candidates + confidence, never a silent guess).
+ */
+export type NeedleAddress = {
+    /** the element's needle-id (deterministic for file-backed content, random for scratch) */
+    id?: string;
+    /** `#needle` anchor value, when the target's name carries one */
+    anchor?: string;
+    /** element type (`node`, `material`, …) — narrows resolution and validates matches */
+    type?: StampedElementType | (string & {});
+    /** the target's name at address-creation time */
+    name?: string;
+    /** node names from the asset root (exclusive) down to the target (inclusive); nodes only */
+    namePath?: string[];
+};
+
+/** Structural (duck-typed) view of a live scene-graph node — works with any three.js. */
+export type GraphNode = {
+    name?: string;
+    children?: readonly GraphNode[];
+    userData?: Record<string, unknown>;
+};
+
+/** Build an address for a glTF root-collection element. `namePath` only applies to nodes. */
+export function createGltfElementAddress(json: GltfJson, type: StampedElementType | string, index: number): NeedleAddress | null {
+    const collection = json[collectionKeyForType(type)];
+    if (!Array.isArray(collection)) return null;
+    const element = collection[index];
+    if (element == null || typeof element !== "object") return null;
+
+    const name = typeof element.name === "string" ? element.name : undefined;
+    const address: NeedleAddress = { type };
+    const id = getElementId(element);
+    if (id) address.id = id;
+    const anchor = parseAnchorValue(name);
+    if (anchor) address.anchor = anchor;
+    // an empty name is non-information: resolution never reads `name` (id → anchor →
+    // namePath) and reconciliation falls back to the last namePath segment ("" again).
+    // NOTE: empty namePath SEGMENTS are load-bearing (positional child-walk) — only the
+    // standalone `name` field is dropped when empty.
+    if (name) address.name = name;
+    if (type === "node") {
+        const path = gltfNodeNamePath(json, index);
+        if (path) address.namePath = path;
+    }
+    return address;
+}
+
+/** Build an address for a live scene-graph object under `root`. */
+export function createObjectAddress(root: GraphNode, target: GraphNode): NeedleAddress | null {
+    const path = findPath(root, target);
+    if (!path) return null;
+
+    const address: NeedleAddress = { type: "node" };
+    const id = target.userData?.[NEEDLE_ID_KEY];
+    if (typeof id === "string") address.id = id;
+    const anchor = parseAnchorValue(target.name);
+    if (anchor) address.anchor = anchor;
+    // empty name dropped — see createGltfElementAddress; namePath segments stay verbatim
+    if (target.name) address.name = target.name;
+    address.namePath = path.map(n => n.name ?? "");
+    return address;
+}
+
+export function collectionKeyForType(type: string): string {
+    // glTF collection keys are the pluralized type names; only "mesh" is irregular
+    return type === "mesh" ? "meshes" : `${type}s`;
+}
+
+/** names from root (exclusive) to the node at `nodeIndex` (inclusive), via the scene tree */
+function gltfNodeNamePath(json: GltfJson, nodeIndex: number): string[] | null {
+    const nodes = json["nodes"];
+    if (!Array.isArray(nodes)) return null;
+    const parents = new Map<number, number>();
+    for (let i = 0; i < nodes.length; i++) {
+        const children = nodes[i]?.children;
+        if (Array.isArray(children)) for (const c of children) parents.set(c, i);
+    }
+    const path: string[] = [];
+    let current: number | undefined = nodeIndex;
+    const seen = new Set<number>();
+    while (current !== undefined) {
+        if (seen.has(current)) return null; // malformed (cyclic) input
+        seen.add(current);
+        path.unshift(typeof nodes[current]?.name === "string" ? nodes[current].name : "");
+        current = parents.get(current);
+    }
+    return path;
+}
+
+/** path from root (exclusive) to target (inclusive), or null if target is not under root */
+export function findPath(root: GraphNode, target: GraphNode): GraphNode[] | null {
+    if (root === target) return [];
+    const children = root.children;
+    if (!children) return null;
+    for (let i = 0; i < children.length; i++) {
+        const child = children[i];
+        if (child == null) continue;
+        const sub = findPath(child, target);
+        if (sub) return [child, ...sub];
+    }
+    return null;
+}

package/src/anchor.ts

@@ -1,68 +1,71 @@
-/**
- * The name-anchor scheme: an element named `Door #needle` derives its deterministic id
- * from the text before the marker instead of (name, index, file hash) — so the id
- * survives content changes and asset re-uploads as long as the name stays.
- *
- * CONTRACT NOTE — the marker set is part of the id contract. Markers may be ADDED (new
- * names start anchoring), but never removed or re-prioritized, and every WRITER of ids
- * (this package's consumers: cloud upload, editors, CLI) must agree on the set before a
- * new marker ships — a writer that anchors on a marker another writer doesn't know mints
- * DIFFERENT ids for the same file. The anchored id only hashes the VALUE (not the
- * marker), so all markers are aliases into the same id space.
- */
-
-/** the original marker — kept as a named export for existing consumers */
-export const ANCHOR_MARKER = "#needle";
-
-/**
- * All recognized markers, matched longest-first so overlapping suffixes resolve
- * deterministically. Currently one entry; see the contract note before adding more.
- */
-export const ANCHOR_MARKERS: readonly string[] = [ANCHOR_MARKER];
-
-export type ParsedAnchor = {
-    /** the marker that matched (one of {@link ANCHOR_MARKERS}) */
-    marker: string;
-    /** the anchor value — the deterministic-id input */
-    value: string;
-};
-
-/**
- * Parse an element name against all recognized markers (case-insensitive suffix match).
- * Returns null when no marker matches or the anchor value is empty.
- */
-export function parseAnchor(rawName: string | null | undefined): ParsedAnchor | null {
-    if (rawName == null) return null;
-    const trimmed = rawName.trim();
-    const lower = trimmed.toLowerCase();
-    for (const marker of byLengthDescending(ANCHOR_MARKERS)) {
-        if (!lower.endsWith(marker)) continue;
-        const value = normalizeAnchorValue(trimmed.substring(0, trimmed.length - marker.length));
-        return value.length > 0 ? { marker, value } : null;
-    }
-    return null;
-}
-
-/**
- * Anchor values treat SPACES and UNDERSCORES as the same character (runs collapse to
- * one space): three's GLTFLoader sanitizes node names on load (whitespace becomes
- * "_"), so "Door Frame #needle" appears live as "Door_Frame_#needle" — without
- * normalization the stamped anchor and the live anchor would never match. Applied at
- * PARSE time, so id computation and resolution agree from one change point. Accepted
- * trade: names differing only by space-vs-underscore share one anchor.
- */
-function normalizeAnchorValue(value: string): string {
-    return value.replace(/[\s_]+/g, " ").trim();
-}
-
-/**
- * Extract the anchor value from an element name, or null when the name carries no anchor.
- * Convenience over {@link parseAnchor} for callers that only need the id input.
- */
-export function parseAnchorValue(rawName: string | null | undefined): string | null {
-    return parseAnchor(rawName)?.value ?? null;
-}
-
-function byLengthDescending(markers: readonly string[]): readonly string[] {
-    return markers.length > 1 ? [...markers].sort((a, b) => b.length - a.length) : markers;
-}
+/**
+ * The name-anchor scheme: an element named `Door #needle` derives its deterministic id
+ * from the text before the marker instead of (name, index, file hash) — so the id
+ * survives content changes and asset re-uploads as long as the name stays.
+ *
+ * CONTRACT NOTE — the marker set is part of the id contract. Markers may be ADDED (new
+ * names start anchoring), but never removed or re-prioritized, and every WRITER of ids
+ * (this package's consumers: cloud upload, editors, CLI) must agree on the set before a
+ * new marker ships — a writer that anchors on a marker another writer doesn't know mints
+ * DIFFERENT ids for the same file. The anchored id only hashes the VALUE (not the
+ * marker), so all markers are aliases into the same id space.
+ */
+
+/** the original marker — kept as a named export for existing consumers */
+export const ANCHOR_MARKER = "#needle";
+
+/**
+ * All recognized markers, matched longest-first so overlapping suffixes resolve
+ * deterministically. Currently one entry; see the contract note before adding more.
+ */
+export const ANCHOR_MARKERS: readonly string[] = [ANCHOR_MARKER];
+
+export type ParsedAnchor = {
+    /** the marker that matched (one of {@link ANCHOR_MARKERS}) */
+    marker: string;
+    /** the anchor value — the deterministic-id input */
+    value: string;
+};
+
+/**
+ * Parse an element name against all recognized markers (case-insensitive suffix match).
+ * Returns null when no marker matches or the anchor value is empty.
+ */
+export function parseAnchor(rawName: string | null | undefined): ParsedAnchor | null {
+    if (rawName == null) return null;
+    const trimmed = rawName.trim();
+    const lower = trimmed.toLowerCase();
+    for (const marker of byLengthDescending(ANCHOR_MARKERS)) {
+        if (!lower.endsWith(marker)) continue;
+        const value = normalizeName(trimmed.substring(0, trimmed.length - marker.length));
+        return value.length > 0 ? { marker, value } : null;
+    }
+    return null;
+}
+
+/**
+ * Names treat SPACES and UNDERSCORES as the same character (runs collapse to one space):
+ * three's GLTFLoader sanitizes node names on load (whitespace becomes "_"), so
+ * "Door Frame #needle" appears live as "Door_Frame_#needle" — without normalization a
+ * stamped anchor and the live anchor would never match. Applied at PARSE time, so id
+ * computation and resolution agree from one change point. Accepted trade: names differing
+ * only by space-vs-underscore are one name.
+ *
+ * Exported because id derivation applies the SAME rule to unanchored names (see
+ * {@link import("./id.js").idNameOf}) — one normalization, one change point.
+ */
+export function normalizeName(value: string): string {
+    return value.replace(/[\s_]+/g, " ").trim();
+}
+
+/**
+ * Extract the anchor value from an element name, or null when the name carries no anchor.
+ * Convenience over {@link parseAnchor} for callers that only need the id input.
+ */
+export function parseAnchorValue(rawName: string | null | undefined): string | null {
+    return parseAnchor(rawName)?.value ?? null;
+}
+
+function byLengthDescending(markers: readonly string[]): readonly string[] {
+    return markers.length > 1 ? [...markers].sort((a, b) => b.length - a.length) : markers;
+}