@thxgg/steward 0.1.5 → 0.1.7

package/.output/server/node_modules/hast-util-to-html/lib/handle/element.js

@@ -0,0 +1,265 @@
+/**
+ * @import {Element, Parents, Properties} from 'hast'
+ * @import {State} from '../index.js'
+ */
+
+import {ccount} from 'ccount'
+import {stringify as commas} from 'comma-separated-tokens'
+import {find, svg} from 'property-information'
+import {stringify as spaces} from 'space-separated-tokens'
+import {stringifyEntities} from 'stringify-entities'
+import {closing} from '../omission/closing.js'
+import {opening} from '../omission/opening.js'
+
+/**
+ * Maps of subsets.
+ *
+ * Each value is a matrix of tuples.
+ * The value at `0` causes parse errors, the value at `1` is valid.
+ * Of both, the value at `0` is unsafe, and the value at `1` is safe.
+ *
+ * @type {Record<'double' | 'name' | 'single' | 'unquoted', Array<[Array<string>, Array<string>]>>}
+ */
+const constants = {
+  // See: <https://html.spec.whatwg.org/#attribute-name-state>.
+  name: [
+    ['\t\n\f\r &/=>'.split(''), '\t\n\f\r "&\'/=>`'.split('')],
+    ['\0\t\n\f\r "&\'/<=>'.split(''), '\0\t\n\f\r "&\'/<=>`'.split('')]
+  ],
+  // See: <https://html.spec.whatwg.org/#attribute-value-(unquoted)-state>.
+  unquoted: [
+    ['\t\n\f\r &>'.split(''), '\0\t\n\f\r "&\'<=>`'.split('')],
+    ['\0\t\n\f\r "&\'<=>`'.split(''), '\0\t\n\f\r "&\'<=>`'.split('')]
+  ],
+  // See: <https://html.spec.whatwg.org/#attribute-value-(single-quoted)-state>.
+  single: [
+    ["&'".split(''), '"&\'`'.split('')],
+    ["\0&'".split(''), '\0"&\'`'.split('')]
+  ],
+  // See: <https://html.spec.whatwg.org/#attribute-value-(double-quoted)-state>.
+  double: [
+    ['"&'.split(''), '"&\'`'.split('')],
+    ['\0"&'.split(''), '\0"&\'`'.split('')]
+  ]
+}
+
+/**
+ * Serialize an element node.
+ *
+ * @param {Element} node
+ *   Node to handle.
+ * @param {number | undefined} index
+ *   Index of `node` in `parent.
+ * @param {Parents | undefined} parent
+ *   Parent of `node`.
+ * @param {State} state
+ *   Info passed around about the current state.
+ * @returns {string}
+ *   Serialized node.
+ */
+export function element(node, index, parent, state) {
+  const schema = state.schema
+  const omit = schema.space === 'svg' ? false : state.settings.omitOptionalTags
+  let selfClosing =
+    schema.space === 'svg'
+      ? state.settings.closeEmptyElements
+      : state.settings.voids.includes(node.tagName.toLowerCase())
+  /** @type {Array<string>} */
+  const parts = []
+  /** @type {string} */
+  let last
+
+  if (schema.space === 'html' && node.tagName === 'svg') {
+    state.schema = svg
+  }
+
+  const attributes = serializeAttributes(state, node.properties)
+
+  const content = state.all(
+    schema.space === 'html' && node.tagName === 'template' ? node.content : node
+  )
+
+  state.schema = schema
+
+  // If the node is categorised as void, but it has children, remove the
+  // categorisation.
+  // This enables for example `menuitem`s, which are void in W3C HTML but not
+  // void in WHATWG HTML, to be stringified properly.
+  // Note: `menuitem` has since been removed from the HTML spec, and so is no
+  // longer void.
+  if (content) selfClosing = false
+
+  if (attributes || !omit || !opening(node, index, parent)) {
+    parts.push('<', node.tagName, attributes ? ' ' + attributes : '')
+
+    if (
+      selfClosing &&
+      (schema.space === 'svg' || state.settings.closeSelfClosing)
+    ) {
+      last = attributes.charAt(attributes.length - 1)
+      if (
+        !state.settings.tightSelfClosing ||
+        last === '/' ||
+        (last && last !== '"' && last !== "'")
+      ) {
+        parts.push(' ')
+      }
+
+      parts.push('/')
+    }
+
+    parts.push('>')
+  }
+
+  parts.push(content)
+
+  if (!selfClosing && (!omit || !closing(node, index, parent))) {
+    parts.push('</' + node.tagName + '>')
+  }
+
+  return parts.join('')
+}
+
+/**
+ * @param {State} state
+ * @param {Properties | null | undefined} properties
+ * @returns {string}
+ */
+function serializeAttributes(state, properties) {
+  /** @type {Array<string>} */
+  const values = []
+  let index = -1
+  /** @type {string} */
+  let key
+
+  if (properties) {
+    for (key in properties) {
+      if (properties[key] !== null && properties[key] !== undefined) {
+        const value = serializeAttribute(state, key, properties[key])
+        if (value) values.push(value)
+      }
+    }
+  }
+
+  while (++index < values.length) {
+    const last = state.settings.tightAttributes
+      ? values[index].charAt(values[index].length - 1)
+      : undefined
+
+    // In tight mode, don’t add a space after quoted attributes.
+    if (index !== values.length - 1 && last !== '"' && last !== "'") {
+      values[index] += ' '
+    }
+  }
+
+  return values.join('')
+}
+
+/**
+ * @param {State} state
+ * @param {string} key
+ * @param {Properties[keyof Properties]} value
+ * @returns {string}
+ */
+function serializeAttribute(state, key, value) {
+  const info = find(state.schema, key)
+  const x =
+    state.settings.allowParseErrors && state.schema.space === 'html' ? 0 : 1
+  const y = state.settings.allowDangerousCharacters ? 0 : 1
+  let quote = state.quote
+  /** @type {string | undefined} */
+  let result
+
+  if (info.overloadedBoolean && (value === info.attribute || value === '')) {
+    value = true
+  } else if (
+    (info.boolean || info.overloadedBoolean) &&
+    (typeof value !== 'string' || value === info.attribute || value === '')
+  ) {
+    value = Boolean(value)
+  }
+
+  if (
+    value === null ||
+    value === undefined ||
+    value === false ||
+    (typeof value === 'number' && Number.isNaN(value))
+  ) {
+    return ''
+  }
+
+  const name = stringifyEntities(
+    info.attribute,
+    Object.assign({}, state.settings.characterReferences, {
+      // Always encode without parse errors in non-HTML.
+      subset: constants.name[x][y]
+    })
+  )
+
+  // No value.
+  // There is currently only one boolean property in SVG: `[download]` on
+  // `<a>`.
+  // This property does not seem to work in browsers (Firefox, Safari, Chrome),
+  // so I can’t test if dropping the value works.
+  // But I assume that it should:
+  //
+  // ```html
+  // <!doctype html>
+  // <svg viewBox="0 0 100 100">
+  //   <a href=https://example.com download>
+  //     <circle cx=50 cy=40 r=35 />
+  //   </a>
+  // </svg>
+  // ```
+  //
+  // See: <https://github.com/wooorm/property-information/blob/main/lib/svg.js>
+  if (value === true) return name
+
+  // `spaces` doesn’t accept a second argument, but it’s given here just to
+  // keep the code cleaner.
+  value = Array.isArray(value)
+    ? (info.commaSeparated ? commas : spaces)(value, {
+        padLeft: !state.settings.tightCommaSeparatedLists
+      })
+    : String(value)
+
+  if (state.settings.collapseEmptyAttributes && !value) return name
+
+  // Check unquoted value.
+  if (state.settings.preferUnquoted) {
+    result = stringifyEntities(
+      value,
+      Object.assign({}, state.settings.characterReferences, {
+        attribute: true,
+        subset: constants.unquoted[x][y]
+      })
+    )
+  }
+
+  // If we don’t want unquoted, or if `value` contains character references when
+  // unquoted…
+  if (result !== value) {
+    // If the alternative is less common than `quote`, switch.
+    if (
+      state.settings.quoteSmart &&
+      ccount(value, quote) > ccount(value, state.alternative)
+    ) {
+      quote = state.alternative
+    }
+
+    result =
+      quote +
+      stringifyEntities(
+        value,
+        Object.assign({}, state.settings.characterReferences, {
+          // Always encode without parse errors in non-HTML.
+          subset: (quote === "'" ? constants.single : constants.double)[x][y],
+          attribute: true
+        })
+      ) +
+      quote
+  }
+
+  // Don’t add a `=` for unquoted empties.
+  return name + (result ? '=' + result : result)
+}

package/.output/server/node_modules/hast-util-to-html/lib/handle/index.js

@@ -0,0 +1,47 @@
+/**
+ * @import {Nodes, Parents} from 'hast'
+ * @import {State} from '../index.js'
+ */
+
+import {zwitch} from 'zwitch'
+import {comment} from './comment.js'
+import {doctype} from './doctype.js'
+import {element} from './element.js'
+import {raw} from './raw.js'
+import {root} from './root.js'
+import {text} from './text.js'
+
+/**
+ * @type {(node: Nodes, index: number | undefined, parent: Parents | undefined, state: State) => string}
+ */
+export const handle = zwitch('type', {
+  invalid,
+  unknown,
+  handlers: {comment, doctype, element, raw, root, text}
+})
+
+/**
+ * Fail when a non-node is found in the tree.
+ *
+ * @param {unknown} node
+ *   Unknown value.
+ * @returns {never}
+ *   Never.
+ */
+function invalid(node) {
+  throw new Error('Expected node, not `' + node + '`')
+}
+
+/**
+ * Fail when a node with an unknown type is found in the tree.
+ *
+ * @param {unknown} node_
+ *  Unknown node.
+ * @returns {never}
+ *   Never.
+ */
+function unknown(node_) {
+  // `type` is guaranteed by runtime JS.
+  const node = /** @type {Nodes} */ (node_)
+  throw new Error('Cannot compile unknown node `' + node.type + '`')
+}

package/.output/server/node_modules/hast-util-to-html/lib/handle/raw.js

@@ -0,0 +1,27 @@
+/**
+ * @import {Parents} from 'hast'
+ * @import {Raw} from 'mdast-util-to-hast'
+ * @import {State} from '../index.js'
+ */
+
+import {text} from './text.js'
+
+/**
+ * Serialize a raw node.
+ *
+ * @param {Raw} node
+ *   Node to handle.
+ * @param {number | undefined} index
+ *   Index of `node` in `parent.
+ * @param {Parents | undefined} parent
+ *   Parent of `node`.
+ * @param {State} state
+ *   Info passed around about the current state.
+ * @returns {string}
+ *   Serialized node.
+ */
+export function raw(node, index, parent, state) {
+  return state.settings.allowDangerousHtml
+    ? node.value
+    : text(node, index, parent, state)
+}

package/.output/server/node_modules/hast-util-to-html/lib/handle/root.js

@@ -0,0 +1,22 @@
+/**
+ * @import {Parents, Root} from 'hast'
+ * @import {State} from '../index.js'
+ */
+
+/**
+ * Serialize a root.
+ *
+ * @param {Root} node
+ *   Node to handle.
+ * @param {number | undefined} _1
+ *   Index of `node` in `parent.
+ * @param {Parents | undefined} _2
+ *   Parent of `node`.
+ * @param {State} state
+ *   Info passed around about the current state.
+ * @returns {string}
+ *   Serialized node.
+ */
+export function root(node, _1, _2, state) {
+  return state.all(node)
+}

package/.output/server/node_modules/hast-util-to-html/lib/handle/text.js

@@ -0,0 +1,38 @@
+/**
+ * @import {Parents, Text} from 'hast'
+ * @import {Raw} from 'mdast-util-to-hast'
+ * @import {State} from '../index.js'
+ */
+
+import {stringifyEntities} from 'stringify-entities'
+
+// Declare array as variable so it can be cached by `stringifyEntities`
+const textEntitySubset = ['<', '&']
+
+/**
+ * Serialize a text node.
+ *
+ * @param {Raw | Text} node
+ *   Node to handle.
+ * @param {number | undefined} _
+ *   Index of `node` in `parent.
+ * @param {Parents | undefined} parent
+ *   Parent of `node`.
+ * @param {State} state
+ *   Info passed around about the current state.
+ * @returns {string}
+ *   Serialized node.
+ */
+export function text(node, _, parent, state) {
+  // Check if content of `node` should be escaped.
+  return parent &&
+    parent.type === 'element' &&
+    (parent.tagName === 'script' || parent.tagName === 'style')
+    ? node.value
+    : stringifyEntities(
+        node.value,
+        Object.assign({}, state.settings.characterReferences, {
+          subset: textEntitySubset
+        })
+      )
+}

package/.output/server/node_modules/hast-util-to-html/lib/index.js

@@ -0,0 +1,257 @@
+/**
+ * @import {Nodes, Parents, RootContent} from 'hast'
+ * @import {Schema} from 'property-information'
+ * @import {Options as StringifyEntitiesOptions} from 'stringify-entities'
+ */
+
+/**
+ * @typedef {Omit<StringifyEntitiesOptions, 'attribute' | 'escapeOnly' | 'subset'>} CharacterReferences
+ *
+ * @typedef Options
+ *   Configuration.
+ * @property {boolean | null | undefined} [allowDangerousCharacters=false]
+ *   Do not encode some characters which cause XSS vulnerabilities in older
+ *   browsers (default: `false`).
+ *
+ *   > ⚠️ **Danger**: only set this if you completely trust the content.
+ * @property {boolean | null | undefined} [allowDangerousHtml=false]
+ *   Allow `raw` nodes and insert them as raw HTML (default: `false`).
+ *
+ *   When `false`, `Raw` nodes are encoded.
+ *
+ *   > ⚠️ **Danger**: only set this if you completely trust the content.
+ * @property {boolean | null | undefined} [allowParseErrors=false]
+ *   Do not encode characters which cause parse errors (even though they work),
+ *   to save bytes (default: `false`).
+ *
+ *   Not used in the SVG space.
+ *
+ *   > 👉 **Note**: intentionally creates parse errors in markup (how parse
+ *   > errors are handled is well defined, so this works but isn’t pretty).
+ * @property {boolean | null | undefined} [bogusComments=false]
+ *   Use “bogus comments” instead of comments to save byes: `<?charlie>`
+ *   instead of `<!--charlie-->` (default: `false`).
+ *
+ *   > 👉 **Note**: intentionally creates parse errors in markup (how parse
+ *   > errors are handled is well defined, so this works but isn’t pretty).
+ * @property {CharacterReferences | null | undefined} [characterReferences]
+ *   Configure how to serialize character references (optional).
+ * @property {boolean | null | undefined} [closeEmptyElements=false]
+ *   Close SVG elements without any content with slash (`/`) on the opening tag
+ *   instead of an end tag: `<circle />` instead of `<circle></circle>`
+ *   (default: `false`).
+ *
+ *   See `tightSelfClosing` to control whether a space is used before the
+ *   slash.
+ *
+ *   Not used in the HTML space.
+ * @property {boolean | null | undefined} [closeSelfClosing=false]
+ *   Close self-closing nodes with an extra slash (`/`): `<img />` instead of
+ *   `<img>` (default: `false`).
+ *
+ *   See `tightSelfClosing` to control whether a space is used before the
+ *   slash.
+ *
+ *   Not used in the SVG space.
+ * @property {boolean | null | undefined} [collapseEmptyAttributes=false]
+ *   Collapse empty attributes: get `class` instead of `class=""` (default:
+ *   `false`).
+ *
+ *   Not used in the SVG space.
+ *
+ *   > 👉 **Note**: boolean attributes (such as `hidden`) are always collapsed.
+ * @property {boolean | null | undefined} [omitOptionalTags=false]
+ *   Omit optional opening and closing tags (default: `false`).
+ *
+ *   For example, in `<ol><li>one</li><li>two</li></ol>`, both `</li>` closing
+ *   tags can be omitted.
+ *   The first because it’s followed by another `li`, the last because it’s
+ *   followed by nothing.
+ *
+ *   Not used in the SVG space.
+ * @property {boolean | null | undefined} [preferUnquoted=false]
+ *   Leave attributes unquoted if that results in less bytes (default: `false`).
+ *
+ *   Not used in the SVG space.
+ * @property {boolean | null | undefined} [quoteSmart=false]
+ *   Use the other quote if that results in less bytes (default: `false`).
+ * @property {Quote | null | undefined} [quote='"']
+ *   Preferred quote to use (default: `'"'`).
+ * @property {Space | null | undefined} [space='html']
+ *   When an `<svg>` element is found in the HTML space, this package already
+ *   automatically switches to and from the SVG space when entering and exiting
+ *   it (default: `'html'`).
+ *
+ *   > 👉 **Note**: hast is not XML.
+ *   > It supports SVG as embedded in HTML.
+ *   > It does not support the features available in XML.
+ *   > Passing SVG might break but fragments of modern SVG should be fine.
+ *   > Use [`xast`][xast] if you need to support SVG as XML.
+ * @property {boolean | null | undefined} [tightAttributes=false]
+ *   Join attributes together, without whitespace, if possible: get
+ *   `class="a b"title="c d"` instead of `class="a b" title="c d"` to save
+ *   bytes (default: `false`).
+ *
+ *   Not used in the SVG space.
+ *
+ *   > 👉 **Note**: intentionally creates parse errors in markup (how parse
+ *   > errors are handled is well defined, so this works but isn’t pretty).
+ * @property {boolean | null | undefined} [tightCommaSeparatedLists=false]
+ *   Join known comma-separated attribute values with just a comma (`,`),
+ *   instead of padding them on the right as well (`,␠`, where `␠` represents a
+ *   space) (default: `false`).
+ * @property {boolean | null | undefined} [tightDoctype=false]
+ *   Drop unneeded spaces in doctypes: `<!doctypehtml>` instead of
+ *   `<!doctype html>` to save bytes (default: `false`).
+ *
+ *   > 👉 **Note**: intentionally creates parse errors in markup (how parse
+ *   > errors are handled is well defined, so this works but isn’t pretty).
+ * @property {boolean | null | undefined} [tightSelfClosing=false]
+ *   Do not use an extra space when closing self-closing elements: `<img/>`
+ *   instead of `<img />` (default: `false`).
+ *
+ *   > 👉 **Note**: only used if `closeSelfClosing: true` or
+ *   > `closeEmptyElements: true`.
+ * @property {boolean | null | undefined} [upperDoctype=false]
+ *   Use a `<!DOCTYPE…` instead of `<!doctype…` (default: `false`).
+ *
+ *   Useless except for XHTML.
+ * @property {ReadonlyArray<string> | null | undefined} [voids]
+ *   Tag names of elements to serialize without closing tag (default: `html-void-elements`).
+ *
+ *   Not used in the SVG space.
+ *
+ *   > 👉 **Note**: It’s highly unlikely that you want to pass this, because
+ *   > hast is not for XML, and HTML will not add more void elements.
+ *
+ * @typedef {'"' | "'"} Quote
+ *   HTML quotes for attribute values.
+ *
+ * @typedef {Omit<Required<{[key in keyof Options]: Exclude<Options[key], null | undefined>}>, 'space' | 'quote'>} Settings
+ *
+ * @typedef {'html' | 'svg'} Space
+ *   Namespace.
+ *
+ * @typedef State
+ *   Info passed around about the current state.
+ * @property {(node: Parents | undefined) => string} all
+ *   Serialize the children of a parent node.
+ * @property {Quote} alternative
+ *   Alternative quote.
+ * @property {(node: Nodes, index: number | undefined, parent: Parents | undefined) => string} one
+ *   Serialize one node.
+ * @property {Quote} quote
+ *   Preferred quote.
+ * @property {Schema} schema
+ *   Current schema.
+ * @property {Settings} settings
+ *   User configuration.
+ */
+
+import {htmlVoidElements} from 'html-void-elements'
+import {html, svg} from 'property-information'
+import {handle} from './handle/index.js'
+
+/** @type {Options} */
+const emptyOptions = {}
+
+/** @type {CharacterReferences} */
+const emptyCharacterReferences = {}
+
+/** @type {Array<never>} */
+const emptyChildren = []
+
+/**
+ * Serialize hast as HTML.
+ *
+ * @param {Array<RootContent> | Nodes} tree
+ *   Tree to serialize.
+ * @param {Options | null | undefined} [options]
+ *   Configuration (optional).
+ * @returns {string}
+ *   Serialized HTML.
+ */
+export function toHtml(tree, options) {
+  const options_ = options || emptyOptions
+  const quote = options_.quote || '"'
+  const alternative = quote === '"' ? "'" : '"'
+
+  if (quote !== '"' && quote !== "'") {
+    throw new Error('Invalid quote `' + quote + '`, expected `\'` or `"`')
+  }
+
+  /** @type {State} */
+  const state = {
+    one,
+    all,
+    settings: {
+      omitOptionalTags: options_.omitOptionalTags || false,
+      allowParseErrors: options_.allowParseErrors || false,
+      allowDangerousCharacters: options_.allowDangerousCharacters || false,
+      quoteSmart: options_.quoteSmart || false,
+      preferUnquoted: options_.preferUnquoted || false,
+      tightAttributes: options_.tightAttributes || false,
+      upperDoctype: options_.upperDoctype || false,
+      tightDoctype: options_.tightDoctype || false,
+      bogusComments: options_.bogusComments || false,
+      tightCommaSeparatedLists: options_.tightCommaSeparatedLists || false,
+      tightSelfClosing: options_.tightSelfClosing || false,
+      collapseEmptyAttributes: options_.collapseEmptyAttributes || false,
+      allowDangerousHtml: options_.allowDangerousHtml || false,
+      voids: options_.voids || htmlVoidElements,
+      characterReferences:
+        options_.characterReferences || emptyCharacterReferences,
+      closeSelfClosing: options_.closeSelfClosing || false,
+      closeEmptyElements: options_.closeEmptyElements || false
+    },
+    schema: options_.space === 'svg' ? svg : html,
+    quote,
+    alternative
+  }
+
+  return state.one(
+    Array.isArray(tree) ? {type: 'root', children: tree} : tree,
+    undefined,
+    undefined
+  )
+}
+
+/**
+ * Serialize a node.
+ *
+ * @this {State}
+ *   Info passed around about the current state.
+ * @param {Nodes} node
+ *   Node to handle.
+ * @param {number | undefined} index
+ *   Index of `node` in `parent.
+ * @param {Parents | undefined} parent
+ *   Parent of `node`.
+ * @returns {string}
+ *   Serialized node.
+ */
+function one(node, index, parent) {
+  return handle(node, index, parent, this)
+}
+
+/**
+ * Serialize all children of `parent`.
+ *
+ * @this {State}
+ *   Info passed around about the current state.
+ * @param {Parents | undefined} parent
+ *   Parent whose children to serialize.
+ * @returns {string}
+ */
+export function all(parent) {
+  /** @type {Array<string>} */
+  const results = []
+  const children = (parent && parent.children) || emptyChildren
+  let index = -1
+
+  while (++index < children.length) {
+    results[index] = this.one(children[index], index, parent)
+  }
+
+  return results.join('')
+}