@weaverse/next 0.1.0-alpha.0 → 0.1.0-alpha.10

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