dirvi-lib 0.6.1 → 0.7.1

package/dist/tree-surfer/tree-node/tree-node.types.d.ts

@@ -1,25 +1,14 @@
-import { z } from 'zod';
-/**
- * Runtime schema for IDs that can be safely represented as serializable
- * primitive values.
- *
- * Strings are accepted as-is. Numbers must be finite, so `NaN`, `Infinity`,
- * and `-Infinity` are rejected.
- *
- * Applications should derive a more specific schema when those constraints
- * are needed.
- */
-export declare const serializableKeySchema: z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
 /**
  * A serializable primitive suitable for use as a stable tree ID.
  *
- * The runtime schema guarantees that numeric values are finite. TypeScript
- * cannot represent the exclusion of `NaN` and infinities from `number`, so
- * values from untrusted sources should be validated with
- * `serializableKeySchema` before being used as IDs.
+ * @remarks
+ *
+ * Numeric IDs must be finite. TypeScript cannot represent the exclusion of
+ * `NaN` and infinities from `number`, so values from untrusted sources should
+ * be validated with `serializableKeySchema`.
  *
  * For application-specific IDs, define a narrower branded schema and derive
- * its type with `z.output`.
+ * its type with `z.output`:
  *
  * @example
  *
@@ -39,61 +28,63 @@ export declare const serializableKeySchema: z.ZodUnion<readonly [z.ZodString, z.
  */
 export type SerializableKey = string | number;
 /**
- * A node with no children.
+ * A node in a tree.
+ *
+ * @remarks
+ *
+ * A node's `id` identifies it among its siblings and is used when resolving
+ * paths through the tree.
+ *
+ * Nodes are discriminated by the shape of their `children` property:
+ *
+ *  - a leaf has no children and does not have a child collection;
+ *  - an open branch has a loaded array of child nodes;
+ *  - a closed branch has children that have not been loaded yet and uses
+ *   `children: null`.
+ *
+ * `Node` is the concrete application-specific node type. It may contain
+ * additional properties, provided that it preserves the leaf-or-branch shape
+ * described by this type.
+ *
+ * The recursive `Node` parameter allows application-specific properties
+ * to be available on every descendant.
+ *
+ * @typeParam Id - The type of node IDs.
+ * @typeParam Node - The application-specific recursive node type.
+ *
+ * @example
+ *
+ * ```ts
+ * type DirectoryEntry = TreeNode<string, DirectoryEntry> & {
+ *   kind: 'file' | 'directory';
+ * };
+ * ```
  */
+export type TreeNode<Id extends SerializableKey, Node extends TreeNode<Id, Node>> = LeafTreeNode<Id> | BranchTreeNode<Id, Node>;
+/** A node with no children. */
 export type LeafTreeNode<Id extends SerializableKey> = {
     id: Id;
     children?: never;
 };
-/**
- * A branch whose children have not been loaded.
- */
-export type ClosedBranchTreeNode<Id extends SerializableKey> = {
+/** A tree node that has children, either loaded or unloaded. */
+export type BranchTreeNode<Id extends SerializableKey, Node extends TreeNode<Id, Node>> = OpenBranchTreeNode<Id, Node> | ClosedBranchTreeNode<Id>;
+/** A branch whose direct children have been loaded. */
+export type OpenBranchTreeNode<Id extends SerializableKey, Node extends TreeNode<Id, Node>> = {
     id: Id;
-    children: null;
+    children: Node[];
 };
-/**
- * A branch whose children have been loaded.
- *
- * TODO Later: Add a dictionary by ID for faster lookup.
- * Then children will just be an array for keeping order.
- */
-export type OpenBranchTreeNode<Id extends SerializableKey, ChildNode extends TreeNode<Id, ChildNode>> = {
+/** A branch whose direct children have not been loaded. */
+export type ClosedBranchTreeNode<Id extends SerializableKey> = {
     id: Id;
-    children: ChildNode[];
+    children: null;
 };
 /**
- * A tree node that has children, either loaded or unloaded.
- */
-export type BranchTreeNode<Id extends SerializableKey, ChildNode extends TreeNode<Id, ChildNode>> = OpenBranchTreeNode<Id, ChildNode> | ClosedBranchTreeNode<Id>;
-/**
- * A node in a tree.
- *
- * `ChildNode` is the concrete application-specific node type. It may contain
- * additional properties, provided that it has the shape of either a leaf or a
- * branch.
- */
-export type TreeNode<Id extends SerializableKey, ChildNode extends TreeNode<Id, ChildNode>> = LeafTreeNode<Id> | BranchTreeNode<Id, ChildNode>;
-/**
- * Selects a value from a node reached by a path.
- *
- * The selector is called only when the complete path exists and identifies
- * a node. Returning `undefined` from the selector is allowed, but is
- * indistinguishable from an unsuccessful lookup in the return value.
- */
-export type TreeNodeSelector<ChildNode, Result> = (node: ChildNode) => Result;
-/**
- * Produces a replacement for a node reached by a path.
+ * Operations for inspecting and immutably updating a tree node array.
  *
- * Returning `undefined` aborts the modification and causes `modifyAtPath`
- * to return `undefined`.
- */
-export type TreeNodeModifier<ChildNode> = (node: ChildNode) => ChildNode | undefined;
-/**
- * Fundamental operations for inspecting and immutably updating a tree forest.
+ * @remarks
  *
- * A forest is represented by an array of root-level nodes. A path is an array
- * of IDs beginning at a root node and continuing through its descendants.
+ * A path is an array of IDs beginning at a root node and continuing through
+ * its descendants.
  *
  * For example, given tree with IDs:
  *
@@ -102,83 +93,65 @@ export type TreeNodeModifier<ChildNode> = (node: ChildNode) => ChildNode | undef
  *
  * the path to `child` is `['root', 'child']`.
  *
- * Path traversal and child lookup are performed by this API so that callers
- * do not depend on the internal child-storage representation or need to
- * iterate over children themselves.
+ * Paths cannot pass through leaves or closed branches. A closed branch may be
+ * the final node in a path. An empty path does not identify a node and is
+ * invalid for both lookup and modification operations.
  *
- * An empty path does not identify a node and is invalid for both lookup and
- * modification operations.
+ * @typeParam Id - The type of node IDs.
+ * @typeParam Node - The application-specific recursive node type.
  */
-export type TreeNodeApi<Id extends SerializableKey, ChildNode extends TreeNode<Id, ChildNode>> = {
-    isLeaf(node: ChildNode): node is ChildNode & LeafTreeNode<Id>;
-    isBranch(node: ChildNode): node is ChildNode & BranchTreeNode<Id, ChildNode>;
-    isClosedBranch(node: BranchTreeNode<Id, ChildNode>): node is ClosedBranchTreeNode<Id>;
-    isOpenBranch(node: BranchTreeNode<Id, ChildNode>): node is OpenBranchTreeNode<Id, ChildNode>;
+export type TreeNodeApi<Id extends SerializableKey, Node extends TreeNode<Id, Node>> = {
+    isLeaf(node: Node): node is Node & LeafTreeNode<Id>;
+    isBranch(node: Node): node is Node & BranchTreeNode<Id, Node>;
+    isClosedBranch(node: BranchTreeNode<Id, Node>): node is ClosedBranchTreeNode<Id>;
+    isOpenBranch(node: BranchTreeNode<Id, Node>): node is OpenBranchTreeNode<Id, Node>;
     /**
-     * Returns the loaded children of an open branch.
+     * Returns the loaded direct children of an open branch.
      *
-     * The returned iterable preserves the branch's sibling order. The method
-     * can only be called after narrowing the branch with `isOpenBranch`.
+     * The children are returned in sibling order. The returned nodes are the
+     * existing nodes and are not cloned.
      *
-     * The returned children are the existing child nodes; they are not cloned.
+     * @param node - An open branch.
+     * @returns The branch's loaded children.
      */
-    getChildren(node: OpenBranchTreeNode<Id, ChildNode>): Iterable<ChildNode>;
+    getChildren(node: OpenBranchTreeNode<Id, Node>): Iterable<Node>;
     /**
-     * Returns the child with the supplied ID.
+     * Finds a direct child by ID.
      *
-     * Returns `undefined` when the branch has no child with that ID.
-     * The returned child is the existing node; it is not cloned.
+     * @param node - An open branch.
+     * @param id - The ID of the child to find.
+     * @returns The existing child, or `undefined` when no matching child exists.
      */
-    getChildById(node: OpenBranchTreeNode<Id, ChildNode>, id: Id): ChildNode | undefined;
+    getChildById(node: OpenBranchTreeNode<Id, Node>, id: Id): Node | undefined;
     /**
-     * Applies `selector` to the node at `path`.
-     *
-     * The path must:
-     *
-     * - be non-empty;
-     * - begin at one of the supplied forest entries;
-     * - contain only IDs that identify existing entries;
-     * - not traverse through a leaf; and
-     * - not traverse through a closed branch.
-     *
-     * A branch at the end of the path is valid even when it is closed.
+     * Applies a selector to the node at a path.
      *
      * The selector is called only after the complete path has been resolved.
-     * This method does not clone the tree or the selected node.
+     * The selected node is not cloned.
      *
-     * Returns `undefined` when the path cannot be resolved, or when the
-     * selector returns `undefined`.
+     * @param entries - The root-level nodes of the forest.
+     * @param path - A non-empty path beginning at a root node.
+     * @param selector - The function to apply to the resolved node.
+     * @returns The selector result, or `undefined` when the path cannot be
+     * resolved or the selector returns `undefined`.
      */
-    getAtPath<Result>(entries: ChildNode[], path: Id[], selector: TreeNodeSelector<ChildNode, Result>): Result | undefined;
+    getAtPath<Result>(entries: Node[], path: Id[], selector: (node: Node) => Result): Result | undefined;
     /**
-     * Immutably modifies the node at `path`.
+     * Immutably replaces the node at a path.
      *
      * The modifier is called only after the complete path has been resolved.
-     * Its return value replaces the target node. Returning `undefined` aborts
-     * the modification.
-     *
-     * The operation creates new arrays and ancestor nodes along the path.
-     * Nodes and arrays unrelated to the path retain their original object
-     * identity. The input forest and its nodes (as objects) are never modified.
-     *
-     * The path must:
-     *
-     * - be non-empty;
-     * - begin at one of the supplied forest entries;
-     * - contain only IDs that identify existing entries;
-     * - not traverse through a leaf; and
-     * - not traverse through a closed branch.
-     *
-     * A leaf or branch, including a closed branch, may be the final target.
+     * Returning `undefined` aborts the modification.
      *
-     * Returns `undefined` when:
+     * New arrays and ancestor nodes are created along the modified path.
+     * Unrelated nodes and arrays retain their original object identity. The
+     * input array is never modified.
      *
-     * - `path` is empty;
-     * - the path does not exist;
-     * - an intermediate node is a leaf;
-     * - an intermediate branch is closed; or
-     * - the modifier returns `undefined`.
+     * @param entries - The root-level nodes of the forest.
+     * @param path - A non-empty path beginning at a root node.
+     * @param modifier - Produces the replacement node.
+     * @returns A new forest, or `undefined` when the path cannot be resolved or
+     * the modifier returns `undefined`.
      */
-    modifyAtPath(entries: ChildNode[], path: Id[], modifier: TreeNodeModifier<ChildNode>): ChildNode[] | undefined;
+    modifyAtPath(entries: Node[], path: Id[], modifier: (node: Node) => Node | undefined): Node[] | undefined;
 };
 //# sourceMappingURL=tree-node.types.d.ts.map

package/dist/tree-surfer/tree-node/tree-node.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tree-node.types.d.ts","sourceRoot":"","sources":["../../../src/tree-surfer/tree-node/tree-node.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;;;GASG;AACH,eAAO,MAAM,qBAAqB,iDAA6C,CAAC;AAEhF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,MAAM,CAAC;AAE9C;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,EAAE,SAAS,eAAe,IAAI;IACrD,EAAE,EAAE,EAAE,CAAC;IACP,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,CAAC,EAAE,SAAS,eAAe,IAAI;IAC7D,EAAE,EAAE,EAAE,CAAC;IACP,QAAQ,EAAE,IAAI,CAAC;CAChB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,CAC5B,EAAE,SAAS,eAAe,EAC1B,SAAS,SAAS,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC,IACvC;IACF,EAAE,EAAE,EAAE,CAAC;IACP,QAAQ,EAAE,SAAS,EAAE,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,CACxB,EAAE,SAAS,eAAe,EAC1B,SAAS,SAAS,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC,IACvC,kBAAkB,CAAC,EAAE,EAAE,SAAS,CAAC,GAAG,oBAAoB,CAAC,EAAE,CAAC,CAAC;AAEjE;;;;;;GAMG;AACH,MAAM,MAAM,QAAQ,CAClB,EAAE,SAAS,eAAe,EAC1B,SAAS,SAAS,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC,IACvC,YAAY,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;AAIrD;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,CAAC,SAAS,EAAE,MAAM,IAAI,CAAC,IAAI,EAAE,SAAS,KAAK,MAAM,CAAC;AAE9E;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,CAAC,SAAS,IAAI,CACxC,IAAI,EAAE,SAAS,KACZ,SAAS,GAAG,SAAS,CAAC;AAE3B;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,WAAW,CACrB,EAAE,SAAS,eAAe,EAC1B,SAAS,SAAS,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC,IACvC;IAGF,MAAM,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,IAAI,SAAS,GAAG,YAAY,CAAC,EAAE,CAAC,CAAC;IAE9D,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,IAAI,SAAS,GAAG,cAAc,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;IAE7E,cAAc,CACZ,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE,SAAS,CAAC,GAClC,IAAI,IAAI,oBAAoB,CAAC,EAAE,CAAC,CAAC;IAEpC,YAAY,CACV,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE,SAAS,CAAC,GAClC,IAAI,IAAI,kBAAkB,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;IAE7C;;;;;;;OAOG;IACH,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC,EAAE,EAAE,SAAS,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;IAE1E;;;;;OAKG;IACH,YAAY,CACV,IAAI,EAAE,kBAAkB,CAAC,EAAE,EAAE,SAAS,CAAC,EACvC,EAAE,EAAE,EAAE,GACL,SAAS,GAAG,SAAS,CAAC;IAEzB;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,CAAC,MAAM,EACd,OAAO,EAAE,SAAS,EAAE,EACpB,IAAI,EAAE,EAAE,EAAE,EACV,QAAQ,EAAE,gBAAgB,CAAC,SAAS,EAAE,MAAM,CAAC,GAC5C,MAAM,GAAG,SAAS,CAAC;IAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,YAAY,CACV,OAAO,EAAE,SAAS,EAAE,EACpB,IAAI,EAAE,EAAE,EAAE,EACV,QAAQ,EAAE,gBAAgB,CAAC,SAAS,CAAC,GACpC,SAAS,EAAE,GAAG,SAAS,CAAC;CAC5B,CAAC"}
+{"version":3,"file":"tree-node.types.d.ts","sourceRoot":"","sources":["../../../src/tree-surfer/tree-node/tree-node.types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,MAAM,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,MAAM,QAAQ,CAClB,EAAE,SAAS,eAAe,EAC1B,IAAI,SAAS,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC,IAC7B,YAAY,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;AAEhD,+BAA+B;AAC/B,MAAM,MAAM,YAAY,CAAC,EAAE,SAAS,eAAe,IAAI;IACrD,EAAE,EAAE,EAAE,CAAC;IACP,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB,CAAC;AAEF,gEAAgE;AAChE,MAAM,MAAM,cAAc,CACxB,EAAE,SAAS,eAAe,EAC1B,IAAI,SAAS,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC,IAC7B,kBAAkB,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,oBAAoB,CAAC,EAAE,CAAC,CAAC;AAK5D,uDAAuD;AACvD,MAAM,MAAM,kBAAkB,CAC5B,EAAE,SAAS,eAAe,EAC1B,IAAI,SAAS,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC,IAC7B;IACF,EAAE,EAAE,EAAE,CAAC;IACP,QAAQ,EAAE,IAAI,EAAE,CAAC;CAClB,CAAC;AAEF,2DAA2D;AAC3D,MAAM,MAAM,oBAAoB,CAAC,EAAE,SAAS,eAAe,IAAI;IAC7D,EAAE,EAAE,EAAE,CAAC;IACP,QAAQ,EAAE,IAAI,CAAC;CAChB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,MAAM,WAAW,CACrB,EAAE,SAAS,eAAe,EAC1B,IAAI,SAAS,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC,IAC7B;IACF,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,IAAI,IAAI,GAAG,YAAY,CAAC,EAAE,CAAC,CAAC;IACpD,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,IAAI,IAAI,GAAG,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IAC9D,cAAc,CACZ,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,GAC7B,IAAI,IAAI,oBAAoB,CAAC,EAAE,CAAC,CAAC;IACpC,YAAY,CACV,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,GAC7B,IAAI,IAAI,kBAAkB,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IAExC;;;;;;;;OAQG;IACH,WAAW,CAAC,IAAI,EAAE,kBAAkB,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAEhE;;;;;;OAMG;IACH,YAAY,CAAC,IAAI,EAAE,kBAAkB,CAAC,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,IAAI,GAAG,SAAS,CAAC;IAE3E;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,MAAM,EACd,OAAO,EAAE,IAAI,EAAE,EACf,IAAI,EAAE,EAAE,EAAE,EACV,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,MAAM,GAC/B,MAAM,GAAG,SAAS,CAAC;IAEtB;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CACV,OAAO,EAAE,IAAI,EAAE,EACf,IAAI,EAAE,EAAE,EAAE,EACV,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,GAAG,SAAS,GACzC,IAAI,EAAE,GAAG,SAAS,CAAC;CACvB,CAAC"}

package/dist/tree-surfer/tree-node/tree-node.types.js

@@ -1,12 +1 @@
-import { z } from 'zod';
-/**
- * Runtime schema for IDs that can be safely represented as serializable
- * primitive values.
- *
- * Strings are accepted as-is. Numbers must be finite, so `NaN`, `Infinity`,
- * and `-Infinity` are rejected.
- *
- * Applications should derive a more specific schema when those constraints
- * are needed.
- */
-export const serializableKeySchema = z.union([z.string(), z.number().finite()]);
+export {};

package/dist/tree-surfer-ui/application/intent-to-effect.d.ts

@@ -1,4 +1,4 @@
-import { SerializableKey, TreeNode, TreeNodeApi } from '../../tree-surfer/tree-node/tree-node.types.js';
+import { SerializableKey, TreeNode, TreeNodeApi } from '../../tree-surfer/index.js';
 import { Effect, Intent } from '../domain/index.js';
 import { CursorApi, State, StateApi } from '../../tree-surfer/index.js';
 export type IntentToEffect<Id extends SerializableKey, BufferNode extends TreeNode<Id, BufferNode>> = (intent: Intent, state: State<Id, BufferNode>) => Effect<Id, BufferNode> | undefined;

package/dist/tree-surfer-ui/application/intent-to-effect.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"intent-to-effect.d.ts","sourceRoot":"","sources":["../../../src/tree-surfer-ui/application/intent-to-effect.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,QAAQ,EACR,WAAW,EACZ,MAAM,gDAAgD,CAAC;AACxD,OAAO,EAAE,MAAM,EAAgB,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAGxE,MAAM,MAAM,cAAc,CACxB,EAAE,SAAS,eAAe,EAC1B,UAAU,SAAS,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC,IACzC,CACF,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,KAAK,CAAC,EAAE,EAAE,UAAU,CAAC,KACzB,MAAM,CAAC,EAAE,EAAE,UAAU,CAAC,GAAG,SAAS,CAAC;AAGxC,wBAAgB,oBAAoB,CAClC,EAAE,SAAS,eAAe,EAC1B,UAAU,SAAS,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC,EAE3C,QAAQ,EAAE,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC,EAClC,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC,EACxB,WAAW,EAAE,WAAW,CAAC,EAAE,EAAE,UAAU,CAAC,GACvC,cAAc,CAAC,EAAE,EAAE,UAAU,CAAC,CA6EhC"}
+{"version":3,"file":"intent-to-effect.d.ts","sourceRoot":"","sources":["../../../src/tree-surfer-ui/application/intent-to-effect.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,QAAQ,EACR,WAAW,EACZ,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,MAAM,EAAgB,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAIxE,MAAM,MAAM,cAAc,CACxB,EAAE,SAAS,eAAe,EAC1B,UAAU,SAAS,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC,IACzC,CACF,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,KAAK,CAAC,EAAE,EAAE,UAAU,CAAC,KACzB,MAAM,CAAC,EAAE,EAAE,UAAU,CAAC,GAAG,SAAS,CAAC;AAGxC,wBAAgB,oBAAoB,CAClC,EAAE,SAAS,eAAe,EAC1B,UAAU,SAAS,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC,EAE3C,QAAQ,EAAE,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC,EAClC,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC,EACxB,WAAW,EAAE,WAAW,CAAC,EAAE,EAAE,UAAU,CAAC,GACvC,cAAc,CAAC,EAAE,EAAE,UAAU,CAAC,CAkEhC"}

package/dist/tree-surfer-ui/application/intent-to-effect.js

@@ -1,3 +1,4 @@
+import { parseCommand } from './parse-command.js';
 // Factory method, since Apis are needed to derive intent
 export function createIntentToEffect(stateApi, cursorApi, treeNodeApi) {
     return (intent, state) => {
@@ -41,24 +42,13 @@ export function createIntentToEffect(stateApi, cursorApi, treeNodeApi) {
                     },
                 };
             case 'executeCommandLine':
-                if (intent.commandLine === ':q') {
-                    return {
-                        effectType: 'quit',
-                        exitMessage: '',
-                    };
-                }
-                if (intent.commandLine === ':evlp') {
-                    return {
-                        effectType: 'emitVisibleLeavesPaths',
-                    };
-                }
-                return {
+                return (parseCommand(intent.commandLine) ?? {
                     effectType: 'setInputState',
                     inputState: {
                         inputMode: 'normal',
                         normalBuffer: '',
                     },
-                };
+                });
         }
     };
 }
@@ -108,6 +98,12 @@ function normalBufferToEffectResult(updatedNormalBuffer) {
 function normalInteractRightToEffect(state, stateApi, cursorApi, treeNodeApi) {
     const currentEntry = stateApi.getNodeAtCursor(state);
     if (currentEntry === undefined) {
+        if (state.cursor.kind === 'fold') {
+            return {
+                effectType: 'peekFold',
+                parentPath: state.cursor.parentPath
+            };
+        }
         return undefined;
     }
     const path = cursorApi.getPath(state.cursor);

package/dist/tree-surfer-ui/application/parse-command.d.ts

@@ -0,0 +1,4 @@
+import { SerializableKey, TreeNode } from '../../tree-surfer/index.js';
+import { Effect } from '../domain/index.js';
+export declare function parseCommand<Id extends SerializableKey, BufferNode extends TreeNode<Id, BufferNode>>(commandLine: string): Effect<Id, BufferNode> | undefined;
+//# sourceMappingURL=parse-command.d.ts.map

package/dist/tree-surfer-ui/application/parse-command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-command.d.ts","sourceRoot":"","sources":["../../../src/tree-surfer-ui/application/parse-command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACvE,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAI5C,wBAAgB,YAAY,CAC1B,EAAE,SAAS,eAAe,EAC1B,UAAU,SAAS,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC,EAC3C,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC,EAAE,EAAE,UAAU,CAAC,GAAG,SAAS,CAqDzD"}

package/dist/tree-surfer-ui/application/parse-command.js

@@ -0,0 +1,48 @@
+const DEFAULT_VIEW_NAME = 'default';
+export function parseCommand(commandLine) {
+    const command = commandLine.trim();
+    switch (command) {
+        case ':q':
+            return {
+                effectType: 'quit',
+                exitMessage: '',
+            };
+        case ':evlp':
+            return {
+                effectType: 'emitVisibleLeavesPaths',
+            };
+    }
+    /*
+     * Vim-style view commands:
+     *
+     *   :mkview!
+     *   :mkview! project
+     *   :loadview
+     *   :loadview project
+     *
+     * The name may contain spaces, so capture the remainder of the command
+     * instead of splitting on whitespace.
+     *
+     * TODO Later: mkview that checks if same named view already saved
+     */
+    const viewCommand = command.match(/^:(mkview!|loadview)(?:\s+(.+?))?$/);
+    if (viewCommand === null) {
+        return undefined;
+    }
+    const commandName = viewCommand[1];
+    const suppliedName = viewCommand[2]?.trim();
+    const name = suppliedName || DEFAULT_VIEW_NAME;
+    switch (commandName) {
+        case 'mkview!':
+            return {
+                effectType: 'saveView',
+                name,
+                overwrite: true,
+            };
+        case 'loadview':
+            return {
+                effectType: 'loadView',
+                name,
+            };
+    }
+}

package/dist/tree-surfer-ui/domain/effect.d.ts

@@ -6,6 +6,16 @@ export type Effect<Id extends SerializableKey, BufferNode extends TreeNode<Id, B
 } | {
     effectType: 'loadBranchEntries';
     path: Id[];
+} | {
+    effectType: 'peekFold';
+    parentPath: readonly Id[];
+} | {
+    effectType: 'saveView';
+    name: string;
+    overwrite: boolean;
+} | {
+    effectType: 'loadView';
+    name: string;
 } | {
     effectType: 'emitVisibleLeavesPaths';
 } | {

package/dist/tree-surfer-ui/domain/effect.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"effect.d.ts","sourceRoot":"","sources":["../../../src/tree-surfer-ui/domain/effect.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EACL,eAAe,EACf,QAAQ,EACT,MAAM,4BAA4B,CAAC;AAGpC,MAAM,MAAM,MAAM,CAChB,EAAE,SAAS,eAAe,EAC1B,UAAU,SAAS,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC,IAEzC;IACE,UAAU,EAAE,sBAAsB,CAAC;IACnC,MAAM,EAAE,YAAY,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;CACtC,GACD;IACE,UAAU,EAAE,mBAAmB,CAAC;IAChC,IAAI,EAAE,EAAE,EAAE,CAAC;CACZ,GACD;IACE,UAAU,EAAE,wBAAwB,CAAC;CACtC,GACD;IACE,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;CACrB,GACD;IACE,UAAU,EAAE,eAAe,CAAC;IAC5B,UAAU,EAAE,UAAU,CAAC;CACxB,CAAC;AAGN,MAAM,MAAM,YAAY,CACtB,EAAE,SAAS,eAAe,EAC1B,UAAU,SAAS,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC,IAEzC;IACE,gBAAgB,EAAE,WAAW,CAAC;CAC/B,GACD;IACE,gBAAgB,EAAE,WAAW,CAAC;CAC/B,GACD;IACE,gBAAgB,EAAE,kBAAkB,CAAC;IACrC,IAAI,EAAE,EAAE,EAAE,CAAC;IACX,OAAO,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;CAC9B,GACD;IACE,gBAAgB,EAAE,kBAAkB,CAAC;CACtC,GACD;IACE,gBAAgB,EAAE,MAAM,CAAC;CAC1B,GACD;IACE,gBAAgB,EAAE,QAAQ,CAAC;CAC5B,GACD;IACE,gBAAgB,EAAE,YAAY,CAAC;CAChC,CAAC"}
+{"version":3,"file":"effect.d.ts","sourceRoot":"","sources":["../../../src/tree-surfer-ui/domain/effect.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAEvE,MAAM,MAAM,MAAM,CAChB,EAAE,SAAS,eAAe,EAC1B,UAAU,SAAS,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC,IAEzC;IACE,UAAU,EAAE,sBAAsB,CAAC;IACnC,MAAM,EAAE,YAAY,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;CACtC,GACD;IACE,UAAU,EAAE,mBAAmB,CAAC;IAChC,IAAI,EAAE,EAAE,EAAE,CAAC;CACZ,GACD;IACE,UAAU,EAAE,UAAU,CAAC;IACvB,UAAU,EAAE,SAAS,EAAE,EAAE,CAAC;CAC3B,GACD;IACE,UAAU,EAAE,UAAU,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,OAAO,CAAC;CACpB,GACD;IACE,UAAU,EAAE,UAAU,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;CACd,GACD;IACE,UAAU,EAAE,wBAAwB,CAAC;CACtC,GACD;IACE,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;CACrB,GACD;IACE,UAAU,EAAE,eAAe,CAAC;IAC5B,UAAU,EAAE,UAAU,CAAC;CACxB,CAAC;AAGN,MAAM,MAAM,YAAY,CACtB,EAAE,SAAS,eAAe,EAC1B,UAAU,SAAS,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC,IAEzC;IACE,gBAAgB,EAAE,WAAW,CAAC;CAC/B,GACD;IACE,gBAAgB,EAAE,WAAW,CAAC;CAC/B,GACD;IACE,gBAAgB,EAAE,kBAAkB,CAAC;IACrC,IAAI,EAAE,EAAE,EAAE,CAAC;IACX,OAAO,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;CAC9B,GACD;IACE,gBAAgB,EAAE,kBAAkB,CAAC;CACtC,GACD;IACE,gBAAgB,EAAE,MAAM,CAAC;CAC1B,GACD;IACE,gBAAgB,EAAE,QAAQ,CAAC;CAC5B,GACD;IACE,gBAAgB,EAAE,YAAY,CAAC;CAChC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dirvi-lib",
-  "version": "0.6.1",
+  "version": "0.7.1",
   "description": "Dependency for dirvi apps.",
   "license": "LGPL-3.0-or-later",
   "type": "module",
@@ -20,6 +20,7 @@
     "clean": "rm -rf dist",
     "build": "pnpm clean && tsc",
     "typecheck": "tsc --noEmit",
-    "format": "prettier . --write"
+    "format": "prettier . --write",
+    "docs": "typedoc"
   }
 }

package/dist/domain/posix-node.d.ts

@@ -1,29 +0,0 @@
-import { z } from 'zod';
-import { UnixPath } from './unix-path.js';
-import { Cursor, State } from '../tree-surfer/index.js';
-import { FoldNode } from '../tree-surfer/fold-node/fold-node.types.js';
-import { NavNode } from '../tree-surfer/nav-node/nav-node.types.js';
-export declare const PosixNameSchema: z.ZodString;
-export type PosixName = z.output<typeof PosixNameSchema>;
-export type PosixNode = {
-    kind: 'file';
-    id: PosixName;
-} | {
-    kind: 'symlink';
-    id: PosixName;
-    target: UnixPath;
-} | {
-    kind: 'directory';
-    id: PosixName;
-    children: PosixNode[] | null;
-};
-export declare const PosixNodeApi: import("../tree-surfer/index.js").TreeNodeApi<string, PosixNode>;
-export type PosixCursor = Cursor<PosixName>;
-export declare const PosixCursorApi: import("../tree-surfer/cursor.js").CursorApi<string>;
-export type PosixFoldNode = FoldNode<PosixName>;
-export declare const PosixFoldNodeApi: import("../tree-surfer/index.js").FoldNodeApi<string>;
-export type PosixNavNode = NavNode<PosixName, PosixNode>;
-export declare const PosixNavApi: import("../tree-surfer/index.js").NavNodeApi<string, PosixNode>;
-export type PosixState = State<PosixName, PosixNode>;
-export declare const PosixStateApi: import("../tree-surfer/state.js").StateApi<string, PosixNode>;
-//# sourceMappingURL=posix-node.d.ts.map

package/dist/domain/posix-node.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"posix-node.d.ts","sourceRoot":"","sources":["../../src/domain/posix-node.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,OAAO,EAGL,MAAM,EACN,KAAK,EACN,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,6CAA6C,CAAC;AAEvE,OAAO,EAAE,OAAO,EAAE,MAAM,2CAA2C,CAAC;AAIpE,eAAO,MAAM,eAAe,aAQxB,CAAC;AAEL,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,eAAe,CAAC,CAAC;AAGzD,MAAM,MAAM,SAAS,GACjB;IACE,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,SAAS,CAAC;CACf,GACD;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,EAAE,EAAE,SAAS,CAAC;IACd,MAAM,EAAE,QAAQ,CAAC;CAClB,GACD;IACE,IAAI,EAAE,WAAW,CAAC;IAClB,EAAE,EAAE,SAAS,CAAC;IACd,QAAQ,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;CAC9B,CAAC;AAEN,eAAO,MAAM,YAAY,kEAA4C,CAAC;AAStE,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;AAE5C,eAAO,MAAM,cAAc,sDAA+B,CAAC;AAG3D,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;AAEhD,eAAO,MAAM,gBAAgB,uDAAiC,CAAC;AAG/D,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;AAEzD,eAAO,MAAM,WAAW,iEAIvB,CAAC;AAGF,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;AAErD,eAAO,MAAM,aAAa,+DAKzB,CAAC"}

package/dist/domain/posix-node.js

@@ -1,20 +0,0 @@
-import { z } from 'zod';
-import { createTreeNodeApi } from '../tree-surfer/tree-node/tree-node.impl.js';
-import { createCursorApi, createStateApi, } from '../tree-surfer/index.js';
-import { createFoldNodeApi } from '../tree-surfer/fold-node/fold-node.impl.js';
-import { createNavNodeApi } from '../tree-surfer/nav-node/nav-node.impl.js';
-// Name
-export const PosixNameSchema = z
-    .string()
-    .min(1)
-    .refine((value) => !value.includes('/'), {
-    message: "Entry name must not contain '/'",
-})
-    .refine((value) => value !== '.' && value !== '..', {
-    message: "Entry name cannot be '.' or '..'",
-});
-export const PosixNodeApi = createTreeNodeApi();
-export const PosixCursorApi = createCursorApi();
-export const PosixFoldNodeApi = createFoldNodeApi();
-export const PosixNavApi = createNavNodeApi(PosixNodeApi, PosixFoldNodeApi, PosixCursorApi);
-export const PosixStateApi = createStateApi(PosixNodeApi, PosixFoldNodeApi, PosixCursorApi, PosixNavApi);

package/dist/domain/unix-path.d.ts

@@ -1,6 +0,0 @@
-import { z } from 'zod';
-export declare const UnixPathSchema: z.ZodString;
-export type UnixPath = z.output<typeof UnixPathSchema>;
-export declare const UnixAbsolutePathSchema: z.ZodString;
-export type UnixAbsolutePath = z.output<typeof UnixAbsolutePathSchema>;
-//# sourceMappingURL=unix-path.d.ts.map

package/dist/domain/unix-path.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"unix-path.d.ts","sourceRoot":"","sources":["../../src/domain/unix-path.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,eAAO,MAAM,cAAc,aAKvB,CAAC;AAEL,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,cAAc,CAAC,CAAC;AAEvD,eAAO,MAAM,sBAAsB,aAKlC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,sBAAsB,CAAC,CAAC"}

package/dist/domain/unix-path.js

@@ -1,11 +0,0 @@
-import { z } from 'zod';
-// UNIX PATHS
-export const UnixPathSchema = z
-    .string()
-    .min(1)
-    .refine((value) => !value.includes('\0'), {
-    message: 'Unix paths must not contain null bytes',
-});
-export const UnixAbsolutePathSchema = UnixPathSchema.refine((value) => value.startsWith('/'), {
-    message: 'Path must be an absolute Unix path',
-});

package/dist/tree-surfer/state.d.ts

@@ -1,19 +0,0 @@
-import { Cursor, CursorApi } from './cursor.js';
-import { SerializableKey, TreeNode, TreeNodeApi } from './tree-node/tree-node.types.js';
-import { FoldNodeApi, FoldNodeRoot } from './fold-node/fold-node.types.js';
-import { NavNodeApi } from './nav-node/nav-node.types.js';
-export type State<Id extends SerializableKey, BufferNode extends TreeNode<Id, BufferNode>> = {
-    buffer: BufferNode[];
-    foldNode: FoldNodeRoot<Id>;
-    cursor: Cursor<Id>;
-};
-export type StateApi<Id extends SerializableKey, BufferNode extends TreeNode<Id, BufferNode>> = {
-    getNodeAtCursor(state: State<Id, BufferNode>): BufferNode | undefined;
-    /**
-     * Reloads the root and all descendant branches that were loaded in the
-     * previous state.
-     */
-    resync(oldState: State<Id, BufferNode>, loadBranches: (path: Id[]) => Promise<BufferNode[]>): Promise<State<Id, BufferNode>>;
-};
-export declare function createStateApi<Id extends SerializableKey, BufferNode extends TreeNode<Id, BufferNode>>(treeNodeApi: TreeNodeApi<Id, BufferNode>, foldNodeApi: FoldNodeApi<Id>, cursorApi: CursorApi<Id>, navNodeApi: NavNodeApi<Id, BufferNode>): StateApi<Id, BufferNode>;
-//# sourceMappingURL=state.d.ts.map

package/dist/tree-surfer/state.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../src/tree-surfer/state.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,SAAS,EAAc,MAAM,aAAa,CAAC;AAC5D,OAAO,EACL,eAAe,EACf,QAAQ,EACR,WAAW,EACZ,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAEL,WAAW,EACX,YAAY,EACb,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE1D,MAAM,MAAM,KAAK,CACf,EAAE,SAAS,eAAe,EAC1B,UAAU,SAAS,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC,IACzC;IACF,MAAM,EAAE,UAAU,EAAE,CAAC;IACrB,QAAQ,EAAE,YAAY,CAAC,EAAE,CAAC,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,QAAQ,CAClB,EAAE,SAAS,eAAe,EAC1B,UAAU,SAAS,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC,IACzC;IACF,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,EAAE,UAAU,CAAC,GAAG,UAAU,GAAG,SAAS,CAAC;IAEtE;;;OAGG;IACH,MAAM,CACJ,QAAQ,EAAE,KAAK,CAAC,EAAE,EAAE,UAAU,CAAC,EAC/B,YAAY,EAAE,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,OAAO,CAAC,UAAU,EAAE,CAAC,GAClD,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC;CACnC,CAAC;AAEF,wBAAgB,cAAc,CAC5B,EAAE,SAAS,eAAe,EAC1B,UAAU,SAAS,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC,EAE3C,WAAW,EAAE,WAAW,CAAC,EAAE,EAAE,UAAU,CAAC,EACxC,WAAW,EAAE,WAAW,CAAC,EAAE,CAAC,EAC5B,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC,EACxB,UAAU,EAAE,UAAU,CAAC,EAAE,EAAE,UAAU,CAAC,GACrC,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC,CAgK1B"}