@reblu/site-blocks 0.17.1 → 0.19.0

package/dist/index.d.cts

@@ -1,10 +1,11 @@
-import { ShopErrorCode, PageDetail, PageListItem, ShopProductListItem, ShopProductTrustIcon, ShopProductTrustItem, TrustBadgeType, TrustBadge, BlockType, PageBlock, ResolvedEmbed, ShopFacets, ShopOrder, ShopBillingInput, ShopCheckoutInput, ShopOrderInvoice } from '@reblu/site-contracts';
+import { ShopErrorCode, PageDetail, PageListItem, ProfessionalField, 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';
+import { H as HeadingLevel } from './_heading-BsNbc1wc.cjs';
 
 declare function readingTime(content: string | null | undefined): number | null;
 
@@ -227,6 +228,14 @@ interface MarkdownRendererProps {
      * the page keeps a single h1.
      */
     headingOffset?: number;
+    /**
+     * Land the body's SHALLOWEST heading at `1 + headingOffset` instead of shifting every
+     * heading by a fixed amount, so standard Markdown (`##` sections) renders `<h2>` under
+     * the page `<h1>` just like the convention (`#` sections) does. Relative depth is kept
+     * and levels clamp at h6. Use it where the body sits directly under the page `<h1>`;
+     * leave it off where the body sits under its own section heading. Default `false`.
+     */
+    normalizeHeadings?: boolean;
     /**
      * Restrict and render images (REB-1075). Absent: every image the sanitiser keeps is
      * rendered as a lazy `<img>` inside its paragraph (the historical behaviour).
@@ -247,7 +256,7 @@ interface MarkdownImageOptions {
         alt: string;
     }) => React$1.ReactNode;
 }
-declare function MarkdownRenderer({ content, className, headingOffset, images, }: MarkdownRendererProps): react_jsx_runtime.JSX.Element | null;
+declare function MarkdownRenderer({ content, className, headingOffset, normalizeHeadings, 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
@@ -258,11 +267,10 @@ interface SafeHtmlProps {
     html: string | null | undefined;
     className?: string;
     headingOffset?: number;
+    /** See {@link MarkdownRendererProps.normalizeHeadings}. Default `false`. */
+    normalizeHeadings?: boolean;
 }
-declare function SafeHtml({ html, className, headingOffset }: SafeHtmlProps): react_jsx_runtime.JSX.Element | null;
-
-/** A heading level a caller can configure — `h1`…`h6`. */
-type HeadingLevel = 1 | 2 | 3 | 4 | 5 | 6;
+declare function SafeHtml({ html, className, headingOffset, normalizeHeadings, }: SafeHtmlProps): react_jsx_runtime.JSX.Element | null;
 
 /**
  * `CourseDescription` — the drop-in for `AcademyCourseDetail.description`
@@ -400,11 +408,35 @@ interface ProfileCardProps {
     /** Short list of specialties / tags shown as chips. */
     specialties?: string[];
     bio?: string;
+    /**
+     * REB-1099 — the tenant's professional fields (`professional.fields` from
+     * `client.pages.list`). Only the `showOnCard` ones are shown.
+     */
+    fields?: ProfessionalField[] | null;
     /** Link target for the full profile. Omit to render non-linking. */
     href?: string;
     className?: string;
 }
-declare function ProfileCard({ name, role, imageUrl, specialties, bio, href, className }: ProfileCardProps): react_jsx_runtime.JSX.Element;
+declare function ProfileCard({ name, role, imageUrl, specialties, bio, fields, href, className, }: ProfileCardProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * `ProfessionalFields` — the tenant-defined professional fields of a team
+ * profile (REB-1099), e.g. a registration number, as a `<dl>`.
+ *
+ * Feed it `professional.fields` from the SITE API as-is: the list card
+ * (`client.pages.list`) already carries only the card fields, the profile
+ * (`client.pages.bySlug`) carries every public one. `variant='card'` filters
+ * to `showOnCard` anyway, so one list can feed both places. The labels are the
+ * tenant's own; nothing here names a field. Renders nothing when there is
+ * nothing to show. RSC-safe.
+ */
+interface ProfessionalFieldsProps {
+    fields: ProfessionalField[] | null | undefined;
+    /** `'card'` keeps only `showOnCard` fields. Default `'profile'`: every field. */
+    variant?: 'card' | 'profile';
+    className?: string;
+}
+declare function ProfessionalFields({ fields, variant, className, }: ProfessionalFieldsProps): react_jsx_runtime.JSX.Element | null;
 
 /**
  * `ProductCard` — presentational shop product tile over `ShopProductListItem`.
@@ -1249,4 +1281,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, 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 };
+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, 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, ProfessionalFields, type ProfessionalFieldsProps, 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,10 +1,11 @@
-import { ShopErrorCode, PageDetail, PageListItem, ShopProductListItem, ShopProductTrustIcon, ShopProductTrustItem, TrustBadgeType, TrustBadge, BlockType, PageBlock, ResolvedEmbed, ShopFacets, ShopOrder, ShopBillingInput, ShopCheckoutInput, ShopOrderInvoice } from '@reblu/site-contracts';
+import { ShopErrorCode, PageDetail, PageListItem, ProfessionalField, 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';
+import { H as HeadingLevel } from './_heading-BsNbc1wc.js';
 
 declare function readingTime(content: string | null | undefined): number | null;
 
@@ -227,6 +228,14 @@ interface MarkdownRendererProps {
      * the page keeps a single h1.
      */
     headingOffset?: number;
+    /**
+     * Land the body's SHALLOWEST heading at `1 + headingOffset` instead of shifting every
+     * heading by a fixed amount, so standard Markdown (`##` sections) renders `<h2>` under
+     * the page `<h1>` just like the convention (`#` sections) does. Relative depth is kept
+     * and levels clamp at h6. Use it where the body sits directly under the page `<h1>`;
+     * leave it off where the body sits under its own section heading. Default `false`.
+     */
+    normalizeHeadings?: boolean;
     /**
      * Restrict and render images (REB-1075). Absent: every image the sanitiser keeps is
      * rendered as a lazy `<img>` inside its paragraph (the historical behaviour).
@@ -247,7 +256,7 @@ interface MarkdownImageOptions {
         alt: string;
     }) => React$1.ReactNode;
 }
-declare function MarkdownRenderer({ content, className, headingOffset, images, }: MarkdownRendererProps): react_jsx_runtime.JSX.Element | null;
+declare function MarkdownRenderer({ content, className, headingOffset, normalizeHeadings, 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
@@ -258,11 +267,10 @@ interface SafeHtmlProps {
     html: string | null | undefined;
     className?: string;
     headingOffset?: number;
+    /** See {@link MarkdownRendererProps.normalizeHeadings}. Default `false`. */
+    normalizeHeadings?: boolean;
 }
-declare function SafeHtml({ html, className, headingOffset }: SafeHtmlProps): react_jsx_runtime.JSX.Element | null;
-
-/** A heading level a caller can configure — `h1`…`h6`. */
-type HeadingLevel = 1 | 2 | 3 | 4 | 5 | 6;
+declare function SafeHtml({ html, className, headingOffset, normalizeHeadings, }: SafeHtmlProps): react_jsx_runtime.JSX.Element | null;
 
 /**
  * `CourseDescription` — the drop-in for `AcademyCourseDetail.description`
@@ -400,11 +408,35 @@ interface ProfileCardProps {
     /** Short list of specialties / tags shown as chips. */
     specialties?: string[];
     bio?: string;
+    /**
+     * REB-1099 — the tenant's professional fields (`professional.fields` from
+     * `client.pages.list`). Only the `showOnCard` ones are shown.
+     */
+    fields?: ProfessionalField[] | null;
     /** Link target for the full profile. Omit to render non-linking. */
     href?: string;
     className?: string;
 }
-declare function ProfileCard({ name, role, imageUrl, specialties, bio, href, className }: ProfileCardProps): react_jsx_runtime.JSX.Element;
+declare function ProfileCard({ name, role, imageUrl, specialties, bio, fields, href, className, }: ProfileCardProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * `ProfessionalFields` — the tenant-defined professional fields of a team
+ * profile (REB-1099), e.g. a registration number, as a `<dl>`.
+ *
+ * Feed it `professional.fields` from the SITE API as-is: the list card
+ * (`client.pages.list`) already carries only the card fields, the profile
+ * (`client.pages.bySlug`) carries every public one. `variant='card'` filters
+ * to `showOnCard` anyway, so one list can feed both places. The labels are the
+ * tenant's own; nothing here names a field. Renders nothing when there is
+ * nothing to show. RSC-safe.
+ */
+interface ProfessionalFieldsProps {
+    fields: ProfessionalField[] | null | undefined;
+    /** `'card'` keeps only `showOnCard` fields. Default `'profile'`: every field. */
+    variant?: 'card' | 'profile';
+    className?: string;
+}
+declare function ProfessionalFields({ fields, variant, className, }: ProfessionalFieldsProps): react_jsx_runtime.JSX.Element | null;
 
 /**
  * `ProductCard` — presentational shop product tile over `ShopProductListItem`.
@@ -1249,4 +1281,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, 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 };
+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, 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, ProfessionalFields, type ProfessionalFieldsProps, 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 };