epiq 0.0.2 → 0.0.4

package/dist/lib/default-actions-routes.js

@@ -1,47 +0,0 @@
-import { setState } from './state.js';
-import { Mode } from './types/action-map.model.js';
-import { enterChildNode, exitToParentNode, navigateToNextContainer, navigateToNextItem, navigateToPreviousContainer, navigateToPreviousItem, } from './utils/default-actions.js';
-import { KeyIntent } from './utils/key-intent.js';
-export const buildDefaultActions = () => [
-    {
-        mode: Mode.DEFAULT,
-        description: '[ARROW KEYS] Navigate',
-    },
-    {
-        intent: KeyIntent.ToggleHelp,
-        mode: Mode.DEFAULT,
-        action: () => setState(state => ({ ...state, viewHelp: !state.viewHelp })),
-    },
-    {
-        intent: KeyIntent.Confirm,
-        mode: Mode.DEFAULT,
-        description: '[ENTER] Confirm',
-        action: enterChildNode,
-    },
-    {
-        intent: KeyIntent.Exit,
-        mode: Mode.DEFAULT,
-        description: '[E] Exit container',
-        action: exitToParentNode,
-    },
-    {
-        intent: KeyIntent.NavPreviousItem,
-        mode: Mode.DEFAULT,
-        action: navigateToPreviousItem,
-    },
-    {
-        intent: KeyIntent.NavNextItem,
-        mode: Mode.DEFAULT,
-        action: navigateToNextItem,
-    },
-    {
-        intent: KeyIntent.NavToPreviousContainer,
-        mode: Mode.DEFAULT,
-        action: navigateToPreviousContainer,
-    },
-    {
-        intent: KeyIntent.NavToNextContainer,
-        mode: Mode.DEFAULT,
-        action: navigateToNextContainer,
-    },
-];

package/dist/lib/default-actions.d.ts

@@ -1,4 +0,0 @@
-import { NavigateCtx } from './navigation-context.js';
-import { ActionEntry } from './types/action-map.model.js';
-export type DefaultActionMap = ActionEntry<[NavigateCtx]>[];
-export declare const buildDefaultActions: () => DefaultActionMap;

package/dist/lib/default-actions.js

@@ -1,47 +0,0 @@
-import { setState } from './state.js';
-import { Mode } from './types/action-map.model.js';
-import { enterChildNode, exitToParentNode, navigateToNextContainer, navigateToNextItem, navigateToPreviousContainer, navigateToPreviousItem, } from './utils/default-action-utils.js';
-import { KeyIntent } from './utils/key-intent.js';
-export const buildDefaultActions = () => [
-    {
-        mode: Mode.DEFAULT,
-        description: '[ARROW KEYS] Navigate',
-    },
-    {
-        intent: KeyIntent.ToggleHelp,
-        mode: Mode.DEFAULT,
-        action: () => setState(state => ({ ...state, viewHelp: !state.viewHelp })),
-    },
-    {
-        intent: KeyIntent.Confirm,
-        mode: Mode.DEFAULT,
-        description: '[ENTER] Confirm',
-        action: enterChildNode,
-    },
-    {
-        intent: KeyIntent.Exit,
-        mode: Mode.DEFAULT,
-        description: '[E] Exit container',
-        action: exitToParentNode,
-    },
-    {
-        intent: KeyIntent.NavPreviousItem,
-        mode: Mode.DEFAULT,
-        action: navigateToPreviousItem,
-    },
-    {
-        intent: KeyIntent.NavNextItem,
-        mode: Mode.DEFAULT,
-        action: navigateToNextItem,
-    },
-    {
-        intent: KeyIntent.NavToPreviousContainer,
-        mode: Mode.DEFAULT,
-        action: navigateToPreviousContainer,
-    },
-    {
-        intent: KeyIntent.NavToNextContainer,
-        mode: Mode.DEFAULT,
-        action: navigateToNextContainer,
-    },
-];

package/dist/lib/navigation-context.d.ts

@@ -1,16 +0,0 @@
-import { NavigationTree } from './types/navigation.model.js';
-export interface NavigateCtx {
-    _selectedIndex: number;
-    breadCrumb: Array<NavigationTree<NavigationTree>>;
-    navigationNode: NavigationTree<NavigationTree>;
-    children: NavigationTree[];
-    getSelectedIndex(): number;
-    select(index: number): void;
-    selectNone(): void;
-    reInvokeNavigate(index: number, breadCrumb: NavigationTree<NavigationTree>[]): void;
-    render(): void;
-    confirm(selected: NavigationTree<NavigationTree>): void;
-    exit(): void;
-    enterChildNode(node: NavigationTree<NavigationTree>): void;
-    enterParentNode(): void;
-}

package/dist/lib/navigation.d.ts

@@ -1,10 +0,0 @@
-import { NavigationTree } from './types/navigation.model.js';
-export declare function navigate<T extends NavigationTree>({ index, breadCrumb, callbacks, }: {
-    index: number;
-    breadCrumb: Array<NavigationTree<NavigationTree>>;
-    callbacks: Partial<{
-        render: () => void;
-        onSelectChange: (s: T['children'][number]) => void;
-        onConfirm: (s: T['children'][number]) => void;
-    }>;
-}): void;

package/dist/lib/navigation.js

@@ -1,74 +0,0 @@
-import readline from 'readline';
-import { navigationState } from './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, 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 }, idx, onSelectChange) {
-    children.forEach((c, i) => (c.isSelected = i === idx));
-    onSelectChange(children[idx]);
-}

package/dist/lib/render-utils.d.ts

@@ -1,10 +0,0 @@
-declare const COLORS: {
-    readonly green: "\u001B[32m";
-    readonly gray: "\u001B[90m";
-    readonly yellow: "\u001B[33m";
-    readonly red: "\u001B[31m";
-    readonly default: null;
-};
-export type HighlightColor = keyof typeof COLORS;
-export declare const highlight: (str: string, color?: HighlightColor) => string;
-export {};

package/dist/lib/render-utils.js

@@ -1,12 +0,0 @@
-const COLORS = {
-    green: "\x1b[32m",
-    gray: "\x1b[90m",
-    yellow: "\x1b[33m",
-    red: "\x1b[31m",
-    default: null, // no color
-};
-const RESET = "\x1b[0m";
-export const highlight = (str, color = "default") => {
-    const prefix = COLORS[color];
-    return prefix ? `${prefix}${str}${RESET}` : str;
-};

package/dist/lib/state.d.ts

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

package/dist/lib/state.js

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

package/dist/lib/types/action-map.model.d.ts

@@ -1,14 +0,0 @@
-export declare const Mode: {
-    readonly DEFAULT: "default";
-    readonly MOVE: "move";
-};
-export type ModeOptions = (typeof Mode)[keyof typeof Mode];
-export type ActionEntry<TArgs extends any[] = []> = {
-    intent?: string;
-    mode: string;
-    description?: `[${string}] ${string}`;
-    action?: (...args: TArgs) => void;
-};
-export type ActionMap<T extends Record<string, any[]>> = {
-    [K in keyof T]: ActionEntry<T[K]>[];
-};

package/dist/lib/types/action-map.model.js

@@ -1,4 +0,0 @@
-export const Mode = {
-    DEFAULT: 'default',
-    MOVE: 'move',
-};

package/dist/lib/types/board.model.d.ts

@@ -1,21 +0,0 @@
-import type { NavigationTree } from './navigation.model.js';
-export declare const BoardItemTypes: {
-    readonly TICKET: "TICKET";
-    readonly SWIMLANE: "SWIMLANE";
-    readonly BOARD: "BOARD";
-};
-export type Ticket = NavigationTree<{
-    actionContext: (typeof BoardItemTypes)['TICKET'];
-    description?: string;
-}>;
-export type Swimlane = NavigationTree<{
-    actionContext: (typeof BoardItemTypes)['SWIMLANE'];
-    enableChildNavigationAcrossContainers: true;
-}> & {
-    children: Ticket[];
-};
-export type Board = NavigationTree<{
-    actionContext: (typeof BoardItemTypes)['BOARD'];
-}> & {
-    children: Swimlane[];
-};

package/dist/lib/types/board.model.js

@@ -1,5 +0,0 @@
-export const BoardItemTypes = {
-    TICKET: 'TICKET',
-    SWIMLANE: 'SWIMLANE',
-    BOARD: 'BOARD',
-};

package/dist/lib/types/navigation.model.d.ts

@@ -1,9 +0,0 @@
-export type NavigationTree<TMeta = Record<string, unknown>> = {
-    id: string;
-    isSelected: boolean;
-    childrenRenderAxis: 'vertical' | 'horizontal';
-    name: string;
-    children: NavigationTree<unknown>[];
-    actionContext: string;
-    enableChildNavigationAcrossContainers?: boolean;
-} & TMeta;

package/dist/lib/utils/array-utils.d.ts

@@ -1,5 +0,0 @@
-export declare function moveItemInArray<T>({ array, from, to, }: {
-    array: T[];
-    from: number;
-    to: number;
-}): void;

package/dist/lib/utils/array-utils.js

@@ -1,7 +0,0 @@
-export function moveItemInArray({ array, from, to, }) {
-    if (from < 0 || from >= array.length || to < 0 || to >= array.length)
-        return;
-    const [item] = array.splice(from, 1);
-    if (item)
-        array.splice(to, 0, item);
-}

package/dist/lib/utils/default-action-utils.js

@@ -1,50 +0,0 @@
-// -- Basic item navigation --
-const navigateByOffset = (ctx, offset) => {
-    const len = ctx.children.length;
-    const newIndex = (ctx.getSelectedIndex() + offset + len) % len;
-    ctx.select(newIndex);
-};
-export const navigateToNextItem = (ctx) => navigateByOffset(ctx, 1);
-export const navigateToPreviousItem = (ctx) => navigateByOffset(ctx, -1);
-// -- Cross-container navigation --
-const navigateToSiblingContainer = (ctx, direction) => {
-    if (!ctx.navigationNode.enableChildNavigationAcrossContainers)
-        return;
-    const parent = ctx.breadCrumb.at(-1);
-    const grandParent = ctx.breadCrumb.at(-2);
-    if (!parent || !grandParent)
-        return;
-    const parentIndex = grandParent.children.findIndex(x => x.id === parent.id);
-    const sliced = direction === -1
-        ? grandParent.children.toSpliced(parentIndex).toReversed()
-        : grandParent.children.slice(parentIndex + 1);
-    const nextSibling = sliced.find(x => x.children.length);
-    if (!nextSibling?.children?.length)
-        return;
-    const prevIndex = ctx.getSelectedIndex();
-    const boundedIndex = Math.min(prevIndex, nextSibling.children.length - 1);
-    ctx.selectNone();
-    ctx.reInvokeNavigate(boundedIndex, [
-        ...ctx.breadCrumb.slice(0, -1),
-        nextSibling,
-    ]);
-};
-export const navigateToNextContainer = (ctx) => navigateToSiblingContainer(ctx, 1);
-export const navigateToPreviousContainer = (ctx) => navigateToSiblingContainer(ctx, -1);
-export const enterChildNode = (ctx) => {
-    const current = ctx.navigationNode.children[ctx._selectedIndex];
-    if (!current)
-        return;
-    if (!current.children?.length) {
-        ctx.confirm(current);
-    }
-    else {
-        ctx.select(-1);
-        ctx.enterChildNode(current);
-    }
-};
-export const exitToParentNode = (ctx) => {
-    if (ctx.breadCrumb.length >= 2) {
-        ctx.enterParentNode();
-    }
-};

package/dist/lib/utils/default-actions.d.ts

@@ -1,7 +0,0 @@
-import { NavigateCtx } from '../navigation-context.js';
-export declare const navigateToNextItem: (ctx: NavigateCtx) => void;
-export declare const navigateToPreviousItem: (ctx: NavigateCtx) => void;
-export declare const navigateToNextContainer: (ctx: NavigateCtx) => void;
-export declare const navigateToPreviousContainer: (ctx: NavigateCtx) => void;
-export declare const enterChildNode: (ctx: NavigateCtx) => void;
-export declare const exitToParentNode: (ctx: NavigateCtx) => void;

package/dist/lib/utils/default-actions.js

@@ -1,50 +0,0 @@
-// -- Basic item navigation --
-const navigateByOffset = (ctx, offset) => {
-    const len = ctx.children.length;
-    const newIndex = (ctx.getSelectedIndex() + offset + len) % len;
-    ctx.select(newIndex);
-};
-export const navigateToNextItem = (ctx) => navigateByOffset(ctx, 1);
-export const navigateToPreviousItem = (ctx) => navigateByOffset(ctx, -1);
-// -- Cross-container navigation --
-const navigateToSiblingContainer = (ctx, direction) => {
-    if (!ctx.navigationNode.enableChildNavigationAcrossContainers)
-        return;
-    const parent = ctx.breadCrumb.at(-1);
-    const grandParent = ctx.breadCrumb.at(-2);
-    if (!parent || !grandParent)
-        return;
-    const parentIndex = grandParent.children.findIndex(x => x.id === parent.id);
-    const sliced = direction === -1
-        ? grandParent.children.toSpliced(parentIndex).toReversed()
-        : grandParent.children.slice(parentIndex + 1);
-    const nextSibling = sliced.find(x => x.children.length);
-    if (!nextSibling?.children?.length)
-        return;
-    const prevIndex = ctx.getSelectedIndex();
-    const boundedIndex = Math.min(prevIndex, nextSibling.children.length - 1);
-    ctx.selectNone();
-    ctx.reInvokeNavigate(boundedIndex, [
-        ...ctx.breadCrumb.slice(0, -1),
-        nextSibling,
-    ]);
-};
-export const navigateToNextContainer = (ctx) => navigateToSiblingContainer(ctx, 1);
-export const navigateToPreviousContainer = (ctx) => navigateToSiblingContainer(ctx, -1);
-export const enterChildNode = (ctx) => {
-    const current = ctx.navigationNode.children[ctx._selectedIndex];
-    if (!current)
-        return;
-    if (!current.children?.length) {
-        ctx.confirm(current);
-    }
-    else {
-        ctx.select(-1);
-        ctx.enterChildNode(current);
-    }
-};
-export const exitToParentNode = (ctx) => {
-    if (ctx.breadCrumb.length >= 2) {
-        ctx.enterParentNode();
-    }
-};

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

@@ -1,16 +0,0 @@
-import readline from 'readline';
-import { NavigateCtx } from '../navigation-context.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/lib/utils/key-intent.js

@@ -1,65 +0,0 @@
-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/dist/lib/utils.d.ts

@@ -1,10 +0,0 @@
-export declare const clearScreen: () => void;
-export declare const keys: {
-    readonly CTRL_C: "\u0003";
-    readonly ENTER: "\r";
-    readonly ARROW_UP: "\u001B[A";
-    readonly ARROW_DOWN: "\u001B[B";
-    readonly ARROW_LEFT: "\u001B[D";
-    readonly ARROW_RIGHT: "\u001B[C";
-    readonly ESCAPE: "\u001B";
-};

package/dist/lib/utils.js

@@ -1,12 +0,0 @@
-export const clearScreen = () => {
-    process.stdout.write('\x1B[2J\x1B[0f');
-};
-export const keys = {
-    CTRL_C: '\u0003',
-    ENTER: '\r',
-    ARROW_UP: '\u001b[A',
-    ARROW_DOWN: '\u001b[B',
-    ARROW_LEFT: '\u001b[D',
-    ARROW_RIGHT: '\u001b[C',
-    ESCAPE: '\u001b',
-};

package/dist/mock/board.d.ts

@@ -1,2 +0,0 @@
-import { type Board } from '../lib/types/board.model.js';
-export declare const board: Board;