@weaverse/hydrogen 5.24.0 → 6.0.0-beta.0

package/src/WeaverseHydrogenRoot.tsx

@@ -28,19 +28,19 @@ import {
 } from './hooks/translation-context'
 import { createWeaverseDataContext } from './hooks/use-weaverse-data-context'
 import type {
-  HydrogenComponentData,
   HydrogenElement,
-  HydrogenPageData,
-  HydrogenThemeSettings,
   TranslationChanges,
   TranslationEntry,
   TranslationItemEntry,
   TranslationMap,
+  WeaverseComponentData,
   WeaverseInternal,
   WeaverseLoaderRequestInfo,
-} from './index'
+  WeaversePageData,
+  WeaverseThemeSettings,
+} from './internal'
 import type {
-  HydrogenComponent,
+  WeaverseComponent,
   WeaverseHydrogenParams,
   WeaverseLoaderData,
 } from './types'
@@ -91,7 +91,7 @@ export class WeaverseHydrogenItem extends WeaverseItemStore {
   private _snapshotTranslationRef: TranslationItemEntry | null = null
 
   /** Creates an item store from serialized component data and its owner. */
-  constructor(initialData: HydrogenComponentData, weaverse: WeaverseHydrogen) {
+  constructor(initialData: WeaverseComponentData, weaverse: WeaverseHydrogen) {
     super(initialData, weaverse)
     const { data, ...rest } = initialData
     if (!this.Element?.schema) {
@@ -231,7 +231,7 @@ export class WeaverseHydrogen extends Weaverse {
   /** Component item store constructor used by the core runtime. */
   declare ItemConstructor: typeof WeaverseHydrogenItem
   /** Current page content owned by the runtime. */
-  declare data: HydrogenPageData
+  declare data: WeaversePageData
   /** Component item stores indexed by instance ID. */
   declare static itemInstances: Map<string, WeaverseHydrogenItem>
   /** Registered component definitions indexed by component type. */
@@ -359,7 +359,7 @@ export class WeaverseHydrogen extends Weaverse {
   /**
    * Override setProjectData to re-extract translation sidecar from new page data.
    */
-  setProjectData = (data: HydrogenPageData) => {
+  setProjectData = (data: WeaversePageData) => {
     this.data = data
     this.extractTranslationSidecar()
     this.initProject()
@@ -371,8 +371,11 @@ function createWeaverseInstance(
 ): WeaverseHydrogen {
   const normalizedParams = normalizeRequestInfo(params)
   if (isBrowser) {
-    window.__weaverses = window.__weaverses || {}
-    const existing = window.__weaverses[normalizedParams.pageId]
+    const runtimeWindow = window as unknown as {
+      __weaverses?: Record<string, WeaverseHydrogen>
+    }
+    runtimeWindow.__weaverses = runtimeWindow.__weaverses || {}
+    const existing = runtimeWindow.__weaverses[normalizedParams.pageId]
     // Reuse the instance only while the browser stays on the same URL —
     // navigation to a different pathname/search builds a fresh instance.
     const isReused =
@@ -382,7 +385,7 @@ function createWeaverseInstance(
     const weaverse = isReused
       ? existing
       : new WeaverseHydrogen(normalizedParams)
-    window.__weaverses[normalizedParams.pageId] = weaverse
+    runtimeWindow.__weaverses[normalizedParams.pageId] = weaverse
     if (weaverse.isDesignMode) {
       weaverse.requestInfo = normalizedParams.requestInfo
       if (hasWeaverseStudio(window)) {
@@ -414,11 +417,11 @@ const StudioConnect = memo(() => {
  * allocates and loops on every render — theme component arrays are
  * module-level constants, so register each list identity once.
  */
-const registeredComponentLists = new WeakSet<HydrogenComponent[]>()
+const registeredComponentLists = new WeakSet<WeaverseComponent[]>()
 
 function RenderRoot(props: {
   data: WeaverseLoaderData
-  components: HydrogenComponent[]
+  components: WeaverseComponent[]
   dataContext?: Record<string, any>
 }) {
   const { data, components, dataContext } = props
@@ -488,7 +491,7 @@ export interface WeaverseHydrogenRootErrorProps {
 /** Props accepted by {@link WeaverseHydrogenRoot}. */
 export interface WeaverseHydrogenRootProps {
   /** Theme components available to the page renderer. */
-  components: HydrogenComponent[]
+  components: WeaverseComponent[]
   /**
    * Optional explicit `weaverseData` payload. When provided, bypasses the
    * automatic route-scoped resolution. Accepts a resolved value, a
@@ -686,7 +689,7 @@ function useTranslationData(): {
  * }
  * ```
  */
-export function useThemeSettings<T = HydrogenThemeSettings>() {
+export function useThemeSettings<T = WeaverseThemeSettings>() {
   const themeSettingsStore = useThemeSettingsStore()
   const settings = useSafeExternalStore(
     themeSettingsStore.subscribe,

package/src/components/index.ts

@@ -1,8 +1,8 @@
-import type { HydrogenComponent } from '../types'
+import type { WeaverseComponent } from '../types'
 import MainComponent, { schema as mainSchema } from './main'
 
 /** Built-in components required to render the root of every Weaverse page. */
-export let defaultComponents: HydrogenComponent[] = [
+export let defaultComponents: WeaverseComponent[] = [
   {
     default: MainComponent,
     schema: mainSchema,

package/src/components/main.tsx

@@ -1,12 +1,12 @@
 import { createSchema, type SchemaType } from '@weaverse/schema'
 import type { HTMLAttributes } from 'react'
-import type { HydrogenComponentProps } from '../types'
+import type { WeaverseComponentProps } from '../types'
 
 /*
   Main is the default Weaverse component that is used to render the main content.
   This component wraps all the sections/components inside a Weaverse page.
 */
-function Main(props: HydrogenComponentProps & HTMLAttributes<HTMLDivElement>) {
+function Main(props: WeaverseComponentProps & HTMLAttributes<HTMLDivElement>) {
   let { children, dangerouslySetInnerHTML, ...rest } = props
 
   return (

package/src/hooks/translation-context.tsx

@@ -1,35 +1,10 @@
 import { useSafeExternalStore } from '@weaverse/react'
 import { createContext, type ReactNode, useContext, useMemo } from 'react'
-import type { TranslationStore } from '../utils/translation-store'
-
-/**
- * Traverse a nested object by dot-path.
- *
- * @example
- * getNestedKey({ cart: { title: 'Cart' } }, 'cart.title') // => 'Cart'
- * getNestedKey({}, 'cart.title', 'fallback')              // => 'fallback'
- */
-export function getNestedKey(
-  obj: Record<string, unknown>,
-  path: string,
-  fallback?: string
-): string | undefined {
-  const keys = path.split('.')
-  let current: unknown = obj
+import { getNestedKey } from '../utils/nested-key'
 
-  for (const key of keys) {
-    if (current == null || typeof current !== 'object') {
-      return fallback
-    }
-    current = (current as Record<string, unknown>)[key]
-  }
-
-  if (typeof current === 'string') {
-    return current
-  }
+export { getNestedKey }
 
-  return fallback
-}
+import type { TranslationStore } from '../utils/translation-store'
 
 /**
  * Replace `{{variable}}` patterns in a string with provided values.

package/src/index.ts

@@ -1,88 +1,49 @@
 /**
- * React and React Router integrations for rendering Weaverse content in
- * Shopify Hydrogen storefronts.
+ * Framework-independent core of the Weaverse SDK for Hydrogen storefronts:
+ * component and theme schemas, data helpers, translations and shared types.
  *
- * @packageDocumentation
- */
-
-import { getSelectedProductOptions as hydrogen_getSelectedProductOptions } from '@shopify/hydrogen'
-import type { SelectedOptionInput } from '@shopify/hydrogen/storefront-api-types'
-import {
-  isBrowser,
-  isIframe,
-  useChildInstances,
-  useItemInstance,
-  useParentInstance,
-  useWeaverse,
-} from '@weaverse/react'
-
-/**
- * Filter out Weaverse-specific query parameters from product options.
- * Removes `isDesignMode` and any parameters starting with `weaverse` prefix.
- *
- * @param request - The incoming HTTP request
- * @returns Filtered product options for Shopify Hydrogen
+ * Themes import from their framework's entry, such as
+ * `@weaverse/hydrogen/react-router`, which re-exports this core.
  *
- * @example
- * ```typescript
- * export async function loader({ request }: LoaderFunctionArgs) {
- *   const selectedOptions = getSelectedProductOptions(request)
- *   // Use selectedOptions for product queries without Weaverse params
- * }
- * ```
+ * @packageDocumentation
  */
-export function getSelectedProductOptions(
-  request: Request
-): SelectedOptionInput[] {
-  let options = hydrogen_getSelectedProductOptions(request)
-  return options.filter(
-    ({ name }) => name !== 'isDesignMode' && !name.startsWith('weaverse')
-  )
-}
 
-// Re-export all types and utilities from schema package
-export * from '@weaverse/schema'
-export * from './components'
-export {
-  getNestedKey,
-  interpolate,
-  // Deprecated aliases — kept for backward compatibility.
-  ThemeTextProvider,
-  type ThemeTextProviderProps,
-  type ThemeTextValue,
-  type TranslateFunction,
-  // Canonical translation API.
-  TranslationProvider,
-  type TranslationProviderProps,
-  type TranslationValue,
-  useThemeText,
-  useTranslation,
-} from './hooks/translation-context'
-// Export Hydrogen-specific hooks
+export { isBrowser, isIframe } from '@weaverse/react'
 export {
-  createWeaverseDataContext,
-  type RouteKeyedDataContext,
-  useWeaverseDataContext,
-  type WeaverseDataContext,
-} from './hooks/use-weaverse-data-context'
-// Export hydrogen-specific modules
-export * from './seo'
-export * from './types'
-export * from './utils'
-export type { WeaverseDataValue } from './utils/pick-weaverse-data'
-export { ThemeTextStore, TranslationStore } from './utils/translation-store'
-export type {
-  ThemeSettingsStore,
-  WeaverseThemeData,
-} from './utils/use-theme-settings-store'
-export * from './WeaverseHydrogenRoot'
-export * from './weaverse-client'
-// Re-export utilities from @weaverse/react
+  type BasicInput,
+  createSchema,
+  IMAGES_PLACEHOLDERS,
+  type InspectorGroup,
+  type PageType,
+  type SchemaType,
+} from '@weaverse/schema'
+export type { TranslateFunction } from './hooks/translation-context'
 export {
-  isBrowser,
-  isIframe,
-  useChildInstances,
-  useItemInstance,
-  useParentInstance,
-  useWeaverse,
-}
+  type ComponentDataValue,
+  type PublicEnv,
+  type WeaverseBlog,
+  type WeaverseChildComponentReference,
+  type WeaverseCollection,
+  type WeaverseComponentData,
+  type WeaverseComponentSchema,
+  WeaverseError,
+  type WeaverseI18n,
+  type WeaverseImage,
+  WeaverseLoadError,
+  type WeaverseLoaderData,
+  type WeaverseLoaderRequestInfo,
+  type WeaverseLoadFailureKind,
+  type WeaverseMetaObject,
+  type WeaversePageAssignment,
+  type WeaversePageData,
+  type WeaverseProduct,
+  type WeaverseProjectConfigs,
+  type WeaverseProjectType,
+  type WeaverseThemeSchema,
+  type WeaverseThemeSettings,
+  type WeaverseThemeSettingsResponse,
+  type WeaverseVideo,
+} from './types'
+export { generateDataFromSchema } from './utils'
+export { getNestedKey } from './utils/nested-key'
+export { TranslationStore } from './utils/translation-store'

package/src/internal.ts

@@ -0,0 +1,64 @@
+/**
+ * Internal surface of `@weaverse/hydrogen` for Weaverse's own tools (Builder,
+ * CLI). Undocumented and not covered by semver: themes import from
+ * `@weaverse/hydrogen/react-router` instead.
+ *
+ * @packageDocumentation
+ */
+
+import {
+  isBrowser,
+  isIframe,
+  useChildInstances,
+  useItemInstance,
+  useParentInstance,
+  useWeaverse,
+} from '@weaverse/react'
+
+// Re-export all types and utilities from schema package
+export * from '@weaverse/schema'
+export * from './components'
+export {
+  interpolate,
+  // Deprecated aliases — kept for backward compatibility.
+  ThemeTextProvider,
+  type ThemeTextProviderProps,
+  type ThemeTextValue,
+  type TranslateFunction,
+  // Canonical translation API.
+  TranslationProvider,
+  type TranslationProviderProps,
+  type TranslationValue,
+  useThemeText,
+  useTranslation,
+} from './hooks/translation-context'
+// Export Hydrogen-specific hooks
+export {
+  createWeaverseDataContext,
+  type RouteKeyedDataContext,
+  useWeaverseDataContext,
+  type WeaverseDataContext,
+} from './hooks/use-weaverse-data-context'
+// Export hydrogen-specific modules
+export * from './seo'
+export * from './types'
+export * from './utils'
+export { getNestedKey } from './utils/nested-key'
+export type { WeaverseDataValue } from './utils/pick-weaverse-data'
+export { getSelectedProductOptions } from './utils/product-options'
+export { ThemeTextStore, TranslationStore } from './utils/translation-store'
+export type {
+  ThemeSettingsStore,
+  WeaverseThemeData,
+} from './utils/use-theme-settings-store'
+export * from './WeaverseHydrogenRoot'
+export * from './weaverse-client'
+// Re-export utilities from @weaverse/react
+export {
+  isBrowser,
+  isIframe,
+  useChildInstances,
+  useItemInstance,
+  useParentInstance,
+  useWeaverse,
+}

package/src/next-server.ts

@@ -0,0 +1,13 @@
+/**
+ * Server-only part of the Next.js adapter: the server client that loads pages
+ * and theme settings, and the revalidation route handler.
+ *
+ * @packageDocumentation
+ */
+
+export {
+  createWeaverseNextRevalidateHandler,
+  createWeaverseNextServerClient,
+  type WeaverseNextServerClient,
+  type WeaverseNextThemeSettingsResponse,
+} from '@weaverse/next/server'

package/src/next.ts

@@ -0,0 +1,35 @@
+/**
+ * Next.js App Router adapter of the Weaverse SDK: the client factory, root and
+ * page providers, renderer and Studio connection. Re-exports the core and the
+ * React bindings, so a Next.js storefront imports client and shared code from
+ * this entry and server-only code from `@weaverse/hydrogen/next/server`.
+ *
+ * @packageDocumentation
+ */
+
+// Hooks and stores come from the Next adapter itself so they share its React
+// contexts; these named exports take precedence over the star re-exports.
+export {
+  buildWeaverseNextRequestInfo,
+  createWeaverseNextClient,
+  TranslationProvider,
+  TranslationStore,
+  useChildInstances,
+  useItemInstance,
+  useParentInstance,
+  useThemeSettings,
+  useTranslation,
+  useWeaverse,
+  type WeaverseNextComponent,
+  type WeaverseNextI18n,
+  type WeaverseNextLoaderData,
+  WeaverseNextProvider,
+  WeaverseNextRenderer,
+  type WeaverseNextRequestContext,
+  WeaverseNextRootProvider,
+  WeaverseNextStudioConnect,
+  type WeaverseNextThemeSchema,
+  type WeaverseNextThemeSchemaGroup,
+} from '@weaverse/next'
+export * from './index'
+export * from './react'

package/src/react-router.ts

@@ -0,0 +1,52 @@
+/**
+ * React Router adapter of the Weaverse SDK for Hydrogen 2026.10+ storefronts:
+ * the request-scoped client, root rendering, Studio connection, SEO and
+ * commerce helpers. Re-exports the core and the React bindings, so a theme
+ * imports everything from this entry.
+ *
+ * @packageDocumentation
+ */
+
+export {
+  TranslationProvider,
+  type TranslationProviderProps,
+  type TranslationValue,
+  useTranslation,
+} from './hooks/translation-context'
+export * from './index'
+export * from './react'
+export {
+  getWeaverseSeoMeta,
+  type WeaverseSeoInput,
+  type WeaverseSeoPageContainer,
+} from './seo'
+export type {
+  CustomPageEntry,
+  FetchProjectRequestBody,
+  LoadPageParams,
+  ProjectIdValue,
+  RouteLoaderArgs,
+  WeaverseClientArgs,
+  WeaverseComponent,
+  WeaverseComponentLoaderArgs,
+  WeaverseEnv,
+  WeaverseRouteAppLoadContext,
+  WeaverseStorefront,
+  WeaverseStorefrontCallOptions,
+} from './types'
+export type { WeaverseDataValue } from './utils/pick-weaverse-data'
+export { getSelectedProductOptions } from './utils/product-options'
+export {
+  useThemeSettings,
+  WeaverseHydrogenRoot,
+  type WeaverseHydrogenRootErrorProps,
+  type WeaverseHydrogenRootProps,
+  type WithWeaverseOptions,
+  withWeaverse,
+} from './WeaverseHydrogenRoot'
+export {
+  type BuilderApiCacheTarget,
+  type FetchCustomPagesOptions,
+  WeaverseClient,
+  type WeaverseFetchWithCacheOptions,
+} from './weaverse-client'

package/src/react.ts

@@ -0,0 +1,16 @@
+/**
+ * React bindings of the Weaverse SDK that work in any React framework.
+ *
+ * Themes import from their framework's entry, such as
+ * `@weaverse/hydrogen/react-router`, which re-exports these bindings.
+ *
+ * @packageDocumentation
+ */
+
+export {
+  useChildInstances,
+  useItemInstance,
+  useParentInstance,
+  useWeaverse,
+} from '@weaverse/react'
+export type { WeaverseComponentProps } from './types'

package/src/seo.ts

@@ -1,17 +1,17 @@
 import type { PageSEOData } from '@weaverse/schema'
 import type { MetaDescriptor } from 'react-router'
-import type { HydrogenPageData, WeaverseLoaderData } from './types'
+import type { WeaverseLoaderData, WeaversePageData } from './types'
 
 /** Object containing an optional Weaverse page for SEO extraction. */
 export interface WeaverseSeoPageContainer {
   /** Page whose published SEO fields should be formatted. */
-  page?: HydrogenPageData | null
+  page?: WeaversePageData | null
 }
 
 /** Input accepted by {@link getWeaverseSeoMeta}. */
 export type WeaverseSeoInput =
   | WeaverseLoaderData
-  | HydrogenPageData
+  | WeaversePageData
   | WeaverseSeoPageContainer
   | null
   | undefined
@@ -104,7 +104,7 @@ export function formatMetaDescriptors(
 
 /**
  * Convenience accessor: pull `page.seo` out of a `WeaverseLoaderData`
- * (or `HydrogenPageData`) and emit `MetaDescriptor[]`. Null-safe.
+ * (or `WeaversePageData`) and emit `MetaDescriptor[]`. Null-safe.
  *
  * @example
  * ```ts
@@ -119,7 +119,7 @@ export function getWeaverseSeoMeta(data: WeaverseSeoInput): MetaDescriptor[] {
   }
   let page =
     'items' in data && 'id' in data
-      ? (data as HydrogenPageData)
+      ? (data as WeaversePageData)
       : ((data as WeaverseSeoPageContainer).page ?? null)
   return formatMetaDescriptors(page?.seo ?? null)
 }