dirvi-lib 0.4.0 → 0.6.0

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

@@ -0,0 +1,3 @@
+import { UserInput, InputState, Intent } from '../domain/index.js';
+export declare function userInputToIntent(userInput: UserInput, inputState: InputState): Intent | undefined;
+//# sourceMappingURL=user-input-to-intent.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"user-input-to-intent.d.ts","sourceRoot":"","sources":["../../../src/tree-surfer-ui/application/user-input-to-intent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAGnE,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,SAAS,EACpB,UAAU,EAAE,UAAU,GACrB,MAAM,GAAG,SAAS,CAQpB"}

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

@@ -0,0 +1,98 @@
+// Derive the intent from the user input and the current input state.
+export function userInputToIntent(userInput, inputState) {
+    switch (inputState.inputMode) {
+        case 'normal':
+            return normalUserInputToIntent(userInput, inputState.normalBuffer);
+        case 'command':
+            return commandUserInputToIntent(userInput, inputState.commandLine);
+    }
+}
+function normalUserInputToIntent(userInput, normalBuffer) {
+    if (userInput.userInputType === 'esc') {
+        return {
+            intentType: 'setNormalBuffer',
+            normalBuffer: '',
+        };
+    }
+    if (userInput.userInputType === 'character') {
+        return normalCharacterToIntent(userInput.string, normalBuffer);
+    }
+    switch (userInput.userInputType) {
+        case 'rightArrow':
+            return {
+                intentType: 'normalRight',
+            };
+        case 'leftArrow':
+            return {
+                intentType: 'normalLeft',
+            };
+        case 'downArrow':
+            return {
+                intentType: 'normalDown',
+            };
+        case 'upArrow':
+            return {
+                intentType: 'normalUp',
+            };
+    }
+}
+function normalCharacterToIntent(character, normalBuffer) {
+    if (normalBuffer === '') {
+        switch (character) {
+            case 'l':
+                return {
+                    intentType: 'normalRight',
+                };
+            case 'h':
+                return {
+                    intentType: 'normalLeft',
+                };
+            case 'j':
+                return {
+                    intentType: 'normalDown',
+                };
+            case 'k':
+                return {
+                    intentType: 'normalUp',
+                };
+            case ':':
+                return {
+                    intentType: 'enterCommandLineMode',
+                };
+        }
+    }
+    return {
+        intentType: 'setNormalBuffer',
+        normalBuffer: normalBuffer + character,
+    };
+}
+function commandUserInputToIntent(userInput, commandLine) {
+    if (userInput.userInputType === 'esc') {
+        return {
+            intentType: 'exitCommandLineMode',
+        };
+    }
+    if (userInput.userInputType === 'enter') {
+        return {
+            intentType: 'executeCommandLine',
+            commandLine: commandLine,
+        };
+    }
+    if (userInput.userInputType === 'backspace') {
+        if (commandLine.length < 2) {
+            return {
+                intentType: 'exitCommandLineMode',
+            };
+        }
+        return {
+            intentType: 'setCommandLine',
+            commandLine: commandLine.slice(0, -1),
+        };
+    }
+    if (userInput.userInputType === 'character') {
+        return {
+            intentType: 'setCommandLine',
+            commandLine: commandLine + userInput.string,
+        };
+    }
+}

package/dist/tree-surfer-ui/application/user-input-to-intent.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=user-input-to-intent.test.d.ts.map

package/dist/tree-surfer-ui/application/user-input-to-intent.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-input-to-intent.test.d.ts","sourceRoot":"","sources":["../../../src/tree-surfer-ui/application/user-input-to-intent.test.ts"],"names":[],"mappings":""}

package/dist/tree-surfer-ui/application/user-input-to-intent.test.js

@@ -0,0 +1,118 @@
+import { describe, expect, it } from 'vitest';
+import { userInputToIntent } from './user-input-to-intent.js';
+function normalInputState(normalBuffer = '') {
+    return {
+        inputMode: 'normal',
+        normalBuffer,
+    };
+}
+function commandInputState(commandLine = ':') {
+    return {
+        inputMode: 'command',
+        commandLine,
+    };
+}
+describe('userInputToIntent', () => {
+    describe('normal mode', () => {
+        it.each([
+            ['l', { intentType: 'normalRight' }],
+            ['h', { intentType: 'normalLeft' }],
+            ['j', { intentType: 'normalDown' }],
+            ['k', { intentType: 'normalUp' }],
+            [':', { intentType: 'enterCommandLineMode' }],
+        ])('converts "%s" to the expected intent', (character, expected) => {
+            const userInput = {
+                userInputType: 'character',
+                string: character,
+            };
+            expect(userInputToIntent(userInput, normalInputState())).toEqual(expected);
+        });
+        it('adds an unrecognized character to the normal buffer', () => {
+            const userInput = {
+                userInputType: 'character',
+                string: 'g',
+            };
+            expect(userInputToIntent(userInput, normalInputState())).toEqual({
+                intentType: 'setNormalBuffer',
+                normalBuffer: 'g',
+            });
+        });
+        it('appends a character to an existing normal buffer', () => {
+            const userInput = {
+                userInputType: 'character',
+                string: 'g',
+            };
+            expect(userInputToIntent(userInput, normalInputState('2'))).toEqual({
+                intentType: 'setNormalBuffer',
+                normalBuffer: '2g',
+            });
+        });
+        it('clears the normal buffer when Escape is pressed', () => {
+            const userInput = {
+                userInputType: 'esc',
+            };
+            expect(userInputToIntent(userInput, normalInputState('gg'))).toEqual({
+                intentType: 'setNormalBuffer',
+                normalBuffer: '',
+            });
+        });
+        it.each([
+            ['rightArrow', 'normalRight'],
+            ['leftArrow', 'normalLeft'],
+            ['downArrow', 'normalDown'],
+            ['upArrow', 'normalUp'],
+        ])('converts %s to %s', (userInputType, intentType) => {
+            const userInput = {
+                userInputType,
+            };
+            expect(userInputToIntent(userInput, normalInputState())).toEqual({
+                intentType,
+            });
+        });
+        it('does not enter command-line mode when the normal buffer is non-empty', () => {
+            const userInput = {
+                userInputType: 'character',
+                string: ':',
+            };
+            expect(userInputToIntent(userInput, normalInputState('g'))).toEqual({
+                intentType: 'setNormalBuffer',
+                normalBuffer: 'g:',
+            });
+        });
+    });
+    describe('command-line mode', () => {
+        it('appends a character to the command line', () => {
+            const userInput = {
+                userInputType: 'character',
+                string: 'w',
+            };
+            expect(userInputToIntent(userInput, commandInputState(':'))).toEqual({
+                intentType: 'setCommandLine',
+                commandLine: ':w',
+            });
+        });
+        it('executes the command line when Enter is pressed', () => {
+            const userInput = {
+                userInputType: 'enter',
+            };
+            expect(userInputToIntent(userInput, commandInputState(':w'))).toEqual({
+                intentType: 'executeCommandLine',
+                commandLine: ':w',
+            });
+        });
+        it('exits command-line mode when Escape is pressed', () => {
+            const userInput = {
+                userInputType: 'esc',
+            };
+            expect(userInputToIntent(userInput, commandInputState(':w'))).toEqual({
+                intentType: 'exitCommandLineMode',
+            });
+        });
+        it.each(['rightArrow', 'leftArrow', 'downArrow', 'upArrow'])('ignores %s in command-line mode', (userInputType) => {
+            const userInput = {
+                userInputType,
+            };
+            expect(userInputToIntent(userInput, commandInputState())).toBeUndefined();
+        });
+    });
+});

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

@@ -0,0 +1,35 @@
+import type { InputState } from './input-state.js';
+import { SerializableKey, TreeNode } from '../../tree-surfer/index.js';
+export type Effect<Id extends SerializableKey, BufferNode extends TreeNode<Id, BufferNode>> = {
+    effectType: 'dispatchEffectAction';
+    action: EffectAction<Id, BufferNode>;
+} | {
+    effectType: 'loadBranchEntries';
+    path: Id[];
+} | {
+    effectType: 'emitVisibleLeavesPaths';
+} | {
+    effectType: 'quit';
+    exitMessage: string;
+} | {
+    effectType: 'setInputState';
+    inputState: InputState;
+};
+export type EffectAction<Id extends SerializableKey, BufferNode extends TreeNode<Id, BufferNode>> = {
+    effectActionType: 'nextEntry';
+} | {
+    effectActionType: 'prevEntry';
+} | {
+    effectActionType: 'setBranchEntries';
+    path: Id[];
+    entries: BufferNode[] | null;
+} | {
+    effectActionType: 'navigateToParent';
+} | {
+    effectActionType: 'fold';
+} | {
+    effectActionType: 'unfold';
+} | {
+    effectActionType: 'toggleFold';
+};
+//# sourceMappingURL=effect.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,5 @@
+export * from './effect.js';
+export * from './input-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

@@ -0,0 +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"}

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

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

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

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

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

@@ -0,0 +1 @@
+{"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"}

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

@@ -0,0 +1,25 @@
+export type Intent = NormalModeIntent | CommandLineIntent;
+export type NormalModeIntent = {
+    intentType: 'normalRight';
+} | {
+    intentType: 'normalLeft';
+} | {
+    intentType: 'normalDown';
+} | {
+    intentType: 'normalUp';
+} | {
+    intentType: 'setNormalBuffer';
+    normalBuffer: string;
+};
+export type CommandLineIntent = {
+    intentType: 'enterCommandLineMode';
+} | {
+    intentType: 'setCommandLine';
+    commandLine: string;
+} | {
+    intentType: 'executeCommandLine';
+    commandLine: string;
+} | {
+    intentType: 'exitCommandLineMode';
+};
+//# sourceMappingURL=intent.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"intent.d.ts","sourceRoot":"","sources":["../../../src/tree-surfer-ui/domain/intent.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,MAAM,GAAG,gBAAgB,GAAG,iBAAiB,CAAC;AAE1D,MAAM,MAAM,gBAAgB,GACxB;IACE,UAAU,EAAE,aAAa,CAAC;CAC3B,GACD;IACE,UAAU,EAAE,YAAY,CAAC;CAC1B,GACD;IACE,UAAU,EAAE,YAAY,CAAC;CAC1B,GACD;IACE,UAAU,EAAE,UAAU,CAAC;CACxB,GACD;IACE,UAAU,EAAE,iBAAiB,CAAC;IAC9B,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEN,MAAM,MAAM,iBAAiB,GACzB;IACE,UAAU,EAAE,sBAAsB,CAAC;CACpC,GACD;IACE,UAAU,EAAE,gBAAgB,CAAC;IAC7B,WAAW,EAAE,MAAM,CAAC;CACrB,GACD;IACE,UAAU,EAAE,oBAAoB,CAAC;IACjC,WAAW,EAAE,MAAM,CAAC;CACrB,GACD;IACE,UAAU,EAAE,qBAAqB,CAAC;CACnC,CAAC"}

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

@@ -0,0 +1,19 @@
+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/tree-surfer-ui/domain/user-input.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-input.d.ts","sourceRoot":"","sources":["../../../src/tree-surfer-ui/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dirvi-lib",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Dependency for dirvi apps.",
   "license": "LGPL-3.0-or-later",
   "type": "module",
@@ -17,7 +17,8 @@
     "typescript": "^5.0.0"
   },
   "scripts": {
-    "build": "tsc",
+    "clean": "rm -rf dist",
+    "build": "pnpm clean && tsc",
     "typecheck": "tsc --noEmit",
     "format": "prettier . --write"
   }

package/dist/application/intent-to-effect-no-state.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=intent-to-effect-no-state.test.d.ts.map

package/dist/application/intent-to-effect-no-state.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"intent-to-effect-no-state.test.d.ts","sourceRoot":"","sources":["../../src/application/intent-to-effect-no-state.test.ts"],"names":[],"mappings":""}

package/dist/application/intent-to-effect-no-state.test.js

@@ -1,178 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import { intentToEffect } from './intent-to-effect.js';
-const state = {};
-describe('intentToEffectNoState', () => {
-  describe('normal mode buffer', () => {
-    it('stores z as a possible command prefix', () => {
-      expect(
-        intentToEffect(
-          {
-            intentType: 'setNormalBuffer',
-            normalBuffer: 'z',
-          },
-          state,
-        ),
-      ).toEqual({
-        effectType: 'setInputState',
-        inputState: {
-          inputMode: 'normal',
-          normalBuffer: 'z',
-        },
-      });
-    });
-    it.each([
-      ['za', 'toggleFold'],
-      ['zc', 'fold'],
-      ['zo', 'unfold'],
-    ])(
-      'converts %s into a %s effect action',
-      (normalBuffer, effectActionType) => {
-        expect(
-          intentToEffect(
-            {
-              intentType: 'setNormalBuffer',
-              normalBuffer,
-            },
-            state,
-          ),
-        ).toEqual({
-          effectType: 'dispatchEffectAction',
-          action: {
-            effectActionType,
-          },
-        });
-      },
-    );
-    it('clears the normal buffer when the input is not a known command', () => {
-      expect(
-        intentToEffect(
-          {
-            intentType: 'setNormalBuffer',
-            normalBuffer: 'x',
-          },
-          state,
-        ),
-      ).toEqual({
-        effectType: 'setInputState',
-        inputState: {
-          inputMode: 'normal',
-          normalBuffer: '',
-        },
-      });
-    });
-  });
-  describe('normal mode navigation', () => {
-    it('moves to the next entry', () => {
-      expect(
-        intentToEffect(
-          {
-            intentType: 'normalDown',
-          },
-          state,
-        ),
-      ).toEqual({
-        effectType: 'dispatchEffectAction',
-        action: {
-          effectActionType: 'nextEntry',
-        },
-      });
-    });
-    it('moves to the previous entry', () => {
-      expect(
-        intentToEffect(
-          {
-            intentType: 'normalUp',
-          },
-          state,
-        ),
-      ).toEqual({
-        effectType: 'dispatchEffectAction',
-        action: {
-          effectActionType: 'prevEntry',
-        },
-      });
-    });
-  });
-  describe('command-line mode', () => {
-    it('enters command-line mode', () => {
-      expect(
-        intentToEffect(
-          {
-            intentType: 'enterCommandLineMode',
-          },
-          state,
-        ),
-      ).toEqual({
-        effectType: 'setInputState',
-        inputState: {
-          inputMode: 'command',
-          commandLine: ':',
-        },
-      });
-    });
-    it('updates the command line', () => {
-      expect(
-        intentToEffect(
-          {
-            intentType: 'setCommandLine',
-            commandLine: ':w',
-          },
-          state,
-        ),
-      ).toEqual({
-        effectType: 'setInputState',
-        inputState: {
-          inputMode: 'command',
-          commandLine: ':w',
-        },
-      });
-    });
-    it('exits command-line mode', () => {
-      expect(
-        intentToEffect(
-          {
-            intentType: 'exitCommandLineMode',
-          },
-          state,
-        ),
-      ).toEqual({
-        effectType: 'setInputState',
-        inputState: {
-          inputMode: 'normal',
-          normalBuffer: '',
-        },
-      });
-    });
-    it('returns to normal mode after executing a gibberish command line', () => {
-      expect(
-        intentToEffect(
-          {
-            intentType: 'executeCommandLine',
-            commandLine: ':sijbas',
-          },
-          state,
-        ),
-      ).toEqual({
-        effectType: 'setInputState',
-        inputState: {
-          inputMode: 'normal',
-          normalBuffer: '',
-        },
-      });
-    });
-    it('quits when the :q command is executed', () => {
-      expect(
-        intentToEffect(
-          {
-            intentType: 'executeCommandLine',
-            commandLine: ':q',
-          },
-          state,
-        ),
-      ).toEqual({
-        effectType: 'quit',
-        exitMessage: '',
-      });
-    });
-  });
-});

package/dist/application/intent-to-effect.d.ts

@@ -1,8 +0,0 @@
-import { Effect } from '../domain/effect.js';
-import { State } from '../domain/state.js';
-import { Intent } from '../domain/intent.js';
-export declare function intentToEffect(
-  intent: Intent,
-  state: State,
-): Effect | undefined;
-//# sourceMappingURL=intent-to-effect.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"intent-to-effect.d.ts","sourceRoot":"","sources":["../../src/application/intent-to-effect.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAgB,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,KAAK,EAAQ,MAAM,oBAAoB,CAAC;AAEjD,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAU7C,wBAAgB,cAAc,CAC5B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,KAAK,GACX,MAAM,GAAG,SAAS,CAgEpB"}