API Reference

The Weaverse SDK provides the runtime, React bindings, framework integrations, and schema utilities used to build Weaverse-powered storefronts.

SDK Packages

`@weaverse/hydrogen`

The adapter for Hydrogen storefronts on React Router. It includes:

WeaverseClient for server-side page and theme loading
WeaverseHydrogenRoot for page rendering
Hydrogen hooks, component types, and utilities
Re-exports from @weaverse/react and @weaverse/schema

`@weaverse/next`

The package for Next.js App Router storefronts. It includes:

createWeaverseNextServerClient (from @weaverse/next/server) for request-scoped page and theme loading
WeaverseNextRenderer, WeaverseNextProvider, and WeaverseNextRootProvider for rendering
Studio connection, per-item revalidation, and translation utilities
Re-exports from @weaverse/react and @weaverse/schema

See the Next.js API reference.

`@weaverse/react`

React bindings shared by framework integrations, including runtime contexts, hooks, and the lower-level WeaverseRoot renderer.

`@weaverse/core`

Framework-independent runtime classes, item stores, events, and core data types.

`@weaverse/schema`

Schema definitions, Studio input types, availability types, and validation utilities.

Basic Usage

import {
  WeaverseHydrogenRoot,
  useWeaverse,
  type WeaverseHydrogen,
} from '@weaverse/hydrogen'
import { components } from '~/weaverse/components'

export function WeaversePage() {
  return <WeaverseHydrogenRoot components={components} />
}

export function RuntimeInfo() {
  const weaverse = useWeaverse<WeaverseHydrogen>()

  return <span>{weaverse.data.name}</span>
}

API Categories

Hooks

Access the Weaverse runtime, item stores, child instances, parent instances, and theme settings.

Components

Render Weaverse pages and initialize Hydrogen root providers.

Client

Load page data, theme settings, and custom page metadata on the server.

Types and Utilities

Reference public TypeScript contracts and helper functions.

Overview

Hooks

Components

Utilities & Types

Introduction

API Reference

SDK Packages

`@weaverse/hydrogen`

`@weaverse/next`

`@weaverse/react`

`@weaverse/core`

`@weaverse/schema`

Basic Usage

API Categories

Hooks

Components

Client

Types and Utilities

Getting Help

​API Reference

​SDK Packages

​@weaverse/hydrogen

​@weaverse/next

​@weaverse/react

​@weaverse/core

​@weaverse/schema

​Basic Usage

​API Categories

Hooks

Components

Client

Types and Utilities

​Getting Help

API Reference

SDK Packages

`@weaverse/hydrogen`

`@weaverse/next`

`@weaverse/react`

`@weaverse/core`

`@weaverse/schema`

Basic Usage

API Categories

Getting Help