@riverbankcms/sdk 0.138.0 → 0.139.0

package/dist/_dts/api/src/privacyPolicy.d.ts

@@ -1,9 +1,70 @@
 export type SiteLegalJurisdiction = 'UK' | 'US' | 'EU' | 'CA' | 'AU' | 'OTHER';
+/**
+ * Where a privacy identity field gets its value.
+ *
+ * `public` reads the site's own public business name or contact email at
+ * request time, so changing the public value changes the policy. `custom`
+ * uses the value saved on the legal profile.
+ */
+export type SiteLegalIdentitySource = 'public' | 'custom';
 export type SiteLegalProfilePayload = {
     legalEntityName: string | null;
     privacyContactEmail: string | null;
     jurisdiction: SiteLegalJurisdiction;
+    legalEntityNameSource: SiteLegalIdentitySource;
+    privacyContactEmailSource: SiteLegalIdentitySource;
+    /**
+     * Whether the site serves its privacy policy. Absent on every profile saved
+     * before this flag existed, and absent reads as false, so no site publishes
+     * a policy page until an administrator turns it on.
+     */
+    privacyPolicyPublished: boolean;
 };
+/**
+ * A legal profile saved before the source flags existed carries values an
+ * administrator typed by hand, so a saved value is an override and only an
+ * empty one falls back to the public value.
+ */
+export declare function resolveLegalIdentitySource(source: SiteLegalIdentitySource | null | undefined, savedValue: string | null): SiteLegalIdentitySource;
+export type ResolvedSitePrivacyIdentity = {
+    entityName: string | null;
+    contactEmail: string | null;
+    jurisdiction: SiteLegalJurisdiction;
+    entityNameSource: SiteLegalIdentitySource;
+    contactEmailSource: SiteLegalIdentitySource;
+};
+/**
+ * Resolves the identity the privacy policy speaks in, reading the public
+ * business name and contact email wherever the profile defers to them.
+ *
+ * Nothing is copied between the two stores: a profile that defers resolves
+ * afresh on every read, so a site that renames itself does not have a stale
+ * name in its policy.
+ */
+export declare function resolveSitePrivacyIdentity(input: {
+    legalProfile: SiteLegalProfilePayload;
+    publicBusinessName: string | null;
+    publicContactEmail: string | null;
+}): ResolvedSitePrivacyIdentity;
+/**
+ * A policy can only name a data controller once an entity name resolves.
+ * The contact email is not required: the policy has a standing fallback that
+ * points at the contact details published on the site.
+ */
+export declare function isSitePrivacyIdentityReady(identity: ResolvedSitePrivacyIdentity): boolean;
+/**
+ * EU member states, used both to place a site in the EU privacy jurisdiction
+ * and to seed the shop's default shipping countries.
+ */
+export declare const EU_MEMBER_COUNTRIES: readonly ["AT", "BE", "BG", "HR", "CY", "CZ", "DK", "EE", "FI", "FR", "DE", "GR", "HU", "IE", "IT", "LV", "LT", "LU", "MT", "NL", "PL", "PT", "RO", "SK", "SI", "ES", "SE"];
+/**
+ * Maps an ISO 3166-1 alpha-2 country code to a privacy jurisdiction.
+ *
+ * Onboarding collects alpha-2, so the United Kingdom arrives as `GB` rather
+ * than `UK`. An unrecognised or absent code is `OTHER`, which has its own
+ * policy wording rather than a wrong regulator.
+ */
+export declare function mapCountryToLegalJurisdiction(countryCode: string | null | undefined): SiteLegalJurisdiction;
 export type SitePrivacyPolicyCapabilities = {
     usesNecessaryCookies: boolean;
     usesAnalyticsCookies: boolean;
@@ -42,8 +103,14 @@ export type SensitiveClientRecordsSettings = {
     acceptedConfirmationKeys: SensitiveClientRecordsConfirmationKey[];
     disableRequiresSupport: boolean;
 };
+/**
+ * What a client may send for the legal profile. The source and publication
+ * flags are optional so a caller that has no control for them (and any client
+ * written before they existed) leaves them to be derived from the values.
+ */
+export type SiteLegalProfileInput = Omit<SiteLegalProfilePayload, 'legalEntityNameSource' | 'privacyContactEmailSource' | 'privacyPolicyPublished'> & Partial<Pick<SiteLegalProfilePayload, 'legalEntityNameSource' | 'privacyContactEmailSource' | 'privacyPolicyPublished'>>;
 export type SitePrivacySettingsPayload = {
-    legalProfile: SiteLegalProfilePayload;
+    legalProfile: SiteLegalProfileInput;
     sensitiveClientRecords?: SensitiveClientRecordsUpdatePayload;
 };
 export type SitePrivacySettings = {
@@ -52,9 +119,14 @@ export type SitePrivacySettings = {
 };
 export type SitePrivacySettingsResponse = {
     settings: SitePrivacySettings;
+    /** What the policy currently says its controller and contact are. */
+    resolvedIdentity: ResolvedSitePrivacyIdentity;
     preview: {
         policyPath: string;
+        /** An entity name resolves, so a policy can be built. */
         isReady: boolean;
+        /** The administrator has turned the policy on. */
+        isPublished: boolean;
         capabilities: SitePrivacyPolicyCapabilities;
         document: SitePrivacyPolicyDocument | null;
     };
@@ -70,7 +142,7 @@ export declare const MANAGED_PRIVACY_POLICY_PATH: "/privacy";
 export declare const DEFAULT_SITE_LEGAL_JURISDICTION: SiteLegalJurisdiction;
 export declare const JURISDICTION_LABELS: Record<SiteLegalJurisdiction, string>;
 export declare function buildManagedPrivacyPolicyDocument(input: {
-    legalProfile: SiteLegalProfilePayload;
+    identity: ResolvedSitePrivacyIdentity;
     capabilities: SitePrivacyPolicyCapabilities;
     effectiveDate: string;
 }): SitePrivacyPolicyDocument;

package/dist/_dts/api/src/publicBookingAvailabilityEndpointDefinitions.d.ts

@@ -13,7 +13,7 @@ export declare const PUBLIC_BOOKING_AVAILABILITY_ENDPOINT_DEFINITIONS: {
     getPublicBookingServices: {
         path: "/public/bookings/services";
         method: "GET";
-        revalidate: 60;
+        revalidate: number;
         tags: "riverbank:site:{siteId}:public-booking-services"[];
         auth: "public";
         responseKind: "json";
@@ -21,7 +21,7 @@ export declare const PUBLIC_BOOKING_AVAILABILITY_ENDPOINT_DEFINITIONS: {
     getPublicBookingService: {
         path: "/public/bookings/services/{serviceId}";
         method: "GET";
-        revalidate: 60;
+        revalidate: number;
         tags: "riverbank:site:{siteId}:public-booking-services"[];
         auth: "public";
         responseKind: "json";
@@ -29,7 +29,7 @@ export declare const PUBLIC_BOOKING_AVAILABILITY_ENDPOINT_DEFINITIONS: {
     getPublicBookingResourcesReference: {
         path: "/public/bookings/resources/reference";
         method: "GET";
-        revalidate: 60;
+        revalidate: number;
         tags: "riverbank:site:{siteId}:public-booking-services"[];
         auth: "public";
         responseKind: "json";
@@ -37,7 +37,7 @@ export declare const PUBLIC_BOOKING_AVAILABILITY_ENDPOINT_DEFINITIONS: {
     getPublicBookingAvailableDates: {
         path: "/public/bookings/availability/dates";
         method: "GET";
-        revalidate: 60;
+        revalidate: number;
         tags: ("riverbank:site:{siteId}:public-booking-services" | "riverbank:site:{siteId}:public-booking-availability")[];
         auth: "public";
         responseKind: "json";
@@ -45,7 +45,7 @@ export declare const PUBLIC_BOOKING_AVAILABILITY_ENDPOINT_DEFINITIONS: {
     getPublicBookingAvailableSlots: {
         path: "/public/bookings/availability/slots";
         method: "GET";
-        revalidate: 60;
+        revalidate: number;
         tags: ("riverbank:site:{siteId}:public-booking-services" | "riverbank:site:{siteId}:public-booking-availability")[];
         auth: "public";
         responseKind: "json";
@@ -53,7 +53,7 @@ export declare const PUBLIC_BOOKING_AVAILABILITY_ENDPOINT_DEFINITIONS: {
     getPublicWeeklySlotAvailability: {
         path: "/public/bookings/weekly-slot-availability";
         method: "GET";
-        revalidate: 60;
+        revalidate: number;
         tags: ("riverbank:site:{siteId}:public-booking-services" | "riverbank:site:{siteId}:public-booking-availability")[];
         auth: "public";
         responseKind: "json";

package/dist/_dts/api/src/publicEventEndpointDefinitions.d.ts

@@ -24,7 +24,7 @@ export declare const PUBLIC_EVENT_ENDPOINT_DEFINITIONS: {
     resolveEventSubroute: {
         path: "/public/sites/{siteId}/events/subroutes/resolve";
         method: "GET";
-        revalidate: 60;
+        revalidate: number;
         tags: ("riverbank:site:{siteId}:public-events" | "event-subroute")[];
         auth: "public";
         responseKind: "json";

package/dist/_dts/api/src/publicExperience/newsletterEndpoints.d.ts

@@ -5,13 +5,11 @@
  */
 import type { APIEndpoint } from "../apiEndpointTypes";
 import type { NewsletterSubscribeBody } from "./sharedTypes";
+import type { MailingListPublicSignupResponse } from '../../../core/src/index';
 export type PublicNewsletterAPIEndpoints = {
     subscribeNewsletter: APIEndpoint<NewsletterSubscribeBody, {
         siteId: string;
-    }, {
-        subscribed: true;
-        requiresConfirmation?: boolean;
-    }>;
+    }, MailingListPublicSignupResponse>;
     confirmNewsletter: APIEndpoint<never, {
         siteId: string;
         token: string;

package/dist/_dts/api/src/publicExperience/sharedTypes.d.ts

@@ -4,6 +4,8 @@
  * Re-exported from `../publicExperienceEndpoints`, which stays the public import site.
  */
 import type { AutoAppliedDiscountPreview } from '../bookingRecords';
+import type { MailingListSignupSourceRef, MailingListVisitorSelection } from '../../../core/src/index';
+export type { MailingListSignupSourceRef } from '../../../core/src/index';
 export declare const PUBLIC_EVENT_TICKET_SELECTION_CONTRACT_VERSION: "public-event-ticket-selection.v2";
 export type EventTicketSelectionRequest = {
     pricingOptionId?: string | null;
@@ -39,46 +41,30 @@ export type PublicEventLoaderParams = {
     includeOccurrenceId?: string;
     /**
      * What the read is asking for: `'occurrences'` (default) for a page of dates,
-     * or `'runs'` for one row per whole-series run regardless of date.
+     * `'runs'` for one row per whole-series run regardless of date, or
+     * `'catalogue'` for one representative occurrence per series. Catalogue
+     * reads are complete when `limit` is omitted; cursors and explicit limits
+     * apply after representative selection.
      */
     readIntent?: string;
     detailLevel?: string;
     readProfile?: string;
 };
-export type NewsletterSignupPublicDestinationRef = {
-    tag: 'block_ref';
-    blockId: string;
-} | {
-    tag: 'signed_destination_ref';
-    token: string;
-};
-export type NewsletterSubscribeTarget = {
-    tag: 'legacy_riverbank_list';
-    listId: string;
-    destinationRef?: NewsletterSignupPublicDestinationRef;
-} | {
-    tag: 'published_block_ref';
-    destinationRef: NewsletterSignupPublicDestinationRef;
-};
-type NewsletterSubscribeFields = {
+export type NewsletterSubscribeBody = {
     email: string;
     firstName?: string | null;
     lastName?: string | null;
     name?: string | null;
     company?: string | null;
     phone?: string | null;
-    tags?: string[];
+    sourceRef: MailingListSignupSourceRef;
+    setupRevision: number;
+    visitorSelection?: MailingListVisitorSelection;
     meta?: {
         honeypot?: string;
         altchaSolution?: string | null;
     };
 };
-export type NewsletterSubscribeBody = NewsletterSubscribeFields & ({
-    target: NewsletterSubscribeTarget;
-} | {
-    listId: string;
-    destinationRef?: NewsletterSignupPublicDestinationRef;
-});
 export type PublicEventScheduleScope = 'any' | 'recurring' | 'oneOff';
 export type PublicEventRecurrence = Readonly<{
     kind: 'weekly';

package/dist/_dts/api/src/publicReadEndpointDefinitions.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Direct public reads governed by the canonical public-read freshness policy.
+ * Keeping these definitions together makes the endpoint identity used to
+ * derive freshness reviewable beside its route and tags.
+ */
+export declare const PUBLIC_READ_ENDPOINT_DEFINITIONS: {
+    getPublishedEntryPreview: {
+        path: "/public/content/{siteId}/{type}/{slug}/preview";
+        method: "GET";
+        revalidate: number;
+        tags: "content-{siteId}-{type}-{slug}"[];
+        auth: "public";
+        responseKind: "json";
+    };
+    listPublishedEntries: {
+        path: "/public/content/{siteId}/{type}/entries";
+        method: "GET";
+        revalidate: number;
+        tags: "content-{siteId}-{type}"[];
+        auth: "public";
+        responseKind: "json";
+    };
+    getPublicFormById: {
+        path: "/public/forms/{formId}";
+        method: "GET";
+        revalidate: number;
+        tags: "riverbank:form:{formId}"[];
+        auth: "public";
+        responseKind: "json";
+    };
+    listPublicEvents: {
+        path: "/public/sites/{siteId}/events";
+        method: "GET";
+        revalidate: number;
+        tags: "riverbank:site:{siteId}:public-events"[];
+        auth: "public";
+        responseKind: "json";
+    };
+    listPublicTeamMembers: {
+        path: "/public/sites/{siteId}/team-members";
+        method: "GET";
+        revalidate: number;
+        tags: "riverbank:site:{siteId}:public-team-members"[];
+        errors: never[];
+        auth: "public";
+        responseKind: "json";
+    };
+    listPublicPasses: {
+        path: "/public/sites/{siteId}/bookings/products/passes";
+        method: "GET";
+        revalidate: number;
+        tags: "riverbank:site:{siteId}:public-passes"[];
+        auth: "public";
+        responseKind: "json";
+    };
+    listPublicMemberships: {
+        path: "/public/sites/{siteId}/bookings/products/memberships";
+        method: "GET";
+        revalidate: number;
+        tags: "riverbank:site:{siteId}:public-memberships"[];
+        auth: "public";
+        responseKind: "json";
+    };
+    listPublicProducts: {
+        path: "/public/sites/{siteId}/products";
+        method: "GET";
+        revalidate: number;
+        tags: "riverbank:site:{siteId}:public-products"[];
+        errors: never[];
+        auth: "public";
+        responseKind: "json";
+    };
+};

package/dist/_dts/api/src/schemas/site-api-keys.d.ts

@@ -53,8 +53,8 @@ export declare const sitePreviewKeyParamsSchema: z.ZodObject<{
 export declare const createSiteApiKeyBodySchema: z.ZodObject<{
     name: z.ZodString;
     environment: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
-        test: "test";
         live: "live";
+        test: "test";
     }>>>;
 }, z.core.$strip>;
 /** What a client sends: `environment` may be omitted. */

package/dist/_dts/api/src/sdkContracts.d.ts

@@ -469,11 +469,7 @@ export interface SdkPullNavigationItem {
 export interface SdkPullNavigationMenu {
     id: string;
     siteId: string;
-    identifier: string | null;
-    name: string;
-    isPrimary: boolean;
-    isFooter: boolean;
-    footerRole: 'main' | 'legal-policy' | null;
+    location: 'main' | 'footer' | 'legal';
     items: SdkPullNavigationItem[];
     createdAt: string;
     updatedAt: string;
@@ -1146,11 +1142,7 @@ export interface SdkEventOccurrenceResponse {
 }
 export type SdkUpsertNavigationMenuResponse = SdkCommandApplicationResult<{
     id: string;
-    identifier: string | null;
-    name: string;
-    isPrimary: boolean;
-    isFooter: boolean;
-    footerRole: 'main' | 'legal-policy' | null;
+    location: 'main' | 'footer' | 'legal';
     items: SdkPullNavigationItem[];
     createdAt: string;
     updatedAt: string;

package/dist/_dts/api/src/sdkThemeWire.d.ts

@@ -1767,7 +1767,7 @@ export declare const sdkThemeWireSchema: z.ZodType<{
                     family: "organic-squiggle" | "short-center-rule";
                     colorToken?: "text" | "primary" | "secondary" | "accent" | "muted" | "border" | undefined;
                 } | null | undefined;
-                headingDecorationOverride?: "on" | "off" | "site-default" | null | undefined;
+                headingDecorationOverride?: "off" | "on" | "site-default" | null | undefined;
                 accordionIconTreatment?: {
                     iconSet: "chevron" | "caret" | "plus" | "minimal-cross";
                     colorToken: "text" | "current" | "primary" | "secondary" | "accent" | "muted";
@@ -3827,7 +3827,7 @@ export declare const sdkThemeWireSchema: z.ZodType<{
                     family: "organic-squiggle" | "short-center-rule";
                     colorToken?: "text" | "primary" | "secondary" | "accent" | "muted" | "border" | undefined;
                 } | null | undefined;
-                headingDecorationOverride?: "on" | "off" | "site-default" | null | undefined;
+                headingDecorationOverride?: "off" | "on" | "site-default" | null | undefined;
                 accordionIconTreatment?: {
                     iconSet: "chevron" | "caret" | "plus" | "minimal-cross";
                     colorToken: "text" | "current" | "primary" | "secondary" | "accent" | "muted";

package/dist/_dts/api/src/siteManagementEndpoints.d.ts

@@ -834,41 +834,12 @@ export type SiteManagementAPIEndpoints = {
     }, {
         menus: NavigationMenuWithItems[];
     }>;
-    createNavigationMenu: APIEndpoint<{
-        name: string;
-        isPrimary?: boolean;
-        isFooter?: boolean;
-        footerRole?: 'main' | 'legal-policy' | null;
-        position?: number;
-    }, {
-        siteId: string;
-    }, {
-        menus: NavigationMenuWithItems[];
-    }>;
     getNavigationMenuItems: APIEndpoint<never, {
         siteId: string;
         menuId: string;
     }, {
         items: NavigationItemRecord[];
     }>;
-    updateNavigationMenu: APIEndpoint<{
-        name?: string;
-        isPrimary?: boolean;
-        isFooter?: boolean;
-        footerRole?: 'main' | 'legal-policy' | null;
-        position?: number;
-    }, {
-        siteId: string;
-        menuId: string;
-    }, {
-        menus: NavigationMenuWithItems[];
-    }>;
-    deleteNavigationMenu: APIEndpoint<never, {
-        siteId: string;
-        menuId: string;
-    }, {
-        menus: NavigationMenuWithItems[];
-    }>;
     createNavigationItem: APIEndpoint<{
         label: string;
         type: 'link' | 'dropdown';