epiq 0.0.0

package/dist/navigation/navigation.js

@@ -0,0 +1,74 @@
+import readline from 'readline';
+import { navigationState } from './state/state.js';
+import { getKeyIntent } from './utils/key-intent.js';
+export function navigate({ index = 0, breadCrumb, callbacks, }) {
+    const { render = () => { }, onSelectChange = () => { }, onConfirm = () => { }, } = callbacks;
+    const ctx = {
+        breadCrumb,
+        get navigationNode() {
+            return this.breadCrumb.at(-1);
+        },
+        get children() {
+            return this.navigationNode.children ?? [];
+        },
+        selectNone: () => {
+            ctx.select(-1);
+        },
+        _selectedIndex: 0,
+        getSelectedIndex() {
+            return this._selectedIndex;
+        },
+        select(i) {
+            this._selectedIndex = i;
+            updateSelection(ctx.navigationNode, breadCrumb, i, onSelectChange);
+        },
+        render,
+        reInvokeNavigate(index, breadCrumb) {
+            return reInvokeNavigate(index, breadCrumb);
+        },
+        confirm: sel => onConfirm(sel),
+        exit: () => {
+            cleanup();
+            process.exit(0);
+        },
+        enterChildNode: node => reInvokeNavigate(0, [...breadCrumb, node]),
+        enterParentNode: () => {
+            ctx.select(-1); // Clear all on this level
+            if (breadCrumb.length < 2)
+                return; // Need at least grandparent + parent
+            const ancestors = breadCrumb;
+            const parent = ancestors[ancestors.length - 1];
+            const grandParent = ancestors[ancestors.length - 2];
+            if (!parent || !grandParent)
+                return;
+            const parentIndex = grandParent?.children.findIndex(x => parent.id === x.id);
+            reInvokeNavigate(parentIndex, breadCrumb.slice(0, -1)); // Go to parent level
+        },
+    };
+    ctx.select(index);
+    function onKeyPress(_, key) {
+        if (key.ctrl && key.name === 'c')
+            return ctx.exit();
+        const filteredActions = navigationState.availableActions.filter(x => x.mode === navigationState.mode);
+        const action = filteredActions?.find(actionMeta => {
+            const intent = getKeyIntent(key, ctx);
+            return intent === actionMeta.intent;
+        });
+        action?.action?.(ctx);
+        ctx.render();
+    }
+    const cleanup = () => process.stdin.removeListener('keypress', onKeyPress);
+    const reInvokeNavigate = (idx, crumb) => {
+        cleanup();
+        navigate({ index: idx, breadCrumb: [...crumb], callbacks });
+    };
+    render();
+    readline.emitKeypressEvents(process.stdin);
+    if (process.stdin.isTTY)
+        process.stdin.setRawMode(true);
+    process.stdin.on('keypress', onKeyPress);
+}
+function updateSelection({ children }, breadCrumb, idx, onSelectChange) {
+    children.forEach((c, i) => (c.isSelected = i === idx));
+    onSelectChange(children[idx], breadCrumb);
+}

package/dist/navigation/state/state.d.ts

@@ -0,0 +1,11 @@
+import { ActionEntry, ModeOptions } from '../model/action-map.model.js';
+import { NavigateCtx } from '../model/navigation-ctx.model.js';
+import { NavigationTree } from '../model/navigation-tree.model.js';
+export declare let navigationState: {
+    mode: ModeOptions;
+    availableActions: ActionEntry<[NavigateCtx]>[];
+    viewHelp: boolean;
+    currentNode: NavigationTree<NavigationTree> | null;
+    breadCrumb: NavigationTree<NavigationTree>[];
+};
+export declare const setState: (cb: (oldState: typeof navigationState) => typeof navigationState) => void;

package/dist/navigation/state/state.js

@@ -0,0 +1,10 @@
+export let navigationState = {
+    mode: 'default',
+    availableActions: [],
+    viewHelp: false,
+    currentNode: null,
+    breadCrumb: [],
+};
+export const setState = (cb) => {
+    navigationState = cb(navigationState);
+};

package/dist/navigation/utils/key-intent.d.ts

@@ -0,0 +1,16 @@
+import readline from 'readline';
+import { NavigateCtx } from '../model/navigation-ctx.model.js';
+export declare enum KeyIntent {
+    NavPreviousItem = "nav-previous-item",
+    NavNextItem = "nav-next-item",
+    NavToPreviousContainer = "nav-to-previous-container",
+    NavToNextContainer = "nav-to-next-container",
+    MovePreviousItem = "move-previous-item",
+    MoveNextItem = "move-next-item",
+    MoveToPreviousContainer = "move-to-previous-container",
+    MoveToNextContainer = "move-to-next-container",
+    Confirm = "confirm",
+    Exit = "exit",
+    ToggleHelp = "toggle-help"
+}
+export declare function getKeyIntent(key: readline.Key, ctx: NavigateCtx): KeyIntent | null;

package/dist/navigation/utils/key-intent.js

@@ -0,0 +1,65 @@
+export var KeyIntent;
+(function (KeyIntent) {
+    KeyIntent["NavPreviousItem"] = "nav-previous-item";
+    KeyIntent["NavNextItem"] = "nav-next-item";
+    KeyIntent["NavToPreviousContainer"] = "nav-to-previous-container";
+    KeyIntent["NavToNextContainer"] = "nav-to-next-container";
+    KeyIntent["MovePreviousItem"] = "move-previous-item";
+    KeyIntent["MoveNextItem"] = "move-next-item";
+    KeyIntent["MoveToPreviousContainer"] = "move-to-previous-container";
+    KeyIntent["MoveToNextContainer"] = "move-to-next-container";
+    KeyIntent["Confirm"] = "confirm";
+    KeyIntent["Exit"] = "exit";
+    KeyIntent["ToggleHelp"] = "toggle-help";
+})(KeyIntent || (KeyIntent = {}));
+export function getKeyIntent(key, ctx) {
+    const axis = ctx.navigationNode.childrenRenderAxis;
+    if (key.shift) {
+        switch (key.name) {
+            case 'up':
+                return axis === 'vertical' ? KeyIntent.MovePreviousItem : null;
+            case 'down':
+                return axis === 'vertical' ? KeyIntent.MoveNextItem : null;
+            case 'left':
+                return axis === 'horizontal'
+                    ? KeyIntent.MovePreviousItem
+                    : ctx.navigationNode.enableChildNavigationAcrossContainers
+                        ? KeyIntent.MoveToPreviousContainer
+                        : null;
+            case 'right':
+                return axis === 'horizontal'
+                    ? KeyIntent.MoveNextItem
+                    : ctx.navigationNode.enableChildNavigationAcrossContainers
+                        ? KeyIntent.MoveToNextContainer
+                        : null;
+            default:
+                return null;
+        }
+    }
+    switch (key.name) {
+        case 'h':
+            return KeyIntent.ToggleHelp;
+        case 'up':
+            return axis === 'vertical' ? KeyIntent.NavPreviousItem : null;
+        case 'down':
+            return axis === 'vertical' ? KeyIntent.NavNextItem : null;
+        case 'left':
+            return axis === 'horizontal'
+                ? KeyIntent.NavPreviousItem
+                : ctx.navigationNode.enableChildNavigationAcrossContainers
+                    ? KeyIntent.NavToPreviousContainer
+                    : null;
+        case 'right':
+            return axis === 'horizontal'
+                ? KeyIntent.NavNextItem
+                : ctx.navigationNode.enableChildNavigationAcrossContainers
+                    ? KeyIntent.NavToNextContainer
+                    : null;
+        case 'return':
+            return KeyIntent.Confirm;
+        case 'e':
+            return KeyIntent.Exit;
+        default:
+            return null;
+    }
+}

package/package.json

@@ -0,0 +1,57 @@
+{
+	"name": "epiq",
+	"version": "0.0.0",
+	"license": "MIT",
+	"bin": "dist/cli.js",
+	"type": "module",
+	"engines": {
+		"node": ">=16"
+	},
+	"scripts": {
+		"build": "tsc",
+		"dev": "tsc --watch",
+		"test": "prettier --check . && xo && ava",
+		"execute": "node dist/cli.js"
+	},
+	"files": [
+		"dist"
+	],
+	"dependencies": {
+		"ink": "^4.1.0",
+		"meow": "^11.0.0",
+		"react": "^18.2.0"
+	},
+	"devDependencies": {
+		"@sindresorhus/tsconfig": "^3.0.1",
+		"@types/react": "^18.0.32",
+		"@vdemedes/prettier-config": "^2.0.1",
+		"ava": "^5.2.0",
+		"chalk": "^5.2.0",
+		"eslint-config-xo-react": "^0.27.0",
+		"eslint-plugin-react": "^7.32.2",
+		"eslint-plugin-react-hooks": "^4.6.0",
+		"ink-testing-library": "^3.0.0",
+		"prettier": "^2.8.7",
+		"ts-node": "^10.9.1",
+		"tsx": "^4.20.3",
+		"typescript": "^5.0.3",
+		"xo": "^0.53.1"
+	},
+	"ava": {
+		"extensions": {
+			"ts": "module",
+			"tsx": "module"
+		},
+		"nodeArguments": [
+			"--loader=ts-node/esm"
+		]
+	},
+	"xo": {
+		"extends": "xo-react",
+		"prettier": true,
+		"rules": {
+			"react/prop-types": "off"
+		}
+	},
+	"prettier": "@vdemedes/prettier-config"
+}

package/readme.md

@@ -0,0 +1,37 @@
+# epiq
+
+## Local dev
+
+Start dev server in background terminal session:
+
+```bash
+$ npm run dev
+```
+
+Run app with:
+
+```bash
+$ npm run execute
+```
+
+## Install (WIP!)
+
+```bash
+$ npm install --global epiq
+```
+
+## CLI (WIP!)
+
+```
+$ epiq --help
+
+  Usage
+    $ epiq
+
+  Options
+    --name  Your name
+
+  Examples
+    $ epiq --name=Jane
+    Hello, Jane
+```