dirvi-lib 0.7.0 → 0.8.0

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

@@ -1,11 +1,14 @@
-import type { InputState } from './input-state.js';
+import type { InputModeState } from './input-mode-state.js';
 import { SerializableKey, TreeNode } from '../../tree-surfer/index.js';
-export type Effect<Id extends SerializableKey, BufferNode extends TreeNode<Id, BufferNode>> = {
+export type Effect<Id extends SerializableKey, Node extends TreeNode<Id, Node>> = {
     effectType: 'dispatchEffectAction';
-    action: EffectAction<Id, BufferNode>;
+    action: EffectAction<Id, Node>;
 } | {
     effectType: 'loadBranchEntries';
     path: Id[];
+} | {
+    effectType: 'peekFold';
+    parentPath: readonly Id[];
 } | {
     effectType: 'saveView';
     name: string;
@@ -20,23 +23,21 @@ export type Effect<Id extends SerializableKey, BufferNode extends TreeNode<Id, B
     exitMessage: string;
 } | {
     effectType: 'setInputState';
-    inputState: InputState;
+    inputState: InputModeState;
 };
-export type EffectAction<Id extends SerializableKey, BufferNode extends TreeNode<Id, BufferNode>> = {
+export type EffectAction<Id extends SerializableKey, Node extends TreeNode<Id, Node>> = {
     effectActionType: 'nextEntry';
 } | {
     effectActionType: 'prevEntry';
 } | {
     effectActionType: 'setBranchEntries';
     path: Id[];
-    entries: BufferNode[] | null;
+    entries: Node[] | null;
 } | {
     effectActionType: 'navigateToParent';
 } | {
     effectActionType: 'fold';
 } | {
     effectActionType: 'unfold';
-} | {
-    effectActionType: 'toggleFold';
 };
 //# sourceMappingURL=effect.d.ts.map

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,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,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"}
+{"version":3,"file":"effect.d.ts","sourceRoot":"","sources":["../../../src/tree-surfer-ui/domain/effect.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAEvE,MAAM,MAAM,MAAM,CAChB,EAAE,SAAS,eAAe,EAC1B,IAAI,SAAS,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC,IAE7B;IACE,UAAU,EAAE,sBAAsB,CAAC;IACnC,MAAM,EAAE,YAAY,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;CAChC,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,cAAc,CAAC;CAC5B,CAAC;AAGN,MAAM,MAAM,YAAY,CACtB,EAAE,SAAS,eAAe,EAC1B,IAAI,SAAS,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC,IAE7B;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,IAAI,EAAE,GAAG,IAAI,CAAC;CACxB,GACD;IACE,gBAAgB,EAAE,kBAAkB,CAAC;CACtC,GACD;IACE,gBAAgB,EAAE,MAAM,CAAC;CAC1B,GACD;IACE,gBAAgB,EAAE,QAAQ,CAAC;CAC5B,CAAC"}

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

@@ -1,5 +1,5 @@
 export * from './effect.js';
-export * from './input-state.js';
+export * from './input-mode-state.js';
 export * from './intent.js';
 export * from './user-input.js';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/tree-surfer-ui/domain/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/tree-surfer-ui/domain/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC"}

package/dist/tree-surfer-ui/domain/index.js

@@ -1,4 +1,4 @@
 export * from './effect.js';
-export * from './input-state.js';
+export * from './input-mode-state.js';
 export * from './intent.js';
 export * from './user-input.js';

package/dist/tree-surfer-ui/domain/{input-state.d.ts → input-mode-state.d.ts}

@@ -1,8 +1,8 @@
-export type InputState = {
+export type InputModeState = {
     inputMode: 'normal';
     normalBuffer: string;
 } | {
     inputMode: 'command';
     commandLine: string;
 };
-//# sourceMappingURL=input-state.d.ts.map
+//# sourceMappingURL=input-mode-state.d.ts.map

package/dist/tree-surfer-ui/domain/input-mode-state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"input-mode-state.d.ts","sourceRoot":"","sources":["../../../src/tree-surfer-ui/domain/input-mode-state.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GACtB;IACE,SAAS,EAAE,QAAQ,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB,GACD;IACE,SAAS,EAAE,SAAS,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dirvi-lib",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "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/tree-surfer/state.d.ts

@@ -1,25 +0,0 @@
-import { z } from 'zod';
-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 declare function createStateSchema<Id extends SerializableKey, BufferNode extends TreeNode<Id, BufferNode>>(bufferNodeSchema: z.ZodType<BufferNode>, foldNodeRootSchema: z.ZodType<State<Id, BufferNode>['foldNode']>, cursorSchema: z.ZodType<State<Id, BufferNode>['cursor']>): z.ZodObject<{
-    buffer: z.ZodArray<z.ZodType<BufferNode, unknown, z.core.$ZodTypeInternals<BufferNode, unknown>>>;
-    foldNode: z.ZodType<FoldNodeRoot<Id>, unknown, z.core.$ZodTypeInternals<FoldNodeRoot<Id>, unknown>>;
-    cursor: z.ZodType<Cursor<Id>, unknown, z.core.$ZodTypeInternals<Cursor<Id>, unknown>>;
-}, z.core.$strip>;
-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,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,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;AAG1D,wBAAgB,iBAAiB,CAC/B,EAAE,SAAS,eAAe,EAC1B,UAAU,SAAS,QAAQ,CAAC,EAAE,EAAE,UAAU,CAAC,EAE3C,gBAAgB,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,EACvC,kBAAkB,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC,UAAU,CAAC,CAAC,EAChE,YAAY,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAC;;;;kBAOzD;AAGD,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"}

package/dist/tree-surfer/state.js

@@ -1,118 +0,0 @@
-import { z } from 'zod';
-import { CursorKind } from './cursor.js';
-// Schema
-export function createStateSchema(bufferNodeSchema, foldNodeRootSchema, cursorSchema) {
-    return z.object({
-        buffer: z.array(bufferNodeSchema),
-        foldNode: foldNodeRootSchema,
-        cursor: cursorSchema,
-    });
-}
-export function createStateApi(treeNodeApi, foldNodeApi, cursorApi, navNodeApi) {
-    // Helpers
-    /**
-     * Create a new buffer and fold node at this level.
-     *
-     * Works on fold root and child level through the generic.
-     */
-    async function reload(oldBuffer, oldFoldNode, // Can be FoldNode too
-    parentPath, loadBranches) {
-        let newBufferAtRoot = await loadBranches(parentPath);
-        let newFoldNode = oldFoldNode; // Start with assumption of no changes
-        /**
-         * Reload descendants that were already loaded in the old buffer.
-         *
-         * Fold membership is represented by IDs in `folds`, so it remains
-         * valid across a reload without rebuilding an entry array.
-         */
-        for (const oldEntry of oldBuffer) {
-            // If it wasn't an open branch, then there's no need to reload descendants.
-            // Either the new entry is a leaf or an unopen branch.
-            if (!treeNodeApi.isBranch(oldEntry) ||
-                !treeNodeApi.isOpenBranch(oldEntry)) {
-                continue;
-            }
-            // Get the entry being updated, in the new buffer
-            const newEntry = treeNodeApi.getAtPath(newBufferAtRoot, [oldEntry.id], (entry) => entry);
-            // If it doesn't exist (an open branch was deleted) then move on
-            if (newEntry === undefined) {
-                continue;
-            }
-            // The old entry may have changed into a leaf.
-            // A newly loaded branch is normally closed here because loadBranches
-            // returns flat entries, and the descendants are to be attached below.
-            if (!treeNodeApi.isBranch(newEntry)) {
-                continue;
-            }
-            const oldChildFoldNode = oldFoldNode === undefined
-                ? undefined
-                : foldNodeApi.getChildById(oldFoldNode, oldEntry.id);
-            const entryPath = [...parentPath, oldEntry.id];
-            const reloadedChild = await reload([...treeNodeApi.getChildren(oldEntry)], oldChildFoldNode, entryPath, loadBranches);
-            const updatedBuffer = treeNodeApi.modifyAtPath(newBufferAtRoot, [oldEntry.id], (entry) => {
-                // The entry may be closed: loadBranches normally returns branches
-                // with `branches: null`. We are turning it back into an open branch.
-                if (!treeNodeApi.isBranch(entry)) {
-                    return undefined;
-                }
-                return {
-                    ...entry,
-                    branches: reloadedChild.buffer,
-                };
-            });
-            if (updatedBuffer !== undefined) {
-                newBufferAtRoot = updatedBuffer;
-            }
-        }
-        return {
-            buffer: newBufferAtRoot,
-            foldNode: newFoldNode,
-        };
-    }
-    /**
-     * Currently the cursor just goes to the first entry at root if
-     * not all root entries are folded, otherwise the fold.
-     *
-     * TODO: Cursor policy:
-     * 1. Keep the exact cursor if it survives,
-     * 2. Otherwise, choose the deepest surviving ancestor entry,
-     * 3. Otherwise, choose the nearest preceding old cursor that still survives,
-     * 4. Otherwise, choose the first new cursor.
-     * 5. If no cursor exists, use the root fold cursor.
-     */
-    function resyncCursor(oldState, newBuffer, newFoldNode) {
-        const navigation = navNodeApi.from(newBuffer, newFoldNode);
-        return navNodeApi.cursors(navigation)[0];
-    }
-    return {
-        getNodeAtCursor(state) {
-            const path = cursorApi.getPath(state.cursor);
-            if (path === undefined) {
-                // The cursor is positioned on a fold rather than an entry.
-                return undefined;
-            }
-            return treeNodeApi.getAtPath(state.buffer, path, (node) => node);
-        },
-        async resync(oldState, loadBranches) {
-            const reloaded = await reload(oldState.buffer, oldState.foldNode, [], loadBranches);
-            /*
-             * `oldState.foldNode` is always present. At the root reload starts with
-             * that node, so `reloaded.foldNode` should also always be present.
-             *
-             * The fallback expresses the State invariant while satisfying the
-             * optional return type needed by recursive child reloads.
-             */
-            const foldNode = reloaded.foldNode ?? oldState.foldNode;
-            const cursor = resyncCursor(oldState, reloaded.buffer, foldNode) ?? {
-                kind: CursorKind.Fold,
-                parentPath: [],
-            };
-            return {
-                ...oldState,
-                buffer: reloaded.buffer,
-                foldNode,
-                cursor,
-            };
-        },
-    };
-}

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

@@ -1 +0,0 @@
-{"version":3,"file":"input-state.d.ts","sourceRoot":"","sources":["../../../src/tree-surfer-ui/domain/input-state.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAClB;IACE,SAAS,EAAE,QAAQ,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB,GACD;IACE,SAAS,EAAE,SAAS,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC"}