@riverbankcms/sdk 0.107.0 → 0.108.0

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

@@ -0,0 +1,143 @@
+import type { Brand } from './branded';
+import { type Result } from './result';
+export type FooterModuleId = Brand<string, 'FooterModuleId'>;
+export type FooterMembershipKey = Brand<string, 'FooterMembershipKey'>;
+export type FooterRichText = Readonly<Record<string, unknown>>;
+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 declare function unsafeAsFooterModuleId(value: string): FooterModuleId;
+export declare function parseFooterModuleId(value: unknown): Result<FooterModuleId, FooterCompositionError>;
+export declare function validateFooterComposition(composition: FooterCompositionV1): Result<FooterCompositionV1, FooterCompositionError>;
+export declare function parseFooterCompositionV1(value: unknown): Result<FooterCompositionV1, FooterCompositionError>;
+/**
+ * Bounded pre-production upgrader for the placement-shaped V1 that never reached production.
+ * It is intentionally not called by the runtime parser.
+ */
+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 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';
+}>;
+export declare function deriveFooterEditorOverview(composition: FooterCompositionV1): Readonly<{
+    selected: readonly FooterEditorOverviewItem[];
+    available: readonly FooterEditorOverviewItem[];
+}>;
+type LegacyFooterNormalizationOptions = Readonly<{
+    brand?: Readonly<{
+        showLogo: boolean;
+        showTitle: boolean;
+    }>;
+    footerVisible?: boolean;
+}>;
+export declare function normalizeLegacyFooterContentToV1(value: unknown, options?: LegacyFooterNormalizationOptions): Result<FooterCompositionV1, FooterCompositionError>;
+export {};

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

@@ -29,6 +29,8 @@ export * from './assertNever';
 export * from './participants';
 export * from './participant-identity';
 export * from './public-url-validation';
+export * from './public-profile';
+export * from './footer-composition';
 export * from './number-input';
 export * from './field-errors';
 export * from './form-submission-preview';

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

@@ -0,0 +1,73 @@
+import type { Brand } from './branded';
+import { type Result } from './result';
+export type PublicProfileTimeZone = Brand<string, 'PublicProfileTimeZone'>;
+export type OpeningHoursTime = Brand<string, 'OpeningHoursTime'>;
+export type PublicSocialLinkId = Brand<string, 'PublicSocialLinkId'>;
+export declare const publicProfileWeekdays: readonly ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"];
+export type PublicProfileWeekday = (typeof publicProfileWeekdays)[number];
+export declare const knownSocialPlatforms: readonly ["facebook", "instagram", "linkedin", "tiktok", "x", "youtube"];
+export type KnownSocialPlatform = (typeof knownSocialPlatforms)[number];
+export type PublicContactDetails = Readonly<{
+    kind: 'phone';
+    phone: string;
+    email: null;
+}> | Readonly<{
+    kind: 'email';
+    phone: null;
+    email: string;
+}> | Readonly<{
+    kind: 'phone-and-email';
+    phone: string;
+    email: string;
+}>;
+export type OpeningHoursInterval = Readonly<{
+    opensAt: OpeningHoursTime;
+    closesAt: OpeningHoursTime;
+}>;
+export type OpeningHoursDay = Readonly<{
+    kind: 'closed';
+    weekday: PublicProfileWeekday;
+}> | Readonly<{
+    kind: 'open';
+    weekday: PublicProfileWeekday;
+    intervals: readonly [OpeningHoursInterval, ...OpeningHoursInterval[]];
+}>;
+export type WeeklyOpeningHours = Readonly<{
+    timeZone: PublicProfileTimeZone;
+    days: readonly [
+        OpeningHoursDay,
+        OpeningHoursDay,
+        OpeningHoursDay,
+        OpeningHoursDay,
+        OpeningHoursDay,
+        OpeningHoursDay,
+        OpeningHoursDay
+    ];
+}>;
+export type PublicSocialLink = Readonly<{
+    id: PublicSocialLinkId;
+    kind: 'known';
+    platform: KnownSocialPlatform;
+    url: string;
+}> | Readonly<{
+    id: PublicSocialLinkId;
+    kind: 'custom';
+    label: string;
+    url: string;
+}>;
+export type PublicProfile = Readonly<{
+    contact: PublicContactDetails | null;
+    openingHours: WeeklyOpeningHours | null;
+    socialLinks: readonly PublicSocialLink[];
+}>;
+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' | 'duplicate_social_link_id';
+    path: string;
+    message: string;
+}>;
+export declare function parsePublicContactDetails(value: unknown): Result<PublicContactDetails, PublicProfileParseError>;
+export declare function parsePublicProfileTimeZone(value: unknown): Result<PublicProfileTimeZone, PublicProfileParseError>;
+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>;
+export declare function emptyPublicProfile(): PublicProfile;