@reblu/site-blocks 0.2.1

package/dist/index.d.cts

@@ -0,0 +1,162 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { PageDetail, PageListItem, ShopProductListItem } from '@reblu/site-contracts';
+
+declare function readingTime(content: string | null | undefined): number | null;
+
+/**
+ * Format an integer-cents amount as a localized currency string.
+ *
+ * All Reblu shop monetary values travel as integer cents (Prisma `Int`, never
+ * Decimal), so the SITE never sees floats. This helper is the single place that
+ * converts cents → major units and applies `Intl.NumberFormat`, keeping price
+ * rendering consistent across `ProductCard` and any future shop organism.
+ */
+declare function formatPrice(cents: number, currency?: string, locale?: string): string;
+
+/**
+ * Pure builders for the social-share targets used by `ShareButtons`.
+ *
+ * Framework-free so the URL construction is unit-testable without rendering.
+ * Every provider gets the canonical post URL; providers that support custom copy
+ * (X, WhatsApp) also receive the post title.
+ */
+interface ShareUrls {
+    linkedin: string;
+    x: string;
+    facebook: string;
+    whatsapp: string;
+}
+declare function buildShareUrls(url: string, title: string): ShareUrls;
+
+/**
+ * Canonical Blog markdown → **safe HTML** pipeline for the Reblu SITE SDK.
+ *
+ * Blog `content` arrives as raw Markdown (tiptap-markdown). This module owns the
+ * single, hardened conversion every SITE reuses instead of reinventing it:
+ *
+ *   Markdown ──(marked, GFM)──▶ HTML ──(DOMPurify)──▶ safe HTML
+ *
+ * DOMPurify is MANDATORY (XSS): the output is later parsed into React nodes by
+ * `MarkdownRenderer` (no `dangerouslySetInnerHTML`), but sanitising here means the
+ * string is safe regardless of how a consumer chooses to render it.
+ *
+ * `<iframe>` is the one non-default tag we allow, and ONLY when its `src` host is
+ * on the YouTube allowlist — every other embed (arbitrary iframes) is dropped.
+ */
+/** Hosts permitted for `<iframe>` embeds. Exact host match — no suffix tricks. */
+declare const ALLOWED_YOUTUBE_HOSTS: readonly string[];
+/** True when `src` is an absolute URL whose host is exactly a YouTube host. */
+declare function isAllowedYouTubeHost(src: string | null | undefined): boolean;
+/**
+ * Sanitise an already-HTML string with the same policy (default-safe tags plus a
+ * host-gated `<iframe>`). Use for content that arrives as HTML — e.g. page
+ * `section.contentHtml` from base-api, which is `marked` output that has NOT been
+ * sanitised server-side.
+ */
+declare function sanitizeHtml(html: string | null | undefined): string;
+/** Convert raw Markdown to sanitised, XSS-safe HTML. */
+declare function markdownToSafeHtml(markdown: string | null | undefined): string;
+
+/**
+ * `MarkdownRenderer` — the canonical Blog body renderer.
+ *
+ * Pipeline: raw Markdown → `markdownToSafeHtml` (marked → DOMPurify, XSS-safe) →
+ * `html-react-parser` into a token-styled React tree. We parse the sanitised HTML
+ * into real React nodes (a component map) rather than using
+ * `dangerouslySetInnerHTML`, so images lazy-load, external links are hardened, and
+ * YouTube embeds get a responsive aspect-ratio wrapper.
+ *
+ * RSC-safe: no hooks, no browser APIs — renders inside a Server Component.
+ * Styling is entirely token-driven (shadcn/OKLCH tokens); the block carries no
+ * brand aesthetic of its own.
+ */
+interface MarkdownRendererProps {
+    /** Raw Markdown (blog `content`). */
+    content: string | null | undefined;
+    className?: string;
+    /**
+     * Shift every heading down by this many levels (clamped to h6). Use `1` on a
+     * page that already renders its own `<h1>` so markdown `#` becomes `<h2>` and
+     * the page keeps a single h1.
+     */
+    headingOffset?: number;
+}
+declare function MarkdownRenderer({ content, className, headingOffset }: 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
+ * through `sanitizeHtml`/`markdownToSafeHtml`; this component does NOT sanitise, so
+ * never hand it untrusted HTML.
+ */
+interface SafeHtmlProps {
+    html: string | null | undefined;
+    className?: string;
+    headingOffset?: number;
+}
+declare function SafeHtml({ html, className, headingOffset }: SafeHtmlProps): react_jsx_runtime.JSX.Element | null;
+
+/**
+ * `Treatment` — full treatment page organism over a `PageDetail` (a SERVICE-type
+ * page). Renders the hero band followed by the ordered content sections.
+ * Token-driven, RSC-safe.
+ */
+interface TreatmentProps {
+    page: PageDetail;
+    className?: string;
+}
+declare function Treatment({ page, className }: TreatmentProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * `Specialty` — specialty page organism over a `PageDetail`. Like `Treatment` it
+ * renders a hero and content sections, but a specialty groups treatments, so it
+ * also renders an optional grid of the treatment pages under it (links to each
+ * treatment). Token-driven, RSC-safe.
+ */
+interface SpecialtyProps {
+    page: PageDetail;
+    /** Treatment pages under this specialty. Rendered as a linked grid when present. */
+    treatments?: PageListItem[];
+    /** Builds the href for a treatment page from its slug. Defaults to `/{slug}`. */
+    treatmentHref?: (slug: string) => string;
+    /** Heading for the treatments grid. Defaults to "Treatments". */
+    treatmentsLabel?: string;
+    className?: string;
+}
+declare function Specialty({ page, treatments, treatmentHref, treatmentsLabel, className, }: SpecialtyProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * `ProfileCard` — presentational professional/team-member card (the clinic
+ * "doctor card" from the mockups). There is no SITE API contract for staff yet,
+ * so the prop shape is local and intentionally minimal. Token-driven, RSC-safe.
+ */
+interface ProfileCardProps {
+    name: string;
+    role?: string;
+    imageUrl?: string;
+    /** Short list of specialties / tags shown as chips. */
+    specialties?: string[];
+    bio?: string;
+    /** 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;
+
+/**
+ * `ProductCard` — presentational shop product tile over `ShopProductListItem`.
+ *
+ * Token-driven, RSC-safe (no hooks). Prices arrive as integer cents and are
+ * formatted with {@link formatPrice}. A `comparePrice` higher than `price` renders
+ * as a struck-through "was" amount.
+ */
+interface ProductCardProps {
+    product: ShopProductListItem;
+    /** Link target for the product (e.g. `/shop/{slug}`). Omit to render non-linking. */
+    href?: string;
+    currencyCode?: string;
+    locale?: string;
+    className?: string;
+}
+declare function ProductCard({ product, href, currencyCode, locale, className }: ProductCardProps): react_jsx_runtime.JSX.Element;
+
+export { ALLOWED_YOUTUBE_HOSTS, MarkdownRenderer, type MarkdownRendererProps, ProductCard, type ProductCardProps, ProfileCard, type ProfileCardProps, SafeHtml, type SafeHtmlProps, type ShareUrls, Specialty, type SpecialtyProps, Treatment, type TreatmentProps, buildShareUrls, formatPrice, isAllowedYouTubeHost, markdownToSafeHtml, readingTime, sanitizeHtml };

package/dist/index.d.ts

@@ -0,0 +1,162 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { PageDetail, PageListItem, ShopProductListItem } from '@reblu/site-contracts';
+
+declare function readingTime(content: string | null | undefined): number | null;
+
+/**
+ * Format an integer-cents amount as a localized currency string.
+ *
+ * All Reblu shop monetary values travel as integer cents (Prisma `Int`, never
+ * Decimal), so the SITE never sees floats. This helper is the single place that
+ * converts cents → major units and applies `Intl.NumberFormat`, keeping price
+ * rendering consistent across `ProductCard` and any future shop organism.
+ */
+declare function formatPrice(cents: number, currency?: string, locale?: string): string;
+
+/**
+ * Pure builders for the social-share targets used by `ShareButtons`.
+ *
+ * Framework-free so the URL construction is unit-testable without rendering.
+ * Every provider gets the canonical post URL; providers that support custom copy
+ * (X, WhatsApp) also receive the post title.
+ */
+interface ShareUrls {
+    linkedin: string;
+    x: string;
+    facebook: string;
+    whatsapp: string;
+}
+declare function buildShareUrls(url: string, title: string): ShareUrls;
+
+/**
+ * Canonical Blog markdown → **safe HTML** pipeline for the Reblu SITE SDK.
+ *
+ * Blog `content` arrives as raw Markdown (tiptap-markdown). This module owns the
+ * single, hardened conversion every SITE reuses instead of reinventing it:
+ *
+ *   Markdown ──(marked, GFM)──▶ HTML ──(DOMPurify)──▶ safe HTML
+ *
+ * DOMPurify is MANDATORY (XSS): the output is later parsed into React nodes by
+ * `MarkdownRenderer` (no `dangerouslySetInnerHTML`), but sanitising here means the
+ * string is safe regardless of how a consumer chooses to render it.
+ *
+ * `<iframe>` is the one non-default tag we allow, and ONLY when its `src` host is
+ * on the YouTube allowlist — every other embed (arbitrary iframes) is dropped.
+ */
+/** Hosts permitted for `<iframe>` embeds. Exact host match — no suffix tricks. */
+declare const ALLOWED_YOUTUBE_HOSTS: readonly string[];
+/** True when `src` is an absolute URL whose host is exactly a YouTube host. */
+declare function isAllowedYouTubeHost(src: string | null | undefined): boolean;
+/**
+ * Sanitise an already-HTML string with the same policy (default-safe tags plus a
+ * host-gated `<iframe>`). Use for content that arrives as HTML — e.g. page
+ * `section.contentHtml` from base-api, which is `marked` output that has NOT been
+ * sanitised server-side.
+ */
+declare function sanitizeHtml(html: string | null | undefined): string;
+/** Convert raw Markdown to sanitised, XSS-safe HTML. */
+declare function markdownToSafeHtml(markdown: string | null | undefined): string;
+
+/**
+ * `MarkdownRenderer` — the canonical Blog body renderer.
+ *
+ * Pipeline: raw Markdown → `markdownToSafeHtml` (marked → DOMPurify, XSS-safe) →
+ * `html-react-parser` into a token-styled React tree. We parse the sanitised HTML
+ * into real React nodes (a component map) rather than using
+ * `dangerouslySetInnerHTML`, so images lazy-load, external links are hardened, and
+ * YouTube embeds get a responsive aspect-ratio wrapper.
+ *
+ * RSC-safe: no hooks, no browser APIs — renders inside a Server Component.
+ * Styling is entirely token-driven (shadcn/OKLCH tokens); the block carries no
+ * brand aesthetic of its own.
+ */
+interface MarkdownRendererProps {
+    /** Raw Markdown (blog `content`). */
+    content: string | null | undefined;
+    className?: string;
+    /**
+     * Shift every heading down by this many levels (clamped to h6). Use `1` on a
+     * page that already renders its own `<h1>` so markdown `#` becomes `<h2>` and
+     * the page keeps a single h1.
+     */
+    headingOffset?: number;
+}
+declare function MarkdownRenderer({ content, className, headingOffset }: 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
+ * through `sanitizeHtml`/`markdownToSafeHtml`; this component does NOT sanitise, so
+ * never hand it untrusted HTML.
+ */
+interface SafeHtmlProps {
+    html: string | null | undefined;
+    className?: string;
+    headingOffset?: number;
+}
+declare function SafeHtml({ html, className, headingOffset }: SafeHtmlProps): react_jsx_runtime.JSX.Element | null;
+
+/**
+ * `Treatment` — full treatment page organism over a `PageDetail` (a SERVICE-type
+ * page). Renders the hero band followed by the ordered content sections.
+ * Token-driven, RSC-safe.
+ */
+interface TreatmentProps {
+    page: PageDetail;
+    className?: string;
+}
+declare function Treatment({ page, className }: TreatmentProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * `Specialty` — specialty page organism over a `PageDetail`. Like `Treatment` it
+ * renders a hero and content sections, but a specialty groups treatments, so it
+ * also renders an optional grid of the treatment pages under it (links to each
+ * treatment). Token-driven, RSC-safe.
+ */
+interface SpecialtyProps {
+    page: PageDetail;
+    /** Treatment pages under this specialty. Rendered as a linked grid when present. */
+    treatments?: PageListItem[];
+    /** Builds the href for a treatment page from its slug. Defaults to `/{slug}`. */
+    treatmentHref?: (slug: string) => string;
+    /** Heading for the treatments grid. Defaults to "Treatments". */
+    treatmentsLabel?: string;
+    className?: string;
+}
+declare function Specialty({ page, treatments, treatmentHref, treatmentsLabel, className, }: SpecialtyProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * `ProfileCard` — presentational professional/team-member card (the clinic
+ * "doctor card" from the mockups). There is no SITE API contract for staff yet,
+ * so the prop shape is local and intentionally minimal. Token-driven, RSC-safe.
+ */
+interface ProfileCardProps {
+    name: string;
+    role?: string;
+    imageUrl?: string;
+    /** Short list of specialties / tags shown as chips. */
+    specialties?: string[];
+    bio?: string;
+    /** 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;
+
+/**
+ * `ProductCard` — presentational shop product tile over `ShopProductListItem`.
+ *
+ * Token-driven, RSC-safe (no hooks). Prices arrive as integer cents and are
+ * formatted with {@link formatPrice}. A `comparePrice` higher than `price` renders
+ * as a struck-through "was" amount.
+ */
+interface ProductCardProps {
+    product: ShopProductListItem;
+    /** Link target for the product (e.g. `/shop/{slug}`). Omit to render non-linking. */
+    href?: string;
+    currencyCode?: string;
+    locale?: string;
+    className?: string;
+}
+declare function ProductCard({ product, href, currencyCode, locale, className }: ProductCardProps): react_jsx_runtime.JSX.Element;
+
+export { ALLOWED_YOUTUBE_HOSTS, MarkdownRenderer, type MarkdownRendererProps, ProductCard, type ProductCardProps, ProfileCard, type ProfileCardProps, SafeHtml, type SafeHtmlProps, type ShareUrls, Specialty, type SpecialtyProps, Treatment, type TreatmentProps, buildShareUrls, formatPrice, isAllowedYouTubeHost, markdownToSafeHtml, readingTime, sanitizeHtml };