Type trrack tree output

Author: JackWilb

apps/react-trrack-example/src/app/App.tsx

@@ -8,7 +8,7 @@ import {
   Typography,
 } from '@mui/material';
 
-import { HistoryTree, type HistoryNode } from './components/HistoryTree';
+import { HistoryTree } from './components/HistoryTree';
 import { Navbar } from './components/Navbar';
 import { useTrrackTaskManager } from './store/trrack';
 
@@ -67,7 +67,7 @@ function App() {
         </List>
         <HistoryTree
           currentNodeId={trrack.current.id}
-          root={trrack.tree() as HistoryNode}
+          root={trrack.tree()}
           onSelect={(id) => trrackManager.trrack.to(id)}
         />
       </Box>

apps/react-trrack-example/src/app/components/HistoryTree.tsx

@@ -1,10 +1,7 @@
+import { type TrrackTreeNode } from '@trrack/core';
 import { List, ListItemButton, ListItemText } from '@mui/material';
 
-export type HistoryNode = {
-  id: string;
-  label: string;
-  children: HistoryNode[];
-};
+export type HistoryNode = TrrackTreeNode<unknown, string>;
 
 function HistoryTreeBranch({
   currentNodeId,

packages/core/src/provenance/trrack.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { applyPatch, compare, deepClone, Operation } from 'fast-json-patch';
-import { RecordActionArgs, Trrack } from './types';
+import { RecordActionArgs, Trrack, TrrackTreeNode } from './types';
 import { PayloadAction } from '../action';
 
 import { initEventManager } from '../event';
@@ -464,15 +464,10 @@ function isNextNodeUp(
     );
 }
 
-type TreeNode = Omit<ProvenanceNode<any, any>, 'children' | 'name'> & {
-    name: string;
-    children: TreeNode[];
-};
-
 function getTreeFromNode(
     node: ProvenanceNode<any, any>,
     nodes: Nodes<any, any>
-): TreeNode {
+): TrrackTreeNode<any, any> {
     return {
         ...node,
         children: node.children.map((n) => getTreeFromNode(nodes[n], nodes)),

packages/core/src/provenance/types.ts

@@ -22,6 +22,14 @@ export type RecordActionArgs<State, Event extends string> = {
     onlySideEffects?: boolean;
 };
 
+export type TrrackTreeNode<State, Event extends string> = Omit<
+    ProvenanceNode<State, Event>,
+    'children'
+> & {
+    name: string;
+    children: TrrackTreeNode<State, Event>[];
+};
+
 export interface Trrack<State, Event extends string> {
     registry: Registry<Event>;
     isTraversing: boolean;
@@ -72,7 +80,7 @@ export interface Trrack<State, Event extends string> {
         skipOnNew?: boolean
     ): UnsubscribeCurrentChangeListener;
     done(): void;
-    tree(): unknown;
+    tree(): TrrackTreeNode<State, Event>;
     on(event: TrrackEvents, listener: (args?: unknown) => void): void;
     export(): string;
     exportObject(): ProvenanceGraph<State, Event>;