@manyducks.co/dolla 2.0.0-alpha.2 → 2.0.0-alpha.20

package/dist/view.d.ts

@@ -1,26 +1,41 @@
-import { type MarkupNode, type ElementContext, type Markup } from "./markup.js";
+import { type MarkupElement, type ElementContext, type Markup } from "./markup.js";
 import type { Logger } from "./modules/dolla.js";
-import { type MaybeSignal, Signal, type SignalValues, type StopFunction } from "./signals.js";
+import { type MaybeState, Setter, State, type StateValues, type StopFunction } from "./state.js";
 /**
  * Any valid value that a View can return.
  */
-export type ViewResult = Node | Signal<any> | Markup | Markup[] | null;
+export type ViewResult = Node | State<any> | Markup | Markup[] | null;
 export type ViewFunction<P> = (props: P, context: ViewContext) => ViewResult;
 /**
  * A view that has been constructed into DOM nodes.
  */
-export interface ViewNode extends MarkupNode {
-    setChildren(children: MarkupNode[]): void;
+export interface ViewElement extends MarkupElement {
+    /**
+     * Take a ViewFunction and render it as a child of this view.
+     */
+    setChildView(view: ViewFunction<{}>): ViewElement;
 }
 export interface ViewContext extends Logger {
     /**
      * A string ID unique to this view.
      */
     readonly uid: string;
+    /**
+     * Sets a context variable and returns its value. Context variables are accessible on the same context and from those of 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 variables stored on this context.
+     */
+    getAll(): Record<string | symbol, unknown>;
     /**
      * Sets the name of the view's built in logger.
      */
-    setName(name: string): void;
+    setName(name: string): ViewContext;
     /**
      * Registers a callback to run just before this view is mounted. DOM nodes are not yet attached to the page.
      */
@@ -38,13 +53,34 @@ export interface ViewContext extends Logger {
      */
     onUnmount(callback: () => void): void;
     /**
-     * Watch a set of signals. The callback is called when any of the signals receive a new value.
+     * Watch a set of states. The callback is called when any of the states receive a new value.
      * Watchers will be automatically stopped when this view is unmounted.
      */
-    watch<T extends MaybeSignal<any>[]>(signals: [...T], callback: (...values: SignalValues<T>) => void): StopFunction;
+    watch<T extends MaybeState<any>[]>(states: [...T], callback: (...values: StateValues<T>) => void): StopFunction;
     /**
      * Returns a Markup element that displays this view's children.
      */
     outlet(): Markup;
 }
-export declare function constructView<P>(elementContext: ElementContext, view: ViewFunction<P>, props: P, children?: Markup[]): ViewNode;
+export declare class View<P> implements ViewElement {
+    uniqueId: string;
+    _elementContext: ElementContext;
+    _logger: Logger;
+    _view: ViewFunction<P>;
+    _props: P;
+    _element?: MarkupElement;
+    _$children: State<MarkupElement[]>;
+    _setChildren: Setter<MarkupElement[], MarkupElement[]>;
+    _watcher: import("./state.js").StateWatcher;
+    _beforeMountCallbacks: (() => any)[];
+    _onMountCallbacks: (() => any)[];
+    _beforeUnmountCallbacks: (() => any)[];
+    _onUnmountCallbacks: (() => any)[];
+    constructor(elementContext: ElementContext, view: ViewFunction<P>, props: P, children?: Markup[]);
+    get node(): Node;
+    isMounted: boolean;
+    mount(parent: Node, after?: Node): void;
+    unmount(parentIsUnmounting: boolean): void;
+    setChildView(fn: ViewFunction<{}>): View<{}>;
+    initialize(): void;
+}

package/docs/http.md

@@ -0,0 +1,5 @@
+# HTTP Client
+
+> TODO: Write me.
+
+This page goes into detail on how to use the built in HTTP client.

package/docs/i18n.md

@@ -0,0 +1,5 @@
+# Internationalization (i18n) Support
+
+> TODO: Write me.
+
+This page goes into detail on how to work with translations.

package/docs/router.md

@@ -0,0 +1,5 @@
+# Router
+
+> TODO: Write me.
+
+This page goes into detail on what you can do with the router.

package/docs/states.md

@@ -0,0 +1,5 @@
+# States
+
+> TODO: Write me.
+
+This page goes into detail on everything State related.

package/docs/views.md

@@ -0,0 +1,5 @@
+# Views
+
+> TODO: Write me.
+
+This page goes into detail on Views; props, context, applying styles and classes, etc.

package/notes/context-vars.md

@@ -0,0 +1,21 @@
+# Idea: Context Variables
+
+In designing how Dolla's version of 'context' works, I've been going through a few different ideas. The simplest seems to be the ability to store _context variables_ that, once set, are accessible on the same context or any child context.
+
+```js
+function SomeView(props, ctx) {
+  ctx.set("key", 5);
+
+  // ... and in a child view do
+  ctx.get("key");
+  // which returns null if the value isn't present.
+  // It's like localStorage for the view tree.
+}
+```
+
+They can be typed, but always with a possibility to return null.
+
+```js
+const value = ctx.get<number>("key");
+// value is number | null to force the programmer to check it.
+```

package/notes/readme-scratch.md

@@ -0,0 +1,222 @@
+# README
+
+> This note will eventually become the new README. Here I'm laying out my ideal framework API.
+
+A basic component.
+
+```jsx
+import Dolla, { createState, derive } from "@manyducks.co/dolla";
+
+function ExampleView(props, ctx) {
+  const [$count, setCount] = createState(5);
+  const $doubled = derive([$count], (n) => n * 2);
+
+  ctx.watch([$count], (count) => {
+    ctx.log("value of count is now %n", count);
+  });
+
+  return <p>{$count}</p>;
+}
+
+Dolla.mount(document.body, ExampleView);
+```
+
+<details open>
+<summary>
+  <h2>Signals API</h2>
+</summary>
+
+The signals API. Dolla's signals use explicit tracking, meaning any function where signal values are tracked take an array of the signals you want to track. This way you know exactly what depends on what at a glance without any kind of hidden tracking logic behind the scenes. You are free to `.get()` the value of a signal without worrying about untracking it first.
+
+```jsx
+import { createState } from "@manyducks.co/dolla";
+
+const [$count, setCount] = createState(256);
+
+$count.get(); // 256; returns the current value
+
+const stop = $count.watch((value) => {
+  // Runs once immediately, then again whenever the value changes.
+});
+
+setCount(512); // Update the value of $count. The new value is set and all watchers run synchronously.
+
+stop(); // Stop watching for changes.
+```
+
+That is the basic signal API. Signals are all about composability. Here are some more advanced ways of working with them:
+
+```jsx
+import { createState, toState, valueOf, derive } from "@manyducks.co/dolla";
+
+const [$count, setCount] = createState(72);
+
+// Returns the value of the signal passed in. If the value is not a signal it is returned as is.
+const count = valueOf($count);
+const bool = valueOf(true);
+
+// Creates a signal containing the value passed in. If the value is already a signal it is returned as is.
+const $bool = toState(true);
+const $anotherCount = toState($count);
+
+// Derive a new signal from the value of another. Whenever $count changes, $doubled will follow.
+const $doubled = derive([$count], (count) => count * 2);
+
+// Derive a new signal from the values of several others. When any value in the list changes, $sum will be recomputed.
+const $sum = derive([$count, $doubled], (count, doubled) => count + doubled);
+```
+
+The API if we call it State instead of Signal to distance from the Signal object in standardization process.
+
+```jsx
+import { createState, toState, valueOf, derive } from "@manyducks.co/dolla";
+
+const [$count, setCount] = createState(72);
+
+// Returns the value of the signal passed in. If the value is not a signal it is returned as is.
+const count = valueOf($count);
+const bool = valueOf(true);
+
+// Creates a signal containing the value passed in. If the value is already a signal it is returned as is.
+const $bool = toState(true);
+const $anotherCount = toState($count);
+
+// Derive a new signal from the value of another. Whenever $count changes, $doubled will follow.
+const $doubled = derive([$count], (count) => count * 2);
+
+// Derive a new signal from the values of several others. When any value in the list changes, $sum will be recomputed.
+const $sum = derive([$count, $doubled], (count, doubled) => count + doubled);
+```
+
+States also come in a settable variety, with the setter included on the same object. Sometimes you want to pass around a two-way binding and this is what SettableState is for.
+
+```jsx
+import { createSettableState, fromSettable, toSettable } from "@manyducks.co/dolla";
+
+// Settable states have their setter included.
+const $$value = createSettableState("Test");
+$$value.set("New Value");
+
+// They can also be split into a State and Setter
+const [$value, setValue] = fromSettableState($$value);
+
+// And a State and Setter can be combined into a SettableState.
+const $$otherValue = toSettableState($value, setValue);
+
+// Or discard the setter and make it read-only using the good old toState function:
+const $value = toState($$value);
+```
+
+Alternative API
+
+```jsx
+import { State } from "@manyducks.co/dolla";
+
+const [$count, setCount] = State(72);
+
+const count = State.unwrap($count);
+const bool = State.unwrap(true);
+
+const $bool = State.wrap(true);
+const $sameCount = State.wrap($count);
+
+const $doubled = State.from([$count], (count) => count * 2);
+
+const $sum = State.from([$count, $doubled], (count, doubled) => count + doubled);
+```
+
+Yet another
+
+```jsx
+import Dolla from "@manyducks.co/dolla";
+
+const [$count, setCount] = Dolla.state(72);
+
+const count = Dolla.get($count);
+const bool = Dolla.get(true);
+
+const $bool = Dolla.toState(true);
+const $sameCount = Dolla.toState($count);
+
+const $doubled = Dolla.computed([$count], (count) => count * 2);
+const $sum = Dolla.computed([$count, $doubled], (count, doubled) => count + doubled);
+
+// or
+
+import { state, computed, get, toState } from "@manyducks.co/dolla";
+
+const [$count, setCount] = state(72);
+
+const count = get($count);
+const bool = get(true);
+
+const $bool = toState(true);
+const $sameCount = toState($count);
+
+const $doubled = computed([$count], (count) => count * 2);
+const $sum = computed([$count, $doubled], (count, doubled) => count + doubled);
+```
+
+Settable signals:
+
+```jsx
+import { createSettableState, createSetter, toSettableSignal, fromSettableSignal } from "@manyducks.co/dolla";
+
+// Create a SettableSignal, which is basically a signal and its setter combined into a single object.
+const $$settable = createSettableState("Example");
+
+// The basic API is identical...
+$$settable.get();
+const stop = $$settable.watch((value) => {
+  // ...
+});
+stop();
+
+// ... except for the addition of a setter.
+$$settable.set("Set me directly");
+
+// When you already have a signal and a setter, they can be combined into one.
+const $$count = toSettableSignal($count, setCount);
+
+// This updates the original $signal value.
+$$count.set(386);
+
+// TODO: You can also split a SettableSignal into a signal and its setter.
+const [$readable, setReadable] = fromSettableSignal($$settable);
+
+// Create a custom setter. Calling this will cap the value to 100.
+const setCountBounded = createSetter($count, (next, current) => {
+  return Math.min(100, next);
+});
+
+setCountBounded((current) => {
+  return current + 1;
+});
+
+// Or make a proxy $$doubled -- but would you actually want to proxy things like this?
+const [$count, setCount] = createState(5);
+const $doubled = derive([$count], (count) => count * 2);
+const $$doubled = toSettableSignal(
+  $doubled,
+  createSetter($doubled, (next, current) => {
+    setCount(next * 2);
+  }),
+);
+```
+
+I'm not really sure we need all of this. On the chopping block:
+
+- The entire concept of settable signals
+  - `createSettableState`
+  - `toSettableSignal`
+  - `fromSettableSignal`
+  - `createSetter`
+
+This makes the entire API just four functions:
+
+- `createState`
+- `derive`
+- `toState`
+- `valueOf`
+
+</details>

package/notes/route-middleware.md

@@ -0,0 +1,42 @@
+# Router Middleware
+
+Allow handling route guards, preloading, etc with per-route middleware. When a route is matched, all middleware from higher layers are run again.
+
+```js
+Dolla.router.setup({
+  middleware: [/* does it make sense to have global middleware? */]
+  routes: [
+    { path: "/login", middleware: [auth] },
+    { path: "/", middleware: [auth], routes: [{ path: "/example", view: ExampleView }] }
+  ]
+});
+
+async function auth(ctx) {
+  // This check can be implemented however it needs to be for the app.
+  const authed = await isAuthorized();
+
+  if (ctx.path === "/login") {
+    if (authed) {
+      ctx.redirect("/");
+    }
+  } else {
+    if (!authed) {
+      ctx.redirect("/login");
+    }
+  }
+  // If no redirect has happened and nothing has been returned then we're clear to proceed.
+}
+
+// A middleware can also return Markup to stay on the URL but show something different.
+async function randomVisitor(ctx) {
+  if (Math.random() > 0.99) {
+    return <LuckyVisitorView />
+  }
+}
+
+// Or preload async data and set a context variable before navigating.
+async function preload(ctx) {
+  const data = await fetchData();
+  ctx.set("data", data);
+}
+```

package/notes/scratch.md

@@ -1,5 +1,92 @@
 # Scratch Note
 
+Bring the $ back and the name full circle.
+
+```js
+import { $, $$ } from "@manyducks.co/dolla";
+
+// Shorthand dolla sign
+
+// An initial value (with optional options object) creates a state.
+const [$count, setCount] = $(0);
+// = createState(0)
+
+// An array and a function derives a state.
+const $doubled = $([$count], (count) => count * 2);
+// = derive([$count], (count) => count * 2);
+
+// A state returns the same state.
+const $sameCount = $.of($count);
+const $wrapped = $.of({ message: "This is a state with no setter." });
+// = toState($count)
+
+// Get value from a state. Values that are not states are returned directly.
+const count = $.value($count);
+
+// An initial value creates a SettableState
+const $$count = $$(5);
+// = createSettableState(5);
+
+// Merge state and setter into a SettableState
+const $$count = $$($count, setCount);
+// = toSettableState($count, setCount);
+
+// Split a SettableState into a state and setter
+const [$count, setCount] = $($$count);
+```
+
+---
+
+I've been looking into other libraries that don't make you track your dependencies specifically.
+
+```js
+import { $ } from "@manyducks.co/dolla";
+
+const [count, setCount] = $(0);
+
+const doubled = $.computed(() => count() * 2);
+
+
+
+$.effect(() => {
+  console.log(doubled());
+});
+
+$.batch(() => {
+  // Set multiple things but defer updates to after this function returns.
+});
+
+// Helpers on $; can plug into template as is.
+$.if(
+  $.computed(() => count() > 5),
+  <span>Greater than 5!</span>,
+  <span>Not greater than 5...</span>,
+);
+
+const switched = $.switch(count, [[1, "one"], [2, "two"], [3, "three"]], "more...");
+
+$.repeat()
+
+// TODO: How feasible is this?
+<Repeat each={}>
+  {(item, index) => {
+
+  }}
+</Repeat>
+
+<Show when={condition}>
+  Condition is true.
+</Show>
+
+// Get
+count();
+
+// Set
+count(52);
+```
+
+---
+
 What if Dolla was just a global object that you don't instantiate. I have never personally run into a use case for having more than one app on a page at once. In all my projects, the page and the app are synonymous.
 
 Doing this would make it possible to access things inside the Dolla app from _outside_ code such as Quill blots. Effectively all code that has access to your Dolla import is _inside_ the app.
@@ -11,8 +98,8 @@ Doing this would make it possible to access things inside the Dolla app from _ou
 import Dolla from "@manyducks.co/dolla";
 
 // Languages: add translation, set language and get localized string as a signal
-Dolla.language.setup({
-  initialLanguage: Dolla.language.detect({ fallback: "ja" }), // Detect user's language and fall back to passed value
+Dolla.i18n.setup({
+  initialLanguage: Dolla.i18n.detect({ fallback: "ja" }), // Detect user's language and fall back to passed value
   languages: [
     { name: "ja", path: "/static/locales/ja.json" },
     {
@@ -26,8 +113,8 @@ Dolla.language.setup({
   ]
 });
 
-Dolla.language.$current
-Dolla.language.t$()
+Dolla.i18n.$locale
+Dolla.i18n.t$()
 
 // A single setup call to keep things contained (must happen before mount)
 Dolla.router.setup({
@@ -78,7 +165,7 @@ debug.warn("THIS IS A SCOPED LOGGER");
 Dolla.render.read(() => {
   // Reference DOM nodes
 });
-Dolla.render.update(() => {
+Dolla.render.write(() => {
   // Mutate the DOM as part of Dolla's next batch
 }, "some-key");
 
@@ -93,7 +180,7 @@ function SomeView (props: SomeViewProps, ctx: Dolla.ViewContext) {
   const debug = Dolla.createLogger("SomeView");
 
   // returns a signal and a setter function
-  const [$someValue, setSomeValue] = Dolla.createSignal(4);
+  const [$someValue, setSomeValue] = Dolla.createState(4);
 
   // Router is now a part of the Dolla object
   Dolla.router.$path;

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "@manyducks.co/dolla",
-  "version": "2.0.0-alpha.2",
+  "version": "2.0.0-alpha.20",
   "description": "Front-end components, routing and state management.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
   "sideEffects": false,
-  "repository": "https://github.com/manyducksco/dolla",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/manyducksco/dolla.git"
+  },
   "scripts": {
     "test": "npm run build && node --test",
     "build:esbuild": "tsc && node build.js",
@@ -36,20 +39,17 @@
       "types": "./jsx-dev-runtime.d.ts"
     }
   },
-  "dependencies": {
-    "fetch-ponyfill": "^7.1.0",
-    "history": "^5.3.0",
-    "nanoid": "^5.0.4",
-    "simple-color-hash": "^1.0.2",
-    "vite": "^6.0.7"
-  },
   "devDependencies": {
-    "@types/node": "^18.17.6",
+    "@types/node": "^22.10.6",
     "csstype": "^3.1.3",
     "esbuild": "^0.24.2",
+    "fast-deep-equal": "^3.1.3",
+    "history": "^5.3.0",
     "htm": "^3.1.1",
-    "prettier": "^3.2.4",
-    "typescript": "^5.3.3",
-    "zod": "^3.22.4"
+    "nanoid": "^5.0.9",
+    "prettier": "^3.4.2",
+    "simple-color-hash": "^1.0.2",
+    "typescript": "^5.7.3",
+    "vite": "^6.0.7"
   }
 }

package/tests/{signals.test.js → state.test.js}

@@ -1,10 +1,10 @@
 import test from "node:test";
 import assert from "node:assert";
 
-import { signal, derive } from "../lib/index.js";
+import { createState, derive } from "../dist/index.js";
 
 test("signal", (t) => {
-  const [$count, setCount] = signal(5);
+  const [$count, setCount] = createState(5);
 
   const defaultWatcher = t.mock.fn();
   const stopDefault = $count.watch(defaultWatcher);
@@ -42,8 +42,8 @@ test("signal", (t) => {
 });
 
 test("derive", (t) => {
-  const [$one, setOne] = signal(5);
-  const [$two, setTwo] = signal(20);
+  const [$one, setOne] = createState(5);
+  const [$two, setTwo] = createState(20);
 
   const deriveSum = t.mock.fn((one, two) => one + two);
   const deriveProduct = t.mock.fn((one, two) => one * two);
@@ -101,9 +101,9 @@ test("derive", (t) => {
 });
 
 test("derive nested signals", (t) => {
-  const [$value, setValue] = signal(5);
+  const [$value, setValue] = createState(5);
 
-  const [$object, setObject] = signal({
+  const [$object, setObject] = createState({
     href: derive([$value], (value) => `/projects/${value}/test`),
   });
 

package/dist/modules/language.d.ts

@@ -1,41 +0,0 @@
-import { type Signal } from "../signals.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: Signal<string | undefined>;
-    constructor(dolla: Dolla);
-    get supportedLanguages(): string[];
-    setup(options: LanguageSetupOptions): void;
-    setLanguage(name: string): Promise<void>;
-    /**
-     * Returns a Signal 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 | Signal<Stringable>>): Signal<string>;
-}
-export {};