@riverbankcms/sdk 0.139.0 → 0.141.0

package/dist/_dts/core/src/mailing-list-setup.d.ts

@@ -1,6 +1,9 @@
 import type { Brand, SiteId } from './branded';
-import type { BrevoAccountId, BrevoConfirmationTemplateId, BrevoConnectionId, BrevoListId, MailchimpAccountId, MailchimpAudienceId, MailchimpConnectionId, NewsletterListId } from './mailing-list-identifiers';
+import { type BrevoAccountId, type BrevoConfirmationTemplateId, type BrevoConnectionId, type BrevoListId, type MailchimpAccountId, type MailchimpAudienceId, type MailchimpConnectionId, type NewsletterListId } from './mailing-list-identifiers';
+import { type Result } from './result';
 export type MailingListProvider = 'native' | 'mailchimp' | 'brevo';
+/** The name shown to people for each provider; the native one is the product brand. */
+export declare function mailingListProviderName(provider: MailingListProvider): string;
 export type NativeMailingListTopicId = NewsletterListId;
 export type MailingListSetupRevision = Brand<number, 'MailingListSetupRevision'>;
 export type MailingListProfileField = 'name' | 'first_name' | 'last_name' | 'company' | 'phone';
@@ -22,8 +25,15 @@ export type MailingListGlobalForm = Readonly<{
     fields: MailingListGlobalFields;
     includeOptionalPhone: boolean;
     buttonLabel: string;
+    successMessage: string;
     privacyNote: string | null;
 }>;
+export declare const DEFAULT_MAILING_LIST_SUCCESS_MESSAGE = "Thanks \u2014 you're on the list.";
+/**
+ * Seeded into a new setup so every signup form carries a preferences/unsubscribe
+ * reassurance out of the box. Administrators can edit or clear it.
+ */
+export declare const DEFAULT_MAILING_LIST_PRIVACY_NOTE = "Change your preferences or unsubscribe at any time.";
 export type ToggleConfirmation = Readonly<{
     tag: 'off';
 }> | Readonly<{
@@ -126,4 +136,7 @@ export type MailingListProviderScope = Readonly<{
     provider: 'brevo';
     accountId: BrevoAccountId;
 }>;
+export declare function mailingListProviderScopeFromConfigured(provider: ConfiguredMailingListProvider): MailingListProviderScope;
+export declare function parseMailingListProviderScope(value: unknown): Result<MailingListProviderScope, 'invalid_mailing_list_provider_scope'>;
+export declare function sameMailingListProviderScope(previous: MailingListProviderScope, next: MailingListProviderScope): boolean;
 export declare function countDefaultMailingListPlacements(placementModes: readonly ('default' | 'custom')[]): number;

package/dist/_dts/core/src/mailing-list-submission.d.ts

@@ -34,23 +34,22 @@ export type MailingListSignupSource = Readonly<{
 export type MailingListSignupSourceRef = Readonly<{
     tag: 'block_ref';
     blockId: MailingListBlockId;
+    contentVersionId: ContentVersionId;
 }> | Readonly<{
     tag: 'signed_source_ref';
     token: MailingListSignedSourceToken;
 }>;
 /** Source identity signed into managed-footer and SDK-footer form tokens. */
 export type MailingListSignupTokenSource = Readonly<{
-    kind: 'block';
-    blockId: MailingListBlockId;
-}> | Readonly<{
     kind: 'footer-composition';
     sectionId: FooterModuleId;
+    revision: MailingListFooterRevision;
 }> | Readonly<{
     kind: 'sdk-footer-block';
     blockId: MailingListSdkFooterBlockId;
     contentHash: MailingListSdkContentHash;
 }>;
-export declare function buildMailingListSignupBlockSourceRef(blockId: unknown): MailingListSignupSourceRef | null;
+export declare function buildMailingListSignupBlockSourceRef(blockId: unknown, contentVersionId: unknown): MailingListSignupSourceRef | null;
 type MailingListSignupProfileBase = Readonly<{
     email: NormalizedSubscriberEmail;
     phone: Readonly<{
@@ -108,27 +107,6 @@ type ResolvedMailingListSignupIntentBase = Readonly<{
     source: MailingListSignupSource;
     consentedAt: string;
 }>;
-type ResolvedMailingListFormProfile = Readonly<{
-    formPreset: 'emailOnly';
-    profile: Extract<MailingListSignupProfile, {
-        preset: 'emailOnly';
-    }>;
-}> | Readonly<{
-    formPreset: 'emailName';
-    profile: Extract<MailingListSignupProfile, {
-        preset: 'emailName';
-    }>;
-}> | Readonly<{
-    formPreset: 'emailFirstLast';
-    profile: Extract<MailingListSignupProfile, {
-        preset: 'emailFirstLast';
-    }>;
-}> | Readonly<{
-    formPreset: 'emailNameCompany';
-    profile: Extract<MailingListSignupProfile, {
-        preset: 'emailNameCompany';
-    }>;
-}>;
 type ResolvedMailingListProviderIntent = Readonly<{
     provider: 'native';
     target: Extract<ResolvedMailingListTarget, {
@@ -150,7 +128,9 @@ type ResolvedMailingListProviderIntent = Readonly<{
     }>;
     confirmation: BrevoConfirmation;
 }>;
-export type ResolvedMailingListSignupIntent = ResolvedMailingListSignupIntentBase & ResolvedMailingListFormProfile & ResolvedMailingListProviderIntent;
+export type ResolvedMailingListSignupIntent = ResolvedMailingListSignupIntentBase & Readonly<{
+    profile: MailingListSignupProfile;
+}> & ResolvedMailingListProviderIntent;
 export type MailingListProviderAcknowledgement = Readonly<{
     tag: 'subscribed';
 }> | Readonly<{
@@ -199,7 +179,7 @@ export type MailingListPublicSignupResponse = Readonly<{
     reason: 'profile_rejected';
 }> | Readonly<{
     tag: 'unavailable';
-    reason: 'configuration_unavailable' | 'stale_configuration' | 'authentication_failed' | 'target_unavailable' | 'subscriber_suppressed' | 'rate_limited' | 'temporarily_unavailable';
+    reason: 'configuration_unavailable' | 'stale_configuration' | 'authentication_failed' | 'target_unavailable' | 'rate_limited' | 'temporarily_unavailable';
 }> | Readonly<{
     tag: 'uncertain';
     reason: 'deadline_exceeded' | 'network_interrupted';

package/dist/_dts/core/src/participants.d.ts

@@ -1,4 +1,4 @@
-import { type AppointmentId, type AttendeeId, type Brand, type CustomerId, type EventSeriesRegistrationId, type EventAttendeeGuestId, type ParticipantId } from './branded';
+import { type AppointmentId, type AttendeeId, type Brand, type CustomerId, type EventSeriesRegistrationId, type ParticipantId } from './branded';
 import { type Result } from './result';
 export type ParticipantEmail = Brand<string, 'ParticipantEmail'>;
 export type ParticipantSlotKey = Brand<string, 'ParticipantSlotKey'>;
@@ -14,26 +14,6 @@ export type ParticipantCountParseError = {
 } | {
     kind: 'non_positive_participant_count';
 };
-export type ProvisionalParticipantIdentity = Readonly<{
-    kind: 'event_guest';
-    eventAttendeeGuestId: EventAttendeeGuestId;
-    slotKey: ParticipantSlotKey;
-}>;
-export type ProvisionalParticipantIdentityMetadata = Readonly<{
-    kind: 'event_guest';
-    source: 'event_guest_backfill';
-    eventAttendeeGuestId: EventAttendeeGuestId;
-    slotKey: ParticipantSlotKey;
-}>;
-export type ProvisionalParticipantIdentityParseError = {
-    kind: 'not_an_object';
-} | {
-    kind: 'unsupported_identity_kind';
-} | {
-    kind: 'missing_event_attendee_guest_id';
-} | {
-    kind: 'missing_slot_key';
-};
 export declare function unsafeAsParticipantSlotKey(value: string): ParticipantSlotKey;
 export declare function unsafeAsParticipantCount(value: number): ParticipantCount;
 /**
@@ -45,12 +25,6 @@ export declare function unsafeAsParticipantCount(value: number): ParticipantCoun
 export declare function normalizeParticipantEmail(value: string | null | undefined): ParticipantEmail | null;
 export declare function parseParticipantEmail(value: string | null | undefined): Result<ParticipantEmail, ParticipantEmailNormalizationError>;
 export declare function parseParticipantCount(value: number): Result<ParticipantCount, ParticipantCountParseError>;
-export declare function provisionalEventGuestParticipantIdentity(input: Readonly<{
-    eventAttendeeGuestId: EventAttendeeGuestId;
-    slotKey: ParticipantSlotKey;
-}>): ProvisionalParticipantIdentity;
-export declare function encodeProvisionalParticipantIdentity(identity: ProvisionalParticipantIdentity): ProvisionalParticipantIdentityMetadata;
-export declare function parseProvisionalParticipantIdentity(value: unknown): Result<ProvisionalParticipantIdentity, ProvisionalParticipantIdentityParseError>;
 export declare function deriveParticipantDisplayLabel(input: Readonly<{
     displayName: string | null;
     emailNormalized: ParticipantEmail | null;
@@ -100,7 +74,7 @@ export type ParticipantParticipation = {
 } | {
     kind: 'event_guest';
     attendeeId: AttendeeId;
-    guestId: EventAttendeeGuestId;
+    guestIndex: number;
 } | {
     kind: 'event_series_registration';
     registrationId: EventSeriesRegistrationId;
@@ -177,7 +151,6 @@ export type EventRegistrationParticipantProjectionInput = Readonly<{
         customerId: CustomerId;
     };
     guests: readonly (ParticipantContactInput & {
-        guestId: EventAttendeeGuestId;
         guestIndex: number;
     })[];
 }>;

package/dist/_dts/core/src/public-experience.d.ts

@@ -0,0 +1,4 @@
+export declare const PUBLIC_EXPERIENCES: readonly ["website", "hosted_booking"];
+export type PublicExperience = (typeof PUBLIC_EXPERIENCES)[number];
+export declare function isPublicExperience(value: unknown): value is PublicExperience;
+export declare function parsePublicExperience(value: unknown): PublicExperience | null;

package/dist/_dts/core/src/public-profile.d.ts

@@ -62,14 +62,35 @@ export type PublicSocialLink = Readonly<{
  * `shown`.
  */
 export type PublicAddressVisibility = 'shown' | 'hidden';
+/**
+ * Whether each contact method is published on the site. Both default to shown,
+ * because that is what a saved contact has always meant. A hidden email can
+ * still be the privacy policy's contact: hiding it withholds it from the page,
+ * not from the policy.
+ */
+export type PublicContactVisibility = Readonly<{
+    phone: PublicAddressVisibility;
+    email: PublicAddressVisibility;
+}>;
 export type PublicProfile = Readonly<{
     contact: PublicContactDetails | null;
+    contactVisibility: PublicContactVisibility;
     openingHours: WeeklyOpeningHours | null;
     socialLinks: readonly PublicSocialLink[];
     addressVisibility: PublicAddressVisibility;
+    /**
+     * Whether the business runs from a place people come to, which is what the
+     * address and opening hours belong to.
+     *
+     * Null means nobody has answered yet, and it stays null rather than
+     * defaulting to false: a site that already has a saved address plainly has
+     * premises, and only the caller holding that address can say so. Resolve it
+     * with `resolvePublicProfilePremises`.
+     */
+    premises: boolean | null;
 }>;
 export type PublicProfileParseError = Readonly<{
-    code: 'invalid_shape' | 'contact_method_required' | 'invalid_email' | 'invalid_phone' | 'invalid_timezone' | 'invalid_weekdays' | 'invalid_time' | 'invalid_interval' | 'overlapping_intervals' | 'invalid_social_link' | 'invalid_address_visibility' | 'duplicate_social_link_id';
+    code: 'invalid_shape' | 'contact_method_required' | 'invalid_email' | 'invalid_phone' | 'invalid_timezone' | 'invalid_weekdays' | 'invalid_time' | 'invalid_interval' | 'overlapping_intervals' | 'invalid_social_link' | 'invalid_address_visibility' | 'invalid_contact_visibility' | 'invalid_premises' | 'duplicate_social_link_id';
     path: string;
     message: string;
 }>;
@@ -78,4 +99,9 @@ export declare function parsePublicProfileTimeZone(value: unknown): Result<Publi
 export declare function parseWeeklyOpeningHours(value: unknown): Result<WeeklyOpeningHours, PublicProfileParseError>;
 export declare function parsePublicSocialLinks(value: unknown): Result<readonly PublicSocialLink[], PublicProfileParseError>;
 export declare function parsePublicProfile(value: unknown): Result<PublicProfile, PublicProfileParseError>;
+/**
+ * Resolves whether a site has premises, falling back to whether it already
+ * holds a business address for every profile saved before the switch existed.
+ */
+export declare function resolvePublicProfilePremises(profile: PublicProfile, hasBusinessAddress: boolean): boolean;
 export declare function emptyPublicProfile(): PublicProfile;

package/dist/_dts/core/src/site-route-target.d.ts

@@ -1,6 +1,6 @@
-import { type BrandedIdParseError, type ContentEntryId, type PageId, type PageSurfaceId } from './branded';
+import { type BrandedIdParseError, type ContentEntryId, type AppointmentServiceId, type PageId, type PageSurfaceId } from './branded';
 import { type Result } from './result';
-export declare const SITE_ROUTE_NODE_TYPES: readonly ["page", "content_entry", "page_surface"];
+export declare const SITE_ROUTE_NODE_TYPES: readonly ["page", "content_entry", "page_surface", "appointment_service"];
 export type SiteRouteNodeType = (typeof SITE_ROUTE_NODE_TYPES)[number];
 export type SiteRouteTarget = Readonly<{
     kind: 'page';
@@ -11,6 +11,9 @@ export type SiteRouteTarget = Readonly<{
 }> | Readonly<{
     kind: 'pageSurface';
     surfaceId: PageSurfaceId;
+}> | Readonly<{
+    kind: 'appointmentService';
+    serviceId: AppointmentServiceId;
 }>;
 export type SiteRouteTargetParseError = Readonly<{
     kind: 'invalid-node-type';
@@ -27,6 +30,9 @@ export type SiteRouteTargetParseError = Readonly<{
 }> | Readonly<{
     kind: 'invalid-page-surface-id';
     error: BrandedIdParseError;
+}> | Readonly<{
+    kind: 'invalid-appointment-service-id';
+    error: BrandedIdParseError;
 }>;
 export declare function parseSiteRouteTarget(input: Readonly<{
     nodeType: unknown;
@@ -37,4 +43,5 @@ export declare function foldSiteRouteTarget<TValue>(target: SiteRouteTarget, cas
     page: (pageId: PageId) => TValue;
     contentEntry: (entryId: ContentEntryId) => TValue;
     pageSurface: (surfaceId: PageSurfaceId) => TValue;
+    appointmentService: (serviceId: AppointmentServiceId) => TValue;
 }>): TValue;