@weaverse/next 0.1.0-alpha.2 → 0.1.0-alpha.20
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/README.md +586 -123
- package/dist/chunk-LH6AAEIK.mjs +326 -0
- package/dist/chunk-LH6AAEIK.mjs.map +1 -0
- package/dist/index.js +784 -60
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +588 -58
- package/dist/index.mjs.map +1 -1
- package/dist/server.js +537 -76
- package/dist/server.js.map +1 -1
- package/dist/server.mjs +363 -27
- package/dist/server.mjs.map +1 -1
- package/dist/types/client.d.ts +16 -0
- package/dist/types/client.d.ts.map +1 -0
- package/dist/types/hooks.d.ts +20 -0
- package/dist/types/hooks.d.ts.map +1 -0
- package/dist/types/index.d.ts +34 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/item.d.ts +60 -0
- package/dist/types/item.d.ts.map +1 -0
- package/dist/types/loader.d.ts +25 -0
- package/dist/types/loader.d.ts.map +1 -0
- package/dist/types/main.d.ts +11 -0
- package/dist/types/main.d.ts.map +1 -0
- package/dist/types/provider.d.ts +82 -0
- package/dist/types/provider.d.ts.map +1 -0
- package/dist/types/registry.d.ts +15 -0
- package/dist/types/registry.d.ts.map +1 -0
- package/dist/types/renderer.d.ts +21 -0
- package/dist/types/renderer.d.ts.map +1 -0
- package/dist/types/request-info.d.ts +19 -0
- package/dist/types/request-info.d.ts.map +1 -0
- package/dist/types/revalidate-item.d.ts +82 -0
- package/dist/types/revalidate-item.d.ts.map +1 -0
- package/dist/types/root-provider.d.ts +62 -0
- package/dist/types/root-provider.d.ts.map +1 -0
- package/dist/types/runtime.d.ts +113 -0
- package/dist/types/runtime.d.ts.map +1 -0
- package/dist/types/seo.d.ts +55 -0
- package/dist/types/seo.d.ts.map +1 -0
- package/dist/types/server/configs.d.ts +27 -0
- package/dist/types/server/configs.d.ts.map +1 -0
- package/dist/types/server/normalize-page-url.d.ts +19 -0
- package/dist/types/server/normalize-page-url.d.ts.map +1 -0
- package/dist/types/server/revalidate-handler.d.ts +55 -0
- package/dist/types/server/revalidate-handler.d.ts.map +1 -0
- package/dist/types/server/server-client.d.ts +21 -0
- package/dist/types/server/server-client.d.ts.map +1 -0
- package/dist/types/server.d.ts +19 -0
- package/dist/types/server.d.ts.map +1 -0
- package/dist/types/studio-bridge.d.ts +16 -0
- package/dist/types/studio-bridge.d.ts.map +1 -0
- package/dist/types/studio-connect.d.ts +27 -0
- package/dist/types/studio-connect.d.ts.map +1 -0
- package/dist/types/studio-router.d.ts +50 -0
- package/dist/types/studio-router.d.ts.map +1 -0
- package/dist/types/studio-script-src.d.ts +12 -0
- package/dist/types/studio-script-src.d.ts.map +1 -0
- package/dist/types/theme-settings-store.d.ts +18 -0
- package/dist/types/theme-settings-store.d.ts.map +1 -0
- package/dist/types/translation-context.d.ts +156 -0
- package/dist/types/translation-context.d.ts.map +1 -0
- package/dist/types/translation-store.d.ts +44 -0
- package/dist/types/translation-store.d.ts.map +1 -0
- package/dist/types/types.d.ts +665 -0
- package/dist/types/types.d.ts.map +1 -0
- package/dist/types/use-weaverse-next-studio.d.ts +34 -0
- package/dist/types/use-weaverse-next-studio.d.ts.map +1 -0
- package/dist/types/utils.d.ts +12 -0
- package/dist/types/utils.d.ts.map +1 -0
- package/package.json +12 -8
- package/src/client.ts +102 -0
- package/src/hooks.ts +50 -0
- package/src/index.ts +153 -0
- package/src/item.ts +167 -0
- package/src/loader.ts +135 -0
- package/src/main.tsx +45 -0
- package/src/provider.tsx +225 -0
- package/src/registry.ts +63 -0
- package/src/renderer.tsx +100 -0
- package/src/request-info.ts +124 -0
- package/src/revalidate-item.ts +211 -0
- package/src/root-provider.tsx +182 -0
- package/src/runtime.ts +555 -0
- package/src/seo.ts +157 -0
- package/src/server/configs.ts +178 -0
- package/src/server/normalize-page-url.ts +73 -0
- package/src/server/revalidate-handler.ts +357 -0
- package/src/server/server-client.ts +728 -0
- package/src/server.ts +67 -0
- package/src/studio-bridge.tsx +82 -0
- package/src/studio-connect.tsx +88 -0
- package/src/studio-router.ts +85 -0
- package/src/studio-script-src.ts +128 -0
- package/src/theme-settings-store.ts +47 -0
- package/src/translation-context.tsx +299 -0
- package/src/translation-store.ts +69 -0
- package/src/types.ts +753 -0
- package/src/use-weaverse-next-studio.tsx +106 -0
- package/src/utils.ts +37 -0
- package/dist/chunk-SS6QUKYY.mjs +0 -149
- package/dist/chunk-SS6QUKYY.mjs.map +0 -1
- package/dist/index.d.mts +0 -250
- package/dist/index.d.ts +0 -250
- package/dist/server.d.mts +0 -60
- package/dist/server.d.ts +0 -60
- package/dist/types-DvEeLX6L.d.mts +0 -321
- package/dist/types-DvEeLX6L.d.ts +0 -321
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type { JSX } from 'react/jsx-runtime';
|
|
2
|
+
import type { WeaverseNextClient, WeaverseNextLoaderData } from './types';
|
|
3
|
+
/** Page payload, client, and connector data accepted by the Next renderer. */
|
|
4
|
+
export interface WeaverseNextRendererProps {
|
|
5
|
+
/** Client to render from. Defaults to the provider's client. */
|
|
6
|
+
client?: WeaverseNextClient;
|
|
7
|
+
/** Page payload to render. Defaults to `client.data`. */
|
|
8
|
+
data?: WeaverseNextLoaderData | null;
|
|
9
|
+
/** Data-connector context for `{{...}}` template replacement. */
|
|
10
|
+
dataContext?: Record<string, unknown>;
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* Render a serialized Weaverse page tree through `@weaverse/react` primitives.
|
|
14
|
+
*
|
|
15
|
+
* Reads the client/page data supplied by {@link WeaverseNextProvider} when no
|
|
16
|
+
* props are passed, or accepts an explicit `client` + `data` for standalone use. Builds a
|
|
17
|
+
* framework-neutral `Weaverse` core instance (no React Router hooks) and hands
|
|
18
|
+
* it to the shared `WeaverseRoot`.
|
|
19
|
+
*/
|
|
20
|
+
export declare const WeaverseNextRenderer: import("react").MemoExoticComponent<(props: WeaverseNextRendererProps) => JSX.Element | null>;
|
|
21
|
+
//# sourceMappingURL=renderer.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"renderer.d.ts","sourceRoot":"","sources":["../../src/renderer.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAA;AAG5C,OAAO,KAAK,EACV,kBAAkB,EAClB,sBAAsB,EAEvB,MAAM,SAAS,CAAA;AAsBhB,8EAA8E;AAC9E,MAAM,WAAW,yBAAyB;IACxC,gEAAgE;IAChE,MAAM,CAAC,EAAE,kBAAkB,CAAA;IAC3B,yDAAyD;IACzD,IAAI,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;IACpC,iEAAiE;IACjE,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACtC;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,8CACxB,yBAAyB,KAC/B,GAAG,CAAC,OAAO,GAAG,IAAI,CA8CnB,CAAA"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type { WeaverseNextRequestContext, WeaverseNextRequestInfo } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* Put the request's market prefix (`i18n.pathPrefix`, e.g. `/de-de`) on a
|
|
4
|
+
* pathname that does not carry it yet.
|
|
5
|
+
*
|
|
6
|
+
* A Next app builds its request context from the route path, and with
|
|
7
|
+
* locale-segmented routes that path is usually unprefixed. Studio's address
|
|
8
|
+
* bar follows `requestInfo.pathname`, so without the prefix it snaps back to
|
|
9
|
+
* the default market after every navigation. A path that already carries the
|
|
10
|
+
* prefix, and the default market's empty prefix, pass through unchanged.
|
|
11
|
+
*/
|
|
12
|
+
export declare function withPathPrefix(pathname: string, i18n?: WeaverseNextRequestContext['i18n']): string;
|
|
13
|
+
/**
|
|
14
|
+
* Build the Hydrogen-like request info shape consumed by the Studio bridge.
|
|
15
|
+
* Duplicate query keys keep the last value, matching `URLSearchParams` iteration
|
|
16
|
+
* assignment and Hydrogen's practical query-object behavior.
|
|
17
|
+
*/
|
|
18
|
+
export declare function buildWeaverseNextRequestInfo(context?: WeaverseNextRequestContext): WeaverseNextRequestInfo;
|
|
19
|
+
//# sourceMappingURL=request-info.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"request-info.d.ts","sourceRoot":"","sources":["../../src/request-info.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,uBAAuB,EACxB,MAAM,SAAS,CAAA;AAqBhB;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,0BAA0B,CAAC,MAAM,CAAC,GACxC,MAAM,CAcR;AAqDD;;;;GAIG;AACH,wBAAgB,4BAA4B,CAC1C,OAAO,CAAC,EAAE,0BAA0B,GACnC,uBAAuB,CAYzB"}
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
import type { PageType } from '@weaverse/schema';
|
|
2
|
+
import type { WeaverseNextComponentData, WeaverseNextI18n, WeaverseNextRequestInfo } from './types';
|
|
3
|
+
/** Default App Router endpoint used for Studio item-loader revalidation. */
|
|
4
|
+
export declare const DEFAULT_REVALIDATE_ENDPOINT = "/api/weaverse/revalidate";
|
|
5
|
+
/**
|
|
6
|
+
* Server-owned and transient controls stripped from the revalidation route
|
|
7
|
+
* context on both sides of the trust boundary. Compared case-insensitively, so
|
|
8
|
+
* every entry is stored lowercased. Client sanitization keeps normal traffic
|
|
9
|
+
* clean; the route handler repeats this deny-list as the security boundary.
|
|
10
|
+
*
|
|
11
|
+
* - Server-owned: a crafted `?weaverseProjectId=`/`?weaverseHost=` must never
|
|
12
|
+
* influence server config resolution (see `getWeaverseNextConfigs`), and
|
|
13
|
+
* credential-shaped params never ride along in route context.
|
|
14
|
+
* - Transient: draft-item and RSC transport params never describe route identity.
|
|
15
|
+
*/
|
|
16
|
+
export declare const DENIED_ROUTE_CONTEXT_PARAMS: string[];
|
|
17
|
+
/** i18n fields allowed to cross the browser boundary. */
|
|
18
|
+
export declare const ROUTE_CONTEXT_I18N_KEYS: readonly ["country", "label", "language", "locale", "pathPrefix"];
|
|
19
|
+
/**
|
|
20
|
+
* JSON-safe route subset that may cross the browser boundary alongside the
|
|
21
|
+
* draft item. Never carries headers, cookies, auth, env, project ID, Studio
|
|
22
|
+
* host, API keys/bases, commerce clients, the request context, runtime, or
|
|
23
|
+
* client. `search` is canonical (preserves duplicate keys); the derived
|
|
24
|
+
* `queries` record is intentionally omitted.
|
|
25
|
+
*/
|
|
26
|
+
export interface WeaverseNextRevalidateRouteContext {
|
|
27
|
+
/** Route handle used for page assignment. */
|
|
28
|
+
handle?: string;
|
|
29
|
+
/** Public locale and market identity allowed across the browser boundary. */
|
|
30
|
+
i18n?: Pick<WeaverseNextI18n, 'country' | 'label' | 'language' | 'locale' | 'pathPrefix'>;
|
|
31
|
+
/** Weaverse page type resolved by the active route. */
|
|
32
|
+
pageType?: PageType;
|
|
33
|
+
/** Canonical same-origin route pathname. */
|
|
34
|
+
pathname: string;
|
|
35
|
+
/** Sanitized serialized query string, including the leading `?` when set. */
|
|
36
|
+
search: string;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Minimal runtime surface the in-place apply needs. Structural (not the
|
|
40
|
+
* concrete `WeaverseNextRuntime` class) so unit tests can drive it with a
|
|
41
|
+
* plain mock. `requestInfo` stays optional: a real `WeaverseNextRuntime`
|
|
42
|
+
* always supplies it, but when absent the client omits `routeContext` and the
|
|
43
|
+
* legacy `{ draftItem }` request is preserved.
|
|
44
|
+
*/
|
|
45
|
+
export interface RevalidateItemRuntimeLike {
|
|
46
|
+
/** Live item stores keyed by Weaverse item ID. */
|
|
47
|
+
itemInstances: Map<string, {
|
|
48
|
+
/** Merge refreshed loader data into the live item store. */
|
|
49
|
+
setData: (update: Record<string, unknown>) => unknown;
|
|
50
|
+
}>;
|
|
51
|
+
/** Active route identity used to construct the optional revalidation payload. */
|
|
52
|
+
requestInfo?: WeaverseNextRequestInfo;
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Strip denied (server-owned/transient) controls from a `search` string and
|
|
56
|
+
* re-serialize it. Preserves ordinary application queries, duplicate keys,
|
|
57
|
+
* encoded Unicode, and mode controls (`isDesignMode`, `isPreviewMode`,
|
|
58
|
+
* `__revisionId`, `sectionType`). Returns `''` or a `?`-prefixed string.
|
|
59
|
+
*/
|
|
60
|
+
export declare function sanitizeRouteContextSearch(search: string): string;
|
|
61
|
+
/**
|
|
62
|
+
* Build the sanitized {@link WeaverseNextRevalidateRouteContext} from the
|
|
63
|
+
* active runtime's request info. Returns `undefined` without a usable pathname
|
|
64
|
+
* so the caller omits `routeContext` and keeps the legacy request. This is not
|
|
65
|
+
* the security boundary — the route handler re-validates and re-sanitizes.
|
|
66
|
+
*/
|
|
67
|
+
export declare function buildWeaverseNextRevalidateRouteContext(requestInfo?: WeaverseNextRequestInfo): WeaverseNextRevalidateRouteContext | undefined;
|
|
68
|
+
/**
|
|
69
|
+
* Studio per-item loader revalidation: POST the unsaved draft item (and, when
|
|
70
|
+
* the runtime exposes route context, a sanitized `routeContext`) to the app's
|
|
71
|
+
* revalidate route (see `createWeaverseNextRevalidateHandler`) and apply the
|
|
72
|
+
* returned `loaderData` to the live item instance in place.
|
|
73
|
+
*
|
|
74
|
+
* No `router.refresh()` is involved, so the RSC tree is never re-applied — no
|
|
75
|
+
* page remount, no scroll reset, and the draft payload never touches the URL.
|
|
76
|
+
*
|
|
77
|
+
* Throws on any failure (missing route, non-OK response, unknown item) so the
|
|
78
|
+
* Builder Studio bridge can detect the miss and fall back to its legacy
|
|
79
|
+
* refresh-based revalidation for this window.
|
|
80
|
+
*/
|
|
81
|
+
export declare function revalidateWeaverseNextItem(runtime: RevalidateItemRuntimeLike, draftItem: WeaverseNextComponentData, endpoint?: string): Promise<void>;
|
|
82
|
+
//# sourceMappingURL=revalidate-item.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"revalidate-item.d.ts","sourceRoot":"","sources":["../../src/revalidate-item.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAEhD,OAAO,KAAK,EACV,yBAAyB,EACzB,gBAAgB,EAChB,uBAAuB,EACxB,MAAM,SAAS,CAAA;AAEhB,4EAA4E;AAC5E,eAAO,MAAM,2BAA2B,6BAA6B,CAAA;AAIrE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,2BAA2B,UAWvC,CAAA;AAED,yDAAyD;AACzD,eAAO,MAAM,uBAAuB,mEAM1B,CAAA;AAEV;;;;;;GAMG;AACH,MAAM,WAAW,kCAAkC;IACjD,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,6EAA6E;IAC7E,IAAI,CAAC,EAAE,IAAI,CACT,gBAAgB,EAChB,SAAS,GAAG,OAAO,GAAG,UAAU,GAAG,QAAQ,GAAG,YAAY,CAC3D,CAAA;IACD,uDAAuD;IACvD,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,CAAA;IAChB,6EAA6E;IAC7E,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;;;;GAMG;AACH,MAAM,WAAW,yBAAyB;IACxC,kDAAkD;IAClD,aAAa,EAAE,GAAG,CAChB,MAAM,EACN;QACE,4DAA4D;QAC5D,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAA;KACtD,CACF,CAAA;IACD,iFAAiF;IACjF,WAAW,CAAC,EAAE,uBAAuB,CAAA;CACtC;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAUjE;AAED;;;;;GAKG;AACH,wBAAgB,uCAAuC,CACrD,WAAW,CAAC,EAAE,uBAAuB,GACpC,kCAAkC,GAAG,SAAS,CA4ChD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,0BAA0B,CAC9C,OAAO,EAAE,yBAAyB,EAClC,SAAS,EAAE,yBAAyB,EACpC,QAAQ,GAAE,MAAoC,GAC7C,OAAO,CAAC,IAAI,CAAC,CAgCf"}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import type { SchemaType } from '@weaverse/schema';
|
|
2
|
+
import { type ReactNode } from 'react';
|
|
3
|
+
import { type TranslateFunction } from './translation-context';
|
|
4
|
+
import { TranslationStore } from './translation-store';
|
|
5
|
+
import type { WeaverseNextThemeSchema, WeaverseNextThemeSettingsStore } from './types';
|
|
6
|
+
/** Root-scoped theme and translation stores adopted by route providers. */
|
|
7
|
+
export interface WeaverseNextRootContextValue {
|
|
8
|
+
/** Active-locale static-text overrides shared with route-level providers. */
|
|
9
|
+
merchantOverrides?: Record<string, unknown>;
|
|
10
|
+
/** Theme default locale JSON shared with route-level providers. */
|
|
11
|
+
staticContent: Record<string, unknown>;
|
|
12
|
+
/** Root-scoped external store shared with route-level providers. */
|
|
13
|
+
themeSettingsStore: WeaverseNextThemeSettingsStore;
|
|
14
|
+
/** Single live design-mode static-text override store for the whole session. */
|
|
15
|
+
translationStore: TranslationStore;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Ambient root-scoped context. Route-level `WeaverseNextProvider` reads this to
|
|
19
|
+
* adopt the shared theme settings store instead of creating its own.
|
|
20
|
+
*/
|
|
21
|
+
export declare const WeaverseNextRootContext: import("react").Context<WeaverseNextRootContextValue | null>;
|
|
22
|
+
/** Root theme and translation data shared across the App Router tree. */
|
|
23
|
+
export interface WeaverseNextRootProviderProps {
|
|
24
|
+
/** Application subtree, including global and route-level components. */
|
|
25
|
+
children: ReactNode;
|
|
26
|
+
/** Root-loaded theme settings (published-mode fetch, no design-mode context). */
|
|
27
|
+
initialThemeSettings?: Record<string, unknown>;
|
|
28
|
+
/** Active-locale static-text overrides from `loadThemeSettings().merchantOverrides`. */
|
|
29
|
+
merchantOverrides?: Record<string, unknown>;
|
|
30
|
+
/** Public environment values exposed to the theme-settings store. */
|
|
31
|
+
publicEnv?: Record<string, string | undefined>;
|
|
32
|
+
/**
|
|
33
|
+
* Theme default locale JSON (`loadThemeSettings().staticContent`). Falls back
|
|
34
|
+
* to `themeSchema.i18n.staticContent` when omitted.
|
|
35
|
+
*/
|
|
36
|
+
staticContent?: Record<string, unknown>;
|
|
37
|
+
/** Optional external translation function (host i18n); highest priority in `t()`. */
|
|
38
|
+
t?: TranslateFunction;
|
|
39
|
+
/** Theme schema associated with the initial settings. */
|
|
40
|
+
themeSchema?: SchemaType | WeaverseNextThemeSchema;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Root-scoped client boundary that owns the single `WeaverseNextThemeSettingsStore`
|
|
44
|
+
* for the whole app session, matching Hydrogen's `withWeaverse()` root store.
|
|
45
|
+
* Mount once in `app/layout.tsx`, above `Header`/`Footer`/global modules and any
|
|
46
|
+
* route-level `WeaverseNextProvider`.
|
|
47
|
+
*
|
|
48
|
+
* Also renders `WeaverseNextContext` with a minimal value so `useThemeSettings()`
|
|
49
|
+
* works for components mounted directly under this provider, even without a
|
|
50
|
+
* route-level `WeaverseNextProvider` above them.
|
|
51
|
+
*
|
|
52
|
+
* @example
|
|
53
|
+
* ```tsx
|
|
54
|
+
* <WeaverseNextRootProvider initialThemeSettings={theme.theme} themeSchema={theme.schema}>
|
|
55
|
+
* <Header />
|
|
56
|
+
* {children}
|
|
57
|
+
* <Footer />
|
|
58
|
+
* </WeaverseNextRootProvider>
|
|
59
|
+
* ```
|
|
60
|
+
*/
|
|
61
|
+
export declare function WeaverseNextRootProvider(props: WeaverseNextRootProviderProps): import("react/jsx-runtime").JSX.Element;
|
|
62
|
+
//# sourceMappingURL=root-provider.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"root-provider.d.ts","sourceRoot":"","sources":["../../src/root-provider.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EAEL,KAAK,SAAS,EAIf,MAAM,OAAO,CAAA;AAOd,OAAO,EACL,KAAK,iBAAiB,EAEvB,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AACtD,OAAO,KAAK,EACV,uBAAuB,EACvB,8BAA8B,EAC/B,MAAM,SAAS,CAAA;AAEhB,2EAA2E;AAC3E,MAAM,WAAW,4BAA4B;IAC3C,6EAA6E;IAC7E,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC3C,mEAAmE;IACnE,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACtC,oEAAoE;IACpE,kBAAkB,EAAE,8BAA8B,CAAA;IAClD,gFAAgF;IAChF,gBAAgB,EAAE,gBAAgB,CAAA;CACnC;AAED;;;GAGG;AACH,eAAO,MAAM,uBAAuB,8DACsB,CAAA;AAE1D,yEAAyE;AACzE,MAAM,WAAW,6BAA6B;IAC5C,wEAAwE;IACxE,QAAQ,EAAE,SAAS,CAAA;IACnB,iFAAiF;IACjF,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9C,wFAAwF;IACxF,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC3C,qEAAqE;IACrE,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAA;IAC9C;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACvC,qFAAqF;IACrF,CAAC,CAAC,EAAE,iBAAiB,CAAA;IACrB,yDAAyD;IACzD,WAAW,CAAC,EAAE,UAAU,GAAG,uBAAuB,CAAA;CACnD;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,6BAA6B,2CAgG5E"}
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
import { Weaverse } from '@weaverse/react';
|
|
2
|
+
import { type WeaverseNextItem } from './item';
|
|
3
|
+
import type { WeaverseNextPageData, WeaverseNextRequestInfo, WeaverseNextRuntimeConfig, WeaverseNextRuntimeInternal, WeaverseNextTranslationChanges, WeaverseNextTranslationMap } from './types';
|
|
4
|
+
declare global {
|
|
5
|
+
interface Window {
|
|
6
|
+
__weaverse?: WeaverseNextRuntime;
|
|
7
|
+
__weaverses?: Record<string, WeaverseNextRuntime>;
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
/** Weaverse page data with the root component resolved for rendering. */
|
|
11
|
+
export interface WeaverseNextRenderablePage extends WeaverseNextPageData {
|
|
12
|
+
/** Component item ID used as the root of the rendered page tree. */
|
|
13
|
+
rootId: string;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Browser runtime that adapts a Next.js loader payload to `@weaverse/react`
|
|
17
|
+
* and exposes the navigation, settings, and translation state used by Studio.
|
|
18
|
+
*/
|
|
19
|
+
export declare class WeaverseNextRuntime extends Weaverse {
|
|
20
|
+
/** Stable ID of the page owned by this runtime. */
|
|
21
|
+
pageId: string;
|
|
22
|
+
/** Mutable callbacks and stores consumed by the Studio bridge. */
|
|
23
|
+
internal: WeaverseNextRuntimeInternal;
|
|
24
|
+
/** Path, query, and locale metadata for Studio navigation. */
|
|
25
|
+
requestInfo: WeaverseNextRequestInfo;
|
|
26
|
+
/** Whether this runtime renders a component preview. */
|
|
27
|
+
isPreviewMode: boolean;
|
|
28
|
+
/** Whether this runtime renders a saved revision. */
|
|
29
|
+
isRevisionPreview: boolean;
|
|
30
|
+
/** Component type rendered in section preview mode. */
|
|
31
|
+
sectionType?: string;
|
|
32
|
+
/**
|
|
33
|
+
* Translation map received from Builder in design mode, keyed by item ID.
|
|
34
|
+
* `WeaverseNextItem.getSnapShot()` overlays these onto the data handed to
|
|
35
|
+
* components, so translations render without mutating the base `_store`.
|
|
36
|
+
*/
|
|
37
|
+
translationMap: WeaverseNextTranslationMap;
|
|
38
|
+
/** Locale associated with the item-level translation sidecar. */
|
|
39
|
+
translationLocale: string;
|
|
40
|
+
/** Weaverse language ID used when saving translation changes. */
|
|
41
|
+
translationLanguageId: string;
|
|
42
|
+
/**
|
|
43
|
+
* Fresh page data captured while React was rendering. Runtime reuse happens
|
|
44
|
+
* inside the renderer's render phase (`useMemo`), where applying it through
|
|
45
|
+
* `setProjectData()` would emit item updates to `useSyncExternalStore`
|
|
46
|
+
* subscribers mid-render. The renderer applies it post-commit via
|
|
47
|
+
* `flushRenderPhaseUpdates()`. Never set on design-mode runtimes — the live
|
|
48
|
+
* Studio tree owns the page data there.
|
|
49
|
+
*/
|
|
50
|
+
pendingProjectData?: WeaverseNextRenderablePage;
|
|
51
|
+
/**
|
|
52
|
+
* Reused item instances whose data was refreshed while this runtime was
|
|
53
|
+
* constructed during render (core `initProject()` calls `setData()` on
|
|
54
|
+
* them). Their data is already fresh; only the subscriber notification was
|
|
55
|
+
* deferred to `flushRenderPhaseUpdates()`.
|
|
56
|
+
*/
|
|
57
|
+
pendingItemUpdates: WeaverseNextItem[];
|
|
58
|
+
/** Create a browser runtime from a loaded page and its request context. */
|
|
59
|
+
constructor(config: WeaverseNextRuntimeConfig);
|
|
60
|
+
/**
|
|
61
|
+
* Pull `translationMap` / `translationLocale` / `translationLanguageId` off
|
|
62
|
+
* the current page data (Builder attaches them in design mode). Unlike
|
|
63
|
+
* Hydrogen, this also clears the sidecar to defaults when the new page data
|
|
64
|
+
* carries none, so a reused runtime / project-data swap can't leave a stale
|
|
65
|
+
* map overlaying the fresh tree.
|
|
66
|
+
*/
|
|
67
|
+
extractTranslationSidecar: () => void;
|
|
68
|
+
/**
|
|
69
|
+
* Replace the translation sidecar (Builder pushes this when translation data
|
|
70
|
+
* arrives or the active language changes) and refresh every item so their
|
|
71
|
+
* merged snapshots recompute.
|
|
72
|
+
*/
|
|
73
|
+
setTranslationSidecar: (map?: WeaverseNextTranslationMap, locale?: string, languageId?: string) => void;
|
|
74
|
+
/**
|
|
75
|
+
* Update a single translatable field for one item. Assigns a new per-item
|
|
76
|
+
* entry object so `WeaverseNextItem.getSnapShot()`'s translation-ref cache
|
|
77
|
+
* invalidates, then triggers only that item's subscribers.
|
|
78
|
+
*/
|
|
79
|
+
updateTranslation: (itemId: string, key: string, originalValue: string, translatedValue: string) => void;
|
|
80
|
+
/**
|
|
81
|
+
* Collect translation changes for the save flow. Returns `undefined` unless
|
|
82
|
+
* both the locale and language ID are set and at least one entry exists;
|
|
83
|
+
* each entry key is namespaced as `data.<field>` to match Builder.
|
|
84
|
+
*/
|
|
85
|
+
getTranslationChanges: () => WeaverseNextTranslationChanges | undefined;
|
|
86
|
+
/**
|
|
87
|
+
* Re-extract the translation sidecar whenever project data is replaced (route
|
|
88
|
+
* change / non-design reuse), before rebuilding item stores. Takes the
|
|
89
|
+
* renderable page shape (`rootId` resolved) that `getRenderablePage()` and
|
|
90
|
+
* the reuse branch pass in.
|
|
91
|
+
*/
|
|
92
|
+
setProjectData: (data: WeaverseNextRenderablePage) => void;
|
|
93
|
+
/**
|
|
94
|
+
* Apply updates deferred off the render phase: swap in any pending page data
|
|
95
|
+
* captured on runtime reuse, then notify items whose data was refreshed
|
|
96
|
+
* during construction. The renderer calls this from a layout effect right
|
|
97
|
+
* after commit, so subscribers re-render before paint (no content flash) and
|
|
98
|
+
* without React's setState-in-render warning.
|
|
99
|
+
*/
|
|
100
|
+
flushRenderPhaseUpdates: () => void;
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* Create a browser runtime or reuse the runtime already registered for the
|
|
104
|
+
* same page and request. Reuse preserves unsaved Studio state in design mode.
|
|
105
|
+
*/
|
|
106
|
+
export declare function createWeaverseNextRuntime(config: WeaverseNextRuntimeConfig): WeaverseNextRuntime;
|
|
107
|
+
/**
|
|
108
|
+
* Bind a design-mode runtime to the global Builder Studio bridge.
|
|
109
|
+
*
|
|
110
|
+
* @returns `true` when Studio was initialized or refreshed, otherwise `false`.
|
|
111
|
+
*/
|
|
112
|
+
export declare function bindWeaverseNextStudioRuntime(runtime: WeaverseNextRuntime): boolean;
|
|
113
|
+
//# sourceMappingURL=runtime.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../../src/runtime.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAC1C,OAAO,EAGL,KAAK,gBAAgB,EACtB,MAAM,QAAQ,CAAA;AAIf,OAAO,KAAK,EAGV,oBAAoB,EACpB,uBAAuB,EACvB,yBAAyB,EACzB,2BAA2B,EAC3B,8BAA8B,EAE9B,0BAA0B,EAC3B,MAAM,SAAS,CAAA;AAEhB,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,UAAU,CAAC,EAAE,mBAAmB,CAAA;QAChC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAA;KAClD;CACF;AAgJD,yEAAyE;AACzE,MAAM,WAAW,0BAA2B,SAAQ,oBAAoB;IACtE,oEAAoE;IACpE,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,QAAQ;IAC/C,mDAAmD;IACnD,MAAM,EAAE,MAAM,CAAA;IACd,kEAAkE;IAClE,QAAQ,EAAE,2BAA2B,CAAA;IACrC,8DAA8D;IAC9D,WAAW,EAAE,uBAAuB,CAAA;IACpC,wDAAwD;IACxD,aAAa,EAAE,OAAO,CAAA;IACtB,qDAAqD;IACrD,iBAAiB,EAAE,OAAO,CAAA;IAC1B,uDAAuD;IACvD,WAAW,CAAC,EAAE,MAAM,CAAA;IAGpB;;;;OAIG;IACH,cAAc,EAAE,0BAA0B,CAAK;IAC/C,iEAAiE;IACjE,iBAAiB,SAAW;IAC5B,iEAAiE;IACjE,qBAAqB,SAAW;IAEhC;;;;;;;OAOG;IACH,kBAAkB,CAAC,EAAE,0BAA0B,CAAA;IAE/C;;;;;OAKG;IACH,kBAAkB,EAAE,gBAAgB,EAAE,CAAK;IAE3C,2EAA2E;gBAC/D,MAAM,EAAE,yBAAyB;IAuD7C;;;;;;OAMG;IACH,yBAAyB,aAexB;IAED;;;;OAIG;IACH,qBAAqB,GACnB,MAAK,0BAA+B,EACpC,eAAW,EACX,mBAAe,UAMhB;IAED;;;;OAIG;IACH,iBAAiB,GACf,QAAQ,MAAM,EACd,KAAK,MAAM,EACX,eAAe,MAAM,EACrB,iBAAiB,MAAM,UAcxB;IAED;;;;OAIG;IACH,qBAAqB,QAAO,8BAA8B,GAAG,SAAS,CAsBrE;IAED;;;;;OAKG;IACH,cAAc,GAAI,MAAM,0BAA0B,UAIjD;IAED;;;;;;OAMG;IACH,uBAAuB,aActB;CACF;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,yBAAyB,GAChC,mBAAmB,CA2FrB;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,CAAC,OAAO,EAAE,mBAAmB,WAwCzE"}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import type { PageSEOData } from '@weaverse/schema';
|
|
2
|
+
import type { Metadata } from 'next';
|
|
3
|
+
import type { WeaverseNextLoaderData, WeaverseNextPageData } from './types';
|
|
4
|
+
/** Object containing an optional Weaverse page for SEO extraction. */
|
|
5
|
+
export interface WeaverseNextSeoPageContainer {
|
|
6
|
+
/** Page whose published SEO fields should be formatted. */
|
|
7
|
+
page?: WeaverseNextPageData | null;
|
|
8
|
+
}
|
|
9
|
+
/** Input accepted by {@link getWeaverseNextSeoMetadata}. */
|
|
10
|
+
export type WeaverseNextSeoInput = WeaverseNextLoaderData | WeaverseNextPageData | WeaverseNextSeoPageContainer | null | undefined;
|
|
11
|
+
/** Open Graph metadata accepted by Next.js's `Metadata` API. */
|
|
12
|
+
export type NextOpenGraph = NonNullable<Metadata['openGraph']>;
|
|
13
|
+
/** Twitter card metadata accepted by Next.js's `Metadata` API. */
|
|
14
|
+
export type NextTwitter = NonNullable<Metadata['twitter']>;
|
|
15
|
+
/**
|
|
16
|
+
* Weaverse page SEO expressed as a subset of Next's `Metadata`. Assignable to
|
|
17
|
+
* `Metadata` as-is: `const metadata: Metadata = getWeaverseNextSeoMetadata(data)`.
|
|
18
|
+
*/
|
|
19
|
+
export interface WeaverseNextSeoMetadata {
|
|
20
|
+
/** Canonical URL settings for Next's metadata API. */
|
|
21
|
+
alternates?: {
|
|
22
|
+
/** Preferred URL for search indexing. */
|
|
23
|
+
canonical?: string;
|
|
24
|
+
};
|
|
25
|
+
/** Page meta description. */
|
|
26
|
+
description?: string;
|
|
27
|
+
/** Page meta keywords. */
|
|
28
|
+
keywords?: string;
|
|
29
|
+
/** Open Graph metadata normalized to Next's supported union. */
|
|
30
|
+
openGraph?: NextOpenGraph;
|
|
31
|
+
/** Search crawler indexing and link-following directives. */
|
|
32
|
+
robots: {
|
|
33
|
+
/** Whether crawlers may follow links on the page. */
|
|
34
|
+
follow: boolean;
|
|
35
|
+
/** Whether crawlers may index the page. */
|
|
36
|
+
index: boolean;
|
|
37
|
+
};
|
|
38
|
+
/** Page title. */
|
|
39
|
+
title?: string;
|
|
40
|
+
/** Twitter card metadata normalized for Next's metadata API. */
|
|
41
|
+
twitter?: NextTwitter;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Convert Builder SEO fields into metadata accepted by Next.js.
|
|
45
|
+
*
|
|
46
|
+
* Unsupported Open Graph product types and incomplete Twitter app/player
|
|
47
|
+
* cards are safely downgraded to renderable Next.js variants.
|
|
48
|
+
*/
|
|
49
|
+
export declare function formatWeaverseNextSeoMetadata(seo: PageSEOData | null | undefined): WeaverseNextSeoMetadata;
|
|
50
|
+
/**
|
|
51
|
+
* Read page SEO from loader data or a page payload and format it for Next.js
|
|
52
|
+
* `generateMetadata`. Missing data returns indexable/followable robot defaults.
|
|
53
|
+
*/
|
|
54
|
+
export declare function getWeaverseNextSeoMetadata(data: WeaverseNextSeoInput): WeaverseNextSeoMetadata;
|
|
55
|
+
//# sourceMappingURL=seo.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"seo.d.ts","sourceRoot":"","sources":["../../src/seo.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAA;AACpC,OAAO,KAAK,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAE3E,sEAAsE;AACtE,MAAM,WAAW,4BAA4B;IAC3C,2DAA2D;IAC3D,IAAI,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAA;CACnC;AAED,4DAA4D;AAC5D,MAAM,MAAM,oBAAoB,GAC5B,sBAAsB,GACtB,oBAAoB,GACpB,4BAA4B,GAC5B,IAAI,GACJ,SAAS,CAAA;AAEb,gEAAgE;AAChE,MAAM,MAAM,aAAa,GAAG,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAA;AAE9D,kEAAkE;AAClE,MAAM,MAAM,WAAW,GAAG,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAA;AAE1D;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,sDAAsD;IACtD,UAAU,CAAC,EAAE;QACX,yCAAyC;QACzC,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,CAAA;IACD,6BAA6B;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,gEAAgE;IAChE,SAAS,CAAC,EAAE,aAAa,CAAA;IACzB,6DAA6D;IAC7D,MAAM,EAAE;QACN,qDAAqD;QACrD,MAAM,EAAE,OAAO,CAAA;QACf,2CAA2C;QAC3C,KAAK,EAAE,OAAO,CAAA;KACf,CAAA;IACD,kBAAkB;IAClB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,gEAAgE;IAChE,OAAO,CAAC,EAAE,WAAW,CAAA;CACtB;AA+BD;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAC3C,GAAG,EAAE,WAAW,GAAG,IAAI,GAAG,SAAS,GAClC,uBAAuB,CAiDzB;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CACxC,IAAI,EAAE,oBAAoB,GACzB,uBAAuB,CASzB"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type { WeaverseNextBaseConfigs, WeaverseNextRequestContext } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* Extract the request search params from the explicit Next request context.
|
|
4
|
+
* Prefers `searchParams`, falls back to parsing `url`.
|
|
5
|
+
*/
|
|
6
|
+
export declare function getContextSearchParams(context?: WeaverseNextRequestContext): URLSearchParams;
|
|
7
|
+
/** Overrides used while resolving request-scoped Weaverse configuration. */
|
|
8
|
+
export interface ResolveConfigsOptions {
|
|
9
|
+
/** Environment values; missing keys fall back to `process.env`. */
|
|
10
|
+
env?: Record<string, string | undefined>;
|
|
11
|
+
/** Public data API base override. */
|
|
12
|
+
weaverseApiBase?: string;
|
|
13
|
+
/** Studio origin override. */
|
|
14
|
+
weaverseHost?: string;
|
|
15
|
+
/** Studio asset version override. */
|
|
16
|
+
weaverseVersion?: string;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Derive Weaverse configs from the request context and env, close to Hydrogen's
|
|
20
|
+
* `getWeaverseConfigs`. Resolves the trusted host, public API base, design /
|
|
21
|
+
* preview / revision flags, and public env — but never resolves the final
|
|
22
|
+
* `projectId` (that priority chain, which may call an async resolver, lives in
|
|
23
|
+
* the server client). Query/env projectId candidates are returned for the
|
|
24
|
+
* client to combine with function/string inputs.
|
|
25
|
+
*/
|
|
26
|
+
export declare function getWeaverseNextConfigs(context?: WeaverseNextRequestContext, options?: ResolveConfigsOptions): WeaverseNextBaseConfigs;
|
|
27
|
+
//# sourceMappingURL=configs.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"configs.d.ts","sourceRoot":"","sources":["../../../src/server/configs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,uBAAuB,EACvB,0BAA0B,EAC3B,MAAM,UAAU,CAAA;AA6CjB;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,CAAC,EAAE,0BAA0B,GACnC,eAAe,CAWjB;AAkCD,4EAA4E;AAC5E,MAAM,WAAW,qBAAqB;IACpC,mEAAmE;IACnE,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAA;IACxC,qCAAqC;IACrC,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,8BAA8B;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,qCAAqC;IACrC,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB;AAED;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,CAAC,EAAE,0BAA0B,EACpC,OAAO,GAAE,qBAA0B,GAClC,uBAAuB,CAuDzB"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type { WeaverseNextRequestContext } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* Normalize the storefront URL sent in the Builder page API request body.
|
|
4
|
+
*
|
|
5
|
+
* The Builder reads only the pathname (locale/type/handle fallback) and the
|
|
6
|
+
* Weaverse/Studio control params from this URL, so keep exactly those and drop
|
|
7
|
+
* tracking params. Params are sorted for a stable, cache-friendly string.
|
|
8
|
+
*
|
|
9
|
+
* Ported from `@weaverse/hydrogen`'s `normalizePageUrl`, but tolerant of a
|
|
10
|
+
* relative URL (Next route handlers may only know the pathname).
|
|
11
|
+
*/
|
|
12
|
+
export declare function normalizeNextPageUrl(url: string): string;
|
|
13
|
+
/**
|
|
14
|
+
* Build an absolute-ish request URL string from the explicit request context,
|
|
15
|
+
* preferring `url`, then `pathname` + `searchParams`. Used as the input to
|
|
16
|
+
* {@link normalizeNextPageUrl}.
|
|
17
|
+
*/
|
|
18
|
+
export declare function resolveRequestUrl(context?: WeaverseNextRequestContext): string;
|
|
19
|
+
//# sourceMappingURL=normalize-page-url.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"normalize-page-url.d.ts","sourceRoot":"","sources":["../../../src/server/normalize-page-url.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,UAAU,CAAA;AAa1D;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAqBxD;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,OAAO,CAAC,EAAE,0BAA0B,GACnC,MAAM,CAkBR"}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { type WeaverseNextRevalidateRouteContext } from '../revalidate-item';
|
|
2
|
+
import type { WeaverseNextComponentData, WeaverseNextRequestContext, WeaverseNextServerClient } from '../types';
|
|
3
|
+
/** Configuration for the App Router item-revalidation handler. */
|
|
4
|
+
export interface WeaverseNextRevalidateHandlerConfig {
|
|
5
|
+
/**
|
|
6
|
+
* Reuse the app's server-client factory so the loader runs with the same
|
|
7
|
+
* component registry and commerce (storefront) context as page loads.
|
|
8
|
+
*
|
|
9
|
+
* The optional second argument is the validated, same-origin route context
|
|
10
|
+
* reconstructed from the request body. It is `undefined` for legacy bodies
|
|
11
|
+
* that carry no `routeContext`, so a one-argument `(request) => client`
|
|
12
|
+
* callback remains valid. Consumers must still source project ID, Studio
|
|
13
|
+
* host, API bases/keys, and env from server config — never from this
|
|
14
|
+
* browser-provided context.
|
|
15
|
+
*/
|
|
16
|
+
getClient: (request: Request, requestContext?: WeaverseNextRequestContext) => Promise<WeaverseNextServerClient> | WeaverseNextServerClient;
|
|
17
|
+
}
|
|
18
|
+
/** POST body accepted by the revalidate route. */
|
|
19
|
+
export interface WeaverseNextRevalidateRequestBody {
|
|
20
|
+
/** Unsaved Studio item settings to pass to the registered component loader. */
|
|
21
|
+
draftItem: WeaverseNextComponentData;
|
|
22
|
+
/** Public route identity used to reconstruct the loader request context. */
|
|
23
|
+
routeContext?: WeaverseNextRevalidateRouteContext;
|
|
24
|
+
}
|
|
25
|
+
/** App Router handler returned for Studio item revalidation requests. */
|
|
26
|
+
export interface WeaverseNextRevalidateHandler {
|
|
27
|
+
/** Handle a Studio request to rerun one registered component loader. */
|
|
28
|
+
POST: (request: Request) => Promise<Response>;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Create the Studio per-item revalidation route handler.
|
|
32
|
+
*
|
|
33
|
+
* Studio design-mode edits to loader-backed inputs (e.g. resource pickers) need
|
|
34
|
+
* fresh server loader data for a single item. Re-running it through
|
|
35
|
+
* `router.refresh()` re-applies the whole RSC tree — and the draft-item query
|
|
36
|
+
* rewrite changes the App Router page segment key, remounting the page and
|
|
37
|
+
* resetting scroll. This handler runs just the edited component's `loader`
|
|
38
|
+
* with the unsaved draft settings and returns the payload for an in-place
|
|
39
|
+
* client update (see the `2026-07-02--next-item-revalidation` spec).
|
|
40
|
+
*
|
|
41
|
+
* Security: only registered component types are executable, the handler never
|
|
42
|
+
* persists anything, and responses are `no-store`. Exposure is equivalent to
|
|
43
|
+
* the existing `weaverseDraftItem` URL param, which already lets any visitor
|
|
44
|
+
* run design-mode loaders with arbitrary draft settings.
|
|
45
|
+
*
|
|
46
|
+
* @example
|
|
47
|
+
* ```ts
|
|
48
|
+
* // app/api/weaverse/revalidate/route.ts
|
|
49
|
+
* export const { POST } = createWeaverseNextRevalidateHandler({
|
|
50
|
+
* getClient: () => getWeaverseServerClient(Promise.resolve({})),
|
|
51
|
+
* })
|
|
52
|
+
* ```
|
|
53
|
+
*/
|
|
54
|
+
export declare function createWeaverseNextRevalidateHandler(config: WeaverseNextRevalidateHandlerConfig): WeaverseNextRevalidateHandler;
|
|
55
|
+
//# sourceMappingURL=revalidate-handler.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"revalidate-handler.d.ts","sourceRoot":"","sources":["../../../src/server/revalidate-handler.ts"],"names":[],"mappings":"AAEA,OAAO,EAGL,KAAK,kCAAkC,EACxC,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EACV,yBAAyB,EAEzB,0BAA0B,EAC1B,wBAAwB,EACzB,MAAM,UAAU,CAAA;AAsBjB,kEAAkE;AAClE,MAAM,WAAW,mCAAmC;IAClD;;;;;;;;;;OAUG;IACH,SAAS,EAAE,CACT,OAAO,EAAE,OAAO,EAChB,cAAc,CAAC,EAAE,0BAA0B,KACxC,OAAO,CAAC,wBAAwB,CAAC,GAAG,wBAAwB,CAAA;CAClE;AAED,kDAAkD;AAClD,MAAM,WAAW,iCAAiC;IAChD,+EAA+E;IAC/E,SAAS,EAAE,yBAAyB,CAAA;IACpC,4EAA4E;IAC5E,YAAY,CAAC,EAAE,kCAAkC,CAAA;CAClD;AAoMD,yEAAyE;AACzE,MAAM,WAAW,6BAA6B;IAC5C,wEAAwE;IACxE,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;CAC9C;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,mCAAmC,CACjD,MAAM,EAAE,mCAAmC,GAC1C,6BAA6B,CAqE/B"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type { WeaverseNextServerClient, WeaverseNextServerClientConfig } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* Create a server-side {@link WeaverseNextServerClient} for Next.js App Router
|
|
4
|
+
* routes / server components.
|
|
5
|
+
*
|
|
6
|
+
* @example
|
|
7
|
+
* ```ts
|
|
8
|
+
* let weaverse = createWeaverseNextServerClient({
|
|
9
|
+
* projectId: process.env.WEAVERSE_PROJECT_ID,
|
|
10
|
+
* components,
|
|
11
|
+
* commerce: { storefront },
|
|
12
|
+
* requestContext: { url, headers, searchParams, i18n },
|
|
13
|
+
* cache: { revalidate: 60, tags: ['weaverse'] },
|
|
14
|
+
* })
|
|
15
|
+
* let data = await weaverse.loadPage({ type: 'INDEX' })
|
|
16
|
+
* let theme = await weaverse.loadThemeSettings()
|
|
17
|
+
* ```
|
|
18
|
+
*/
|
|
19
|
+
export declare function createWeaverseNextServerClient(config: WeaverseNextServerClientConfig): WeaverseNextServerClient;
|
|
20
|
+
export { getContextSearchParams } from './configs';
|
|
21
|
+
//# sourceMappingURL=server-client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"server-client.d.ts","sourceRoot":"","sources":["../../../src/server/server-client.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAgBV,wBAAwB,EACxB,8BAA8B,EAM/B,MAAM,UAAU,CAAA;AAsqBjB;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,8BAA8B,CAC5C,MAAM,EAAE,8BAA8B,GACrC,wBAAwB,CAE1B;AAED,OAAO,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAA"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Server-only Weaverse APIs for Next.js App Router server components and route
|
|
3
|
+
* handlers.
|
|
4
|
+
*
|
|
5
|
+
* When migrating from Hydrogen's `context.weaverse`, create a request-scoped
|
|
6
|
+
* client with {@link createWeaverseNextServerClient}, then call `loadPage()` or
|
|
7
|
+
* `loadThemeSettings()`. Keep rendering providers and components imported from
|
|
8
|
+
* the root `@weaverse/next` entrypoint.
|
|
9
|
+
*
|
|
10
|
+
* @packageDocumentation
|
|
11
|
+
*/
|
|
12
|
+
export type { WeaverseNextRevalidateRouteContext } from './revalidate-item';
|
|
13
|
+
export { formatWeaverseNextSeoMetadata, getWeaverseNextSeoMetadata, type NextOpenGraph, type NextTwitter, type WeaverseNextSeoInput, type WeaverseNextSeoMetadata, type WeaverseNextSeoPageContainer, } from './seo';
|
|
14
|
+
export { getWeaverseNextConfigs, type ResolveConfigsOptions, } from './server/configs';
|
|
15
|
+
export { normalizeNextPageUrl, resolveRequestUrl, } from './server/normalize-page-url';
|
|
16
|
+
export { createWeaverseNextRevalidateHandler, type WeaverseNextRevalidateHandler, type WeaverseNextRevalidateHandlerConfig, type WeaverseNextRevalidateRequestBody, } from './server/revalidate-handler';
|
|
17
|
+
export { createWeaverseNextServerClient } from './server/server-client';
|
|
18
|
+
export type { WeaverseNextBaseConfigs, WeaverseNextCacheConfig, WeaverseNextClient, WeaverseNextCommerceContext, WeaverseNextComponent, WeaverseNextComponentData, WeaverseNextComponentLoaderArgs, WeaverseNextComponentProps, WeaverseNextConfigs, WeaverseNextCustomPageEntry, WeaverseNextFetchCustomPagesOptions, WeaverseNextFetchOptions, WeaverseNextI18n, WeaverseNextLoaderData, WeaverseNextLoadPageInput, WeaverseNextPageAssignment, WeaverseNextPageData, WeaverseNextProjectId, WeaverseNextRequestContext, WeaverseNextServerClient, WeaverseNextServerClientConfig, WeaverseNextServerLoadPageInput, WeaverseNextStorefront, WeaverseNextThemeSchema, WeaverseNextThemeSchemaGroup, WeaverseNextThemeSchemaInput, WeaverseNextThemeSettingsOptions, WeaverseNextThemeSettingsResponse, } from './types';
|
|
19
|
+
//# sourceMappingURL=server.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../src/server.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,YAAY,EAAE,kCAAkC,EAAE,MAAM,mBAAmB,CAAA;AAC3E,OAAO,EACL,6BAA6B,EAC7B,0BAA0B,EAC1B,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC5B,KAAK,4BAA4B,GAClC,MAAM,OAAO,CAAA;AACd,OAAO,EACL,sBAAsB,EACtB,KAAK,qBAAqB,GAC3B,MAAM,kBAAkB,CAAA;AACzB,OAAO,EACL,oBAAoB,EACpB,iBAAiB,GAClB,MAAM,6BAA6B,CAAA;AACpC,OAAO,EACL,mCAAmC,EACnC,KAAK,6BAA6B,EAClC,KAAK,mCAAmC,EACxC,KAAK,iCAAiC,GACvC,MAAM,6BAA6B,CAAA;AACpC,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAA;AACvE,YAAY,EACV,uBAAuB,EACvB,uBAAuB,EACvB,kBAAkB,EAClB,2BAA2B,EAC3B,qBAAqB,EACrB,yBAAyB,EACzB,+BAA+B,EAC/B,0BAA0B,EAC1B,mBAAmB,EACnB,2BAA2B,EAC3B,mCAAmC,EACnC,wBAAwB,EACxB,gBAAgB,EAChB,sBAAsB,EACtB,yBAAyB,EACzB,0BAA0B,EAC1B,oBAAoB,EACpB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,8BAA8B,EAC9B,+BAA+B,EAC/B,sBAAsB,EACtB,uBAAuB,EACvB,4BAA4B,EAC5B,4BAA4B,EAC5B,gCAAgC,EAChC,iCAAiC,GAClC,MAAM,SAAS,CAAA"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { type WeaverseNextRuntime } from './runtime';
|
|
2
|
+
import type { WeaverseNextRuntimeInternal } from './types';
|
|
3
|
+
/** Runtime and host callbacks attached to the Builder Studio bridge. */
|
|
4
|
+
export interface WeaverseNextStudioBridgeProps {
|
|
5
|
+
/** Preview navigation callback. */
|
|
6
|
+
navigate?: WeaverseNextRuntimeInternal['navigate'];
|
|
7
|
+
/** Whole-route refresh callback used as a legacy fallback. */
|
|
8
|
+
revalidate?: WeaverseNextRuntimeInternal['revalidate'];
|
|
9
|
+
/** Preferred per-item loader revalidation callback. */
|
|
10
|
+
revalidateItem?: WeaverseNextRuntimeInternal['revalidateItem'];
|
|
11
|
+
/** Browser runtime to initialize or refresh in Studio. */
|
|
12
|
+
runtime: WeaverseNextRuntime;
|
|
13
|
+
}
|
|
14
|
+
/** Page-level Studio runtime binder. */
|
|
15
|
+
export declare function WeaverseNextStudioBridge(props: WeaverseNextStudioBridgeProps): null;
|
|
16
|
+
//# sourceMappingURL=studio-bridge.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"studio-bridge.d.ts","sourceRoot":"","sources":["../../src/studio-bridge.tsx"],"names":[],"mappings":"AAGA,OAAO,EAEL,KAAK,mBAAmB,EACzB,MAAM,WAAW,CAAA;AAClB,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,SAAS,CAAA;AAK1D,wEAAwE;AACxE,MAAM,WAAW,6BAA6B;IAC5C,mCAAmC;IACnC,QAAQ,CAAC,EAAE,2BAA2B,CAAC,UAAU,CAAC,CAAA;IAClD,8DAA8D;IAC9D,UAAU,CAAC,EAAE,2BAA2B,CAAC,YAAY,CAAC,CAAA;IACtD,uDAAuD;IACvD,cAAc,CAAC,EAAE,2BAA2B,CAAC,gBAAgB,CAAC,CAAA;IAC9D,0DAA0D;IAC1D,OAAO,EAAE,mBAAmB,CAAA;CAC7B;AAED,wCAAwC;AACxC,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,6BAA6B,QAwD5E"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type { WeaverseNextRequestContext } from './types';
|
|
2
|
+
/** Trust context used while loading the Studio bridge script. */
|
|
3
|
+
export interface LoadWeaverseNextStudioScriptOptions {
|
|
4
|
+
/** Storefront hostname; required to permit loopback Studio origins. */
|
|
5
|
+
storefrontHostname?: string;
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* Resolve and append the Next Studio bridge script for the given request
|
|
9
|
+
* context, deduping by src. SSR-safe (no-op without `document`) so it can run
|
|
10
|
+
* unconditionally from a root layout/error boundary before any page tree or
|
|
11
|
+
* runtime exists — e.g. App Router `not-found.tsx` / `error.tsx` routes.
|
|
12
|
+
*/
|
|
13
|
+
export declare function loadWeaverseNextStudioScript(context?: WeaverseNextRequestContext, options?: LoadWeaverseNextStudioScriptOptions): void;
|
|
14
|
+
/** Props for the root-level Studio script connector. */
|
|
15
|
+
export interface WeaverseNextStudioConnectProps {
|
|
16
|
+
/** Explicit request context used to resolve Studio mode and host. */
|
|
17
|
+
context?: WeaverseNextRequestContext;
|
|
18
|
+
/** Storefront hostname; required to permit loopback Studio origins. */
|
|
19
|
+
storefrontHostname?: string;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Root-level Studio script connector for Next client boundaries. Mount once
|
|
23
|
+
* near the app root (e.g. root layout) so it also covers routes that never
|
|
24
|
+
* render `WeaverseNextRenderer`, such as `not-found.tsx` / `error.tsx`.
|
|
25
|
+
*/
|
|
26
|
+
export declare function WeaverseNextStudioConnect(props: WeaverseNextStudioConnectProps): null;
|
|
27
|
+
//# sourceMappingURL=studio-connect.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"studio-connect.d.ts","sourceRoot":"","sources":["../../src/studio-connect.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,SAAS,CAAA;AA0BzD,iEAAiE;AACjE,MAAM,WAAW,mCAAmC;IAClD,uEAAuE;IACvE,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAC1C,OAAO,CAAC,EAAE,0BAA0B,EACpC,OAAO,GAAE,mCAAwC,QAkBlD;AAED,wDAAwD;AACxD,MAAM,WAAW,8BAA8B;IAC7C,qEAAqE;IACrE,OAAO,CAAC,EAAE,0BAA0B,CAAA;IACpC,uEAAuE;IACvE,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,CACvC,KAAK,EAAE,8BAA8B,QAStC"}
|