@riverbankcms/sdk 0.127.0 → 0.128.0

package/dist/_dts/content-editor/src/footerComposer.d.ts

@@ -4,6 +4,8 @@ export type FooterEditorTarget = Readonly<{
 }> | Readonly<{
     kind: 'module';
     moduleId: FooterModuleId;
+}> | Readonly<{
+    kind: 'engagement';
 }> | Readonly<{
     kind: 'shared-profile';
     section: 'contact' | 'opening-hours' | 'social-links';
@@ -48,6 +50,7 @@ type FooterEditorViewPlanInput = Readonly<{
     hasLogo?: boolean;
     hasMainNavigation?: boolean;
     hasLegalPolicyNavigation?: boolean;
+    hasEngagementSource?: boolean;
     canEdit: boolean;
     legalRegion?: 'integrated' | 'separate';
 }>;

package/dist/_dts/content-editor/src/footerEngagementDraft.d.ts

@@ -0,0 +1,57 @@
+import { type FooterEngagementSection, type Result } from '../../core/src/index';
+type FooterEngagementDraftBase = Readonly<{
+    treatment: FooterEngagementSection['treatment'];
+    heading: string;
+    intro: string;
+}>;
+type FooterMailingCopyDraft = Readonly<{
+    buttonLabel: string;
+    successMessage: string;
+    privacyNote: string;
+}>;
+export type FooterEngagementDraft = (FooterEngagementDraftBase & Readonly<{
+    kind: 'standard-contact';
+    formId: string;
+}>) | (FooterEngagementDraftBase & FooterMailingCopyDraft & Readonly<{
+    kind: 'mailing-list';
+    destination: Readonly<{
+        provider: 'riverbank';
+        listId: string;
+    }> | Readonly<{
+        provider: 'mailchimp';
+        audienceId: string;
+    }>;
+}>);
+export type FooterEngagementDraftEvent = Readonly<{
+    type: 'select-kind';
+    kind: FooterEngagementDraft['kind'];
+}> | Readonly<{
+    type: 'set-treatment';
+    treatment: FooterEngagementDraft['treatment'];
+}> | Readonly<{
+    type: 'set-heading';
+    heading: string;
+}> | Readonly<{
+    type: 'set-intro';
+    intro: string;
+}> | Readonly<{
+    type: 'set-form';
+    formId: string;
+}> | Readonly<{
+    type: 'select-mailing-provider';
+    provider: 'riverbank' | 'mailchimp';
+}> | Readonly<{
+    type: 'set-mailing-destination';
+    id: string;
+}> | Readonly<{
+    type: 'set-mailing-copy';
+    field: keyof FooterMailingCopyDraft;
+    value: string;
+}>;
+export declare function reduceFooterEngagementDraft(draft: FooterEngagementDraft, event: FooterEngagementDraftEvent): FooterEngagementDraft;
+export declare function createFooterEngagementDraft(section: FooterEngagementSection | null): FooterEngagementDraft;
+type DraftParseError = Readonly<{
+    message: string;
+}>;
+export declare function parseFooterEngagementDraft(draft: FooterEngagementDraft, currentId: string, mailchimpConnectionId: string): Result<FooterEngagementSection, DraftParseError>;
+export {};

package/dist/_dts/content-editor/src/footerEngagementEditor.d.ts

@@ -0,0 +1,11 @@
+import type { FooterEngagementSection } from '../../core/src/index';
+import type { FooterEngagementAuthoringOptions } from '../../api/src/footer-settings';
+import type { FooterResolvedEngagement } from '../../blocks/src/client/site-chrome';
+export type FooterEngagementReadiness = Readonly<{
+    kind: 'ready';
+}> | Readonly<{
+    kind: 'needs-repair';
+    message: string;
+}>;
+export declare function resolveFooterEngagementAuthoringState(section: FooterEngagementSection | null, options: FooterEngagementAuthoringOptions): FooterEngagementReadiness;
+export declare function resolveFooterEngagementPreview(section: FooterEngagementSection | null, options: FooterEngagementAuthoringOptions): FooterResolvedEngagement;

package/dist/_dts/content-editor/src/footerPreviewRuntime.d.ts

@@ -0,0 +1,13 @@
+import { type FooterResolvedEngagement, type FooterRuntimeViewModel } from '../../blocks/src/client/site-chrome';
+import type { FooterCompositionV1, PublicProfile } from '../../core/src/index';
+export type FooterPreviewRuntimeInput = Readonly<{
+    composition: FooterCompositionV1;
+    publicProfile: PublicProfile;
+    hasBusinessAddress: boolean;
+    hasLogo: boolean;
+    hasMainNavigation: boolean;
+    hasLegalPolicyNavigation: boolean;
+    legalRegion: 'integrated' | 'separate';
+    engagement: FooterResolvedEngagement;
+}>;
+export declare function buildFooterPreviewRuntime(input: FooterPreviewRuntimeInput): FooterRuntimeViewModel;

package/dist/_dts/content-editor/src/index.d.ts

@@ -25,6 +25,7 @@ export { PreviewRichTextEditor } from './primitives/PreviewRichTextEditor';
 export { recordsEqual as editorValuesEqual } from './ui/stores/utils';
 export { footerModuleLabel, planFooterEditorView, type FooterEditorSectionPlan, type FooterEditorSource, type FooterEditorTarget, type FooterEditorViewPlan, } from './footerComposer';
 export { FooterComposerPanel } from './FooterComposerPanel';
+export { resolveFooterEngagementAuthoringState, type FooterEngagementReadiness, } from './footerEngagementEditor';
 export { useStoreBinding, parseEditorPath } from './primitives/shared';
 export type { PathInfo } from './primitives/shared';
 export * from './ai/overlayHelpers';

package/dist/_dts/content-editor/src/useFooterComposerState.d.ts

@@ -0,0 +1,35 @@
+import { type FooterCompositionSnapshot, type PublicProfileSnapshot } from '../../api/src/footer-settings';
+import type { ApiClient } from '../../api/src/request';
+import { type FooterCompositionV1, type PublicProfile } from '../../core/src/index';
+import type { FooterEditorTarget } from './footerComposer';
+export type SaveState = 'idle' | 'saving' | 'saved' | 'conflict' | 'failed';
+export type CompositionSaveOutcome = 'saved' | 'conflict' | 'failed';
+type FooterComposerStateOptions = Readonly<{
+    apiClient: ApiClient;
+    canEdit: boolean;
+    initialTarget?: FooterEditorTarget;
+    onSaved?: () => void;
+    rawSiteId: string;
+}>;
+export declare function useFooterComposerState({ apiClient, canEdit, initialTarget, onSaved, rawSiteId, }: FooterComposerStateOptions): {
+    message: string | null;
+    saveComposition: (next: FooterCompositionV1, optimistic?: boolean) => Promise<CompositionSaveOutcome>;
+    saveProfile: (next: PublicProfile) => Promise<void>;
+    saveState: SaveState;
+    siteId: import("../../core/src/index").SiteId;
+    target: FooterEditorTarget;
+    setTarget: import("react").Dispatch<import("react").SetStateAction<FooterEditorTarget>>;
+    compositionSnapshot: FooterCompositionSnapshot | null;
+    engagementOptions: Readonly<{
+        forms: readonly import("../../api/src/footerSettings").FooterFormSummary[];
+        newsletterLists: readonly import("../../api/src/index").NewsletterListRecord[];
+        mailchimp: import("../../api/src/index").ListMailchimpAudiencesResponse;
+    }> | null;
+    load: () => Promise<void>;
+    loadError: string | null;
+    navigationMenus: import("../../api/src/index").NavigationMenuWithItems[] | null;
+    profileSnapshot: PublicProfileSnapshot | null;
+    setCompositionSnapshot: import("react").Dispatch<import("react").SetStateAction<FooterCompositionSnapshot | null>>;
+    setProfileSnapshot: import("react").Dispatch<import("react").SetStateAction<PublicProfileSnapshot | null>>;
+};
+export {};

package/dist/_dts/core/src/footer-arrangement.d.ts

@@ -0,0 +1,2 @@
+import type { FooterArrangementPlan, FooterLookPolicy, RenderableFooterSection } from './footer-composition-types';
+export declare function planFooterArrangement(renderableSections: readonly RenderableFooterSection[], policy: FooterLookPolicy): FooterArrangementPlan;

package/dist/_dts/core/src/footer-composition-types.d.ts

@@ -0,0 +1,118 @@
+import type { Brand } from './branded';
+import type { FooterEngagementSection, FooterEngagementSource } from './footer-engagement';
+import type { RichTextDoc } from './rich-text';
+export type FooterModuleId = Brand<string, 'FooterModuleId'>;
+export type FooterMembershipKey = Brand<string, 'FooterMembershipKey'>;
+export type FooterRichText = RichTextDoc;
+export type FooterNavigationRole = 'main' | 'legal-policy';
+type FooterSectionBase<TKind extends string> = Readonly<{
+    id: FooterModuleId;
+    kind: TKind;
+    heading: string | null;
+    selected: boolean;
+}>;
+export type FooterSection = (FooterSectionBase<'brand'> & Readonly<{
+    showLogo: boolean;
+    showTitle: boolean;
+}>) | (FooterSectionBase<'navigation'> & Readonly<{
+    source: Readonly<{
+        kind: 'menu-role';
+        role: 'main';
+    }>;
+}>) | (FooterSectionBase<'legal-navigation'> & Readonly<{
+    source: Readonly<{
+        kind: 'menu-role';
+        role: 'legal-policy';
+    }>;
+}>) | (FooterSectionBase<'business-address'> & Readonly<{
+    source: Readonly<{
+        kind: 'business-address';
+    }>;
+}>) | (FooterSectionBase<'contact'> & Readonly<{
+    source: Readonly<{
+        kind: 'public-profile';
+    }>;
+}>) | (FooterSectionBase<'opening-hours'> & Readonly<{
+    source: Readonly<{
+        kind: 'public-profile';
+    }>;
+}>) | (FooterSectionBase<'social-links'> & Readonly<{
+    source: Readonly<{
+        kind: 'public-profile';
+    }>;
+}>) | (FooterSectionBase<'supporting-text'> & Readonly<{
+    content: FooterRichText | null;
+}>) | (FooterSectionBase<'legal'> & Readonly<{
+    content: FooterRichText | null;
+}>) | FooterEngagementSection;
+export type FooterSectionKind = FooterSection['kind'];
+export type FooterCompositionV1 = Readonly<{
+    schemaVersion: 1;
+    sections: readonly FooterSection[];
+}>;
+export type FooterCompositionError = Readonly<{
+    code: 'invalid_shape' | 'unsupported_schema_version' | 'invalid_section' | 'duplicate_section_id' | 'duplicate_section_kind' | 'unknown_section';
+    path: string;
+    message: string;
+}>;
+export type FooterLookPolicy = Readonly<{
+    kind: 'integrated-legal';
+}> | Readonly<{
+    kind: 'separate-legal-region';
+}>;
+export type FooterVisualGroupKind = 'identity' | 'main-navigation' | 'visit' | 'engagement' | 'legal-ending';
+export type FooterColumnCount = 1 | 2 | 3 | 4 | 5;
+export type FooterVisualGroup = Readonly<{
+    kind: FooterVisualGroupKind;
+    sections: readonly FooterSection[];
+    span: 1;
+}>;
+export type FooterRenderRegion = Readonly<{
+    kind: 'engagement-row' | 'main' | 'bottom';
+    columns: FooterColumnCount;
+    groups: readonly FooterVisualGroup[];
+}>;
+export type FooterArrangementPlan = Readonly<{
+    membershipKey: FooterMembershipKey;
+    regions: readonly FooterRenderRegion[];
+    mobileGroups: readonly FooterVisualGroup[];
+}>;
+export type FooterRepairTarget = Readonly<{
+    kind: 'site-identity';
+}> | Readonly<{
+    kind: 'navigation';
+    role: FooterNavigationRole;
+}> | Readonly<{
+    kind: 'business-address';
+}> | Readonly<{
+    kind: 'engagement-source';
+    source: FooterEngagementSource['kind'];
+}> | Readonly<{
+    kind: 'public-profile';
+    section: 'contact' | 'opening-hours' | 'social-links';
+}> | Readonly<{
+    kind: 'footer-section';
+    sectionId: FooterModuleId;
+}>;
+export type ResolvedFooterSection = Readonly<{
+    kind: 'renderable';
+    section: FooterSection;
+}> | Readonly<{
+    kind: 'missing-source';
+    section: FooterSection;
+    repairTarget: FooterRepairTarget;
+}>;
+export type RenderableFooterSection = Extract<ResolvedFooterSection, {
+    kind: 'renderable';
+}>;
+export type FooterSourceAvailability = Readonly<{
+    hasLogo: boolean;
+    hasMainNavigation: boolean;
+    hasLegalPolicyNavigation: boolean;
+    hasBusinessAddress: boolean;
+    hasContact: boolean;
+    hasOpeningHours: boolean;
+    hasSocialLinks: boolean;
+    hasEngagementSource: boolean;
+}>;
+export {};

package/dist/_dts/core/src/footer-composition.d.ts

@@ -1,118 +1,8 @@
-import type { Brand } from './branded';
-import { type RichTextDoc } from './rich-text';
+import type { FooterCompositionError, FooterCompositionV1, FooterModuleId, FooterSection, FooterSourceAvailability, ResolvedFooterSection } from './footer-composition-types';
+import { type FooterEngagementSection } from './footer-engagement';
 import { type Result } from './result';
-export type FooterModuleId = Brand<string, 'FooterModuleId'>;
-export type FooterMembershipKey = Brand<string, 'FooterMembershipKey'>;
-export type FooterRichText = RichTextDoc;
-export type FooterNavigationRole = 'main' | 'legal-policy';
-type FooterSectionBase<TKind extends string> = Readonly<{
-    id: FooterModuleId;
-    kind: TKind;
-    heading: string | null;
-    selected: boolean;
-}>;
-export type FooterSection = (FooterSectionBase<'brand'> & Readonly<{
-    showLogo: boolean;
-    showTitle: boolean;
-}>) | (FooterSectionBase<'navigation'> & Readonly<{
-    source: Readonly<{
-        kind: 'menu-role';
-        role: 'main';
-    }>;
-}>) | (FooterSectionBase<'legal-navigation'> & Readonly<{
-    source: Readonly<{
-        kind: 'menu-role';
-        role: 'legal-policy';
-    }>;
-}>) | (FooterSectionBase<'business-address'> & Readonly<{
-    source: Readonly<{
-        kind: 'business-address';
-    }>;
-}>) | (FooterSectionBase<'contact'> & Readonly<{
-    source: Readonly<{
-        kind: 'public-profile';
-    }>;
-}>) | (FooterSectionBase<'opening-hours'> & Readonly<{
-    source: Readonly<{
-        kind: 'public-profile';
-    }>;
-}>) | (FooterSectionBase<'social-links'> & Readonly<{
-    source: Readonly<{
-        kind: 'public-profile';
-    }>;
-}>) | (FooterSectionBase<'supporting-text'> & Readonly<{
-    content: FooterRichText | null;
-}>) | (FooterSectionBase<'legal'> & Readonly<{
-    content: FooterRichText | null;
-}>);
-/** Retained as a source-compatible name while callers move from modules to sections. */
-export type FooterModule = FooterSection;
-export type FooterModuleKind = FooterSection['kind'];
-export type FooterCompositionV1 = Readonly<{
-    schemaVersion: 1;
-    sections: readonly FooterSection[];
-}>;
-export type FooterCompositionError = Readonly<{
-    code: 'invalid_shape' | 'unsupported_schema_version' | 'invalid_section' | 'duplicate_section_id' | 'duplicate_section_kind' | 'unknown_section';
-    path: string;
-    message: string;
-}>;
-export type FooterLookPolicy = Readonly<{
-    kind: 'integrated-legal';
-}> | Readonly<{
-    kind: 'separate-legal-region';
-}>;
-export type FooterVisualGroupKind = 'identity' | 'main-navigation' | 'visit' | 'legal-ending';
-export type FooterColumnCount = 1 | 2 | 3 | 4;
-export type FooterVisualGroup = Readonly<{
-    kind: FooterVisualGroupKind;
-    sections: readonly FooterSection[];
-    span: 1;
-}>;
-export type FooterRenderRegion = Readonly<{
-    kind: 'main' | 'bottom';
-    columns: FooterColumnCount;
-    groups: readonly FooterVisualGroup[];
-}>;
-export type FooterArrangementPlan = Readonly<{
-    membershipKey: FooterMembershipKey;
-    regions: readonly FooterRenderRegion[];
-    mobileGroups: readonly FooterVisualGroup[];
-}>;
-export type FooterRepairTarget = Readonly<{
-    kind: 'site-identity';
-}> | Readonly<{
-    kind: 'navigation';
-    role: FooterNavigationRole;
-}> | Readonly<{
-    kind: 'business-address';
-}> | Readonly<{
-    kind: 'public-profile';
-    section: 'contact' | 'opening-hours' | 'social-links';
-}> | Readonly<{
-    kind: 'footer-section';
-    sectionId: FooterModuleId;
-}>;
-export type ResolvedFooterSection = Readonly<{
-    kind: 'renderable';
-    section: FooterSection;
-}> | Readonly<{
-    kind: 'missing-source';
-    section: FooterSection;
-    repairTarget: FooterRepairTarget;
-}>;
-export type RenderableFooterSection = Extract<ResolvedFooterSection, {
-    kind: 'renderable';
-}>;
-export type FooterSourceAvailability = Readonly<{
-    hasLogo: boolean;
-    hasMainNavigation: boolean;
-    hasLegalPolicyNavigation: boolean;
-    hasBusinessAddress: boolean;
-    hasContact: boolean;
-    hasOpeningHours: boolean;
-    hasSocialLinks: boolean;
-}>;
+export { planFooterArrangement } from './footer-arrangement';
+export type * from './footer-composition-types';
 export declare function unsafeAsFooterModuleId(value: string): FooterModuleId;
 export declare function parseFooterModuleId(value: unknown): Result<FooterModuleId, FooterCompositionError>;
 export declare function validateFooterComposition(composition: FooterCompositionV1): Result<FooterCompositionV1, FooterCompositionError>;
@@ -123,8 +13,10 @@ export declare function parseFooterCompositionV1(value: unknown): Result<FooterC
  */
 export declare function upgradePlacementFooterCompositionV1(value: unknown): Result<FooterCompositionV1, FooterCompositionError>;
 export declare function setFooterSectionSelected(composition: FooterCompositionV1, sectionId: FooterModuleId, selected: boolean): Result<FooterCompositionV1, FooterCompositionError>;
+export declare function parseFooterEngagementSection(value: unknown): Result<FooterEngagementSection, FooterCompositionError>;
+export declare function upsertFooterEngagementSection(composition: FooterCompositionV1, section: FooterEngagementSection): Result<FooterCompositionV1, FooterCompositionError>;
+export declare function removeFooterEngagementSection(composition: FooterCompositionV1): FooterCompositionV1;
 export declare function resolveFooterSections(composition: FooterCompositionV1, availability: FooterSourceAvailability): readonly ResolvedFooterSection[];
-export declare function planFooterArrangement(renderableSections: readonly RenderableFooterSection[], policy: FooterLookPolicy): FooterArrangementPlan;
 export type FooterEditorOverviewItem = Readonly<{
     section: FooterSection;
     status: 'selected' | 'available';
@@ -141,4 +33,3 @@ type LegacyFooterNormalizationOptions = Readonly<{
     footerVisible?: boolean;
 }>;
 export declare function normalizeLegacyFooterContentToV1(value: unknown, options?: LegacyFooterNormalizationOptions): Result<FooterCompositionV1, FooterCompositionError>;
-export {};

package/dist/_dts/core/src/footer-engagement.d.ts

@@ -0,0 +1,30 @@
+import { type FormId } from './branded';
+import { type NewsletterSignupAuthoringDestination } from './newsletter-signup-destination';
+import { type Result } from './result';
+import type { FooterCompositionError, FooterModuleId } from './footer-composition-types';
+export type FooterEngagementTreatment = 'integrated' | 'separate-row';
+export type FooterEngagementSource = Readonly<{
+    kind: 'standard-contact';
+    formId: FormId;
+    intro: string | null;
+}> | Readonly<{
+    kind: 'mailing-list';
+    destination: NewsletterSignupAuthoringDestination;
+    intro: string | null;
+    buttonLabel: string;
+    successMessage: string;
+    privacyNote: string | null;
+    fieldPreset: 'emailOnly';
+}>;
+export type FooterEngagementSection = Readonly<{
+    id: FooterModuleId;
+    kind: 'engagement';
+    heading: string;
+    selected: boolean;
+    treatment: FooterEngagementTreatment;
+    source: FooterEngagementSource;
+}>;
+export declare function parseFooterEngagementSectionValue(value: Readonly<Record<string, unknown>>, sectionBase: Readonly<{
+    id: FooterModuleId;
+    selected: boolean;
+}>, path: string): Result<FooterEngagementSection, FooterCompositionError>;

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

@@ -32,6 +32,10 @@ export * from './public-url-validation';
 export * from './public-profile';
 export * from './rich-text';
 export * from './footer-composition';
+export * from './footer-arrangement';
+export * from './footer-composition-types';
+export * from './footer-engagement';
+export * from './newsletter-signup-destination';
 export * from './number-input';
 export * from './field-errors';
 export * from './form-submission-preview';

package/dist/_dts/core/src/newsletter-signup-destination.d.ts

@@ -0,0 +1,38 @@
+import type { Brand } from './branded';
+import { type Result } from './result';
+export type NewsletterListId = Brand<string, 'NewsletterListId'>;
+export type MailchimpConnectionId = Brand<string, 'MailchimpConnectionId'>;
+export type MailchimpAudienceId = Brand<string, 'MailchimpAudienceId'>;
+export type MailchimpTagName = Brand<string, 'MailchimpTagName'>;
+export type NewsletterSignupDestinationProvider = 'riverbank' | 'mailchimp';
+export type RiverbankNewsletterDestination = Readonly<{
+    tag: 'riverbank_list';
+    listId: NewsletterListId;
+}>;
+export type MailchimpNewsletterDestination = Readonly<{
+    tag: 'mailchimp_audience';
+    connectionId: MailchimpConnectionId;
+    audienceId: MailchimpAudienceId;
+    tags: readonly MailchimpTagName[];
+}>;
+export type NewsletterSignupAuthoringDestination = RiverbankNewsletterDestination | MailchimpNewsletterDestination;
+export type NewsletterSignupDestinationValueError = Readonly<{
+    kind: 'invalid-destination-shape';
+}> | Readonly<{
+    kind: 'invalid-destination-tag';
+    value: unknown;
+}> | Readonly<{
+    kind: 'invalid-newsletter-list-id';
+}> | Readonly<{
+    kind: 'invalid-mailchimp-connection-id';
+}> | Readonly<{
+    kind: 'invalid-mailchimp-audience-id';
+}> | Readonly<{
+    kind: 'invalid-mailchimp-tags';
+}>;
+export declare function parseNewsletterListId(value: unknown): NewsletterListId | null;
+export declare function parseMailchimpConnectionId(value: unknown): MailchimpConnectionId | null;
+export declare function parseMailchimpAudienceId(value: unknown): MailchimpAudienceId | null;
+export declare function parseMailchimpTagName(value: unknown): MailchimpTagName | null;
+export declare function parseNewsletterSignupDestinationProvider(value: unknown): NewsletterSignupDestinationProvider | null;
+export declare function parseNewsletterSignupAuthoringDestinationValue(value: unknown): Result<NewsletterSignupAuthoringDestination, NewsletterSignupDestinationValueError>;