@nous-research/ui 0.14.2 → 0.16.0

package/src/assets.d.ts

@@ -0,0 +1,38 @@
+interface StaticImageData {
+  src: string
+  height: number
+  width: number
+  blurDataURL?: string
+  blurWidth?: number
+  blurHeight?: number
+}
+
+declare module '*.jpg' {
+  const content: StaticImageData
+  export default content
+}
+
+declare module '*.jpeg' {
+  const content: StaticImageData
+  export default content
+}
+
+declare module '*.png' {
+  const content: StaticImageData
+  export default content
+}
+
+declare module '*.svg' {
+  const content: StaticImageData
+  export default content
+}
+
+declare module '*.gif' {
+  const content: StaticImageData
+  export default content
+}
+
+declare module '*.webp' {
+  const content: StaticImageData
+  export default content
+}

package/src/fonts.ts

@@ -0,0 +1,6 @@
+/** CSS variable names for the design language fonts. Set automatically by fonts.css. */
+export const FONT_SANS = '--font-sans'
+export const FONT_MONO = '--font-mono'
+export const FONT_RULES_COMPRESSED = '--font-rules-compressed'
+export const FONT_RULES_EXPANDED = '--font-rules-expanded'
+export const FONT_MONDWEST = '--font-mondwest'

package/src/hooks/use-capped-frame.ts

@@ -0,0 +1,18 @@
+'use client'
+
+import { useFrame, useThree } from '@react-three/fiber'
+import type { RenderCallback } from '@react-three/fiber'
+import { useRef } from 'react'
+
+export function useCappedFrame(cb: RenderCallback, max?: number) {
+  const last = useRef(performance.now())
+  const { size } = useThree()
+  const interval = 1e3 / (max ?? (size.width < 1024 ? 60 : 120))
+
+  useFrame((st, delta) => {
+    if (performance.now() - last.current > interval) {
+      last.current = performance.now()
+      cb(st, delta)
+    }
+  })
+}

package/src/hooks/use-css-var-dims.ts

@@ -0,0 +1,39 @@
+'use client'
+
+import { useEffect } from 'react'
+
+export function useCssVarDims(
+  name: string,
+  ref: React.RefObject<HTMLElement | null>
+) {
+  useEffect(() => {
+    if (!ref.current) {
+      return
+    }
+
+    const update = (width: number, height: number) => {
+      document.documentElement.style.setProperty(
+        `--${name}-width`,
+        `${width}px`
+      )
+
+      document.documentElement.style.setProperty(
+        `--${name}-height`,
+        `${height}px`
+      )
+    }
+
+    const { height, width } = ref.current.getBoundingClientRect()
+    update(width, height)
+
+    const ro = new ResizeObserver(entries => {
+      for (const entry of entries) {
+        update(entry.contentRect.width, entry.contentRect.height)
+      }
+    })
+
+    ro.observe(ref.current)
+
+    return () => ro.disconnect()
+  }, [name, ref])
+}

package/src/hooks/use-gpu-tier.ts

@@ -0,0 +1,165 @@
+'use client'
+
+import { useStore } from '@nanostores/react'
+import { atom } from 'nanostores'
+
+/**
+ * Tiers:
+ *  0 — no WebGL / software renderer / prefers-reduced-motion / WebGL ctx creation failed
+ *  1 — low-end GPU (integrated, mobile, or failed perf benchmark)
+ *  2 — capable GPU (discrete / high-end integrated)
+ *
+ * Detection runs **synchronously** the first time this module is evaluated
+ * on the client (see the IIFE at the bottom of the file). That means any
+ * consumer reading `$gpuTier` during its first render already sees the
+ * post-detection value, so WebGL components can avoid trying to create a
+ * `THREE.WebGLRenderer` on hardware where context creation will fail.
+ *
+ * The previous version ran the probe inside `nanostores`'s `onMount`
+ * lifecycle, which fires from a microtask after the first listener
+ * subscribes — i.e. after the first React commit. By that point overlay
+ * components had already executed `new THREE.WebGLRenderer(...)` against
+ * the optimistic default, logged `Error creating WebGL context`, and only
+ * unmounted on a follow-up render. Eager module-load detection closes that
+ * race.
+ */
+export const $gpuTier = atom<GpuTier>(2)
+
+const SOFTWARE_PATTERNS =
+  /swiftshader|llvmpipe|softpipe|software|microsoft basic/i
+
+const LOW_END_PATTERNS =
+  /intel.*hd|intel.*uhd|intel.*iris|mali|adreno\s?[1-5]|powervr|apple gpu/i
+
+let detected = false
+
+function detectGpuTier() {
+  if (detected || typeof window === 'undefined') {
+    return
+  }
+
+  detected = true
+
+  if (window.matchMedia('(prefers-reduced-motion: reduce)').matches) {
+    $gpuTier.set(0)
+
+    return
+  }
+
+  let gl: null | WebGLRenderingContext = null
+
+  try {
+    const canvas = document.createElement('canvas')
+    gl = (canvas.getContext('webgl') ||
+      canvas.getContext('experimental-webgl')) as null | WebGLRenderingContext
+  } catch {
+    // Some sandboxed / hardened contexts throw on getContext rather than
+    // returning null (e.g. certain corporate browser policies). Treat as
+    // "no WebGL available".
+    $gpuTier.set(0)
+
+    return
+  }
+
+  if (!gl) {
+    $gpuTier.set(0)
+
+    return
+  }
+
+  const ext = gl.getExtension('WEBGL_debug_renderer_info')
+  const renderer = String(
+    ext
+      ? gl.getParameter(ext.UNMASKED_RENDERER_WEBGL)
+      : gl.getParameter(gl.RENDERER)
+  )
+
+  if (SOFTWARE_PATTERNS.test(renderer)) {
+    $gpuTier.set(0)
+    gl.getExtension('WEBGL_lose_context')?.loseContext()
+
+    return
+  }
+
+  if (LOW_END_PATTERNS.test(renderer)) {
+    $gpuTier.set(1)
+    gl.getExtension('WEBGL_lose_context')?.loseContext()
+
+    return
+  }
+
+  $gpuTier.set(2)
+
+  runBenchmark(gl)
+    .then(fps => $gpuTier.set(fps < 30 ? 1 : 2))
+    .catch(() => $gpuTier.set(1))
+    .finally(() => gl?.getExtension('WEBGL_lose_context')?.loseContext())
+}
+
+if (typeof window !== 'undefined') {
+  detectGpuTier()
+}
+
+function runBenchmark(gl: WebGLRenderingContext): Promise<number> {
+  return new Promise(resolve => {
+    const vs = gl.createShader(gl.VERTEX_SHADER)!
+    const fs = gl.createShader(gl.FRAGMENT_SHADER)!
+    gl.shaderSource(
+      vs,
+      'attribute vec2 a;void main(){gl_Position=vec4(a,0,1);}'
+    )
+    gl.shaderSource(
+      fs,
+      'precision highp float;uniform float t;void main(){float v=0.;for(int i=0;i<64;i++)v+=sin(float(i)*t*.01);gl_FragColor=vec4(v*.001);}'
+    )
+    gl.compileShader(vs)
+    gl.compileShader(fs)
+
+    const prog = gl.createProgram()!
+    gl.attachShader(prog, vs)
+    gl.attachShader(prog, fs)
+    gl.linkProgram(prog)
+    gl.useProgram(prog)
+
+    const buf = gl.createBuffer()
+    gl.bindBuffer(gl.ARRAY_BUFFER, buf)
+    gl.bufferData(
+      gl.ARRAY_BUFFER,
+      new Float32Array([-1, -1, 1, -1, -1, 1, 1, 1]),
+      gl.STATIC_DRAW
+    )
+    const a = gl.getAttribLocation(prog, 'a')
+    gl.enableVertexAttribArray(a)
+    gl.vertexAttribPointer(a, 2, gl.FLOAT, false, 0, 0)
+
+    const uT = gl.getUniformLocation(prog, 't')
+    let frames = 0
+    const start = performance.now()
+
+    const tick = () => {
+      gl.uniform1f(uT, frames)
+      gl.drawArrays(gl.TRIANGLE_STRIP, 0, 4)
+      gl.finish()
+      frames++
+
+      if (performance.now() - start < 200) {
+        requestAnimationFrame(tick)
+      } else {
+        const elapsed = performance.now() - start
+        gl.deleteProgram(prog)
+        gl.deleteShader(vs)
+        gl.deleteShader(fs)
+        gl.deleteBuffer(buf)
+        resolve((frames / elapsed) * 1000)
+      }
+    }
+
+    requestAnimationFrame(tick)
+  })
+}
+
+export function useGpuTier() {
+  return useStore($gpuTier)
+}
+
+type GpuTier = 0 | 1 | 2

package/src/hooks/use-render-loop.ts

@@ -0,0 +1,121 @@
+'use client'
+
+/**
+ * Visibility- and intersection-aware render-loop helper for the WebGL
+ * overlays.
+ *
+ * The overlays were previously running fragment shaders at 60fps for the
+ * entire lifetime of the page — including when the tab was hidden, the
+ * canvas had been scrolled out of view, or the user had been idle for
+ * hours. On retina laptops the compositor cost of mix-blend-mode on a
+ * full-viewport canvas plus continuous WebGL rasterisation is enough to
+ * keep the GPU hot indefinitely, which is what manifests as "fans go
+ * crazy after 2 hours of idle".
+ *
+ * `runRenderLoop` wraps a frame callback so that it:
+ *
+ *   1. Pauses entirely when `document.hidden` is true (background tab,
+ *      minimised window, screen locked).
+ *   2. Pauses when the canvas's bounding rect is offscreen (we tell
+ *      `IntersectionObserver` to look at the canvas itself).
+ *   3. Optionally caps the frame rate via a min-interval — the previous
+ *      `gpuTier === 1 ? setTimeout(loop, 100) : raf` trick is preserved
+ *      and extended so even tier-2 GPUs cap at e.g. 30fps for overlays
+ *      that don't need 60.
+ *
+ * The callback receives the *delta* time in seconds since the last call
+ * (so `uTime` advances correctly across pauses without ever skipping
+ * forward by hours).
+ */
+
+interface RunRenderLoopOptions {
+  /** Element to observe with IntersectionObserver. When fully out of
+   *  view, the loop pauses. Pass the canvas element itself. */
+  el: Element
+  /** Min ms between frames. 0 = no cap (uses requestAnimationFrame).
+   *  Anything > 0 uses setTimeout-driven scheduling. */
+  minIntervalMs?: number
+  /** Frame callback. Receives the elapsed seconds since the previous
+   *  *executed* frame (not since the previous scheduled frame), so
+   *  uniforms keyed off this value will not jump after a long pause. */
+  onFrame: (deltaSeconds: number) => void
+}
+
+export function runRenderLoop({
+  el,
+  minIntervalMs = 0,
+  onFrame
+}: RunRenderLoopOptions) {
+  let running = true
+  let visible = !document.hidden
+  let inView = true
+  let last = performance.now()
+  let raf = 0
+  let timer: ReturnType<typeof setTimeout> | undefined
+
+  const onVisibility = () => {
+    visible = !document.hidden
+
+    // When we come back from a hidden tab, reset the clock so the next
+    // frame's delta is ~one frame, not "hours since I was hidden".
+    if (visible) {
+      last = performance.now()
+      schedule()
+    }
+  }
+
+  const io = new IntersectionObserver(
+    entries => {
+      const wasInView = inView
+      inView = entries.some(e => e.isIntersecting)
+
+      if (!wasInView && inView) {
+        last = performance.now()
+        schedule()
+      }
+    },
+    { threshold: 0 }
+  )
+
+  io.observe(el)
+  document.addEventListener('visibilitychange', onVisibility)
+
+  const tick = () => {
+    if (!running) return
+
+    if (!visible || !inView) {
+      // Don't reschedule — we'll be re-kicked by visibilitychange or IO.
+      return
+    }
+
+    const now = performance.now()
+    const delta = (now - last) / 1000
+    last = now
+
+    onFrame(delta)
+    schedule()
+  }
+
+  function schedule() {
+    if (!running || !visible || !inView) return
+
+    if (minIntervalMs > 0) {
+      timer = setTimeout(tick, minIntervalMs)
+    } else {
+      raf = requestAnimationFrame(tick)
+    }
+  }
+
+  schedule()
+
+  return () => {
+    running = false
+    io.disconnect()
+    document.removeEventListener('visibilitychange', onVisibility)
+    cancelAnimationFrame(raf)
+
+    if (timer !== undefined) {
+      clearTimeout(timer)
+    }
+  }
+}