@statelyai/graph 0.3.0 → 0.3.1

package/dist/{adjacency-list-A4_Eiwj3.mjs → adjacency-list-ITO40kmn.mjs}

@@ -1,4 +1,20 @@
 //#region src/formats/adjacency-list/index.ts
+/**
+* Converts a graph to an adjacency list representation.
+*
+* @example
+* ```ts
+* import { createGraph, toAdjacencyList } from '@statelyai/graph';
+*
+* const graph = createGraph({
+*   nodes: { a: {}, b: {}, c: {} },
+*   edges: [{ source: 'a', target: 'b' }, { source: 'a', target: 'c' }],
+* });
+*
+* toAdjacencyList(graph);
+* // { a: ['b', 'c'], b: [], c: [] }
+* ```
+*/
 function toAdjacencyList(graph) {
 	const adj = {};
 	for (const node of graph.nodes) adj[node.id] = [];
@@ -8,6 +24,23 @@ function toAdjacencyList(graph) {
 	}
 	return adj;
 }
+/**
+* Parses an adjacency list into a graph.
+*
+* @example
+* ```ts
+* import { fromAdjacencyList } from '@statelyai/graph';
+*
+* const graph = fromAdjacencyList({
+*   a: ['b', 'c'],
+*   b: ['c'],
+*   c: [],
+* });
+*
+* graph.nodes; // [{id: 'a', ...}, {id: 'b', ...}, {id: 'c', ...}]
+* graph.edges; // [{sourceId: 'a', targetId: 'b', ...}, ...]
+* ```
+*/
 function fromAdjacencyList(adj, options) {
 	const directed = options?.directed ?? true;
 	const seen = /* @__PURE__ */ new Set();