@opencxh/ui-kit 3.180.0 → 3.182.1

package/dist/src/content/RichText.d.ts

@@ -1,3 +1,4 @@
+import { MentionRef } from './richTextMentions';
 export interface RichTextProps {
     /** Markdown or HTML; which of the two is auto-detected. */
     text: string | null | undefined;
@@ -6,6 +7,14 @@ export interface RichTextProps {
     /** Force a branch instead of detecting — only when the heuristic gets in
      * the way (e.g. plain text that happens to look like a tag). */
     as?: "markdown" | "html";
+    /**
+     * People whose `@Name` should render as a chip when the text is plain.
+     *
+     * Only the markdown branch needs it: text stored by the composer already carries its chips
+     * as markup. Pass the names behind a comment's `payload.mentions` and an older comment, or
+     * one an agent wrote, highlights the same way a fresh one does.
+     */
+    mentions?: MentionRef[];
 }
 /** Safely rendered markdown-or-HTML text. */
-export declare function RichText({ text, className, as }: RichTextProps): import("react").JSX.Element;
+export declare function RichText({ text, className, as, mentions }: RichTextProps): import("react").JSX.Element;

package/dist/src/content/richTextMentions.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Turn `@Name` in plain comment text into a mention chip, at render time.
+ *
+ * The composer already stores chips as markup, so a *new* comment needs none of this. This is
+ * for every other way a comment reaches the feed: one written before the markup existed, and
+ * one an agent wrote as markdown. Those arrive as text, and the name in them is only a name.
+ *
+ * Runs as a rehype pass rather than a string replace on the source, because injecting a tag
+ * into the text would flip `RichText` to its HTML branch and leave an agent's markdown
+ * rendering as literal asterisks.
+ */
+/** Who may be chipped. The id rides along so a chip can later become a link to a person. */
+export interface MentionRef {
+    id: string;
+    name: string;
+}
+interface TextNode {
+    type: "text";
+    value: string;
+    children?: undefined;
+}
+interface ElementNode {
+    type: "element";
+    tagName: string;
+    properties?: Record<string, unknown>;
+    children?: Node[];
+}
+interface OtherNode {
+    type: string;
+    children?: Node[];
+}
+type Node = TextNode | ElementNode | OtherNode;
+/**
+ * A rehype plugin that chips every `@Name` it is told about.
+ *
+ * Longest name first: with both "Jan" and "Jan de Vries" on the list, matching the short one
+ * would chip half of the long one and leave " de Vries" hanging outside it.
+ */
+export declare function rehypeMentions(mentions: MentionRef[]): () => (tree: Node) => void;
+export {};

package/dist/src/index.d.ts

@@ -22,6 +22,7 @@ export { Page, type PageProps } from './content/Page';
 export { PageHeader, type PageHeaderAction, type PageHeaderProps, } from './content/PageHeader';
 export { PageToolbar, PageToolbarActions, type PageToolbarActionsProps, type PageToolbarProps, } from './content/PageToolbar';
 export { RichText, type RichTextProps } from './content/RichText';
+export type { MentionRef } from './content/richTextMentions';
 export { SectionCaption, type SectionCaptionProps } from './content/SectionCaption';
 export { SectionDivider, type SectionDividerProps } from './content/SectionDivider';
 export { type SettingsFrameApi, SettingsFrameProvider, SettingsPage, type SettingsPageProps, type SettingsTrailEntry, useSettingsFrame, useSettingsFrameHost, } from './content/SettingsPage';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opencxh/ui-kit",
-  "version": "3.180.0",
+  "version": "3.182.1",
   "description": "Theme-aware UI component library for OpenCXH platform",
   "type": "module",
   "exports": {