Skip to main content

API Reference

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

SDK Packages

@weaverse/hydrogen

The primary package for Shopify Hydrogen applications. 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/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

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.

Getting Help