ovr 7.0.0-next.36 → 7.0.0-next.37

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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # ovr
2
2
 
3
+ ## 7.0.0-next.37
4
+
5
+ ### Minor Changes
6
+
7
+ - c15a886: A render is made with `new Render`, which takes the element by what to render it to, as `Render.raw` and `Render.escape` take theirs: `new Render({ markup: element }, options)` and `new Render({ markdown: element }, options)`, where they were `Render.markup(element, options)` and `Render.markdown(element, options)`.
8
+
3
9
  ## 7.0.0-next.36
4
10
 
5
11
  ### Minor Changes
@@ -29,13 +29,13 @@ export declare namespace Markdown {
29
29
  }
30
30
  /**
31
31
  * Renders an element to Markdown, as an `AsyncIterable` of blocks, a stream,
32
- * or a string, from the same elements `Markup` renders. Made with
33
- * `Render.markdown`. Each top level block is
32
+ * or a string, from the same elements `Markup` renders. Internal to ovr,
33
+ * made with `new Render`. Each top level block is
34
34
  * written as soon as it closes, and when the page has a `<main>` element, only
35
35
  * its contents are kept. Raw HTML is written as it is.
36
36
  *
37
37
  * ```tsx
38
- * const markdown = await Render.markdown(<Post post={post} />, { base: url }).string();
38
+ * const markdown = await new Render({ markdown: <Post post={post} /> }, { base: url }).string();
39
39
  * ```
40
40
  */
41
41
  export declare class Markdown {
@@ -1286,13 +1286,13 @@ class Blocks {
1286
1286
  }
1287
1287
  /**
1288
1288
  * Renders an element to Markdown, as an `AsyncIterable` of blocks, a stream,
1289
- * or a string, from the same elements `Markup` renders. Made with
1290
- * `Render.markdown`. Each top level block is
1289
+ * or a string, from the same elements `Markup` renders. Internal to ovr,
1290
+ * made with `new Render`. Each top level block is
1291
1291
  * written as soon as it closes, and when the page has a `<main>` element, only
1292
1292
  * its contents are kept. Raw HTML is written as it is.
1293
1293
  *
1294
1294
  * ```tsx
1295
- * const markdown = await Render.markdown(<Post post={post} />, { base: url }).string();
1295
+ * const markdown = await new Render({ markdown: <Post post={post} /> }, { base: url }).string();
1296
1296
  * ```
1297
1297
  */
1298
1298
  export class Markdown {
@@ -86,8 +86,8 @@ export declare class Element implements AsyncGenerator<Chunk, void, unknown> {
86
86
  [Symbol.asyncIterator](): this;
87
87
  [Symbol.asyncDispose](): Promise<void>;
88
88
  }
89
- /** Internal protocol for a render, to read the element a `Markup` renders. */
90
- declare const source: unique symbol;
89
+ /** Internal protocol for a render, to read the element it renders. */
90
+ export declare const source: unique symbol;
91
91
  /** One step of a render: a chunk, a wait before the next step, or nothing once it is done */
92
92
  export type Step = Chunk | Promise<unknown> | undefined;
93
93
  /**
@@ -139,7 +139,7 @@ export declare namespace Markup {
139
139
  /**
140
140
  * Renders an element to markup, such as HTML, SVG, or XML, as an
141
141
  * `AsyncIterable` of strings, a stream, or a string. `Markdown` renders the
142
- * same elements to Markdown. Made with `Render.markup`.
142
+ * same elements to Markdown. Internal to ovr, made with `new Render`.
143
143
  */
144
144
  export declare class Markup {
145
145
  #private;
@@ -150,7 +150,7 @@ export declare class Markup {
150
150
  * @param options Markup options
151
151
  */
152
152
  constructor(element: JSX.Element, options?: Markup.Options);
153
- /** @returns The element, rendered in place where a `Markup` is a child */
153
+ /** @returns The element, rendered in place where a render is a child */
154
154
  get [source](): JSX.Element;
155
155
  /** @yields Markup as the `Element` resolves */
156
156
  [Symbol.asyncIterator](): AsyncGenerator<string, void, unknown>;
@@ -180,5 +180,4 @@ export declare class Markup {
180
180
  */
181
181
  static escape(html: string, attr?: boolean): string;
182
182
  }
183
- export {};
184
183
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/markup/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAG3C,mDAAmD;AACnD,qBAAa,KAAK;IACjB,iCAAiC;IACjC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB,0DAA0D;IAC1D,QAAQ,CAAC,GAAG,EAAE,OAAO,GAAG,SAAS,CAAC;IAElC;;;;;OAKG;IACH,YAAY,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,OAAO,EAGxC;IAED;;OAEG;IACH,QAAQ,IAAI,MAAM,CAEjB;CACD;AAED;;;GAGG;AACH,qBAAa,GAAI,SAAQ,KAAK;IAC7B,eAAe;IACf,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,uDAAuD;IACvD,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,GAAG,SAAS,CAAC;IAEtC,mEAAmE;IACnE,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,CAAC;IAErC;;;;OAIG;IACH,YAAY,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,OAAO,EAK5D;IAED,0DAA0D;IACjD,QAAQ,WA6BhB;CACD;AAED;;;GAGG;AACH,qBAAa,MAAO,SAAQ,KAAK;IAChC,sBAAsB;IACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,YAAY,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAG3C;CACD;AAED;;;GAGG;AACH,qBAAa,KAAM,SAAQ,KAAK;IAC/B,sBAAsB;IACtB,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;IAEzB,oCAAoC;IACpC,YAAY,MAAM,EAAE,KAAK,EAAE,EAG1B;IAEQ,QAAQ,WAKhB;CACD;AAwBD;;;;;GAKG;AACH,qBAAa,OAAQ,YAAW,cAAc,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC;;IACnE,6BAA6B;IAC7B,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAC,OAAO,CAAC,CAAC;IAErD,YAAY;IACZ,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC;IAQ1B;;;OAGG;IACH,YAAY,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAGxE;IAED,kEAAkE;IAClE,IAAI,YAEH;IAuBD,IAAI,yCAEH;IAED,MAAM,CAAC,KAAK,EAAE,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,wCAErC;IAED,KAAK,CAAC,KAAK,EAAE,OAAO,wCAEnB;IAED,CAAC,MAAM,CAAC,aAAa,CAAC,SAErB;IAEK,CAAC,MAAM,CAAC,YAAY,CAAC,kBAE1B;CACD;AAED,8EAA8E;AAC9E,QAAA,MAAM,MAAM,eAAmB,CAAC;AAEhC,6FAA6F;AAC7F,MAAM,MAAM,IAAI,GAAG,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;AAQxD;;;;GAIG;AACH,qBAAa,QAAQ;;IACpB,uEAAuE;IACvE,KAAK,EAAE,KAAK,EAAE,GAAG,SAAS,CAAC;IAE3B,4CAA4C;IAC5C,OAAO,UAAS;IAEhB,2DAA2D;IAC3D,IAAI,UAAS;IAiBb;;;OAGG;IACH,YAAY,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,GAAG,SAAS,EAGrD;IAED;;;OAGG;IACH,IAAI,IAAI,IAAI,CA+IX;IAED;;;OAGG;IACG,KAAK,kBAqBV;CACD;AA0MD;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,WAAY;IAChC,IAAI,IAAI,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IACtD,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;CAC1B,gDA0EA,CAAC;AAEF,yBAAiB,MAAM,CAAC;IACvB,qBAAqB;IACrB,KAAY,OAAO,GAAG;QACrB,wEAAwE;QACxE,GAAG,CAAC,EAAE,OAAO,CAAC;KACd,CAAC;CACF;AAED;;;;GAIG;AACH,qBAAa,MAAM;;IAgBlB;;;;;OAKG;IACH,YAAY,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,OAAO,EAGzD;IAED,0EAA0E;IAC1E,IAAI,CAAC,MAAM,CAAC,gBAEX;IAED,+CAA+C;IACxC,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAWrE;IAED;;;;;OAKG;IACH,MAAM,gDAEL;IAED;;;;;;;;OAQG;IACG,MAAM,oBAeX;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,UAOzC;CACD"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/markup/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAG3C,mDAAmD;AACnD,qBAAa,KAAK;IACjB,iCAAiC;IACjC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB,0DAA0D;IAC1D,QAAQ,CAAC,GAAG,EAAE,OAAO,GAAG,SAAS,CAAC;IAElC;;;;;OAKG;IACH,YAAY,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,OAAO,EAGxC;IAED;;OAEG;IACH,QAAQ,IAAI,MAAM,CAEjB;CACD;AAED;;;GAGG;AACH,qBAAa,GAAI,SAAQ,KAAK;IAC7B,eAAe;IACf,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,uDAAuD;IACvD,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,GAAG,SAAS,CAAC;IAEtC,mEAAmE;IACnE,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,CAAC;IAErC;;;;OAIG;IACH,YAAY,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,OAAO,EAK5D;IAED,0DAA0D;IACjD,QAAQ,WA6BhB;CACD;AAED;;;GAGG;AACH,qBAAa,MAAO,SAAQ,KAAK;IAChC,sBAAsB;IACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,YAAY,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAG3C;CACD;AAED;;;GAGG;AACH,qBAAa,KAAM,SAAQ,KAAK;IAC/B,sBAAsB;IACtB,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;IAEzB,oCAAoC;IACpC,YAAY,MAAM,EAAE,KAAK,EAAE,EAG1B;IAEQ,QAAQ,WAKhB;CACD;AAwBD;;;;;GAKG;AACH,qBAAa,OAAQ,YAAW,cAAc,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC;;IACnE,6BAA6B;IAC7B,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAC,OAAO,CAAC,CAAC;IAErD,YAAY;IACZ,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC;IAQ1B;;;OAGG;IACH,YAAY,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,GAAG,KAAK,GAAG,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAGxE;IAED,kEAAkE;IAClE,IAAI,YAEH;IAuBD,IAAI,yCAEH;IAED,MAAM,CAAC,KAAK,EAAE,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,wCAErC;IAED,KAAK,CAAC,KAAK,EAAE,OAAO,wCAEnB;IAED,CAAC,MAAM,CAAC,aAAa,CAAC,SAErB;IAEK,CAAC,MAAM,CAAC,YAAY,CAAC,kBAE1B;CACD;AAED,sEAAsE;AACtE,eAAO,MAAM,MAAM,eAAmB,CAAC;AAEvC,6FAA6F;AAC7F,MAAM,MAAM,IAAI,GAAG,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;AAQxD;;;;GAIG;AACH,qBAAa,QAAQ;;IACpB,uEAAuE;IACvE,KAAK,EAAE,KAAK,EAAE,GAAG,SAAS,CAAC;IAE3B,4CAA4C;IAC5C,OAAO,UAAS;IAEhB,2DAA2D;IAC3D,IAAI,UAAS;IAiBb;;;OAGG;IACH,YAAY,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,GAAG,SAAS,EAGrD;IAED;;;OAGG;IACH,IAAI,IAAI,IAAI,CAgJX;IAED;;;OAGG;IACG,KAAK,kBAqBV;CACD;AA0MD;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,WAAY;IAChC,IAAI,IAAI,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;IACtD,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;CAC1B,gDA0EA,CAAC;AAEF,yBAAiB,MAAM,CAAC;IACvB,qBAAqB;IACrB,KAAY,OAAO,GAAG;QACrB,wEAAwE;QACxE,GAAG,CAAC,EAAE,OAAO,CAAC;KACd,CAAC;CACF;AAED;;;;GAIG;AACH,qBAAa,MAAM;;IAgBlB;;;;;OAKG;IACH,YAAY,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,OAAO,EAGzD;IAED,wEAAwE;IACxE,IAAI,CAAC,MAAM,CAAC,gBAEX;IAED,+CAA+C;IACxC,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAWrE;IAED;;;;;OAKG;IACH,MAAM,gDAEL;IAED;;;;;;;;OAQG;IACG,MAAM,oBAeX;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,UAOzC;CACD"}
@@ -197,8 +197,8 @@ export class Element {
197
197
  await this.return();
198
198
  }
199
199
  }
200
- /** Internal protocol for a render, to read the element a `Markup` renders. */
201
- const source = Symbol("source");
200
+ /** Internal protocol for a render, to read the element it renders. */
201
+ export const source = Symbol("source");
202
202
  /**
203
203
  * Renders an element one chunk at a time, internal to ovr. A step is
204
204
  * synchronous unless the element has to be waited for, so nested elements cost
@@ -286,8 +286,9 @@ export class Renderer {
286
286
  }
287
287
  return new Tag(tag, props, closed);
288
288
  }
289
- if (element instanceof Markup) {
290
- // its element, which its strings would be escaped as text
289
+ if (source in element) {
290
+ // a render as a child: its element, which its strings would
291
+ // be escaped as text
291
292
  this.#element = element[source];
292
293
  this.#next = 1;
293
294
  continue;
@@ -628,7 +629,7 @@ export const readable = (render) => {
628
629
  /**
629
630
  * Renders an element to markup, such as HTML, SVG, or XML, as an
630
631
  * `AsyncIterable` of strings, a stream, or a string. `Markdown` renders the
631
- * same elements to Markdown. Made with `Render.markup`.
632
+ * same elements to Markdown. Internal to ovr, made with `new Render`.
632
633
  */
633
634
  export class Markup {
634
635
  /** Regex to find escape character for attributes */
@@ -651,7 +652,7 @@ export class Markup {
651
652
  this.#element = element;
652
653
  this.#options = options;
653
654
  }
654
- /** @returns The element, rendered in place where a `Markup` is a child */
655
+ /** @returns The element, rendered in place where a render is a child */
655
656
  get [source]() {
656
657
  return this.#element;
657
658
  }
@@ -1,20 +1,14 @@
1
1
  import type { JSX } from "../jsx/index.js";
2
2
  import { Markdown as MarkdownRender } from "../markdown/index.js";
3
- import { Chunk as ChunkClass, Markup as MarkupRender } from "../markup/index.js";
3
+ import { Chunk as ChunkClass, Markup as MarkupRender, source } from "../markup/index.js";
4
4
  export declare namespace Render {
5
5
  /** A piece of a render, an interface so declaration files name it */
6
6
  interface Chunk extends ChunkClass {
7
7
  }
8
- /** A render of markup: an `AsyncIterable` of strings, a stream, or a string */
9
- interface Markup extends MarkupRender {
10
- }
11
8
  namespace Markup {
12
9
  /** Markup options */
13
10
  type Options = MarkupRender.Options;
14
11
  }
15
- /** A render of Markdown: an `AsyncIterable` of strings, a stream, or a string */
16
- interface Markdown extends MarkdownRender {
17
- }
18
12
  namespace Markdown {
19
13
  /** Markdown options */
20
14
  type Options = MarkdownRender.Options;
@@ -53,15 +47,57 @@ export declare namespace Render {
53
47
  };
54
48
  }
55
49
  /**
56
- * Renders elements, to markup such as HTML for browsers and to Markdown for
57
- * agents, and writes what is already rendered as it is.
50
+ * A render of an element, to markup such as HTML for browsers or to Markdown
51
+ * for agents: an `AsyncIterable` of strings, a stream, or a string. Its
52
+ * static methods write what is already rendered as it is.
58
53
  *
59
54
  * ```tsx
60
- * const html = await Render.markup(<Page />).string();
61
- * const markdown = await Render.markdown(<Page />).string();
55
+ * const html = await new Render({ markup: <Page /> }).string();
56
+ * const markdown = await new Render({ markdown: <Page /> }).string();
57
+ *
58
+ * for await (const chunk of new Render({ markup: <Page /> })) {
59
+ * // each string as the element resolves
60
+ * }
62
61
  * ```
63
62
  */
64
63
  export declare class Render {
64
+ #private;
65
+ /**
66
+ * @param element The element, by what to render it to: `markup`, such as
67
+ * HTML, SVG, or XML
68
+ * @param options Markup options
69
+ */
70
+ constructor(element: {
71
+ readonly markup: JSX.Element;
72
+ }, options?: Render.Markup.Options);
73
+ /**
74
+ * @param element The element, by what to render it to: `markdown`, as
75
+ * agents that ask for it read a page. Each top level block is written as
76
+ * soon as it closes, and when the page has a `<main>` element, only its
77
+ * contents are kept
78
+ * @param options Markdown options
79
+ */
80
+ constructor(element: {
81
+ readonly markdown: JSX.Element;
82
+ }, options?: Render.Markdown.Options);
83
+ /** @returns The element, rendered in place where a render is a child */
84
+ get [source](): JSX.Element;
85
+ /** @returns Strings of the render, as the element resolves */
86
+ [Symbol.asyncIterator](): AsyncGenerator<string, void, unknown>;
87
+ /**
88
+ * The render piped into a `ReadableStream`. Iterate it when possible, to
89
+ * avoid the overhead of the stream.
90
+ *
91
+ * @returns `ReadableStream` of the render
92
+ */
93
+ stream(): ReadableStream<Uint8Array<ArrayBufferLike>>;
94
+ /**
95
+ * The whole render as one string, which buffers it and gives up the
96
+ * benefits of streaming.
97
+ *
98
+ * @returns The render, concatenated
99
+ */
100
+ string(): Promise<string>;
65
101
  /**
66
102
  * Writes markup, Markdown, or both as they are, dangerously bypassing
67
103
  * escaping, so both must be safe.
@@ -92,29 +128,5 @@ export declare class Render {
92
128
  * @returns Escaped text
93
129
  */
94
130
  static escape(text: Render.Escape): string;
95
- /**
96
- * Renders an element to markup, such as HTML, SVG, or XML.
97
- *
98
- * ```tsx
99
- * for await (const chunk of Render.markup(<Page />)) {
100
- * // each string as the element resolves
101
- * }
102
- * ```
103
- *
104
- * @param element Element to render
105
- * @param options Markup options
106
- * @returns The render, to iterate, `stream()`, or `string()`
107
- */
108
- static markup(element: JSX.Element, options?: Render.Markup.Options): Render.Markup;
109
- /**
110
- * Renders an element to Markdown, as agents that ask for it read a page.
111
- * Each top level block is written as soon as it closes, and when the page
112
- * has a `<main>` element, only its contents are kept.
113
- *
114
- * @param element Element to render
115
- * @param options Markdown options
116
- * @returns The render, to iterate, `stream()`, or `string()`
117
- */
118
- static markdown(element: JSX.Element, options?: Render.Markdown.Options): Render.Markdown;
119
131
  }
120
132
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/render/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,QAAQ,IAAI,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAClE,OAAO,EACN,KAAK,IAAI,UAAU,EACnB,MAAM,IAAI,YAAY,EAEtB,MAAM,oBAAoB,CAAC;AAE5B,yBAAiB,MAAM,CAAC;IACvB,qEAAqE;IACrE,UAAiB,KAAM,SAAQ,UAAU;KAAG;IAE5C,+EAA+E;IAC/E,UAAiB,MAAO,SAAQ,YAAY;KAAG;IAE/C,UAAiB,MAAM,CAAC;QACvB,qBAAqB;QACrB,KAAY,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC;KAC3C;IAED,iFAAiF;IACjF,UAAiB,QAAS,SAAQ,cAAc;KAAG;IAEnD,UAAiB,QAAQ,CAAC;QACzB,uBAAuB;QACvB,KAAY,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC;KAC7C;IAED,oDAAoD;IACpD,KAAY,MAAM,GACf;QACA,oCAAoC;QACpC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC;QACtB,QAAQ,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC;KACzB,GACD;QACA,oCAAoC;QACpC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC;QACxB,QAAQ,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC;KACzB,GACD;QACA,wBAAwB;QACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC;QACxB,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC;KACrB,CAAC;IAEL;;;OAGG;IACH,KAAY,GAAG,GACZ;QACA,iCAAiC;QACjC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;QACzB,mFAAmF;QACnF,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;KAC3B,GACD;QACA,wDAAwD;QACxD,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;QAC1B,mDAAmD;QACnD,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;KAC1B,CAAC;CACL;AAED;;;;;;;;GAQG;AACH,qBAAa,MAAM;IAClB;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,KAAK,CAIxC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,UAMhC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,MAAM,CACZ,OAAO,EAAE,GAAG,CAAC,OAAO,EACpB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,GAC7B,MAAM,CAAC,MAAM,CAEf;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,QAAQ,CACd,OAAO,EAAE,GAAG,CAAC,OAAO,EACpB,OAAO,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,GAC/B,MAAM,CAAC,QAAQ,CAEjB;CACD"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/render/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,QAAQ,IAAI,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAClE,OAAO,EACN,KAAK,IAAI,UAAU,EACnB,MAAM,IAAI,YAAY,EAEtB,MAAM,EACN,MAAM,oBAAoB,CAAC;AAE5B,yBAAiB,MAAM,CAAC;IACvB,qEAAqE;IACrE,UAAiB,KAAM,SAAQ,UAAU;KAAG;IAE5C,UAAiB,MAAM,CAAC;QACvB,qBAAqB;QACrB,KAAY,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC;KAC3C;IAED,UAAiB,QAAQ,CAAC;QACzB,uBAAuB;QACvB,KAAY,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC;KAC7C;IAED,oDAAoD;IACpD,KAAY,MAAM,GACf;QACA,oCAAoC;QACpC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC;QACtB,QAAQ,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC;KACzB,GACD;QACA,oCAAoC;QACpC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC;QACxB,QAAQ,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC;KACzB,GACD;QACA,wBAAwB;QACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC;QACxB,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC;KACrB,CAAC;IAEL;;;OAGG;IACH,KAAY,GAAG,GACZ;QACA,iCAAiC;QACjC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;QACzB,mFAAmF;QACnF,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;KAC3B,GACD;QACA,wDAAwD;QACxD,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;QAC1B,mDAAmD;QACnD,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;KAC1B,CAAC;CACL;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,MAAM;;IAOlB;;;;OAIG;IACH,YACC,OAAO,EAAE;QAAE,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,OAAO,CAAA;KAAE,EACzC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAC9B;IACF;;;;;;OAMG;IACH,YACC,OAAO,EAAE;QAAE,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAA;KAAE,EAC3C,OAAO,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO,EAChC;IAeF,wEAAwE;IACxE,IAAI,CAAC,MAAM,CAAC,gBAEX;IAED,8DAA8D;IAC9D,CAAC,MAAM,CAAC,aAAa,CAAC,0CAErB;IAED;;;;;OAKG;IACH,MAAM,gDAEL;IAED;;;;;OAKG;IACH,MAAM,oBAEL;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,KAAK,CAIxC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,UAMhC;CACD"}
@@ -1,15 +1,60 @@
1
1
  import { Markdown as MarkdownRender } from "../markdown/index.js";
2
- import { Chunk as ChunkClass, Markup as MarkupRender, Source, } from "../markup/index.js";
2
+ import { Chunk as ChunkClass, Markup as MarkupRender, Source, source, } from "../markup/index.js";
3
3
  /**
4
- * Renders elements, to markup such as HTML for browsers and to Markdown for
5
- * agents, and writes what is already rendered as it is.
4
+ * A render of an element, to markup such as HTML for browsers or to Markdown
5
+ * for agents: an `AsyncIterable` of strings, a stream, or a string. Its
6
+ * static methods write what is already rendered as it is.
6
7
  *
7
8
  * ```tsx
8
- * const html = await Render.markup(<Page />).string();
9
- * const markdown = await Render.markdown(<Page />).string();
9
+ * const html = await new Render({ markup: <Page /> }).string();
10
+ * const markdown = await new Render({ markdown: <Page /> }).string();
11
+ *
12
+ * for await (const chunk of new Render({ markup: <Page /> })) {
13
+ * // each string as the element resolves
14
+ * }
10
15
  * ```
11
16
  */
12
17
  export class Render {
18
+ /** Element to render */
19
+ #element;
20
+ /** What renders it */
21
+ #render;
22
+ constructor(element, options) {
23
+ if ("markdown" in element) {
24
+ this.#element = element.markdown;
25
+ this.#render = new MarkdownRender(this.#element, options);
26
+ }
27
+ else {
28
+ this.#element = element.markup;
29
+ this.#render = new MarkupRender(this.#element, options);
30
+ }
31
+ }
32
+ /** @returns The element, rendered in place where a render is a child */
33
+ get [source]() {
34
+ return this.#element;
35
+ }
36
+ /** @returns Strings of the render, as the element resolves */
37
+ [Symbol.asyncIterator]() {
38
+ return this.#render[Symbol.asyncIterator]();
39
+ }
40
+ /**
41
+ * The render piped into a `ReadableStream`. Iterate it when possible, to
42
+ * avoid the overhead of the stream.
43
+ *
44
+ * @returns `ReadableStream` of the render
45
+ */
46
+ stream() {
47
+ return this.#render.stream();
48
+ }
49
+ /**
50
+ * The whole render as one string, which buffers it and gives up the
51
+ * benefits of streaming.
52
+ *
53
+ * @returns The render, concatenated
54
+ */
55
+ string() {
56
+ return this.#render.string();
57
+ }
13
58
  /**
14
59
  * Writes markup, Markdown, or both as they are, dangerously bypassing
15
60
  * escaping, so both must be safe.
@@ -50,32 +95,4 @@ export class Render {
50
95
  ? MarkupRender.escape(text.attr, true)
51
96
  : MarkupRender.escape(text.markup);
52
97
  }
53
- /**
54
- * Renders an element to markup, such as HTML, SVG, or XML.
55
- *
56
- * ```tsx
57
- * for await (const chunk of Render.markup(<Page />)) {
58
- * // each string as the element resolves
59
- * }
60
- * ```
61
- *
62
- * @param element Element to render
63
- * @param options Markup options
64
- * @returns The render, to iterate, `stream()`, or `string()`
65
- */
66
- static markup(element, options) {
67
- return new MarkupRender(element, options);
68
- }
69
- /**
70
- * Renders an element to Markdown, as agents that ask for it read a page.
71
- * Each top level block is written as soon as it closes, and when the page
72
- * has a `<main>` element, only its contents are kept.
73
- *
74
- * @param element Element to render
75
- * @param options Markdown options
76
- * @returns The render, to iterate, `stream()`, or `string()`
77
- */
78
- static markdown(element, options) {
79
- return new MarkdownRender(element, options);
80
- }
81
98
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "ovr",
3
3
  "description": "Web apps anyone can use. Each route serves people a page and agents Markdown and MCP tools, with forms, Postgres, and passkey sign-in built in.",
4
- "version": "7.0.0-next.36",
4
+ "version": "7.0.0-next.37",
5
5
  "license": "MIT",
6
6
  "repository": {
7
7
  "type": "git",
@@ -1477,13 +1477,13 @@ class Blocks {
1477
1477
 
1478
1478
  /**
1479
1479
  * Renders an element to Markdown, as an `AsyncIterable` of blocks, a stream,
1480
- * or a string, from the same elements `Markup` renders. Made with
1481
- * `Render.markdown`. Each top level block is
1480
+ * or a string, from the same elements `Markup` renders. Internal to ovr,
1481
+ * made with `new Render`. Each top level block is
1482
1482
  * written as soon as it closes, and when the page has a `<main>` element, only
1483
1483
  * its contents are kept. Raw HTML is written as it is.
1484
1484
  *
1485
1485
  * ```tsx
1486
- * const markdown = await Render.markdown(<Post post={post} />, { base: url }).string();
1486
+ * const markdown = await new Render({ markdown: <Post post={post} /> }, { base: url }).string();
1487
1487
  * ```
1488
1488
  */
1489
1489
  export class Markdown {
@@ -224,8 +224,8 @@ export class Element implements AsyncGenerator<Chunk, void, unknown> {
224
224
  }
225
225
  }
226
226
 
227
- /** Internal protocol for a render, to read the element a `Markup` renders. */
228
- const source = Symbol("source");
227
+ /** Internal protocol for a render, to read the element it renders. */
228
+ export const source = Symbol("source");
229
229
 
230
230
  /** One step of a render: a chunk, a wait before the next step, or nothing once it is done */
231
231
  export type Step = Chunk | Promise<unknown> | undefined;
@@ -343,9 +343,10 @@ export class Renderer {
343
343
  return new Tag(tag, props, closed);
344
344
  }
345
345
 
346
- if (element instanceof Markup) {
347
- // its element, which its strings would be escaped as text
348
- this.#element = element[source];
346
+ if (source in element) {
347
+ // a render as a child: its element, which its strings would
348
+ // be escaped as text
349
+ this.#element = (element as { [source]: unknown })[source];
349
350
  this.#next = 1;
350
351
  continue;
351
352
  }
@@ -748,7 +749,7 @@ export namespace Markup {
748
749
  /**
749
750
  * Renders an element to markup, such as HTML, SVG, or XML, as an
750
751
  * `AsyncIterable` of strings, a stream, or a string. `Markdown` renders the
751
- * same elements to Markdown. Made with `Render.markup`.
752
+ * same elements to Markdown. Internal to ovr, made with `new Render`.
752
753
  */
753
754
  export class Markup {
754
755
  /** Regex to find escape character for attributes */
@@ -777,7 +778,7 @@ export class Markup {
777
778
  this.#options = options;
778
779
  }
779
780
 
780
- /** @returns The element, rendered in place where a `Markup` is a child */
781
+ /** @returns The element, rendered in place where a render is a child */
781
782
  get [source]() {
782
783
  return this.#element;
783
784
  }
@@ -4,23 +4,18 @@ import {
4
4
  Chunk as ChunkClass,
5
5
  Markup as MarkupRender,
6
6
  Source,
7
+ source,
7
8
  } from "../markup/index.js";
8
9
 
9
10
  export namespace Render {
10
11
  /** A piece of a render, an interface so declaration files name it */
11
12
  export interface Chunk extends ChunkClass {}
12
13
 
13
- /** A render of markup: an `AsyncIterable` of strings, a stream, or a string */
14
- export interface Markup extends MarkupRender {}
15
-
16
14
  export namespace Markup {
17
15
  /** Markup options */
18
16
  export type Options = MarkupRender.Options;
19
17
  }
20
18
 
21
- /** A render of Markdown: an `AsyncIterable` of strings, a stream, or a string */
22
- export interface Markdown extends MarkdownRender {}
23
-
24
19
  export namespace Markdown {
25
20
  /** Markdown options */
26
21
  export type Options = MarkdownRender.Options;
@@ -67,15 +62,90 @@ export namespace Render {
67
62
  }
68
63
 
69
64
  /**
70
- * Renders elements, to markup such as HTML for browsers and to Markdown for
71
- * agents, and writes what is already rendered as it is.
65
+ * A render of an element, to markup such as HTML for browsers or to Markdown
66
+ * for agents: an `AsyncIterable` of strings, a stream, or a string. Its
67
+ * static methods write what is already rendered as it is.
72
68
  *
73
69
  * ```tsx
74
- * const html = await Render.markup(<Page />).string();
75
- * const markdown = await Render.markdown(<Page />).string();
70
+ * const html = await new Render({ markup: <Page /> }).string();
71
+ * const markdown = await new Render({ markdown: <Page /> }).string();
72
+ *
73
+ * for await (const chunk of new Render({ markup: <Page /> })) {
74
+ * // each string as the element resolves
75
+ * }
76
76
  * ```
77
77
  */
78
78
  export class Render {
79
+ /** Element to render */
80
+ readonly #element: JSX.Element;
81
+
82
+ /** What renders it */
83
+ readonly #render: MarkupRender | MarkdownRender;
84
+
85
+ /**
86
+ * @param element The element, by what to render it to: `markup`, such as
87
+ * HTML, SVG, or XML
88
+ * @param options Markup options
89
+ */
90
+ constructor(
91
+ element: { readonly markup: JSX.Element },
92
+ options?: Render.Markup.Options,
93
+ );
94
+ /**
95
+ * @param element The element, by what to render it to: `markdown`, as
96
+ * agents that ask for it read a page. Each top level block is written as
97
+ * soon as it closes, and when the page has a `<main>` element, only its
98
+ * contents are kept
99
+ * @param options Markdown options
100
+ */
101
+ constructor(
102
+ element: { readonly markdown: JSX.Element },
103
+ options?: Render.Markdown.Options,
104
+ );
105
+ constructor(
106
+ element:
107
+ { readonly markup: JSX.Element } | { readonly markdown: JSX.Element },
108
+ options?: Render.Markup.Options & Render.Markdown.Options,
109
+ ) {
110
+ if ("markdown" in element) {
111
+ this.#element = element.markdown;
112
+ this.#render = new MarkdownRender(this.#element, options);
113
+ } else {
114
+ this.#element = element.markup;
115
+ this.#render = new MarkupRender(this.#element, options);
116
+ }
117
+ }
118
+
119
+ /** @returns The element, rendered in place where a render is a child */
120
+ get [source]() {
121
+ return this.#element;
122
+ }
123
+
124
+ /** @returns Strings of the render, as the element resolves */
125
+ [Symbol.asyncIterator]() {
126
+ return this.#render[Symbol.asyncIterator]();
127
+ }
128
+
129
+ /**
130
+ * The render piped into a `ReadableStream`. Iterate it when possible, to
131
+ * avoid the overhead of the stream.
132
+ *
133
+ * @returns `ReadableStream` of the render
134
+ */
135
+ stream() {
136
+ return this.#render.stream();
137
+ }
138
+
139
+ /**
140
+ * The whole render as one string, which buffers it and gives up the
141
+ * benefits of streaming.
142
+ *
143
+ * @returns The render, concatenated
144
+ */
145
+ string() {
146
+ return this.#render.string();
147
+ }
148
+
79
149
  /**
80
150
  * Writes markup, Markdown, or both as they are, dangerously bypassing
81
151
  * escaping, so both must be safe.
@@ -117,40 +187,4 @@ export class Render {
117
187
  ? MarkupRender.escape(text.attr, true)
118
188
  : MarkupRender.escape(text.markup);
119
189
  }
120
-
121
- /**
122
- * Renders an element to markup, such as HTML, SVG, or XML.
123
- *
124
- * ```tsx
125
- * for await (const chunk of Render.markup(<Page />)) {
126
- * // each string as the element resolves
127
- * }
128
- * ```
129
- *
130
- * @param element Element to render
131
- * @param options Markup options
132
- * @returns The render, to iterate, `stream()`, or `string()`
133
- */
134
- static markup(
135
- element: JSX.Element,
136
- options?: Render.Markup.Options,
137
- ): Render.Markup {
138
- return new MarkupRender(element, options);
139
- }
140
-
141
- /**
142
- * Renders an element to Markdown, as agents that ask for it read a page.
143
- * Each top level block is written as soon as it closes, and when the page
144
- * has a `<main>` element, only its contents are kept.
145
- *
146
- * @param element Element to render
147
- * @param options Markdown options
148
- * @returns The render, to iterate, `stream()`, or `string()`
149
- */
150
- static markdown(
151
- element: JSX.Element,
152
- options?: Render.Markdown.Options,
153
- ): Render.Markdown {
154
- return new MarkdownRender(element, options);
155
- }
156
190
  }