@riverbankcms/sdk 0.88.0 → 0.90.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.
- package/README.md +27 -4
- package/dist/{PreviewEditorSidebar-EVRS3C7T.mjs → PreviewEditorSidebar-KVXNF3VW.mjs} +3 -3
- package/dist/{PreviewEditorUI-54WD4IGE.mjs → PreviewEditorUI-J3JN5Z7T.mjs} +3 -3
- package/dist/SdkPreviewModeRuntime-UBL6MSNP.mjs +8 -0
- package/dist/_dts/ai/src/contracts/proposals.d.ts +216 -0
- package/dist/_dts/altcha/src/AltchaWidget.d.ts +1 -1
- package/dist/_dts/api/src/accessAdmin.d.ts +7 -0
- package/dist/_dts/api/src/bookingOperations.d.ts +2 -0
- package/dist/_dts/api/src/bookingRecords.d.ts +4 -2
- package/dist/_dts/api/src/bookings.d.ts +3 -1
- package/dist/_dts/api/src/endpoints.d.ts +8 -0
- package/dist/_dts/api/src/index.d.ts +7 -6
- package/dist/_dts/api/src/publicExperienceEndpoints.d.ts +15 -5
- package/dist/_dts/api/src/request.d.ts +21 -0
- package/dist/_dts/api/src/sdk-event-upsert.d.ts +3 -1
- package/dist/_dts/api/src/sdkContracts.d.ts +2 -0
- package/dist/_dts/api/src/siteManagementEndpoints.d.ts +5 -1
- package/dist/_dts/api/src/siteMembers.d.ts +6 -1
- package/dist/_dts/api/src/types.d.ts +4 -2
- package/dist/_dts/api/src/url.d.ts +6 -3
- package/dist/_dts/block-form/src/utils/visibleWhen.d.ts +1 -0
- package/dist/_dts/block-form/src/widgets/RepeaterField/components/RepeaterThumbnailCard.d.ts +5 -1
- package/dist/_dts/block-form/src/widgets/RepeaterField/components/RepeaterThumbnailGrid.d.ts +9 -1
- package/dist/_dts/block-form/src/widgets/RepeaterField/components/index.d.ts +1 -0
- package/dist/_dts/blocks/src/contracts/non-block-islands.d.ts +7 -11
- package/dist/_dts/blocks/src/contracts/proof-block-islands.d.ts +6 -0
- package/dist/_dts/blocks/src/index.d.ts +2 -1
- package/dist/_dts/blocks/src/system/blocks/events/event-calendar.d.ts +14 -6
- package/dist/_dts/blocks/src/system/blocks/events/shared/types.d.ts +4 -4
- package/dist/_dts/blocks/src/system/blocks/hero.d.ts +0 -2
- package/dist/_dts/blocks/src/system/blocks/shop.d.ts +3 -3
- package/dist/_dts/blocks/src/system/blocks/shop.shared.d.ts +8 -0
- package/dist/_dts/blocks/src/system/constants/events.d.ts +4 -1
- package/dist/_dts/blocks/src/system/icons/cta.d.ts +3 -3
- package/dist/_dts/blocks/src/system/icons/index.d.ts +1 -0
- package/dist/_dts/blocks/src/system/icons/registry.d.ts +2 -2
- package/dist/_dts/blocks/src/system/icons/semantic.d.ts +3 -3
- package/dist/_dts/blocks/src/system/icons/svg.d.ts +72 -0
- package/dist/_dts/blocks/src/system/manifest/schema.d.ts +3 -1
- package/dist/_dts/blocks/src/system/runtime/api/index.d.ts +1 -0
- package/dist/_dts/blocks/src/system/runtime/api/types.d.ts +18 -5
- package/dist/_dts/blocks/src/system/runtime/components/registry.client.d.ts +51 -6
- package/dist/_dts/blocks/src/system/runtime/components/runtime-backed-blocks.d.ts +24 -0
- package/dist/_dts/blocks/src/system/runtime/hooks/loadStateError.d.ts +1 -0
- package/dist/_dts/blocks/src/system/runtime/hooks/useAvailableDates.d.ts +1 -1
- package/dist/_dts/blocks/src/system/runtime/hooks/useAvailableDates.state.d.ts +55 -0
- package/dist/_dts/blocks/src/system/runtime/hooks/useAvailableSlots.state.d.ts +39 -0
- package/dist/_dts/blocks/src/system/runtime/hooks/useBookingFormConfig.d.ts +4 -27
- package/dist/_dts/blocks/src/system/runtime/hooks/useBookingFormConfig.state.d.ts +40 -0
- package/dist/_dts/blocks/src/system/runtime/hooks/useCalendarEvents.state.d.ts +20 -0
- package/dist/_dts/blocks/src/system/runtime/hooks/useEventFilters.state.d.ts +31 -0
- package/dist/_dts/blocks/src/system/runtime/hooks/useEventPagination.d.ts +3 -3
- package/dist/_dts/blocks/src/system/runtime/hooks/useEventPagination.state.d.ts +39 -0
- package/dist/_dts/blocks/src/system/runtime/nodes/course-registration/useCourseRegistrationWizard.d.ts +2 -2
- package/dist/_dts/blocks/src/system/runtime/nodes/event-details/logic.d.ts +1 -17
- package/dist/_dts/blocks/src/system/runtime/nodes/event-details.client.d.ts +5 -9
- package/dist/_dts/blocks/src/system/runtime/nodes/event-details.server.d.ts +5 -9
- package/dist/_dts/blocks/src/system/runtime/nodes/event-registration/event-registration.headless.contract.d.ts +2 -1
- package/dist/_dts/blocks/src/system/runtime/nodes/event-registration/eventPaymentOptions.d.ts +24 -0
- package/dist/_dts/blocks/src/system/runtime/nodes/event-registration/types.d.ts +5 -0
- package/dist/_dts/blocks/src/system/runtime/nodes/event-registration/useDiscountCodeUi.d.ts +4 -4
- package/dist/_dts/blocks/src/system/runtime/nodes/event-registration/useDiscountCodeUi.state.d.ts +50 -0
- package/dist/_dts/blocks/src/system/runtime/nodes/event-registration/useEventRegistrationWizard.d.ts +2 -2
- package/dist/_dts/blocks/src/system/runtime/nodes/event-registration.interactive.d.ts +21 -0
- package/dist/_dts/blocks/src/system/runtime/nodes/event-registration.server.d.ts +1 -1
- package/dist/_dts/blocks/src/system/runtime/nodes/events/EventCalendar.interactive.d.ts +11 -1
- package/dist/_dts/blocks/src/system/runtime/nodes/events/EventCombined.client.d.ts +2 -1
- package/dist/_dts/blocks/src/system/runtime/nodes/events/EventCombined.interactive.d.ts +11 -1
- package/dist/_dts/blocks/src/system/runtime/nodes/events/shared/EventPaginatedListView.client.d.ts +1 -1
- package/dist/_dts/blocks/src/system/runtime/nodes/events/shared/calendarViewOptions.d.ts +10 -0
- package/dist/_dts/blocks/src/system/runtime/nodes/events/shared/eventProductEligibility.d.ts +24 -0
- package/dist/_dts/blocks/src/system/runtime/nodes/newsletter-form.client.state.d.ts +24 -2
- package/dist/_dts/blocks/src/system/runtime/nodes/shared/MagicLinkForm.state.d.ts +24 -0
- package/dist/_dts/blocks/src/system/runtime/nodes/shared/contract-schemas.d.ts +5 -2
- package/dist/_dts/blocks/src/system/runtime/nodes/shop-checkout-form.d.ts +2 -2
- package/dist/_dts/blocks/src/system/runtime/shared/useWaitlistClaim.state.d.ts +35 -0
- package/dist/_dts/content-model/src/entry-slots/index.d.ts +1 -0
- package/dist/_dts/content-model/src/entry-slots/sdkBlocks.d.ts +21 -0
- package/dist/_dts/content-model/src/entry-slots/types.d.ts +61 -0
- package/dist/_dts/core/src/branded.d.ts +7 -0
- package/dist/_dts/core/src/index.d.ts +1 -0
- package/dist/_dts/core/src/money-input.d.ts +18 -0
- package/dist/_dts/core/src/site-route-target.d.ts +40 -0
- package/dist/_dts/db/src/generated/supabase/database.types.d.ts +209 -2
- package/dist/_dts/media-core/src/fileDomain.d.ts +4 -0
- package/dist/_dts/media-editor/src/MediaEditor.d.ts +2 -1
- package/dist/_dts/media-editor/src/fieldUi.d.ts +6 -0
- package/dist/_dts/media-editor/src/index.d.ts +1 -1
- package/dist/_dts/preview-next/src/client/index.d.ts +1 -0
- package/dist/_dts/preview-next/src/client/preview/PreviewShell.d.ts +3 -2
- package/dist/_dts/preview-next/src/client/preview/PreviewShellLayout.d.ts +3 -2
- package/dist/_dts/preview-next/src/client/preview/PreviewThemedSiteDocument.d.ts +3 -2
- package/dist/_dts/preview-next/src/client/preview/SiteChromeEditableSurface.d.ts +2 -2
- package/dist/_dts/preview-next/src/client/preview/themeRuntime.d.ts +6 -0
- package/dist/_dts/preview-next/src/client/sdk/SdkPreviewMode.d.ts +2 -1
- package/dist/_dts/sdk/src/cli/commands/pull-dated-offering-scope.d.ts +10 -0
- package/dist/_dts/sdk/src/cli/content/reader.d.ts +12 -5
- package/dist/_dts/sdk/src/client/management/types.d.ts +6 -55
- package/dist/_dts/sdk/src/client/runtimeCachePolicy.d.ts +160 -0
- package/dist/_dts/sdk/src/client/types.d.ts +26 -1
- package/dist/_dts/sdk/src/components.d.ts +1 -0
- package/dist/_dts/sdk/src/config/field-definitions.d.ts +3 -1
- package/dist/_dts/sdk/src/contracts/system-block-content.d.ts +3 -1
- package/dist/_dts/sdk/src/index.d.ts +3 -1
- package/dist/_dts/sdk/src/next/types.d.ts +8 -11
- package/dist/_dts/sdk/src/preview-next/client/index.d.ts +1 -1
- package/dist/_dts/sdk/src/rendering/blocks-theme-scope.d.ts +2 -1
- package/dist/_dts/sdk/src/rendering/components/Layout.d.ts +8 -7
- package/dist/_dts/sdk/src/rendering/components/pageShared.d.ts +5 -6
- package/dist/_dts/sdk/src/rendering/index.d.ts +1 -0
- package/dist/_dts/sdk/src/rendering/server.d.ts +1 -0
- package/dist/_dts/sdk/src/rendering/themeRuntime.d.ts +26 -0
- package/dist/_dts/sdk/src/version.d.ts +1 -1
- package/dist/_dts/site-commands/src/commands.d.ts +18 -0
- package/dist/_dts/theme-core/src/ResponsiveScope.d.ts +12 -0
- package/dist/_dts/theme-core/src/accordions/types.d.ts +1 -1
- package/dist/_dts/theme-core/src/buttons/personalities/types.d.ts +2 -2
- package/dist/_dts/theme-core/src/buttons/types.d.ts +5 -5
- package/dist/_dts/theme-core/src/cards/types.d.ts +2 -2
- package/dist/_dts/theme-core/src/generated/containerResponsiveThemeCss.d.ts +1 -1
- package/dist/_dts/theme-core/src/index.d.ts +2 -0
- package/dist/_dts/theme-core/src/mock-themes/all.d.ts +21 -21
- package/dist/_dts/theme-core/src/schema.d.ts +18 -18
- package/dist/_dts/theme-core/src/site-styles/designState.d.ts +2 -2
- package/dist/_dts/theme-core/src/site-styles/generatedSchemas.d.ts +2 -2
- package/dist/_dts/theme-core/src/site-styles/logoBranding.d.ts +4 -4
- package/dist/_dts/theme-core/src/themeRuntime.d.ts +11 -0
- package/dist/{chunk-ER4UIW4X.mjs → chunk-AEOYWPE4.mjs} +91 -55
- package/dist/{chunk-O4LVYUVH.mjs → chunk-BOQXMCSP.mjs} +147 -101
- package/dist/{chunk-HVOBXA3Y.mjs → chunk-GSPFFUVB.mjs} +2 -2
- package/dist/{chunk-7KOO7RPP.mjs → chunk-PMBB6MQ7.mjs} +2273 -1113
- package/dist/{chunk-K3JWH6HE.mjs → chunk-RQ3XZ4SJ.mjs} +9 -1
- package/dist/{chunk-YDMBIIS5.mjs → chunk-UG7I7S7W.mjs} +1 -1
- package/dist/cli/index.mjs +1564 -546
- package/dist/cli/init-docs/content/cli-reference.md +6 -1
- package/dist/cli/init-docs/content/content-management.md +27 -0
- package/dist/client/{accordion-PT5CGW5N.mjs → accordion-GXQNWQ6O.mjs} +2 -2
- package/dist/client/{bookingForm-2HLRTEYS.mjs → bookingForm-STLUJ36H.mjs} +206 -335
- package/dist/client/bookings.mjs +821 -413
- package/dist/client/{carousel-Z2LKYSWA.mjs → carousel-CVRN6EPP.mjs} +4 -3
- package/dist/client/{cart-ND5IK4A6.mjs → cart-IYIBA5CL.mjs} +8 -8
- package/dist/client/{checkout-EYUSGAY7.mjs → checkout-O3BGM4GS.mjs} +8 -8
- package/dist/client/chunk-4RTFGHZN.mjs +433 -0
- package/dist/client/{chunk-DIRW2LNG.mjs → chunk-6DPXDOIL.mjs} +336 -225
- package/dist/client/chunk-6N7YRNYU.mjs +183 -0
- package/dist/client/{chunk-O5JNI3E4.mjs → chunk-7DH35FGA.mjs} +2 -2
- package/dist/client/{chunk-S4G65LGR.mjs → chunk-D3ETC2SU.mjs} +1 -1
- package/dist/client/{chunk-BAWHZ5GM.mjs → chunk-DAS5CIER.mjs} +460 -157
- package/dist/client/{chunk-6DVPO44G.mjs → chunk-FHU6PFPM.mjs} +1 -1
- package/dist/client/{chunk-SDIYSQAY.mjs → chunk-HIHOQGIP.mjs} +2 -3
- package/dist/client/{chunk-BL66UWGD.mjs → chunk-MFPKS6QS.mjs} +13 -16
- package/dist/client/{chunk-X7GVFB7Y.mjs → chunk-NBFRJ5NB.mjs} +157 -5
- package/dist/client/{chunk-WCVK4MBJ.mjs → chunk-VFHZLZAC.mjs} +1 -1
- package/dist/client/{chunk-GOFO7HRH.mjs → chunk-WHZQDPBZ.mjs} +19 -1
- package/dist/client/{chunk-MHBEWDT7.mjs → chunk-Z62JYS5O.mjs} +122 -50
- package/dist/client/client.mjs +5979 -5198
- package/dist/client/{courseRegistration-H3AZBUEG.mjs → courseRegistration-2D3ACMJR.mjs} +20 -58
- package/dist/client/{eventCalendar-FPKJGLGS.mjs → eventCalendar-QY4UZUFF.mjs} +11 -11
- package/dist/client/{eventCombined-QCGIZBUY.mjs → eventCombined-RRCDKJC2.mjs} +11 -11
- package/dist/client/{eventDetails-HIT3BJWU.mjs → eventDetails-YO335BUT.mjs} +11 -11
- package/dist/client/{eventListing-R4HNWJDN.mjs → eventListing-PXA6GFQ3.mjs} +11 -11
- package/dist/client/{eventRegistration-Q7BYY5HF.mjs → eventRegistration-2ZHEDDXO.mjs} +11 -11
- package/dist/client/{form-NI6YOG6S.mjs → form-ZS6KX4U2.mjs} +7 -7
- package/dist/client/{headerSection-SDYGII36.mjs → headerSection-QK5SLIIB.mjs} +3 -3
- package/dist/client/hooks.mjs +1102 -1029
- package/dist/client/{locationMap-BDETEUQD.mjs → locationMap-GFNIUD2X.mjs} +3 -3
- package/dist/client/{newsletterForm-EKYIU67X.mjs → newsletterForm-PGLTTCUG.mjs} +61 -25
- package/dist/client/{productDetail-5UTGNN76.mjs → productDetail-OPBE5ZPI.mjs} +8 -8
- package/dist/client/{productList-7YA5KXZQ.mjs → productList-NI72Q62Z.mjs} +8 -8
- package/dist/client/rendering/client.mjs +4390 -4245
- package/dist/client/rendering/islands.mjs +19 -19
- package/dist/client/rendering.mjs +3327 -3181
- package/dist/client/{shop-AIMUMZYC.mjs → shop-3ZQPEWYI.mjs} +8 -8
- package/dist/client/spam-protection.mjs +4 -5
- package/dist/preview-next/before-render.mjs +20 -2
- package/dist/preview-next/client/runtime.mjs +5 -5
- package/dist/preview-next/middleware.mjs +18 -0
- package/dist/{sdk-runtime-NW472WNT.mjs → sdk-runtime-FSHXCWDS.mjs} +6 -6
- package/dist/server/components.mjs +2580 -2783
- package/dist/server/config-validation.mjs +1334 -1261
- package/dist/server/config.mjs +1334 -1261
- package/dist/server/data.mjs +1102 -1029
- package/dist/server/index.mjs +1097 -476
- package/dist/server/navigation.mjs +20 -30
- package/dist/server/next.mjs +3282 -2847
- package/dist/server/page-converter.mjs +1009 -946
- package/dist/server/prebuild.mjs +1 -1
- package/dist/server/rendering/server.mjs +2580 -2783
- package/dist/server/rendering.mjs +2586 -2789
- package/dist/server/routing.mjs +1440 -1053
- package/dist/server/server.mjs +1886 -1153
- package/dist/server/theme-bridge.mjs +34 -5
- package/dist/styles/index.css +26 -0
- package/package.json +3 -2
- package/dist/SdkPreviewModeRuntime-ZALZDJEK.mjs +0 -8
- package/dist/client/chunk-H4MHEXYS.mjs +0 -184
- package/dist/client/chunk-ZFHRN6W2.mjs +0 -66
- /package/dist/client/{chunk-LI2C6M5O.mjs → chunk-25W2EQUN.mjs} +0 -0
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
import type { PublicEndpointName } from '../public-api/contracts';
|
|
2
|
+
import type { GetPageParams, GetSiteParams } from './types';
|
|
3
|
+
declare const publishedRuntimeCacheKeyBrand: unique symbol;
|
|
4
|
+
declare const publishedRuntimeCachePayloadSchemaVersionBrand: unique symbol;
|
|
5
|
+
export type PublishedRuntimeCacheKey = string & {
|
|
6
|
+
readonly [publishedRuntimeCacheKeyBrand]: 'PublishedRuntimeCacheKey';
|
|
7
|
+
};
|
|
8
|
+
export type PublishedRuntimeCachePayloadSchemaVersion = number & {
|
|
9
|
+
readonly [publishedRuntimeCachePayloadSchemaVersionBrand]: 'PublishedRuntimeCachePayloadSchemaVersion';
|
|
10
|
+
};
|
|
11
|
+
export declare const DEFAULT_PUBLISHED_RUNTIME_CACHE_PAYLOAD_SCHEMA_VERSION: PublishedRuntimeCachePayloadSchemaVersion;
|
|
12
|
+
export type RuntimeCachePolicyKind = 'durable-public-stale' | 'memory-only' | 'live-only';
|
|
13
|
+
export type RuntimeCacheLiveOnlyReason = 'unknown_endpoint' | 'non_get_request' | 'preview_request' | 'force_refresh' | 'opaque_batch_loader' | 'challenge_endpoint' | 'auth_required' | 'safety_sensitive_booking';
|
|
14
|
+
export type RuntimeCachePolicy = Readonly<{
|
|
15
|
+
kind: 'durable-public-stale';
|
|
16
|
+
endpoint: PublicEndpointName;
|
|
17
|
+
freshTtlSec: number;
|
|
18
|
+
staleTtlSec: number;
|
|
19
|
+
}> | Readonly<{
|
|
20
|
+
kind: 'memory-only';
|
|
21
|
+
endpoint: PublicEndpointName;
|
|
22
|
+
freshTtlSec: number;
|
|
23
|
+
reason: 'durable_rollout_pending';
|
|
24
|
+
}> | Readonly<{
|
|
25
|
+
kind: 'live-only';
|
|
26
|
+
endpoint: string;
|
|
27
|
+
reason: RuntimeCacheLiveOnlyReason;
|
|
28
|
+
}>;
|
|
29
|
+
export type RuntimeCacheParams = Readonly<Record<string, string | number | boolean | null | undefined>>;
|
|
30
|
+
export type ResolveRuntimeCachePolicyInput = Readonly<{
|
|
31
|
+
endpoint: string;
|
|
32
|
+
method?: string;
|
|
33
|
+
params?: RuntimeCacheParams;
|
|
34
|
+
}>;
|
|
35
|
+
export declare function resolveRuntimeCachePolicy(input: ResolveRuntimeCachePolicyInput): RuntimeCachePolicy;
|
|
36
|
+
export type GetSiteRuntimeCacheParams = Readonly<Pick<GetSiteParams, 'id' | 'slug' | 'domain' | 'currentPath' | 'force'>>;
|
|
37
|
+
export type GetContentByPathRuntimeCacheParams = Readonly<Pick<GetPageParams, 'siteId' | 'path' | 'preview'>>;
|
|
38
|
+
type KeyDeriverInputByEndpoint = Readonly<{
|
|
39
|
+
getSite: GetSiteRuntimeCacheParams;
|
|
40
|
+
getContentByPath: GetContentByPathRuntimeCacheParams;
|
|
41
|
+
}>;
|
|
42
|
+
export type PublishedRuntimeCacheKeyEndpoint = keyof typeof DURABLE_RUNTIME_CACHE_KEY_DERIVERS;
|
|
43
|
+
export type ParsePublishedRuntimeCacheKeyResult = Readonly<{
|
|
44
|
+
ok: true;
|
|
45
|
+
key: PublishedRuntimeCacheKey;
|
|
46
|
+
endpoint: PublishedRuntimeCacheKeyEndpoint;
|
|
47
|
+
}> | Readonly<{
|
|
48
|
+
ok: false;
|
|
49
|
+
error: 'not_string' | 'invalid_prefix' | 'unknown_endpoint' | 'invalid_param_encoding';
|
|
50
|
+
}>;
|
|
51
|
+
export type ParsePublishedRuntimeCacheKeyDetailsResult = Readonly<{
|
|
52
|
+
ok: true;
|
|
53
|
+
key: PublishedRuntimeCacheKey;
|
|
54
|
+
endpoint: PublishedRuntimeCacheKeyEndpoint;
|
|
55
|
+
normalizedParams: PublishedRuntimeNormalizedParams;
|
|
56
|
+
}> | Readonly<{
|
|
57
|
+
ok: false;
|
|
58
|
+
error: 'not_string' | 'invalid_prefix' | 'unknown_endpoint' | 'invalid_param_encoding';
|
|
59
|
+
}>;
|
|
60
|
+
export type ParsePublishedRuntimeCachePayloadSchemaVersionResult = Readonly<{
|
|
61
|
+
ok: true;
|
|
62
|
+
value: PublishedRuntimeCachePayloadSchemaVersion;
|
|
63
|
+
}> | Readonly<{
|
|
64
|
+
ok: false;
|
|
65
|
+
error: 'not_number' | 'not_integer' | 'not_positive';
|
|
66
|
+
}>;
|
|
67
|
+
export type PublishedRuntimeCacheFreshness = Readonly<{
|
|
68
|
+
kind: 'fresh';
|
|
69
|
+
staleAgeSec: 0;
|
|
70
|
+
}> | Readonly<{
|
|
71
|
+
kind: 'stale';
|
|
72
|
+
staleAgeSec: number;
|
|
73
|
+
}> | Readonly<{
|
|
74
|
+
kind: 'expired';
|
|
75
|
+
}> | Readonly<{
|
|
76
|
+
kind: 'invalid_timestamp';
|
|
77
|
+
field: 'freshUntil' | 'staleUntil';
|
|
78
|
+
}>;
|
|
79
|
+
export type ClassifyPublishedRuntimeCacheFreshnessInput = Readonly<{
|
|
80
|
+
freshUntil: string;
|
|
81
|
+
staleUntil: string;
|
|
82
|
+
now: Date;
|
|
83
|
+
}>;
|
|
84
|
+
export type PublishedRuntimeCacheReadInput = Readonly<{
|
|
85
|
+
cacheKey: PublishedRuntimeCacheKey;
|
|
86
|
+
endpoint: PublishedRuntimeCacheKeyEndpoint;
|
|
87
|
+
payloadSchemaVersion?: PublishedRuntimeCachePayloadSchemaVersion;
|
|
88
|
+
}>;
|
|
89
|
+
export type PublishedRuntimeCacheReadResult<TPayload = unknown> = Readonly<{
|
|
90
|
+
kind: 'hit';
|
|
91
|
+
freshness: 'fresh' | 'stale';
|
|
92
|
+
payload: TPayload;
|
|
93
|
+
staleAgeSec: number;
|
|
94
|
+
}> | Readonly<{
|
|
95
|
+
kind: 'miss';
|
|
96
|
+
reason: 'not_found' | 'expired' | 'schema_mismatch';
|
|
97
|
+
}> | Readonly<{
|
|
98
|
+
kind: 'error';
|
|
99
|
+
error: Readonly<{
|
|
100
|
+
kind: PublishedRuntimeCacheAdapterErrorKind;
|
|
101
|
+
message: string;
|
|
102
|
+
}>;
|
|
103
|
+
}>;
|
|
104
|
+
export type PublishedRuntimeCacheAdapterErrorKind = 'read_failed' | 'corrupt_row' | 'adapter_exception';
|
|
105
|
+
export type PublishedRuntimeCacheWriteInput<TPayload = unknown> = Readonly<{
|
|
106
|
+
cacheKey: PublishedRuntimeCacheKey;
|
|
107
|
+
endpoint: PublishedRuntimeCacheKeyEndpoint;
|
|
108
|
+
normalizedParams: PublishedRuntimeNormalizedParams;
|
|
109
|
+
payload: TPayload;
|
|
110
|
+
siteId?: string | null;
|
|
111
|
+
freshTtlSec: number;
|
|
112
|
+
staleTtlSec: number;
|
|
113
|
+
payloadSchemaVersion?: PublishedRuntimeCachePayloadSchemaVersion;
|
|
114
|
+
writeReason?: string;
|
|
115
|
+
}>;
|
|
116
|
+
export type PublishedRuntimeCacheAdapter = Readonly<{
|
|
117
|
+
read?: <TPayload = unknown>(input: PublishedRuntimeCacheReadInput) => Promise<PublishedRuntimeCacheReadResult<TPayload>>;
|
|
118
|
+
write?: <TPayload = unknown>(input: PublishedRuntimeCacheWriteInput<TPayload>) => void | Promise<void>;
|
|
119
|
+
}>;
|
|
120
|
+
export type DerivePublishedRuntimeCacheKeyInput = {
|
|
121
|
+
[E in PublishedRuntimeCacheKeyEndpoint]: Readonly<{
|
|
122
|
+
endpoint: E;
|
|
123
|
+
params: KeyDeriverInputByEndpoint[E];
|
|
124
|
+
}>;
|
|
125
|
+
}[PublishedRuntimeCacheKeyEndpoint];
|
|
126
|
+
export type PublishedRuntimeNormalizedParams = Readonly<Record<string, string>>;
|
|
127
|
+
export type PublishedRuntimeCacheKeyError = Readonly<{
|
|
128
|
+
kind: 'not_durable_eligible';
|
|
129
|
+
policy: RuntimeCachePolicy;
|
|
130
|
+
}> | Readonly<{
|
|
131
|
+
kind: 'missing_site_identity';
|
|
132
|
+
acceptedParams: readonly ['slug', 'domain', 'id'];
|
|
133
|
+
}> | Readonly<{
|
|
134
|
+
kind: 'missing_required_param';
|
|
135
|
+
endpoint: PublishedRuntimeCacheKeyEndpoint;
|
|
136
|
+
param: 'siteId';
|
|
137
|
+
}>;
|
|
138
|
+
export type DerivePublishedRuntimeCacheKeyResult = Readonly<{
|
|
139
|
+
ok: true;
|
|
140
|
+
endpoint: PublishedRuntimeCacheKeyEndpoint;
|
|
141
|
+
key: PublishedRuntimeCacheKey;
|
|
142
|
+
normalizedParams: PublishedRuntimeNormalizedParams;
|
|
143
|
+
}> | Readonly<{
|
|
144
|
+
ok: false;
|
|
145
|
+
error: PublishedRuntimeCacheKeyError;
|
|
146
|
+
}>;
|
|
147
|
+
export declare function normalizeRuntimePublicPath(value: unknown): string;
|
|
148
|
+
declare function deriveGetSiteKey(params: GetSiteRuntimeCacheParams): DerivePublishedRuntimeCacheKeyResult;
|
|
149
|
+
declare function deriveGetContentByPathKey(params: GetContentByPathRuntimeCacheParams): DerivePublishedRuntimeCacheKeyResult;
|
|
150
|
+
declare const DURABLE_RUNTIME_CACHE_KEY_DERIVERS: {
|
|
151
|
+
readonly getSite: typeof deriveGetSiteKey;
|
|
152
|
+
readonly getContentByPath: typeof deriveGetContentByPathKey;
|
|
153
|
+
};
|
|
154
|
+
export declare function isPublishedRuntimeCacheKeyEndpoint(value: unknown): value is PublishedRuntimeCacheKeyEndpoint;
|
|
155
|
+
export declare function parsePublishedRuntimeCacheKey(value: unknown): ParsePublishedRuntimeCacheKeyResult;
|
|
156
|
+
export declare function parsePublishedRuntimeCacheKeyDetails(value: unknown): ParsePublishedRuntimeCacheKeyDetailsResult;
|
|
157
|
+
export declare function parsePublishedRuntimeCachePayloadSchemaVersion(value: unknown): ParsePublishedRuntimeCachePayloadSchemaVersionResult;
|
|
158
|
+
export declare function classifyPublishedRuntimeCacheFreshness(input: ClassifyPublishedRuntimeCacheFreshnessInput): PublishedRuntimeCacheFreshness;
|
|
159
|
+
export declare function derivePublishedRuntimeCacheKey(input: DerivePublishedRuntimeCacheKeyInput): DerivePublishedRuntimeCacheKeyResult;
|
|
160
|
+
export {};
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { CheckRedirectResponse, EntriesResponse, EntryResponse, PageResponse, PublicBookingServicesResponse, PublicCoursesResponse, PublicFormResponse, PublicFormsResponse, PublicProductsResponse, PublicTeamMembersResponse, PublicMembershipsResponse, PublicPassesResponse, PublicEventDetailsResponse, PublicEventsResponse, ResolveEntrySubrouteResponse, ResolveEventOccurrenceResponse, RoutableContentResponse, SiteResponse, SitemapRoutesResponse, PublicProductCategorySelector } from '../public-api/contracts';
|
|
2
|
+
import type { PublishedRuntimeCacheAdapter, PublishedRuntimeCacheAdapterErrorKind } from './runtimeCachePolicy';
|
|
2
3
|
export type { CheckRedirectResponse, EntriesResponse, EntryResponse, PageResponse, PublicBookingServicesResponse, PublicCoursesResponse, PublicEventsResponse, PublicFormResponse, PublicFormsResponse, PublicProductsResponse, PublicTeamMembersResponse, PublicMembershipsResponse, PublicPassesResponse, PublicEventDetailsResponse, ResolveEntrySubrouteResponse, ResolveEventOccurrenceResponse, RoutableContentResponse, SiteResponse, SitemapRoutesResponse, } from '../public-api/contracts';
|
|
3
4
|
/**
|
|
4
5
|
* Pagination metadata returned when `includeMeta: true`
|
|
@@ -88,12 +89,27 @@ export type GetEntriesByIdentifiersParams = {
|
|
|
88
89
|
* Source of the data returned by a resilient fetch
|
|
89
90
|
*/
|
|
90
91
|
export type ResilienceSource = 'live' | 'cache' | 'stale' | 'prebuild' | 'error';
|
|
92
|
+
export type ResilienceCacheTier = 'memory-fresh' | 'memory-stale' | 'durable-fresh' | 'durable-stale' | 'prebuild';
|
|
93
|
+
export type ResilienceDurableCacheDiagnostic = Readonly<{
|
|
94
|
+
outcome: 'miss';
|
|
95
|
+
reason: 'not_found' | 'expired' | 'schema_mismatch';
|
|
96
|
+
}> | Readonly<{
|
|
97
|
+
outcome: 'error';
|
|
98
|
+
error: Readonly<{
|
|
99
|
+
kind: PublishedRuntimeCacheAdapterErrorKind;
|
|
100
|
+
message: string;
|
|
101
|
+
}>;
|
|
102
|
+
}>;
|
|
91
103
|
/**
|
|
92
104
|
* Status information from a resilient fetch operation
|
|
93
105
|
*/
|
|
94
106
|
export interface ResilienceStatus {
|
|
95
107
|
/** Where the data came from */
|
|
96
108
|
source: ResilienceSource;
|
|
109
|
+
/** More precise cache tier when source is cache/stale/prebuild */
|
|
110
|
+
cacheTier?: ResilienceCacheTier;
|
|
111
|
+
/** Durable cache miss/error details when live origin failed and no durable hit was served */
|
|
112
|
+
durableCache?: ResilienceDurableCacheDiagnostic;
|
|
97
113
|
/** Whether this was a preview request */
|
|
98
114
|
isPreview: boolean;
|
|
99
115
|
/** Cache key used for this request */
|
|
@@ -243,7 +259,8 @@ export type SdkAuthConfig = {
|
|
|
243
259
|
};
|
|
244
260
|
export declare const SDK_CORRELATION_HEADER_NAMES: readonly ["x-request-id", "x-correlation-id", "x-riverbank-monitor-run-id"];
|
|
245
261
|
export type SdkCorrelationHeaderName = (typeof SDK_CORRELATION_HEADER_NAMES)[number];
|
|
246
|
-
export type
|
|
262
|
+
export type SdkDefaultHeaderName = SdkCorrelationHeaderName | 'x-vercel-protection-bypass';
|
|
263
|
+
export type SdkCorrelationHeaders = Readonly<Partial<Record<SdkDefaultHeaderName, string>>>;
|
|
247
264
|
/**
|
|
248
265
|
* Configuration for creating a Riverbank CMS client
|
|
249
266
|
*/
|
|
@@ -286,6 +303,14 @@ export interface RiverbankClientConfig {
|
|
|
286
303
|
* Per-request headers still win when an individual SDK method supplies `options.headers`.
|
|
287
304
|
*/
|
|
288
305
|
defaultHeaders?: SdkCorrelationHeaders;
|
|
306
|
+
/**
|
|
307
|
+
* Optional durable published runtime cache adapter.
|
|
308
|
+
*
|
|
309
|
+
* Used only for default-closed, anonymous published endpoints that the SDK
|
|
310
|
+
* policy marks durable-stale eligible. The SDK owns fallback ordering and
|
|
311
|
+
* metadata; the app owns the storage implementation.
|
|
312
|
+
*/
|
|
313
|
+
publishedRuntimeCache?: PublishedRuntimeCacheAdapter;
|
|
289
314
|
/**
|
|
290
315
|
* Cache configuration
|
|
291
316
|
*/
|
|
@@ -25,6 +25,7 @@ export { Page } from './rendering/components/Page';
|
|
|
25
25
|
export type { PageProps } from './rendering/components/Page';
|
|
26
26
|
export { Layout } from './rendering/components/Layout';
|
|
27
27
|
export type { LayoutProps, HeaderData, FooterData } from './rendering/components/Layout';
|
|
28
|
+
export type { SdkThemeResponsiveMode, SdkThemeRuntime, } from './rendering/themeRuntime';
|
|
28
29
|
export { PageRenderer, ThemeScope, buildThemeRuntime, RichText, resolveImageUrl, resolveImageUrlWithContext, resolveImageSourceSetWithContext, ImagePresets, } from './rendering';
|
|
29
30
|
export type { AppointmentBookingContent, BlogListingContent, BlogPostContent, BodyTextAlignment, BodyTextContent, CollectionContent, ColumnsContent, CourseDetailsContent, CourseRegistrationContent, CtaFullContent, EmbedContent, EventCalendarContent, EventDetailsContent, EventListingContent, EventRegistrationContent, EventSpotlightContent, FaqContent, FormBlockContent, GiftingContent, HeroContent, HeroMedia, ImageGalleryContent, MediaTextContent, NewsletterSignupContent, ShopContent, SingleButtonContent, SiteFooterContent, SiteHeaderContent, SystemBlockContentByKind, SystemBlockContentFor, TeamMembersContent, TestimonialEntryContent, TestimonialsBlockContent, VideoGridContent, ImageOptions, ResolveImageUrlContext, ResolveImageSourceSetOptions, ResolvedImageSourceSet, PageOutline, RouteMap, Theme, ThemeTokens, Media, TipTapNode, LinkValue, RichTextPrimitiveProps, } from './rendering';
|
|
30
31
|
export type { BlockOverrideProps, BlockOverrideRegistration, BlockOverrideRegistrations, BlockOverrides, BlockOverrideComponent, CustomBlockOverrideKey, KnownSystemBlockOverrides, KnownBlockOverrideKey, LazyBlockOverrideFactory, LazyBlockOverrideRegistration, StrictBlockOverrideRegistrations, StrictBlockOverrides, SystemBlockOverrideKey, } from './rendering';
|
|
@@ -29,7 +29,9 @@ export type FieldVisibilityPredicate = {
|
|
|
29
29
|
maxItems?: number;
|
|
30
30
|
};
|
|
31
31
|
export type FieldVisibilityCondition = FieldVisibilityPredicate | {
|
|
32
|
-
allOf:
|
|
32
|
+
allOf: FieldVisibilityCondition[];
|
|
33
|
+
} | {
|
|
34
|
+
anyOf: FieldVisibilityCondition[];
|
|
33
35
|
};
|
|
34
36
|
export type FieldUi = Partial<{
|
|
35
37
|
widget: string;
|
|
@@ -215,9 +215,10 @@ export type EmbedContent = {
|
|
|
215
215
|
export type EventLayout = 'grid' | 'stack' | 'compact';
|
|
216
216
|
export type ColumnOption = '2' | '3' | '4';
|
|
217
217
|
export type WeekStart = 'sunday' | 'monday';
|
|
218
|
-
export type DisplayMode = 'combined' | '
|
|
218
|
+
export type DisplayMode = 'combined' | 'calendar' | 'list' | 'timetable';
|
|
219
219
|
export type FilterAutoShow = 'auto' | 'always' | 'never';
|
|
220
220
|
export type CalendarTabViews = 'both' | 'month' | 'week';
|
|
221
|
+
export type CalendarView = 'month' | 'week';
|
|
221
222
|
export type ButtonVariant = 'primary' | 'secondary' | 'outline' | 'link';
|
|
222
223
|
export type CardVariantRole = 'default' | 'alternative';
|
|
223
224
|
export type LegacyCardVariantRoleAlias = 'variant1' | 'variant2';
|
|
@@ -238,6 +239,7 @@ export type EventCalendarContent = {
|
|
|
238
239
|
loadMoreText?: string | null;
|
|
239
240
|
startOfWeek?: WeekStart | null;
|
|
240
241
|
calendarTabViews?: CalendarTabViews | null;
|
|
242
|
+
defaultCalendarView?: CalendarView | null;
|
|
241
243
|
showFilters?: boolean | null;
|
|
242
244
|
showCategoryFilter?: FilterAutoShow | null;
|
|
243
245
|
showVenueFilter?: boolean | null;
|
|
@@ -19,12 +19,14 @@
|
|
|
19
19
|
*/
|
|
20
20
|
export { createRiverbankClient, getResilienceStatusFromError, RiverbankApiError, } from './client/index';
|
|
21
21
|
export { SDK_CORRELATION_HEADER_NAMES } from './client/types';
|
|
22
|
-
export type { RiverbankClient, RiverbankClientConfig, SdkCorrelationHeaderName, SdkCorrelationHeaders, SdkAuthConfig, SiteResponse, PageResponse, EntriesResponse, EntriesResponseWithMeta, GetEntriesByIdentifiersParams, GetPageParams, GetSiteParams, PaginationMeta, EntryResponse, ResilienceConfig, ResilienceStatus, ResilientData, ResilienceSource, CircuitState, RetryConfig, CircuitBreakerConfig, } from './client/types';
|
|
22
|
+
export type { RiverbankClient, RiverbankClientConfig, SdkCorrelationHeaderName, SdkCorrelationHeaders, SdkAuthConfig, SiteResponse, PageResponse, EntriesResponse, EntriesResponseWithMeta, GetEntriesByIdentifiersParams, GetPageParams, GetSiteParams, PaginationMeta, EntryResponse, ResilienceConfig, ResilienceDurableCacheDiagnostic, ResilienceStatus, ResilientData, ResilienceSource, CircuitState, RetryConfig, CircuitBreakerConfig, } from './client/types';
|
|
23
23
|
export { prebuildCache } from './prebuild/index';
|
|
24
24
|
export type { PrebuildOptions, PrebuildResult, PrebuildProgress, PrebuildManifest, PrebuildContentType, } from './prebuild/types';
|
|
25
25
|
export { PrebuildLoader, createPrebuildLoader, canUsePrebuild, } from './prebuild/loader';
|
|
26
26
|
export type { PrebuildLoaderConfig, LoadResult } from './prebuild/loader';
|
|
27
27
|
export type { ApiClient } from './public-api/runtime';
|
|
28
28
|
export { buildEndpointURL, API_ENDPOINTS } from './public-api/runtime';
|
|
29
|
+
export { DEFAULT_PUBLISHED_RUNTIME_CACHE_PAYLOAD_SCHEMA_VERSION, classifyPublishedRuntimeCacheFreshness, derivePublishedRuntimeCacheKey, isPublishedRuntimeCacheKeyEndpoint, normalizeRuntimePublicPath, parsePublishedRuntimeCacheKey, parsePublishedRuntimeCacheKeyDetails, parsePublishedRuntimeCachePayloadSchemaVersion, resolveRuntimeCachePolicy, } from './client/runtimeCachePolicy';
|
|
30
|
+
export type { ClassifyPublishedRuntimeCacheFreshnessInput, DerivePublishedRuntimeCacheKeyInput, DerivePublishedRuntimeCacheKeyResult, GetContentByPathRuntimeCacheParams, GetSiteRuntimeCacheParams, ParsePublishedRuntimeCacheKeyResult, ParsePublishedRuntimeCacheKeyDetailsResult, ParsePublishedRuntimeCachePayloadSchemaVersionResult, PublishedRuntimeCacheAdapter, PublishedRuntimeCacheAdapterErrorKind, PublishedRuntimeCacheFreshness, PublishedRuntimeCacheKey, PublishedRuntimeCacheKeyEndpoint, PublishedRuntimeCacheKeyError, PublishedRuntimeCachePayloadSchemaVersion, PublishedRuntimeCacheReadInput, PublishedRuntimeCacheReadResult, PublishedRuntimeCacheWriteInput, PublishedRuntimeNormalizedParams, ResolveRuntimeCachePolicyInput, RuntimeCacheLiveOnlyReason, RuntimeCacheParams, RuntimeCachePolicy, RuntimeCachePolicyKind, } from './client/runtimeCachePolicy';
|
|
29
31
|
export type { RiverbankSiteConfig, SiteStyleConfig, SectionBackground, SectionOptionsConfig, ContainerOptionsConfig, SectionSpacing, ContainerMaxWidth, ContainerAlignment, } from './config';
|
|
30
32
|
export { SYSTEM_BLOCK_KINDS, type SystemBlockKind, type CustomBlockKind, type BlockKind, } from './types';
|
|
@@ -8,6 +8,7 @@ import type { ReactNode } from 'react';
|
|
|
8
8
|
import type { RiverbankClient } from '../client/types';
|
|
9
9
|
import type { RiverbankSiteConfig } from '../config/types';
|
|
10
10
|
import type { Theme } from '../contracts';
|
|
11
|
+
import type { SdkThemeRuntime } from '../rendering/themeRuntime';
|
|
11
12
|
import type { BlockOverrideRegistrations } from '../rendering/overrides';
|
|
12
13
|
import type { Metadata } from '../metadata/generatePageMetadata';
|
|
13
14
|
import type { LoadContentResult } from '../rendering/helpers/loadContent';
|
|
@@ -23,13 +24,11 @@ export interface CatchAllContext {
|
|
|
23
24
|
/** Whether preview mode is enabled */
|
|
24
25
|
preview: boolean;
|
|
25
26
|
/**
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
* Preview mode should mirror this so SDK sites that fully own their styling
|
|
30
|
-
* don't accidentally get CMS theme styling applied only while editing.
|
|
27
|
+
* Runtime wrapper used by the SDK page renderer.
|
|
28
|
+
* Preview mode mirrors this so editing and live rendering use the same
|
|
29
|
+
* visual theme/responsive infrastructure contract.
|
|
31
30
|
*/
|
|
32
|
-
|
|
31
|
+
themeRuntime: SdkThemeRuntime;
|
|
33
32
|
/** Search parameters from the URL (for filtering, pagination, etc.) */
|
|
34
33
|
searchParams: Record<string, string | string[] | undefined>;
|
|
35
34
|
}
|
|
@@ -279,13 +278,11 @@ export type CreateCatchAllPageOptions = {
|
|
|
279
278
|
children: ReactNode;
|
|
280
279
|
}) => ReactNode | Promise<ReactNode>;
|
|
281
280
|
/**
|
|
282
|
-
*
|
|
283
|
-
* Enable this to use built-in theme styling from the CMS.
|
|
284
|
-
* Disable if you're bringing your own styles.
|
|
281
|
+
* Controls the runtime wrapper around rendered page content.
|
|
285
282
|
*
|
|
286
|
-
* @default
|
|
283
|
+
* @default { kind: 'responsive-only' }
|
|
287
284
|
*/
|
|
288
|
-
|
|
285
|
+
themeRuntime?: SdkThemeRuntime;
|
|
289
286
|
/**
|
|
290
287
|
* Enable portal authentication for the reserved `/portal` customer route.
|
|
291
288
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import React, { type ReactNode } from "react";
|
|
2
2
|
import type { PreviewShellLayoutProps, PreviewShellProps, SdkPreviewModeProps } from "../../../../preview-next/src/client/index";
|
|
3
|
-
export type { SdkPreviewModeContent, SdkPreviewModeProps, PreviewShellProps, PreviewShellLayoutProps, } from '../../../../preview-next/src/client/index';
|
|
3
|
+
export type { SdkPreviewModeContent, SdkPreviewModeProps, PreviewThemeRuntime, PreviewThemeResponsiveMode, PreviewShellProps, PreviewShellLayoutProps, } from '../../../../preview-next/src/client/index';
|
|
4
4
|
type PreviewQueryProviderProps = Readonly<{
|
|
5
5
|
children: ReactNode;
|
|
6
6
|
}>;
|
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
|
+
import type { ThemeResponsiveMode } from '../../../theme-core/src/index';
|
|
2
3
|
import type { Theme } from '../contracts';
|
|
3
4
|
export type ThemeScopeProps = {
|
|
4
5
|
theme: Theme;
|
|
5
6
|
children?: React.ReactNode;
|
|
6
7
|
themeId?: string;
|
|
7
|
-
responsiveMode?:
|
|
8
|
+
responsiveMode?: ThemeResponsiveMode;
|
|
8
9
|
className?: string;
|
|
9
10
|
};
|
|
10
11
|
export declare function ThemeScope(props: ThemeScopeProps): React.ReactElement;
|
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
*/
|
|
6
6
|
import { buildMenu, buildFooterMenu, buildLogo } from '../../navigation';
|
|
7
7
|
import type { RiverbankClient, SiteResponse } from '../../client/types';
|
|
8
|
+
import { type SdkThemeRuntime } from '../themeRuntime';
|
|
8
9
|
export type HeaderData = {
|
|
9
10
|
menu: ReturnType<typeof buildMenu>;
|
|
10
11
|
logo: ReturnType<typeof buildLogo>;
|
|
@@ -40,15 +41,15 @@ export type LayoutProps = {
|
|
|
40
41
|
/** Render stage for internal links and block transforms. */
|
|
41
42
|
previewStage?: 'published' | 'preview';
|
|
42
43
|
/**
|
|
43
|
-
*
|
|
44
|
-
* Enable this to use built-in theme styling from the CMS.
|
|
45
|
-
* Disable if you're bringing your own styles and want to avoid SDK-injected theme variables.
|
|
44
|
+
* Controls the runtime wrapper around SDK layout content.
|
|
46
45
|
*
|
|
47
|
-
*
|
|
46
|
+
* - cms-theme: inject CMS theme variables and component CSS
|
|
47
|
+
* - responsive-only: keep the responsive utility root without CMS theme styles
|
|
48
|
+
* - none: render no SDK runtime wrapper; only safe with fully custom chrome
|
|
48
49
|
*
|
|
49
|
-
* @default
|
|
50
|
+
* @default { kind: 'cms-theme' }
|
|
50
51
|
*/
|
|
51
|
-
|
|
52
|
+
themeRuntime?: SdkThemeRuntime;
|
|
52
53
|
};
|
|
53
54
|
/**
|
|
54
55
|
* Layout component that wraps content with site header and footer.
|
|
@@ -85,4 +86,4 @@ export type LayoutProps = {
|
|
|
85
86
|
* </Layout>
|
|
86
87
|
* ```
|
|
87
88
|
*/
|
|
88
|
-
export declare function Layout({ siteData: providedSiteData, client, siteId, slug, domain, children, header, footer, headerVariant, hasPortalSession, previewStage,
|
|
89
|
+
export declare function Layout({ siteData: providedSiteData, client, siteId, slug, domain, children, header, footer, headerVariant, hasPortalSession, previewStage, themeRuntime, }: LayoutProps): Promise<import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>>>;
|
|
@@ -4,6 +4,7 @@ import type { ResolvedBlockData } from '../../data';
|
|
|
4
4
|
import type { SiteBookingOfferingPresetSummary } from '../../public-api/contracts';
|
|
5
5
|
import type { RuntimeSdkConfig } from '../helpers/loadPage';
|
|
6
6
|
import { type ComponentRegistry } from '../blocks-page-renderer';
|
|
7
|
+
import { type SdkThemeRuntime } from '../themeRuntime';
|
|
7
8
|
import type { BlockOverrides } from '../overrides';
|
|
8
9
|
import type { SdkCustomBlock } from '../../config/types';
|
|
9
10
|
export type PageProps = {
|
|
@@ -77,13 +78,11 @@ export type PageProps = {
|
|
|
77
78
|
*/
|
|
78
79
|
blockOverrides?: BlockOverrides;
|
|
79
80
|
/**
|
|
80
|
-
*
|
|
81
|
-
* Enable this to use built-in theme styling from the CMS.
|
|
82
|
-
* Disable if you're bringing your own styles.
|
|
81
|
+
* Controls the runtime wrapper around page content.
|
|
83
82
|
*
|
|
84
|
-
* @default
|
|
83
|
+
* @default { kind: 'none' }
|
|
85
84
|
*/
|
|
86
|
-
|
|
85
|
+
themeRuntime?: SdkThemeRuntime;
|
|
87
86
|
};
|
|
88
87
|
export type PageHydrationBootstrapConfig = {
|
|
89
88
|
siteId: string;
|
|
@@ -91,4 +90,4 @@ export type PageHydrationBootstrapConfig = {
|
|
|
91
90
|
mediaAssets?: readonly MediaAssetIndexItem[];
|
|
92
91
|
};
|
|
93
92
|
export declare function toPageHydrationBootstrapConfig(props: Pick<PageProps, 'siteId' | 'supabaseUrl' | 'mediaAssets'>): PageHydrationBootstrapConfig;
|
|
94
|
-
export declare function PageContent({ page, theme, themeTokens: providedTokens, siteId, resolvedData, bookingOfferingPresets, routeMap, pagesByIdentifier, entriesByIdentifier, wrapBlock, registry, usePlaceholders, blockOverrides, sdkConfig, customBlocks, supabaseUrl, mediaAssets, apiBaseUrl, portalToken, previewToken, dataContext,
|
|
93
|
+
export declare function PageContent({ page, theme, themeTokens: providedTokens, siteId, resolvedData, bookingOfferingPresets, routeMap, pagesByIdentifier, entriesByIdentifier, wrapBlock, registry, usePlaceholders, blockOverrides, sdkConfig, customBlocks, supabaseUrl, mediaAssets, apiBaseUrl, portalToken, previewToken, dataContext, themeRuntime, }: PageProps): ReactElement;
|
|
@@ -8,6 +8,7 @@ export { Page } from './components/Page';
|
|
|
8
8
|
export type { PageProps } from './components/Page';
|
|
9
9
|
export { Layout } from './components/Layout';
|
|
10
10
|
export type { LayoutProps, HeaderData, FooterData } from './components/Layout';
|
|
11
|
+
export type { SdkThemeResponsiveMode, SdkThemeRuntime, } from './themeRuntime';
|
|
11
12
|
export { Block } from './components/Block';
|
|
12
13
|
export type { BlockProps } from './components/Block';
|
|
13
14
|
export { loadPage } from './helpers/loadPage';
|
|
@@ -6,6 +6,7 @@ export { Page } from './components/Page.server';
|
|
|
6
6
|
export type { PageProps } from './components/Page.server';
|
|
7
7
|
export { Layout } from './components/Layout';
|
|
8
8
|
export type { LayoutProps, HeaderData, FooterData } from './components/Layout';
|
|
9
|
+
export type { SdkThemeResponsiveMode, SdkThemeRuntime, } from './themeRuntime';
|
|
9
10
|
export { Block } from './components/Block.server';
|
|
10
11
|
export type { BlockProps } from './components/Block.server';
|
|
11
12
|
export { defineBlockOverrideRegistrations, defineBlockOverrides, defineLazyBlockOverride, } from './overrides';
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import type { ThemeResponsiveMode, ThemeRuntime } from '../../../theme-core/src/index';
|
|
3
|
+
import type { Theme } from '../contracts';
|
|
4
|
+
export type SdkThemeResponsiveMode = ThemeResponsiveMode;
|
|
5
|
+
export type SdkThemeRuntime = ThemeRuntime;
|
|
6
|
+
export declare const defaultLayoutThemeRuntime: {
|
|
7
|
+
readonly kind: "cms-theme";
|
|
8
|
+
};
|
|
9
|
+
export declare const defaultSdkChromeThemeRuntime: {
|
|
10
|
+
readonly kind: "responsive-only";
|
|
11
|
+
};
|
|
12
|
+
export declare const defaultPageThemeRuntime: {
|
|
13
|
+
readonly kind: "none";
|
|
14
|
+
};
|
|
15
|
+
export declare const defaultCatchAllThemeRuntime: {
|
|
16
|
+
readonly kind: "responsive-only";
|
|
17
|
+
};
|
|
18
|
+
export declare function planLayoutThemeRuntime(input: {
|
|
19
|
+
themeRuntime?: SdkThemeRuntime;
|
|
20
|
+
usesSdkChrome: boolean;
|
|
21
|
+
}): SdkThemeRuntime;
|
|
22
|
+
export declare function renderWithSdkThemeRuntime({ themeRuntime, theme, children, }: {
|
|
23
|
+
themeRuntime: SdkThemeRuntime;
|
|
24
|
+
theme: Theme;
|
|
25
|
+
children: React.ReactNode;
|
|
26
|
+
}): React.ReactElement;
|
|
@@ -406,6 +406,7 @@ export declare const upsertEventSeriesCommandSchema: z.ZodObject<{
|
|
|
406
406
|
ref: z.ZodPipe<z.ZodString, z.ZodTransform<EventSeriesRef, string>>;
|
|
407
407
|
input: z.ZodObject<{
|
|
408
408
|
slug: z.ZodString;
|
|
409
|
+
path: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
409
410
|
title: z.ZodString;
|
|
410
411
|
archetype: z.ZodEnum<{
|
|
411
412
|
custom: "custom";
|
|
@@ -514,6 +515,11 @@ export declare const upsertEventSeriesCommandSchema: z.ZodObject<{
|
|
|
514
515
|
paymentTerms: z.ZodOptional<z.ZodUnknown>;
|
|
515
516
|
presentation: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
|
|
516
517
|
tags: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
|
|
518
|
+
blocks: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
|
|
519
|
+
identifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
520
|
+
kind: z.ZodString;
|
|
521
|
+
content: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
522
|
+
}, z.core.$strict>>>>;
|
|
517
523
|
staffRefs: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<StaffRef, string>>>>>;
|
|
518
524
|
}, z.core.$strict>;
|
|
519
525
|
}, z.core.$strict>;
|
|
@@ -1366,6 +1372,7 @@ export declare const siteCommandSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
|
1366
1372
|
ref: z.ZodPipe<z.ZodString, z.ZodTransform<EventSeriesRef, string>>;
|
|
1367
1373
|
input: z.ZodObject<{
|
|
1368
1374
|
slug: z.ZodString;
|
|
1375
|
+
path: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1369
1376
|
title: z.ZodString;
|
|
1370
1377
|
archetype: z.ZodEnum<{
|
|
1371
1378
|
custom: "custom";
|
|
@@ -1474,6 +1481,11 @@ export declare const siteCommandSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
|
1474
1481
|
paymentTerms: z.ZodOptional<z.ZodUnknown>;
|
|
1475
1482
|
presentation: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
|
|
1476
1483
|
tags: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
|
|
1484
|
+
blocks: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
|
|
1485
|
+
identifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1486
|
+
kind: z.ZodString;
|
|
1487
|
+
content: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
1488
|
+
}, z.core.$strict>>>>;
|
|
1477
1489
|
staffRefs: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<StaffRef, string>>>>>;
|
|
1478
1490
|
}, z.core.$strict>;
|
|
1479
1491
|
}, z.core.$strict>, z.ZodObject<{
|
|
@@ -2241,6 +2253,7 @@ export declare const siteCommandBatchSchema: z.ZodObject<{
|
|
|
2241
2253
|
ref: z.ZodPipe<z.ZodString, z.ZodTransform<EventSeriesRef, string>>;
|
|
2242
2254
|
input: z.ZodObject<{
|
|
2243
2255
|
slug: z.ZodString;
|
|
2256
|
+
path: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2244
2257
|
title: z.ZodString;
|
|
2245
2258
|
archetype: z.ZodEnum<{
|
|
2246
2259
|
custom: "custom";
|
|
@@ -2349,6 +2362,11 @@ export declare const siteCommandBatchSchema: z.ZodObject<{
|
|
|
2349
2362
|
paymentTerms: z.ZodOptional<z.ZodUnknown>;
|
|
2350
2363
|
presentation: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
|
|
2351
2364
|
tags: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodString>>>;
|
|
2365
|
+
blocks: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
|
|
2366
|
+
identifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
2367
|
+
kind: z.ZodString;
|
|
2368
|
+
content: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
2369
|
+
}, z.core.$strict>>>>;
|
|
2352
2370
|
staffRefs: z.ZodOptional<z.ZodReadonly<z.ZodArray<z.ZodPipe<z.ZodString, z.ZodTransform<StaffRef, string>>>>>;
|
|
2353
2371
|
}, z.core.$strict>;
|
|
2354
2372
|
}, z.core.$strict>, z.ZodObject<{
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import * as React from "react";
|
|
2
|
+
import { type ThemeResponsiveMode } from "./responsiveMode";
|
|
3
|
+
export type ResponsiveScopeProps = {
|
|
4
|
+
children: React.ReactNode;
|
|
5
|
+
responsiveMode?: ThemeResponsiveMode;
|
|
6
|
+
className?: string;
|
|
7
|
+
};
|
|
8
|
+
/**
|
|
9
|
+
* Structural responsive root for SDK/runtime chrome that opts out of CMS theme
|
|
10
|
+
* styling but still depends on scoped rb-* responsive utility classes.
|
|
11
|
+
*/
|
|
12
|
+
export declare function ResponsiveScope({ children, responsiveMode, className, }: ResponsiveScopeProps): React.JSX.Element;
|
|
@@ -62,8 +62,8 @@ export declare const buttonPersonalitySchema: z.ZodObject<{
|
|
|
62
62
|
shadow: z.ZodEnum<{
|
|
63
63
|
medium: "medium";
|
|
64
64
|
none: "none";
|
|
65
|
-
low: "low";
|
|
66
65
|
high: "high";
|
|
66
|
+
low: "low";
|
|
67
67
|
}>;
|
|
68
68
|
textTransform: z.ZodEnum<{
|
|
69
69
|
none: "none";
|
|
@@ -145,8 +145,8 @@ export declare const buttonPersonalitySchema: z.ZodObject<{
|
|
|
145
145
|
elevation: z.ZodEnum<{
|
|
146
146
|
medium: "medium";
|
|
147
147
|
none: "none";
|
|
148
|
-
low: "low";
|
|
149
148
|
high: "high";
|
|
149
|
+
low: "low";
|
|
150
150
|
}>;
|
|
151
151
|
softness: z.ZodNullable<z.ZodEnum<{
|
|
152
152
|
soft: "soft";
|
|
@@ -103,8 +103,8 @@ export declare const cornerStyleSchema: z.ZodEnum<{
|
|
|
103
103
|
export declare const shadowSizeSchema: z.ZodEnum<{
|
|
104
104
|
medium: "medium";
|
|
105
105
|
none: "none";
|
|
106
|
-
low: "low";
|
|
107
106
|
high: "high";
|
|
107
|
+
low: "low";
|
|
108
108
|
}>;
|
|
109
109
|
export declare const textTransformSchema: z.ZodEnum<{
|
|
110
110
|
none: "none";
|
|
@@ -239,8 +239,8 @@ export declare const buttonGlobalSettingsSchema: z.ZodObject<{
|
|
|
239
239
|
shadow: z.ZodEnum<{
|
|
240
240
|
medium: "medium";
|
|
241
241
|
none: "none";
|
|
242
|
-
low: "low";
|
|
243
242
|
high: "high";
|
|
243
|
+
low: "low";
|
|
244
244
|
}>;
|
|
245
245
|
textTransform: z.ZodEnum<{
|
|
246
246
|
none: "none";
|
|
@@ -390,8 +390,8 @@ export declare const buttonVariantSchema: z.ZodObject<{
|
|
|
390
390
|
elevation: z.ZodEnum<{
|
|
391
391
|
medium: "medium";
|
|
392
392
|
none: "none";
|
|
393
|
-
low: "low";
|
|
394
393
|
high: "high";
|
|
394
|
+
low: "low";
|
|
395
395
|
}>;
|
|
396
396
|
softness: z.ZodNullable<z.ZodEnum<{
|
|
397
397
|
soft: "soft";
|
|
@@ -457,8 +457,8 @@ export declare const buttonSystemSchema: z.ZodObject<{
|
|
|
457
457
|
shadow: z.ZodEnum<{
|
|
458
458
|
medium: "medium";
|
|
459
459
|
none: "none";
|
|
460
|
-
low: "low";
|
|
461
460
|
high: "high";
|
|
461
|
+
low: "low";
|
|
462
462
|
}>;
|
|
463
463
|
textTransform: z.ZodEnum<{
|
|
464
464
|
none: "none";
|
|
@@ -540,8 +540,8 @@ export declare const buttonSystemSchema: z.ZodObject<{
|
|
|
540
540
|
elevation: z.ZodEnum<{
|
|
541
541
|
medium: "medium";
|
|
542
542
|
none: "none";
|
|
543
|
-
low: "low";
|
|
544
543
|
high: "high";
|
|
544
|
+
low: "low";
|
|
545
545
|
}>;
|
|
546
546
|
softness: z.ZodNullable<z.ZodEnum<{
|
|
547
547
|
soft: "soft";
|
|
@@ -189,8 +189,8 @@ export declare const cardVariantSchema: z.ZodObject<{
|
|
|
189
189
|
elevation: z.ZodEnum<{
|
|
190
190
|
medium: "medium";
|
|
191
191
|
none: "none";
|
|
192
|
-
low: "low";
|
|
193
192
|
high: "high";
|
|
193
|
+
low: "low";
|
|
194
194
|
}>;
|
|
195
195
|
softness: z.ZodNullable<z.ZodEnum<{
|
|
196
196
|
soft: "soft";
|
|
@@ -297,8 +297,8 @@ export declare const cardSystemSchema: z.ZodObject<{
|
|
|
297
297
|
elevation: z.ZodEnum<{
|
|
298
298
|
medium: "medium";
|
|
299
299
|
none: "none";
|
|
300
|
-
low: "low";
|
|
301
300
|
high: "high";
|
|
301
|
+
low: "low";
|
|
302
302
|
}>;
|
|
303
303
|
softness: z.ZodNullable<z.ZodEnum<{
|
|
304
304
|
soft: "soft";
|