@reblu/site-blocks 0.15.0 → 0.17.0

package/dist/index.d.cts

@@ -1,7 +1,9 @@
 import { ShopErrorCode, PageDetail, PageListItem, ShopProductListItem, ShopProductTrustIcon, ShopProductTrustItem, TrustBadgeType, TrustBadge, BlockType, PageBlock, ResolvedEmbed, ShopFacets, ShopOrder, ShopBillingInput, ShopCheckoutInput, ShopOrderInvoice } from '@reblu/site-contracts';
+export { DATA_REQUEST_TYPES } from '@reblu/site-contracts';
 import { FaqItem } from './seo.cjs';
 export { FaqPageJsonLd, MarkdownToPlainTextOptions, buildFaqPageJsonLd, collectFaqItems, markdownToPlainText } from './seo.cjs';
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as React$1 from 'react';
 import { ReactNode, ComponentType, FormEvent } from 'react';
 
 declare function readingTime(content: string | null | undefined): number | null;
@@ -225,8 +227,27 @@ interface MarkdownRendererProps {
      * the page keeps a single h1.
      */
     headingOffset?: number;
+    /**
+     * Restrict and render images (REB-1075). Absent: every image the sanitiser keeps is
+     * rendered as a lazy `<img>` inside its paragraph (the historical behaviour).
+     */
+    images?: MarkdownImageOptions;
+}
+/** The `images` option of {@link MarkdownRenderer}. */
+interface MarkdownImageOptions {
+    /**
+     * Absolute URL prefixes an image may load from (e.g. a storage bucket's public URL,
+     * ending in `/`). Any other image is dropped. Compared on the parsed, normalised URL
+     * (`..` resolved), with the scheme included, so `http:` never matches an `https:` prefix.
+     */
+    allowedUrlPrefixes: readonly string[];
+    /** Render an allowed image yourself (e.g. `next/image`). Default: a lazy `<img>`. */
+    render?: (image: {
+        src: string;
+        alt: string;
+    }) => React$1.ReactNode;
 }
-declare function MarkdownRenderer({ content, className, headingOffset }: MarkdownRendererProps): react_jsx_runtime.JSX.Element | null;
+declare function MarkdownRenderer({ content, className, headingOffset, images, }: MarkdownRendererProps): react_jsx_runtime.JSX.Element | null;
 /**
  * Render an **already-sanitised** HTML string through the same token-driven
  * component map as {@link MarkdownRenderer}. Consumers pass HTML that has been run
@@ -489,8 +510,14 @@ declare function FaqAccordion({ items, heading, headingLevel, questionHeadingLev
  * - Badges are grouped by type (in {@link DEFAULT_TRUST_BADGE_TYPE_ORDER}, or
  *   the `types` prop), each group under an overridable heading, and ordered by
  *   `sortOrder` inside it.
- * - A logo is an `<img>` whose `alt` is the badge name; a badge without a logo
+ * - A logo is an `<img>` whose `alt` is the badge name, rendered only when its
+ *   URL is http(s) or root-relative (REB-1002); a badge without a usable logo
  *   shows its name as text.
+ * - `heading` (optional) wraps everything in a `<section>` labelled by it
+ *   (`headingId`), with the group headings one level below — so a SITE keeps
+ *   its `<section aria-labelledby>` landmark (REB-1002).
+ * - Consumer classNames follow the REB-997 slot rule: `headingClassName` and
+ *   `sectionHeadingClassName` REPLACE that heading's default typography.
  * - `url` links only when it is http(s), in a new window with
  *   `rel="noopener noreferrer"` and a visually hidden new-window hint.
  */
@@ -505,7 +532,18 @@ interface TrustBadgesProps {
     headings?: Partial<Record<TrustBadgeType, string | null>>;
     /** Which groups to render, in this order. Defaults to every type. */
     types?: readonly TrustBadgeType[];
-    /** Heading level of each group title. Defaults to `2`. */
+    /**
+     * Optional section title, e.g. «Nos avalan». When given, the root is a
+     * `<section aria-labelledby={headingId}>` and the group headings render one
+     * level below `headingLevel`.
+     */
+    heading?: ReactNode;
+    /** `id` of the section heading (the section's `aria-labelledby`). @default 'trust-badges-heading' */
+    headingId?: string;
+    /**
+     * Heading level of the section title when `heading` is given, otherwise of
+     * each group title. Defaults to `2`.
+     */
     headingLevel?: HeadingLevel;
     /** Visually hidden text appended to linked badges. */
     newWindowLabel?: string;
@@ -513,14 +551,22 @@ interface TrustBadgesProps {
     className?: string;
     /** Classes for each group. */
     groupClassName?: string;
-    /** Classes for each group heading. */
+    /**
+     * Classes for each group heading. When given, they REPLACE the default
+     * `text-sm font-semibold uppercase tracking-widest` (REB-997).
+     */
     headingClassName?: string;
+    /**
+     * Classes for the section heading (only with `heading`). When given, they
+     * REPLACE the default `text-xl font-semibold` (REB-997).
+     */
+    sectionHeadingClassName?: string;
     /** Classes for each group's `<ul>`. */
     listClassName?: string;
     /** Classes for each logo `<img>`. */
     logoClassName?: string;
 }
-declare function TrustBadges({ badges, headings, types, headingLevel, newWindowLabel, className, groupClassName, headingClassName, listClassName, logoClassName, }: TrustBadgesProps): react_jsx_runtime.JSX.Element | null;
+declare function TrustBadges({ badges, headings, types, heading, headingId, headingLevel, newWindowLabel, className, groupClassName, headingClassName, sectionHeadingClassName, listClassName, logoClassName, }: TrustBadgesProps): react_jsx_runtime.JSX.Element | null;
 
 /**
  * REB-850 — `PageBlocks`: the shared renderer for a page's registry blocks
@@ -1203,4 +1249,4 @@ interface OrderInvoiceLinkProps {
 }
 declare function OrderInvoiceLink({ invoice, labels, className }: OrderInvoiceLinkProps): react_jsx_runtime.JSX.Element | null;
 
-export { ALLOWED_YOUTUBE_HOSTS, AddedToCartToast, type AddedToCartToastLabels, type AddedToCartToastProps, type AddedToCartToastStatus, type BlockRendererProps, type CanonicalBlockType, type CartAdjustmentLine, CartAdjustmentsNotice, type CartAdjustmentsNoticeLabels, type CartAdjustmentsNoticeProps, type CartLineItemView, CartLineList, type CartLineListLabels, type CartLineListProps, CartSummary, type CartSummaryLabels, type CartSummaryProps, type CheckoutAppliedDiscount, type CheckoutContactErrors, type CheckoutContactValues, CheckoutForm, type CheckoutFormLabels, type CheckoutFormProps, CheckoutLoginPrompt, type CheckoutLoginPromptLabels, type CheckoutLoginPromptProps, CourseDescription, type CourseDescriptionProps, DEFAULT_INVOICE_COUNTRIES, DEFAULT_SHOP_ERROR_FALLBACK_MESSAGE, DEFAULT_SHOP_ERROR_MESSAGES, DEFAULT_SHOP_PRICE_BANDS, DEFAULT_TRUST_BADGE_HEADINGS, DEFAULT_TRUST_BADGE_TYPE_ORDER, DEFAULT_TRUST_ICONS, EMPTY_FULL_INVOICE_VALUE, FaqAccordion, type FaqAccordionProps, FaqItem, type FullInvoiceErrors, FullInvoiceFields, type FullInvoiceFieldsLabels, type FullInvoiceFieldsProps, type FullInvoiceIdType, type FullInvoiceValue, type HeadingLevel, MarkdownRenderer, type MarkdownRendererProps, OrderConfirmation, type OrderConfirmationLabels, type OrderConfirmationOrder, type OrderConfirmationProps, type OrderConfirmationStatus, OrderInvoiceLink, type OrderInvoiceLinkLabels, type OrderInvoiceLinkProps, PageBlocks, type PageBlocksComponents, type PageBlocksProps, PageCardGrid, type PageCardGridProps, ParentPage, type ParentPageProps, ProductCard, type ProductCardProps, ProductTrustItems, type ProductTrustItemsProps, ProfileCard, type ProfileCardProps, type RenderableBlock, SafeHtml, type SafeHtmlProps, type ShareUrls, type ShopFilterPriceBand, ShopFilters, type ShopFiltersActive, type ShopFiltersHrefs, type ShopFiltersLabels, type ShopFiltersProps, Specialty, type SpecialtyProps, Treatment, type TreatmentProps, TrustBadges, type TrustBadgesProps, type TrustIconComponent, type TrustIconProps, buildShareUrls, formatPrice, getShopErrorMessage, isAllowedYouTubeHost, isOverSimplifiedInvoiceCap, markdownToSafeHtml, readingTime, sanitizeHtml, shopIssuesInvoices, shouldRenderShopFilters, toCheckoutInvoiceFields };
+export { ALLOWED_YOUTUBE_HOSTS, AddedToCartToast, type AddedToCartToastLabels, type AddedToCartToastProps, type AddedToCartToastStatus, type BlockRendererProps, type CanonicalBlockType, type CartAdjustmentLine, CartAdjustmentsNotice, type CartAdjustmentsNoticeLabels, type CartAdjustmentsNoticeProps, type CartLineItemView, CartLineList, type CartLineListLabels, type CartLineListProps, CartSummary, type CartSummaryLabels, type CartSummaryProps, type CheckoutAppliedDiscount, type CheckoutContactErrors, type CheckoutContactValues, CheckoutForm, type CheckoutFormLabels, type CheckoutFormProps, CheckoutLoginPrompt, type CheckoutLoginPromptLabels, type CheckoutLoginPromptProps, CourseDescription, type CourseDescriptionProps, DEFAULT_INVOICE_COUNTRIES, DEFAULT_SHOP_ERROR_FALLBACK_MESSAGE, DEFAULT_SHOP_ERROR_MESSAGES, DEFAULT_SHOP_PRICE_BANDS, DEFAULT_TRUST_BADGE_HEADINGS, DEFAULT_TRUST_BADGE_TYPE_ORDER, DEFAULT_TRUST_ICONS, EMPTY_FULL_INVOICE_VALUE, FaqAccordion, type FaqAccordionProps, FaqItem, type FullInvoiceErrors, FullInvoiceFields, type FullInvoiceFieldsLabels, type FullInvoiceFieldsProps, type FullInvoiceIdType, type FullInvoiceValue, type HeadingLevel, type MarkdownImageOptions, MarkdownRenderer, type MarkdownRendererProps, OrderConfirmation, type OrderConfirmationLabels, type OrderConfirmationOrder, type OrderConfirmationProps, type OrderConfirmationStatus, OrderInvoiceLink, type OrderInvoiceLinkLabels, type OrderInvoiceLinkProps, PageBlocks, type PageBlocksComponents, type PageBlocksProps, PageCardGrid, type PageCardGridProps, ParentPage, type ParentPageProps, ProductCard, type ProductCardProps, ProductTrustItems, type ProductTrustItemsProps, ProfileCard, type ProfileCardProps, type RenderableBlock, SafeHtml, type SafeHtmlProps, type ShareUrls, type ShopFilterPriceBand, ShopFilters, type ShopFiltersActive, type ShopFiltersHrefs, type ShopFiltersLabels, type ShopFiltersProps, Specialty, type SpecialtyProps, Treatment, type TreatmentProps, TrustBadges, type TrustBadgesProps, type TrustIconComponent, type TrustIconProps, buildShareUrls, formatPrice, getShopErrorMessage, isAllowedYouTubeHost, isOverSimplifiedInvoiceCap, markdownToSafeHtml, readingTime, sanitizeHtml, shopIssuesInvoices, shouldRenderShopFilters, toCheckoutInvoiceFields };

package/dist/index.d.ts

@@ -1,7 +1,9 @@
 import { ShopErrorCode, PageDetail, PageListItem, ShopProductListItem, ShopProductTrustIcon, ShopProductTrustItem, TrustBadgeType, TrustBadge, BlockType, PageBlock, ResolvedEmbed, ShopFacets, ShopOrder, ShopBillingInput, ShopCheckoutInput, ShopOrderInvoice } from '@reblu/site-contracts';
+export { DATA_REQUEST_TYPES } from '@reblu/site-contracts';
 import { FaqItem } from './seo.js';
 export { FaqPageJsonLd, MarkdownToPlainTextOptions, buildFaqPageJsonLd, collectFaqItems, markdownToPlainText } from './seo.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as React$1 from 'react';
 import { ReactNode, ComponentType, FormEvent } from 'react';
 
 declare function readingTime(content: string | null | undefined): number | null;
@@ -225,8 +227,27 @@ interface MarkdownRendererProps {
      * the page keeps a single h1.
      */
     headingOffset?: number;
+    /**
+     * Restrict and render images (REB-1075). Absent: every image the sanitiser keeps is
+     * rendered as a lazy `<img>` inside its paragraph (the historical behaviour).
+     */
+    images?: MarkdownImageOptions;
+}
+/** The `images` option of {@link MarkdownRenderer}. */
+interface MarkdownImageOptions {
+    /**
+     * Absolute URL prefixes an image may load from (e.g. a storage bucket's public URL,
+     * ending in `/`). Any other image is dropped. Compared on the parsed, normalised URL
+     * (`..` resolved), with the scheme included, so `http:` never matches an `https:` prefix.
+     */
+    allowedUrlPrefixes: readonly string[];
+    /** Render an allowed image yourself (e.g. `next/image`). Default: a lazy `<img>`. */
+    render?: (image: {
+        src: string;
+        alt: string;
+    }) => React$1.ReactNode;
 }
-declare function MarkdownRenderer({ content, className, headingOffset }: MarkdownRendererProps): react_jsx_runtime.JSX.Element | null;
+declare function MarkdownRenderer({ content, className, headingOffset, images, }: MarkdownRendererProps): react_jsx_runtime.JSX.Element | null;
 /**
  * Render an **already-sanitised** HTML string through the same token-driven
  * component map as {@link MarkdownRenderer}. Consumers pass HTML that has been run
@@ -489,8 +510,14 @@ declare function FaqAccordion({ items, heading, headingLevel, questionHeadingLev
  * - Badges are grouped by type (in {@link DEFAULT_TRUST_BADGE_TYPE_ORDER}, or
  *   the `types` prop), each group under an overridable heading, and ordered by
  *   `sortOrder` inside it.
- * - A logo is an `<img>` whose `alt` is the badge name; a badge without a logo
+ * - A logo is an `<img>` whose `alt` is the badge name, rendered only when its
+ *   URL is http(s) or root-relative (REB-1002); a badge without a usable logo
  *   shows its name as text.
+ * - `heading` (optional) wraps everything in a `<section>` labelled by it
+ *   (`headingId`), with the group headings one level below — so a SITE keeps
+ *   its `<section aria-labelledby>` landmark (REB-1002).
+ * - Consumer classNames follow the REB-997 slot rule: `headingClassName` and
+ *   `sectionHeadingClassName` REPLACE that heading's default typography.
  * - `url` links only when it is http(s), in a new window with
  *   `rel="noopener noreferrer"` and a visually hidden new-window hint.
  */
@@ -505,7 +532,18 @@ interface TrustBadgesProps {
     headings?: Partial<Record<TrustBadgeType, string | null>>;
     /** Which groups to render, in this order. Defaults to every type. */
     types?: readonly TrustBadgeType[];
-    /** Heading level of each group title. Defaults to `2`. */
+    /**
+     * Optional section title, e.g. «Nos avalan». When given, the root is a
+     * `<section aria-labelledby={headingId}>` and the group headings render one
+     * level below `headingLevel`.
+     */
+    heading?: ReactNode;
+    /** `id` of the section heading (the section's `aria-labelledby`). @default 'trust-badges-heading' */
+    headingId?: string;
+    /**
+     * Heading level of the section title when `heading` is given, otherwise of
+     * each group title. Defaults to `2`.
+     */
     headingLevel?: HeadingLevel;
     /** Visually hidden text appended to linked badges. */
     newWindowLabel?: string;
@@ -513,14 +551,22 @@ interface TrustBadgesProps {
     className?: string;
     /** Classes for each group. */
     groupClassName?: string;
-    /** Classes for each group heading. */
+    /**
+     * Classes for each group heading. When given, they REPLACE the default
+     * `text-sm font-semibold uppercase tracking-widest` (REB-997).
+     */
     headingClassName?: string;
+    /**
+     * Classes for the section heading (only with `heading`). When given, they
+     * REPLACE the default `text-xl font-semibold` (REB-997).
+     */
+    sectionHeadingClassName?: string;
     /** Classes for each group's `<ul>`. */
     listClassName?: string;
     /** Classes for each logo `<img>`. */
     logoClassName?: string;
 }
-declare function TrustBadges({ badges, headings, types, headingLevel, newWindowLabel, className, groupClassName, headingClassName, listClassName, logoClassName, }: TrustBadgesProps): react_jsx_runtime.JSX.Element | null;
+declare function TrustBadges({ badges, headings, types, heading, headingId, headingLevel, newWindowLabel, className, groupClassName, headingClassName, sectionHeadingClassName, listClassName, logoClassName, }: TrustBadgesProps): react_jsx_runtime.JSX.Element | null;
 
 /**
  * REB-850 — `PageBlocks`: the shared renderer for a page's registry blocks
@@ -1203,4 +1249,4 @@ interface OrderInvoiceLinkProps {
 }
 declare function OrderInvoiceLink({ invoice, labels, className }: OrderInvoiceLinkProps): react_jsx_runtime.JSX.Element | null;
 
-export { ALLOWED_YOUTUBE_HOSTS, AddedToCartToast, type AddedToCartToastLabels, type AddedToCartToastProps, type AddedToCartToastStatus, type BlockRendererProps, type CanonicalBlockType, type CartAdjustmentLine, CartAdjustmentsNotice, type CartAdjustmentsNoticeLabels, type CartAdjustmentsNoticeProps, type CartLineItemView, CartLineList, type CartLineListLabels, type CartLineListProps, CartSummary, type CartSummaryLabels, type CartSummaryProps, type CheckoutAppliedDiscount, type CheckoutContactErrors, type CheckoutContactValues, CheckoutForm, type CheckoutFormLabels, type CheckoutFormProps, CheckoutLoginPrompt, type CheckoutLoginPromptLabels, type CheckoutLoginPromptProps, CourseDescription, type CourseDescriptionProps, DEFAULT_INVOICE_COUNTRIES, DEFAULT_SHOP_ERROR_FALLBACK_MESSAGE, DEFAULT_SHOP_ERROR_MESSAGES, DEFAULT_SHOP_PRICE_BANDS, DEFAULT_TRUST_BADGE_HEADINGS, DEFAULT_TRUST_BADGE_TYPE_ORDER, DEFAULT_TRUST_ICONS, EMPTY_FULL_INVOICE_VALUE, FaqAccordion, type FaqAccordionProps, FaqItem, type FullInvoiceErrors, FullInvoiceFields, type FullInvoiceFieldsLabels, type FullInvoiceFieldsProps, type FullInvoiceIdType, type FullInvoiceValue, type HeadingLevel, MarkdownRenderer, type MarkdownRendererProps, OrderConfirmation, type OrderConfirmationLabels, type OrderConfirmationOrder, type OrderConfirmationProps, type OrderConfirmationStatus, OrderInvoiceLink, type OrderInvoiceLinkLabels, type OrderInvoiceLinkProps, PageBlocks, type PageBlocksComponents, type PageBlocksProps, PageCardGrid, type PageCardGridProps, ParentPage, type ParentPageProps, ProductCard, type ProductCardProps, ProductTrustItems, type ProductTrustItemsProps, ProfileCard, type ProfileCardProps, type RenderableBlock, SafeHtml, type SafeHtmlProps, type ShareUrls, type ShopFilterPriceBand, ShopFilters, type ShopFiltersActive, type ShopFiltersHrefs, type ShopFiltersLabels, type ShopFiltersProps, Specialty, type SpecialtyProps, Treatment, type TreatmentProps, TrustBadges, type TrustBadgesProps, type TrustIconComponent, type TrustIconProps, buildShareUrls, formatPrice, getShopErrorMessage, isAllowedYouTubeHost, isOverSimplifiedInvoiceCap, markdownToSafeHtml, readingTime, sanitizeHtml, shopIssuesInvoices, shouldRenderShopFilters, toCheckoutInvoiceFields };
+export { ALLOWED_YOUTUBE_HOSTS, AddedToCartToast, type AddedToCartToastLabels, type AddedToCartToastProps, type AddedToCartToastStatus, type BlockRendererProps, type CanonicalBlockType, type CartAdjustmentLine, CartAdjustmentsNotice, type CartAdjustmentsNoticeLabels, type CartAdjustmentsNoticeProps, type CartLineItemView, CartLineList, type CartLineListLabels, type CartLineListProps, CartSummary, type CartSummaryLabels, type CartSummaryProps, type CheckoutAppliedDiscount, type CheckoutContactErrors, type CheckoutContactValues, CheckoutForm, type CheckoutFormLabels, type CheckoutFormProps, CheckoutLoginPrompt, type CheckoutLoginPromptLabels, type CheckoutLoginPromptProps, CourseDescription, type CourseDescriptionProps, DEFAULT_INVOICE_COUNTRIES, DEFAULT_SHOP_ERROR_FALLBACK_MESSAGE, DEFAULT_SHOP_ERROR_MESSAGES, DEFAULT_SHOP_PRICE_BANDS, DEFAULT_TRUST_BADGE_HEADINGS, DEFAULT_TRUST_BADGE_TYPE_ORDER, DEFAULT_TRUST_ICONS, EMPTY_FULL_INVOICE_VALUE, FaqAccordion, type FaqAccordionProps, FaqItem, type FullInvoiceErrors, FullInvoiceFields, type FullInvoiceFieldsLabels, type FullInvoiceFieldsProps, type FullInvoiceIdType, type FullInvoiceValue, type HeadingLevel, type MarkdownImageOptions, MarkdownRenderer, type MarkdownRendererProps, OrderConfirmation, type OrderConfirmationLabels, type OrderConfirmationOrder, type OrderConfirmationProps, type OrderConfirmationStatus, OrderInvoiceLink, type OrderInvoiceLinkLabels, type OrderInvoiceLinkProps, PageBlocks, type PageBlocksComponents, type PageBlocksProps, PageCardGrid, type PageCardGridProps, ParentPage, type ParentPageProps, ProductCard, type ProductCardProps, ProductTrustItems, type ProductTrustItemsProps, ProfileCard, type ProfileCardProps, type RenderableBlock, SafeHtml, type SafeHtmlProps, type ShareUrls, type ShopFilterPriceBand, ShopFilters, type ShopFiltersActive, type ShopFiltersHrefs, type ShopFiltersLabels, type ShopFiltersProps, Specialty, type SpecialtyProps, Treatment, type TreatmentProps, TrustBadges, type TrustBadgesProps, type TrustIconComponent, type TrustIconProps, buildShareUrls, formatPrice, getShopErrorMessage, isAllowedYouTubeHost, isOverSimplifiedInvoiceCap, markdownToSafeHtml, readingTime, sanitizeHtml, shopIssuesInvoices, shouldRenderShopFilters, toCheckoutInvoiceFields };