@weaverse/next 0.1.0-alpha.9 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (106) hide show
  1. package/README.md +155 -73
  2. package/dist/{chunk-6PMZ77RA.mjs → chunk-LH6AAEIK.mjs} +115 -8
  3. package/dist/chunk-LH6AAEIK.mjs.map +1 -0
  4. package/dist/index.js +180 -32
  5. package/dist/index.js.map +1 -1
  6. package/dist/index.mjs +86 -47
  7. package/dist/index.mjs.map +1 -1
  8. package/dist/server.js +321 -91
  9. package/dist/server.js.map +1 -1
  10. package/dist/server.mjs +205 -28
  11. package/dist/server.mjs.map +1 -1
  12. package/dist/types/client.d.ts +16 -0
  13. package/dist/types/client.d.ts.map +1 -0
  14. package/dist/types/hooks.d.ts +20 -0
  15. package/dist/types/hooks.d.ts.map +1 -0
  16. package/dist/types/index.d.ts +34 -0
  17. package/dist/types/index.d.ts.map +1 -0
  18. package/dist/types/item.d.ts +60 -0
  19. package/dist/types/item.d.ts.map +1 -0
  20. package/dist/types/loader.d.ts +25 -0
  21. package/dist/types/loader.d.ts.map +1 -0
  22. package/dist/types/main.d.ts +11 -0
  23. package/dist/types/main.d.ts.map +1 -0
  24. package/dist/types/provider.d.ts +82 -0
  25. package/dist/types/provider.d.ts.map +1 -0
  26. package/dist/types/registry.d.ts +15 -0
  27. package/dist/types/registry.d.ts.map +1 -0
  28. package/dist/types/renderer.d.ts +21 -0
  29. package/dist/types/renderer.d.ts.map +1 -0
  30. package/dist/types/request-info.d.ts +19 -0
  31. package/dist/types/request-info.d.ts.map +1 -0
  32. package/dist/types/revalidate-item.d.ts +82 -0
  33. package/dist/types/revalidate-item.d.ts.map +1 -0
  34. package/dist/types/root-provider.d.ts +62 -0
  35. package/dist/types/root-provider.d.ts.map +1 -0
  36. package/dist/types/runtime.d.ts +113 -0
  37. package/dist/types/runtime.d.ts.map +1 -0
  38. package/dist/types/seo.d.ts +55 -0
  39. package/dist/types/seo.d.ts.map +1 -0
  40. package/dist/types/server/configs.d.ts +27 -0
  41. package/dist/types/server/configs.d.ts.map +1 -0
  42. package/dist/types/server/normalize-page-url.d.ts +19 -0
  43. package/dist/types/server/normalize-page-url.d.ts.map +1 -0
  44. package/dist/types/server/revalidate-handler.d.ts +55 -0
  45. package/dist/types/server/revalidate-handler.d.ts.map +1 -0
  46. package/dist/types/server/server-client.d.ts +21 -0
  47. package/dist/types/server/server-client.d.ts.map +1 -0
  48. package/dist/types/server.d.ts +19 -0
  49. package/dist/types/server.d.ts.map +1 -0
  50. package/dist/types/studio-bridge.d.ts +16 -0
  51. package/dist/types/studio-bridge.d.ts.map +1 -0
  52. package/dist/types/studio-connect.d.ts +27 -0
  53. package/dist/types/studio-connect.d.ts.map +1 -0
  54. package/dist/types/studio-router.d.ts +50 -0
  55. package/dist/types/studio-router.d.ts.map +1 -0
  56. package/dist/types/studio-script-src.d.ts +12 -0
  57. package/dist/types/studio-script-src.d.ts.map +1 -0
  58. package/dist/types/theme-settings-store.d.ts +18 -0
  59. package/dist/types/theme-settings-store.d.ts.map +1 -0
  60. package/dist/types/translation-context.d.ts +156 -0
  61. package/dist/types/translation-context.d.ts.map +1 -0
  62. package/dist/types/translation-store.d.ts +44 -0
  63. package/dist/types/translation-store.d.ts.map +1 -0
  64. package/dist/types/types.d.ts +665 -0
  65. package/dist/types/types.d.ts.map +1 -0
  66. package/dist/types/use-weaverse-next-studio.d.ts +34 -0
  67. package/dist/types/use-weaverse-next-studio.d.ts.map +1 -0
  68. package/dist/types/utils.d.ts +12 -0
  69. package/dist/types/utils.d.ts.map +1 -0
  70. package/package.json +12 -8
  71. package/src/client.ts +102 -0
  72. package/src/hooks.ts +50 -0
  73. package/src/index.ts +153 -0
  74. package/src/item.ts +167 -0
  75. package/src/loader.ts +135 -0
  76. package/src/main.tsx +45 -0
  77. package/src/provider.tsx +225 -0
  78. package/src/registry.ts +63 -0
  79. package/src/renderer.tsx +100 -0
  80. package/src/request-info.ts +124 -0
  81. package/src/revalidate-item.ts +211 -0
  82. package/src/root-provider.tsx +182 -0
  83. package/src/runtime.ts +555 -0
  84. package/src/seo.ts +157 -0
  85. package/src/server/configs.ts +178 -0
  86. package/src/server/normalize-page-url.ts +73 -0
  87. package/src/server/revalidate-handler.ts +357 -0
  88. package/src/server/server-client.ts +728 -0
  89. package/src/server.ts +67 -0
  90. package/src/studio-bridge.tsx +82 -0
  91. package/src/studio-connect.tsx +88 -0
  92. package/src/studio-router.ts +85 -0
  93. package/src/studio-script-src.ts +128 -0
  94. package/src/theme-settings-store.ts +47 -0
  95. package/src/translation-context.tsx +299 -0
  96. package/src/translation-store.ts +69 -0
  97. package/src/types.ts +753 -0
  98. package/src/use-weaverse-next-studio.tsx +106 -0
  99. package/src/utils.ts +37 -0
  100. package/dist/chunk-6PMZ77RA.mjs.map +0 -1
  101. package/dist/index.d.mts +0 -580
  102. package/dist/index.d.ts +0 -580
  103. package/dist/seo-Dos9t22_.d.mts +0 -477
  104. package/dist/seo-Dos9t22_.d.ts +0 -477
  105. package/dist/server.d.mts +0 -99
  106. package/dist/server.d.ts +0 -99
package/dist/index.d.ts DELETED
@@ -1,580 +0,0 @@
1
- import { WeaverseItemStore, Weaverse, ElementData } from '@weaverse/react';
2
- export { isBrowser, isIframe, useChildInstances, useItemInstance, useParentInstance, useWeaverse } from '@weaverse/react';
3
- export { InspectorGroup, PageType, SchemaType, createSchema } from '@weaverse/schema';
4
- import { h as WeaverseNextClientConfig, g as WeaverseNextClient, i as WeaverseNextCommerceContext, x as WeaverseNextRequestContext, t as WeaverseNextLoaderData, a as TranslationStore, y as WeaverseNextRequestInfo, k as WeaverseNextComponentData, I as WeaverseNextThemeSettingsStore, A as WeaverseNextRuntimeInternal, M as WeaverseNextTranslationMap, v as WeaverseNextPageData, z as WeaverseNextRuntimeConfig, J as WeaverseNextTranslationChanges } from './seo-Dos9t22_.js';
5
- export { T as ThemeTextStore, W as WeaverseArticle, b as WeaverseBlog, c as WeaverseCollection, d as WeaverseMetaObject, j as WeaverseNextComponent, l as WeaverseNextComponentLoaderArgs, m as WeaverseNextComponentProps, o as WeaverseNextCustomPageEntry, p as WeaverseNextFetchCustomPagesOptions, r as WeaverseNextI18n, s as WeaverseNextLoadPageInput, u as WeaverseNextPageAssignment, B as WeaverseNextSeoMetadata, F as WeaverseNextStorefront, K as WeaverseNextTranslationEntry, L as WeaverseNextTranslationItemEntry, N as WeaverseNextTranslationMapEntry, O as WeaverseProduct, P as formatWeaverseNextSeoMetadata, Q as getWeaverseNextSeoMetadata } from './seo-Dos9t22_.js';
6
- import * as react_jsx_runtime from 'react/jsx-runtime';
7
- import * as react from 'react';
8
- import { ReactNode } from 'react';
9
-
10
- /**
11
- * Create a {@link WeaverseNextClient} from explicit config.
12
- *
13
- * @example
14
- * ```ts
15
- * let client = createWeaverseNextClient({
16
- * projectId: process.env.WEAVERSE_PROJECT_ID!,
17
- * components,
18
- * commerce: { storefront },
19
- * fetchPage: async ({ type, handle }) => fetchWeaversePage({ type, handle }),
20
- * })
21
- * ```
22
- */
23
- declare function createWeaverseNextClient(config: WeaverseNextClientConfig): WeaverseNextClient;
24
-
25
- /**
26
- * Read explicit root/global data passed to the provider. Next-native
27
- * replacement for `useRouteLoaderData('root')`.
28
- */
29
- declare function useWeaverseRootData<T = unknown>(): T;
30
- /**
31
- * Read explicit page/route commerce data passed to the provider. Next-native
32
- * replacement for section-level `useLoaderData()`.
33
- */
34
- declare function useWeaversePageData<T = unknown>(): T;
35
- /** Read the app-provided commerce context (storefront/cart/customer). */
36
- declare function useWeaverseCommerce<T = WeaverseNextCommerceContext>(): T;
37
- /**
38
- * Read live Weaverse theme settings. The Studio bridge updates the provider's
39
- * external store via `updateThemeSettings`, so components re-render during live
40
- * design-mode edits.
41
- */
42
- declare function useThemeSettings<T = Record<string, unknown>>(): T;
43
-
44
- interface RunComponentLoadersArgs {
45
- client: WeaverseNextClient;
46
- commerce?: WeaverseNextCommerceContext;
47
- context?: WeaverseNextRequestContext;
48
- /** Page payload to walk; defaults to `client.data`. */
49
- data?: WeaverseNextLoaderData | null;
50
- }
51
- /**
52
- * Walk a serialized page tree and run each registered component's `loader`,
53
- * attaching the result to the item as `loaderData`.
54
- *
55
- * Loaders receive explicit `commerce.storefront` (and `weaverse.storefront` as
56
- * a compatibility alias via the client). Children are walked recursively when
57
- * they are inline item objects; flat `items` arrays are covered by the
58
- * top-level walk.
59
- *
60
- * @returns a cloned `data` object with `loaderData` attached to cloned items.
61
- */
62
- declare function runWeaverseComponentLoaders(args: RunComponentLoadersArgs): Promise<WeaverseNextLoaderData | null>;
63
-
64
- /**
65
- * Traverse a nested object by dot-path.
66
- *
67
- * @example
68
- * getNestedKey({ cart: { title: 'Cart' } }, 'cart.title') // => 'Cart'
69
- * getNestedKey({}, 'cart.title', 'fallback') // => 'fallback'
70
- */
71
- declare function getNestedKey(obj: Record<string, unknown>, path: string, fallback?: string): string | undefined;
72
- /**
73
- * Replace `{{variable}}` patterns in a string with provided values.
74
- *
75
- * @example
76
- * interpolate('Hello {{name}}!', { name: 'World' }) // => 'Hello World!'
77
- * interpolate('-{{percentage}}% Off', { percentage: 15 }) // => '-15% Off'
78
- */
79
- declare function interpolate(template: string, variables?: Record<string, string | number>): string;
80
- /**
81
- * Signature for a translation function.
82
- */
83
- type TranslateFunction = (key: string, variables?: Record<string, string | number>) => string;
84
- interface TranslationValue {
85
- /** Active-locale translated keys loaded from the storefront API. */
86
- merchantOverrides: Record<string, unknown> | null;
87
- /**
88
- * Translate a key with optional variable interpolation.
89
- *
90
- * Priority chain (highest wins):
91
- * 1. External `t` (passed into `WeaverseNextRootProvider` / `TranslationProvider`)
92
- * 2. Design overrides (live Builder edits from `TranslationStore`)
93
- * 3. `merchantOverrides` (DB/API overrides for the current locale)
94
- * 4. `staticContent` (theme default JSON)
95
- * 5. The key itself (fallback)
96
- *
97
- * @example
98
- * t('cart.title') // => "Cart"
99
- * t('badge.sale', { percentage: 15 }) // => "-15% Off"
100
- */
101
- t: TranslateFunction;
102
- /**
103
- * @deprecated Use {@link TranslationValue.translationStore} instead. Kept as a
104
- * backward-compatible alias pointing at the same store instance.
105
- */
106
- themeTextStore: TranslationStore | null;
107
- /** Exposed so the runtime/Studio bridge can attach it to `internal`. */
108
- translationStore: TranslationStore | null;
109
- }
110
- interface TranslationProviderProps {
111
- children: ReactNode;
112
- merchantOverrides?: Record<string, unknown>;
113
- staticContent: Record<string, unknown>;
114
- /**
115
- * Optional external translation function.
116
- * When provided it becomes the **highest-priority** source:
117
- * if it returns a non-empty string that differs from the raw key,
118
- * that value is used; otherwise the internal resolution chain continues.
119
- */
120
- t?: TranslateFunction;
121
- /**
122
- * @deprecated Use {@link TranslationProviderProps.translationStore} instead.
123
- * Still accepted for backward compatibility; ignored when `translationStore`
124
- * is also provided.
125
- */
126
- themeTextStore?: TranslationStore | null;
127
- /** Optional store for live design-mode text overrides from the builder. */
128
- translationStore?: TranslationStore | null;
129
- }
130
- /**
131
- * Build the `t()` translation function over a fixed set of sources.
132
- *
133
- * Resolution order, highest priority first:
134
- * 1. `externalT` – host i18n (e.g. Shopify), unless it echoes the key
135
- * 2. `designOverrides` – live design-mode edits, flat dot-path keys
136
- * 3. `merchantOverrides` – locale overrides from the API, nested
137
- * 4. `staticContent` – the theme's default locale JSON
138
- * 5. the key itself
139
- *
140
- * Design overrides are looked up per-key (own properties only) rather than
141
- * merged into `merchantOverrides`: a flat key like `cart.title` must override
142
- * exactly that leaf without wiping sibling keys (`cart.subtitle`), and a
143
- * per-key own-property lookup never builds nested objects from
144
- * merchant-controlled keys, so it cannot pollute `Object.prototype`.
145
- */
146
- declare function createTranslate(sources: {
147
- staticContent: Record<string, unknown>;
148
- merchantOverrides?: Record<string, unknown>;
149
- designOverrides?: Record<string, string>;
150
- externalT?: TranslateFunction;
151
- }): TranslateFunction;
152
- /**
153
- * Provider that wraps the app to expose the `t()` function.
154
- *
155
- * - `staticContent` – the theme's default locale JSON (from themeSchema.i18n)
156
- * - `merchantOverrides` – locale-specific overrides fetched from the API
157
- * - `translationStore` – optional store for live design-mode text overrides
158
- * (the deprecated `themeTextStore` prop is accepted as a fallback)
159
- */
160
- declare function TranslationProvider({ staticContent, merchantOverrides, t: externalT, translationStore, themeTextStore, children, }: TranslationProviderProps): react_jsx_runtime.JSX.Element;
161
- /**
162
- * Hook to access the translation `t()` function.
163
- *
164
- * Must be used inside a component wrapped by `WeaverseNextRootProvider` or
165
- * `TranslationProvider`.
166
- *
167
- * @example
168
- * ```tsx
169
- * function CartTitle() {
170
- * let { t } = useTranslation()
171
- * return <h2>{t('cart.title')}</h2>
172
- * }
173
- * ```
174
- */
175
- declare function useTranslation(): TranslationValue;
176
- /**
177
- * @deprecated Use {@link TranslationProvider} instead.
178
- */
179
- declare const ThemeTextProvider: typeof TranslationProvider;
180
- /**
181
- * @deprecated Use {@link useTranslation} instead.
182
- */
183
- declare const useThemeText: typeof useTranslation;
184
- /**
185
- * @deprecated Use {@link TranslationValue} instead.
186
- */
187
- type ThemeTextValue = TranslationValue;
188
- /**
189
- * @deprecated Use {@link TranslationProviderProps} instead.
190
- */
191
- type ThemeTextProviderProps = TranslationProviderProps;
192
-
193
- interface WeaverseNextProviderProps {
194
- children: ReactNode;
195
- client?: WeaverseNextClient;
196
- /** App-provided commerce context (storefront/cart/customer). */
197
- commerce?: WeaverseNextCommerceContext;
198
- /**
199
- * Active-locale static-text overrides (nested, from `loadThemeSettings()`).
200
- * Adopts the root provider's `merchantOverrides` when omitted.
201
- */
202
- merchantOverrides?: Record<string, unknown>;
203
- /** Explicit page/route commerce data (replaces section-level `useLoaderData`). */
204
- pageData?: unknown;
205
- /** Explicit root/global data (replaces `useRouteLoaderData('root')`). */
206
- rootData?: unknown;
207
- /**
208
- * Theme default locale JSON (`loadThemeSettings().staticContent`). Adopts the
209
- * root provider's `staticContent` when omitted, then falls back to
210
- * `client.themeSchema.i18n.staticContent`.
211
- */
212
- staticContent?: Record<string, unknown>;
213
- /** Optional external translation function (host i18n); highest priority in `t()`. */
214
- t?: TranslateFunction;
215
- /** Theme settings override; falls back to `client.themeSettings`. */
216
- themeSettings?: Record<string, unknown>;
217
- }
218
- /**
219
- * Client boundary that supplies explicit root/page/commerce data to Weaverse
220
- * sections. Next-native replacement for `withWeaverse` + route loader data —
221
- * no React Router route matches are emulated.
222
- *
223
- * In App Router, create/pass `client` only from a client component wrapper. A
224
- * `WeaverseNextClient` contains functions and component references, so it is
225
- * not serializable across a Server Component → Client Component boundary.
226
- *
227
- * @example
228
- * ```tsx
229
- * 'use client'
230
- *
231
- * <WeaverseNextProvider client={client} rootData={rootData} pageData={pageData} commerce={commerce}>
232
- * <WeaverseNextRenderer />
233
- * </WeaverseNextProvider>
234
- * ```
235
- */
236
- declare function WeaverseNextProvider(props: WeaverseNextProviderProps): react_jsx_runtime.JSX.Element;
237
-
238
- interface WeaverseNextRendererProps {
239
- /** Client to render from. Defaults to the provider's client. */
240
- client?: WeaverseNextClient;
241
- /** Page payload to render. Defaults to `client.data`. */
242
- data?: WeaverseNextLoaderData | null;
243
- /** Data-connector context for `{{...}}` template replacement. */
244
- dataContext?: Record<string, unknown>;
245
- }
246
- /**
247
- * Render a serialized Weaverse page tree through `@weaverse/react` primitives.
248
- *
249
- * Reads the client/page data from {@link WeaverseNextContext} when no props are
250
- * passed, or accepts an explicit `client` + `data` for standalone use. Builds a
251
- * framework-neutral `Weaverse` core instance (no React Router hooks) and hands
252
- * it to the shared `WeaverseRoot`.
253
- */
254
- declare const WeaverseNextRenderer: react.MemoExoticComponent<(props: WeaverseNextRendererProps) => react_jsx_runtime.JSX.Element | null>;
255
-
256
- /**
257
- * Build the Hydrogen-like request info shape consumed by the Studio bridge.
258
- * Duplicate query keys keep the last value, matching `URLSearchParams` iteration
259
- * assignment and Hydrogen's practical query-object behavior.
260
- */
261
- declare function buildWeaverseNextRequestInfo(context?: WeaverseNextRequestContext): WeaverseNextRequestInfo;
262
-
263
- declare const DEFAULT_REVALIDATE_ENDPOINT = "/api/weaverse/revalidate";
264
- /**
265
- * Minimal runtime surface the in-place apply needs. Structural (not the
266
- * concrete `WeaverseNextRuntime` class) so unit tests can drive it with a
267
- * plain mock.
268
- */
269
- interface RevalidateItemRuntimeLike {
270
- itemInstances: Map<string, {
271
- setData: (update: Record<string, unknown>) => unknown;
272
- }>;
273
- }
274
- /**
275
- * Studio per-item loader revalidation: POST the unsaved draft item to the
276
- * app's revalidate route (see `createWeaverseNextRevalidateHandler`) and apply
277
- * the returned `loaderData` to the live item instance in place.
278
- *
279
- * No `router.refresh()` is involved, so the RSC tree is never re-applied — no
280
- * page remount, no scroll reset, and the draft payload never touches the URL.
281
- *
282
- * Throws on any failure (missing route, non-OK response, unknown item) so the
283
- * Builder Studio bridge can detect the miss and fall back to its legacy
284
- * refresh-based revalidation for this window.
285
- */
286
- declare function revalidateWeaverseNextItem(runtime: RevalidateItemRuntimeLike, draftItem: WeaverseNextComponentData, endpoint?: string): Promise<void>;
287
-
288
- interface WeaverseNextRootContextValue {
289
- /** Active-locale static-text overrides shared with route-level providers. */
290
- merchantOverrides?: Record<string, unknown>;
291
- /** Theme default locale JSON shared with route-level providers. */
292
- staticContent: Record<string, unknown>;
293
- themeSettingsStore: WeaverseNextThemeSettingsStore;
294
- /** Single live design-mode static-text override store for the whole session. */
295
- translationStore: TranslationStore;
296
- }
297
- interface WeaverseNextRootProviderProps {
298
- children: ReactNode;
299
- /** Root-loaded theme settings (published-mode fetch, no design-mode context). */
300
- initialThemeSettings?: Record<string, unknown>;
301
- /** Active-locale static-text overrides from `loadThemeSettings().merchantOverrides`. */
302
- merchantOverrides?: Record<string, unknown>;
303
- publicEnv?: Record<string, string | undefined>;
304
- /**
305
- * Theme default locale JSON (`loadThemeSettings().staticContent`). Falls back
306
- * to `themeSchema.i18n.staticContent` when omitted.
307
- */
308
- staticContent?: Record<string, unknown>;
309
- /** Optional external translation function (host i18n); highest priority in `t()`. */
310
- t?: TranslateFunction;
311
- themeSchema?: unknown;
312
- }
313
- /**
314
- * Root-scoped client boundary that owns the single `WeaverseNextThemeSettingsStore`
315
- * for the whole app session, matching Hydrogen's `withWeaverse()` root store.
316
- * Mount once in `app/layout.tsx`, above `Header`/`Footer`/global modules and any
317
- * route-level `WeaverseNextProvider`.
318
- *
319
- * Also renders `WeaverseNextContext` with a minimal value so `useThemeSettings()`
320
- * works for components mounted directly under this provider, even without a
321
- * route-level `WeaverseNextProvider` above them.
322
- *
323
- * @example
324
- * ```tsx
325
- * <WeaverseNextRootProvider initialThemeSettings={theme.theme} themeSchema={theme.schema}>
326
- * <Header />
327
- * {children}
328
- * <Footer />
329
- * </WeaverseNextRootProvider>
330
- * ```
331
- */
332
- declare function WeaverseNextRootProvider(props: WeaverseNextRootProviderProps): react_jsx_runtime.JSX.Element;
333
-
334
- /**
335
- * Item store that flattens the serialized item's nested `data` field onto the
336
- * store and seeds schema defaults — same shape Hydrogen produces, so the
337
- * shared `@weaverse/react` renderer can spread props at the top level.
338
- */
339
- declare class WeaverseNextItem extends WeaverseItemStore {
340
- weaverse: WeaverseNextRuntime;
341
- /**
342
- * Cached merged snapshot (base `_store` + translations). Reset whenever the
343
- * `_store` ref or the item's translation entry ref changes, so
344
- * `useSyncExternalStore` sees a stable object between unrelated re-renders.
345
- */
346
- private _cachedSnapshot;
347
- private _snapshotStoreRef;
348
- private _snapshotTranslationRef;
349
- constructor(initialData: WeaverseNextComponentData, weaverse: Weaverse);
350
- /**
351
- * Flatten nested `data` on updates exactly like the constructor does. Core's
352
- * `initProject()` calls `setData(item)` when a new runtime serves a page
353
- * whose item instances already exist (e.g. locale/client navigation), and
354
- * the inherited shallow merge would leave stale top-level props behind.
355
- * Assigning through the inherited `data` setter swaps the `_store` ref,
356
- * which invalidates the memoized snapshot below. The subscriber emit is
357
- * queued instead of fired when a render-phase deferral is active (see
358
- * `collectDeferredItemUpdates`).
359
- */
360
- setData: (update: Omit<ElementData, "id" | "type">) => ElementData;
361
- /**
362
- * Overlay item-level translations onto the base store when the runtime is in
363
- * translation mode. Mirrors Hydrogen's `WeaverseHydrogenItem.getSnapShot()`:
364
- * memoized by `_store` ref + translation entry ref so the returned object is
365
- * referentially stable, and a fast path that returns the base store untouched
366
- * when the item has no translations.
367
- */
368
- getSnapShot: () => ElementData;
369
- }
370
-
371
- declare global {
372
- interface Window {
373
- __weaverse?: WeaverseNextRuntime;
374
- __weaverses?: Record<string, WeaverseNextRuntime>;
375
- }
376
- }
377
- declare class WeaverseNextRuntime extends Weaverse {
378
- pageId: string;
379
- internal: WeaverseNextRuntimeInternal;
380
- requestInfo: WeaverseNextRequestInfo;
381
- isPreviewMode: boolean;
382
- isRevisionPreview: boolean;
383
- sectionType?: string;
384
- /**
385
- * Translation map received from Builder in design mode, keyed by item ID.
386
- * `WeaverseNextItem.getSnapShot()` overlays these onto the data handed to
387
- * components, so translations render without mutating the base `_store`.
388
- */
389
- translationMap: WeaverseNextTranslationMap;
390
- translationLocale: string;
391
- translationLanguageId: string;
392
- /**
393
- * Fresh page data captured while React was rendering. Runtime reuse happens
394
- * inside the renderer's render phase (`useMemo`), where applying it through
395
- * `setProjectData()` would emit item updates to `useSyncExternalStore`
396
- * subscribers mid-render. The renderer applies it post-commit via
397
- * `flushRenderPhaseUpdates()`. Never set on design-mode runtimes — the live
398
- * Studio tree owns the page data there.
399
- */
400
- pendingProjectData?: WeaverseNextPageData & {
401
- rootId: string;
402
- };
403
- /**
404
- * Reused item instances whose data was refreshed while this runtime was
405
- * constructed during render (core `initProject()` calls `setData()` on
406
- * them). Their data is already fresh; only the subscriber notification was
407
- * deferred to `flushRenderPhaseUpdates()`.
408
- */
409
- pendingItemUpdates: WeaverseNextItem[];
410
- constructor(config: WeaverseNextRuntimeConfig);
411
- /**
412
- * Pull `translationMap` / `translationLocale` / `translationLanguageId` off
413
- * the current page data (Builder attaches them in design mode). Unlike
414
- * Hydrogen, this also clears the sidecar to defaults when the new page data
415
- * carries none, so a reused runtime / project-data swap can't leave a stale
416
- * map overlaying the fresh tree.
417
- */
418
- extractTranslationSidecar: () => void;
419
- /**
420
- * Replace the translation sidecar (Builder pushes this when translation data
421
- * arrives or the active language changes) and refresh every item so their
422
- * merged snapshots recompute.
423
- */
424
- setTranslationSidecar: (map?: WeaverseNextTranslationMap, locale?: string, languageId?: string) => void;
425
- /**
426
- * Update a single translatable field for one item. Assigns a new per-item
427
- * entry object so `WeaverseNextItem.getSnapShot()`'s translation-ref cache
428
- * invalidates, then triggers only that item's subscribers.
429
- */
430
- updateTranslation: (itemId: string, key: string, originalValue: string, translatedValue: string) => void;
431
- /**
432
- * Collect translation changes for the save flow. Returns `undefined` unless
433
- * both the locale and language ID are set and at least one entry exists;
434
- * each entry key is namespaced as `data.<field>` to match Builder.
435
- */
436
- getTranslationChanges: () => WeaverseNextTranslationChanges | undefined;
437
- /**
438
- * Re-extract the translation sidecar whenever project data is replaced (route
439
- * change / non-design reuse), before rebuilding item stores. Takes the
440
- * renderable page shape (`rootId` resolved) that `getRenderablePage()` and
441
- * the reuse branch pass in.
442
- */
443
- setProjectData: (data: WeaverseNextPageData & {
444
- rootId: string;
445
- }) => void;
446
- /**
447
- * Apply updates deferred off the render phase: swap in any pending page data
448
- * captured on runtime reuse, then notify items whose data was refreshed
449
- * during construction. The renderer calls this from a layout effect right
450
- * after commit, so subscribers re-render before paint (no content flash) and
451
- * without React's setState-in-render warning.
452
- */
453
- flushRenderPhaseUpdates: () => void;
454
- }
455
- declare function createWeaverseNextRuntime(config: WeaverseNextRuntimeConfig): WeaverseNextRuntime;
456
- declare function bindWeaverseNextStudioRuntime(runtime: WeaverseNextRuntime): boolean;
457
-
458
- interface WeaverseNextStudioBridgeProps {
459
- navigate?: WeaverseNextRuntimeInternal['navigate'];
460
- revalidate?: WeaverseNextRuntimeInternal['revalidate'];
461
- revalidateItem?: WeaverseNextRuntimeInternal['revalidateItem'];
462
- runtime: WeaverseNextRuntime;
463
- }
464
- /** Page-level Studio runtime binder. */
465
- declare function WeaverseNextStudioBridge(props: WeaverseNextStudioBridgeProps): null;
466
-
467
- interface LoadWeaverseNextStudioScriptOptions {
468
- storefrontHostname?: string;
469
- }
470
- /**
471
- * Resolve and append the Next Studio bridge script for the given request
472
- * context, deduping by src. SSR-safe (no-op without `document`) so it can run
473
- * unconditionally from a root layout/error boundary before any page tree or
474
- * runtime exists — e.g. App Router `not-found.tsx` / `error.tsx` routes.
475
- */
476
- declare function loadWeaverseNextStudioScript(context?: WeaverseNextRequestContext, options?: LoadWeaverseNextStudioScriptOptions): void;
477
- interface WeaverseNextStudioConnectProps {
478
- context?: WeaverseNextRequestContext;
479
- storefrontHostname?: string;
480
- }
481
- /**
482
- * Root-level Studio script connector for Next client boundaries. Mount once
483
- * near the app root (e.g. root layout) so it also covers routes that never
484
- * render `WeaverseNextRenderer`, such as `not-found.tsx` / `error.tsx`.
485
- */
486
- declare function WeaverseNextStudioConnect(props: WeaverseNextStudioConnectProps): null;
487
-
488
- /**
489
- * Minimal structural shape of the Next App Router returned by `useRouter()`
490
- * (`next/navigation`) that the Studio bridge needs. Declared locally — rather
491
- * than importing `AppRouterInstance` from `next` — so the adapter stays a pure
492
- * function that unit tests can drive with a plain mock and never pulls
493
- * `next/navigation` into the test graph.
494
- */
495
- interface WeaverseNextRouterLike {
496
- push: (href: string, options?: {
497
- scroll?: boolean;
498
- }) => void;
499
- refresh: () => void;
500
- replace: (href: string, options?: {
501
- scroll?: boolean;
502
- }) => void;
503
- }
504
- /** Resolved Studio navigation/revalidation callbacks for a Next runtime. */
505
- interface WeaverseNextStudioInternals {
506
- navigate: NonNullable<WeaverseNextRuntimeInternal['navigate']>;
507
- revalidate: NonNullable<WeaverseNextRuntimeInternal['revalidate']>;
508
- }
509
- interface CreateWeaverseNextStudioInternalsOptions {
510
- /** Use `router.replace` instead of `router.push` for navigation. */
511
- replace?: boolean;
512
- }
513
- /**
514
- * Build Studio `navigate` / `revalidate` callbacks from a Next App Router.
515
- *
516
- * Maps Hydrogen's React Router semantics onto Next App Router:
517
- * - `navigate(to, { preventScrollReset })` → `router.push(to, { scroll })`,
518
- * where `scroll` is the inverse of `preventScrollReset`. Studio passes
519
- * `preventScrollReset` for in-place edits so the preview viewport is kept,
520
- * matching React Router's `navigate({ preventScrollReset })`.
521
- * - `revalidate()` → `router.refresh()`, the App Router's loader-backed refresh
522
- * and the closest equivalent to React Router's `useRevalidator`.
523
- *
524
- * Pure (no React, no `next/navigation`) so it is unit-testable with a mock
525
- * router; the {@link WeaverseNextRouterLike} contract is the only coupling.
526
- */
527
- declare function createWeaverseNextStudioInternals(router: WeaverseNextRouterLike, options?: CreateWeaverseNextStudioInternalsOptions): WeaverseNextStudioInternals;
528
-
529
- interface ResolveWeaverseNextStudioScriptSrcOptions {
530
- storefrontHostname?: string;
531
- }
532
- /**
533
- * Resolve the Studio script URL from request/search context. `@weaverse/next`
534
- * uses the dedicated Next bridge path served by Builder.
535
- */
536
- declare function resolveWeaverseNextStudioScriptSrc(context?: WeaverseNextRequestContext, options?: ResolveWeaverseNextStudioScriptSrcOptions): string | null;
537
-
538
- interface CreateWeaverseNextThemeSettingsStoreOptions {
539
- publicEnv?: Record<string, string | undefined>;
540
- schema?: unknown;
541
- settings?: Record<string, unknown>;
542
- }
543
- /**
544
- * Small external store shape compatible with the Studio bridge and React's
545
- * `useSyncExternalStore` contract. The bridge calls `updateThemeSettings` during
546
- * live theme edits, so keep that method name stable.
547
- */
548
- declare function createWeaverseNextThemeSettingsStore(options?: CreateWeaverseNextThemeSettingsStoreOptions): WeaverseNextThemeSettingsStore;
549
-
550
- /**
551
- * Resolve stable Studio `navigate` / `revalidate` callbacks from the Next App
552
- * Router. `useRouter()` is stable across renders, but the derived callbacks are
553
- * cached in a ref keyed on the router instance so the bridge's bind effect
554
- * (which depends on `navigate` / `revalidate` identity) doesn't re-run — and
555
- * re-`refreshStudio` — on every render.
556
- */
557
- declare function useWeaverseNextStudioInternals(options?: CreateWeaverseNextStudioInternalsOptions): WeaverseNextStudioInternals;
558
- interface WeaverseNextStudioProps extends CreateWeaverseNextStudioInternalsOptions {
559
- /**
560
- * Route the app mounted with `createWeaverseNextRevalidateHandler`.
561
- * Defaults to `/api/weaverse/revalidate`.
562
- */
563
- revalidateEndpoint?: string;
564
- runtime: WeaverseNextRuntime;
565
- }
566
- /**
567
- * Page-level Studio binder wired to the Next App Router. Mirrors Hydrogen's
568
- * `useStudio` (which binds the runtime and feeds it React Router's `navigate` /
569
- * `revalidate`): it resolves the App Router callbacks via
570
- * {@link useWeaverseNextStudioInternals} and hands them to
571
- * {@link WeaverseNextStudioBridge}, so consuming apps get Studio navigation and
572
- * revalidation without manually wiring `next/navigation`.
573
- *
574
- * Client-only — it is the single place `@weaverse/next` touches
575
- * `next/navigation`, keeping the runtime/renderer and `@weaverse/next/server`
576
- * free of router imports.
577
- */
578
- declare function WeaverseNextStudio(props: WeaverseNextStudioProps): react_jsx_runtime.JSX.Element;
579
-
580
- export { type CreateWeaverseNextStudioInternalsOptions, type CreateWeaverseNextThemeSettingsStoreOptions, DEFAULT_REVALIDATE_ENDPOINT, type LoadWeaverseNextStudioScriptOptions, type ResolveWeaverseNextStudioScriptSrcOptions, type RevalidateItemRuntimeLike, type RunComponentLoadersArgs, ThemeTextProvider, type ThemeTextProviderProps, type ThemeTextValue, type TranslateFunction, TranslationProvider, type TranslationProviderProps, TranslationStore, type TranslationValue, WeaverseNextClient, WeaverseNextClientConfig, WeaverseNextCommerceContext, WeaverseNextComponentData, WeaverseNextLoaderData, WeaverseNextPageData, WeaverseNextProvider, type WeaverseNextProviderProps, WeaverseNextRenderer, type WeaverseNextRendererProps, WeaverseNextRequestContext, WeaverseNextRequestInfo, type WeaverseNextRootContextValue, WeaverseNextRootProvider, type WeaverseNextRootProviderProps, type WeaverseNextRouterLike, WeaverseNextRuntime, WeaverseNextRuntimeConfig, WeaverseNextRuntimeInternal, WeaverseNextStudio, WeaverseNextStudioBridge, type WeaverseNextStudioBridgeProps, WeaverseNextStudioConnect, type WeaverseNextStudioConnectProps, type WeaverseNextStudioInternals, type WeaverseNextStudioProps, WeaverseNextThemeSettingsStore, WeaverseNextTranslationChanges, WeaverseNextTranslationMap, bindWeaverseNextStudioRuntime, buildWeaverseNextRequestInfo, createTranslate, createWeaverseNextClient, createWeaverseNextRuntime, createWeaverseNextStudioInternals, createWeaverseNextThemeSettingsStore, getNestedKey, interpolate, loadWeaverseNextStudioScript, resolveWeaverseNextStudioScriptSrc, revalidateWeaverseNextItem, runWeaverseComponentLoaders, useThemeSettings, useThemeText, useTranslation, useWeaverseCommerce, useWeaverseNextStudioInternals, useWeaversePageData, useWeaverseRootData };