@reicek/neataptic-ts 0.1.25 → 0.1.26

package/src/architecture/network/remove/README.md

@@ -27,25 +27,13 @@ Notes / Limitations:
 
 ## architecture/network/remove/network.remove.utils.types.ts
 
-### NODE_TYPE_INPUT
-
-Node type literal for input anchors.
-
-### NODE_TYPE_OUTPUT
-
-Node type literal for output anchors.
-
-### ERROR_NODE_NOT_IN_NETWORK
-
-Error emitted when target node is not part of the network.
-
 ### ERROR_CANNOT_REMOVE_ANCHOR_NODE
 
 Error emitted when trying to remove structural anchor nodes.
 
-### NODE_NOT_FOUND_INDEX
+### ERROR_NODE_NOT_IN_NETWORK
 
-Sentinel index used when node is not found.
+Error emitted when target node is not part of the network.
 
 ### FIRST_REMOVED_NODE_INDEX
 
@@ -55,14 +43,26 @@ Index for selecting first spliced node.
 
 Internal network properties accessed during remove operations.
 
-### NodeRemovalContext
+### NODE_NOT_FOUND_INDEX
 
-Immutable context for validated node-removal request.
+Sentinel index used when node is not found.
+
+### NODE_TYPE_INPUT
+
+Node type literal for input anchors.
+
+### NODE_TYPE_OUTPUT
+
+Node type literal for output anchors.
 
 ### NodeConnectionSnapshotContext
 
 Snapshot of node adjacency prior to removal.
 
+### NodeRemovalContext
+
+Immutable context for validated node-removal request.
+
 ### ReconnectEndpointPairContext
 
 Endpoint pair for reconnecting bridged paths.
@@ -85,37 +85,35 @@ Parameters:
 
 ## architecture/network/remove/network.remove.gates.utils.ts
 
-### detachGatesOwnedByNode
+### clearConnectionGater
 
 ```ts
-detachGatesOwnedByNode(
-  removalContext: NodeRemovalContext,
+clearConnectionGater(
+  candidateConnection: default,
 ): void
 ```
 
-Removes gate records gated by target node and nulls their gater field.
+Clears gater reference so legacy checks treat connection as ungated.
 
 Parameters:
-- `removalContext` - - Immutable removal context.
+- `candidateConnection` - - Connection to clear.
 
 Returns: Nothing.
 
-### keepGateConnectionAfterNodeRemoval
+### detachGatesOwnedByNode
 
 ```ts
-keepGateConnectionAfterNodeRemoval(
-  candidateConnection: default,
-  removedNode: default,
-): boolean
+detachGatesOwnedByNode(
+  removalContext: NodeRemovalContext,
+): void
 ```
 
-Filters one gate connection while clearing removed-node gater ownership.
+Removes gate records gated by target node and nulls their gater field.
 
 Parameters:
-- `candidateConnection` - - Gate candidate.
-- `removedNode` - - Removed node reference.
+- `removalContext` - - Immutable removal context.
 
-Returns: True when gate should remain in list.
+Returns: Nothing.
 
 ### isGatedByRemovedNode
 
@@ -134,38 +132,25 @@ Parameters:
 
 Returns: True when removed node is gater.
 
-### clearConnectionGater
+### keepGateConnectionAfterNodeRemoval
 
 ```ts
-clearConnectionGater(
+keepGateConnectionAfterNodeRemoval(
   candidateConnection: default,
-): void
+  removedNode: default,
+): boolean
 ```
 
-Clears gater reference so legacy checks treat connection as ungated.
+Filters one gate connection while clearing removed-node gater ownership.
 
 Parameters:
-- `candidateConnection` - - Connection to clear.
+- `candidateConnection` - - Gate candidate.
+- `removedNode` - - Removed node reference.
 
-Returns: Nothing.
+Returns: True when gate should remain in list.
 
 ## architecture/network/remove/network.remove.finalize.utils.ts
 
-### removeNodeFromNetworkStorage
-
-```ts
-removeNodeFromNetworkStorage(
-  removalContext: NodeRemovalContext,
-): void
-```
-
-Removes node from network storage and conditionally releases it to pool.
-
-Parameters:
-- `removalContext` - - Immutable removal context.
-
-Returns: Nothing.
-
 ### markNetworkRemovalDirtyFlags
 
 ```ts
@@ -181,21 +166,6 @@ Parameters:
 
 Returns: Nothing.
 
-### spliceNodeFromNetwork
-
-```ts
-spliceNodeFromNetwork(
-  removalContext: NodeRemovalContext,
-): default | undefined
-```
-
-Splices node out of network list using validated index.
-
-Parameters:
-- `removalContext` - - Immutable removal context.
-
-Returns: Removed node or undefined.
-
 ### releaseRemovedNodeWhenPoolingEnabled
 
 ```ts
@@ -211,39 +181,37 @@ Parameters:
 
 Returns: Nothing.
 
-## architecture/network/remove/network.remove.snapshot.utils.ts
-
-### createNodeConnectionSnapshot
+### removeNodeFromNetworkStorage
 
 ```ts
-createNodeConnectionSnapshot(
+removeNodeFromNetworkStorage(
   removalContext: NodeRemovalContext,
-): NodeConnectionSnapshotContext
+): void
 ```
 
-Creates immutable snapshots of node adjacency lists before mutation.
+Removes node from network storage and conditionally releases it to pool.
 
 Parameters:
 - `removalContext` - - Immutable removal context.
 
-Returns: Snapshot context.
+Returns: Nothing.
 
-### disconnectAllNodeConnections
+### spliceNodeFromNetwork
 
 ```ts
-disconnectAllNodeConnections(
+spliceNodeFromNetwork(
   removalContext: NodeRemovalContext,
-  snapshotContext: NodeConnectionSnapshotContext,
-): void
+): default | undefined
 ```
 
-Disconnects all inbound, outbound, and self-loop edges for removed node.
+Splices node out of network list using validated index.
 
 Parameters:
 - `removalContext` - - Immutable removal context.
-- `snapshotContext` - - Immutable adjacency snapshot.
 
-Returns: Nothing.
+Returns: Removed node or undefined.
+
+## architecture/network/remove/network.remove.snapshot.utils.ts
 
 ### cloneInboundConnections
 
@@ -290,6 +258,38 @@ Parameters:
 
 Returns: Self-loop count.
 
+### createNodeConnectionSnapshot
+
+```ts
+createNodeConnectionSnapshot(
+  removalContext: NodeRemovalContext,
+): NodeConnectionSnapshotContext
+```
+
+Creates immutable snapshots of node adjacency lists before mutation.
+
+Parameters:
+- `removalContext` - - Immutable removal context.
+
+Returns: Snapshot context.
+
+### disconnectAllNodeConnections
+
+```ts
+disconnectAllNodeConnections(
+  removalContext: NodeRemovalContext,
+  snapshotContext: NodeConnectionSnapshotContext,
+): void
+```
+
+Disconnects all inbound, outbound, and self-loop edges for removed node.
+
+Parameters:
+- `removalContext` - - Immutable removal context.
+- `snapshotContext` - - Immutable adjacency snapshot.
+
+Returns: Nothing.
+
 ### disconnectConnectionGroup
 
 ```ts
@@ -328,37 +328,37 @@ Returns: Nothing.
 
 ## architecture/network/remove/network.remove.reconnect.utils.ts
 
-### reconnectBridgedPaths
+### collectReconnectEndpointPairs
 
 ```ts
-reconnectBridgedPaths(
-  removalContext: NodeRemovalContext,
+collectReconnectEndpointPairs(
   snapshotContext: NodeConnectionSnapshotContext,
-): void
+): ReconnectEndpointPairContext[]
 ```
 
-Reconnects paths from former inbound sources to former outbound targets.
+Collects all valid source/target reconnect endpoint pairs.
 
 Parameters:
-- `removalContext` - - Immutable removal context.
 - `snapshotContext` - - Immutable adjacency snapshot.
 
-Returns: Nothing.
+Returns: Valid reconnect endpoint pairs.
 
-### collectReconnectEndpointPairs
+### connectPairWhenMissing
 
 ```ts
-collectReconnectEndpointPairs(
-  snapshotContext: NodeConnectionSnapshotContext,
-): ReconnectEndpointPairContext[]
+connectPairWhenMissing(
+  network: default,
+  reconnectPair: ReconnectEndpointPairContext,
+): void
 ```
 
-Collects all valid source/target reconnect endpoint pairs.
+Connects one endpoint pair only when direct edge does not already exist.
 
 Parameters:
-- `snapshotContext` - - Immutable adjacency snapshot.
+- `network` - - Target network.
+- `reconnectPair` - - Source/target pair.
 
-Returns: Valid reconnect endpoint pairs.
+Returns: Nothing.
 
 ### createReconnectEndpointPair
 
@@ -377,6 +377,23 @@ Parameters:
 
 Returns: Reconnect pair or undefined.
 
+### doesDirectConnectionExist
+
+```ts
+doesDirectConnectionExist(
+  network: default,
+  reconnectPair: ReconnectEndpointPairContext,
+): boolean
+```
+
+Checks whether a direct connection already exists for reconnect pair.
+
+Parameters:
+- `network` - - Target network.
+- `reconnectPair` - - Source/target pair.
+
+Returns: True when direct edge already exists.
+
 ### isReconnectPairValid
 
 ```ts
@@ -394,40 +411,23 @@ Parameters:
 
 Returns: True when reconnect pair should be attempted.
 
-### connectPairWhenMissing
+### reconnectBridgedPaths
 
 ```ts
-connectPairWhenMissing(
-  network: default,
-  reconnectPair: ReconnectEndpointPairContext,
+reconnectBridgedPaths(
+  removalContext: NodeRemovalContext,
+  snapshotContext: NodeConnectionSnapshotContext,
 ): void
 ```
 
-Connects one endpoint pair only when direct edge does not already exist.
+Reconnects paths from former inbound sources to former outbound targets.
 
 Parameters:
-- `network` - - Target network.
-- `reconnectPair` - - Source/target pair.
+- `removalContext` - - Immutable removal context.
+- `snapshotContext` - - Immutable adjacency snapshot.
 
 Returns: Nothing.
 
-### doesDirectConnectionExist
-
-```ts
-doesDirectConnectionExist(
-  network: default,
-  reconnectPair: ReconnectEndpointPairContext,
-): boolean
-```
-
-Checks whether a direct connection already exists for reconnect pair.
-
-Parameters:
-- `network` - - Target network.
-- `reconnectPair` - - Source/target pair.
-
-Returns: True when direct edge already exists.
-
 ## architecture/network/remove/network.remove.validation.utils.ts
 
 ### createValidatedNodeRemovalContext
@@ -447,23 +447,6 @@ Parameters:
 
 Returns: Validated removal context.
 
-### resolveNodeIndexOrThrow
-
-```ts
-resolveNodeIndexOrThrow(
-  network: default,
-  targetNode: default,
-): number
-```
-
-Resolves node index and throws when missing.
-
-Parameters:
-- `network` - - Target network.
-- `targetNode` - - Node being removed.
-
-Returns: Node index inside network list.
-
 ### ensureNodeIsNotStructuralAnchor
 
 ```ts
@@ -493,3 +476,20 @@ Parameters:
 - `targetNode` - - Node under evaluation.
 
 Returns: True when node is an anchor.
+
+### resolveNodeIndexOrThrow
+
+```ts
+resolveNodeIndexOrThrow(
+  network: default,
+  targetNode: default,
+): number
+```
+
+Resolves node index and throws when missing.
+
+Parameters:
+- `network` - - Target network.
+- `targetNode` - - Node being removed.
+
+Returns: Node index inside network list.