bruh 1.9.2-types.0 → 1.10.0

package/src/dom/index.node.mjs

@@ -1,3 +1,10 @@
+const isMetaNode      = Symbol.for("bruh meta node")
+const isMetaTextNode  = Symbol.for("bruh meta text node")
+const isMetaElement   = Symbol.for("bruh meta element")
+const isMetaRawString = Symbol.for("bruh meta raw string")
+
+//#region HTML syntax functions
+
 // https://html.spec.whatwg.org/multipage/syntax.html#void-elements
 const voidElements = [
   "base",
@@ -26,6 +33,7 @@ const isVoidElement = element =>
 
 // https://html.spec.whatwg.org/multipage/syntax.html#elements-2
 // https://html.spec.whatwg.org/multipage/syntax.html#cdata-rcdata-restrictions
+// Does not work for https://html.spec.whatwg.org/multipage/syntax.html#raw-text-elements (script and style)
 const escapeForElement = x =>
   (x + "")
     .replace(/&/g, "&")
@@ -37,14 +45,20 @@ const escapeForDoubleQuotedAttribute = x =>
     .replace(/&/g, "&")
     .replace(/"/g, """)
 
-const isMetaNode      = Symbol.for("bruh meta node")
-const isMetaTextNode  = Symbol.for("bruh meta text node")
-const isMetaElement   = Symbol.for("bruh meta element")
-const isMetaRawString = Symbol.for("bruh meta raw string")
+// https://html.spec.whatwg.org/multipage/syntax.html#attributes-2
+const attributesToString = attributes =>
+  Object.entries(attributes)
+    .map(([name, value]) =>
+      value === ""
+        ? ` ${name}`
+        : ` ${name}="${escapeForDoubleQuotedAttribute(value)}"`
+    ).join("")
+
+//#endregion
 
 // A basic check for if a value is allowed as a meta node's child
 // It's responsible for quickly checking the type, not deep validation
-const isMetaNodeChild = x =>
+const isMetaChild = x =>
   // meta nodes, reactives, and DOM nodes
   x?.[isMetaNode] ||
   x?.[isMetaRawString] ||
@@ -57,8 +71,11 @@ const isMetaNodeChild = x =>
   // Everything else can be a child when stringified
 
 
-// Meta Nodes
+//#region Meta Nodes that act like lightweight rendering-oriented DOM nodes
 
+// Text nodes have no individual HTML representation
+// We emulate this with a custom element <bruh-textnode> with an inline style reset
+// These elements can be hydrated very quickly and even be marked with a tag
 export class MetaTextNode {
   [isMetaNode]     = true;
   [isMetaTextNode] = true
@@ -71,20 +88,22 @@ export class MetaTextNode {
   }
 
   toString() {
-    return `<bruh-textnode style="all:unset;display:inline"${
-      this.tag
-        ? ` data-tag="${escapeForDoubleQuotedAttribute(this.tag)}"`
-        : ""
-    }>${ escapeForElement(this.textContent) }</bruh-textnode>`
+    const tag = this.tag
+      ? ` tag="${escapeForDoubleQuotedAttribute(this.tag)}"`
+      : ""
+    return `<bruh-textnode style="all:unset;display:inline"${tag}>${
+      escapeForElement(this.textContent)
+    }</bruh-textnode>`
   }
 
-  setTag(tag = "") {
+  setTag(tag) {
     this.tag = tag
 
     return this
   }
 }
 
+// A light model of an element
 export class MetaElement {
   [isMetaNode]    = true;
   [isMetaElement] = true
@@ -98,157 +117,160 @@ export class MetaElement {
   }
 
   toString() {
-    // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2
-    const attributes =
-      Object.entries(this.attributes)
-        .map(([name, value]) =>
-          value === ""
-            ? ` ${name}`
-            : ` ${name}="${escapeForDoubleQuotedAttribute(value)}"`
-        ).join("")
+    const attributes = attributesToString(this.attributes)
     // https://html.spec.whatwg.org/multipage/syntax.html#syntax-start-tag
     const startTag = `<${this.name}${attributes}>`
-
     if (isVoidElement(this.name))
       return startTag
 
-    const contents =
-      this.children
-        .flat(Infinity)
-        .map(child => {
-          return (child[isMetaNode] || child[isMetaRawString])
-            ? child.toString()
-            : escapeForElement(child)
-        }).join("")
+    const contents = this.children
+      .flat(Infinity)
+      .map(child =>
+        (child[isMetaNode] || child[isMetaRawString])
+          ? child.toString()
+          : escapeForElement(child)
+      )
+      .join("")
     // https://html.spec.whatwg.org/multipage/syntax.html#end-tags
     const endTag = `</${this.name}>`
     return startTag + contents + endTag
   }
-
-  addAttributes(attributes = {}) {
-    Object.assign(this.attributes, attributes)
-
-    return this
-  }
-
-  addDataAttributes(dataAttributes = {}) {
-    Object.entries(dataAttributes)
-      .forEach(([name, value]) => {
-        // https://html.spec.whatwg.org/multipage/dom.html#dom-domstringmap-setitem
-        const skewered = name.replace(/[A-Z]/g, letter => `-${letter.toLowerCase()}`)
-        this.attributes[`data-${skewered}`] = value
-      })
-
-    return this
-  }
-
-  addStyles(styles = {}) {
-    // Doesn't support proper escaping
-    // https://www.w3.org/TR/css-syntax-3/#ref-for-parse-a-list-of-declarations%E2%91%A0
-    // https://www.w3.org/TR/css-syntax-3/#typedef-ident-token
-    const currentStyles = Object.fromEntries(
-      (this.attributes.style || "")
-        .split(";").filter(s => s.length)
-        .map(declaration => declaration.split(":").map(s => s.trim()))
-    )
-
-    Object.assign(currentStyles, styles)
-
-    this.attributes.style =
-      Object.entries(currentStyles)
-        .map(([property, value]) => `${property}:${value}`)
-        .join(";")
-
-    return this
-  }
-
-  toggleClasses(classes = {}) {
-    // Doesn't support proper escaping
-    // https://html.spec.whatwg.org/multipage/dom.html#global-attributes:classes-2
-    const classList = new Set(
-      (this.attributes.class || "")
-        .split(/\s+/).filter(s => s.length)
-    )
-
-    Object.entries(classes)
-      .forEach(([name, value]) => {
-        if (value)
-          classList.add(name)
-        else
-          classList.delete(name)
-      })
-
-    this.attributes.class = Array.from(classList).join(" ")
-
-    return this
-  }
 }
 
-export class MetaRawString {
+// Raw strings can be meta element children, where they bypass string escaping
+// This should be avoided in general, but is needed for unsupported HTML features
+export class MetaRawString extends String {
   [isMetaRawString] = true
 
-  string
-
   constructor(string) {
-    this.string = string
+    super(string)
   }
+}
 
-  toString() {
-    return this.string
-  }
+//#endregion
+
+//#region Meta element helper functions e.g. applyAttributes()
+
+// Merge style rules with an object
+export const applyStyles = (element, styles) => {
+  // Doesn't support proper escaping
+  // https://www.w3.org/TR/css-syntax-3/#ref-for-parse-a-list-of-declarations%E2%91%A0
+  // https://www.w3.org/TR/css-syntax-3/#typedef-ident-token
+  const currentStyles = Object.fromEntries(
+    (element.attributes.style || "")
+      .split(";").filter(s => s.length)
+      .map(declaration => declaration.split(":").map(s => s.trim()))
+  )
+
+  Object.entries(styles)
+    .forEach(([property, value]) => {
+      if (value !== undefined)
+        currentStyles[property] = value
+      else
+        delete currentStyles[property]
+    })
+
+  element.attributes.style =
+    Object.entries(currentStyles)
+      .map(([property, value]) => `${property}:${value}`)
+      .join(";")
 }
 
+// Merge classes with an object mapping from class names to booleans
+export const applyClasses = (element, classes) => {
+  // Doesn't support proper escaping
+  // https://html.spec.whatwg.org/multipage/dom.html#global-attributes:classes-2
+  const currentClasses = new Set(
+    (element.attributes.class || "")
+      .split(/\s+/).filter(s => s.length)
+  )
+
+  Object.entries(classes)
+    .forEach(([name, value]) => {
+      if (value)
+        currentClasses.add(name)
+      else
+        currentClasses.delete(name)
+    })
+
+  element.attributes.class = [...currentClasses].join(" ")
+}
+
+// Merge attributes with an object
+export const applyAttributes = (element, attributes) => {
+  Object.entries(attributes)
+    .forEach(([name, value]) => {
+      if (value !== undefined)
+        element.attributes[name] = value
+      else
+        delete element.attributes[name]
+    })
+}
 
+//#endregion
 
-// Convenience functions
+//#region rawString(), t(), and e()
 
 export const rawString = string =>
   new MetaRawString(string)
 
-const createMetaTextNode = textContent =>
+export const t = textContent =>
   new MetaTextNode(textContent)
 
-const createMetaElement = name => (...variadic) => {
-  const meta = new MetaElement(name)
+export const e = name => (...variadic) => {
+  const element = new MetaElement(name)
 
-  // Implement optional attributes as first argument
-  if (!isMetaNodeChild(variadic[0]))
-    [meta.attributes, ...meta.children] = variadic
-  else {
-    meta.attributes = {}
-    meta.children = variadic
+  // If there are no props
+  if (isMetaChild(variadic[0])) {
+    element.children.push(...variadic)
+    return element
   }
 
-  return meta
-}
-
-// JSX integration
-const createMetaElementJSX = (nameOrComponent, attributesOrProps, ...children) => {
-  // If we are making a html element
-  // This is likely when the jsx tag name begins with a lowercase character
-  if (typeof nameOrComponent == "string") {
-    const meta = new MetaElement(nameOrComponent)
+  // If props exist as the first variadic argument
+  const [props, ...children] = variadic
 
-    // These are attributes then, but they might be null/undefined
-    meta.attributes = attributesOrProps || {}
-    meta.children = children
+  // The bruh prop is reserved for future use
+  delete props.bruh
 
-    return meta
+  // Apply overloaded props, if possible
+  if (typeof props.style === "object") {
+    applyStyles(element, props.style)
+    delete props.style
+  }
+  if (typeof props.class === "object") {
+    applyClasses(element, props.class)
+    delete props.class
   }
+  // The rest of the props are attributes
+  applyAttributes(element, props)
 
-  // It must be a component, then
-  // Bruh components are just functions that return meta elements
-  // Due to JSX, this would mean a function with only one parameter - a "props" object
-  // This object includes the all of the attributes and a "children" key
-  return nameOrComponent( Object.assign({}, attributesOrProps, { children }) )
+  // Add the children to the element
+  element.children.push(...children)
+  return element
 }
 
-// These will be called with short names
-export {
-  createMetaTextNode   as t,
-  createMetaElement    as e,
-  createMetaElementJSX as h
+//#endregion
+
+//#region JSX integration
+
+// The function that jsx tags (except fragments) compile to
+export const h = (nameOrComponent, props, ...children) => {
+  // If we are making an element, this is just a wrapper of e()
+  // This is likely when the JSX tag name begins with a lowercase character
+  if (typeof nameOrComponent === "string") {
+    const makeElement = e(nameOrComponent)
+    return props
+      ? makeElement(props, ...children)
+      : makeElement(...children)
+  }
+
+  // It must be a component, then, as bruh components are just functions
+  // Due to JSX, this would mean a function with only one parameter - props
+  // This object includes the all of the normal props and a "children" key
+  return nameOrComponent({ ...props, children })
 }
 
 // The JSX fragment is made into a bruh fragment (just an array)
 export const JSXFragment = ({ children }) => children
+
+//#endregion

package/src/reactive/index.mjs

@@ -1,6 +1,4 @@
-/** @typedef { import("./index") } */
-
-const isReactive = Symbol.for("bruh reactive")
+export const isReactive = Symbol.for("bruh reactive")
 
 // A super simple and performant reactive value implementation
 export class SimpleReactive {
@@ -81,7 +79,7 @@ export class FunctionalReactive {
   }
 
   set value(newValue) {
-    // Only allow souce nodes to be directly updated
+    // Only allow source nodes to be directly updated
     if (this.#depth !== 0)
       return
 

package/src/util/index.mjs

@@ -31,20 +31,6 @@ export const createDestructable = (object, iterable) => {
   return destructable
 }
 
-// A function that acts like Maybe.from(x).ifExists(existsThen).ifEmpty(emptyThen)
-// Except we just use an array in place of a true Maybe type
-// This is useful for setting and removing reactive attributes
-export const maybeDo = (existsThen, emptyThen) => x => {
-  if (Array.isArray(x)) {
-    if (x.length)
-      existsThen(x[0])
-    else
-      emptyThen()
-  }
-  else
-    existsThen(x)
-}
-
 // Creates an object (as a Proxy) that acts as a function
 // So functionAsObject(f).property is equivalent to f("property")
 // This is can be useful when combined with destructuring syntax, e.g.:

package/src/dom/index.browser.d.ts

@@ -1,113 +0,0 @@
-import { Reactive } from "../reactive"
-
-declare type MaybeReactiveRecord<T> = Record<string, T | Reactive<T>>
-
-declare const isReactive:     unique symbol
-declare const isMetaNode:     unique symbol
-declare const isMetaTextNode: unique symbol
-declare const isMetaElement:  unique symbol
-
-declare type Stringifyable = { toString: () => string }
-
-declare type NonReactiveMetaNodeChild =
-  | MetaNode
-  | Node
-  | string
-  | number
-  | Array<NonReactiveMetaNodeChild>
-
-export declare type MetaNodeChild =
-  | NonReactiveMetaNodeChild
-  | Reactive<NonReactiveMetaNodeChild>
-
-export declare type childrenToNodes = (children: Array<MetaNodeChild>) => Array<Node>
-
-export declare type MetaNode = {
-  [isMetaNode]: true
-  node: Node
-  addProperties: (properties: object) => MetaNode
-}
-
-export declare class MetaTextNode implements MetaNode {
-  constructor(value: string)
-
-  [isMetaNode]:     true
-  [isMetaTextNode]: true
-  node: Text
-  addProperties: (properties: object) => MetaNode
-}
-
-export declare class MetaElement implements MetaNode {
-  constructor(name: string, namespace?: string)
-
-  static from: (element: Element) => MetaElement
-
-  [isMetaNode]:    true
-  [isMetaElement]: true
-  node: Element
-  addProperties:     (properties: object) => MetaNode
-
-  addAttributes:     (attributes:     MaybeReactiveRecord<Stringifyable | void>) => MetaNode
-  addDataAttributes: (dataAttributes: MaybeReactiveRecord<Stringifyable | void>) => MetaNode
-  addStyles:         (styles:         MaybeReactiveRecord<Stringifyable | void>) => MetaNode
-  toggleClasses:     (classes:        MaybeReactiveRecord<boolean>)       => MetaNode
-
-  before:          (...children: Array<MetaNodeChild>) => MetaNode
-  prepend:         (...children: Array<MetaNodeChild>) => MetaNode
-  append:          (...children: Array<MetaNodeChild>) => MetaNode
-  after:           (...children: Array<MetaNodeChild>) => MetaNode
-  replaceChildren: (...children: Array<MetaNodeChild>) => MetaNode
-  replaceWith:     (...children: Array<MetaNodeChild>) => MetaNode
-}
-
-export declare class MetaHTMLElement<Name extends keyof HTMLElementTagNameMap> extends MetaElement {
-  constructor(name: Name, namespace?: "http://www.w3.org/1999/xhtml")
-  node: HTMLElementTagNameMap[Name]
-}
-export declare class MetaSVGElement<Name extends keyof SVGElementTagNameMap> extends MetaElement {
-  constructor(name: Name, namespace: "http://www.w3.org/2000/svg")
-  node: SVGElementTagNameMap[Name]
-}
-
-export declare const hydrateTextNodes: () => Record<string, Text>
-
-declare const createMetaTextNode: (value: string) => MetaTextNode
-
-declare const createMetaElement: {
-  <Name extends keyof HTMLElementTagNameMap>
-  (name: Name, namespace?: "http://www.w3.org/1999/xhtml"): {
-    (                                                ...children: Array<MetaNodeChild>): MetaHTMLElement<Name>
-    (attributes: MaybeReactiveRecord<Stringifyable | void>, ...children: Array<MetaNodeChild>): MetaHTMLElement<Name>
-  }
-
-  <Name extends keyof SVGElementTagNameMap>
-  (name: Name, namespace: "http://www.w3.org/2000/svg"): {
-    (                                                ...children: Array<MetaNodeChild>): MetaSVGElement<Name>
-    (attributes: MaybeReactiveRecord<Stringifyable | void>, ...children: Array<MetaNodeChild>): MetaSVGElement<Name>
-  }
-
-  (name: string, namespace?: string): {
-    (                                                ...children: Array<MetaNodeChild>): MetaNode
-    (attributes: MaybeReactiveRecord<Stringifyable | void>, ...children: Array<MetaNodeChild>): MetaNode
-  }
-}
-
-declare const createMetaElementJSX: {
-  <Name extends keyof HTMLElementTagNameMap>
-  (name: Name, attributes: MaybeReactiveRecord<Stringifyable | void>, ...children: Array<MetaNodeChild>): MetaHTMLElement<Name>
-
-  <Props, Child, ReturnType>
-  (
-    component: (propsAndChildren: Props & { children: Array<Child> }) => ReturnType,
-    props: Props,
-    ...children: Array<Child>
-  ): ReturnType
-}
-
-export {
-  createMetaTextNode   as t,
-  createMetaElement    as e,
-  createMetaElementJSX as h
-}
-
-declare const JSXFragment: <Child>(argument: { children: Array<Child> }) => Array<Child>

package/src/reactive/index.d.ts

@@ -1,36 +0,0 @@
-declare const isReactive: unique symbol
-
-export declare type Reactive<T> = {
-  [isReactive]: true
-  value: T
-  addReaction: (reaction: Function) => Function
-}
-
-export declare class SimpleReactive<T> implements Reactive<T> {
-  constructor(value: T)
-
-  [isReactive]: true
-  get value(): T
-  set value(newValue: T)
-  addReaction(reaction: Function): () => boolean
-}
-
-export declare class FunctionalReactive<T> implements Reactive<T> {
-  constructor(value: T)
-  constructor(dependencies: Array<FunctionalReactive<unknown>>, f: () => T)
-
-  [isReactive]: true
-  get value(): T
-  set value(newValue: T)
-  addReaction(reaction: Function): () => boolean
-}
-
-export declare const r: {
-  <T>(value: T): FunctionalReactive<T>
-  <T>(dependencies: Array<FunctionalReactive<unknown>>, f: () => T): FunctionalReactive<T>
-}
-
-export declare const reactiveDo: {
-  <T>(reactive: Reactive<T>, f: (value: T) => unknown): Function
-  <T>(value: T, f: (value: T) => unknown): void
-}