web-toolkit-x 0.0.1 → 0.71.0

package/src/core/browser.ts

@@ -0,0 +1,555 @@
+import { getEventName } from './utils.js'
+
+/*
+ * Names of the event listeners supported in templates, in camel case, e.g.
+ * onPointerDown, generated from the events of Chromium 153, with the alias
+ * onDoubleClick of onDblClick. Only a type, as the events are checked
+ * against the browser in debug mode.
+ */
+export type EventName =
+  | 'onAbort'
+  | 'onAfterPrint'
+  | 'onAnimationCancel'
+  | 'onAnimationEnd'
+  | 'onAnimationIteration'
+  | 'onAnimationStart'
+  | 'onAppInstalled'
+  | 'onAuxClick'
+  | 'onBeforeCopy'
+  | 'onBeforeCut'
+  | 'onBeforeInput'
+  | 'onBeforeInstallPrompt'
+  | 'onBeforeMatch'
+  | 'onBeforePaste'
+  | 'onBeforePrint'
+  | 'onBeforeToggle'
+  | 'onBeforeUnload'
+  | 'onBeforeXRSelect'
+  | 'onBlur'
+  | 'onCancel'
+  | 'onCanPlay'
+  | 'onCanPlayThrough'
+  | 'onChange'
+  | 'onClick'
+  | 'onClose'
+  | 'onCommand'
+  | 'onCompositionEnd'
+  | 'onCompositionStart'
+  | 'onCompositionUpdate'
+  | 'onContentVisibilityAutoStateChange'
+  | 'onContextLost'
+  | 'onContextMenu'
+  | 'onContextRestored'
+  | 'onCopy'
+  | 'onCueChange'
+  | 'onCut'
+  | 'onDblClick'
+  | 'onDeviceMotion'
+  | 'onDeviceOrientation'
+  | 'onDeviceOrientationAbsolute'
+  | 'onDoubleClick'
+  | 'onDrag'
+  | 'onDragEnd'
+  | 'onDragEnter'
+  | 'onDragLeave'
+  | 'onDragOver'
+  | 'onDragStart'
+  | 'onDrop'
+  | 'onDurationChange'
+  | 'onEmptied'
+  | 'onEncrypted'
+  | 'onEnded'
+  | 'onEnterPictureInPicture'
+  | 'onError'
+  | 'onFocus'
+  | 'onFormData'
+  | 'onFreeze'
+  | 'onFullscreenChange'
+  | 'onFullscreenError'
+  | 'onGamepadConnected'
+  | 'onGamepadDisconnected'
+  | 'onGotPointerCapture'
+  | 'onHashChange'
+  | 'onInput'
+  | 'onInvalid'
+  | 'onKeyDown'
+  | 'onKeyPress'
+  | 'onKeyUp'
+  | 'onLanguageChange'
+  | 'onLeavePictureInPicture'
+  | 'onLoad'
+  | 'onLoadedData'
+  | 'onLoadedMetadata'
+  | 'onLoadStart'
+  | 'onLostPointerCapture'
+  | 'onMessage'
+  | 'onMessageError'
+  | 'onMouseDown'
+  | 'onMouseEnter'
+  | 'onMouseLeave'
+  | 'onMouseMove'
+  | 'onMouseOut'
+  | 'onMouseOver'
+  | 'onMouseUp'
+  | 'onMouseWheel'
+  | 'onOffline'
+  | 'onOnline'
+  | 'onPageHide'
+  | 'onPageReveal'
+  | 'onPageShow'
+  | 'onPageSwap'
+  | 'onPaste'
+  | 'onPause'
+  | 'onPlay'
+  | 'onPlaying'
+  | 'onPointerCancel'
+  | 'onPointerDown'
+  | 'onPointerEnter'
+  | 'onPointerLeave'
+  | 'onPointerLockChange'
+  | 'onPointerLockError'
+  | 'onPointerMove'
+  | 'onPointerOut'
+  | 'onPointerOver'
+  | 'onPointerRawUpdate'
+  | 'onPointerUp'
+  | 'onPopState'
+  | 'onPrerenderingChange'
+  | 'onProgress'
+  | 'onRateChange'
+  | 'onReadyStateChange'
+  | 'onRejectionHandled'
+  | 'onReset'
+  | 'onResize'
+  | 'onResume'
+  | 'onScroll'
+  | 'onScrollEnd'
+  | 'onScrollSnapChange'
+  | 'onScrollSnapChanging'
+  | 'onSearch'
+  | 'onSecurityPolicyViolation'
+  | 'onSeeked'
+  | 'onSeeking'
+  | 'onSelect'
+  | 'onSelectionChange'
+  | 'onSelectStart'
+  | 'onSlotChange'
+  | 'onStalled'
+  | 'onStorage'
+  | 'onSubmit'
+  | 'onSuspend'
+  | 'onTimeUpdate'
+  | 'onToggle'
+  | 'onTouchCancel'
+  | 'onTouchEnd'
+  | 'onTouchMove'
+  | 'onTouchStart'
+  | 'onTransitionCancel'
+  | 'onTransitionEnd'
+  | 'onTransitionRun'
+  | 'onTransitionStart'
+  | 'onUnhandledRejection'
+  | 'onUnload'
+  | 'onVisibilityChange'
+  | 'onVolumeChange'
+  | 'onWaiting'
+  | 'onWaitingForKey'
+  | 'onWebkitAnimationEnd'
+  | 'onWebkitAnimationIteration'
+  | 'onWebkitAnimationStart'
+  | 'onWebkitFullscreenChange'
+  | 'onWebkitFullscreenError'
+  | 'onWebkitTransitionEnd'
+  | 'onWheel'
+
+/*
+ * Names of the element attributes supported in templates, in camel case,
+ * e.g. tabIndex, generated from the attributes of Chromium 153, with the
+ * names supported before, e.g. allowFullScreen. Only a type, as the
+ * attributes are checked against the browser in debug mode.
+ */
+export type AttributeName =
+  | 'abbr'
+  | 'accept'
+  | 'acceptCharset'
+  | 'accessKey'
+  | 'action'
+  | 'adAuctionHeaders'
+  | 'align'
+  | 'aLink'
+  | 'allow'
+  | 'allowFullscreen'
+  | 'allowFullScreen'
+  | 'allowPaymentRequest'
+  | 'alt'
+  | 'archive'
+  | 'ariaActions'
+  | 'ariaActiveDescendant'
+  | 'ariaAtomic'
+  | 'ariaAutoComplete'
+  | 'ariaBrailleLabel'
+  | 'ariaBrailleRoleDescription'
+  | 'ariaBusy'
+  | 'ariaChecked'
+  | 'ariaColCount'
+  | 'ariaColIndex'
+  | 'ariaColIndexText'
+  | 'ariaColSpan'
+  | 'ariaControls'
+  | 'ariaCurrent'
+  | 'ariaDescribedBy'
+  | 'ariaDescription'
+  | 'ariaDetails'
+  | 'ariaDisabled'
+  | 'ariaErrorMessage'
+  | 'ariaExpanded'
+  | 'ariaFlowTo'
+  | 'ariaHasPopup'
+  | 'ariaHidden'
+  | 'ariaInvalid'
+  | 'ariaKeyShortcuts'
+  | 'ariaLabel'
+  | 'ariaLabelledBy'
+  | 'ariaLabelLedBy'
+  | 'ariaLevel'
+  | 'ariaLive'
+  | 'ariaModal'
+  | 'ariaMultiLine'
+  | 'ariaMultiSelectable'
+  | 'ariaOrientation'
+  | 'ariaOwns'
+  | 'ariaPlaceholder'
+  | 'ariaPosInSet'
+  | 'ariaPressed'
+  | 'ariaReadOnly'
+  | 'ariaRelevant'
+  | 'ariaRequired'
+  | 'ariaRoleDescription'
+  | 'ariaRowCount'
+  | 'ariaRowIndex'
+  | 'ariaRowIndexText'
+  | 'ariaRowSpan'
+  | 'ariaSelected'
+  | 'ariaSetSize'
+  | 'ariaSort'
+  | 'ariaValueMax'
+  | 'ariaValueMin'
+  | 'ariaValueNow'
+  | 'ariaValueText'
+  | 'as'
+  | 'async'
+  | 'attributionSrc'
+  | 'autoCapitalize'
+  | 'autoComplete'
+  | 'autoCorrect'
+  | 'autoFocus'
+  | 'autoPlay'
+  | 'axis'
+  | 'background'
+  | 'bgColor'
+  | 'blocking'
+  | 'border'
+  | 'browsingTopics'
+  | 'cellPadding'
+  | 'cellSpacing'
+  | 'charset'
+  | 'checked'
+  | 'cite'
+  | 'clear'
+  | 'closedBy'
+  | 'code'
+  | 'codeBase'
+  | 'codeType'
+  | 'color'
+  | 'cols'
+  | 'colSpan'
+  | 'command'
+  | 'commandFor'
+  | 'compact'
+  | 'content'
+  | 'contentEditable'
+  | 'controls'
+  | 'coords'
+  | 'credentialless'
+  | 'crossOrigin'
+  | 'csp'
+  | 'data'
+  | 'dateTime'
+  | 'declare'
+  | 'decoding'
+  | 'default'
+  | 'defer'
+  | 'dir'
+  | 'dirName'
+  | 'disabled'
+  | 'disablePictureInPicture'
+  | 'disableRemotePlayback'
+  | 'download'
+  | 'draggable'
+  | 'elementTiming'
+  | 'encoding'
+  | 'encType'
+  | 'enterKeyHint'
+  | 'event'
+  | 'fetchPriority'
+  | 'focusGroupStart'
+  | 'for'
+  | 'form'
+  | 'formAction'
+  | 'formEnctype'
+  | 'formMethod'
+  | 'formNoValidate'
+  | 'formTarget'
+  | 'frame'
+  | 'frameBorder'
+  | 'headers'
+  | 'height'
+  | 'hidden'
+  | 'high'
+  | 'href'
+  | 'hrefLang'
+  | 'hspace'
+  | 'httpEquiv'
+  | 'id'
+  | 'imageSizes'
+  | 'imageSrcset'
+  | 'incremental'
+  | 'inert'
+  | 'inputMode'
+  | 'integrity'
+  | 'interestFor'
+  | 'is'
+  | 'isMap'
+  | 'itemProp'
+  | 'kind'
+  | 'label'
+  | 'lang'
+  | 'link'
+  | 'list'
+  | 'loading'
+  | 'longDesc'
+  | 'loop'
+  | 'low'
+  | 'lowSrc'
+  | 'marginHeight'
+  | 'marginWidth'
+  | 'max'
+  | 'maxLength'
+  | 'media'
+  | 'method'
+  | 'min'
+  | 'minLength'
+  | 'multiple'
+  | 'muted'
+  | 'name'
+  | 'noHref'
+  | 'noModule'
+  | 'nonce'
+  | 'noShade'
+  | 'noValidate'
+  | 'noWrap'
+  | 'open'
+  | 'optimum'
+  | 'part'
+  | 'pattern'
+  | 'ping'
+  | 'placeholder'
+  | 'playsInline'
+  | 'popover'
+  | 'popoverTarget'
+  | 'popoverTargetAction'
+  | 'poster'
+  | 'preload'
+  | 'privateToken'
+  | 'readOnly'
+  | 'referrerPolicy'
+  | 'rel'
+  | 'required'
+  | 'rev'
+  | 'reversed'
+  | 'role'
+  | 'rows'
+  | 'rowSpan'
+  | 'rules'
+  | 'sandbox'
+  | 'scheme'
+  | 'scope'
+  | 'scrolling'
+  | 'selected'
+  | 'shadowRootClonable'
+  | 'shadowRootCustomElementRegistry'
+  | 'shadowRootDelegatesFocus'
+  | 'shadowRootMode'
+  | 'shadowRootReferenceTarget'
+  | 'shadowRootSerializable'
+  | 'shadowRootSlotAssignment'
+  | 'shape'
+  | 'size'
+  | 'sizes'
+  | 'slot'
+  | 'span'
+  | 'spellCheck'
+  | 'src'
+  | 'srcDoc'
+  | 'srcLang'
+  | 'srcSet'
+  | 'standby'
+  | 'start'
+  | 'step'
+  | 'summary'
+  | 'tabIndex'
+  | 'target'
+  | 'title'
+  | 'translate'
+  | 'type'
+  | 'useMap'
+  | 'vAlign'
+  | 'value'
+  | 'version'
+  | 'virtualKeyboardPolicy'
+  | 'vLink'
+  | 'vspace'
+  | 'webkitDirectory'
+  | 'width'
+  | 'wrap'
+  | 'writingSuggestions'
+
+/* Attributes set by other names than those of the element properties. */
+const ATTRIBUTE_PROPERTIES: Record<string, string> = { for: 'htmlFor' }
+
+/* Attributes valid on all elements, not reflected as element properties. */
+const UNREFLECTED_ATTRIBUTES = new Set(['ariaOwns', 'is', 'itemProp'])
+
+/* The lower-cased property names of the elements, read when first needed. */
+const elementProperties = new Map<string, Set<string>>()
+
+const getElementProperties = (tagName: string) => {
+  let properties = elementProperties.get(tagName)
+  if (!properties) {
+    properties = new Set()
+    // the attributes are reflected as properties, in the prototype chain
+    for (const name in document.createElement(tagName)) {
+      properties.add(name.toLowerCase())
+    }
+    elementProperties.set(tagName, properties)
+  }
+  return properties
+}
+
+/*
+ * Events without handler properties, e.g. oncompositionend, or with them
+ * only on touch devices, e.g. ontouchstart.
+ */
+const EVENTS_WITHOUT_HANDLERS = new Set([
+  'compositionstart',
+  'compositionupdate',
+  'compositionend',
+  'touchstart',
+  'touchmove',
+  'touchend',
+  'touchcancel',
+])
+
+/*
+ * The style properties of the browser, read when first needed. Chromium
+ * defines them on the style object, Firefox on its prototype, so they are
+ * collected up to the CSSStyleDeclaration methods.
+ */
+let supportedStyles: Set<string> | null = null
+const getSupportedStyles = () => {
+  if (!supportedStyles) {
+    supportedStyles = new Set()
+    for (
+      let object: object | null = document.documentElement.style;
+      object && object !== CSSStyleDeclaration.prototype;
+      object = Object.getPrototypeOf(object) as object | null
+    ) {
+      for (const name of Object.getOwnPropertyNames(object)) {
+        supportedStyles.add(name)
+      }
+    }
+  }
+  return supportedStyles
+}
+
+const Browser = {
+  /**
+   * Checks if the browser supports the attribute on the element, as
+   * a property of the element in any letter case, e.g. tabIndex. Meant
+   * for debug mode, as the check creates an element of each tag name.
+   */
+  isAttributeSupported(this: void, key: string, tagName: string): boolean {
+    if (UNREFLECTED_ATTRIBUTES.has(key)) {
+      return true
+    }
+    const properties = getElementProperties(tagName)
+    const name = (ATTRIBUTE_PROPERTIES[key] ?? key).toLowerCase()
+    // the ARIA relations are reflected as the related elements
+    return (
+      properties.has(name) ||
+      properties.has(`${name}element`) ||
+      properties.has(`${name}elements`)
+    )
+  },
+
+  /**
+   * Checks if the browser supports the event of the listener, e.g. onClick,
+   * on the element, as its handler property, e.g. onclick. Meant for debug
+   * mode, as the check creates an element of each tag name.
+   */
+  isEventSupported(this: void, key: string, tagName: string): boolean {
+    const event = getEventName(key)
+    return (
+      EVENTS_WITHOUT_HANDLERS.has(event) ||
+      getElementProperties(tagName).has(`on${event}`)
+    )
+  },
+
+  isStyleSupported(this: void, key: string): boolean {
+    return key.startsWith('--') || getSupportedStyles().has(key)
+  },
+}
+
+/*
+ * The filter functions of Chromium 153, in camel case, e.g. dropShadow for
+ * drop-shadow in CSS. Only a type, as the functions are checked against
+ * the browser in debug mode.
+ */
+export type FilterName =
+  | 'blur'
+  | 'brightness'
+  | 'contrast'
+  | 'dropShadow'
+  | 'grayscale'
+  | 'hueRotate'
+  | 'invert'
+  | 'opacity'
+  | 'saturate'
+  | 'sepia'
+  | 'url'
+
+/* The transform functions of Chromium 153, as named in CSS, e.g. translateX. */
+export type TransformName =
+  | 'matrix'
+  | 'matrix3d'
+  | 'translate'
+  | 'translate3d'
+  | 'translateX'
+  | 'translateY'
+  | 'translateZ'
+  | 'scale'
+  | 'scale3d'
+  | 'scaleX'
+  | 'scaleY'
+  | 'scaleZ'
+  | 'rotate'
+  | 'rotate3d'
+  | 'rotateX'
+  | 'rotateY'
+  | 'rotateZ'
+  | 'skew'
+  | 'skewX'
+  | 'skewY'
+  | 'perspective'
+
+export default Browser

package/src/core/child-nodes.ts

@@ -0,0 +1,77 @@
+import { invariant } from './utils.js'
+import type VirtualElement from './virtual-element.js'
+import type VirtualNode from './virtual-node.js'
+import type WebComponent from './web-component.js'
+
+/*
+ * A node with child nodes: an element, or a Web Component
+ * with the child nodes rendered in its light DOM.
+ */
+export type ParentVirtualNode = VirtualElement | WebComponent
+
+/*
+ * Operations on the child nodes of the parent nodes, which store them
+ * as `children` of an element or `childNodes` of a Web Component.
+ */
+const ChildNodes = {
+  set(parent: ParentVirtualNode, nodes: VirtualNode[]) {
+    parent.childNodes = nodes
+    for (const child of nodes) {
+      parent.ref.appendChild(child.ref)
+    }
+  },
+
+  insert(parent: ParentVirtualNode, child: VirtualNode, index?: number) {
+    const nodes = parent.childNodes ?? []
+    if (index === undefined) {
+      index = nodes.length
+    }
+    const nextChild = nodes[index]
+    nodes.splice(index, 0, child)
+    parent.childNodes = nodes
+    parent.ref.insertBefore(child.ref, (nextChild && nextChild.ref) || null)
+    child.parentNode = parent
+  },
+
+  replace(parent: ParentVirtualNode, child: VirtualNode, node: VirtualNode) {
+    const nodes = parent.childNodes ?? []
+    const index = nodes.indexOf(child)
+    invariant(index >= 0, 'Specified node is not a child of this element!')
+    nodes.splice(index, 1, node)
+    child.parentNode = null
+    node.parentNode = parent
+    child.ref.replaceWith(node.ref)
+  },
+
+  move(
+    parent: ParentVirtualNode,
+    child: VirtualNode,
+    from: number,
+    to: number,
+  ) {
+    const nodes = parent.childNodes ?? []
+    invariant(
+      nodes[from] === child,
+      'Specified node is not a child of this element!',
+    )
+    nodes.splice(from, 1)
+    nodes.splice(to, 0, child)
+    // the DOM position is taken from the virtual children, as element
+    // children would skip the text and comment nodes
+    const nextChild = nodes[to + 1]
+    parent.ref.insertBefore(child.ref, nextChild ? nextChild.ref : null)
+  },
+
+  remove(parent: ParentVirtualNode, child: VirtualNode) {
+    const nodes = parent.childNodes ?? []
+    const index = nodes.indexOf(child)
+    invariant(index >= 0, 'Specified node is not a child of this element!')
+    nodes.splice(index, 1)
+    if (!nodes.length) {
+      parent.childNodes = undefined
+    }
+    parent.ref.removeChild(child.ref)
+  },
+}
+
+export default ChildNodes

package/src/core/comment.ts

@@ -0,0 +1,24 @@
+import type { CommentDescription } from './description.js'
+import VirtualNode from './virtual-node.js'
+
+class Comment extends VirtualNode {
+  static NodeType = 'comment'
+
+  declare description: CommentDescription
+  declare ref: globalThis.Comment
+
+  constructor(description: CommentDescription, parentNode?: VirtualNode) {
+    super(description, parentNode)
+    this.attachDOM()
+  }
+
+  get nodeType(): string {
+    return Comment.NodeType
+  }
+
+  attachDOM() {
+    this.ref = document.createComment(` ${this.description.text} `)
+  }
+}
+
+export default Comment