@riverbankcms/sdk 0.138.0 → 0.139.0

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

@@ -1,19 +1,21 @@
-import type { Theme } from "../../blocks/src/index";
-import type { LogoFacts } from "../../theme-core/src/site-styles/index";
-import { z } from "zod";
-import type { AiGenerateSiteEntityType, AiGenerateSitePrimaryCta, AiGenerateSiteRequest } from "./siteGeneration";
-import type { SiteVerticalBookingConfig } from "../../core/src/index";
-import type { AppointmentSetupTargetStep } from "./appointmentSetup";
+import type { Theme } from '../../blocks/src/index';
+import type { SiteVerticalBookingConfig } from '../../core/src/index';
+import { z } from 'zod';
+import type { AiGenerateSiteEntityType, AiGenerateSitePrimaryCta, AiGenerateSiteRequest } from './siteGeneration';
+import type { AppointmentSetupTargetStep } from './appointmentSetup';
+import type { MacadamiaOnboardingLogoAnalysis, MacadamiaOnboardingSurfaceData, PublicOnboardingSurfaceId } from './onboarding/surfaceData';
+export type * from './onboarding/surfaceData';
 /**
  * Site Onboarding Contracts
  *
- * These types cover AI-assisted site setup, launch readiness, and the
- * Macadamia public onboarding flow.
+ * These types cover AI-assisted site setup, launch readiness, and the public
+ * onboarding attempt lifecycle. The Macadamia surface's own draft shapes live
+ * in `./onboarding/surfaceData` and are re-exported from here.
  *
  * Note: Do NOT use these API types as validation schemas. They document wire
  * contracts while the owning services validate and normalize inputs.
  */
-export type SitePurpose = "GENERATE_LEADS" | "SHOWCASE_PORTFOLIO" | "SELL_PRODUCTS" | "SELL_TICKETS" | "EVENT_INFO" | "BLOGGING" | "COMMUNITY" | "OTHER";
+export type SitePurpose = 'GENERATE_LEADS' | 'SHOWCASE_PORTFOLIO' | 'SELL_PRODUCTS' | 'SELL_TICKETS' | 'EVENT_INFO' | 'BLOGGING' | 'COMMUNITY' | 'OTHER';
 export type AiBrandGuidelinesExample = {
     title: string;
     text: string;
@@ -29,8 +31,8 @@ export type SiteAiBrandGuidelinesPayload = {
 export type SiteAiBrandGuidelinesResponse = {
     settings: SiteAiBrandGuidelinesPayload | null;
 };
-export type SiteAiProfileEntityType = "INDIVIDUAL" | "BUSINESS" | "NON_PROFIT" | "EVENT" | "COMMUNITY" | "OTHER";
-export type SiteAiProfileLocationMode = "PHYSICAL" | "REMOTE_ONLY" | "NOT_RELEVANT";
+export type SiteAiProfileEntityType = 'INDIVIDUAL' | 'BUSINESS' | 'NON_PROFIT' | 'EVENT' | 'COMMUNITY' | 'OTHER';
+export type SiteAiProfileLocationMode = 'PHYSICAL' | 'REMOTE_ONLY' | 'NOT_RELEVANT';
 export type SiteAiProfilePayload = {
     entityType: SiteAiProfileEntityType;
     entityName: string;
@@ -53,7 +55,7 @@ export type SiteContentSamplingStats = {
     placeholderCandidateCount: number;
 };
 export type SiteContentSampledItem = {
-    kind: "page" | "entry";
+    kind: 'page' | 'entry';
     title: string | null;
     path: string | null;
     identifier: string | null;
@@ -68,16 +70,16 @@ export type AiBrandGuidelinesGenerationContextResponse = {
     };
 };
 export type AiBrandGuidelinesGenerateRequest = {
-    step: "field";
-    field: "audience" | "brandVoice" | "writingGuidelines" | "dos" | "donts" | "examples";
+    step: 'field';
+    field: 'audience' | 'brandVoice' | 'writingGuidelines' | 'dos' | 'donts' | 'examples';
     useSiteContent: boolean;
     lockedSettings: Partial<SiteAiBrandGuidelinesPayload>;
     currentSettings?: SiteAiBrandGuidelinesPayload;
     userMessage?: string;
 };
 export type AiBrandGuidelinesGenerateResponse = {
-    kind: "field-proposal";
-    field: "audience" | "brandVoice" | "writingGuidelines" | "dos" | "donts" | "examples";
+    kind: 'field-proposal';
+    field: 'audience' | 'brandVoice' | 'writingGuidelines' | 'dos' | 'donts' | 'examples';
     message: string;
     proposal: Partial<SiteAiBrandGuidelinesPayload>;
     siteContent: {
@@ -87,36 +89,11 @@ export type AiBrandGuidelinesGenerateResponse = {
         stats: SiteContentSamplingStats;
     };
 };
-export type MacadamiaOnboardingSiteMode = "single_page" | "fuller_starter";
-export type MacadamiaOnboardingMappedPalette = {
-    palette: Record<"primary" | "secondary" | "accent" | "background" | "surface" | "text", string>;
-    mode: "light" | "dark";
-};
-export type MacadamiaOnboardingLogoPaletteRecommendation = {
-    title: string;
-    palette: MacadamiaOnboardingMappedPalette["palette"];
-};
-export type MacadamiaOnboardingLogoAnalysis = {
-    logoFacts: LogoFacts;
-    recommendedPalettes: MacadamiaOnboardingLogoPaletteRecommendation[];
-    ignoredColors: string[];
-};
-export type MacadamiaOnboardingVisualIdentity = {
-    logoPath: string | null;
-    logoUrl: string | null;
-    logoPalette: string[] | null;
-    logoMappedPalette: MacadamiaOnboardingMappedPalette | null;
-    logoAnalysis: MacadamiaOnboardingLogoAnalysis | null;
-    primaryColor: string | null;
-    secondaryColors: string[];
-    selectedPaletteKey: string | null;
-    inspirationUrls: string[];
-};
-export type LaunchRequirementId = "confirm_email" | "review_generated_site" | "configure_appointments" | "configure_events" | "configure_courses" | "connect_payments" | "connect_custom_domain";
-export type LaunchRequirementPackId = "core" | "bookings_appointments" | "bookings_events" | "bookings_courses" | "payments" | "domain";
-export type LaunchRequirementPriority = "required" | "recommended" | "optional";
-export type LaunchRequirementState = "complete" | "pending";
-export type LaunchRequirementOwner = "admin" | "editor" | "either";
+export type LaunchRequirementId = 'confirm_email' | 'review_generated_site' | 'configure_appointments' | 'configure_events' | 'configure_courses' | 'connect_payments' | 'connect_custom_domain';
+export type LaunchRequirementPackId = 'core' | 'bookings_appointments' | 'bookings_events' | 'bookings_courses' | 'payments' | 'domain';
+export type LaunchRequirementPriority = 'required' | 'recommended' | 'optional';
+export type LaunchRequirementState = 'complete' | 'pending';
+export type LaunchRequirementOwner = 'admin' | 'editor' | 'either';
 export declare const LAUNCH_REQUIREMENT_OVERRIDE_DEFINITIONS: {
     readonly configure_appointments: {
         readonly requirementId: "configure_appointments";
@@ -124,93 +101,93 @@ export declare const LAUNCH_REQUIREMENT_OVERRIDE_DEFINITIONS: {
     };
 };
 export type LaunchRequirementOverrideDefinition = (typeof LAUNCH_REQUIREMENT_OVERRIDE_DEFINITIONS)[keyof typeof LAUNCH_REQUIREMENT_OVERRIDE_DEFINITIONS];
-export type LaunchOverridableRequirementId = LaunchRequirementOverrideDefinition["requirementId"];
-export type LaunchRequirementOverrideReason = LaunchRequirementOverrideDefinition["reason"];
+export type LaunchOverridableRequirementId = LaunchRequirementOverrideDefinition['requirementId'];
+export type LaunchRequirementOverrideReason = LaunchRequirementOverrideDefinition['reason'];
 export type LaunchRequirementOverride = {
-    requirementId: Extract<LaunchRequirementId, "configure_appointments">;
+    requirementId: Extract<LaunchRequirementId, 'configure_appointments'>;
     reason: LaunchRequirementOverrideReason;
     acknowledgedAt: string | null;
     acknowledgedBy: string | null;
 };
 export type LaunchRequirementAction = {
-    kind: "open_dashboard_path";
+    kind: 'open_dashboard_path';
     label: string;
     path: string;
 } | {
-    kind: "acknowledge_requirement";
+    kind: 'acknowledge_requirement';
     label: string;
-    requirementId: Extract<LaunchRequirementId, "review_generated_site">;
-    acknowledgementKind: "review";
+    requirementId: Extract<LaunchRequirementId, 'review_generated_site'>;
+    acknowledgementKind: 'review';
 } | {
-    kind: "acknowledge_requirement";
+    kind: 'acknowledge_requirement';
     label: string;
-    requirementId: Extract<LaunchRequirementId, "configure_appointments">;
-    acknowledgementKind: "override";
+    requirementId: Extract<LaunchRequirementId, 'configure_appointments'>;
+    acknowledgementKind: 'override';
     overrideReason: LaunchRequirementOverrideReason;
 } | {
-    kind: "informational_only";
+    kind: 'informational_only';
     label: string;
 };
 export type LaunchRequirementEvidence = {
-    kind: "derived";
+    kind: 'derived';
 } | {
-    kind: "acknowledged";
+    kind: 'acknowledged';
     acknowledgedAt: string | null;
     acknowledgedBy: string | null;
 } | {
-    kind: "overridden";
+    kind: 'overridden';
     reason: LaunchRequirementOverrideReason;
     acknowledgedAt: string | null;
     acknowledgedBy: string | null;
 } | {
-    kind: "deferred";
-    reason: "pending_setup" | "pending_acknowledgement";
+    kind: 'deferred';
+    reason: 'pending_setup' | 'pending_acknowledgement';
 };
 export type LaunchEmailPackState = {
-    kind: "confirmed";
+    kind: 'confirmed';
 } | {
-    kind: "pending_confirmation";
+    kind: 'pending_confirmation';
 };
 export type LaunchReviewPackState = {
-    kind: "reviewed";
+    kind: 'reviewed';
     reviewedAt: string | null;
     reviewedBy: string | null;
 } | {
-    kind: "pending_review";
+    kind: 'pending_review';
 };
 export type LaunchAppointmentsPackState = {
-    kind: "disabled";
+    kind: 'disabled';
 } | {
-    kind: "ready";
+    kind: 'ready';
 } | {
-    kind: "pending_setup";
+    kind: 'pending_setup';
     targetStep: AppointmentSetupTargetStep;
 };
 export type LaunchEventsPackState = {
-    kind: "disabled";
+    kind: 'disabled';
 } | {
-    kind: "ready";
+    kind: 'ready';
 } | {
-    kind: "pending_setup";
+    kind: 'pending_setup';
 };
 export type LaunchPaymentsPackState = {
-    kind: "not_applicable";
+    kind: 'not_applicable';
 } | {
-    kind: "ready";
+    kind: 'ready';
 } | {
-    kind: "pending_setup";
+    kind: 'pending_setup';
 };
 export type LaunchCoursesPackState = {
-    kind: "not_applicable";
+    kind: 'not_applicable';
 } | {
-    kind: "ready";
+    kind: 'ready';
 } | {
-    kind: "pending_setup";
+    kind: 'pending_setup';
 };
 export type LaunchCustomDomainPackState = {
-    kind: "connected";
+    kind: 'connected';
 } | {
-    kind: "pending_setup";
+    kind: 'pending_setup';
 };
 export type LaunchRequirement = {
     id: LaunchRequirementId;
@@ -225,10 +202,10 @@ export type LaunchRequirement = {
     evidence: LaunchRequirementEvidence;
 };
 export type GoLiveDecision = {
-    kind: "allowed";
+    kind: 'allowed';
     overriddenRequirementIds: LaunchRequirementId[];
 } | {
-    kind: "blocked";
+    kind: 'blocked';
     blockingRequirementIds: LaunchRequirementId[];
     overriddenRequirementIds: LaunchRequirementId[];
 };
@@ -247,11 +224,11 @@ export declare const acknowledgeLaunchRequirementRequestSchema: z.ZodDiscriminat
 }, z.core.$strip>], "requirementId">;
 export type AcknowledgeLaunchRequirementRequest = z.infer<typeof acknowledgeLaunchRequirementRequestSchema>;
 export declare function toAcknowledgeLaunchRequirementRequest(action: Extract<LaunchRequirementAction, {
-    kind: "acknowledge_requirement";
+    kind: 'acknowledge_requirement';
 }>): AcknowledgeLaunchRequirementRequest;
 export type AcknowledgeLaunchRequirementResponse = {
     acknowledged: true;
-    requirementId: Extract<LaunchRequirementId, "review_generated_site" | "configure_appointments">;
+    requirementId: Extract<LaunchRequirementId, 'review_generated_site' | 'configure_appointments'>;
 };
 export declare const goLiveSiteRequestSchema: z.ZodObject<{
     acceptExtraSiteCharge: z.ZodOptional<z.ZodBoolean>;
@@ -279,133 +256,11 @@ export type OnboardingPreviewThemesResponse = {
     themes: OnboardingPreviewThemeOption[];
 };
 export type ResendOnboardingPreviewConfirmationResponse = {
-    result: "resent" | "already_confirmed";
+    result: 'resent' | 'already_confirmed';
     dashboardUnlocked: boolean;
     requiresEmailConfirmation: boolean;
     launchReadiness: LaunchReadiness;
 };
-export type PublicOnboardingSurfaceId = "macadamia";
-export type MacadamiaOnboardingTeamMode = "solo" | "team";
-export type MacadamiaOnboardingOfferingKind = "classes" | "courses" | "workshops" | "retreats" | "performances" | "private_sessions";
-export type MacadamiaOnboardingStyleMood = "calm_grounding" | "warm_welcoming" | "modern_polished" | "natural_earthy" | "bright_uplifting" | "luxury_retreat";
-export type MacadamiaOnboardingFirstOfferingKind = "class" | "course" | "workshop" | "retreat" | "performance" | "private_session";
-export type MacadamiaOnboardingFirstOfferingDeliveryMode = "in_person" | "online" | "both";
-export type MacadamiaOnboardingFirstOfferingScheduleMode = "weekly" | "one_off";
-export type MacadamiaOnboardingWeekday = "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday";
-export type MacadamiaOnboardingEventSession = {
-    clientId: string;
-    startDate: string;
-    startTime: string;
-    endDate: string;
-    endTime: string;
-    isMultiDay: boolean;
-};
-export type MacadamiaOnboardingFirstOffering = {
-    kind: "class";
-    title: string;
-    description: string | null;
-    deliveryMode: MacadamiaOnboardingFirstOfferingDeliveryMode;
-    location: string | null;
-    startDate: string;
-    recurrenceRule: string;
-    startTime: string;
-    durationMinutes: number;
-    priceType: "free" | "paid";
-    priceAmount: number | null;
-    capacity: number | null;
-} | {
-    kind: "course";
-    title: string;
-    description: string | null;
-    deliveryMode: MacadamiaOnboardingFirstOfferingDeliveryMode;
-    location: string | null;
-    priceType: "free" | "paid";
-    priceAmount: number | null;
-    capacity: number | null;
-    sessions: MacadamiaOnboardingEventSession[];
-} | {
-    kind: "workshop" | "retreat" | "performance";
-    title: string;
-    description: string | null;
-    deliveryMode: MacadamiaOnboardingFirstOfferingDeliveryMode;
-    location: string | null;
-    scheduleMode: MacadamiaOnboardingFirstOfferingScheduleMode;
-    startDate: string;
-    startTime: string;
-    durationMinutes: number;
-    priceType: "free" | "paid";
-    priceAmount: number | null;
-    capacity: number | null;
-} | {
-    kind: "private_session";
-    title: string;
-    description: string | null;
-    deliveryMode: MacadamiaOnboardingFirstOfferingDeliveryMode;
-    location: string | null;
-    durationMinutes: number;
-    priceType: "free" | "paid";
-    priceAmount: number | null;
-};
-export type MacadamiaOnboardingDraftFirstOffering = {
-    kind: "class";
-    title: string;
-    description: string | null;
-    deliveryMode: MacadamiaOnboardingFirstOfferingDeliveryMode | null;
-    location: string | null;
-    startDate: string | null;
-    recurrenceRule: string | null;
-    startTime: string | null;
-    durationMinutes: number | null;
-    priceType: "free" | "paid" | null;
-    priceAmount: number | null;
-    capacity: number | null;
-} | {
-    kind: "course";
-    title: string;
-    description: string | null;
-    deliveryMode: MacadamiaOnboardingFirstOfferingDeliveryMode | null;
-    location: string | null;
-    priceType: "free" | "paid" | null;
-    priceAmount: number | null;
-    capacity: number | null;
-    sessions: MacadamiaOnboardingEventSession[];
-} | {
-    kind: "workshop" | "retreat" | "performance";
-    title: string;
-    description: string | null;
-    deliveryMode: MacadamiaOnboardingFirstOfferingDeliveryMode | null;
-    location: string | null;
-    scheduleMode: MacadamiaOnboardingFirstOfferingScheduleMode;
-    startDate: string | null;
-    startTime: string | null;
-    durationMinutes: number | null;
-    priceType: "free" | "paid" | null;
-    priceAmount: number | null;
-    capacity: number | null;
-} | {
-    kind: "private_session";
-    title: string;
-    description: string | null;
-    deliveryMode: MacadamiaOnboardingFirstOfferingDeliveryMode | null;
-    location: string | null;
-    durationMinutes: number | null;
-    priceType: "free" | "paid" | null;
-    priceAmount: number | null;
-};
-export type MacadamiaOnboardingSurfaceData = {
-    teamMode: MacadamiaOnboardingTeamMode;
-    ownerName: string | null;
-    offeringKinds: MacadamiaOnboardingOfferingKind[];
-    bookingVerticalConfig?: SiteVerticalBookingConfig | null;
-    siteMode: MacadamiaOnboardingSiteMode;
-    styleMoods: MacadamiaOnboardingStyleMood[];
-    countryCode: string | null;
-    locationText: string | null;
-    timezone: string;
-    currency: string;
-    visualIdentity: MacadamiaOnboardingVisualIdentity;
-    firstOffering: MacadamiaOnboardingDraftFirstOffering | null;
-};
 export type PublicOnboardingLogoUploadUrlRequest = {
     filename: string;
     bytes: number;
@@ -425,11 +280,11 @@ export type PublicOnboardingLogoUploadResponse = {
     palette: string[];
     logoAnalysis: MacadamiaOnboardingLogoAnalysis | null;
 };
-export type PublicOnboardingAttemptStatus = "draft" | "claimed" | "provisioning" | "provisioned" | "completed" | "cancelled";
-export type PublicOnboardingProvisioningStage = "starting" | "site_setup" | "copy_generation" | "media_generation" | "page_creation" | "surface_setup" | "theme_setup" | "preview_ready";
-export type SiteGenerationScope = "simple" | "comprehensive";
-export type SiteGenerationFeatureKey = "home" | "about" | "contact" | "appointments" | "events" | "testimonials" | "faq" | "newsletter_signup" | "blog" | "portfolio" | "gallery" | "map_directions";
-export type SiteGenerationBookingOfferingKind = "classes" | "courses" | "workshops" | "retreats" | "performances" | "private_sessions";
+export type PublicOnboardingAttemptStatus = 'draft' | 'claimed' | 'provisioning' | 'provisioned' | 'completed' | 'cancelled';
+export type PublicOnboardingProvisioningStage = 'starting' | 'site_setup' | 'copy_generation' | 'media_generation' | 'page_creation' | 'surface_setup' | 'theme_setup' | 'preview_ready';
+export type SiteGenerationScope = 'simple' | 'comprehensive';
+export type SiteGenerationFeatureKey = 'home' | 'about' | 'contact' | 'appointments' | 'events' | 'testimonials' | 'faq' | 'newsletter_signup' | 'blog' | 'portfolio' | 'gallery' | 'map_directions';
+export type SiteGenerationBookingOfferingKind = 'classes' | 'courses' | 'workshops' | 'retreats' | 'performances' | 'private_sessions';
 export type AiSiteWizardSuggestGoalsRequest = {
     entityType: AiGenerateSiteEntityType;
     entityName: string;
@@ -469,7 +324,7 @@ export type AiSiteWizardIntakeTriageResponse = {
         shop: string | null;
     };
 };
-export type AiSiteWizardTelemetryEvent = "wizard_resumed" | "goal_suggestions_loaded" | "goal_suggestions_failed" | "goal_suggestions_stale" | "wizard_draft_saved" | "wizard_draft_save_failed";
+export type AiSiteWizardTelemetryEvent = 'wizard_resumed' | 'goal_suggestions_loaded' | 'goal_suggestions_failed' | 'goal_suggestions_stale' | 'wizard_draft_saved' | 'wizard_draft_save_failed';
 export type AiSiteWizardTelemetryRequest = {
     event: AiSiteWizardTelemetryEvent;
     metadata?: Record<string, unknown>;
@@ -491,8 +346,8 @@ export type SiteWizardResumeSnapshot = {
     logoUrl?: string | null;
     logoPalette?: string[] | null;
     logoMappedPalette?: {
-        palette: Record<"primary" | "secondary" | "accent" | "background" | "surface" | "text", string>;
-        mode: "light" | "dark";
+        palette: Record<'primary' | 'secondary' | 'accent' | 'background' | 'surface' | 'text', string>;
+        mode: 'light' | 'dark';
     } | null;
     logoAnalysis?: MacadamiaOnboardingLogoAnalysis | null;
     goalSuggestions?: AiSiteWizardSuggestGoalsResponse | null;
@@ -542,49 +397,57 @@ export type PublicOnboardingAttemptResponse = {
     attemptToken: string;
 };
 export type PublicOnboardingAttemptProgress = {
-    kind: "awaiting_auth";
+    kind: 'awaiting_auth';
 } | {
-    kind: "idle";
+    kind: 'idle';
 } | {
-    kind: "running";
+    kind: 'running';
     stage: PublicOnboardingProvisioningStage;
     message: string;
     startedAt: string | null;
     lastUpdatedAt: string | null;
 } | {
-    kind: "taking_longer";
+    kind: 'taking_longer';
     stage: PublicOnboardingProvisioningStage;
     message: string;
     startedAt: string | null;
     lastUpdatedAt: string | null;
 } | {
-    kind: "ready";
+    kind: 'ready';
     siteId: string;
     siteSlug: string;
     continuePath: string;
 } | {
-    kind: "failed";
+    kind: 'failed';
     errorMessage: string;
 } | {
-    kind: "unavailable";
-    reason: "completed" | "cancelled" | "invalid_site";
+    kind: 'unavailable';
+    /**
+     * The last two are not about the attempt row: `experience_unavailable`
+     * means the chosen public experience cannot be provisioned yet and
+     * `experience_not_chosen` means no experience was ever picked (see
+     * `planOnboardingExperienceProvisioning`). The attempt itself is
+     * untouched and stays claimed in both cases, and only the first is a
+     * dead end for the person: the second sends them back to the wizard.
+     */
+    reason: 'completed' | 'cancelled' | 'invalid_site' | 'experience_unavailable' | 'experience_not_chosen';
     message: string;
 };
 export type PublicOnboardingAttemptProgressResponse = {
     progress: PublicOnboardingAttemptProgress;
 };
 export type PublicOnboardingAttemptRunKickoff = {
-    kind: "started";
+    kind: 'started';
     runId: string;
 } | {
-    kind: "restarted_stale";
+    kind: 'restarted_stale';
     runId: string;
 } | {
-    kind: "already_running";
+    kind: 'already_running';
 } | {
-    kind: "not_needed";
+    kind: 'not_needed';
 } | {
-    kind: "blocked";
+    kind: 'blocked';
 };
 export type PublicOnboardingAttemptRunResponse = {
     kickoff: PublicOnboardingAttemptRunKickoff;

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

@@ -320,19 +320,11 @@ export type SitePlatformAPIEndpoints = {
         reordered: true;
     }>;
     sdkUpsertNavigationMenu: APIEndpoint<{
-        identifier?: string;
-        name: string;
-        isPrimary?: boolean;
-        isFooter?: boolean;
-        footerRole?: 'main' | 'legal-policy' | null;
+        location: 'main' | 'footer' | 'legal';
         items: readonly SdkUpsertNavigationItemInput[];
     }, {
         siteId: string;
     }, SdkUpsertNavigationMenuResponse>;
-    sdkDeleteNavigationMenu: APIEndpoint<never, {
-        siteId: string;
-        menuId: string;
-    }, SdkDeleteResponse>;
     sdkUpsertTheme: APIEndpoint<Readonly<{
         kind: 'update';
         /**

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

@@ -1,10 +1,19 @@
 import type { SiteFooterContent, SiteHeaderContent } from "../../blocks/src/index";
-import type { BusinessAddress } from "../../core/src/index";
+import type { BusinessAddress, PublicAddressVisibility, PublicContactDetails } from "../../core/src/index";
 import type { FooterMode } from "../../theme-core/src/index";
 import type { SiteBannerSettingsPayload } from "./siteBanner";
 export type SiteDeploymentMode = "managed" | "headless_cms" | "headless_full";
 export type SiteGeneralSettingsPayload = {
     siteTitle: string;
+    /**
+     * The site's tagline, stored in `site_settings.site_description`. Read as
+     * the SEO description fallback and by the booking-page header.
+     *
+     * Optional on the way in, where absent means unchanged: a client that has
+     * no tagline field yet, including a browser tab loaded before this shipped,
+     * must not have its save rejected or blank the stored value.
+     */
+    siteDescription?: string | null;
     logoAssetId: string | null;
     faviconAssetId: string | null;
     allowIndexingInProduction: boolean;
@@ -12,6 +21,16 @@ export type SiteGeneralSettingsPayload = {
 export type SiteGeneralSettingsResponse = {
     settings: SiteGeneralSettingsPayload;
 };
+/**
+ * The business details a rendered site reads. The address itself already
+ * travels on the site record; `addressVisibility` says whether a reader may
+ * show it.
+ */
+export type SiteRuntimeBusinessDetails = {
+    tagline: string | null;
+    contact: PublicContactDetails | null;
+    addressVisibility: PublicAddressVisibility;
+};
 export type SiteFooterBlocksEditorBlock = {
     id: string;
     kind: string;

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

@@ -48,7 +48,7 @@ export type { SiteBannerAnnouncementRole, SiteBannerCta, SiteBannerScope, SiteBa
 export type { SitePageBlock, SitePagePayload } from "./sitePages";
 export type { SiteAnalyticsCookieBannerCopyOverrides, SiteAnalyticsSettingsPayload, SiteAnalyticsSettingsResponse, } from "./siteAnalytics";
 export type { SiteLegalJurisdiction, SiteLegalProfilePayload, SensitiveClientRecordsConfirmationKey, SensitiveClientRecordsMode, SensitiveClientRecordsRetentionProfile, SensitiveClientRecordsSettings, SensitiveClientRecordsUpdatePayload, SitePrivacyPolicyCapabilities, SitePrivacyPolicyDocument, SitePrivacySettings, SitePrivacySettingsPayload, SitePrivacySettingsResponse, SiteRuntimePrivacyPolicy, SitePrivacyPolicySection, } from "./privacyPolicy";
-export type { MaintenanceSettingsPayload, MaintenanceSettingsResponse, SiteBusinessAddressPayload, SiteBusinessAddressResponse, SiteDeploymentMode, SiteFooterBlocksEditorBlock, SiteFooterBlocksEditorResponse, SiteGeneralSettingsPayload, SiteGeneralSettingsResponse, SiteLayoutResolvedPayload, SiteLayoutSettingsPayload, SiteLayoutSettingsResponse, UpdateSiteDeploymentModePayload, UpdateSiteDeploymentModeResponse, UpdateSiteFooterBlocksPayload, UpdateSiteFooterBlocksResponse, } from "./siteSettings";
+export type { MaintenanceSettingsPayload, MaintenanceSettingsResponse, SiteBusinessAddressPayload, SiteBusinessAddressResponse, SiteDeploymentMode, SiteFooterBlocksEditorBlock, SiteFooterBlocksEditorResponse, SiteGeneralSettingsPayload, SiteGeneralSettingsResponse, SiteLayoutResolvedPayload, SiteLayoutSettingsPayload, SiteLayoutSettingsResponse, SiteRuntimeBusinessDetails, UpdateSiteDeploymentModePayload, UpdateSiteDeploymentModeResponse, UpdateSiteFooterBlocksPayload, UpdateSiteFooterBlocksResponse, } from "./siteSettings";
 export type { BillingCheckoutRequest, BillingCheckoutResponse, BillingStatusResponse, BillingSummaryComponent, BillingSummaryComponentKind, BillingSummaryComponentSource, BillingSummaryBasePlanComponent, BillingSummarySiteComponent, BillingSummaryAddOnComponent, BillingSummaryResponse, SiteBillingCheckoutResponse, SiteBillingCostResponse, StripeAutomaticTaxIssue, StripeAutomaticTaxReadiness, StripeAutomaticTaxStatus, StripeConnectDisconnectResponse, StripeConnectRestrictions, StripeConnectStartResponse, StripeConnectStatusResponse, UpdateStripeAutomaticTaxRequest, } from "./billing";
 export type { AiGenerateSiteEntityType, AiGenerateSitePrimaryCta, AiGenerateSiteRequest, AiGenerateSiteResponse, } from "./siteGeneration";
 export { SITE_ROLE_DISPLAY_ORDER, SITE_ROLE_PERMISSION_LEVEL } from "./siteMembers";
@@ -62,6 +62,7 @@ import type { AiAndLaunchReadinessAPIEndpointDefinitions, AiAPIEndpointName, AiA
 import type { BookingManagementAPIEndpoints } from "./bookingManagementEndpoints";
 import type { CommercePortalAPIEndpoints } from "./commercePortalEndpoints";
 import type { MailchimpIntegrationAPIEndpoints } from "./mailchimpIntegration";
+import type { MailingListIntegrationAPIEndpoints } from "./mailingListIntegration";
 import type { PublicExperienceAPIEndpoints } from "./publicExperienceEndpoints";
 import type { SeoEndpointDefinitions } from "./seoEndpoints";
 import type { SiteManagementAPIEndpoints } from "./siteManagementEndpoints";
@@ -69,7 +70,7 @@ import type { SitePlatformAPIEndpoints } from "./sitePlatformEndpoints";
 import type { SiteRuntimeAPIEndpoints } from "./siteRuntimeEndpoints";
 type TableName = keyof DbDatabase["public"]["Tables"];
 export type DTOType<K extends TableName> = Partial<CamelizeKeys<DbRow<K>>>;
-type APIEndpointsMonolith = AiAndLaunchReadinessAPIEndpointDefinitions & AccountAPIEndpoints & SeoEndpointDefinitions & SiteManagementAPIEndpoints & PublicExperienceAPIEndpoints & SiteRuntimeAPIEndpoints & SitePlatformAPIEndpoints & BookingManagementAPIEndpoints & CommercePortalAPIEndpoints & MailchimpIntegrationAPIEndpoints;
+type APIEndpointsMonolith = AiAndLaunchReadinessAPIEndpointDefinitions & AccountAPIEndpoints & SeoEndpointDefinitions & SiteManagementAPIEndpoints & PublicExperienceAPIEndpoints & SiteRuntimeAPIEndpoints & SitePlatformAPIEndpoints & BookingManagementAPIEndpoints & CommercePortalAPIEndpoints & MailchimpIntegrationAPIEndpoints & MailingListIntegrationAPIEndpoints;
 type ComposeEndpointMaps<Maps extends readonly object[], Acc extends object = {}> = Maps extends readonly [
     infer Head extends object,
     ...infer Tail extends readonly object[]
@@ -81,7 +82,7 @@ type AvailabilityAPIEndpointName = "listAvailabilityRules" | "setWeeklyAvailabil
 type CalendarAPIEndpointName = "getCalendarStatus" | "updateCalendarPreferences" | "disconnectCalendar";
 type ContentTypesAPIEndpointName = "listContentTypes" | "createContentType" | "updateContentType" | "deleteContentType" | "duplicateContentType";
 type MediaAPIEndpointName = "createMediaAsset" | "mediaList" | "mediaProductFileList" | "mediaGet" | "mediaUpdate" | "mediaCanonicalCrop" | "mediaDelete" | "mediaBulkDelete" | "mediaUsageCheck" | "mediaGetSignedUrl" | "createMediaUploadUrl" | "mediaUpload" | "getMediaLabels" | "getMediaSettings" | "updateMediaSettings" | "mediaSearch" | "classifyMediaAsset" | "classifyMediaBatch" | "enqueueMediaClassifyJob" | "runMediaClassifyJob" | "runAllMediaClassifyJobs" | "mediaJobsStatus";
-type ComposedDomainEndpointNames = "accountGetIdentity" | "accountListSites" | "accountCreateSite" | "accountProvisionProjectCredentials" | AiAPIEndpointName | LaunchReadinessAPIEndpointName | SiteMembersAPIEndpointName | SeoAPIEndpointName | RedirectsAPIEndpointName | AvailabilityAPIEndpointName | CalendarAPIEndpointName | ContentTypesAPIEndpointName | MediaAPIEndpointName | "listMailchimpAudiences" | "getMailchimpSignupSyncHealth";
+type ComposedDomainEndpointNames = "accountGetIdentity" | "accountListSites" | "accountCreateSite" | "accountProvisionProjectCredentials" | AiAPIEndpointName | LaunchReadinessAPIEndpointName | SiteMembersAPIEndpointName | SeoAPIEndpointName | RedirectsAPIEndpointName | AvailabilityAPIEndpointName | CalendarAPIEndpointName | ContentTypesAPIEndpointName | MediaAPIEndpointName | "listMailchimpAudiences";
 export type SiteMembersAPIEndpoints = Pick<APIEndpointsMonolith, SiteMembersAPIEndpointName>;
 export type SeoAPIEndpoints = Pick<APIEndpointsMonolith, SeoAPIEndpointName>;
 export type RedirectsAPIEndpoints = Pick<APIEndpointsMonolith, RedirectsAPIEndpointName>;
@@ -102,7 +103,7 @@ type DomainAPIEndpointMaps = [
     CalendarAPIEndpoints,
     ContentTypesAPIEndpoints,
     MediaAPIEndpoints,
-    Pick<APIEndpointsMonolith, "listMailchimpAudiences" | "getMailchimpSignupSyncHealth">
+    Pick<APIEndpointsMonolith, "listMailchimpAudiences">
 ];
 type ComposedAPIEndpointMaps = [...DomainAPIEndpointMaps, RemainingAPIEndpoints];
 export type APIEndpoints = ComposeEndpointMaps<ComposedAPIEndpointMaps>;