@manyducks.co/dolla 2.0.0-alpha.13 → 2.0.0-alpha.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,5 @@
1
- import { r as s } from "./passthrough-Bz5ZF4jn.js";
2
- import { P as m } from "./passthrough-Bz5ZF4jn.js";
1
+ import { s } from "./passthrough-CBbog_A9.js";
2
+ import { P as m } from "./passthrough-CBbog_A9.js";
3
3
  function d(n, r, t, e, a, l) {
4
4
  const i = { ...o(["children", "key"], r) }, c = Array.isArray(r.children) ? r.children : [r.children];
5
5
  return s(n, i, ...c);
@@ -1,5 +1,5 @@
1
- import { r as t } from "./passthrough-Bz5ZF4jn.js";
2
- import { P as l } from "./passthrough-Bz5ZF4jn.js";
1
+ import { s as t } from "./passthrough-CBbog_A9.js";
2
+ import { P as l } from "./passthrough-CBbog_A9.js";
3
3
  function d(n, e, r) {
4
4
  return t(n, e ? { ...u(["children", "key"], e) } : void 0, e.children);
5
5
  }
package/dist/markup.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import type { Dolla } from "./modules/dolla.js";
2
2
  import { MaybeState, type State } from "./state.js";
3
3
  import type { Renderable, Stringable } from "./types.js";
4
- import { type ViewFunction, type ViewContext, type ViewResult } from "./view.js";
4
+ import { type ViewContext, type ViewFunction, type ViewResult } from "./view.js";
5
5
  export interface ElementContext {
6
6
  /**
7
7
  * The root Dolla instance this element belongs to.
@@ -21,24 +21,34 @@ export interface ElementContext {
21
21
  isSVG?: boolean;
22
22
  }
23
23
  /**
24
- * Markup is a set of element metadata that hasn't been constructed into a MarkupNode yet.
24
+ * Markup is a set of element metadata that hasn't been constructed into a MarkupElement yet.
25
25
  */
26
26
  export interface Markup {
27
+ /**
28
+ * 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.
29
+ * DOM nodes can be created by name, such as HTML elements like "div", "ul" or "span", SVG elements like ""
30
+ */
27
31
  type: string | ViewFunction<any>;
32
+ /**
33
+ * Data that will be passed to a new MarkupElement instance when it is constructed.
34
+ */
28
35
  props?: Record<string, any>;
36
+ /**
37
+ *
38
+ */
29
39
  children?: Markup[];
30
40
  }
31
41
  /**
32
42
  * A DOM node that has been constructed from a Markup object.
33
43
  */
34
- export interface MarkupNode {
44
+ export interface MarkupElement {
35
45
  readonly node?: Node;
36
46
  readonly isMounted: boolean;
37
47
  mount(parent: Node, after?: Node): void;
38
48
  unmount(): void;
39
49
  }
40
50
  export declare function isMarkup(value: unknown): value is Markup;
41
- export declare function isNode(value: unknown): value is MarkupNode;
51
+ export declare function isMarkupElement(value: unknown): value is MarkupElement;
42
52
  export declare function toMarkup(renderables: Renderable | Renderable[]): Markup[];
43
53
  export interface MarkupAttributes {
44
54
  $text: {
@@ -59,7 +69,7 @@ export interface MarkupAttributes {
59
69
  renderFn: (...items: any) => Renderable;
60
70
  };
61
71
  $outlet: {
62
- $children: State<MarkupNode[]>;
72
+ $children: State<MarkupElement[]>;
63
73
  };
64
74
  $node: {
65
75
  value: Node;
@@ -90,19 +100,11 @@ export declare function repeat<T>(items: MaybeState<T[]>, keyFn: (value: T, inde
90
100
  */
91
101
  export declare function portal(parent: Node, content: Renderable): Markup;
92
102
  /**
93
- * A special kind of State exclusively for storing references to DOM nodes.
94
- */
95
- export declare function createRef<T extends Node>(): Ref<T>;
96
- export declare function isRef<T extends Node>(value: any): value is Ref<T>;
97
- export interface Ref<T extends Node> extends State<T | undefined> {
98
- node: T | undefined;
99
- }
100
- /**
101
- * Construct Markup metadata into a set of MarkupNodes.
103
+ * Construct Markup metadata into a set of MarkupElements.
102
104
  */
103
- export declare function constructMarkup(elementContext: ElementContext, markup: Markup | Markup[]): MarkupNode[];
105
+ export declare function constructMarkup(elementContext: ElementContext, markup: Markup | Markup[]): MarkupElement[];
104
106
  /**
105
- * Combines one or more MarkupNodes into a single MarkupNode.
107
+ * Combines one or more MarkupElements into a single MarkupElement.
106
108
  */
107
- export declare function mergeNodes(nodes: MarkupNode[]): MarkupNode;
109
+ export declare function mergeElements(nodes: MarkupElement[]): MarkupElement;
108
110
  export declare function isRenderable(value: unknown): value is Renderable;
@@ -1,6 +1,6 @@
1
- import { createRef, isRef, MarkupNode, type Markup } from "../markup.js";
2
- import { createSettableState, createState, derive, toSettableState, toState, valueOf, watch, type State } from "../state.js";
3
- import { type ViewFunction, type ViewNode } from "../view.js";
1
+ import { type Markup, type MarkupElement } from "../markup.js";
2
+ import { createRef, createSettableState, createState, createWatcher, derive, isRef, toSettableState, toState, valueOf, type State } from "../state.js";
3
+ import { type ViewElement, type ViewFunction } from "../view.js";
4
4
  import { type CrashViewProps } from "../views/default-crash-view.js";
5
5
  import { HTTP } from "./http.js";
6
6
  import { I18n } from "./i18n.js";
@@ -45,13 +45,14 @@ export declare class Dolla {
45
45
  readonly render: Render;
46
46
  readonly router: Router;
47
47
  constructor();
48
+ watch: <I extends import("../state.js").MaybeState<any>[]>(states: [...I], fn: (...currentValues: import("../state.js").StateValues<I>) => void) => import("../state.js").StopFunction;
48
49
  createState: typeof createState;
49
50
  createSettableState: typeof createSettableState;
50
51
  toSettableState: typeof toSettableState;
51
52
  toState: typeof toState;
52
53
  valueOf: typeof valueOf;
53
54
  derive: typeof derive;
54
- watch: typeof watch;
55
+ createWatcher: typeof createWatcher;
55
56
  createRef: typeof createRef;
56
57
  isRef: typeof isRef;
57
58
  /**
@@ -73,6 +74,18 @@ export declare class Dolla {
73
74
  * When a crash is reported the app will be unmounted and replaced with this crash page.
74
75
  */
75
76
  setCrashView(view: ViewFunction<CrashViewProps>): void;
77
+ /**
78
+ * Sets a context variable and returns its value. Context variables are accessible on the app and in child views.
79
+ */
80
+ set<T>(key: string | symbol, value: T): T;
81
+ /**
82
+ * Gets the value of a context variable. Returns null if the variable is not set.
83
+ */
84
+ get<T>(key: string | symbol): T | null;
85
+ /**
86
+ * Returns an object of all context variables stored at the app level.
87
+ */
88
+ getAll(): Record<string | symbol, unknown>;
76
89
  mount(selector: string, view?: ViewFunction<any>): Promise<void>;
77
90
  mount(element: HTMLElement, view?: ViewFunction<any>): Promise<void>;
78
91
  unmount(): Promise<void>;
@@ -103,9 +116,9 @@ export declare class Dolla {
103
116
  /**
104
117
  *
105
118
  */
106
- constructView<P>(view: ViewFunction<P>, props: P, children?: Markup[]): ViewNode;
119
+ constructView<P>(view: ViewFunction<P>, props: P, children?: Markup[]): ViewElement;
107
120
  /**
108
121
  *
109
122
  */
110
- constructMarkup(markup: Markup | Markup[]): MarkupNode;
123
+ constructMarkup(markup: Markup | Markup[]): MarkupElement;
111
124
  }
@@ -1,9 +1,17 @@
1
1
  import { type MaybeState, type State } from "../state.js";
2
2
  import type { Dolla } from "./dolla.js";
3
3
  /**
4
- * An object where values are either a translated string or another nested Translation object.
4
+ * A JSON object of translated strings. Values can be string templates or nested objects.
5
5
  */
6
- type LocalizedStrings = Record<string, string | Record<string, string | Record<string, string | Record<string, string>>>>;
6
+ interface LocalizedStrings extends Record<string, string | LocalizedStrings> {
7
+ }
8
+ /**
9
+ * A formatter to be applied to a variable.
10
+ */
11
+ type Format = {
12
+ name: string;
13
+ options: Record<string, any>;
14
+ };
7
15
  export interface TranslationConfig {
8
16
  /**
9
17
  * Name of the locale this translation is for (BCP 47 locale names recommended).
@@ -34,6 +42,18 @@ export type TOptions = {
34
42
  *
35
43
  */
36
44
  context?: MaybeState<string>;
45
+ /**
46
+ * Override formats specified in the template with the ones in the array for each named variable.
47
+ *
48
+ * @example
49
+ * t("example_key", {
50
+ * count: 5,
51
+ * formatOverrides: {
52
+ * count: [ { name: "datetime", options: { style: "currency", currency: "JPY" } } ]
53
+ * }
54
+ * });
55
+ */
56
+ formatOverrides?: MaybeState<Record<string, Record<string, Format[]>>>;
37
57
  [value: string]: MaybeState<any>;
38
58
  };
39
59
  export type Formatter = (locale: string, value: unknown, options: Record<string, any>) => string;
@@ -1,5 +1,5 @@
1
1
  import { type Stringable } from "../types.js";
2
- import { ViewNode, type ViewFunction } from "../view.js";
2
+ import { type ViewElement, type ViewFunction } from "../view.js";
3
3
  import type { Dolla } from "./dolla.js";
4
4
  export interface RouteMatchContext {
5
5
  /**
@@ -100,7 +100,7 @@ export interface RouterSetupOptions {
100
100
  }
101
101
  export interface RouterElements {
102
102
  readonly rootElement?: HTMLElement;
103
- readonly rootView?: ViewNode;
103
+ readonly rootView?: ViewElement;
104
104
  }
105
105
  export declare class Router {
106
106
  #private;
@@ -1,4 +1,4 @@
1
- import { type MarkupNode, type ElementContext, type Markup } from "../markup.js";
1
+ import { type MarkupElement, type ElementContext, type Markup } from "../markup.js";
2
2
  import { type State, type StopFunction } from "../state.js";
3
3
  import { type Renderable } from "../types.js";
4
4
  export interface ConditionalConfig {
@@ -7,14 +7,14 @@ export interface ConditionalConfig {
7
7
  elseContent?: Renderable;
8
8
  elementContext: ElementContext;
9
9
  }
10
- export declare class Conditional implements MarkupNode {
10
+ export declare class Conditional implements MarkupElement {
11
11
  node: Node;
12
12
  endNode: Node;
13
13
  $predicate: State<any>;
14
14
  stopCallback?: StopFunction;
15
15
  thenContent?: Markup[];
16
16
  elseContent?: Markup[];
17
- connectedContent: MarkupNode[];
17
+ connectedContent: MarkupElement[];
18
18
  elementContext: ElementContext;
19
19
  initialUpdateHappened: boolean;
20
20
  previousValue?: any;
@@ -1,15 +1,15 @@
1
- import { type ElementContext, type Markup, type MarkupNode, type Ref } from "../markup.js";
2
- import { type StopFunction } from "../state.js";
1
+ import { type ElementContext, type Markup, type MarkupElement } from "../markup.js";
2
+ import { type Ref, type State, type StopFunction } from "../state.js";
3
3
  type HTMLOptions = {
4
4
  elementContext: ElementContext;
5
5
  tag: string;
6
6
  props: Record<string, any>;
7
7
  children?: Markup[];
8
8
  };
9
- export declare class HTML implements MarkupNode {
9
+ export declare class HTML implements MarkupElement {
10
10
  node: HTMLElement | SVGElement;
11
11
  props: Record<string, any>;
12
- children: MarkupNode[];
12
+ children: MarkupElement[];
13
13
  stopCallbacks: StopFunction[];
14
14
  elementContext: ElementContext;
15
15
  uniqueId: string;
@@ -20,6 +20,7 @@ export declare class HTML implements MarkupNode {
20
20
  mount(parent: Node, after?: Node): void;
21
21
  unmount(): void;
22
22
  getUpdateKey(type: string, value: string | number): string;
23
+ attachProp<T>(value: State<T> | T, callback: (value: T) => void, updateKey: string): void;
23
24
  applyProps(element: HTMLElement | SVGElement, props: Record<string, unknown>): void;
24
25
  applyStyles(element: HTMLElement | SVGElement, styles: unknown, stopCallbacks: StopFunction[]): () => void;
25
26
  applyClasses(element: HTMLElement | SVGElement, classes: unknown, stopCallbacks: StopFunction[]): () => void;
@@ -1,4 +1,4 @@
1
- import { type ElementContext, type MarkupNode } from "../markup.js";
1
+ import { type ElementContext, type MarkupElement } from "../markup.js";
2
2
  import { type State } from "../state.js";
3
3
  import type { Renderable } from "../types.js";
4
4
  interface ObserverOptions {
@@ -9,16 +9,17 @@ interface ObserverOptions {
9
9
  /**
10
10
  * Displays dynamic children without a parent element.
11
11
  */
12
- export declare class Observer implements MarkupNode {
12
+ export declare class Observer implements MarkupElement {
13
13
  node: Node;
14
14
  endNode: Node;
15
- connectedViews: MarkupNode[];
15
+ connectedViews: MarkupElement[];
16
16
  renderFn: (...values: any) => Renderable;
17
17
  elementContext: ElementContext;
18
18
  observerControls: {
19
19
  start: () => void;
20
20
  stop: () => void;
21
21
  };
22
+ watcher: import("../state.js").StateWatcher;
22
23
  get isMounted(): boolean;
23
24
  constructor({ states, renderFn, elementContext }: ObserverOptions);
24
25
  mount(parent: Node, after?: Node): void;
@@ -1,22 +1,22 @@
1
- import { type MarkupNode, type ElementContext } from "../markup.js";
1
+ import { type MarkupElement, type ElementContext } from "../markup.js";
2
2
  import { type State, type StopFunction } from "../state.js";
3
3
  export interface OutletConfig {
4
- $children: State<MarkupNode[]>;
4
+ $children: State<MarkupElement[]>;
5
5
  elementContext: ElementContext;
6
6
  }
7
7
  /**
8
8
  * Manages an array of DOMHandles.
9
9
  */
10
- export declare class Outlet implements MarkupNode {
10
+ export declare class Outlet implements MarkupElement {
11
11
  node: Node;
12
12
  endNode: Node;
13
- $children: State<MarkupNode[]>;
13
+ $children: State<MarkupElement[]>;
14
14
  stopCallback?: StopFunction;
15
- connectedChildren: MarkupNode[];
15
+ mountedChildren: MarkupElement[];
16
16
  elementContext: ElementContext;
17
17
  constructor(config: OutletConfig);
18
18
  get isMounted(): boolean;
19
19
  mount(parent: Node, after?: Node | undefined): void;
20
20
  unmount(): void;
21
- update(newChildren: MarkupNode[]): void;
21
+ update(newChildren: MarkupElement[]): void;
22
22
  }
@@ -1,4 +1,4 @@
1
- import { type MarkupNode, type ElementContext } from "../markup.js";
1
+ import { type MarkupElement, type ElementContext } from "../markup.js";
2
2
  import { type Renderable } from "../types.js";
3
3
  interface PortalConfig {
4
4
  content: Renderable;
@@ -8,9 +8,9 @@ interface PortalConfig {
8
8
  /**
9
9
  * Renders content into a specified parent node.
10
10
  */
11
- export declare class Portal implements MarkupNode {
11
+ export declare class Portal implements MarkupElement {
12
12
  config: PortalConfig;
13
- handle?: MarkupNode;
13
+ element?: MarkupElement;
14
14
  get isMounted(): boolean;
15
15
  constructor(config: PortalConfig);
16
16
  mount(_parent: Node, _after?: Node): void;
@@ -1,4 +1,4 @@
1
- import { type MarkupNode, type ElementContext } from "../markup.js";
1
+ import { type MarkupElement, type ElementContext } from "../markup.js";
2
2
  import { type State, type Setter, type StopFunction } from "../state.js";
3
3
  import { type ViewContext, type ViewResult } from "../view.js";
4
4
  interface RepeatOptions<T> {
@@ -13,9 +13,9 @@ type ConnectedItem<T> = {
13
13
  setValue: Setter<T>;
14
14
  $index: State<number>;
15
15
  setIndex: Setter<number>;
16
- handle: MarkupNode;
16
+ element: MarkupElement;
17
17
  };
18
- export declare class Repeat<T> implements MarkupNode {
18
+ export declare class Repeat<T> implements MarkupElement {
19
19
  node: Node;
20
20
  endNode: Node;
21
21
  $items: State<T[]>;
@@ -1,4 +1,4 @@
1
- import { type MarkupNode } from "../markup.js";
1
+ import { type MarkupElement } from "../markup.js";
2
2
  import { type MaybeState, type StopFunction } from "../state.js";
3
3
  interface Stringable {
4
4
  toString(): string;
@@ -6,7 +6,7 @@ interface Stringable {
6
6
  interface TextOptions {
7
7
  value: MaybeState<Stringable>;
8
8
  }
9
- export declare class Text implements MarkupNode {
9
+ export declare class Text implements MarkupElement {
10
10
  node: globalThis.Text;
11
11
  value: MaybeState<Stringable>;
12
12
  stopCallback?: StopFunction;