@davidsouther/jiffies 1.0.0-beta.1

package/README.md

@@ -0,0 +1,60 @@
+# Jiffies
+
+JEFRi Jiffies are a number of "common" utilities for JavaScript/TypeScript pulled from and inspired by other programming languages, and common base tools missing or inconsistent between DOM and Node runtimes.
+
+- `assert` - common runtime assertions.
+- `context` - JavaScript implementation of the Python [`with`][pywith] statement.
+- `display` - TypeScript implementation of the Rust [Display][rustdisplay] trait.
+- `equal` - JavaScript deep equality checkers, including TS type checking.
+- `flags` - JavaScript flag, environment, and configuration loader.
+- `log` - JavaScript implementation of a [log4j][log4j]-alike logger.
+- `result` - JavaScript implementation of Rust's [Option][rustoption] and [Result][rustresult] types.
+- `loader.mjs` - Node 16.x typescript-transpiling module loader.
+
+Jiffies also includes several microframeworks.
+
+- `dom` - a tiny DOM functional library.
+- `pico` - a copy of [PicoCSS](pico.css).
+- `scope` - JavaScript testing microframework.
+- `server` - Node HTTP Server & middleware.
+
+## Development
+
+1.  Clone jiffies
+1.  cd jiffies
+1.  npm install
+1.  npm link
+
+After any edit
+
+1. npm run build
+
+Alternatively, in a background terminal
+
+1. npm run watch &
+
+## Apps
+
+### Starting
+
+1. Create app folder
+1. npm init
+1. npm install -D prettier typescript@next
+1. npm link @jefri/jiffies
+
+<!--
+TODO(Make @jefri/create)
+
+1.  npm init @jefri
+
+*   .gitignore
+*   package.json
+*   tsconfig.json
+*   src/main.ts
+*   src/index.html
+*   src/app.ts
+-->
+
+### Running
+
+1. npm start

package/build/assert.d.ts

@@ -0,0 +1,23 @@
+declare type AssertMessage = string | (() => string);
+/**
+ * Throw an error when a condition is not met.
+ */
+export declare function assert(condition: boolean, message?: AssertMessage): void | never;
+/**
+ * Given a value, return it if it is not null nor undefined. Otherwise throw an
+ * error.
+ *
+ * @template T
+ * @returns {NonNullable<T>}
+ */
+export declare function assertExists<T>(t: T, message?: AssertMessage): NonNullable<T>;
+/**
+ * @param {*} n
+ * @returns string
+ */
+export declare function assertString(n: unknown, message?: AssertMessage): string;
+/**
+ * Compile time assertion that no value will used at this point in control flow.
+ */
+export declare function checkExhaustive(value: never, message?: AssertMessage): never;
+export {};

package/build/assert.js

@@ -0,0 +1,33 @@
+/**
+ * Throw an error when a condition is not met.
+ */
+export function assert(condition, message = "Assertion failed") {
+    if (!condition) {
+        throw new Error(message instanceof Function ? message() : message);
+    }
+}
+/**
+ * Given a value, return it if it is not null nor undefined. Otherwise throw an
+ * error.
+ *
+ * @template T
+ * @returns {NonNullable<T>}
+ */
+export function assertExists(t, message = "Assertion failed: value does not exist") {
+    assert(t != null, message);
+    return t;
+}
+/**
+ * @param {*} n
+ * @returns string
+ */
+export function assertString(n, message = () => `Assertion failed: ${n} is not a string`) {
+    assert(typeof n == "string", message);
+    return n;
+}
+/**
+ * Compile time assertion that no value will used at this point in control flow.
+ */
+export function checkExhaustive(value, message = `Unexpected value ${value}`) {
+    throw new Error(message instanceof Function ? message() : message);
+}

package/build/case.d.ts

@@ -0,0 +1 @@
+export declare function dashCase(identifier: string): string;

package/build/case.js

@@ -0,0 +1,5 @@
+export function dashCase(identifier) {
+    return identifier
+        .replace(/([a-z])([A-Z])/g, (_, a, b) => `${a}-${b.toLowerCase()}`)
+        .replace(/ ([A-Z])/g, (_, b) => `-${b.toLowerCase()}`);
+}

package/build/components/button_bar.d.ts

@@ -0,0 +1,8 @@
+declare const ButtonBar: import("../dom/fc.js").FCComponentCtor<{
+    value: T;
+    values: T[];
+    events: {
+        onSelect: (current: T) => void;
+    };
+}, {}>;
+export default ButtonBar;

package/build/components/button_bar.js

@@ -0,0 +1,16 @@
+import { display } from "../display.js";
+import { FC } from "../dom/fc.js";
+import { a, li, ul } from "../dom/html.js";
+const ButtonBar = FC("button-bar", (el, { value, values, events }) => ul({ class: "ButtonBar__wrapper" }, ...values.map((option) => li(a({
+    href: "#",
+    class: `ButtonBar__${`${option}`.replace(/\s+/g, "_").toLowerCase()}
+                ${option === value ? "" : "secondary"}
+                `.replace(/[\n\s]+/, " "),
+    events: {
+        click: (e) => {
+            e.preventDefault();
+            events.onSelect(option);
+        },
+    },
+}, display(option))))));
+export default ButtonBar;

package/build/components/index.d.ts

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

package/build/components/index.js

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

package/build/components/inline_edit.d.ts

@@ -0,0 +1,12 @@
+export interface InlineEditState {
+    mode: number;
+    value: string;
+}
+export declare const InlineEdit: import("../dom/fc.js").FCComponentCtor<{
+    mode?: number | undefined;
+    value: string;
+    events: {
+        change: (value: string) => void;
+    };
+}, InlineEditState>;
+export default InlineEdit;

package/build/components/inline_edit.js

@@ -0,0 +1,48 @@
+import { width } from "../dom/css/sizing.js";
+import { FC, State } from "../dom/fc.js";
+import { input, span } from "../dom/html.js";
+const Mode = { VIEW: 0, EDIT: 1 };
+export const InlineEdit = FC("inline-edit", (el, { mode = Mode.VIEW, value, events }) => {
+    const state = (el[State] ??= { mode, value });
+    const render = () => {
+        switch (state.mode) {
+            case Mode.EDIT:
+                return edit();
+            case Mode.VIEW:
+                return view();
+            default:
+                return span();
+        }
+    };
+    const view = () => span({
+        style: { cursor: "text", ...width("full", "inline") },
+        events: {
+            click: () => {
+                state.mode = Mode.EDIT;
+                el.update(render());
+            },
+        },
+    }, state.value ?? "");
+    const edit = () => {
+        const edit = span({ style: { display: "block", position: "relative" } }, input({
+            style: {
+                zIndex: "10",
+                position: "absolute",
+                left: "0",
+                marginTop: "-0.375rem",
+            },
+            events: {
+                blur: ({ target }) => events.change(target?.value ?? ""),
+            },
+            type: "text",
+            value: state.value,
+        }), "\u00a0" // Hack to get the span to take up space
+        );
+        setTimeout(() => {
+            edit.dispatchEvent(new Event("focus"));
+        });
+        return edit;
+    };
+    return render();
+});
+export default InlineEdit;

package/build/components/logger.d.ts

@@ -0,0 +1,7 @@
+import { DOMElement, Updatable } from "../dom/dom.js";
+import { Logger } from "../log.js";
+export interface HTMLLogger extends Logger {
+    root: Updatable<DOMElement>;
+}
+export declare function isHTMLLogger(logger: Logger): logger is HTMLLogger;
+export declare function makeHTMLLogger(name: string): HTMLLogger;

package/build/components/logger.js

@@ -0,0 +1,22 @@
+import { display } from "../display.js";
+import { div, span, ul, li, pre, code } from "../dom/html.js";
+import { LEVEL } from "../log.js";
+export function isHTMLLogger(logger) {
+    return logger.root != undefined;
+}
+export function makeHTMLLogger(name) {
+    let log;
+    const root = div(div(span(name)), (log = ul()));
+    const logger = { level: LEVEL.INFO, root };
+    function append(message) {
+        log.appendChild(li(pre(code(message))));
+    }
+    const logAt = (level) => (message) => level >= (logger.level ?? LEVEL.ERROR)
+        ? append(display(message))
+        : undefined;
+    logger.debug = logAt(LEVEL.VERBOSE);
+    logger.info = logAt(LEVEL.INFO);
+    logger.warn = logAt(LEVEL.WARN);
+    logger.error = logAt(LEVEL.ERROR);
+    return logger;
+}

package/build/components/select.d.ts

@@ -0,0 +1,13 @@
+import { EventHandler } from "../dom/dom.js";
+export declare const Select: import("../dom/fc.js").FCComponentCtor<{
+    name: string;
+    value: string;
+    events: {
+        change: EventHandler;
+    };
+    disabled: boolean;
+    options: [
+        string,
+        string
+    ][];
+}, {}>;

package/build/components/select.js

@@ -0,0 +1,3 @@
+import { FC } from "../dom/fc.js";
+import { option, select } from "../dom/html.js";
+export const Select = FC("jiffies-select", (el, { name, events: { change }, disabled, value, options }) => select({ name, events: { change }, disabled }, ...options.map(([v, name]) => option({ value: v, selected: value === v }, `${name}`))));

package/build/components/test.d.ts

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

package/build/components/test.js

@@ -0,0 +1,2 @@
+await import("./virtual_scroll.test.js");
+export {};

package/build/components/virtual_scroll.d.ts

@@ -0,0 +1,41 @@
+import { UHTMLElement } from "../dom/html.js";
+export interface VirtualScrollSettings {
+    minIndex: number;
+    maxIndex: number;
+    startIndex: number;
+    itemHeight: number;
+    count: number;
+    tolerance: number;
+}
+export interface VirtualScrollDataAdapter<T> {
+    (offset: number, limit: number): Iterable<T>;
+}
+export declare function arrayAdapter<T>(data: T[]): VirtualScrollDataAdapter<T>;
+export interface VirtualScrollProps<T, U extends HTMLElement> {
+    settings: Partial<VirtualScrollSettings>;
+    get: VirtualScrollDataAdapter<T>;
+    row: (t: T) => UHTMLElement<U>;
+}
+export declare function fillVirtualScrollSettings(settings: Partial<VirtualScrollSettings>): VirtualScrollSettings;
+export declare function initialState<T>(settings: VirtualScrollSettings): VirtualScrollState<T>;
+export declare function getData<T>(minIndex: number, maxIndex: number, offset: number, limit: number, get: VirtualScrollDataAdapter<T>): T[];
+export declare function doScroll<T>(scrollTop: number, state: VirtualScrollState<T>, get: VirtualScrollDataAdapter<T>): {
+    scrollTop: number;
+    topPaddingHeight: number;
+    bottomPaddingHeight: number;
+    data: T[];
+};
+interface VirtualScrollState<T, U extends HTMLElement = HTMLElement> {
+    settings: VirtualScrollSettings;
+    scrollTop: number;
+    bufferedItems: number;
+    totalHeight: number;
+    viewportHeight: number;
+    topPaddingHeight: number;
+    bottomPaddingHeight: number;
+    toleranceHeight: number;
+    data: T[];
+    rows: UHTMLElement<U>[];
+}
+export declare const VirtualScroll: import("../dom/fc.js").FCComponentCtor<VirtualScrollProps<unknown, HTMLElement>, VirtualScrollState<unknown, HTMLElement>>;
+export default VirtualScroll;

package/build/components/virtual_scroll.js

@@ -0,0 +1,94 @@
+import { debounce } from "../debounce.js";
+import { FC, State } from "../dom/fc.js";
+import { div } from "../dom/html.js";
+export function arrayAdapter(data) {
+    return (offset, limit) => data.slice(offset, offset + limit);
+}
+export function fillVirtualScrollSettings(settings) {
+    const { minIndex = 0, maxIndex = 1, startIndex = 0, itemHeight = 20, count = maxIndex - minIndex + 1, tolerance = count, } = settings;
+    return { minIndex, maxIndex, startIndex, itemHeight, count, tolerance };
+}
+export function initialState(settings) {
+    // From Denis Hilt, https://blog.logrocket.com/virtual-scrolling-core-principles-and-basic-implementation-in-react/
+    const { minIndex, maxIndex, startIndex, itemHeight, count, tolerance } = settings;
+    const bufferedItems = count + 2 * tolerance;
+    const itemsAbove = Math.max(0, startIndex - tolerance - minIndex);
+    const viewportHeight = count * itemHeight;
+    const totalHeight = (maxIndex - minIndex + 1) * itemHeight;
+    const toleranceHeight = tolerance * itemHeight;
+    const bufferHeight = viewportHeight + 2 * toleranceHeight;
+    const topPaddingHeight = itemsAbove * itemHeight;
+    const bottomPaddingHeight = totalHeight - (topPaddingHeight + bufferHeight);
+    return {
+        scrollTop: 0,
+        settings,
+        viewportHeight,
+        totalHeight,
+        toleranceHeight,
+        bufferedItems,
+        topPaddingHeight,
+        bottomPaddingHeight,
+        data: [],
+        rows: [],
+    };
+}
+export function getData(minIndex, maxIndex, offset, limit, get) {
+    const start = Math.max(0, minIndex, offset);
+    const end = Math.min(maxIndex, offset + limit - 1);
+    const data = get(start, end - start);
+    return [...data];
+}
+export function doScroll(scrollTop, state, get) {
+    const { totalHeight, toleranceHeight, bufferedItems, settings: { itemHeight, minIndex, maxIndex }, } = state;
+    const index = minIndex + Math.floor((scrollTop - toleranceHeight) / itemHeight);
+    const data = getData(minIndex, maxIndex, index, bufferedItems, get);
+    const topPaddingHeight = Math.max((index - minIndex) * itemHeight, 0);
+    const bottomPaddingHeight = Math.max(totalHeight - (topPaddingHeight + data.length * itemHeight), 0);
+    return { scrollTop, topPaddingHeight, bottomPaddingHeight, data };
+}
+// export interface VirtualScroll<T, U extends HTMLElement> {
+//   state: VirtualScrollState<T>;
+//   rows: UHTMLElement<U>[];
+// }
+export const VirtualScroll = FC("virtual-scroll", (element, props) => {
+    const settings = fillVirtualScrollSettings(props.settings);
+    const state = (element[State] = {
+        ...initialState(settings),
+        ...element[State],
+    });
+    const scrollTo = ({ target } = { target: state }) => {
+        const scrollTop = target?.scrollTop ?? state.topPaddingHeight;
+        const updatedSate = {
+            ...state,
+            ...doScroll(scrollTop, state, props.get),
+        };
+        setState(updatedSate);
+    };
+    const viewportElement = div({
+        style: { height: `${state.viewportHeight}px`, overflowY: "scroll" },
+        events: { scroll: debounce(scrollTo, 0) },
+    });
+    setTimeout(() => {
+        viewportElement.scroll({ top: state.scrollTop });
+    });
+    const setState = (newState) => {
+        state.scrollTop = newState.scrollTop;
+        state.topPaddingHeight = newState.topPaddingHeight;
+        state.bottomPaddingHeight = newState.bottomPaddingHeight;
+        state.data = newState.data;
+        element[State].rows = state.data.map(props.row);
+        viewportElement.update(div({
+            class: "VirtualScroll__topPadding",
+            style: { height: `${state.topPaddingHeight}px` },
+        }), ...(element[State].rows ?? []).map((row, i) => div({
+            class: `VirtualScroll__item_${i}`,
+            style: { height: `${settings.itemHeight}px` },
+        }, row)), div({
+            class: "VirtualScroll__bottomPadding",
+            style: { height: `${state.bottomPaddingHeight}px` },
+        }));
+    };
+    scrollTo();
+    return viewportElement;
+});
+export default VirtualScroll;

package/build/components/virtual_scroll.test.d.ts

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

package/build/components/virtual_scroll.test.js

@@ -0,0 +1,21 @@
+import { State } from "../dom/fc.js";
+import { div } from "../dom/html.js";
+import { describe, it, expect } from "../scope/index.js";
+import VirtualScroll, { arrayAdapter, } from "./virtual_scroll.js";
+describe("VirtualScroll", () => {
+    it("tracks scroll position", () => {
+        const data = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9];
+        const props = {
+            settings: { count: 3, startIndex: 2 },
+            get: arrayAdapter(data),
+            row: (i) => div(`${i}`),
+        };
+        // @ts-ignore TODO(TFC)
+        const scroll = VirtualScroll(props);
+        expect(scroll[State].bufferedItems).toBe(9);
+        expect(scroll[State].data).toEqual([0, 1, 2, 3, 4, 5, 6, 7, 8]);
+        //expect(scroll.state.topPaddingHeight).toBe(0);
+        expect(scroll[State].viewportHeight).toBe(60);
+        //expect(scroll.state.totalHeight).toBe(200);
+    });
+});

package/build/context.d.ts

@@ -0,0 +1,15 @@
+import { Err, Result } from "./result.js";
+export declare const Enter: unique symbol;
+export declare const Exit: unique symbol;
+export interface Context {
+    [Enter]: () => void;
+    [Exit]: () => void;
+}
+export interface Operation<T, E extends Error, C extends Context> {
+    (c: C): T | Result<T, E>;
+}
+export interface AsyncOperation<T, E extends Error, C extends Context> {
+    (c: C): Promise<T | Result<T, E>>;
+}
+export declare function using<T, E extends Error, C extends Context>(context: C | (() => C) | Operation<T, E, C>, operation?: Operation<T, E, C>, normalizeError?: (e: Error | unknown | any) => Err<E>): Result<T, E>;
+export declare function asyncUsing<T, E extends Error, C extends Context>(context: C | (() => Promise<C>), operation: AsyncOperation<T, E, C>, normalizeError?: (e: Error | unknown | any) => Err<E>): Promise<Result<T, E>>;

package/build/context.js

@@ -0,0 +1,43 @@
+import { Ok, Err, isResult } from "./result.js";
+export const Enter = Symbol("Context Enter");
+export const Exit = Symbol("Context Exit");
+export function using(context, operation, normalizeError = (e) => Err(e)) {
+    if (typeof context == "function") {
+        if (context.length == 1) {
+            operation = context;
+            context = {};
+        }
+        else {
+            context = context();
+        }
+    }
+    let result;
+    try {
+        context[Enter]();
+        const op = operation(context);
+        result = isResult(op) ? op : Ok(op);
+    }
+    catch (e) {
+        result = normalizeError(e);
+    }
+    finally {
+        context[Exit]();
+    }
+    return result;
+}
+export async function asyncUsing(context, operation, normalizeError = (e) => Err(e)) {
+    context = typeof context == "function" ? await context() : context;
+    let result;
+    try {
+        context[Enter]();
+        const op = await operation(context);
+        result = isResult(op) ? op : Ok(op);
+    }
+    catch (e) {
+        result = normalizeError(e);
+    }
+    finally {
+        context[Exit]();
+    }
+    return result;
+}

package/build/context.test.d.ts

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

package/build/context.test.js

@@ -0,0 +1,46 @@
+import { Enter, Exit, using } from "./context.js";
+import { Err, isErr, isOk, Ok, unwrap } from "./result.js";
+import { describe, it } from "./scope/describe.js";
+import { expect } from "./scope/expect.js";
+describe("Context", () => {
+    it("performs an operation using a context", () => {
+        const context = TestContext();
+        const result = using(context, () => Ok(5));
+        expect(unwrap(result)).toBe(5);
+        expect(context.initialized).toBe(true);
+        expect(context.completed).toBe(true);
+    });
+    it("reports the result of a thrown error", () => {
+        const context = TestContext();
+        const result = using(context, () => {
+            throw new Error("Failed");
+        });
+        expect(isErr(result)).toBe(true);
+        expect(Err(result)).toMatchObject({
+            message: "Failed",
+        });
+    });
+    it("passes the context to the operation", () => {
+        const op = using(TestContext, ({ initialized, completed }) => ({
+            initialized,
+            completed,
+        }));
+        expect(isOk(op)).toBe(true);
+        const { completed, initialized } = unwrap(op);
+        expect(initialized).toBe(true);
+        expect(completed).toBe(false);
+    });
+});
+function TestContext() {
+    const context = {
+        [Enter]: () => {
+            context.initialized = true;
+        },
+        [Exit]: () => {
+            context.completed = true;
+        },
+        initialized: false,
+        completed: false,
+    };
+    return context;
+}

package/build/debounce.d.ts

@@ -0,0 +1 @@
+export declare function debounce(fn: (...args: any[]) => any, ms?: number): (...args: Parameters<typeof fn>) => ReturnType<typeof fn>;

package/build/debounce.js

@@ -0,0 +1,7 @@
+export function debounce(fn, ms = 32) {
+    let timer;
+    return (...args) => {
+        clearTimeout(timer);
+        timer = setTimeout(() => (clearTimeout(timer), fn(...args)), ms);
+    };
+}

package/build/display.d.ts

@@ -0,0 +1,5 @@
+export declare type Display = string | {
+    toString(): string;
+};
+export declare const isDisplay: (a: unknown) => a is Display;
+export declare const display: (a: unknown | Display) => string;

package/build/display.js

@@ -0,0 +1,3 @@
+export const isDisplay = (/** @type unknown */ a) => typeof a.toString === "function" ||
+    typeof a === "string";
+export const display = (a) => isDisplay(a) ? a.toString() : JSON.stringify(a);

package/build/dom/css/border.d.ts

@@ -0,0 +1,11 @@
+import { Properties } from "../types/css.js";
+import { Side, Size } from "./constants.js";
+export declare function rounded(size?: Size, side?: Side): Properties<0 | (string & {}), string & {}>;
+export declare function border({ side, style, radius, width, color, }: {
+    side?: Side;
+    style?: "solid" | "dotted" | "dashed" | "double" | "none";
+    radius?: Size;
+    width?: 0 | 1 | 2 | 4 | 8;
+    color?: string;
+}): {};
+export declare function inset(width: 0 | 1 | 2 | 4 | 8, color1?: string, color2?: string): {};

package/build/dom/css/border.js

@@ -0,0 +1,27 @@
+import { isSide, getSize, getSide } from "./core.js";
+export function rounded(size = "", side = "") {
+    if (isSide(size)) {
+        side = size;
+        size = "";
+    }
+    const sized = getSize(size);
+    return getSide(side).reduce((prev, curr) => {
+        if (curr === "") {
+            prev.borderRadius = sized;
+        }
+        else {
+            // @ts-ignore
+            prev[`border${curr}Radius`] = sized;
+        }
+        return prev;
+    }, {});
+}
+export function border({ side = "", style = "solid", radius = "", width = 1, color = "black", }) {
+    return {};
+}
+export function inset(width, color1 = "gray", color2 = "lightgray") {
+    return {
+        ...border({ side: "tl", width, color: color1, radius: "none" }),
+        ...border({ side: "br", width, color: color2, radius: "none" }),
+    };
+}

package/build/dom/css/constants.d.ts

@@ -0,0 +1,31 @@
+export declare const Sizes: {
+    none: string;
+    sm: string;
+    "": string;
+    md: string;
+    lg: string;
+    xl: string;
+    "2xl": string;
+    "3xl": string;
+    full: string;
+};
+export declare const Sides: {
+    "": string;
+    t: string;
+    r: string;
+    l: string;
+    b: string;
+    tl: string;
+    tr: string;
+    bl: string;
+    br: string;
+};
+export declare const Widths: {
+    "1/4": string;
+    "1/2": string;
+    "3/4": string;
+    full: string;
+};
+export declare type Size = keyof typeof Sizes;
+export declare type Side = keyof typeof Sides;
+export declare type Width = keyof typeof Widths;