@manyducks.co/dolla 2.0.0-alpha.34 → 2.0.0-alpha.36

package/README.md

@@ -7,7 +7,7 @@
 
 Dolla is a batteries-included JavaScript frontend framework covering the needs of moderate-to-complex single page apps:
 
-- ⚡ Reactive DOM updates with [State](./docs/state.md). Inspired by Signals, but with explicit tracking.
+- ⚡ Reactive DOM updates with [Signals](./docs/state.md).
 - 📦 Reusable components with [Views](./docs/views.md).
 - 💾 Reusable state management with [Stores](./docs/stores.md).
 - 🔀 Built-in [routing](./docs/router.md) with nested routes and middleware support (check login status, preload data, etc).
@@ -25,7 +25,7 @@ Dolla's goals include:
 
 > TODO: Write about why Dolla was started and what it's all about.
 
-- Borne of frustration using React and similar libs (useEffect, referential equality, a pain to integrate other libs into its lifecycle, need to hunt for libraries to move beyond Hello World).
+- Borne of frustration using React and similar libs (useEffect, referential equality, a pain to integrate other libs into its lifecycle, need to hunt for libraries to move much beyond Hello World).
 - Merges ideas from my favorite libraries and frameworks (Solid/Knockout, Choo, Svelte, i18next, etc) into one curated set designed to work well together.
 - Opinionated (with the _correct_ opinions).
 - Many mainstream libraries seem too big for what they do. The entirety of Dolla is less than half the size of [`react-router`](https://bundlephobia.com/package/react-router@7.1.5).
@@ -35,33 +35,20 @@ Dolla's goals include:
 A basic view. Note that the view function is called exactly once when the view is first mounted. All changes to DOM nodes thereafter happen as a result of `$state` values changing.
 
 ```js
-import Dolla, { createState } from "@manyducks.co/dolla";
+import Dolla, { atom, effect, get, html } from "@manyducks.co/dolla";
 
 function Counter() {
-  const [$count, setCount] = createState(0);
+  const count = atom(0);
 
-  function increment() {
-    setCount((count) => count + 1);
-  }
-
-  function decrement() {
-    setCount((count) => count - 1);
-  }
-
-  function reset() {
-    setCount(0);
-  }
-
-  return (
+  return html`
     <div>
-      <p>Clicks: {$count}</p>
+      <p>Counter: ${count}</p>
       <div>
-        <button onClick={decrement}>-1</button>
-        <button onClick={reset}>Reset</button>
-        <button onClick={increment}>+1</button>
+        <button onclick=${() => count.value--}>-1</button>
+        <button onclick=${() => count.value++}>+1</button>
       </div>
     </div>
-  );
+  `;
 });
 
 Dolla.mount(document.body, Counter);

package/dist/core/{batch.d.ts → _batch.d.ts}

@@ -7,11 +7,15 @@ export declare class Batch {
     constructor(dolla: Dolla);
     /**
      * Queues a callback that runs before the next batch of writes.
+     *
+     * @deprecated
      */
     read(callback: () => void): void;
     /**
      * Queues a callback to run in the next render batch.
      * Always put DOM mutations in a write callback when possible to help Dolla batch them efficiently.
+     *
+     * @deprecated
      */
     write(callback: () => void, key?: string): void;
 }

package/dist/core/_signals_new.d.ts

@@ -0,0 +1,130 @@
+import { type Dependency, type Subscriber } from "alien-signals";
+/**
+ * A function to compare the current and next values. Returning `true` means the value has changed.
+ */
+export type EqualityFunction<T> = (current: T, next: T) => boolean;
+export interface ReactiveOptions<T> {
+    /**
+     * A label for debugging purposes.
+     */
+    name?: string;
+    /**
+     * A function to compare the current and next values. Returning `true` means the value has changed.
+     */
+    equals?: EqualityFunction<T>;
+}
+export interface Effect extends Subscriber, Dependency {
+    name?: string;
+    fn(): void;
+}
+export interface Computed<T = any> extends Signal<T | undefined>, Subscriber {
+    name?: string;
+    getter: (cachedValue?: T) => T;
+    equals: EqualityFunction<T>;
+}
+export interface Signal<T = any> extends Dependency {
+    name?: string;
+    currentValue: T;
+}
+/**
+ * A readable reactive state object.
+ */
+export interface Reactive<T> {
+    readonly name?: string;
+    /**
+     * The current value. Read-only.
+     */
+    readonly value: T;
+}
+export interface Atom<T> extends Reactive<T> {
+    /**
+     * The current value.
+     */
+    value: T;
+}
+export type MaybeReactive<T> = Reactive<T> | T;
+export type UnsubscribeFunction = () => void;
+/**
+ * Determines if a value is reactive.
+ */
+export declare function isReactive<T>(value: any): value is Reactive<T>;
+/**
+ * Creates a simple reactive container that stores a value.
+ * Atom values can be read and updated with the `value` property
+ *
+ * @example
+ * const count = atom(1);
+ * count.value++;
+ * count.value; // 2
+ */
+export declare function atom<T>(): Atom<T | undefined>;
+/**
+ * Creates a simple reactive container that stores a value.
+ * Atom values can be read and updated with the `value` property.
+ *
+ * @example
+ * const count = atom(1);
+ * count.value++;
+ * count.value; // 2
+ */
+export declare function atom<T>(value: T, options?: ReactiveOptions<T>): Atom<T>;
+/**
+ * Creates a simple reactive container that stores a value.
+ * Atom values can be read and updated with the `value` property.
+ *
+ * @example
+ * const count = atom(1);
+ * count.value++;
+ * count.value; // 2
+ */
+export declare function atom<T>(value?: T, options?: ReactiveOptions<T>): Atom<T | undefined>;
+type ComposeCallback<T> = (previousValue?: T) => MaybeReactive<T>;
+/**
+ * Creates a reactive container that derives its value from other reactive values that it tracks.
+ *
+ * @example
+ * const count = atom(1);
+ * const doubled = compose(() => get(count) * 2);
+ */
+export declare function compose<T>(fn: ComposeCallback<T>, options?: ReactiveOptions<T>): Reactive<T>;
+/**
+ * Takes a new value to set, or a callback that receives the current value and returns a new value to set.
+ */
+type Setter<T> = (next: T | ((current: T) => T)) => void;
+export declare function set<T>(atom: Atom<T>): Setter<T>;
+export declare function set<T>(atom: Atom<T>, next: T | ((current: T) => T)): void;
+/**
+ * Returns the current value from a reactive _and track it_ if called in a `compose` or `effect` scope.
+ * If a non-reactive value is passed it will just be returned untracked.
+ *
+ * @example
+ * const count = atom(1);
+ * const value = get(count); // 1
+ *
+ * const value = get(5); // 5
+ */
+export declare function get<T>(value: MaybeReactive<T>): T;
+/**
+ * Returns the current value from a reactive (without tracking).
+ * If a non-reactive value is passed it will be returned.
+ *
+ * @example
+ * ctx.effect(() => {
+ *   const doubled = get(count) * 2; // `count` will be tracked
+ *
+ *   const doubled = peek(count) * 2; // `count` will NOT be tracked
+ * });
+ */
+export declare function peek<T>(value: MaybeReactive<T>): T;
+export type EffectCallback = () => void;
+/**
+ * Creates a tracked scope that re-runs whenever the values of any tracked reactives changes.
+ * Reactives are tracked by accessing their `value` within the body of the function.
+ *
+ * NOTE: You must call the unsubscribe function to stop watching for changes.
+ * If you are using an effect inside a View or Store, use `ctx.effect` instead, which cleans up automatically when the component unmounts.
+ */
+export declare function effect(fn: EffectCallback, options?: {
+    name?: string;
+}): UnsubscribeFunction;
+export {};

package/dist/core/context.d.ts

@@ -1,22 +1,10 @@
-import type { Emitter } from "@manyducks.co/emitter";
 import type { Dolla } from "./dolla";
 import type { Store, StoreFunction } from "./store";
-interface ContextEmitterEvents {
-    [eventName: string | symbol]: [ContextEvent, ...args: any[]];
-}
 export interface ElementContext {
     /**
      * The root Dolla instance this element belongs to.
      */
     root: Dolla;
-    /**
-     * Storage for context variables.
-     */
-    data: Record<string | symbol, unknown>;
-    /**
-     * Event emitter for this context.
-     */
-    emitter: Emitter<ContextEmitterEvents>;
     /**
      * Stores attached to this context.
      */
@@ -34,42 +22,16 @@ export interface ElementContext {
      */
     viewName?: string;
 }
-/**
- * Mapping of listener function passed to `.on` -> wrapped versions that discard eventName.
- * Wrapping listeners is necessary because the context API's `.on` method does not pass the event name to "*" listeners while the emitter does.
- * ContextEvent objects already have the event name stored as `event.type`.
- */
-export type WildcardListenerMap = Map<(event: ContextEvent, ...args: any[]) => void, (eventName: string | symbol, event: ContextEvent, ...args: any[]) => void>;
 export interface ComponentContext {
     /**
-     * Sets a context variable and returns its value.
-     */
-    set<T>(key: string | symbol, value: T): T;
-    /**
-     * Gets the value of a context variable. Returns null if the variable is not set.
-     */
-    get<T>(key: string | symbol): T | null;
-    /**
-     * Adds a listener to be called when an event with a matching `type` is emitted.
+     * A name for debugging purposes. Prepended to log messages.
      */
-    on<T = unknown>(type: string, listener: (event: ContextEvent, ...args: any[]) => void): void;
-    /**
-     * Removes a listener from the list to be called when an event with a matching `type` is emitted.
-     */
-    off<T = unknown>(type: string, listener: (event: ContextEvent, ...args: any[]) => void): void;
-    /**
-     * Adds a listener to be called when an event with a matching `type` is emitted. The listener is immediately removed after being called once.
-     */
-    once<T = unknown>(type: string, listener: (event: ContextEvent, ...args: any[]) => void): void;
-    /**
-     * Emits a new event to all listeners.
-     */
-    emit<T = unknown>(type: string, ...args: any[]): boolean;
+    name: string;
 }
 /**
- * A context capable of hosting stores.
+ * A context capable of providing stores.
  */
-export interface StorableContext extends ComponentContext {
+export interface StoreProviderContext {
     /**
      * Attaches a new store to this context and returns it.
      */
@@ -82,20 +44,10 @@ export interface StorableContext extends ComponentContext {
      * Attaches a new store to this context and returns it.
      */
     provide<Options, Value>(store: StoreFunction<Options, Value>, options: Options): Value;
+}
+export interface StoreConsumerContext {
     /**
      * Gets the closest instance of a store. Throws an error if the store isn't provided higher in the tree.
      */
-    use<Value>(store: StoreFunction<any, Value>): Value;
-}
-/**
- * An event emitted from and received by a Dolla context. These are separate from DOM events.
- */
-export declare class ContextEvent {
-    #private;
-    constructor(type: string);
-    get type(): string;
-    get isStopped(): boolean;
-    stop(): void;
-    get [Symbol.toStringTag](): string;
+    get<Value>(store: StoreFunction<any, Value>): Value;
 }
-export {};

package/dist/core/dolla.d.ts

@@ -1,14 +1,11 @@
-import { HTTP } from "../modules/http.js";
-import { I18n } from "../modules/i18n.js";
-import { type Router } from "../modules/router.js";
-import { type CrashViewProps } from "../views/default-crash-view.js";
-import { Batch } from "./batch.js";
-import { ContextEvent, type StorableContext } from "./context.js";
+import { HTTP } from "../http/index.js";
+import { type Router } from "../router/index.js";
+import { I18n } from "../translate/index.js";
+import type { StoreConsumerContext, StoreProviderContext } from "./context.js";
 import { type Markup, type MarkupElement } from "./markup.js";
 import { type ViewElement, type ViewFunction } from "./nodes/view.js";
-import { createRef, isRef } from "./ref.js";
-import { createState, createWatcher, derive, isState, toState, toValue } from "./state.js";
 import { StoreFunction } from "./store.js";
+import { type CrashViewProps } from "./views/default-crash-view.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.
@@ -42,22 +39,11 @@ export type LoggerOptions = {
      */
     uid?: string;
 };
-export declare class Dolla implements StorableContext {
+export declare class Dolla implements StoreProviderContext, StoreConsumerContext {
     #private;
-    readonly batch: Batch;
-    private readonly stats;
     readonly http: HTTP;
     readonly i18n: I18n;
     constructor();
-    watch: <I extends import("./state.js").MaybeState<any>[]>(states: [...I], fn: (...currentValues: import("./state.js").StateValues<I>) => void) => import("./state.js").StopFunction;
-    createState: typeof createState;
-    toState: typeof toState;
-    toValue: typeof toValue;
-    isState: typeof isState;
-    derive: typeof derive;
-    createWatcher: typeof createWatcher;
-    createRef: typeof createRef;
-    isRef: typeof isRef;
     /**
      * True when the app is connected to a DOM node and displayed to the user.
      */
@@ -85,33 +71,6 @@ export declare class Dolla implements StorableContext {
      * Returns the top level view Dolla is rendering inside the root element. This will return undefined until Dolla.mount() is called.
      */
     getRootView(): ViewElement | undefined;
-    /**
-     * Sets a context variable and returns its value. Context variables are accessible on the app and in child views.
-     */
-    set<T>(key: string | symbol, value: T): T;
-    /**
-     * Gets the value of a context variable. Returns null if the variable is not set.
-     */
-    get<T>(key: string | symbol): T | null;
-    /**
-     * Returns an object of all context variables stored at the app level.
-     */
-    /**
-     * Adds a listener to be called when an event with a matching `type` is emitted.
-     */
-    on<T = unknown>(type: string, listener: (event: ContextEvent, ...args: any[]) => void): void;
-    /**
-     * Removes a listener from the list to be called when an event with a matching `type` is emitted.
-     */
-    off<T = unknown>(type: string, listener: (event: ContextEvent, ...args: any[]) => void): void;
-    /**
-     * Adds a listener to be called when an event with a matching `type` is emitted. The listener is immediately removed after being called once.
-     */
-    once<T = unknown>(type: string, listener: (event: ContextEvent, ...args: any[]) => void): void;
-    /**
-     * Emits a new event to all listeners.
-     */
-    emit<T = unknown>(type: string, ...args: any[]): boolean;
     /**
      * Attaches a new store to this context.
      */
@@ -127,7 +86,7 @@ export declare class Dolla implements StorableContext {
     /**
      * Gets the nearest instance of a store. Throws an error if the store isn't provided higher in the tree.
      */
-    use<Value>(store: StoreFunction<any, Value>): Value;
+    get<Value>(store: StoreFunction<any, Value>): Value;
     mount(selector: string, router: Router): Promise<void>;
     mount(selector: string, view: ViewFunction<any>): Promise<void>;
     mount(element: Element, router: Router): Promise<void>;

package/dist/core/markup.d.ts

@@ -1,28 +1,7 @@
 import type { Renderable } from "../types.js";
 import type { ElementContext } from "./context.js";
 import { type ViewContext, type ViewFunction, type ViewResult } from "./nodes/view.js";
-import { type MaybeState, type State } from "./state.js";
-import { IS_MARKUP } from "./symbols.js";
-export declare class _Markup implements Markup {
-    [IS_MARKUP]: boolean;
-    static text(value: MaybeState<string>): _Markup;
-    static from(renderable: Renderable): Markup;
-    /**
-     * In the case of a view, type will be the View function itself. It can also hold an identifier for special nodes like "$cond", "$repeat", etc.
-     * DOM nodes can be created by name, such as HTML elements like "div", "ul" or "span", SVG elements like ""
-     */
-    type: string | ViewFunction<any>;
-    /**
-     * Data that will be passed to a new MarkupElement instance when it is constructed.
-     */
-    props: Record<string, any> | undefined;
-    /**
-     *
-     */
-    children: Markup[];
-    constructor(type: string | ViewFunction<any>, props?: Record<string, any>, children?: Renderable[]);
-    toElement(context: ElementContext): MarkupElement;
-}
+import { MaybeReactive, type Reactive } from "./signals.js";
 /**
  * Markup is a set of element metadata that hasn't been constructed into a MarkupElement yet.
  */
@@ -61,17 +40,16 @@ export interface MarkupAttributes {
     $text: {
         value: any;
     };
-    $repeat: {
-        $items: State<any[]>;
+    $list: {
+        items: Reactive<any[]>;
         keyFn: (value: any, index: number) => string | number | symbol;
-        renderFn: ($item: State<any>, $index: State<number>, c: ViewContext) => ViewResult;
+        renderFn: (item: Reactive<any>, index: Reactive<number>, ctx: ViewContext) => ViewResult;
     };
-    $observer: {
-        sources: MaybeState<any>[];
-        renderFn: (...items: any) => Renderable;
+    $dynamic: {
+        source: Reactive<Renderable>;
     };
     $outlet: {
-        $children: State<MarkupElement[]>;
+        children: MaybeReactive<MarkupElement[]>;
     };
     $node: {
         value: Node;
@@ -91,12 +69,12 @@ export declare const html: (strings: TemplateStringsArray, ...values: any[]) =>
 /**
  * Displays content conditionally. When `condition` holds a truthy value, `thenContent` is displayed; when `condition` holds a falsy value, `elseContent` is displayed.
  */
-export declare function cond(condition: MaybeState<any>, thenContent?: Renderable, elseContent?: Renderable): Markup;
+export declare function cond(condition: MaybeReactive<any>, thenContent?: Renderable, elseContent?: Renderable): Markup;
 /**
  * Calls `renderFn` for each item in `items`. Dynamically adds and removes views as items change.
  * The result of `keyFn` is used to compare items and decide if item was added, removed or updated.
  */
-export declare function repeat<T>(items: MaybeState<T[]>, keyFn: (value: T, index: number) => string | number | symbol, renderFn: ($value: State<T>, $index: State<number>, ctx: ViewContext) => ViewResult): Markup;
+export declare function list<T>(items: MaybeReactive<T[]>, keyFn: (value: T, index: number) => string | number | symbol, renderFn: (item: Reactive<T>, index: Reactive<number>, ctx: ViewContext) => ViewResult): Markup;
 /**
  * Renders `content` into a `parent` node anywhere in the page, rather than its usual position in the view.
  */

package/dist/core/nodes/{observer.d.ts → dynamic.d.ts}

@@ -1,27 +1,25 @@
 import type { Renderable } from "../../types.js";
 import type { ElementContext } from "../context.js";
 import { type MarkupElement } from "../markup.js";
-import { type MaybeState } from "../state.js";
+import { type Reactive } from "../signals.js";
 import { IS_MARKUP_ELEMENT } from "../symbols.js";
-interface ObserverOptions {
+interface DynamicOptions {
+    source: Reactive<Renderable>;
     elementContext: ElementContext;
-    sources: MaybeState<any>[];
-    renderFn: (...values: any) => Renderable;
 }
 /**
  * Displays dynamic children without a parent element.
- * Used when a State is passed as a child in a view template.
+ * Renders a Reactive value via a render function.
  */
-export declare class Observer implements MarkupElement {
+export declare class Dynamic implements MarkupElement {
     [IS_MARKUP_ELEMENT]: boolean;
     node: Text;
-    children: MarkupElement[];
-    renderFn: (...values: any) => Renderable;
-    elementContext: ElementContext;
-    watcher: import("../state.js").StateWatcher;
-    sources: MaybeState<any>[];
+    private children;
+    private elementContext;
+    private source;
+    private unsubscribe?;
     get isMounted(): boolean;
-    constructor({ sources, renderFn, elementContext }: ObserverOptions);
+    constructor(options: DynamicOptions);
     mount(parent: Node, after?: Node): void;
     unmount(parentIsUnmounting?: boolean): void;
     cleanup(parentIsUnmounting: boolean): void;

package/dist/core/nodes/html.d.ts

@@ -1,7 +1,5 @@
 import { type ElementContext } from "../context.js";
 import { type Markup, type MarkupElement } from "../markup.js";
-import { type Ref } from "../ref.js";
-import { type State, type StopFunction } from "../state.js";
 import { IS_MARKUP_ELEMENT } from "../symbols.js";
 type HTMLOptions = {
     elementContext: ElementContext;
@@ -12,25 +10,21 @@ type HTMLOptions = {
 export declare class HTML implements MarkupElement {
     [IS_MARKUP_ELEMENT]: boolean;
     node: HTMLElement | SVGElement;
-    props: Record<string, any>;
-    childMarkup: Markup[];
-    children: MarkupElement[];
-    stopCallbacks: StopFunction[];
-    elementContext: ElementContext;
-    uniqueId: string;
-    _batchWrite: (callback: () => void, key?: string) => void;
-    ref?: Ref<any>;
-    canClickAway: boolean;
+    private props;
+    private childMarkup;
+    private children;
+    private unsubscribers;
+    private elementContext;
+    private ref?;
+    private canClickAway;
     get isMounted(): boolean;
     constructor({ tag, props, children, elementContext }: HTMLOptions);
     mount(parent: Node, after?: Node): void;
     unmount(parentIsUnmounting?: boolean): void;
-    getUpdateKey(type: string, value: string | number): string;
-    _mutate(callback: () => any, updateKey?: string): void;
-    attachProp<T>(value: State<T> | T, callback: (value: T) => void, updateKey: string): void;
-    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;
+    private attachProp;
+    private applyProps;
+    private applyStyles;
+    private applyClasses;
 }
 /**
  * Converts a camelCase string to kebab-case.

package/dist/core/nodes/list.d.ts

@@ -0,0 +1,28 @@
+import { type ElementContext } from "../context.js";
+import { type MarkupElement } from "../markup.js";
+import { type Reactive } from "../signals.js";
+import { IS_MARKUP_ELEMENT } from "../symbols.js";
+import { type ViewContext, type ViewResult } from "./view.js";
+interface ListOptions<T> {
+    elementContext: ElementContext;
+    items: Reactive<T[]>;
+    keyFn: (item: T, index: number) => string | number | symbol;
+    renderFn: (item: Reactive<T>, index: Reactive<number>, ctx: ViewContext) => ViewResult;
+}
+export declare class List<T> implements MarkupElement {
+    [IS_MARKUP_ELEMENT]: boolean;
+    node: Text;
+    private items;
+    private unsubscribe;
+    private connectedItems;
+    private elementContext;
+    private renderFn;
+    private keyFn;
+    get isMounted(): boolean;
+    constructor({ elementContext, items, renderFn, keyFn }: ListOptions<T>);
+    mount(parent: Node, after?: Node): void;
+    unmount(parentIsUnmounting?: boolean): void;
+    private _cleanup;
+    private _update;
+}
+export {};

package/dist/core/nodes/outlet.d.ts

@@ -1,5 +1,5 @@
 import { type MarkupElement } from "../markup.js";
-import { type MaybeState, type StopFunction } from "../state.js";
+import { type MaybeReactive } from "../signals.js";
 import { IS_MARKUP_ELEMENT } from "../symbols.js";
 /**
  * Manages several MarkupElements as one.
@@ -8,12 +8,12 @@ export declare class Outlet implements MarkupElement {
     [IS_MARKUP_ELEMENT]: boolean;
     node: Text;
     isMounted: boolean;
-    source: MaybeState<MarkupElement[]>;
-    elements: MarkupElement[];
-    stopCallback?: StopFunction;
-    constructor(source: MaybeState<MarkupElement[]>);
+    private source;
+    private elements;
+    private unsubscribe?;
+    constructor(source: MaybeReactive<MarkupElement[]>);
     mount(parent: Node, after?: Node | undefined): void;
     unmount(parentIsUnmounting?: boolean): void;
-    cleanup(parentIsUnmounting: boolean): void;
-    update(newElements: MarkupElement[]): void;
+    private cleanup;
+    private update;
 }

package/dist/core/nodes/portal.d.ts

@@ -12,8 +12,8 @@ interface PortalConfig {
  */
 export declare class Portal implements MarkupElement {
     [IS_MARKUP_ELEMENT]: boolean;
-    config: PortalConfig;
-    element?: MarkupElement;
+    private config;
+    private element?;
     get isMounted(): boolean;
     constructor(config: PortalConfig);
     mount(_parent: Node, _after?: Node): void;