@rightkit/doc-render 0.1.0 → 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.1 — 2026-10-07
+
+- `buildBlocks(nodes, { hintPrefixes })` limits which `<!-- PREFIX: KIND -->` comments count as explicit hints (default `["doc", "viewright"]`). ViewRight passes `["viewright"]` for exact parity.

package/dist/detectors/index.d.ts

@@ -12,6 +12,10 @@ export type Block = {
     kind: "plain";
     nodes: RootContent[];
 };
+export interface BuildBlocksOptions {
+    /** Comment prefixes accepted for explicit hints (`<!-- PREFIX: KIND -->`). Default `["doc", "viewright"]`. */
+    hintPrefixes?: readonly string[];
+}
 /**
  * The confidence gate. Walks top-level nodes, runs detectors, and decides per block:
  *   - hit at/above threshold (or forced by a hint) → semantic component
@@ -19,4 +23,4 @@ export type Block = {
  *   - no hit                                       → plain markdown
  * Returns a flat block list the renderer maps to React.
  */
-export declare function buildBlocks(nodes: RootContent[]): Block[];
+export declare function buildBlocks(nodes: RootContent[], options?: BuildBlocksOptions): Block[];

package/dist/detectors/index.js

@@ -17,11 +17,17 @@ const DETECTORS = [
     comparisonDetector,
     stepperDetector,
 ];
-const HINT_RE = /<!--\s*(?:doc|viewright):\s*(frontmatter|callout|stepper|comparison|faq|richTable|descriptionList)\s*-->/i;
-function parseHint(node) {
+const HINT_KINDS = "frontmatter|callout|stepper|comparison|faq|richTable|descriptionList";
+const DEFAULT_HINT_PREFIXES = ["doc", "viewright"];
+function hintPattern(prefixes) {
+    const names = prefixes.map((p) => p.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")).join("|");
+    return new RegExp(`<!--\\s*(?:${names}):\\s*(${HINT_KINDS})\\s*-->`, "i");
+}
+const DEFAULT_HINT_RE = hintPattern(DEFAULT_HINT_PREFIXES);
+function parseHint(node, re) {
     if (node.type !== "html")
         return null;
-    const m = HINT_RE.exec(node.value ?? "");
+    const m = re.exec(node.value ?? "");
     return m ? m[1] : null;
 }
 /**
@@ -31,7 +37,8 @@ function parseHint(node) {
  *   - no hit                                       → plain markdown
  * Returns a flat block list the renderer maps to React.
  */
-export function buildBlocks(nodes) {
+export function buildBlocks(nodes, options = {}) {
+    const hintRe = options.hintPrefixes ? hintPattern(options.hintPrefixes) : DEFAULT_HINT_RE;
     const blocks = [];
     let pendingHint = null;
     let plainRun = [];
@@ -44,7 +51,7 @@ export function buildBlocks(nodes) {
     let i = 0;
     while (i < nodes.length) {
         const node = nodes[i];
-        const hint = parseHint(node);
+        const hint = parseHint(node, hintRe);
         if (hint) {
             pendingHint = hint;
             i += 1; // the hint comment itself never renders

package/dist/index.d.ts

@@ -7,7 +7,7 @@ export { collectFootnotes } from "./footnotes.js";
 export { formatCitation, formatBibliographyEntry, formatNames, formatYear, buildBibliographyMap } from "./citations/formatter.js";
 export type { CslEntry, CslName, BibliographyEntry, CitationMatch } from "./citations/types.js";
 export { buildBlocks } from "./detectors/index.js";
-export type { Block } from "./detectors/index.js";
+export type { Block, BuildBlocksOptions } from "./detectors/index.js";
 export type { Detector, DetectorHit, SemanticKind } from "./detectors/types.js";
 export { remarkCitations } from "./remarkCitations.js";
 export { remarkDefListAbbr } from "./remarkDefListAbbr.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rightkit/doc-render",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Brand-neutral, read-only document renderer (Markdown, sanitized HTML, safe email frame) for Right Suite readers.",
   "license": "MIT OR Apache-2.0",
   "type": "module",
@@ -18,7 +18,8 @@
     "styles.css",
     "README.md",
     "LICENSE-MIT",
-    "LICENSE-APACHE"
+    "LICENSE-APACHE",
+    "CHANGELOG.md"
   ],
   "sideEffects": [
     "*.css"