@reblu/site-blocks 0.18.0 → 0.20.0

package/dist/client.d.ts

@@ -1,8 +1,9 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React from 'react';
 import { ReactNode } from 'react';
-import { DataRequestType, DataRequestInput, DataRequestSubmission } from '@reblu/site-contracts';
+import { ShopProductListItem, AcademyModulePublic, AcademyLessonPublic, DataRequestType, DataRequestInput, DataRequestSubmission } from '@reblu/site-contracts';
 export { DATA_REQUEST_TYPES } from '@reblu/site-contracts';
+import { H as HeadingLevel } from './_heading-BsNbc1wc.js';
 
 /**
  * `useCollection` — the headless heart of `@reblu/site-blocks`.
@@ -247,6 +248,112 @@ interface CartIconProps {
 }
 declare function CartIcon({ itemCount, href, hydrated, bumpOnAdd, labels, className }: CartIconProps): react_jsx_runtime.JSX.Element;
 
+/**
+ * `ProductCarousel` — a horizontal product strip («Productos relacionados»,
+ * «También te puede interesar»…) with no carousel dependency.
+ *
+ * - The track is a native scroll container with CSS scroll-snap, so touch users swipe
+ *   it and keyboard users scroll it once it has focus (it is a labelled, focusable region).
+ * - Previous/next arrows (from `sm` up) scroll by one visible page. They are not rendered
+ *   when everything fits, and the arrow of the end the track is at is disabled.
+ * - Arrow scrolling is instant under `prefers-reduced-motion: reduce`.
+ * - Cards: the package's `ProductCard` by default, or the consumer's via `renderProduct`.
+ */
+interface ProductCarouselLabels {
+    /** Accessible name of the track when there is no `heading`. */
+    region: string;
+    /** `aria-roledescription` of the track. */
+    roleDescription: string;
+    previous: string;
+    next: string;
+}
+declare const DEFAULT_PRODUCT_CAROUSEL_LABELS: ProductCarouselLabels;
+interface ProductCarouselCommonProps {
+    /** Visible heading; when set it also names the track. */
+    heading?: string;
+    /** Default: 2. */
+    headingLevel?: HeadingLevel;
+    /** Replaces the heading's typography (see the className rule in the README). */
+    headingClassName?: string;
+    labels?: Partial<ProductCarouselLabels>;
+    className?: string;
+    /** Classes for each slide (`<li>`), e.g. a different card width. */
+    itemClassName?: string;
+}
+interface ProductCarouselDefaultCardProps extends ProductCarouselCommonProps {
+    products: readonly ShopProductListItem[];
+    renderProduct?: undefined;
+    /** Link target per product (e.g. `(p) => \`/shop/${p.slug}\``). Omit for non-linking cards. */
+    productHref?: (product: ShopProductListItem) => string | undefined;
+    currencyCode?: string;
+    locale?: string;
+}
+interface ProductCarouselCustomCardProps<T extends {
+    id: string | number;
+}> extends ProductCarouselCommonProps {
+    products: readonly T[];
+    /** Renders one slide's card — your own product card. */
+    renderProduct: (product: T, index: number) => ReactNode;
+    productHref?: undefined;
+    currencyCode?: undefined;
+    locale?: undefined;
+}
+type ProductCarouselProps<T extends {
+    id: string | number;
+} = ShopProductListItem> = ProductCarouselDefaultCardProps | ProductCarouselCustomCardProps<T>;
+declare function ProductCarousel<T extends {
+    id: string | number;
+} = ShopProductListItem>(props: ProductCarouselProps<T>): react_jsx_runtime.JSX.Element | null;
+
+/**
+ * `CourseSyllabus` — the drop-in programme of a public course page, over
+ * `AcademyCourseDetail.modules` (`client.academy.bySlug()`), REB-1134.
+ *
+ * - The header reads the heading, then «N módulos · M lecciones».
+ * - Each module with lessons is a `<button>` with `aria-expanded` and
+ *   `aria-controls`, showing its lesson count and, when every lesson has one,
+ *   the module's total duration. Expanding it lists the lessons in the order
+ *   the API returns them, with their duration and the free-preview flag.
+ * - A module without lessons is a plain row (title only), never a button.
+ *
+ * It renders only what the API serves. The API returns published lessons only
+ * and no video, playback or attachment data, so nothing here can leak it.
+ *
+ * Client Component: it holds the open/closed state of each module. Every prop
+ * is serialisable (copy is plain strings), so a Server Component page can
+ * render it directly.
+ */
+interface CourseSyllabusLabels {
+    heading: string;
+    moduleSingular: string;
+    modulePlural: string;
+    lessonSingular: string;
+    lessonPlural: string;
+    /** Badge on a lesson with `isFreePreview`. */
+    freePreview: string;
+    /** Hours unit in durations («1 h 15 min»). */
+    hours: string;
+    /** Minutes unit in durations. */
+    minutes: string;
+}
+declare const DEFAULT_COURSE_SYLLABUS_LABELS: CourseSyllabusLabels;
+/** A module as served. `lessons` is optional so an older payload still renders. */
+type CourseSyllabusModule = Pick<AcademyModulePublic, 'id' | 'title'> & {
+    description?: string | null;
+    lessons?: readonly AcademyLessonPublic[];
+};
+interface CourseSyllabusProps {
+    /** `AcademyCourseDetail.modules`, in the order the API returns them. */
+    modules: readonly CourseSyllabusModule[];
+    labels?: Partial<CourseSyllabusLabels>;
+    /** Level of the heading. Default `2`. */
+    headingLevel?: HeadingLevel;
+    /** Replaces the heading's default typography (see the className rule in the README). */
+    headingClassName?: string;
+    className?: string;
+}
+declare function CourseSyllabus({ modules, labels: labelOverrides, headingLevel, headingClassName, className, }: CourseSyllabusProps): react_jsx_runtime.JSX.Element | null;
+
 /**
  * `DataRequestForm` — drop-in public GDPR rights form (REB-980) over
  * `POST /api/site/data-requests` (REB-77). The visitor picks the right they
@@ -326,4 +433,4 @@ interface DataRequestFormProps {
 }
 declare function DataRequestForm({ getCaptchaToken, submit, endpoint, onInteract, onSubmitted, requestTypes, labels, locale, className, }: DataRequestFormProps): react_jsx_runtime.JSX.Element;
 
-export { AddToCartButton, type AddToCartButtonLabels, type AddToCartButtonProps, type AddToCartButtonStatus, CartIcon, type CartIconLabels, type CartIconProps, Collection, type CollectionFacet, type CollectionFacetOption, type CollectionFilter, type CollectionLabels, type CollectionProps, DATA_REQUEST_FIELD_LIMITS, DEFAULT_DATA_REQUEST_FORM_LABELS, DataRequestForm, type DataRequestFormLabels, type DataRequestFormProps, type DataRequestSubmitResult, ShareButtons, type ShareButtonsLabels, type ShareButtonsProps, type UseCollectionOptions, type UseCollectionResult, useCollection };
+export { AddToCartButton, type AddToCartButtonLabels, type AddToCartButtonProps, type AddToCartButtonStatus, CartIcon, type CartIconLabels, type CartIconProps, Collection, type CollectionFacet, type CollectionFacetOption, type CollectionFilter, type CollectionLabels, type CollectionProps, CourseSyllabus, type CourseSyllabusLabels, type CourseSyllabusModule, type CourseSyllabusProps, DATA_REQUEST_FIELD_LIMITS, DEFAULT_COURSE_SYLLABUS_LABELS, DEFAULT_DATA_REQUEST_FORM_LABELS, DEFAULT_PRODUCT_CAROUSEL_LABELS, DataRequestForm, type DataRequestFormLabels, type DataRequestFormProps, type DataRequestSubmitResult, ProductCarousel, type ProductCarouselCustomCardProps, type ProductCarouselDefaultCardProps, type ProductCarouselLabels, type ProductCarouselProps, ShareButtons, type ShareButtonsLabels, type ShareButtonsProps, type UseCollectionOptions, type UseCollectionResult, useCollection };