@xmachines/play-router 6.1.0 → 7.0.0

package/dist/xstate/machine-to-graph.js

@@ -1,116 +1,105 @@
+import { UnknownStateTypeError } from "../errors.js";
 import { toDirectedGraph } from "xstate/graph";
 import { createGraph } from "@statelyai/graph";
-import { UnknownStateTypeError } from "../errors.js";
+//#region packages/play-router/src/xstate/machine-to-graph.ts
 /**
- * Converts an XState v5 state machine into a typed Graph of @statelyai/graph.
- *
- * The pipeline of the conversion is:
- * `XState Machine → toDirectedGraph() → the hierarchy of the DirectedGraphNode objects → createGraph() → Graph`
- *
- * The graph of the result holds three things:
- * - **The hierarchy**: the parentId of a node shows the compound nesting and the parallel nesting of XState
- * - **The edges**: every transition, with its event types and with its optional guard types
- * - **The metadata**: the state type, the meta object, and the route path from the extraction
- *
- * @param machine - The XState v5 state machine, in each shape
- * @returns The typed directed graph, with a MachineNodeData object on each node and a MachineEdgeData object on each edge
- *
- * @example
- * The conversion of a simple machine, and a query of its routes
- * ```typescript
- * import { createMachine } from "xstate";
- * import { getChildren, getSuccessors } from "@statelyai/graph";
- * import { machineToGraph } from "@xmachines/play-router/xstate";
- *
- * const machine = createMachine({
- *   id: "app",
- *   initial: "home",
- *   states: {
- *     home: { meta: { route: "/home" }, on: { GO_ABOUT: "about" } },
- *     about: { meta: { route: "/about" } },
- *   },
- * });
- *
- * const graph = machineToGraph(machine);
- * const children = getChildren(graph, "app"); // [home, about]
- * const successors = getSuccessors(graph, "app.home"); // [about]
- * ```
- *
- * @see {@link MachineNodeData} for the shape of the data of a node
- * @see {@link MachineEdgeData} for the shape of the data of an edge
- * @see https://github.com/statelyai/graph for the API reference of @statelyai/graph
- */
+* Converts an XState v5 state machine into a typed Graph of @statelyai/graph.
+*
+* The pipeline of the conversion is:
+* `XState Machine → toDirectedGraph() → the hierarchy of the DirectedGraphNode objects → createGraph() → Graph`
+*
+* The graph of the result holds three things:
+* - **The hierarchy**: the parentId of a node shows the compound nesting and the parallel nesting of XState
+* - **The edges**: every transition, with its event types and with its optional guard types
+* - **The metadata**: the state type, the meta object, and the route path from the extraction
+*
+* @param machine - The XState v5 state machine, in each shape
+* @returns The typed directed graph, with a MachineNodeData object on each node and a MachineEdgeData object on each edge
+*
+* @example
+* The conversion of a simple machine, and a query of its routes
+* ```typescript
+* import { createMachine } from "xstate";
+* import { getChildren, getSuccessors } from "@statelyai/graph";
+* import { machineToGraph } from "@xmachines/play-router/xstate";
+*
+* const machine = createMachine({
+*   id: "app",
+*   initial: "home",
+*   states: {
+*     home: { meta: { route: "/home" }, on: { GO_ABOUT: "about" } },
+*     about: { meta: { route: "/about" } },
+*   },
+* });
+*
+* const graph = machineToGraph(machine);
+* const children = getChildren(graph, "app"); // [home, about]
+* const successors = getSuccessors(graph, "app.home"); // [about]
+* ```
+*
+* @see {@link MachineNodeData} for the shape of the data of a node
+* @see {@link MachineEdgeData} for the shape of the data of an edge
+* @see https://github.com/statelyai/graph for the API reference of @statelyai/graph
+*/
 /**
- * The set of the valid XState state types, for the check at run time.
- * It guards against a later change of XState, and against a machine shape that the
- * package does not expect.
- */
-const VALID_STATE_TYPES = new Set([
-    "atomic",
-    "compound",
-    "parallel",
-    "final",
-    "history",
+* The set of the valid XState state types, for the check at run time.
+* It guards against a later change of XState, and against a machine shape that the
+* package does not expect.
+*/
+var VALID_STATE_TYPES = /* @__PURE__ */ new Set([
+	"atomic",
+	"compound",
+	"parallel",
+	"final",
+	"history"
 ]);
-export const machineToGraph = (machine) => {
-    const dg = toDirectedGraph(machine);
-    // Convert the hierarchy of the DirectedGraphNode objects into a flat array of nodes and a flat array of edges
-    const nodes = [];
-    const edges = [];
-    let edgeCounter = 0;
-    const walk = (dgNode, parentId) => {
-        const sn = dgNode.stateNode;
-        const meta = sn.meta;
-        const metaRoute = meta?.["route"];
-        const route = typeof metaRoute === "string"
-            ? metaRoute
-            : typeof metaRoute === "object" && metaRoute !== null && "path" in metaRoute
-                ? metaRoute.path
-                : undefined;
-        // An assertion at run time: check the state type before the cast
-        if (!VALID_STATE_TYPES.has(sn.type)) {
-            throw new UnknownStateTypeError(sn.type, sn.id, [...VALID_STATE_TYPES]);
-        }
-        const nodeData = {
-            stateId: sn.id,
-            type: sn.type,
-        };
-        if (meta !== undefined)
-            nodeData.meta = meta;
-        if (route !== undefined)
-            nodeData.route = route;
-        if (parentId !== undefined) {
-            nodes.push({ id: dgNode.id, parentId, data: nodeData });
-        }
-        else {
-            nodes.push({ id: dgNode.id, data: nodeData });
-        }
-        // Collect the edges of THIS node. An edge is on its source node, and not on the root of the graph
-        for (const edge of dgNode.edges) {
-            const edgeData = {
-                eventType: edge.label.text,
-            };
-            if (edge.transition.guard) {
-                edgeData.guardType = String(edge.transition.guard);
-            }
-            edges.push({
-                id: `e${edgeCounter++}`,
-                sourceId: edge.source.id,
-                targetId: edge.target.id,
-                data: edgeData,
-            });
-        }
-        // Walk into the children, with this node as their parent
-        for (const child of dgNode.children) {
-            walk(child, dgNode.id);
-        }
-    };
-    walk(dg);
-    return createGraph({
-        mode: "directed",
-        initialNodeId: dg.id,
-        nodes,
-        edges,
-    });
+var machineToGraph = (machine) => {
+	const dg = toDirectedGraph(machine);
+	const nodes = [];
+	const edges = [];
+	let edgeCounter = 0;
+	const walk = (dgNode, parentId) => {
+		const sn = dgNode.stateNode;
+		const meta = sn.meta;
+		const metaRoute = meta?.["route"];
+		const route = typeof metaRoute === "string" ? metaRoute : typeof metaRoute === "object" && metaRoute !== null && "path" in metaRoute ? metaRoute.path : void 0;
+		if (!VALID_STATE_TYPES.has(sn.type)) throw new UnknownStateTypeError(sn.type, sn.id, [...VALID_STATE_TYPES]);
+		const nodeData = {
+			stateId: sn.id,
+			type: sn.type
+		};
+		if (meta !== void 0) nodeData.meta = meta;
+		if (route !== void 0) nodeData.route = route;
+		if (parentId !== void 0) nodes.push({
+			id: dgNode.id,
+			parentId,
+			data: nodeData
+		});
+		else nodes.push({
+			id: dgNode.id,
+			data: nodeData
+		});
+		for (const edge of dgNode.edges) {
+			const edgeData = { eventType: edge.label.text };
+			if (edge.transition.guard) edgeData.guardType = String(edge.transition.guard);
+			edges.push({
+				id: `e${edgeCounter++}`,
+				sourceId: edge.source.id,
+				targetId: edge.target.id,
+				data: edgeData
+			});
+		}
+		for (const child of dgNode.children) walk(child, dgNode.id);
+	};
+	walk(dg);
+	return createGraph({
+		mode: "directed",
+		initialNodeId: dg.id,
+		nodes,
+		edges
+	});
 };
+//#endregion
+export { machineToGraph };
+
 //# sourceMappingURL=machine-to-graph.js.map

package/dist/xstate/machine-to-graph.js.map

@@ -1 +1 @@
-{"version":3,"file":"machine-to-graph.js","sourceRoot":"","sources":["../../src/xstate/machine-to-graph.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAA0B,MAAM,cAAc,CAAC;AACvE,OAAO,EAAE,WAAW,EAAc,MAAM,kBAAkB,CAAC;AAE3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAgBrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH;;;;GAIG;AACH,MAAM,iBAAiB,GAAwB,IAAI,GAAG,CAAC;IACtD,QAAQ;IACR,UAAU;IACV,UAAU;IACV,OAAO;IACP,SAAS;CACT,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,OAAwB,EAAgB,EAAE;IACxE,MAAM,EAAE,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;IAEpC,8GAA8G;IAC9G,MAAM,KAAK,GAAoE,EAAE,CAAC;IAClF,MAAM,KAAK,GAKN,EAAE,CAAC;IACR,IAAI,WAAW,GAAG,CAAC,CAAC;IAEpB,MAAM,IAAI,GAAG,CAAC,MAAyB,EAAE,QAAiB,EAAQ,EAAE;QACnE,MAAM,EAAE,GAAG,MAAM,CAAC,SAAS,CAAC;QAC5B,MAAM,IAAI,GAAG,EAAE,CAAC,IAA2C,CAAC;QAC5D,MAAM,SAAS,GAAG,IAAI,EAAE,CAAC,OAAO,CAAC,CAAC;QAClC,MAAM,KAAK,GACV,OAAO,SAAS,KAAK,QAAQ;YAC5B,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,IAAI,IAAI,MAAM,IAAI,SAAS;gBAC3E,CAAC,CAAE,SAA8B,CAAC,IAAI;gBACtC,CAAC,CAAC,SAAS,CAAC;QAEf,iEAAiE;QACjE,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,qBAAqB,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC;QACzE,CAAC;QAED,MAAM,QAAQ,GAAoB;YACjC,OAAO,EAAE,EAAE,CAAC,EAAE;YACd,IAAI,EAAE,EAAE,CAAC,IAA+B;SACxC,CAAC;QACF,IAAI,IAAI,KAAK,SAAS;YAAE,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;QAC7C,IAAI,KAAK,KAAK,SAAS;YAAE,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC;QAEhD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAC5B,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QACzD,CAAC;aAAM,CAAC;YACP,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC/C,CAAC;QAED,kGAAkG;QAClG,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjC,MAAM,QAAQ,GAAoB;gBACjC,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI;aAC1B,CAAC;YACF,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;gBAC3B,QAAQ,CAAC,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACpD,CAAC;YACD,KAAK,CAAC,IAAI,CAAC;gBACV,EAAE,EAAE,IAAI,WAAW,EAAE,EAAE;gBACvB,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE;gBACxB,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE;gBACxB,IAAI,EAAE,QAAQ;aACd,CAAC,CAAC;QACJ,CAAC;QAED,yDAAyD;QACzD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YACrC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;QACxB,CAAC;IACF,CAAC,CAAC;IAEF,IAAI,CAAC,EAAE,CAAC,CAAC;IAET,OAAO,WAAW,CAAC;QAClB,IAAI,EAAE,UAAU;QAChB,aAAa,EAAE,EAAE,CAAC,EAAE;QACpB,KAAK;QACL,KAAK;KACL,CAAC,CAAC;AACJ,CAAC,CAAC"}
+{"version":3,"file":"machine-to-graph.js","names":[],"sources":["../../src/xstate/machine-to-graph.ts"],"sourcesContent":["import type { AnyStateMachine } from \"xstate\";\nimport { toDirectedGraph, type DirectedGraphNode } from \"xstate/graph\";\nimport { createGraph, type Graph } from \"@statelyai/graph\";\nimport type { MachineNodeData, MachineEdgeData } from \"./machine-types.js\";\nimport { UnknownStateTypeError } from \"../errors.js\";\n\n/**\n * The typed Graph of @statelyai/graph that represents a state machine.\n * It gives you the queries of the hierarchy, the algorithms of a walk, and the tests\n * of the reachability.\n *\n * @example\n * ```typescript\n * import { getChildren, getSuccessors, hasPath } from \"@statelyai/graph\";\n * const graph: MachineGraph = machineToGraph(machine);\n * const children = getChildren(graph, \"myMachine\");\n * ```\n */\nexport type MachineGraph = Graph<MachineNodeData, MachineEdgeData>;\n\n/**\n * Converts an XState v5 state machine into a typed Graph of @statelyai/graph.\n *\n * The pipeline of the conversion is:\n * `XState Machine → toDirectedGraph() → the hierarchy of the DirectedGraphNode objects → createGraph() → Graph`\n *\n * The graph of the result holds three things:\n * - **The hierarchy**: the parentId of a node shows the compound nesting and the parallel nesting of XState\n * - **The edges**: every transition, with its event types and with its optional guard types\n * - **The metadata**: the state type, the meta object, and the route path from the extraction\n *\n * @param machine - The XState v5 state machine, in each shape\n * @returns The typed directed graph, with a MachineNodeData object on each node and a MachineEdgeData object on each edge\n *\n * @example\n * The conversion of a simple machine, and a query of its routes\n * ```typescript\n * import { createMachine } from \"xstate\";\n * import { getChildren, getSuccessors } from \"@statelyai/graph\";\n * import { machineToGraph } from \"@xmachines/play-router/xstate\";\n *\n * const machine = createMachine({\n *   id: \"app\",\n *   initial: \"home\",\n *   states: {\n *     home: { meta: { route: \"/home\" }, on: { GO_ABOUT: \"about\" } },\n *     about: { meta: { route: \"/about\" } },\n *   },\n * });\n *\n * const graph = machineToGraph(machine);\n * const children = getChildren(graph, \"app\"); // [home, about]\n * const successors = getSuccessors(graph, \"app.home\"); // [about]\n * ```\n *\n * @see {@link MachineNodeData} for the shape of the data of a node\n * @see {@link MachineEdgeData} for the shape of the data of an edge\n * @see https://github.com/statelyai/graph for the API reference of @statelyai/graph\n */\n/**\n * The set of the valid XState state types, for the check at run time.\n * It guards against a later change of XState, and against a machine shape that the\n * package does not expect.\n */\nconst VALID_STATE_TYPES: ReadonlySet<string> = new Set([\n\t\"atomic\",\n\t\"compound\",\n\t\"parallel\",\n\t\"final\",\n\t\"history\",\n]);\n\nexport const machineToGraph = (machine: AnyStateMachine): MachineGraph => {\n\tconst dg = toDirectedGraph(machine);\n\n\t// Convert the hierarchy of the DirectedGraphNode objects into a flat array of nodes and a flat array of edges\n\tconst nodes: Array<{ id: string; parentId?: string; data: MachineNodeData }> = [];\n\tconst edges: Array<{\n\t\tid: string;\n\t\tsourceId: string;\n\t\ttargetId: string;\n\t\tdata: MachineEdgeData;\n\t}> = [];\n\tlet edgeCounter = 0;\n\n\tconst walk = (dgNode: DirectedGraphNode, parentId?: string): void => {\n\t\tconst sn = dgNode.stateNode;\n\t\tconst meta = sn.meta as Record<string, unknown> | undefined;\n\t\tconst metaRoute = meta?.[\"route\"];\n\t\tconst route =\n\t\t\ttypeof metaRoute === \"string\"\n\t\t\t\t? metaRoute\n\t\t\t\t: typeof metaRoute === \"object\" && metaRoute !== null && \"path\" in metaRoute\n\t\t\t\t\t? (metaRoute as { path: string }).path\n\t\t\t\t\t: undefined;\n\n\t\t// An assertion at run time: check the state type before the cast\n\t\tif (!VALID_STATE_TYPES.has(sn.type)) {\n\t\t\tthrow new UnknownStateTypeError(sn.type, sn.id, [...VALID_STATE_TYPES]);\n\t\t}\n\n\t\tconst nodeData: MachineNodeData = {\n\t\t\tstateId: sn.id,\n\t\t\ttype: sn.type as MachineNodeData[\"type\"],\n\t\t};\n\t\tif (meta !== undefined) nodeData.meta = meta;\n\t\tif (route !== undefined) nodeData.route = route;\n\n\t\tif (parentId !== undefined) {\n\t\t\tnodes.push({ id: dgNode.id, parentId, data: nodeData });\n\t\t} else {\n\t\t\tnodes.push({ id: dgNode.id, data: nodeData });\n\t\t}\n\n\t\t// Collect the edges of THIS node. An edge is on its source node, and not on the root of the graph\n\t\tfor (const edge of dgNode.edges) {\n\t\t\tconst edgeData: MachineEdgeData = {\n\t\t\t\teventType: edge.label.text,\n\t\t\t};\n\t\t\tif (edge.transition.guard) {\n\t\t\t\tedgeData.guardType = String(edge.transition.guard);\n\t\t\t}\n\t\t\tedges.push({\n\t\t\t\tid: `e${edgeCounter++}`,\n\t\t\t\tsourceId: edge.source.id,\n\t\t\t\ttargetId: edge.target.id,\n\t\t\t\tdata: edgeData,\n\t\t\t});\n\t\t}\n\n\t\t// Walk into the children, with this node as their parent\n\t\tfor (const child of dgNode.children) {\n\t\t\twalk(child, dgNode.id);\n\t\t}\n\t};\n\n\twalk(dg);\n\n\treturn createGraph({\n\t\tmode: \"directed\",\n\t\tinitialNodeId: dg.id,\n\t\tnodes,\n\t\tedges,\n\t});\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgEA,IAAM,oCAAyC,IAAI,IAAI;CACtD;CACA;CACA;CACA;CACA;AACD,CAAC;AAED,IAAa,kBAAkB,YAA2C;CACzE,MAAM,KAAK,gBAAgB,OAAO;CAGlC,MAAM,QAAyE,CAAC;CAChF,MAAM,QAKD,CAAC;CACN,IAAI,cAAc;CAElB,MAAM,QAAQ,QAA2B,aAA4B;EACpE,MAAM,KAAK,OAAO;EAClB,MAAM,OAAO,GAAG;EAChB,MAAM,YAAY,OAAO;EACzB,MAAM,QACL,OAAO,cAAc,WAClB,YACA,OAAO,cAAc,YAAY,cAAc,QAAQ,UAAU,YAC/D,UAA+B,OAChC,KAAA;EAGL,IAAI,CAAC,kBAAkB,IAAI,GAAG,IAAI,GACjC,MAAM,IAAI,sBAAsB,GAAG,MAAM,GAAG,IAAI,CAAC,GAAG,iBAAiB,CAAC;EAGvE,MAAM,WAA4B;GACjC,SAAS,GAAG;GACZ,MAAM,GAAG;EACV;EACA,IAAI,SAAS,KAAA,GAAW,SAAS,OAAO;EACxC,IAAI,UAAU,KAAA,GAAW,SAAS,QAAQ;EAE1C,IAAI,aAAa,KAAA,GAChB,MAAM,KAAK;GAAE,IAAI,OAAO;GAAI;GAAU,MAAM;EAAS,CAAC;OAEtD,MAAM,KAAK;GAAE,IAAI,OAAO;GAAI,MAAM;EAAS,CAAC;EAI7C,KAAK,MAAM,QAAQ,OAAO,OAAO;GAChC,MAAM,WAA4B,EACjC,WAAW,KAAK,MAAM,KACvB;GACA,IAAI,KAAK,WAAW,OACnB,SAAS,YAAY,OAAO,KAAK,WAAW,KAAK;GAElD,MAAM,KAAK;IACV,IAAI,IAAI;IACR,UAAU,KAAK,OAAO;IACtB,UAAU,KAAK,OAAO;IACtB,MAAM;GACP,CAAC;EACF;EAGA,KAAK,MAAM,SAAS,OAAO,UAC1B,KAAK,OAAO,OAAO,EAAE;CAEvB;CAEA,KAAK,EAAE;CAEP,OAAO,YAAY;EAClB,MAAM;EACN,eAAe,GAAG;EAClB;EACA;CACD,CAAC;AACF"}