ovr 7.0.0-next.33 → 7.0.0-next.35

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,23 @@
1
1
  # ovr
2
2
 
3
+ ## 7.0.0-next.35
4
+
5
+ ### Minor Changes
6
+
7
+ - 599e2c5: `Render.escape` takes the text by where it goes, and escapes Markdown too: `Render.escape({ html })` for an element's content, `Render.escape({ attr })` for an attribute's value, where it was `Render.escape(text, true)`, and `Render.escape({ markdown })`, for text put into the Markdown `Render.raw` is given.
8
+
9
+ ## 7.0.0-next.34
10
+
11
+ ### Minor Changes
12
+
13
+ - 3906e66: `Render` is the one export for rendering, in place of `Markup` and `Markdown`:
14
+
15
+ - `Render.raw({ html, markdown })` writes what is already rendered, for `Markup.raw(html)` and `Markdown.raw(markdown, html)`. With only `html`, agents get the markup too; with only `markdown`, the page shows nothing; and an empty `markdown` hides the markup from agents.
16
+ - `Render.markup(element, options)` and `Render.markdown(element, options)` return a render: an async iterable with `stream()` and `string()`, for `new Markup(element)`, `Markup.stream(element)`, `Markup.string(element)`, and the same of `Markdown`.
17
+ - `Render.escape(text)` for `Markup.escape(text)`.
18
+ - The types are `Render.Chunk`, `Render.Markup.Options`, and `Render.Markdown.Options`.
19
+ - `c.markdown(body)` for `c.md(body)`.
20
+
3
21
  ## 7.0.0-next.33
4
22
 
5
23
  ### Patch Changes
@@ -142,7 +142,7 @@ export declare class Context<Params extends Record<string, unknown> = Record<str
142
142
  * that is a Markdown document, so agents read its source.
143
143
  *
144
144
  * ```tsx
145
- * if (c.md(post.body)) return;
145
+ * if (c.markdown(post.body)) return;
146
146
  *
147
147
  * return <Post post={post} />;
148
148
  * ```
@@ -151,7 +151,7 @@ export declare class Context<Params extends Record<string, unknown> = Record<str
151
151
  * @param status [HTTP response status code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status)
152
152
  * @returns `true` if it responded, otherwise the page renders for the browser
153
153
  */
154
- md(body: BodyInit | null, status?: number): boolean;
154
+ markdown(body: BodyInit | null, status?: number): boolean;
155
155
  /**
156
156
  * Creates a redirect response.
157
157
  *
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/context/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,KAAK,KAAK,EAA6B,MAAM,kBAAkB,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAEvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,OAAO,EAAkC,KAAK,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAE7E;;;;GAIG;AACH,eAAO,MAAM,KAAK;uBAGG,OAAO;IAC1B,8DAA8D;oBAC9C,WAAW,CAAC,MAAM,CAAC;aAC1B,SAAS;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE;IACvE,2EAA2E;oBAC3D,QAAQ,CAAC,OAAO,CAAC,OAAO,KAAK,CAAC;EAE7C,CAAC;AAEJ,6EAA6E;AAC7E,cAAM,gBAAgB;IACrB;;;;OAIG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IAEvB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5B;;;;OAIG;IACH,OAAO,UAAiB;CACxB;AAED,yDAAyD;AACzD,eAAO,MAAM,QAAQ,eAAqB,CAAC;AAE3C,yBAAiB,OAAO,CAAC;IACxB,4CAA4C;IAC5C,MAAM,WAAW,OAAO;QACvB;;;WAGG;QACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;QACpB,eAAe;QACf,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,gFAAgF;QAChF,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;KAC5B;IAED;;;;;OAKG;IACH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,KAAK,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GACxD,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,IAAI,GAC1B,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,GACxB,IAAI,GACJ,MAAM,CAAC,CAAC,CAAC,CAAC;IAEd;;;;OAIG;IACH,KAAK,MAAM,CAAC,CAAC,SAAS,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,CACjD,KAAK,CAAC,KAAK,CAAC,MAAM,CACjB,CAAC,EACD;QACC,qEAAqE;QACrE,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;KAClB,CACD,CACD,CAAC;;CACF;AAED;;;;;GAKG;AACH,qBAAa,OAAO,CACnB,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAEhE,KAAK,SAAS,KAAK,CAAC,KAAK,GAAG,GAAG;;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;IACtB,uGAAuG;IACvG,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAElB,+BAA+B;IAC/B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAgB;IAEvC,+BAA+B;IAC/B,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IAEvB,iEAAiE;IACjE,QAAQ,CAAC,GAAG,mBAA0B;IAEtC,qEAAqE;IACrE,QAAQ,CAAC,MAAM,SAAoB;IAWnC,6CAA6C;IAC7C,CAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;IAEnD;;;;OAIG;IACH,YAAY,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,EAAE,MAAM,EAK1D;IAED;;;;;OAKG;IACH,IAAI,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI,EAAE,MAAM,CAAC,EAAE,MAAM,QAE1C;IAED;;;;;;OAMG;IACH,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,KAAK,GAAG,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,QAE1D;IAED;;;;;OAKG;IACH,IAAI,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI,EAAE,MAAM,CAAC,EAAE,MAAM,QAE1C;IAED;;;;;;;;;;;;;;OAcG;IACH,EAAE,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI,EAAE,MAAM,CAAC,EAAE,MAAM,WAMxC;IAaD;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,CAAC,SAAS,MAAM,GAAG,GAAG,GAAG,KAAK,EAEtC,QAAQ,EAAE,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GAC/B,CAAC,SAAS,GAAG,MAAM,GAAG,GAAG,GAAG,GAAG,GAAG,MAAM,EAAE,GACzC,KAAK,GACL,CAAC,GACF,CAAC,EACJ,MAAM,GAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAS,QAQzC;IAED;;;;;;;;OAQG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,WAalB;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,OAAO,aAEpC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,oCAIN;IAED;;;;;;OAMG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAgEtE;IAqGD;;;;;;OAMG;IACH,OAAa,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,qBAoBxD;CACD"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/context/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,KAAK,KAAK,EAA6B,MAAM,kBAAkB,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAEvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,OAAO,EAAkC,KAAK,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAE7E;;;;GAIG;AACH,eAAO,MAAM,KAAK;uBAGG,OAAO;IAC1B,8DAA8D;oBAC9C,WAAW,CAAC,MAAM,CAAC;aAC1B,SAAS;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE;IACvE,2EAA2E;oBAC3D,QAAQ,CAAC,OAAO,CAAC,OAAO,KAAK,CAAC;EAE7C,CAAC;AAEJ,6EAA6E;AAC7E,cAAM,gBAAgB;IACrB;;;;OAIG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IAEvB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5B;;;;OAIG;IACH,OAAO,UAAiB;CACxB;AAED,yDAAyD;AACzD,eAAO,MAAM,QAAQ,eAAqB,CAAC;AAE3C,yBAAiB,OAAO,CAAC;IACxB,4CAA4C;IAC5C,MAAM,WAAW,OAAO;QACvB;;;WAGG;QACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;QACpB,eAAe;QACf,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACtB,gFAAgF;QAChF,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;KAC5B;IAED;;;;;OAKG;IACH,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,KAAK,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GACxD,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,IAAI,GAC1B,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,GACxB,IAAI,GACJ,MAAM,CAAC,CAAC,CAAC,CAAC;IAEd;;;;OAIG;IACH,KAAK,MAAM,CAAC,CAAC,SAAS,KAAK,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,CACjD,KAAK,CAAC,KAAK,CAAC,MAAM,CACjB,CAAC,EACD;QACC,qEAAqE;QACrE,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;KAClB,CACD,CACD,CAAC;;CACF;AAED;;;;;GAKG;AACH,qBAAa,OAAO,CACnB,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAEhE,KAAK,SAAS,KAAK,CAAC,KAAK,GAAG,GAAG;;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;IACtB,uGAAuG;IACvG,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;OAIG;IACH,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAElB,+BAA+B;IAC/B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAgB;IAEvC,+BAA+B;IAC/B,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IAEvB,iEAAiE;IACjE,QAAQ,CAAC,GAAG,mBAA0B;IAEtC,qEAAqE;IACrE,QAAQ,CAAC,MAAM,SAAoB;IAWnC,6CAA6C;IAC7C,CAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;IAEnD;;;;OAIG;IACH,YAAY,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,EAAE,MAAM,EAK1D;IAED;;;;;OAKG;IACH,IAAI,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI,EAAE,MAAM,CAAC,EAAE,MAAM,QAE1C;IAED;;;;;;OAMG;IACH,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,SAAS,MAAM,GAAG,KAAK,GAAG,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,QAE1D;IAED;;;;;OAKG;IACH,IAAI,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI,EAAE,MAAM,CAAC,EAAE,MAAM,QAE1C;IAED;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI,EAAE,MAAM,CAAC,EAAE,MAAM,WAM9C;IAaD;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,CAAC,SAAS,MAAM,GAAG,GAAG,GAAG,KAAK,EAEtC,QAAQ,EAAE,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,CAAC,GAC/B,CAAC,SAAS,GAAG,MAAM,GAAG,GAAG,GAAG,GAAG,GAAG,MAAM,EAAE,GACzC,KAAK,GACL,CAAC,GACF,CAAC,EACJ,MAAM,GAAE,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAS,QAQzC;IAED;;;;;;;;OAQG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,WAalB;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,OAAO,aAEpC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,oCAIN;IAED;;;;;;OAMG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAgEtE;IAqGD;;;;;;OAMG;IACH,OAAa,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,qBAoBxD;CACD"}
@@ -116,7 +116,7 @@ export class Context {
116
116
  * that is a Markdown document, so agents read its source.
117
117
  *
118
118
  * ```tsx
119
- * if (c.md(post.body)) return;
119
+ * if (c.markdown(post.body)) return;
120
120
  *
121
121
  * return <Post post={post} />;
122
122
  * ```
@@ -125,7 +125,7 @@ export class Context {
125
125
  * @param status [HTTP response status code](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status)
126
126
  * @returns `true` if it responded, otherwise the page renders for the browser
127
127
  */
128
- md(body, status) {
128
+ markdown(body, status) {
129
129
  if (!this.#markdown())
130
130
  return false;
131
131
  this.#respond(body, status, Header.utf8(Mime.type.md));
@@ -328,18 +328,18 @@ export class Context {
328
328
  // for both
329
329
  if (!/^\s*attachment/i.test(res.headers.get("content-disposition") ?? "") &&
330
330
  this.#markdown()) {
331
- res.body = Markdown.stream(r, {
331
+ res.body = new Markdown(r, {
332
332
  base: this.url,
333
333
  [tools]: agent.get(this.req)?.tool,
334
- });
334
+ }).stream();
335
335
  res.headers.set(Header.name.type, Header.utf8(Mime.type.md));
336
336
  return;
337
337
  }
338
338
  }
339
- res.body = Markup.stream(r, {
339
+ res.body = new Markup(r, {
340
340
  // other defined types are not markup, so they are not escaped
341
341
  raw: Boolean(mime && !Mime.markup(mime)),
342
- });
342
+ }).stream();
343
343
  if (!mime) {
344
344
  // default to HTML
345
345
  res.headers.set(Header.name.type, Header.utf8(Mime.type.html));
package/dist/index.d.ts CHANGED
@@ -6,8 +6,7 @@ export { Mcp } from "./mcp/index.js";
6
6
  export type { JSX } from "./jsx/index.js";
7
7
  export type { Middleware } from "./middleware/index.js";
8
8
  export { Multipart } from "./multipart/index.js";
9
- export { Markup } from "./markup/index.js";
10
- export { Markdown } from "./markdown/index.js";
9
+ export { Render } from "./render/index.js";
11
10
  export { Route } from "./route/index.js";
12
11
  export { Table } from "./table/index.js";
13
12
  export { Field } from "./form/index.js";
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACrC,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACrC,YAAY,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAC1C,YAAY,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACrC,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AACrC,YAAY,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAC1C,YAAY,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC"}
package/dist/index.js CHANGED
@@ -4,8 +4,7 @@ export { Database } from "./database/index.js";
4
4
  export { Limiter } from "./limiter/index.js";
5
5
  export { Mcp } from "./mcp/index.js";
6
6
  export { Multipart } from "./multipart/index.js";
7
- export { Markup } from "./markup/index.js";
8
- export { Markdown } from "./markdown/index.js";
7
+ export { Render } from "./render/index.js";
9
8
  export { Route } from "./route/index.js";
10
9
  export { Table } from "./table/index.js";
11
10
  export { Field } from "./form/index.js";
@@ -1,4 +1,4 @@
1
- import { type Markup } from "../markup/index.js";
1
+ import { type Chunk } from "../markup/index.js";
2
2
  import type { IntrinsicElements as IE } from "./elements.js";
3
3
  export declare namespace JSX {
4
4
  /**
@@ -39,7 +39,7 @@ export declare class JSX {
39
39
  * @param props object containing all the properties and attributes passed to the element or component
40
40
  * @returns Generator of the element's `Chunk`s of HTML
41
41
  */
42
- static jsx<P extends JSX.Props = JSX.Props>(tag: ((props: P) => JSX.Element) | string, props: P): AsyncGenerator<Markup.Chunk, void, unknown>;
42
+ static jsx<P extends JSX.Props = JSX.Props>(tag: ((props: P) => JSX.Element) | string, props: P): AsyncGenerator<Chunk, void, unknown>;
43
43
  /**
44
44
  * JSX requires a `Fragment` export to resolve `<></>`
45
45
  *
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/jsx/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,KAAK,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,KAAK,EAAE,iBAAiB,IAAI,EAAE,EAAE,MAAM,eAAe,CAAC;AAE7D,yBAAiB,GAAG,CAAC;IACpB;;;;OAIG;IACH,KAAK,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACtC;;;;OAIG;IACH,KAAK,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAEtC,6BAA6B;IAC7B,MAAM,WAAW,iBAAkB,SAAQ,EAAE;KAAG;IAEhD,kBAAkB;IAClB,MAAM,MAAM,OAAO,GAAG,aAAa,CAClC,YAAY,CACT,MAAM,GACN,MAAM,GACN,MAAM,GACN,OAAO,GACP,MAAM,GACN,IAAI,GACJ,SAAS,GACT,MAAM,GACN,QAAQ,CAAC,OAAO,CAAC,GACjB,aAAa,CAAC,OAAO,CAAC,CACxB,CACD,CAAC;IAEF,8BAA8B;IAC9B,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IAEhD;;;;OAIG;IACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,GAAG,KAAK,OAAO,CAAC,CAAC;;CAC7D;AAED,cAAc;AACd,qBAAa,GAAG;IACf;;;;;;;;OAQG;IACH,MAAM,CAAC,GAAG,CAAC,CAAC,SAAS,GAAG,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,EACzC,GAAG,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,KAAK,GAAG,CAAC,OAAO,CAAC,GAAG,MAAM,EACzC,KAAK,EAAE,CAAC,GACN,cAAc,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC,CAM7C;IAED;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,EAAE,GAAG,CAAC,OAAO,CAAA;KAAE,eAEhD;CACD;AAED,eAAO,MAAQ,GAAG,kBAAE,QAAQ,qBAAQ,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/jsx/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,KAAK,EAAW,MAAM,oBAAoB,CAAC;AACzD,OAAO,KAAK,EAAE,iBAAiB,IAAI,EAAE,EAAE,MAAM,eAAe,CAAC;AAE7D,yBAAiB,GAAG,CAAC;IACpB;;;;OAIG;IACH,KAAK,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACtC;;;;OAIG;IACH,KAAK,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAEtC,6BAA6B;IAC7B,MAAM,WAAW,iBAAkB,SAAQ,EAAE;KAAG;IAEhD,kBAAkB;IAClB,MAAM,MAAM,OAAO,GAAG,aAAa,CAClC,YAAY,CACT,MAAM,GACN,MAAM,GACN,MAAM,GACN,OAAO,GACP,MAAM,GACN,IAAI,GACJ,SAAS,GACT,MAAM,GACN,QAAQ,CAAC,OAAO,CAAC,GACjB,aAAa,CAAC,OAAO,CAAC,CACxB,CACD,CAAC;IAEF,8BAA8B;IAC9B,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IAEhD;;;;OAIG;IACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,GAAG,KAAK,OAAO,CAAC,CAAC;;CAC7D;AAED,cAAc;AACd,qBAAa,GAAG;IACf;;;;;;;;OAQG;IACH,MAAM,CAAC,GAAG,CAAC,CAAC,SAAS,GAAG,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,EACzC,GAAG,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,KAAK,GAAG,CAAC,OAAO,CAAC,GAAG,MAAM,EACzC,KAAK,EAAE,CAAC,GACN,cAAc,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC,CAMtC;IAED;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,EAAE,GAAG,CAAC,OAAO,CAAA;KAAE,eAEhD;CACD;AAED,eAAO,MAAQ,GAAG,kBAAE,QAAQ,qBAAQ,CAAC"}
@@ -1,5 +1,4 @@
1
1
  import type { JSX } from "../jsx/index.js";
2
- import { type Markup } from "../markup/index.js";
3
2
  /** Internal protocol for the MCP endpoint, to write a form as its tool's call. */
4
3
  export declare const tools: unique symbol;
5
4
  export declare namespace Markdown {
@@ -30,16 +29,22 @@ export declare namespace Markdown {
30
29
  }
31
30
  /**
32
31
  * Renders an element to Markdown, as an `AsyncIterable` of blocks, a stream,
33
- * or a string, from the same elements `Markup` renders. Each top level block is
32
+ * or a string, from the same elements `Markup` renders. Made with
33
+ * `Render.markdown`. 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 Markdown.string(<Post post={post} />, { base: url });
38
+ * const markdown = await Render.markdown(<Post post={post} />, { base: url }).string();
39
39
  * ```
40
40
  */
41
41
  export declare class Markdown {
42
42
  #private;
43
+ /**
44
+ * @param text Plain text
45
+ * @returns The text escaped, to write in Markdown as it is
46
+ */
47
+ static escape(text: string): string;
43
48
  /**
44
49
  * Creates an `AsyncIterable` that renders the element to Markdown.
45
50
  *
@@ -49,33 +54,13 @@ export declare class Markdown {
49
54
  constructor(element: JSX.Element, options?: Markdown.Options);
50
55
  /** @yields Markdown as each block completes */
51
56
  [Symbol.asyncIterator](): AsyncGenerator<string, void, unknown>;
57
+ /** @returns `ReadableStream` of Markdown */
58
+ stream(): ReadableStream<Uint8Array<ArrayBufferLike>>;
52
59
  /**
53
- * @param element Element to render
54
- * @param options Markdown options
55
- * @returns `ReadableStream` of Markdown
56
- */
57
- static stream(element: JSX.Element, options?: Markdown.Options): ReadableStream<Uint8Array<ArrayBufferLike>>;
58
- /**
59
- * Converts a render into a fully concatenated string of Markdown.
60
+ * The whole render as one string.
60
61
  *
61
- * @param element Element to render
62
- * @param options Markdown options
63
62
  * @returns Concatenated Markdown
64
63
  */
65
- static string(element: JSX.Element, options?: Markdown.Options): Promise<string>;
66
- /**
67
- * Markdown source with the HTML it renders to, such as steps written in
68
- * Markdown. Pages show the HTML, and agents reading the page as Markdown
69
- * get the source. Neither is escaped, so both must be safe.
70
- *
71
- * ```tsx
72
- * <section>{Markdown.raw(recipe.steps, render(recipe.steps))}</section>
73
- * ```
74
- *
75
- * @param markdown Markdown source
76
- * @param html Safe HTML it renders to
77
- * @returns New _safe_ chunk
78
- */
79
- static raw(markdown: unknown, html: unknown): Markup.Chunk;
64
+ string(): Promise<string>;
80
65
  }
81
66
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/markdown/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAEN,KAAK,MAAM,EAKX,MAAM,oBAAoB,CAAC;AAyC5B,kFAAkF;AAClF,eAAO,MAAM,KAAK,eAAkB,CAAC;AAErC,yBAAiB,QAAQ,CAAC;IACzB,kCAAkC;IAClC,KAAY,OAAO,GAAG;QACrB,wEAAwE;QACxE,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS,CAAC;QAEzC;;;;;;;;;;;;WAYG;QACH,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,EACd,CAAC,CACD,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,GAAG,KAET;YACA,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAC7B,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;YAC7B,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;SAC1B,GACD,SAAS,CAAC,GACZ,SAAS,CAAC;KACb,CAAC;CACF;AA41CD;;;;;;;;;GASG;AACH,qBAAa,QAAQ;;IAOpB;;;;;OAKG;IACH,YAAY,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,OAAO,EAG3D;IAED,+CAA+C;IACxC,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAWrE;IAED;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,OAAO,+CAE7D;IAED;;;;;;OAMG;IACH,OAAa,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,OAAO,mBAcnE;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC,KAAK,CAEzD;CACD"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/markdown/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAiD3C,kFAAkF;AAClF,eAAO,MAAM,KAAK,eAAkB,CAAC;AAErC,yBAAiB,QAAQ,CAAC;IACzB,kCAAkC;IAClC,KAAY,OAAO,GAAG;QACrB,wEAAwE;QACxE,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS,CAAC;QAEzC;;;;;;;;;;;;WAYG;QACH,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,EACd,CAAC,CACD,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,GAAG,KAET;YACA,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAC7B,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;YAC7B,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;SAC1B,GACD,SAAS,CAAC,GACZ,SAAS,CAAC;KACb,CAAC;CACF;AAg3CD;;;;;;;;;;GAUG;AACH,qBAAa,QAAQ;;IACpB;;;OAGG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,UAEzB;IAQD;;;;;OAKG;IACH,YAAY,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,OAAO,EAG3D;IAED,+CAA+C;IACxC,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAWrE;IAED,4CAA4C;IAC5C,MAAM,gDAEL;IAED;;;;OAIG;IACG,MAAM,oBAcX;CACD"}
@@ -1,4 +1,4 @@
1
- import { Group, Render, Source, Tag, readable, } from "../markup/index.js";
1
+ import { Group, Renderer, Source, Tag, readable, } from "../markup/index.js";
2
2
  /** Internal protocol for the MCP endpoint, to write a form as its tool's call. */
3
3
  export const tools = Symbol("tools");
4
4
  /** Writes Markdown from rendered chunks, one block at a time */
@@ -162,8 +162,8 @@ class Writer {
162
162
  parent.children.push(text);
163
163
  }
164
164
  /**
165
- * Raw HTML, such as from `Markup.raw`, is valid Markdown, so it is
166
- * written as it is, as is Markdown source from `Markdown.raw`.
165
+ * Raw HTML, such as from `Render.raw`, is valid Markdown, so it is
166
+ * written as it is, as is the Markdown it is given with.
167
167
  *
168
168
  * @param html HTML, or Markdown source
169
169
  * @param source The text is Markdown source that is its own block
@@ -329,15 +329,33 @@ class Writer {
329
329
  #paragraph(children) {
330
330
  return this.#inline(children)
331
331
  .split("\n")
332
- .map((line) => line
333
- .trim()
334
- // a quote needs no space after it, and a line of `=` makes a heading of the one above
335
- .replace(/^(>|=+$|(?:[#+-]|-{2,})(?=\s|$))/, "\\$1")
336
- // the escape goes before the delimiter, one before a digit is text
337
- .replace(/^(\d+)([.)])(?=\s|$)/, "$1\\$2"))
332
+ .map((line) => Writer.#lead(line.trim()))
338
333
  .join("\n")
339
334
  .trim();
340
335
  }
336
+ /**
337
+ * @param line A line of text
338
+ * @returns The line with what would start a block escaped, such as a
339
+ * heading, a quote, or a list
340
+ */
341
+ static #lead(line) {
342
+ return (line
343
+ // a quote needs no space after it, and a line of `=` makes a heading of the one above
344
+ .replace(/^(\s*)(>|=+$|(?:[#+-]|-{2,})(?=\s|$))/, "$1\\$2")
345
+ // the escape goes before the delimiter, one before a digit is text
346
+ .replace(/^(\s*\d+)([.)])(?=\s|$)/, "$1\\$2"));
347
+ }
348
+ /**
349
+ * @param text Plain text, of one line or several
350
+ * @returns The text as Markdown that reads as the same text: its syntax
351
+ * characters escaped, and what would start a block on each line
352
+ */
353
+ static escape(text) {
354
+ return text
355
+ .split("\n")
356
+ .map((line) => Writer.#lead(Writer.#escape(line)))
357
+ .join("\n");
358
+ }
341
359
  /**
342
360
  * @param node Block element
343
361
  * @returns Markdown
@@ -1240,7 +1258,7 @@ class Blocks {
1240
1258
  * @param options Markdown options
1241
1259
  */
1242
1260
  constructor(element, options) {
1243
- this.#render = new Render(element, undefined);
1261
+ this.#render = new Renderer(element, undefined);
1244
1262
  this.#writer = new Writer(options);
1245
1263
  }
1246
1264
  /**
@@ -1268,15 +1286,23 @@ class Blocks {
1268
1286
  }
1269
1287
  /**
1270
1288
  * Renders an element to Markdown, as an `AsyncIterable` of blocks, a stream,
1271
- * or a string, from the same elements `Markup` renders. Each top level block is
1289
+ * or a string, from the same elements `Markup` renders. Made with
1290
+ * `Render.markdown`. Each top level block is
1272
1291
  * written as soon as it closes, and when the page has a `<main>` element, only
1273
1292
  * its contents are kept. Raw HTML is written as it is.
1274
1293
  *
1275
1294
  * ```tsx
1276
- * const markdown = await Markdown.string(<Post post={post} />, { base: url });
1295
+ * const markdown = await Render.markdown(<Post post={post} />, { base: url }).string();
1277
1296
  * ```
1278
1297
  */
1279
1298
  export class Markdown {
1299
+ /**
1300
+ * @param text Plain text
1301
+ * @returns The text escaped, to write in Markdown as it is
1302
+ */
1303
+ static escape(text) {
1304
+ return Writer.escape(text);
1305
+ }
1280
1306
  /** Element to render */
1281
1307
  #element;
1282
1308
  /** Markdown options */
@@ -1306,23 +1332,17 @@ export class Markdown {
1306
1332
  await blocks.close();
1307
1333
  }
1308
1334
  }
1309
- /**
1310
- * @param element Element to render
1311
- * @param options Markdown options
1312
- * @returns `ReadableStream` of Markdown
1313
- */
1314
- static stream(element, options) {
1315
- return readable(new Blocks(element, options));
1335
+ /** @returns `ReadableStream` of Markdown */
1336
+ stream() {
1337
+ return readable(new Blocks(this.#element, this.#options));
1316
1338
  }
1317
1339
  /**
1318
- * Converts a render into a fully concatenated string of Markdown.
1340
+ * The whole render as one string.
1319
1341
  *
1320
- * @param element Element to render
1321
- * @param options Markdown options
1322
1342
  * @returns Concatenated Markdown
1323
1343
  */
1324
- static async string(element, options) {
1325
- const blocks = new Blocks(element, options);
1344
+ async string() {
1345
+ const blocks = new Blocks(this.#element, this.#options);
1326
1346
  let markdown = "";
1327
1347
  try {
1328
1348
  for (let result; (result = blocks.step());) {
@@ -1337,20 +1357,4 @@ export class Markdown {
1337
1357
  }
1338
1358
  return markdown;
1339
1359
  }
1340
- /**
1341
- * Markdown source with the HTML it renders to, such as steps written in
1342
- * Markdown. Pages show the HTML, and agents reading the page as Markdown
1343
- * get the source. Neither is escaped, so both must be safe.
1344
- *
1345
- * ```tsx
1346
- * <section>{Markdown.raw(recipe.steps, render(recipe.steps))}</section>
1347
- * ```
1348
- *
1349
- * @param markdown Markdown source
1350
- * @param html Safe HTML it renders to
1351
- * @returns New _safe_ chunk
1352
- */
1353
- static raw(markdown, html) {
1354
- return new Source(markdown, html);
1355
- }
1356
1360
  }
@@ -1,6 +1,6 @@
1
1
  import type { JSX } from "../jsx/index.js";
2
2
  /** Chunk of a rendered element: text, or markup */
3
- declare class Chunk {
3
+ export declare class Chunk {
4
4
  /** Text, or markup when `raw` */
5
5
  readonly value: string;
6
6
  /** `true` if the value is markup, which is not escaped */
@@ -38,7 +38,7 @@ export declare class Tag extends Chunk {
38
38
  toString(): string;
39
39
  }
40
40
  /**
41
- * Markup with its Markdown source, from `Markdown.raw`, internal to ovr. It
41
+ * Markup with the Markdown agents get in its place, from `Render.raw`, internal to ovr. It
42
42
  * is written as its markup, and as its source in Markdown.
43
43
  */
44
44
  export declare class Source extends Chunk {
@@ -95,7 +95,7 @@ export type Step = Chunk | Promise<unknown> | undefined;
95
95
  * synchronous unless the element has to be waited for, so nested elements cost
96
96
  * a loop instead of a generator and a promise for each chunk at every level.
97
97
  */
98
- export declare class Render {
98
+ export declare class Renderer {
99
99
  #private;
100
100
  /** Chunks rendered before the element is its parent's current child */
101
101
  queue: Chunk[] | undefined;
@@ -129,22 +129,17 @@ export declare const readable: (render: {
129
129
  step(): Chunk | string | Promise<unknown> | undefined;
130
130
  close(): Promise<unknown>;
131
131
  }) => ReadableStream<Uint8Array<ArrayBufferLike>>;
132
- /** The class `Markup.Chunk` is named for */
133
- type ChunkClass = Chunk;
134
132
  export declare namespace Markup {
135
133
  /** Markup options */
136
134
  type Options = {
137
135
  /** Set to `true` to disable escaping, for content that is not markup */
138
136
  raw?: boolean;
139
137
  };
140
- /** Rendered `Chunk` instance, an interface so declaration files name it */
141
- interface Chunk extends ChunkClass {
142
- }
143
138
  }
144
139
  /**
145
140
  * Renders an element to markup, such as HTML, SVG, or XML, as an
146
141
  * `AsyncIterable` of strings, a stream, or a string. `Markdown` renders the
147
- * same elements to Markdown.
142
+ * same elements to Markdown. Made with `Render.markup`.
148
143
  */
149
144
  export declare class Markup {
150
145
  #private;
@@ -160,34 +155,22 @@ export declare class Markup {
160
155
  /** @yields Markup as the `Element` resolves */
161
156
  [Symbol.asyncIterator](): AsyncGenerator<string, void, unknown>;
162
157
  /**
163
- * `render` piped into a `ReadableStream`.
164
- * Use `render` when possible to avoid the overhead of the stream.
158
+ * The render piped into a `ReadableStream`. Iterate it when possible, to
159
+ * avoid the overhead of the stream.
165
160
  *
166
- * @param element Element to render
167
- * @param options Markup options
168
161
  * @returns `ReadableStream` of markup
169
162
  */
170
- static stream(element: JSX.Element, options?: Markup.Options): ReadableStream<Uint8Array<ArrayBufferLike>>;
163
+ stream(): ReadableStream<Uint8Array<ArrayBufferLike>>;
171
164
  /**
172
- * Converts a render into a fully concatenated string of markup.
165
+ * The whole render as one string.
173
166
  *
174
167
  * ### WARNING
175
168
  *
176
169
  * This negates streaming benefits and buffers the result into a string.
177
170
  *
178
- * @param element Element to render
179
- * @param options Markup options
180
171
  * @returns Concatenated markup
181
172
  */
182
- static string(element: JSX.Element, options?: Markup.Options): Promise<string>;
183
- /**
184
- * Render raw markup and dangerously bypass escaping. It is written as it is
185
- * in Markdown too, which can contain HTML.
186
- *
187
- * @param html Safe markup to render
188
- * @returns New _safe_ `Chunk`
189
- */
190
- static raw(html: unknown): Markup.Chunk;
173
+ string(): Promise<string>;
191
174
  /**
192
175
  * Escapes text for markup.
193
176
  *
@@ -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,cAAM,KAAK;IACV,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,MAAM;;IAClB,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,4CAA4C;AAC5C,KAAK,UAAU,GAAG,KAAK,CAAC;AAExB,yBAAiB,MAAM,CAAC;IACvB,qBAAqB;IACrB,KAAY,OAAO,GAAG;QACrB,wEAAwE;QACxE,GAAG,CAAC,EAAE,OAAO,CAAC;KACd,CAAC;IAEF,2EAA2E;IAC3E,UAAiB,KAAM,SAAQ,UAAU;KAAG;CAC5C;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;;;;;;;OAOG;IACH,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,OAAO,+CAE3D;IAED;;;;;;;;;;OAUG;IACH,OAAa,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,OAAO,mBAejE;IAED;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC,KAAK,CAEtC;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,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,6 +1,6 @@
1
1
  import { Codec, Size } from "../util/index.js";
2
2
  /** Chunk of a rendered element: text, or markup */
3
- class Chunk {
3
+ export class Chunk {
4
4
  /** Text, or markup when `raw` */
5
5
  value;
6
6
  /** `true` if the value is markup, which is not escaped */
@@ -76,7 +76,7 @@ export class Tag extends Chunk {
76
76
  }
77
77
  }
78
78
  /**
79
- * Markup with its Markdown source, from `Markdown.raw`, internal to ovr. It
79
+ * Markup with the Markdown agents get in its place, from `Render.raw`, internal to ovr. It
80
80
  * is written as its markup, and as its source in Markdown.
81
81
  */
82
82
  export class Source extends Chunk {
@@ -166,7 +166,7 @@ export class Element {
166
166
  */
167
167
  get #generator() {
168
168
  return (this.#chunks ??= (async function* (element) {
169
- const render = new Render(element, undefined);
169
+ const render = new Renderer(element, undefined);
170
170
  try {
171
171
  for (let result; (result = render.step());) {
172
172
  if (result instanceof Chunk)
@@ -204,7 +204,7 @@ const source = Symbol("source");
204
204
  * synchronous unless the element has to be waited for, so nested elements cost
205
205
  * a loop instead of a generator and a promise for each chunk at every level.
206
206
  */
207
- export class Render {
207
+ export class Renderer {
208
208
  /** Chunks rendered before the element is its parent's current child */
209
209
  queue;
210
210
  /** Waiting, set by the parent of a child */
@@ -410,7 +410,7 @@ class Parallel {
410
410
  this.#children = [];
411
411
  // each child starts before any is waited for
412
412
  for (const element of elements) {
413
- const child = new Render(element, raw);
413
+ const child = new Renderer(element, raw);
414
414
  const chunk = this.#advance(child);
415
415
  if (chunk)
416
416
  child.queue = [chunk];
@@ -628,7 +628,7 @@ export const readable = (render) => {
628
628
  /**
629
629
  * Renders an element to markup, such as HTML, SVG, or XML, as an
630
630
  * `AsyncIterable` of strings, a stream, or a string. `Markdown` renders the
631
- * same elements to Markdown.
631
+ * same elements to Markdown. Made with `Render.markup`.
632
632
  */
633
633
  export class Markup {
634
634
  /** Regex to find escape character for attributes */
@@ -657,7 +657,7 @@ export class Markup {
657
657
  }
658
658
  /** @yields Markup as the `Element` resolves */
659
659
  async *[Symbol.asyncIterator]() {
660
- const render = new Render(this.#element, this.#options?.raw);
660
+ const render = new Renderer(this.#element, this.#options?.raw);
661
661
  try {
662
662
  for (let result; (result = render.step());) {
663
663
  if (result instanceof Chunk)
@@ -671,29 +671,25 @@ export class Markup {
671
671
  }
672
672
  }
673
673
  /**
674
- * `render` piped into a `ReadableStream`.
675
- * Use `render` when possible to avoid the overhead of the stream.
674
+ * The render piped into a `ReadableStream`. Iterate it when possible, to
675
+ * avoid the overhead of the stream.
676
676
  *
677
- * @param element Element to render
678
- * @param options Markup options
679
677
  * @returns `ReadableStream` of markup
680
678
  */
681
- static stream(element, options) {
682
- return readable(new Render(element, options?.raw));
679
+ stream() {
680
+ return readable(new Renderer(this.#element, this.#options?.raw));
683
681
  }
684
682
  /**
685
- * Converts a render into a fully concatenated string of markup.
683
+ * The whole render as one string.
686
684
  *
687
685
  * ### WARNING
688
686
  *
689
687
  * This negates streaming benefits and buffers the result into a string.
690
688
  *
691
- * @param element Element to render
692
- * @param options Markup options
693
689
  * @returns Concatenated markup
694
690
  */
695
- static async string(element, options) {
696
- const render = new Render(element, options?.raw);
691
+ async string() {
692
+ const render = new Renderer(this.#element, this.#options?.raw);
697
693
  const chunks = [];
698
694
  try {
699
695
  for (let result; (result = render.step());) {
@@ -709,16 +705,6 @@ export class Markup {
709
705
  // written once every chunk is rendered, as a group of them is
710
706
  return new Group(chunks).toString();
711
707
  }
712
- /**
713
- * Render raw markup and dangerously bypass escaping. It is written as it is
714
- * in Markdown too, which can contain HTML.
715
- *
716
- * @param html Safe markup to render
717
- * @returns New _safe_ `Chunk`
718
- */
719
- static raw(html) {
720
- return new Chunk(html, true);
721
- }
722
708
  /**
723
709
  * Escapes text for markup.
724
710
  *