@sitecore-feaas/clientside 0.2.0 → 0.2.1

package/scripts/test-setup.ts

@@ -1 +1,2 @@
+process.env.TESTING = 'true'
 export default function () {}

package/src/components/FEAASComponent.tsx

@@ -1,9 +1,9 @@
 import { DEFAULT_CDN_URL, FEAASCDNComponentParams, fetchAndRevalidateComponent, parseComponentSource } from '../cdn.js'
 import { renderDOMContent, renderDOMElement } from '../dom/rendering.js'
 import { loadStylesheetAllowStale } from '../headless.js'
-import { FEAASBase } from './FEAASBase.js'
+import { FEAASElement } from './FEAASElement.js'
 
-export function FEAASComponentsProps(element: FEAASBase) {
+export function FEAASComponentsProps(element: FEAASElement) {
   let data: any
   const src = element.getAttribute('src')
   if (src) {
@@ -34,7 +34,7 @@ export function FEAASComponentsProps(element: FEAASBase) {
   }
 }
 export type FEAASComponentsProps = ReturnType<typeof FEAASComponentsProps>
-export class FEAASComponent extends FEAASBase<FEAASComponentsProps, string> {
+export class FEAASComponent extends FEAASElement<FEAASComponentsProps, string> {
   static observedAttributes = [
     'library',
     'component',
@@ -78,7 +78,7 @@ export class FEAASComponent extends FEAASBase<FEAASComponentsProps, string> {
   }
 
   getEditor(): any {
-    return (document.querySelector('feaas-context') as FEAASBase)?.refs.editor
+    return (document.querySelector('feaas-context') as FEAASElement)?.refs.editor
   }
 
   constructor() {

package/src/components/FEAASElement.tsx

@@ -1,61 +1,486 @@
-import type { ReactNode, ReactElement, JSXElementConstructor, PropsWithChildren } from 'react'
-import { FEAASBase } from './FEAASBase.js'
+import type { JSXElementConstructor, ReactElement, ReactNode } from 'react'
+import type ReactDOMClient from 'react-dom/client'
+import type ReactDOM from 'react-dom'
+import type React from 'react'
+import { ControlledPromise } from '../utils/promise.js'
 
-export type ReactModules = {
+export type OptionalExcept<T, K extends keyof T> = Pick<T, K> & Partial<Omit<T, K>>
+
+// Shim in case it's required in node.js environment
+var WebComponent =
+  typeof HTMLElement == 'undefined'
+    ? // @ts-ignore
+      typeof windowJSDOM != 'undefined'
+      ? // @ts-ignore
+        (windowJSDOM.HTMLElement as typeof HTMLElement)
+      : (class {} as unknown as typeof HTMLElement)
+    : HTMLElement
+
+export interface ReactPayload {
   React: typeof React
   ReactDOM: typeof ReactDOM
+  ReactDOMClient: typeof ReactDOMClient
 }
-export type ReactJSX = ReactNode | ReactElement<any, string | JSXElementConstructor<any>>
-export type FEAASReactRender<P> = {
-  (this: FEAASElement<P>, props: P, payload: ReactModules): ReactJSX
-}
+/**
+ * FEAASElement is a superclass for FEAAS components with optional react support.
+ *
+ * Initialization lifecycle:
+ *
+ * - `set(props)`
+ * - `scheduleRender()` - any attribute change causes render to schedule to next frame
+ * - `whenRendered.restart()` - rendering promise is reset and will resolve after render
+ * - `advance()` - called on next frame
+ * - `if (isReadyToLoad()) => boolean` - check if component has all necessary properties to load
+ * - `load() => payload` => component is loaded
+ * - `onLoad?(payload)` => invoke loaded callback
+ * - `advance()` => going further in state machine
+ * - `flush()` => flushes all react changes if needed
+ * - `update()` => component-specific method (or react) to render changes to dom
+ * - `render(payload, props)` => render means react
+ * - `whenRendered.resolve()` - rendering promise is resolved after rendering
+ * - `whenLoaded.resolved()` - resolved after loading and rendering
+ */
+export class FEAASElement<Props = any, Payload = any> extends WebComponent {
+  static observedAttributes: string[]
 
-export default class FEAASElement<P> extends FEAASBase<P, ReactModules> {
-  load() {
-    return Promise.all([
-      // @ts-ignore @webpack-ignore
-      import('https://cdn.skypack.dev/react'),
-      // @ts-ignore
-      import('https://cdn.skypack.dev/react-dom')
-    ]).then(([React, ReactDOM]) => {
-      return { React, ReactDOM }
-    })
+  defaultProps = {} as Partial<Props>
+
+  /** Return attributes as parsed values */
+  getProps(context?: HTMLElement): any {
+    return {}
   }
 
-  render({}: P, { React }: ReactModules): ReactJSX {
-    return <></>
+  /** Properties parsed in current tick */
+  props: Props
+  overrides: Props
+
+  /** Timer until next tick */
+  nextRender: number
+
+  /** Is/was component in the dom? */
+  connected = false
+
+  refs: Record<string, FEAASElement> = {}
+  descendants: FEAASElement[] = []
+
+  /** Result of lazy loading */
+  payload: Payload
+  whenLoaded = ControlledPromise<Payload>((payload) => {
+    this.payload = payload
+  })
+
+  constructor() {
+    super()
+    this.addEventListener('feaasMount', this)
+    this.addEventListener('feaasUnmount', this)
   }
-}
 
-interface MyComponentProps {
-  counter: string
-}
+  /** Attaches shadow root if getShadowRootOptions any settings, or uses element itself */
+  getRoot(): FEAASElement | HTMLElement | ShadowRoot {
+    return this
+  }
 
-export class MyComponent extends FEAASElement<MyComponentProps> {
-  // will re-render component if any of these attributes have changed
-  static observedAttributes = ['counter']
+  /** Attribute changes trigger props parsing and schedules re-rendering */
+  attributeChangedCallback(name: string, oldValue: string, newValue: string) {
+    this.set()
+  }
 
-  useShadowRoot = true
+  /** Components parses its attributes when connected, and schedules rendeirng */
+  connectedCallback() {
+    this.mount()
+  }
+  disconnectedCallback() {
+    this.unmount()
+  }
+  /**
+   * Web components are initialized depth-first, making child elements render before its parents. This could here
+   * attempts to avoid this and inverts the initialization logic, so that children are initialized in the context of its
+   * already-initialized parents.
+   *
+   * FEAAS components dispatch `feaasMount` event that allows components to store references to each other. In addition
+   * it allows external scripts to listen for initialization of FEAAS components
+   */
+  mount() {
+    try {
+      const parent = this.getParent() as FEAASElement
+      // Allow parent component to initialize first
+      if (parent && !parent.connected) return
+      if (this.connected) return
+      this.connected = true
+      this.log('FEAAS: Mount', this.tagName, this)
+      this.dispatchEvent(new Event('feaasMount', { bubbles: true, composed: true }))
+      this.getElements().map((element: FEAASElement) => element.mount?.())
+      this.set()
+    } catch (e) {
+      this.onError(e)
+    }
+  }
+
+  log(...args: any) {
+    if (typeof process != 'undefined' && process.env.TESTING) return
+    console.log(...args)
+  }
+
+  /** Nothing special happens on unmount, except setting a flag */
+  unmount() {
+    if (!this.connected) return
+    this.log('FEAAS: Unmount', this)
+    this.dispatchEvent(new Event('feaasUnmount', { bubbles: true, composed: true }))
+    this.connected = false
+  }
+
+  getParent(onlyFeaas = true) {
+    for (
+      var p: HTMLElement = this;
+      (p = p.parentElement || ((p.parentNode instanceof ShadowRoot ? p.parentNode.host : null) as HTMLElement));
+
+    ) {
+      if (!onlyFeaas || p.tagName.startsWith('FEAAS-')) return p
+    }
+  }
+
+  getElements(root: HTMLElement | ShadowRoot = this.getRoot(), onlyFeaas = true): HTMLElement[] {
+    return Array.from(root.querySelectorAll('*'))
+      .map(
+        (el) =>
+          [
+            !onlyFeaas || el.tagName.startsWith('FEAAS-') ? el : null,
+            el.shadowRoot ? this.getElements(el.shadowRoot, onlyFeaas) : null
+          ] as HTMLElement[]
+      )
+      .flat()
+      .filter(Boolean)
+  }
+
+  /** Catch-all event handler that dispatches events to callback */
+  handleEvent(event: Event) {
+    const target = event.composedPath()[0] as FEAASElement
+    switch (event.type) {
+      case 'feaasMount':
+        if (target != this) this.nestedCallback(target)
+        break
+      case 'feaasUnmount':
+        if (target != this) this.unnestedCallback(target)
+        break
+    }
+  }
+
+  /** Act on children element being removed */
+  unnestedCallback(target: FEAASElement) {
+    const index = this.descendants.indexOf(target)
+    if (index == -1) return
+    this.log('FEAAS: Unnest', this, target)
+    this.descendants.splice(index, -1)
+    this.refs[target.getComponentName()] = null
+    if (target.refs.parent == this) target.refs.parent = null
+    if (target.refs.top == this) {
+      target.refs.top = target.refs.parent
+    }
+  }
+
+  /** Act on children element being added */
+  nestedCallback(target: FEAASElement): boolean | void {
+    const index = this.descendants.indexOf(target)
+    if (index != -1) return
+    this.descendants.push(target)
+    this.log('FEAAS: Nest', this, target)
+    this.refs[target.getComponentName()] = target
+    target.refs.top = this
+    target.refs.parent ||= this
+    if (target.render) {
+      for (var p: FEAASElement = target.refs.parent; p; p = p.refs.parent) {
+        if (p.render) {
+          target.refs.parentReact ||= p
+          target.refs.topReact = p
+        }
+      }
+    }
+  }
+
+  getComponentName() {
+    return this.tagName.replace('FEAAS-', '').toLowerCase()
+  }
+
+  /**
+   * Check if lazy component is ready to be loaded. For example a component may stay unloaded unless certain attributes
+   * are set
+   */
+  isReadyToLoad() {
+    return this.payload === undefined && this.getAttribute('hidden') == null
+  }
+
+  /** Generic error handler */
+  onError(error: Error, where: string = 'uncaught', handled = false) {
+    const event = new CustomEvent('feaasError', { bubbles: true, composed: true, detail: error })
+    this.dispatchEvent(event)
+    this.whenLoaded.reject(error)
+    if (!event.defaultPrevented && !handled) {
+      this.whenRendered.reject(error)
+      try {
+        this.unmount()
+      } catch (e) {}
+      return true
+    }
+    return false
+  }
+
+  shouldUpdateOnLoad() {
+    return true
+  }
+
+  onLoad: (payload: Payload) => void
+
+  /** Load lazy component & render */
+  async advance() {
+    try {
+      if (this.payload === undefined) {
+        if (!this.isReadyToLoad()) return
+        this.payload = null
+        this.dispatchEvent(new Event('feaasLoad', { bubbles: true, composed: true }))
+        const loaded = await this.load().catch((e) => {
+          this.payload = undefined
+          throw e
+        })
+
+        this.whenLoaded.resolve(loaded)
+
+        // Allow component to handle the post-loading
+        if (this.onLoad) {
+          return
+        }
+      } else if (this.payload == null) {
+        return
+      }
+      this.flush()
+      this.whenRendered.resolve(this)
+    } catch (e) {
+      this.onError(e)
+    }
+  }
 
-  // parse attributes from web component to react-ready form
-  getProps() {
-    return {
-      counter: parseFloat(this.getAttribute('counter'))
+  flush() {
+    const flushSync = (this.payload as ReactPayload)?.ReactDOM?.flushSync
+    if (flushSync) {
+      flushSync(() => this.update())
+    } else {
+      this.update()
     }
   }
 
-  // First argument is props, second arguments is React stuff
-  // Destructuring React is important for JSX to work
-  render({ counter }: MyComponentProps, { React }: ReactModules): ReactJSX {
-    const [updates, setUpdates] = React.useState(0)
-    React.useEffect(() => {
-      setUpdates((u) => u + 1)
-    }, [counter])
+  /** Invoke preloading logic that needs to finish before component can render */
+  load() {
+    return Promise.resolve(null)
+  }
+
+  /**
+   * Component-specific logic that updates the DOM. Default render implementation assume react rendering, in that case
+   * the component needs to provide React & ReactDOM references in its payload. Web component redefine its render to not
+   * use react at all
+   */
+  update(): any {
+    //this.log('FEAAS: React', this.tagName, this.payload)
+    if (this.payload == null) return
+    if (!this.render) return
+    const { React, ReactDOM, ReactDOMClient } = (this.payload as ReactPayload) || {}
+    if (!React) throw new Error(`${this.tagName}: React is not present in payload`)
+    if (!ReactDOM) throw new Error(`${this.tagName}: ReactDOM is not present in payload`)
+    if (!this.refs.topReact && !this.forceUpdateReact) {
+      if (ReactDOMClient) {
+        this.reactRoot ||= ReactDOMClient.createRoot(this.getReactRootElement())
+        this.reactRoot.render(this.getReactElement())
+      } else {
+        ReactDOM.render(this.getReactElement(), this.getReactRootElement())
+      }
+    } else if (this.forceUpdateReact) {
+      this.forceUpdateReact?.()
+    } else {
+      this.refs.topReact.forceUpdateReact?.()
+    }
+  }
+
+  invokeReactRendering(): ReactNode {
+    const { React, ReactDOM } = (this.payload as ReactPayload) || {}
+    if (!this.connected) return null
+    const children = this.descendants
+      .filter((r) => {
+        return r.refs.parentReact == this && r.payload
+      })
+      .map((child: FEAASElement<any, any>, index) => {
+        return this.getReactElement(child)
+      })
+    return this.render({ ...this.props, children }, this.payload)
+  }
+
+  reactWrapper: React.FunctionComponent
+  reactErrorBoundary: new (...args: any) => React.Component<{ children: any; slot: string }, { error: Error }>
+  reactRoot: ReactDOMClient.Root
+
+  getReactErrorBoundary(target: FEAASElement = this, displayName = target.tagName) {
+    if (this.reactErrorBoundary) return this.reactErrorBoundary
+
+    const { React, ReactDOM } = (target.payload as ReactPayload) || {}
+    return (this.reactErrorBoundary ||= class FEAASErrorBoundary extends React.Component<
+      { children: any; slot: string },
+      { error: Error }
+    > {
+      state = {
+        error: null as Error
+      }
+
+      static getDerivedStateFromError(error: Error) {
+        return { error: error }
+      }
+
+      componentDidCatch(error: Error, errorInfo: any) {
+        console.error(`FEAAS: ${target.tagName} Error:`, error, errorInfo)
+        target.onError(error, 'react')
+        //this.setState({ error: error })
+      }
+
+      render() {
+        if (this.state.error) {
+          // target.classList.add('feaas-error')
+          return
+          //return <h1>There seems to be a problem.</h1>
+        }
+        //if (target.classList.contains('feaas-error')) target.classList.remove('feaas-error')
+
+        return this.props.children
+      }
+    })
+  }
+
+  getReactElement(target: FEAASElement = this, props?: any) {
+    const { React, ReactDOM } = (target.payload as ReactPayload) || {}
+    const ErrorBoundary = this.getReactErrorBoundary()
+    const Wrapper = this.getReactWrapper(target)
     return (
-      <>
-        <p>Rendering attribute: {counter}</p>
-        <p>Triggered updates: {updates}</p>
-      </>
+      <ErrorBoundary key={target.tagName + '-' + target.getUID()} slot={target.getAttribute('slot')}>
+        <Wrapper />
+      </ErrorBoundary>
     )
   }
+
+  getReactWrapper(target: FEAASElement = this, displayName = target.tagName) {
+    if (target.reactWrapper) return target.reactWrapper
+
+    const { React, ReactDOM } = (target.payload as ReactPayload) || {}
+
+    target.reactWrapper = (props?: any) => {
+      if (target.render) {
+        const [value, forceUpdateReact] = React.useReducer((r) => r + 1, 0)
+        target.forceUpdateReact = forceUpdateReact
+        return ReactDOM.createPortal(<>{target.invokeReactRendering()}</>, target.getReactRootElement())
+      } else {
+        return target.update()
+      }
+    }
+
+    Object.assign(target.reactWrapper, {
+      key: target.tagName + '-' + target.getUID(),
+      displayName: displayName
+    })
+
+    return target.reactWrapper
+  }
+
+  uid: string
+  getUID() {
+    return (this.uid ||= String(Math.random()))
+  }
+  forceUpdateReact: (node?: ReactNode) => void
+
+  /**
+   * Render method that is pretty much the same as React Functional component, but with extra second argument for
+   * payload (usually result of import, it is expected to have React in scope).
+   */
+  render?(props: React.PropsWithChildren<Props>, payload: Payload): ReactNode | ReactElement
+
+  useShadowRoot: boolean
+  getShadowRoot() {
+    if (!this.shadowRoot) {
+      this.attachShadow({ mode: 'open' })
+    }
+    return this.shadowRoot
+  }
+  getReactRootElement(): HTMLElement | ShadowRoot {
+    return this.useShadowRoot ? this.getShadowRoot() : this.getRoot()
+  }
+
+  /** Set props and return values on new next tick */
+  set(overrides?: Partial<Props>) {
+    try {
+      this.scheduleRender()
+      this.overrides = {
+        ...this.overrides,
+        ...overrides
+      }
+      this.props = {
+        ...this.getProps(),
+        ...this.overrides
+      }
+      for (var property in this.props) {
+        const value = this.props[property]
+        const attribute = property.replace(/([a-z])([A-Z])/g, '$1-$2').toLowerCase()
+        if (value == null || value === this.defaultProps[property as keyof typeof this.defaultProps]) {
+          this.removeAttribute(attribute)
+        } else if (typeof value == 'string' || typeof value == 'number' || typeof value == 'boolean') {
+          if (this.getAttribute(attribute) != String(value)) this.setAttribute(attribute, String(value))
+        }
+      }
+    } catch (e) {
+      this.whenRendered.reject(e)
+      this.onError(e, 'set')
+    }
+    return this
+  }
+
+  import(path: string): Promise<Payload> {
+    return import(/* @vite-ignore */ /* webpackIgnore: true */ path)
+  }
+
+  /** Schedule rendering on next tick, to batch multiple attribute changes */
+  initialized: boolean
+  whenRendered = ControlledPromise<this>(
+    () => (this.initialized = true),
+    () => cancelAnimationFrame(this.nextRender)
+  )
+  scheduleRender() {
+    if (this.nextRender == null) {
+      this.whenRendered = this.whenRendered.restart()
+    }
+    cancelAnimationFrame(this.nextRender)
+    this.nextRender = requestAnimationFrame(() => {
+      this.nextRender = null
+      this.advance().catch((e) => {})
+    })
+  }
+
+  formatURL(src: string, hostname: string) {
+    if (typeof src == 'string' && src.match(/^\/[^\/]/)) {
+      return hostname + src
+    } else {
+      return src
+    }
+  }
+
+  getContextAttribute(name: string, element = this) {
+    for (
+      var p: HTMLElement = this;
+      (p = p.parentElement || ((p.parentNode instanceof ShadowRoot ? p.parentNode.host : null) as HTMLElement));
+
+    ) {
+      if (p.getAttribute(name) != null) return p.getAttribute(name)
+    }
+    return this.getAttribute(name)
+  }
+
+  static register(tagName: string, win?: Window) {
+    if (win == null) win = typeof window != 'undefined' ? window : null
+    if (win && !win.customElements.get(tagName)) {
+      win.customElements.define(tagName, this)
+    }
+  }
 }
+
+export { FEAASElement as Element }

package/src/components/FEAASLoader.tsx

@@ -1,4 +1,4 @@
-import { FEAASBase } from './FEAASBase.js'
+import { FEAASElement } from './FEAASElement.js'
 
 export function FEAASLoaderProps(element: HTMLElement) {
   return {
@@ -8,7 +8,7 @@ export function FEAASLoaderProps(element: HTMLElement) {
 }
 type FEAASLoaderProps = ReturnType<typeof FEAASLoaderProps>
 
-export class FEAASLoader extends FEAASBase<FEAASLoaderProps, string> {
+export class FEAASLoader extends FEAASElement<FEAASLoaderProps, string> {
   stylesheet: HTMLStyleElement
   loader: HTMLDivElement
 

package/src/components/FEAASReactElement.tsx

@@ -0,0 +1,61 @@
+import type { ReactNode, ReactElement, JSXElementConstructor, PropsWithChildren } from 'react'
+import { FEAASElement } from './FEAASElement.js'
+
+export type ReactModules = {
+  React: typeof React
+  ReactDOM: typeof ReactDOM
+}
+export type ReactJSX = ReactNode | ReactElement<any, string | JSXElementConstructor<any>>
+export type FEAASReactRender<P> = {
+  (this: FEAASReactElement<P>, props: P, payload: ReactModules): ReactJSX
+}
+
+export default class FEAASReactElement<P> extends FEAASElement<P, ReactModules> {
+  load() {
+    return Promise.all([
+      // @ts-ignore @webpack-ignore
+      import('https://cdn.skypack.dev/react'),
+      // @ts-ignore
+      import('https://cdn.skypack.dev/react-dom')
+    ]).then(([React, ReactDOM]) => {
+      return { React, ReactDOM }
+    })
+  }
+
+  render({}: P, { React }: ReactModules): ReactJSX {
+    return <></>
+  }
+}
+
+interface MyComponentProps {
+  counter: string
+}
+
+export class MyComponent extends FEAASReactElement<MyComponentProps> {
+  // will re-render component if any of these attributes have changed
+  static observedAttributes = ['counter']
+
+  useShadowRoot = true
+
+  // parse attributes from web component to react-ready form
+  getProps() {
+    return {
+      counter: parseFloat(this.getAttribute('counter'))
+    }
+  }
+
+  // First argument is props, second arguments is React stuff
+  // Destructuring React is important for JSX to work
+  render({ counter }: MyComponentProps, { React }: ReactModules): ReactJSX {
+    const [updates, setUpdates] = React.useState(0)
+    React.useEffect(() => {
+      setUpdates((u) => u + 1)
+    }, [counter])
+    return (
+      <>
+        <p>Rendering attribute: {counter}</p>
+        <p>Triggered updates: {updates}</p>
+      </>
+    )
+  }
+}

package/src/components/FEAASStylesheet.tsx

@@ -1,8 +1,8 @@
 import { DEFAULT_CDN_URL, FEAASCDNStylesheetParams, parseStylesheetSource } from '../cdn.js'
 import { loadStylesheet } from '../dom/stylesheet.js'
-import { FEAASBase } from './FEAASBase.js'
+import { FEAASElement } from './FEAASElement.js'
 
-export function FEAASStylesheetProps(element: FEAASBase) {
+export function FEAASStylesheetProps(element: FEAASElement) {
   const src = element.getAttribute('src')
   if (src) {
     var { cdn, library, revision } = parseStylesheetSource(src)
@@ -15,7 +15,7 @@ export function FEAASStylesheetProps(element: FEAASBase) {
 }
 export type FEAASStylesheetProps = ReturnType<typeof FEAASStylesheetProps>
 
-export class FEAASStylesheet extends FEAASBase<FEAASStylesheetProps, string> {
+export class FEAASStylesheet extends FEAASElement<FEAASStylesheetProps, string> {
   getProps() {
     return FEAASStylesheetProps(this)
   }

package/src/headless.ts

@@ -3,7 +3,7 @@
  * avoid circular dependency. Regular clientside build entry point is in ui/index.ts
  */
 
-import FEAASElement from './components/FEAASElement.js'
+import FEAASReactElement from './components/FEAASReactElement.js'
 
 export * from './dom/rendering.js'
 export * from './dom/data.js'
@@ -11,9 +11,10 @@ export * from './dom/scripts.js'
 export * from './dom/stylesheet.js'
 export * from './dom/component.js'
 export * from './fetch.js'
+export * from './utils/promise.js'
 export * from './cdn.js'
-export * from './components/FEAASBase.js'
 export * from './components/FEAASElement.js'
+export * from './components/FEAASReactElement.js'
 export * from './components/FEAASComponent.js'
 export * from './components/FEAASLoader.js'
 export * from './components/FEAASStylesheet.js'
@@ -23,11 +24,11 @@ export * as Thumbnail from './dom/thumbnail.js'
 declare global {
   interface Window {
     FEAASLoading: Promise<any>
-    FEAASElement: typeof FEAASElement
+    FEAASReactElement: typeof FEAASReactElement
   }
 }
 
 if (typeof window != 'undefined') {
-  window.FEAASElement = FEAASElement
+  window.FEAASReactElement = FEAASReactElement
   window.FEAASLoading ??= Promise.resolve()
 }