@riverbankcms/sdk 0.129.0 → 0.129.1

package/dist/_dts/theme-core/src/site-styles/headerLegacyLooks.d.ts

@@ -0,0 +1,372 @@
+import type { Theme } from '../schema';
+import type { HeaderLookDefinition, HeaderLookId } from './headerLookTypes';
+declare function solidBrandHeader(theme: Theme): Theme['header'];
+declare function cleanBaseHeader(theme: Theme): Theme['header'];
+declare function classicCenteredNavHeader(theme: Theme): Theme['header'];
+declare function serifLineHeader(theme: Theme): Theme['header'];
+declare function centeredCalmHeader(theme: Theme): Theme['header'];
+declare function practicalUtilityHeader(theme: Theme): Theme['header'];
+declare function minimalTransparentHeader(theme: Theme): Theme['header'];
+declare function transparentOverlayHeader(theme: Theme): Theme['header'];
+declare function floatingGlassHeader(theme: Theme): Theme['header'];
+export declare const headerLookCatalog: readonly [{
+    readonly id: HeaderLookId;
+    readonly label: "Clean base";
+    readonly openingRequirement: "none";
+    readonly logoAccommodations: readonly [{
+        readonly pattern: "title-only";
+        readonly supportedShapes: readonly ["none", "horizontal", "square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["title-only"];
+        readonly size: "compact";
+    }, {
+        readonly pattern: "inline-wordmark";
+        readonly supportedShapes: readonly ["horizontal"];
+        readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "standard";
+        readonly maxDensity: "detailed";
+    }, {
+        readonly pattern: "inline-mark-with-title";
+        readonly supportedShapes: readonly ["horizontal", "square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["no-text"];
+        readonly supportedDisplayModes: readonly ["logo-plus-title"];
+        readonly size: "compact";
+        readonly maxDensity: "simple";
+    }, {
+        readonly pattern: "popout-badge";
+        readonly supportedShapes: readonly ["square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "display";
+        readonly providesBacking: true;
+    }, {
+        readonly pattern: "logo-plate";
+        readonly supportedShapes: readonly ["square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "display";
+        readonly providesBacking: true;
+    }];
+    readonly compile: typeof cleanBaseHeader;
+}, {
+    readonly id: HeaderLookId;
+    readonly label: "Centered nav";
+    readonly openingRequirement: "none";
+    readonly maxRecommendedNavItems: 6;
+    readonly logoAccommodations: readonly [{
+        readonly pattern: "title-only";
+        readonly supportedShapes: readonly ["none", "horizontal", "square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["title-only"];
+        readonly size: "compact";
+    }, {
+        readonly pattern: "inline-wordmark";
+        readonly supportedShapes: readonly ["horizontal"];
+        readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "standard";
+        readonly maxDensity: "detailed";
+    }, {
+        readonly pattern: "inline-mark-with-title";
+        readonly supportedShapes: readonly ["horizontal", "square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["no-text"];
+        readonly supportedDisplayModes: readonly ["logo-plus-title"];
+        readonly size: "compact";
+        readonly maxDensity: "simple";
+    }, {
+        readonly pattern: "popout-badge";
+        readonly supportedShapes: readonly ["square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "display";
+        readonly providesBacking: true;
+    }, {
+        readonly pattern: "logo-plate";
+        readonly supportedShapes: readonly ["square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "display";
+        readonly providesBacking: true;
+    }];
+    readonly compile: typeof classicCenteredNavHeader;
+}, {
+    readonly id: HeaderLookId;
+    readonly label: "Brand solid";
+    readonly openingRequirement: "none";
+    readonly logoAccommodations: readonly [{
+        readonly pattern: "title-only";
+        readonly supportedShapes: readonly ["none", "horizontal", "square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["title-only"];
+        readonly size: "compact";
+    }, {
+        readonly pattern: "inline-wordmark";
+        readonly supportedShapes: readonly ["horizontal"];
+        readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "standard";
+        readonly maxDensity: "detailed";
+    }, {
+        readonly pattern: "inline-mark-with-title";
+        readonly supportedShapes: readonly ["horizontal", "square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["no-text"];
+        readonly supportedDisplayModes: readonly ["logo-plus-title"];
+        readonly size: "compact";
+        readonly maxDensity: "simple";
+    }, {
+        readonly pattern: "popout-badge";
+        readonly supportedShapes: readonly ["square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "display";
+        readonly providesBacking: true;
+    }, {
+        readonly pattern: "logo-plate";
+        readonly supportedShapes: readonly ["square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "display";
+        readonly providesBacking: true;
+    }];
+    readonly compile: typeof solidBrandHeader;
+}, {
+    readonly id: HeaderLookId;
+    readonly label: "Serif line";
+    readonly openingRequirement: "none";
+    readonly maxRecommendedNavItems: 6;
+    readonly logoAccommodations: readonly [{
+        readonly pattern: "title-only";
+        readonly supportedShapes: readonly ["none", "horizontal", "square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["title-only"];
+        readonly size: "compact";
+    }, {
+        readonly pattern: "inline-wordmark";
+        readonly supportedShapes: readonly ["horizontal"];
+        readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "standard";
+        readonly maxDensity: "detailed";
+    }, {
+        readonly pattern: "inline-mark-with-title";
+        readonly supportedShapes: readonly ["horizontal", "square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["no-text"];
+        readonly supportedDisplayModes: readonly ["logo-plus-title"];
+        readonly size: "compact";
+        readonly maxDensity: "simple";
+    }, {
+        readonly pattern: "centered-masthead";
+        readonly supportedShapes: readonly ["square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "display";
+        readonly providesBacking: true;
+    }, {
+        readonly pattern: "centered-badge";
+        readonly supportedShapes: readonly ["square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "display";
+        readonly providesBacking: true;
+    }];
+    readonly compile: typeof serifLineHeader;
+}, {
+    readonly id: HeaderLookId;
+    readonly label: "Centered calm";
+    readonly openingRequirement: "none";
+    readonly maxRecommendedNavItems: 5;
+    readonly logoAccommodations: readonly [{
+        readonly pattern: "title-only";
+        readonly supportedShapes: readonly ["none", "horizontal", "square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["title-only"];
+        readonly size: "compact";
+    }, {
+        readonly pattern: "inline-wordmark";
+        readonly supportedShapes: readonly ["horizontal"];
+        readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "standard";
+        readonly maxDensity: "detailed";
+    }, {
+        readonly pattern: "inline-mark-with-title";
+        readonly supportedShapes: readonly ["horizontal", "square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["no-text"];
+        readonly supportedDisplayModes: readonly ["logo-plus-title"];
+        readonly size: "compact";
+        readonly maxDensity: "simple";
+    }, {
+        readonly pattern: "centered-masthead";
+        readonly supportedShapes: readonly ["square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "display";
+        readonly providesBacking: true;
+    }, {
+        readonly pattern: "centered-badge";
+        readonly supportedShapes: readonly ["square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "display";
+        readonly providesBacking: true;
+    }];
+    readonly compile: typeof centeredCalmHeader;
+}, {
+    readonly id: HeaderLookId;
+    readonly label: "Practical utility";
+    readonly openingRequirement: "none";
+    readonly requiresProminentCta: true;
+    readonly logoAccommodations: readonly [{
+        readonly pattern: "title-only";
+        readonly supportedShapes: readonly ["none", "horizontal", "square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["title-only"];
+        readonly size: "compact";
+    }, {
+        readonly pattern: "inline-wordmark";
+        readonly supportedShapes: readonly ["horizontal"];
+        readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "standard";
+        readonly maxDensity: "detailed";
+    }, {
+        readonly pattern: "inline-mark-with-title";
+        readonly supportedShapes: readonly ["horizontal", "square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["no-text"];
+        readonly supportedDisplayModes: readonly ["logo-plus-title"];
+        readonly size: "compact";
+        readonly maxDensity: "simple";
+    }, {
+        readonly pattern: "popout-badge";
+        readonly supportedShapes: readonly ["square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "display";
+        readonly providesBacking: true;
+    }, {
+        readonly pattern: "logo-plate";
+        readonly supportedShapes: readonly ["square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "display";
+        readonly providesBacking: true;
+    }];
+    readonly compile: typeof practicalUtilityHeader;
+}, {
+    readonly id: HeaderLookId;
+    readonly label: "Minimal transparent";
+    readonly openingRequirement: "reserved-space-ok";
+    readonly logoAccommodations: readonly [{
+        readonly pattern: "title-only";
+        readonly supportedShapes: readonly ["none", "horizontal", "square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["title-only"];
+        readonly size: "compact";
+    }, {
+        readonly pattern: "inline-wordmark";
+        readonly supportedShapes: readonly ["horizontal"];
+        readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "standard";
+        readonly maxDensity: "detailed";
+    }, {
+        readonly pattern: "inline-mark-with-title";
+        readonly supportedShapes: readonly ["horizontal", "square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["no-text"];
+        readonly supportedDisplayModes: readonly ["logo-plus-title"];
+        readonly size: "compact";
+        readonly maxDensity: "simple";
+    }, {
+        readonly pattern: "popout-badge";
+        readonly supportedShapes: readonly ["square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "display";
+        readonly providesBacking: true;
+    }, {
+        readonly pattern: "logo-plate";
+        readonly supportedShapes: readonly ["square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "display";
+        readonly providesBacking: true;
+    }];
+    readonly compile: typeof minimalTransparentHeader;
+}, {
+    readonly id: HeaderLookId;
+    readonly label: "Transparent overlay";
+    readonly openingRequirement: "requires-image-hero-with-contrast-overlay";
+    readonly maxRecommendedNavItems: 5;
+    readonly logoAccommodations: readonly [{
+        readonly pattern: "title-only";
+        readonly supportedShapes: readonly ["none", "horizontal", "square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["title-only"];
+        readonly size: "compact";
+    }, {
+        readonly pattern: "inline-wordmark";
+        readonly supportedShapes: readonly ["horizontal"];
+        readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "standard";
+        readonly maxDensity: "detailed";
+    }, {
+        readonly pattern: "inline-mark-with-title";
+        readonly supportedShapes: readonly ["horizontal", "square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["no-text"];
+        readonly supportedDisplayModes: readonly ["logo-plus-title"];
+        readonly size: "compact";
+        readonly maxDensity: "simple";
+    }, {
+        readonly pattern: "inline-logo-only";
+        readonly supportedShapes: readonly ["square"];
+        readonly supportedTextPresence: readonly ["contains-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "compact";
+        readonly providesBacking: false;
+    }];
+    readonly compile: typeof transparentOverlayHeader;
+}, {
+    readonly id: HeaderLookId;
+    readonly label: "Floating glass";
+    readonly openingRequirement: "requires-image-hero-with-contrast-overlay";
+    readonly maxRecommendedNavItems: 5;
+    readonly logoAccommodations: readonly [{
+        readonly pattern: "title-only";
+        readonly supportedShapes: readonly ["none", "horizontal", "square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["title-only"];
+        readonly size: "compact";
+    }, {
+        readonly pattern: "inline-wordmark";
+        readonly supportedShapes: readonly ["horizontal"];
+        readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "standard";
+        readonly maxDensity: "detailed";
+    }, {
+        readonly pattern: "inline-mark-with-title";
+        readonly supportedShapes: readonly ["horizontal", "square", "portrait", "tall"];
+        readonly supportedTextPresence: readonly ["no-text"];
+        readonly supportedDisplayModes: readonly ["logo-plus-title"];
+        readonly size: "compact";
+        readonly maxDensity: "simple";
+    }, {
+        readonly pattern: "inline-logo-only";
+        readonly supportedShapes: readonly ["square"];
+        readonly supportedTextPresence: readonly ["contains-text", "unknown"];
+        readonly supportedDisplayModes: readonly ["logo-only"];
+        readonly size: "compact";
+        readonly providesBacking: false;
+    }];
+    readonly compile: typeof floatingGlassHeader;
+}];
+export declare const guaranteedFallbackHeaderLookId: HeaderLookId;
+export declare const guaranteedFallbackHeaderLayoutId: import("../../../blocks/src/index").HeaderLayoutId;
+export declare const guaranteedFallbackHeaderStyleId: import("../../../blocks/src/index").HeaderStyleId;
+export declare function getHeaderLook(id: HeaderLookId): HeaderLookDefinition | null;
+export declare function findHeaderLook(id: HeaderLookId): HeaderLookDefinition | undefined;
+export declare function getHeaderLookOrThrow(id: HeaderLookId): HeaderLookDefinition;
+export declare function headerLookRequiresImageHeroOpening(look: HeaderLookDefinition): boolean;
+export {};

package/dist/_dts/theme-core/src/site-styles/headerLookBranding.d.ts

@@ -0,0 +1,106 @@
+import { type HeaderBrandPresentationPlan, type HeaderBrandPresentationSelection, type LogoAccommodationOption } from './logoBranding';
+import type { HeaderLogoContext } from './headerLookTypes';
+export declare const inlineClassicLogoAccommodations: readonly [{
+    readonly pattern: "title-only";
+    readonly supportedShapes: readonly ["none", "horizontal", "square", "portrait", "tall"];
+    readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+    readonly supportedDisplayModes: readonly ["title-only"];
+    readonly size: "compact";
+}, {
+    readonly pattern: "inline-wordmark";
+    readonly supportedShapes: readonly ["horizontal"];
+    readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+    readonly supportedDisplayModes: readonly ["logo-only"];
+    readonly size: "standard";
+    readonly maxDensity: "detailed";
+}, {
+    readonly pattern: "inline-mark-with-title";
+    readonly supportedShapes: readonly ["horizontal", "square", "portrait", "tall"];
+    readonly supportedTextPresence: readonly ["no-text"];
+    readonly supportedDisplayModes: readonly ["logo-plus-title"];
+    readonly size: "compact";
+    readonly maxDensity: "simple";
+}, {
+    readonly pattern: "popout-badge";
+    readonly supportedShapes: readonly ["square", "portrait", "tall"];
+    readonly supportedTextPresence: readonly ["contains-text", "unknown"];
+    readonly supportedDisplayModes: readonly ["logo-only"];
+    readonly size: "display";
+    readonly providesBacking: true;
+}, {
+    readonly pattern: "logo-plate";
+    readonly supportedShapes: readonly ["square", "portrait", "tall"];
+    readonly supportedTextPresence: readonly ["contains-text", "unknown"];
+    readonly supportedDisplayModes: readonly ["logo-only"];
+    readonly size: "display";
+    readonly providesBacking: true;
+}];
+export declare const centeredLogoAccommodations: readonly [{
+    readonly pattern: "title-only";
+    readonly supportedShapes: readonly ["none", "horizontal", "square", "portrait", "tall"];
+    readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+    readonly supportedDisplayModes: readonly ["title-only"];
+    readonly size: "compact";
+}, {
+    readonly pattern: "inline-wordmark";
+    readonly supportedShapes: readonly ["horizontal"];
+    readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+    readonly supportedDisplayModes: readonly ["logo-only"];
+    readonly size: "standard";
+    readonly maxDensity: "detailed";
+}, {
+    readonly pattern: "inline-mark-with-title";
+    readonly supportedShapes: readonly ["horizontal", "square", "portrait", "tall"];
+    readonly supportedTextPresence: readonly ["no-text"];
+    readonly supportedDisplayModes: readonly ["logo-plus-title"];
+    readonly size: "compact";
+    readonly maxDensity: "simple";
+}, {
+    readonly pattern: "centered-masthead";
+    readonly supportedShapes: readonly ["square", "portrait", "tall"];
+    readonly supportedTextPresence: readonly ["contains-text", "unknown"];
+    readonly supportedDisplayModes: readonly ["logo-only"];
+    readonly size: "display";
+    readonly providesBacking: true;
+}, {
+    readonly pattern: "centered-badge";
+    readonly supportedShapes: readonly ["square", "portrait", "tall"];
+    readonly supportedTextPresence: readonly ["contains-text", "unknown"];
+    readonly supportedDisplayModes: readonly ["logo-only"];
+    readonly size: "display";
+    readonly providesBacking: true;
+}];
+export declare const overlayLogoAccommodations: readonly [{
+    readonly pattern: "title-only";
+    readonly supportedShapes: readonly ["none", "horizontal", "square", "portrait", "tall"];
+    readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+    readonly supportedDisplayModes: readonly ["title-only"];
+    readonly size: "compact";
+}, {
+    readonly pattern: "inline-wordmark";
+    readonly supportedShapes: readonly ["horizontal"];
+    readonly supportedTextPresence: readonly ["contains-text", "no-text", "unknown"];
+    readonly supportedDisplayModes: readonly ["logo-only"];
+    readonly size: "standard";
+    readonly maxDensity: "detailed";
+}, {
+    readonly pattern: "inline-mark-with-title";
+    readonly supportedShapes: readonly ["horizontal", "square", "portrait", "tall"];
+    readonly supportedTextPresence: readonly ["no-text"];
+    readonly supportedDisplayModes: readonly ["logo-plus-title"];
+    readonly size: "compact";
+    readonly maxDensity: "simple";
+}, {
+    readonly pattern: "inline-logo-only";
+    readonly supportedShapes: readonly ["square"];
+    readonly supportedTextPresence: readonly ["contains-text", "unknown"];
+    readonly supportedDisplayModes: readonly ["logo-only"];
+    readonly size: "compact";
+    readonly providesBacking: false;
+}];
+export declare function resolveHeaderBrandPresentation(input: Readonly<{
+    logo: HeaderLogoContext;
+    accommodations: readonly LogoAccommodationOption[];
+    allowDisplayFallback?: boolean;
+}>): HeaderBrandPresentationPlan;
+export declare function requireHeaderBrandPresentationSelection(plan: HeaderBrandPresentationPlan): HeaderBrandPresentationSelection;

package/dist/_dts/theme-core/src/site-styles/headerLookSelection.d.ts

@@ -0,0 +1,2 @@
+import { type HeaderLookResolutionInput, type HeaderSelectionResult } from './headerLookTypes';
+export declare function resolveHeaderLook(input: HeaderLookResolutionInput): HeaderSelectionResult;