Interface: SourceHandle

Stable handle describing a source node’s provenance. The writer uses the handle to decide whether a generated node can be spliced into an existing part or whether a broader scope must be regenerated.

Properties

nodeId?

readonly optional nodeId?: SourceNodeId;

Node id inside the part (when available).

Drawing nodes use (partPath, nodeId) as their stable identity. In that case orderingSlot is preservation metadata only and is deliberately ignored when comparing handles. This lets an existing node retain its identity when its parent-local sibling position changes.

orderingSlot?

readonly optional orderingSlot?: number;

The child’s order slot within the parent element. Used to restore order with raw sidecars and as the identity fallback only when nodeId is unavailable.

partPath

readonly partPath: PartPath;

Package part that owns this node.

rawSidecarIds?

readonly optional rawSidecarIds?: readonly RawSidecarId[];

Raw sidecar ids associated with this node.

relationshipId?

readonly optional relationshipId?: RelationshipId;

The relationship id referencing this node (e.g. r:embed in blip).