effect 4.0.0-beta.67 → 4.0.0-beta.69

package/dist/Graph.js

@@ -64,7 +64,7 @@ const TypeId = "~effect/collections/Graph";
  * Edge data containing source, target, and user data.
  *
  * @category models
- * @since 4.0.0
+ * @since 3.18.0
  */
 export class Edge extends Data.Class {}
 // =============================================================================
@@ -146,7 +146,7 @@ const ProtoGraph = {
  * weights.
  *
  * @category errors
- * @since 4.0.0
+ * @since 3.18.0
  */
 export class GraphError extends /*#__PURE__*/Data.TaggedError("GraphError") {}
 /** @internal */
@@ -160,7 +160,7 @@ const missingNode = node => new GraphError({
  * Returns `true` if a value has the graph runtime type identifier, narrowing
  * it to a `Graph`.
  *
- * @category Guards
+ * @category guards
  * @since 4.0.0
  */
 export const isGraph = u => hasProperty(u, TypeId);
@@ -183,7 +183,7 @@ export const isGraph = u => hasProperty(u, TypeId);
  * ```
  *
  * @category constructors
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const directed = mutate => {
   const graph = Object.create(ProtoGraph);
@@ -222,7 +222,7 @@ export const directed = mutate => {
  * ```
  *
  * @category constructors
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const undirected = mutate => {
   const graph = Object.create(ProtoGraph);
@@ -259,7 +259,7 @@ export const undirected = mutate => {
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const beginMutation = graph => {
   // Copy adjacency maps with deep cloned arrays
@@ -298,7 +298,7 @@ export const beginMutation = graph => {
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const endMutation = mutable => {
   const graph = Object.create(ProtoGraph);
@@ -333,7 +333,7 @@ export const endMutation = mutable => {
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const mutate = /*#__PURE__*/dual(2, (graph, f) => {
   const mutable = beginMutation(graph);
@@ -360,7 +360,7 @@ export const mutate = /*#__PURE__*/dual(2, (graph, f) => {
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const addNode = (mutable, data) => {
   const nodeIndex = mutable.nextNodeIndex;
@@ -379,8 +379,7 @@ export const addNode = (mutable, data) => {
  * **Example** (Getting node data)
  *
  * ```ts
- * import { Graph } from "effect"
- * import * as Option from "effect/Option"
+ * import { Graph, Option } from "effect"
  *
  * const graph = Graph.mutate(Graph.directed<string, number>(), (mutable) => {
  *   Graph.addNode(mutable, "Node A")
@@ -395,7 +394,7 @@ export const addNode = (mutable, data) => {
  * ```
  *
  * @category getters
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const getNode = /*#__PURE__*/dual(2, (graph, nodeIndex) => graph.nodes.has(nodeIndex) ? Option.some(graph.nodes.get(nodeIndex)) : Option.none());
 /**
@@ -420,7 +419,7 @@ export const getNode = /*#__PURE__*/dual(2, (graph, nodeIndex) => graph.nodes.ha
  * ```
  *
  * @category getters
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const hasNode = /*#__PURE__*/dual(2, (graph, nodeIndex) => graph.nodes.has(nodeIndex));
 /**
@@ -444,7 +443,7 @@ export const hasNode = /*#__PURE__*/dual(2, (graph, nodeIndex) => graph.nodes.ha
  * ```
  *
  * @category getters
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const nodeCount = graph => graph.nodes.size;
 /**
@@ -469,7 +468,7 @@ export const nodeCount = graph => graph.nodes.size;
  * ```
  *
  * @category getters
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const findNode = /*#__PURE__*/dual(2, (graph, predicate) => {
   for (const [index, data] of graph.nodes) {
@@ -501,7 +500,7 @@ export const findNode = /*#__PURE__*/dual(2, (graph, predicate) => {
  * ```
  *
  * @category getters
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const findNodes = /*#__PURE__*/dual(2, (graph, predicate) => {
   const results = [];
@@ -536,7 +535,7 @@ export const findNodes = /*#__PURE__*/dual(2, (graph, predicate) => {
  * ```
  *
  * @category getters
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const findEdge = /*#__PURE__*/dual(2, (graph, predicate) => {
   for (const [edgeIndex, edgeData] of graph.edges) {
@@ -571,7 +570,7 @@ export const findEdge = /*#__PURE__*/dual(2, (graph, predicate) => {
  * ```
  *
  * @category getters
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const findEdges = /*#__PURE__*/dual(2, (graph, predicate) => {
   const results = [];
@@ -600,8 +599,8 @@ export const findEdges = /*#__PURE__*/dual(2, (graph, predicate) => {
  * console.log(nodeData) // Option.some("NODE A")
  * ```
  *
- * @category transformations
- * @since 4.0.0
+ * @category transforming
+ * @since 3.18.0
  */
 export const updateNode = (mutable, index, f) => {
   if (!mutable.nodes.has(index)) {
@@ -631,7 +630,7 @@ export const updateNode = (mutable, index, f) => {
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const updateEdge = (mutable, edgeIndex, f) => {
   if (!mutable.edges.has(edgeIndex)) {
@@ -668,8 +667,8 @@ export const updateEdge = (mutable, edgeIndex, f) => {
  * console.log(nodeData) // Option.some("NODE A")
  * ```
  *
- * @category transformations
- * @since 4.0.0
+ * @category transforming
+ * @since 3.18.0
  */
 export const mapNodes = (mutable, f) => {
   // Transform existing node data in place
@@ -699,8 +698,8 @@ export const mapNodes = (mutable, f) => {
  * console.log(edgeData) // Option.some(new Graph.Edge({ source: 0, target: 1, data: 20 }))
  * ```
  *
- * @category transformations
- * @since 4.0.0
+ * @category transforming
+ * @since 3.18.0
  */
 export const mapEdges = (mutable, f) => {
   // Transform existing edge data in place
@@ -733,8 +732,8 @@ export const mapEdges = (mutable, f) => {
  * console.log(edge0) // Option.some(new Graph.Edge({ source: 1, target: 0, data: 1 }))
  * ```
  *
- * @category transformations
- * @since 4.0.0
+ * @category transforming
+ * @since 3.18.0
  */
 export const reverse = mutable => {
   // Reverse all edges by swapping source and target
@@ -769,8 +768,7 @@ export const reverse = mutable => {
  * **Example** (Filtering and mapping nodes)
  *
  * ```ts
- * import { Graph } from "effect"
- * import * as Option from "effect/Option"
+ * import { Graph, Option } from "effect"
  *
  * const graph = Graph.directed<string, number>((mutable) => {
  *   const a = Graph.addNode(mutable, "active")
@@ -790,8 +788,8 @@ export const reverse = mutable => {
  * console.log(Graph.nodeCount(graph)) // 2 (only "active" nodes remain)
  * ```
  *
- * @category transformations
- * @since 4.0.0
+ * @category transforming
+ * @since 3.18.0
  */
 export const filterMapNodes = (mutable, f) => {
   const nodesToRemove = [];
@@ -818,8 +816,7 @@ export const filterMapNodes = (mutable, f) => {
  * **Example** (Filtering and mapping edges)
  *
  * ```ts
- * import { Graph } from "effect"
- * import * as Option from "effect/Option"
+ * import { Graph, Option } from "effect"
  *
  * const graph = Graph.directed<string, number>((mutable) => {
  *   const a = Graph.addNode(mutable, "A")
@@ -839,8 +836,8 @@ export const filterMapNodes = (mutable, f) => {
  * console.log(Graph.edgeCount(graph)) // 2 (edges with weight 5 removed)
  * ```
  *
- * @category transformations
- * @since 4.0.0
+ * @category transforming
+ * @since 3.18.0
  */
 export const filterMapEdges = (mutable, f) => {
   const edgesToRemove = [];
@@ -885,8 +882,8 @@ export const filterMapEdges = (mutable, f) => {
  * console.log(Graph.nodeCount(graph)) // 2 (only "active" nodes remain)
  * ```
  *
- * @category transformations
- * @since 4.0.0
+ * @category transforming
+ * @since 3.18.0
  */
 export const filterNodes = (mutable, predicate) => {
   const nodesToRemove = [];
@@ -926,8 +923,8 @@ export const filterNodes = (mutable, predicate) => {
  * console.log(Graph.edgeCount(graph)) // 2 (edge with weight 5 removed)
  * ```
  *
- * @category transformations
- * @since 4.0.0
+ * @category transforming
+ * @since 3.18.0
  */
 export const filterEdges = (mutable, predicate) => {
   const edgesToRemove = [];
@@ -979,7 +976,7 @@ const invalidateCycleFlagOnAddition = mutable => {
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const addEdge = (mutable, source, target, data) => {
   // Validate that both nodes exist
@@ -1043,7 +1040,7 @@ export const addEdge = (mutable, source, target, data) => {
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const removeNode = (mutable, nodeIndex) => {
   // Check if node exists
@@ -1097,7 +1094,7 @@ export const removeNode = (mutable, nodeIndex) => {
  * ```
  *
  * @category mutations
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const removeEdge = (mutable, edgeIndex) => {
   const wasRemoved = removeEdgeInternal(mutable, edgeIndex);
@@ -1182,7 +1179,7 @@ const removeEdgeInternal = (mutable, edgeIndex) => {
  * ```
  *
  * @category getters
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const getEdge = /*#__PURE__*/dual(2, (graph, edgeIndex) => Option.fromUndefinedOr(graph.edges.get(edgeIndex)));
 /**
@@ -1212,7 +1209,7 @@ export const getEdge = /*#__PURE__*/dual(2, (graph, edgeIndex) => Option.fromUnd
  * ```
  *
  * @category getters
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const hasEdge = /*#__PURE__*/dual(3, (graph, source, target) => {
   const adjacencyList = graph.adjacency.get(source);
@@ -1252,7 +1249,7 @@ export const hasEdge = /*#__PURE__*/dual(3, (graph, source, target) => {
  * ```
  *
  * @category getters
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const edgeCount = graph => graph.edges.size;
 /**
@@ -1288,7 +1285,7 @@ export const edgeCount = graph => graph.edges.size;
  * ```
  *
  * @category getters
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const neighbors = /*#__PURE__*/dual(2, (graph, nodeIndex) => {
   // For undirected graphs, use the specialized helper that returns the other endpoint
@@ -1333,7 +1330,7 @@ export const neighbors = /*#__PURE__*/dual(2, (graph, nodeIndex) => {
  * ```
  *
  * @category queries
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const neighborsDirected = /*#__PURE__*/dual(3, (graph, nodeIndex, direction) => {
   const adjacencyMap = direction === "incoming" ? graph.reverseAdjacency : graph.adjacency;
@@ -1382,7 +1379,7 @@ export const neighborsDirected = /*#__PURE__*/dual(3, (graph, nodeIndex, directi
  * ```
  *
  * @category utils
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const toGraphViz = /*#__PURE__*/dual(args => isGraph(args[0]), (graph, options) => {
   const {
@@ -1453,7 +1450,7 @@ const formatMermaidNode = (nodeId, label, shape) => {
  * **Example** (Exporting a directed Mermaid diagram)
  *
  * ```ts
- * import * as Graph from "effect/Graph"
+ * import { Graph } from "effect"
  *
  * // Basic directed graph export
  * const graph = Graph.directed<string, number>((mutable) => {
@@ -1477,7 +1474,7 @@ const formatMermaidNode = (nodeId, label, shape) => {
  * **Example** (Exporting an undirected Mermaid diagram)
  *
  * ```ts
- * import * as Graph from "effect/Graph"
+ * import { Graph } from "effect"
  *
  * // Undirected graph with custom labels and direction
  * const socialGraph = Graph.undirected<{ name: string }, string>((mutable) => {
@@ -1505,7 +1502,7 @@ const formatMermaidNode = (nodeId, label, shape) => {
  * **Example** (Customizing Mermaid node shapes)
  *
  * ```ts
- * import * as Graph from "effect/Graph"
+ * import { Graph } from "effect"
  *
  * // Advanced styling with node shapes for flowchart
  * const workflow = Graph.directed<{ type: string; name: string }, string>(
@@ -1557,7 +1554,7 @@ const formatMermaidNode = (nodeId, label, shape) => {
  * **Example** (Visualizing dependency graphs)
  *
  * ```ts
- * import * as Graph from "effect/Graph"
+ * import { Graph } from "effect"
  *
  * // Real-world example: Software dependency graph
  * interface Dependency {
@@ -1616,12 +1613,8 @@ const formatMermaidNode = (nodeId, label, shape) => {
  * //   0 -->|"builds with"| 3
  * ```
  *
- * @param graph - The graph to export (directed or undirected)
- * @param options - Optional configuration for the Mermaid output
- * @returns Mermaid diagram syntax as a string
- *
  * @category utils
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const toMermaid = /*#__PURE__*/dual(args => isGraph(args[0]), (graph, options) => {
   // Extract and validate options with defaults
@@ -1695,7 +1688,7 @@ export const toMermaid = /*#__PURE__*/dual(args => isGraph(args[0]), (graph, opt
  * ```
  *
  * @category algorithms
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const isAcyclic = graph => {
   // Use existing cycle flag if available
@@ -1792,7 +1785,7 @@ export const isAcyclic = graph => {
  * ```
  *
  * @category algorithms
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const isBipartite = graph => {
   const coloring = new Map();
@@ -1877,7 +1870,7 @@ const getUndirectedNeighbors = (graph, nodeIndex) => {
  * ```
  *
  * @category algorithms
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const connectedComponents = graph => {
   const visited = new Set();
@@ -1929,7 +1922,7 @@ export const connectedComponents = graph => {
  * ```
  *
  * @category algorithms
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const stronglyConnectedComponents = graph => {
   const visited = new Set();
@@ -2037,7 +2030,7 @@ export const stronglyConnectedComponents = graph => {
  * ```
  *
  * @category algorithms
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const dijkstra = /*#__PURE__*/dual(2, (graph, config) => {
   // Validate that source and target nodes exist
@@ -2181,7 +2174,7 @@ export const dijkstra = /*#__PURE__*/dual(2, (graph, config) => {
  * ```
  *
  * @category algorithms
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const floydWarshall = /*#__PURE__*/dual(2, (graph, cost) => {
   // Get all nodes for Floyd-Warshall algorithm (needs array for nested iteration)
@@ -2320,7 +2313,7 @@ export const floydWarshall = /*#__PURE__*/dual(2, (graph, cost) => {
  * ```
  *
  * @category algorithms
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const astar = /*#__PURE__*/dual(2, (graph, config) => {
   // Validate that source and target nodes exist
@@ -2494,7 +2487,7 @@ export const astar = /*#__PURE__*/dual(2, (graph, config) => {
  * ```
  *
  * @category algorithms
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const bellmanFord = /*#__PURE__*/dual(2, (graph, config) => {
   // Validate that source and target nodes exist
@@ -2642,7 +2635,7 @@ export const bellmanFord = /*#__PURE__*/dual(2, (graph, config) => {
  * ```
  *
  * @category models
- * @since 4.0.0
+ * @since 3.18.0
  */
 export class Walker {
   // @ts-ignore
@@ -2678,7 +2671,6 @@ export class Walker {
    * console.log(custom) // [{ id: 0, name: "A" }, { id: 1, name: "B" }]
    * ```
    *
-   * @category iterators
    * @since 4.0.0
    */
   visit;
@@ -2741,8 +2733,8 @@ export class Walker {
  * console.log(indices) // [0, 1]
  * ```
  *
- * @category utilities
- * @since 4.0.0
+ * @category utils
+ * @since 3.18.0
  */
 export const indices = walker => walker.visit((index, _) => index);
 /**
@@ -2764,8 +2756,8 @@ export const indices = walker => walker.visit((index, _) => index);
  * console.log(values) // ["A", "B"]
  * ```
  *
- * @category utilities
- * @since 4.0.0
+ * @category utils
+ * @since 3.18.0
  */
 export const values = walker => walker.visit((_, data) => data);
 /**
@@ -2787,8 +2779,8 @@ export const values = walker => walker.visit((_, data) => data);
  * console.log(entries) // [[0, "A"], [1, "B"]]
  * ```
  *
- * @category utilities
- * @since 4.0.0
+ * @category utils
+ * @since 3.18.0
  */
 export const entries = walker => walker.visit((index, data) => [index, data]);
 /**
@@ -2826,7 +2818,7 @@ export const entries = walker => walker.visit((index, data) => [index, data]);
  * ```
  *
  * @category iterators
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const dfs = /*#__PURE__*/dual(args => isGraph(args[0]), (graph, config = {}) => {
   const start = config.start ?? [];
@@ -2910,7 +2902,7 @@ export const dfs = /*#__PURE__*/dual(args => isGraph(args[0]), (graph, config =
  * ```
  *
  * @category iterators
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const bfs = /*#__PURE__*/dual(args => isGraph(args[0]), (graph, config = {}) => {
   const start = config.start ?? [];
@@ -2999,7 +2991,7 @@ export const bfs = /*#__PURE__*/dual(args => isGraph(args[0]), (graph, config =
  * ```
  *
  * @category iterators
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const topo = /*#__PURE__*/dual(args => isGraph(args[0]), (graph, config = {}) => {
   // Check if graph is acyclic first
@@ -3108,7 +3100,7 @@ export const topo = /*#__PURE__*/dual(args => isGraph(args[0]), (graph, config =
  * ```
  *
  * @category iterators
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const dfsPostOrder = /*#__PURE__*/dual(args => isGraph(args[0]), (graph, config = {}) => {
   const start = config.start ?? [];
@@ -3199,7 +3191,7 @@ export const dfsPostOrder = /*#__PURE__*/dual(args => isGraph(args[0]), (graph,
  * ```
  *
  * @category iterators
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const nodes = graph => new Walker(f => ({
   [Symbol.iterator]() {
@@ -3247,7 +3239,7 @@ export const nodes = graph => new Walker(f => ({
  * ```
  *
  * @category iterators
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const edges = graph => new Walker(f => ({
   [Symbol.iterator]() {
@@ -3307,7 +3299,7 @@ export const edges = graph => new Walker(f => ({
  * ```
  *
  * @category iterators
- * @since 4.0.0
+ * @since 3.18.0
  */
 export const externals = /*#__PURE__*/dual(args => isGraph(args[0]), (graph, config = {}) => {
   const direction = config.direction ?? "outgoing";