@manyducks.co/dolla 2.0.0-alpha.8 → 2.0.0

package/dist/modules/dolla.d.ts

@@ -1,111 +0,0 @@
-import { createRef, isRef, MarkupNode, type Markup } from "../markup.js";
-import { createSettableState, createState, derive, toSettableState, toState, valueOf, watch, type State } from "../state.js";
-import { type ViewFunction, type ViewNode } from "../view.js";
-import { type CrashViewProps } from "../views/default-crash-view.js";
-import { HTTP } from "./http.js";
-import { Language } from "./language.js";
-import { Render } from "./render.js";
-import { Router } from "./router.js";
-export type Environment = "development" | "production";
-/**
- * Log type toggles. Each message category can be turned on or off or enabled only in a specific environment.
- */
-export type Loggles = {
-    info: boolean | Environment;
-    log: boolean | Environment;
-    warn: boolean | Environment;
-    error: boolean | Environment;
-};
-export interface Logger {
-    info(...args: any[]): void;
-    log(...args: any[]): void;
-    warn(...args: any[]): void;
-    error(...args: any[]): void;
-    crash(error: Error): void;
-}
-export interface LoggerErrorContext {
-    error: Error;
-    loggerName: string;
-    uid?: string;
-}
-export type LoggerOptions = {
-    /**
-     * Console object to use for logging (mostly for testing). Uses window.console by default.
-     */
-    console?: any;
-    /**
-     * Unique ID to print with logs. Makes it easier to track down messages from specific view instances.
-     */
-    uid?: string;
-};
-export declare class Dolla {
-    #private;
-    readonly http: HTTP;
-    readonly language: Language;
-    readonly render: Render;
-    readonly router: Router;
-    constructor();
-    createState: typeof createState;
-    createSettableState: typeof createSettableState;
-    toSettableState: typeof toSettableState;
-    toState: typeof toState;
-    valueOf: typeof valueOf;
-    derive: typeof derive;
-    watch: typeof watch;
-    createRef: typeof createRef;
-    isRef: typeof isRef;
-    /**
-     * True when the app is connected to a DOM node and displayed to the user.
-     */
-    get isMounted(): boolean;
-    /**
-     * Get the current environment that this app is running in.
-     * Environment affects which log messages will print and how much debugging info is included in the DOM.
-     */
-    getEnv(): Environment;
-    /**
-     * Sets the environment that this app is running in.
-     * Environment affects which log messages will print and how much debugging info is included in the DOM.
-     */
-    setEnv(value: Environment): void;
-    /**
-     * Sets the view that will be shown when the `crash` method is called on any logger.
-     * When a crash is reported the app will be unmounted and replaced with this crash page.
-     */
-    setCrashView(view: ViewFunction<CrashViewProps>): void;
-    mount(selector: string, view?: ViewFunction<any>): Promise<void>;
-    mount(element: HTMLElement, view?: ViewFunction<any>): Promise<void>;
-    unmount(): Promise<void>;
-    /**
-     * Registers a `callback` to run after `Dolla.mount` is called, before the app is mounted. If `callback` returns a Promise,
-     * it will be awaited before mounting finishes. Use this to perform initial setup before the app is displayed to the user.
-     */
-    beforeMount(callback: () => void | Promise<void>): void;
-    /**
-     * Registers a `callback` to run after the app is mounted.
-     */
-    onMount(callback: () => void): void;
-    /**
-     * Registers a `callback` to run after `Dolla.unmount` is called, before the app is unmounted. If `callback` returns a Promise,
-     * it will be awaited before unmounting finishes. Use this to perform cleanup.
-     */
-    beforeUnmount(callback: () => void | Promise<void>): void;
-    /**
-     * Registers a `callback` to run after the app is unmounted.
-     */
-    onUnmount(callback: () => void): void;
-    /**
-     * Update log type toggles. Values that are not passed will remain unchanged.
-     */
-    setLoggles(options: Partial<Loggles>): void;
-    setLogFilter(filter: string | RegExp): void;
-    createLogger(name: string | State<string>, options?: LoggerOptions): Logger;
-    /**
-     *
-     */
-    constructView<P>(view: ViewFunction<P>, props: P, children?: Markup[]): ViewNode;
-    /**
-     *
-     */
-    constructMarkup(markup: Markup | Markup[]): MarkupNode;
-}

package/dist/modules/language.d.ts

@@ -1,41 +0,0 @@
-import { type State } from "../state.js";
-import type { Stringable } from "../types.js";
-import type { Dolla } from "./dolla.js";
-/**
- * An object where values are either a translated string or another nested Translation object.
- */
-type LocalizedStrings = Record<string, string | Record<string, string | Record<string, string | Record<string, string>>>>;
-export interface LanguageConfig {
-    name: string;
-    /**
-     * Path to a JSON file with translated strings for this language.
-     */
-    path?: string;
-    /**
-     * A callback function that returns a Promise that resolves to the translation object for this language.
-     */
-    fetch?: () => Promise<LocalizedStrings>;
-}
-export type LanguageSetupOptions = {
-    /**
-     * Default language to load on startup
-     */
-    initialLanguage?: string | null;
-    languages: LanguageConfig[];
-};
-export declare class Language {
-    #private;
-    $current: State<string | undefined>;
-    constructor(dolla: Dolla);
-    get supportedLanguages(): string[];
-    setup(options: LanguageSetupOptions): void;
-    setLanguage(name: string): Promise<void>;
-    /**
-     * Returns a State containing the value at `key`.
-    
-     * @param key - Key to the translated value.
-     * @param values - A map of {{placeholder}} names and the values to replace them with.
-     */
-    t(key: string, values?: Record<string, Stringable | State<Stringable>>): State<string>;
-}
-export {};

package/dist/modules/render.d.ts

@@ -1,17 +0,0 @@
-import type { Dolla } from "./dolla.js";
-export declare class Render {
-    #private;
-    constructor(dolla: Dolla);
-    /**
-     * Queues a callback to run in the next render batch.
-     * Running your DOM mutations in update callbacks reduces layout thrashing.
-     * Returns a Promise that resolves once the callback has run.
-     */
-    update(callback: () => void, key?: string): Promise<void>;
-    /**
-     * Queues a callback that reads DOM information to run after the next render batch,
-     * ensuring all writes have been performed before reading.
-     * Returns a Promise that resolves once the callback has run.
-     */
-    read(callback: () => void): Promise<void>;
-}

package/dist/modules/router.d.ts

@@ -1,152 +0,0 @@
-import { type Stringable } from "../types.js";
-import { ViewNode, type ViewFunction } from "../view.js";
-import type { Dolla } from "./dolla.js";
-export interface RouteMatchContext {
-    /**
-     * Redirects the user to a different route instead of matching the current one.
-     */
-    redirect(path: string): void;
-}
-export interface Route {
-    /**
-     * The path or path fragment to match.
-     */
-    path: string;
-    /**
-     * Path to redirect to when this route is matched, or a callback function that returns such path.
-     */
-    redirect?: string | ((ctx: RouteRedirectContext) => string) | ((ctx: RouteRedirectContext) => Promise<string>);
-    /**
-     * View to display when this route is matched.
-     */
-    view?: ViewFunction<any>;
-    /**
-     * Subroutes.
-     */
-    routes?: Route[];
-    /**
-     * Called after the match is identified but before it is acted on. Use this to set state, load data, etc.
-     */
-    beforeMatch?: (ctx: RouteMatchContext) => void | Promise<void>;
-}
-export interface RouteConfig {
-    pattern: string;
-    meta: {
-        redirect?: string | ((ctx: RouteRedirectContext) => string) | ((ctx: RouteRedirectContext) => Promise<string>);
-        pattern?: string;
-        layers?: RouteLayer[];
-        beforeMatch?: (ctx: RouteMatchContext) => void | Promise<void>;
-    };
-}
-export interface RouteLayer {
-    id: number;
-    view: ViewFunction<{}>;
-}
-/**
- * Object passed to redirect callbacks. Contains information useful for determining how to redirect.
- */
-export interface RouteRedirectContext {
-    /**
-     * The path as it appears in the URL bar.
-     */
-    path: string;
-    /**
-     * The pattern that this path was matched with.
-     */
-    pattern: string;
-    /**
-     * Named route params parsed from `path`.
-     */
-    params: Record<string, string | number | undefined>;
-    /**
-     * Query params parsed from `path`.
-     */
-    query: Record<string, string | number | boolean | undefined>;
-}
-interface ParsedParams {
-    [key: string]: string | number | boolean | (string | number | boolean | null)[] | null;
-}
-interface ParsedQuery extends ParsedParams {
-}
-export interface NavigateOptions {
-    /**
-     * Replace the current item in the history stack instead of adding a new one.
-     * The back button will send the user to the page they visited before this. Defaults to false.
-     */
-    replace?: boolean;
-    /**
-     * Preserve existing query params (if any) when navigating. Defaults to false.
-     */
-    preserveQuery?: boolean;
-}
-export declare enum RoutingStyle {
-    /**
-     * Constructs routes like "https://www.example.com/#/sub/route" which work without any server-side setup.
-     * A good choice if your app has no backend.
-     */
-    hash = "hash",
-    /**
-     * Constructs routes like "https://www.example.com/sub/route" which look nicer (subjective?) than hash routes and are what most users will expect URLs to look like, but require additional backend setup.
-     * Path routing requires you to configure your backend to redirect to the app's index.html when subpaths are requested.
-     */
-    path = "path"
-}
-export interface RouterSetupOptions {
-    routes: Route[];
-    /**
-     * The routing style to use; "hash" will construct routes like "https://www.example.com/#/sub/route" which work without any server-side setup, while "path" will construct routes that use paths directly.
-     */
-    style?: RoutingStyle;
-}
-export interface RouterElements {
-    readonly rootElement?: HTMLElement;
-    readonly rootView?: ViewNode;
-}
-export declare class Router {
-    #private;
-    /**
-     * The currently matched route pattern, if any.
-     */
-    $pattern: import("../state.js").State<string | null>;
-    /**
-     * The current URL path.
-     */
-    $path: import("../state.js").State<string>;
-    /**
-     * The current named path params.
-     */
-    $params: import("../state.js").State<ParsedParams>;
-    /**
-     * The current query params. Changes to this object will be reflected in the URL.
-     */
-    $query: import("../state.js").State<ParsedQuery>;
-    constructor(dolla: Dolla, elements: RouterElements);
-    setup(options: RouterSetupOptions): void;
-    /**
-     * Navigates to another route.
-     *
-     * @example
-     * navigate("/login"); // navigate to `/login`
-     * navigate(["/users", 215], { replace: true }); // replace current history entry with `/users/215`
-     */
-    go(path: Stringable | Stringable[], options?: NavigateOptions): void;
-    /**
-     * Navigate backward. Pass a number of steps to hit the back button that many times.
-     */
-    back(steps?: number): void;
-    /**
-     * Navigate forward. Pass a number of steps to hit the forward button that many times.
-     */
-    forward(steps?: number): void;
-}
-/**
- * Intercepts links within the root node.
- *
- * This is adapted from https://github.com/choojs/nanohref/blob/master/index.js
- *
- * @param root - Element under which to intercept link clicks
- * @param callback - Function to call when a click event is intercepted
- * @param _window - (optional) Override for global window object
- */
-export declare function catchLinks(root: HTMLElement, callback: (anchor: HTMLAnchorElement) => void, _window?: Window & typeof globalThis): () => void;
-export {};

package/dist/nodes/cond.d.ts

@@ -1,26 +0,0 @@
-import { type MarkupNode, type ElementContext, type Markup } from "../markup.js";
-import { type State, type StopFunction } from "../state.js";
-import { type Renderable } from "../types.js";
-export interface ConditionalConfig {
-    $predicate: State<any>;
-    thenContent?: Renderable;
-    elseContent?: Renderable;
-    elementContext: ElementContext;
-}
-export declare class Conditional implements MarkupNode {
-    node: Node;
-    endNode: Node;
-    $predicate: State<any>;
-    stopCallback?: StopFunction;
-    thenContent?: Markup[];
-    elseContent?: Markup[];
-    connectedContent: MarkupNode[];
-    elementContext: ElementContext;
-    initialUpdateHappened: boolean;
-    previousValue?: any;
-    constructor(config: ConditionalConfig);
-    get isMounted(): boolean;
-    mount(parent: Node, after?: Node | undefined): void;
-    unmount(): void;
-    update(value: any): void;
-}

package/dist/nodes/html.d.ts

@@ -1,31 +0,0 @@
-import { type ElementContext, type Markup, type MarkupNode, type Ref } from "../markup.js";
-import { type StopFunction } from "../state.js";
-type HTMLOptions = {
-    elementContext: ElementContext;
-    tag: string;
-    props: Record<string, any>;
-    children?: Markup[];
-};
-export declare class HTML implements MarkupNode {
-    node: HTMLElement | SVGElement;
-    props: Record<string, any>;
-    children: MarkupNode[];
-    stopCallbacks: StopFunction[];
-    elementContext: ElementContext;
-    uniqueId: string;
-    ref?: Ref<any>;
-    canClickAway: boolean;
-    get isMounted(): boolean;
-    constructor({ tag, props, children, elementContext }: HTMLOptions);
-    mount(parent: Node, after?: Node): void;
-    unmount(): void;
-    getUpdateKey(type: string, value: string | number): string;
-    applyProps(element: HTMLElement | SVGElement, props: Record<string, unknown>): void;
-    applyStyles(element: HTMLElement | SVGElement, styles: unknown, stopCallbacks: StopFunction[]): () => void;
-    applyClasses(element: HTMLElement | SVGElement, classes: unknown, stopCallbacks: StopFunction[]): () => void;
-}
-/**
- * Converts a camelCase string to kebab-case.
- */
-export declare function camelToKebab(value: string): string;
-export {};

package/dist/nodes/observer.d.ts

@@ -1,29 +0,0 @@
-import { type ElementContext, type MarkupNode } from "../markup.js";
-import { type State } from "../state.js";
-import type { Renderable } from "../types.js";
-interface ObserverOptions {
-    elementContext: ElementContext;
-    states: State<any>[];
-    renderFn: (...values: any) => Renderable;
-}
-/**
- * Displays dynamic children without a parent element.
- */
-export declare class Observer implements MarkupNode {
-    node: Node;
-    endNode: Node;
-    connectedViews: MarkupNode[];
-    renderFn: (...values: any) => Renderable;
-    elementContext: ElementContext;
-    observerControls: {
-        start: () => void;
-        stop: () => void;
-    };
-    get isMounted(): boolean;
-    constructor({ states, renderFn, elementContext }: ObserverOptions);
-    mount(parent: Node, after?: Node): void;
-    unmount(): void;
-    cleanup(): void;
-    update(...children: Renderable[]): void;
-}
-export {};

package/dist/nodes/outlet.d.ts

@@ -1,22 +0,0 @@
-import { type MarkupNode, type ElementContext } from "../markup.js";
-import { type State, type StopFunction } from "../state.js";
-export interface OutletConfig {
-    $children: State<MarkupNode[]>;
-    elementContext: ElementContext;
-}
-/**
- * Manages an array of DOMHandles.
- */
-export declare class Outlet implements MarkupNode {
-    node: Node;
-    endNode: Node;
-    $children: State<MarkupNode[]>;
-    stopCallback?: StopFunction;
-    connectedChildren: MarkupNode[];
-    elementContext: ElementContext;
-    constructor(config: OutletConfig);
-    get isMounted(): boolean;
-    mount(parent: Node, after?: Node | undefined): void;
-    unmount(): void;
-    update(newChildren: MarkupNode[]): void;
-}

package/dist/nodes/portal.d.ts

@@ -1,19 +0,0 @@
-import { type MarkupNode, type ElementContext } from "../markup.js";
-import { type Renderable } from "../types.js";
-interface PortalConfig {
-    content: Renderable;
-    parent: Node;
-    elementContext: ElementContext;
-}
-/**
- * Renders content into a specified parent node.
- */
-export declare class Portal implements MarkupNode {
-    config: PortalConfig;
-    handle?: MarkupNode;
-    get isMounted(): boolean;
-    constructor(config: PortalConfig);
-    mount(_parent: Node, _after?: Node): void;
-    unmount(): void;
-}
-export {};

package/dist/nodes/repeat.d.ts

@@ -1,34 +0,0 @@
-import { type MarkupNode, type ElementContext } from "../markup.js";
-import { type State, type Setter, type StopFunction } from "../state.js";
-import { type ViewContext, type ViewResult } from "../view.js";
-interface RepeatOptions<T> {
-    elementContext: ElementContext;
-    $items: State<T[]>;
-    keyFn: (value: T, index: number) => string | number | symbol;
-    renderFn: ($value: State<T>, $index: State<number>, ctx: ViewContext) => ViewResult;
-}
-type ConnectedItem<T> = {
-    key: any;
-    $value: State<T>;
-    setValue: Setter<T>;
-    $index: State<number>;
-    setIndex: Setter<number>;
-    handle: MarkupNode;
-};
-export declare class Repeat<T> implements MarkupNode {
-    node: Node;
-    endNode: Node;
-    $items: State<T[]>;
-    stopCallback?: StopFunction;
-    connectedItems: ConnectedItem<T>[];
-    elementContext: ElementContext;
-    renderFn: ($value: State<T>, $index: State<number>, ctx: ViewContext) => ViewResult;
-    keyFn: (value: T, index: number) => string | number | symbol;
-    get isMounted(): boolean;
-    constructor({ elementContext, $items, renderFn, keyFn }: RepeatOptions<T>);
-    mount(parent: Node, after?: Node): void;
-    unmount(): void;
-    _cleanup(): void;
-    _update(value: T[]): void;
-}
-export {};

package/dist/nodes/text.d.ts

@@ -1,19 +0,0 @@
-import { type MarkupNode } from "../markup.js";
-import { type MaybeState, type StopFunction } from "../state.js";
-interface Stringable {
-    toString(): string;
-}
-interface TextOptions {
-    value: MaybeState<Stringable>;
-}
-export declare class Text implements MarkupNode {
-    node: globalThis.Text;
-    value: MaybeState<Stringable>;
-    stopCallback?: StopFunction;
-    get isMounted(): boolean;
-    constructor({ value }: TextOptions);
-    mount(parent: Node, after?: Node | null): Promise<void>;
-    unmount(): Promise<void>;
-    update(value?: Stringable): void;
-}
-export {};