dirvi-lib 0.3.0 → 0.4.0

package/dist/domain/unix-entry.js

@@ -1,96 +1,108 @@
 import { z } from 'zod';
 // UNIX ENTRY
 export const UnixEntryNameSchema = z
-    .string()
-    .min(1)
-    .refine((value) => !value.includes('/'), {
+  .string()
+  .min(1)
+  .refine((value) => !value.includes('/'), {
     message: "Entry name must not contain '/'",
-})
-    .refine((value) => value !== '.' && value !== '..', {
+  })
+  .refine((value) => value !== '.' && value !== '..', {
     message: "Entry name cannot be '.' or '..'",
-});
+  });
 export function entryNamesEqual(left, right) {
-    return (left.length === right.length &&
-        left.every((name, index) => name === right[index]));
+  return (
+    left.length === right.length &&
+    left.every((name, index) => name === right[index])
+  );
 }
 export const UnixEntry = {
-    // Query-Like
-    getEntryAtPath(entries, path) {
-        if (path.length === 0) {
-            return undefined;
-        }
-        let entry;
-        for (const [index, name] of path.entries()) {
-            entry = entries.find((candidate) => candidate.name === name);
-            if (entry === undefined) {
-                return undefined;
-            }
-            if (index === path.length - 1) {
-                return entry;
-            }
-            if (entry.kind !== 'directory' || entry.entries === undefined) {
-                return undefined;
-            }
-            entries = entry.entries;
-        }
+  // Query-Like
+  getEntryAtPath(entries, path) {
+    if (path.length === 0) {
+      return undefined;
+    }
+    let entry;
+    for (const [index, name] of path.entries()) {
+      entry = entries.find((candidate) => candidate.name === name);
+      if (entry === undefined) {
         return undefined;
-    },
-    getEntriesAtPath(entries, path) {
-        if (path.length === 0) {
-            return entries;
-        }
-        const entry = UnixEntry.getEntryAtPath(entries, path);
-        if (entry?.kind !== 'directory') {
-            return undefined;
-        }
-        return entry.entries;
-    },
-    // Command/Modifer-Like
-    setEntriesAtPath(entries, path, newEntries) {
-        const [currentName, ...remainingPath] = path;
-        if (currentName === undefined) {
-            throw new Error('Cannot update directory entries with an empty path');
-        }
-        let found = false;
-        const updatedEntries = entries.map((entry) => {
-            if (entry.name !== currentName) {
-                return entry;
-            }
-            found = true;
-            if (remainingPath.length === 0) {
-                if (entry.kind !== 'directory') {
-                    throw new Error(`Cannot update entries for non-directory entry "${entry.name}"`);
-                }
-                return {
-                    ...entry,
-                    entries: newEntries,
-                };
-            }
-            if (entry.kind !== 'directory') {
-                throw new Error(`Cannot descend through non-directory entry "${entry.name}"`);
-            }
-            if (entry.entries === undefined) {
-                throw new Error(`Cannot descend into unexpanded directory "${entry.name}"`);
-            }
-            return {
-                ...entry,
-                entries: UnixEntry.setEntriesAtPath(entry.entries, remainingPath, newEntries),
-            };
-        });
-        if (!found) {
-            throw new Error(`Directory path does not contain entry "${currentName}"`);
+      }
+      if (index === path.length - 1) {
+        return entry;
+      }
+      if (entry.kind !== 'directory' || entry.entries === undefined) {
+        return undefined;
+      }
+      entries = entry.entries;
+    }
+    return undefined;
+  },
+  getEntriesAtPath(entries, path) {
+    if (path.length === 0) {
+      return entries;
+    }
+    const entry = UnixEntry.getEntryAtPath(entries, path);
+    if (entry?.kind !== 'directory') {
+      return undefined;
+    }
+    return entry.entries;
+  },
+  // Command/Modifer-Like
+  setEntriesAtPath(entries, path, newEntries) {
+    const [currentName, ...remainingPath] = path;
+    if (currentName === undefined) {
+      throw new Error('Cannot update directory entries with an empty path');
+    }
+    let found = false;
+    const updatedEntries = entries.map((entry) => {
+      if (entry.name !== currentName) {
+        return entry;
+      }
+      found = true;
+      if (remainingPath.length === 0) {
+        if (entry.kind !== 'directory') {
+          throw new Error(
+            `Cannot update entries for non-directory entry "${entry.name}"`,
+          );
         }
-        return updatedEntries;
-    },
+        return {
+          ...entry,
+          entries: newEntries,
+        };
+      }
+      if (entry.kind !== 'directory') {
+        throw new Error(
+          `Cannot descend through non-directory entry "${entry.name}"`,
+        );
+      }
+      if (entry.entries === undefined) {
+        throw new Error(
+          `Cannot descend into unexpanded directory "${entry.name}"`,
+        );
+      }
+      return {
+        ...entry,
+        entries: UnixEntry.setEntriesAtPath(
+          entry.entries,
+          remainingPath,
+          newEntries,
+        ),
+      };
+    });
+    if (!found) {
+      throw new Error(`Directory path does not contain entry "${currentName}"`);
+    }
+    return updatedEntries;
+  },
 };
 export const UnixEntryPath = {
-    equal(left, right) {
-        return entryNamesEqual(left, right);
-    },
-    isStrictPathPrefix(prefix, path) {
-        if (path.length <= prefix.length) {
-            return false;
-        }
-        return prefix.every((name, index) => path[index] === name);
+  equal(left, right) {
+    return entryNamesEqual(left, right);
+  },
+  isStrictPathPrefix(prefix, path) {
+    if (path.length <= prefix.length) {
+      return false;
     }
+    return prefix.every((name, index) => path[index] === name);
+  },
 };

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

@@ -3,4 +3,4 @@ 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
+//# sourceMappingURL=unix-path.d.ts.map

package/dist/domain/unix-path.js

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

package/dist/domain/user-input.d.ts

@@ -0,0 +1,27 @@
+export type UserInput =
+  | {
+      userInputType: 'character';
+      string: string;
+    }
+  | {
+      userInputType: 'enter';
+    }
+  | {
+      userInputType: 'backspace';
+    }
+  | {
+      userInputType: 'esc';
+    }
+  | {
+      userInputType: 'rightArrow';
+    }
+  | {
+      userInputType: 'leftArrow';
+    }
+  | {
+      userInputType: 'downArrow';
+    }
+  | {
+      userInputType: 'upArrow';
+    };
+//# sourceMappingURL=user-input.d.ts.map

package/dist/domain/user-input.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-input.d.ts","sourceRoot":"","sources":["../../src/domain/user-input.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GACjB;IACE,aAAa,EAAE,WAAW,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;CAChB,GACD;IACE,aAAa,EAAE,OAAO,CAAC;CACxB,GACD;IACE,aAAa,EAAE,WAAW,CAAC;CAC5B,GACD;IACE,aAAa,EAAE,KAAK,CAAC;CACtB,GACD;IACE,aAAa,EAAE,YAAY,CAAC;CAC7B,GACD;IACE,aAAa,EAAE,WAAW,CAAC;CAC5B,GACD;IACE,aAAa,EAAE,WAAW,CAAC;CAC5B,GACD;IACE,aAAa,EAAE,SAAS,CAAC;CAC1B,CAAC"}

package/dist/domain/user-input.js

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -1,10 +1,15 @@
+export * from './application/user-input-to-intent.js';
+export * from './application/intent-to-effect.js';
 export * from './domain/cursor.js';
 export * from './domain/display-row.js';
+export * from './domain/effect.js';
 export * from './domain/fold-node.js';
+export * from './domain/input-state.js';
 export * from './domain/navigation-node.js';
 export * from './domain/state.js';
 export * from './domain/unix-entry.js';
 export * from './domain/unix-path.js';
+export * from './domain/user-input.js';
 export * from './infrastructure/get-cwd.js';
 export * from './infrastructure/get-dir-lazy-entries.js';
-//# sourceMappingURL=index.d.ts.map
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AAEtC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0CAA0C,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uCAAuC,CAAC;AACtD,cAAc,mCAAmC,CAAC;AAElD,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC;AACvC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AAEvC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0CAA0C,CAAC"}

package/dist/index.js

@@ -1,9 +1,14 @@
+export * from './application/user-input-to-intent.js';
+export * from './application/intent-to-effect.js';
 export * from './domain/cursor.js';
 export * from './domain/display-row.js';
+export * from './domain/effect.js';
 export * from './domain/fold-node.js';
+export * from './domain/input-state.js';
 export * from './domain/navigation-node.js';
 export * from './domain/state.js';
 export * from './domain/unix-entry.js';
 export * from './domain/unix-path.js';
+export * from './domain/user-input.js';
 export * from './infrastructure/get-cwd.js';
 export * from './infrastructure/get-dir-lazy-entries.js';

package/dist/infrastructure/get-cwd.d.ts

@@ -1,3 +1,3 @@
 import type { UnixAbsolutePath } from '../domain/unix-path.js';
 export declare function getCwdAbsPath(): UnixAbsolutePath;
-//# sourceMappingURL=get-cwd.d.ts.map
+//# sourceMappingURL=get-cwd.d.ts.map

package/dist/infrastructure/get-cwd.js

@@ -1,13 +1,15 @@
 import { UnixAbsolutePathSchema } from '../domain/unix-path.js';
 export function getCwdAbsPath() {
-    const currentWorkingDirectory = process.cwd();
-    const result = UnixAbsolutePathSchema.safeParse(currentWorkingDirectory);
-    if (!result.success) {
-        const details = result.error.issues
-            .map((issue) => issue.message)
-            .join('; ');
-        throw new Error(`Bad path for current working directory ` +
-            `"${currentWorkingDirectory}": ${details}`);
-    }
-    return result.data;
+  const currentWorkingDirectory = process.cwd();
+  const result = UnixAbsolutePathSchema.safeParse(currentWorkingDirectory);
+  if (!result.success) {
+    const details = result.error.issues
+      .map((issue) => issue.message)
+      .join('; ');
+    throw new Error(
+      `Bad path for current working directory ` +
+        `"${currentWorkingDirectory}": ${details}`,
+    );
+  }
+  return result.data;
 }

package/dist/infrastructure/get-dir-lazy-entries.d.ts

@@ -1,4 +1,6 @@
 import type { UnixAbsolutePath } from '../domain/unix-path.js';
 import type { UnixEntry } from '../domain/unix-entry.js';
-export declare function getDirLazyEntries(address: UnixAbsolutePath): Promise<UnixEntry[]>;
-//# sourceMappingURL=get-dir-lazy-entries.d.ts.map
+export declare function getDirLazyEntries(
+  address: UnixAbsolutePath,
+): Promise<UnixEntry[]>;
+//# sourceMappingURL=get-dir-lazy-entries.d.ts.map

package/dist/infrastructure/get-dir-lazy-entries.js

@@ -3,32 +3,38 @@ import { join } from 'node:path';
 import { UnixPathSchema } from '../domain/unix-path.js';
 import { UnixEntryNameSchema } from '../domain/unix-entry.js';
 export async function getDirLazyEntries(address) {
-    const directoryEntries = await readdir(address, {
-        withFileTypes: true,
-    });
-    return Promise.all(directoryEntries.map(async (directoryEntry) => {
-        const name = UnixEntryNameSchema.parse(directoryEntry.name);
-        if (directoryEntry.isSymbolicLink()) {
-            const target = UnixPathSchema.parse(await readlink(join(address, directoryEntry.name)));
-            return {
-                kind: 'symlink',
-                name,
-                target,
-            };
-        }
-        if (directoryEntry.isDirectory()) {
-            return {
-                kind: 'directory',
-                name,
-                // Deliberately omitted: this directory has not been expanded.
-            };
-        }
-        if (directoryEntry.isFile()) {
-            return {
-                kind: 'file',
-                name,
-            };
-        }
-        throw new Error(`Unsupported filesystem entry "${join(address, directoryEntry.name)}"`);
-    }));
+  const directoryEntries = await readdir(address, {
+    withFileTypes: true,
+  });
+  return Promise.all(
+    directoryEntries.map(async (directoryEntry) => {
+      const name = UnixEntryNameSchema.parse(directoryEntry.name);
+      if (directoryEntry.isSymbolicLink()) {
+        const target = UnixPathSchema.parse(
+          await readlink(join(address, directoryEntry.name)),
+        );
+        return {
+          kind: 'symlink',
+          name,
+          target,
+        };
+      }
+      if (directoryEntry.isDirectory()) {
+        return {
+          kind: 'directory',
+          name,
+          // Deliberately omitted: this directory has not been expanded.
+        };
+      }
+      if (directoryEntry.isFile()) {
+        return {
+          kind: 'file',
+          name,
+        };
+      }
+      throw new Error(
+        `Unsupported filesystem entry "${join(address, directoryEntry.name)}"`,
+      );
+    }),
+  );
 }

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "dirvi-lib",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Dependency for dirvi apps.",
   "license": "LGPL-3.0-or-later",
   "type": "module",
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": [
     "dist"
   ],
@@ -17,6 +18,7 @@
   },
   "scripts": {
     "build": "tsc",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "format": "prettier . --write"
   }
 }

package/dist/domain/fold.d.ts

@@ -1,10 +0,0 @@
-import type { UnixEntryName } from './unix-entry.js';
-export type FoldNode = {
-    children: Record<UnixEntryName, FoldNode>;
-    folds: UnixEntryName[];
-};
-export declare const FoldNode: {
-    createEmpty(): FoldNode;
-    updateAtPath(rootNode: FoldNode, path: UnixEntryName[], update: (targetNode: FoldNode) => FoldNode): FoldNode;
-};
-//# sourceMappingURL=fold.d.ts.map

package/dist/domain/fold.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"fold.d.ts","sourceRoot":"","sources":["../../src/domain/fold.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,QAAQ,GAAG;IACrB,QAAQ,EAAE,MAAM,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IAC1C,KAAK,EAAE,aAAa,EAAE,CAAC;CACxB,CAAC;AAEF,eAAO,MAAM,QAAQ;mBACJ,QAAQ;2BAQX,QAAQ,QACZ,aAAa,EAAE,UACb,CAAC,UAAU,EAAE,QAAQ,KAAK,QAAQ,GACzC,QAAQ;CAmBZ,CAAC"}

package/dist/domain/fold.js

@@ -1,24 +0,0 @@
-export const FoldNode = {
-    createEmpty() {
-        return {
-            children: Object.create(null),
-            folds: [],
-        };
-    },
-    updateAtPath(rootNode, path, update) {
-        const [currentName, ...remainingPath] = path;
-        // Base case
-        if (currentName === undefined) {
-            return update(rootNode);
-        }
-        // Create childNode to create path in tree to the needed node
-        const childNode = rootNode.children[currentName] ?? FoldNode.createEmpty();
-        return {
-            ...rootNode,
-            children: {
-                ...rootNode.children,
-                [currentName]: FoldNode.updateAtPath(childNode, remainingPath, update),
-            },
-        };
-    }
-};

package/dist/domain/navigation-entry.d.ts

@@ -1,23 +0,0 @@
-import { UnixEntryName } from './unix-entry.js';
-import { UnixPath } from './unix-path.js';
-import { State } from './state.js';
-export type NavigationEntry = {
-    kind: 'file';
-    name: UnixEntryName;
-} | {
-    kind: 'symlink';
-    name: UnixEntryName;
-    target: UnixPath;
-} | {
-    kind: 'directory';
-    name: UnixEntryName;
-    node?: NavigationNode;
-};
-export type NavigationNode = {
-    entries: NavigationEntry[];
-    foldedEntries: NavigationEntry[];
-};
-export declare const NavigationNode: {
-    derive(state: State): NavigationNode;
-};
-//# sourceMappingURL=navigation-entry.d.ts.map

package/dist/domain/navigation-entry.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"navigation-entry.d.ts","sourceRoot":"","sources":["../../src/domain/navigation-entry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAGnC,MAAM,MAAM,eAAe,GACvB;IACE,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,aAAa,CAAC;CACrB,GACD;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,EAAE,aAAa,CAAC;IACpB,MAAM,EAAE,QAAQ,CAAC;CAClB,GACD;IACE,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,CAAC,EAAE,cAAc,CAAC;CACvB,CAAC;AAEN,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,eAAe,EAAE,CAAC;IAC3B,aAAa,EAAE,eAAe,EAAE,CAAC;CAClC,CAAC;AAEF,eAAO,MAAM,cAAc;kBACX,KAAK,GAAG,cAAc;CAGrC,CAAC"}

package/dist/domain/navigation-entry.js

@@ -1,52 +0,0 @@
-export const NavigationNode = {
-    derive(state) {
-        return deriveNode(state.buffer.entries, state.folds);
-    },
-};
-function deriveNode(entries, foldNode) {
-    if (entries === undefined) {
-        return {
-            entries: [],
-            foldedEntries: [],
-        };
-    }
-    const foldedNames = new Set(foldNode?.folds ?? []);
-    const visibleEntries = [];
-    const foldedEntries = [];
-    for (const entry of entries) {
-        const navigationEntry = deriveEntry(entry, foldNode?.children[entry.name]);
-        if (foldedNames.has(entry.name)) {
-            foldedEntries.push(navigationEntry);
-        }
-        else {
-            visibleEntries.push(navigationEntry);
-        }
-    }
-    return {
-        entries: visibleEntries,
-        foldedEntries,
-    };
-}
-function deriveEntry(entry, foldNode) {
-    switch (entry.kind) {
-        case 'file':
-            return {
-                kind: 'file',
-                name: entry.name,
-            };
-        case 'symlink':
-            return {
-                kind: 'symlink',
-                name: entry.name,
-                target: entry.target,
-            };
-        case 'directory':
-            return {
-                kind: 'directory',
-                name: entry.name,
-                node: entry.entries === undefined
-                    ? undefined
-                    : deriveNode(entry.entries, foldNode),
-            };
-    }
-}

package/dist/domain/view.d.ts

@@ -1,15 +0,0 @@
-import { UnixEntry } from './unix-entry.js';
-import type { FoldNode } from './fold-node.js';
-import { Cursor } from './cursor.js';
-export type DirectoryBuffer = {
-    entries: UnixEntry[];
-};
-export type View = {
-    buffer: DirectoryBuffer;
-    folds: FoldNode;
-    cursor: Cursor;
-};
-export declare const View: {
-    getEntryAtCursor(view: View): UnixEntry | undefined;
-};
-//# sourceMappingURL=view.d.ts.map

package/dist/domain/view.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../../src/domain/view.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,SAAS,EAAE,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG;IACjB,MAAM,EAAE,eAAe,CAAC;IACxB,KAAK,EAAE,QAAQ,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,eAAO,MAAM,IAAI;2BACQ,IAAI,GAAG,SAAS,GAAG,SAAS;CAUpD,CAAA"}

package/dist/domain/view.js

@@ -1,12 +0,0 @@
-import { UnixEntry } from './unix-entry.js';
-import { Cursor } from './cursor.js';
-export const View = {
-    getEntryAtCursor(view) {
-        const path = Cursor.getPath(view.cursor);
-        // Nothing on folds
-        if (path === undefined) {
-            return undefined;
-        }
-        return UnixEntry.getEntryAtPath(view.buffer.entries, path);
-    }
-};