@reblu/site-blocks 0.13.0 → 0.14.0

package/dist/seo.d.cts

@@ -44,4 +44,25 @@ declare function buildFaqPageJsonLd(items: readonly FaqItem[]): FaqPageJsonLd |
  */
 declare function collectFaqItems(blocks: readonly PageBlock[] | null | undefined): FaqItem[];
 
-export { type FaqItem, type FaqPageJsonLd, buildFaqPageJsonLd, collectFaqItems };
+interface MarkdownToPlainTextOptions {
+    /**
+     * Maximum length of the result, ellipsis included. Longer text is cut at the
+     * last word boundary that fits and ends in `…`. Omit for no limit.
+     */
+    maxLength?: number;
+}
+/**
+ * Markdown → the plain text a reader sees, for places that cannot render markup:
+ * a `<meta name="description">`, an Open Graph description, a card excerpt.
+ *
+ * REB-879: a course description is rich text now (headings, GFM tables, images),
+ * so slicing the raw Markdown would put `##`, table pipes and `![…](…)` into a
+ * search snippet. This runs the SAME sanitised pipeline as `MarkdownRenderer`
+ * (`markdownToSafeHtml`) and keeps only its text, so it can never surface
+ * anything the renderer would have stripped (a `<script>` body, an attribute).
+ * Images contribute nothing; block elements and table cells are separated by a
+ * single space. Pure and directive-free: safe in `generateMetadata`.
+ */
+declare function markdownToPlainText(markdown: string | null | undefined, { maxLength }?: MarkdownToPlainTextOptions): string;
+
+export { type FaqItem, type FaqPageJsonLd, type MarkdownToPlainTextOptions, buildFaqPageJsonLd, collectFaqItems, markdownToPlainText };

package/dist/seo.d.ts

@@ -44,4 +44,25 @@ declare function buildFaqPageJsonLd(items: readonly FaqItem[]): FaqPageJsonLd |
  */
 declare function collectFaqItems(blocks: readonly PageBlock[] | null | undefined): FaqItem[];
 
-export { type FaqItem, type FaqPageJsonLd, buildFaqPageJsonLd, collectFaqItems };
+interface MarkdownToPlainTextOptions {
+    /**
+     * Maximum length of the result, ellipsis included. Longer text is cut at the
+     * last word boundary that fits and ends in `…`. Omit for no limit.
+     */
+    maxLength?: number;
+}
+/**
+ * Markdown → the plain text a reader sees, for places that cannot render markup:
+ * a `<meta name="description">`, an Open Graph description, a card excerpt.
+ *
+ * REB-879: a course description is rich text now (headings, GFM tables, images),
+ * so slicing the raw Markdown would put `##`, table pipes and `![…](…)` into a
+ * search snippet. This runs the SAME sanitised pipeline as `MarkdownRenderer`
+ * (`markdownToSafeHtml`) and keeps only its text, so it can never surface
+ * anything the renderer would have stripped (a `<script>` body, an attribute).
+ * Images contribute nothing; block elements and table cells are separated by a
+ * single space. Pure and directive-free: safe in `generateMetadata`.
+ */
+declare function markdownToPlainText(markdown: string | null | undefined, { maxLength }?: MarkdownToPlainTextOptions): string;
+
+export { type FaqItem, type FaqPageJsonLd, type MarkdownToPlainTextOptions, buildFaqPageJsonLd, collectFaqItems, markdownToPlainText };