Skip to content

feat(davinci-client): rich-text-collector #568

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ryanbas21 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat(davinci-client): rich-text-collector #568

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
613e21a
feat(davinci-client): add RichContent types to ReadOnlyField
ryanbas21 Apr 13, 2026
099321c
chore: nxignore .opensource dir and preserve richtext newlines
ryanbas21 Apr 22, 2026
d8d7997
chore: pr-comments
ryanbas21 Apr 28, 2026
08a8bcd
chore: pr-comments [Self-Healing CI Rerun]
nx-cloud[bot] Apr 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .changeset/rich-content-links.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
'@forgerock/davinci-client': minor
---

**Breaking change**: `ReadOnlyCollector.output.content` now returns a plain `string` (the label text) instead of `ContentPart[]`.
Copy link
Copy Markdown
Collaborator

@ancheetah ancheetah May 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the language is a little off in this comment. There was never a content property on the collector. content was on the DaVinci field. I also don't think we have an interface called ContentPart.

That said, should we consider a new type of collector RichTextCollector to avoid this breaking change and a major bump?


A new `ReadOnlyCollector.output.richContent` property is always present and contains the structured link data when a LABEL field includes `richContent`. Its shape is `CollectorRichContent` — a template string with `{{key}}` placeholders (`content`) and a validated `replacements` array (`ValidatedReplacement[]`). When no `richContent` is present, `replacements` is an empty array.

**Removed type exports**: `ContentPart`, `TextContentPart`, `LinkContentPart`

**New type exports**: `RichContentLink`, `ValidatedReplacement`, `CollectorRichContent`

Includes href protocol validation that rejects unsafe URI schemes (e.g. `javascript:`, `data:`).
Comment on lines +1 to +13
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Apr 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Make this changeset a major bump.

The note explicitly documents a breaking API change (ReadOnlyCollector.output.content changes type), but the frontmatter is still minor. That will under-version @forgerock/davinci-client.

Suggested fix 
- '@forgerock/davinci-client': minor
+ '@forgerock/davinci-client': major
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In @.changeset/rich-content-links.md around lines 1 - 13, Update the changeset
frontmatter for '@forgerock/davinci-client' from "minor" to "major" because the
documented breaking change (ReadOnlyCollector.output.content changing type)
requires a major version bump; modify the top YAML block so the package entry
reads "'@forgerock/davinci-client': major" and keep the rest of the changeset
content intact.

1 change: 1 addition & 0 deletions .nxignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.opensource/
1 change: 1 addition & 0 deletions .opensource/forgerock-javascript-sdk
Open in desktop
Copy link
Copy Markdown
Collaborator

@ancheetah ancheetah May 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this file? Do we want to include it?

Submodule forgerock-javascript-sdk added at 1e3f0d
38 changes: 36 additions & 2 deletions e2e/davinci-app/components/label.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,43 @@
import type { ReadOnlyCollector } from '@forgerock/davinci-client/types';

export default function (formEl: HTMLFormElement, collector: ReadOnlyCollector) {
// create paragraph element with text of "Loading ... "
const p = document.createElement('p');
p.style.whiteSpace = 'pre-line';
const { richContent } = collector.output;

if (richContent.replacements.length === 0) {
p.innerText = collector.output.content;
formEl?.appendChild(p);
return;
}

// Interpolate the template by splitting on {{key}} and inserting links
const segments = richContent.content.split(/\{\{(\w+)\}\}/);
const replacementMap = new Map(richContent.replacements.map((r) => [r.key, r]));

for (let i = 0; i < segments.length; i++) {
if (i % 2 === 0) {
// Text segment
if (segments[i]) {
p.appendChild(document.createTextNode(segments[i]));
}
} else {
// Replacement key
const replacement = replacementMap.get(segments[i]);
if (replacement?.type === 'link') {
const a = document.createElement('a');
a.href = replacement.href;
a.textContent = replacement.value;
if (replacement.target) {
a.target = replacement.target;
if (replacement.target === '_blank') {
a.rel = 'noopener noreferrer';
}
}
p.appendChild(a);
}
}
Comment on lines +20 to +45
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Apr 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Preserve unmatched placeholders instead of dropping them.

The loop currently skips any token without a matching link replacement, so a typo or unsupported placeholder silently disappears from the rendered label. The \w+ matcher also excludes keys containing punctuation.

♻️ Suggested fix 
       const replacement = replacementMap.get(segments[i]);
       if (replacement?.type === 'link') {
         const a = document.createElement('a');
         a.href = replacement.href;
         a.textContent = replacement.value;
         if (replacement.target) {
           a.target = replacement.target;
           if (replacement.target === '_blank') {
             a.rel = 'noopener noreferrer';
           }
         }
         p.appendChild(a);
+      } else {
+        p.appendChild(document.createTextNode(`{{${segments[i]}}}`));
       }
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@e2e/davinci-app/components/label.ts` around lines 20 - 45, The loop currently
drops unmatched placeholders and the regex /\{\{(\w+)\}\}/ only matches word
chars; change the regex to capture any non-} key (e.g. /\{\{([^}]+)\}\}/) so
keys with punctuation are preserved, and when no replacement is found
(replacementMap.get(...) is undefined) append the original placeholder string
(`'{{' + key + '}}'`) as a text node instead of skipping it; update the code
locations using variables/identifiers segments, replacementMap,
richContent.content and richContent.replacements, and the for loop handling
replacement/type === 'link' to implement this behavior.

}

p.innerText = collector.output.label;
formEl?.appendChild(p);
}
93 changes: 60 additions & 33 deletions packages/davinci-client/api-report/davinci-client.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,14 @@ export interface CollectorErrors {
target: string;
}

// @public
export interface CollectorRichContent {
// (undocumented)
content: string;
// (undocumented)
replacements: RichContentLink[];
}

// @public (undocumented)
export type Collectors = FlowCollector | PasswordCollector | TextCollector | SingleSelectCollector | IdpCollector | SubmitCollector | ActionCollector<'ActionCollector'> | SingleValueCollector<'SingleValueCollector'> | MultiSelectCollector | DeviceAuthenticationCollector | DeviceRegistrationCollector | PhoneNumberCollector | ReadOnlyCollector | ValidatedTextCollector | ProtectCollector | PollingCollector | FidoRegistrationCollector | FidoAuthenticationCollector | QrCodeCollector | AgreementCollector | UnknownCollector;

Expand Down Expand Up @@ -267,13 +275,11 @@ export function davinci<ActionType extends ActionTypes = ActionTypes>(input: {
resume: (input: {
continueToken: string;
}) => Promise<InternalErrorResponse | NodeStates>;
start: <QueryParams extends OutgoingQueryParams = OutgoingQueryParams>(options?: StartOptions<QueryParams> | undefined) => Promise<ContinueNode | StartNode | ErrorNode | FailureNode | SuccessNode>;
start: <QueryParams extends OutgoingQueryParams = OutgoingQueryParams>(options?: StartOptions<QueryParams> | undefined) => Promise<ContinueNode | ErrorNode | FailureNode | StartNode | SuccessNode>;
update: <T extends SingleValueCollectors | MultiSelectCollector | ObjectValueCollectors | AutoCollectors>(collector: T) => Updater<T>;
validate: (collector: SingleValueCollectors | ObjectValueCollectors | MultiValueCollectors | AutoCollectors) => Validator;
poll: (collector: PollingCollector) => Poller;
getClient: () => {
status: "start";
} | {
action: string;
collectors: Collectors[];
description?: string;
Expand All @@ -287,6 +293,8 @@ export function davinci<ActionType extends ActionTypes = ActionTypes>(input: {
status: "error";
} | {
status: "failure";
} | {
status: "start";
} | {
authorization?: {
code?: string;
Expand All @@ -297,7 +305,7 @@ export function davinci<ActionType extends ActionTypes = ActionTypes>(input: {
getCollectors: () => Collectors[];
getError: () => DaVinciError | null;
getErrorCollectors: () => CollectorErrors[];
getNode: () => ContinueNode | StartNode | ErrorNode | FailureNode | SuccessNode;
getNode: () => ContinueNode | ErrorNode | FailureNode | StartNode | SuccessNode;
getServer: () => {
_links?: Links;
id?: string;
Expand All @@ -306,8 +314,6 @@ export function davinci<ActionType extends ActionTypes = ActionTypes>(input: {
href?: string;
eventName?: string;
status: "continue";
} | {
status: "start";
} | {
_links?: Links;
eventName?: string;
Expand All @@ -323,6 +329,8 @@ export function davinci<ActionType extends ActionTypes = ActionTypes>(input: {
interactionId?: string;
interactionToken?: string;
status: "failure";
} | {
status: "start";
} | {
_links?: Links;
eventName?: string;
Expand Down Expand Up @@ -1029,7 +1037,7 @@ export type InferAutoCollectorType<T extends AutoCollectorTypes> = T extends 'Pr
export type InferMultiValueCollectorType<T extends MultiValueCollectorTypes> = T extends 'MultiSelectCollector' ? MultiValueCollectorWithValue<'MultiSelectCollector'> : MultiValueCollectorWithValue<'MultiValueCollector'> | MultiValueCollectorNoValue<'MultiValueCollector'>;

// @public
export type InferNoValueCollectorType<T extends NoValueCollectorTypes> = T extends 'ReadOnlyCollector' ? NoValueCollectorBase<'ReadOnlyCollector'> : T extends 'QrCodeCollector' ? QrCodeCollectorBase : T extends 'AgreementCollector' ? AgreementCollector : NoValueCollectorBase<'NoValueCollector'>;
export type InferNoValueCollectorType<T extends NoValueCollectorTypes> = T extends 'ReadOnlyCollector' ? ReadOnlyCollector : T extends 'QrCodeCollector' ? QrCodeCollector : T extends 'AgreementCollector' ? AgreementCollector : NoValueCollectorBase<'NoValueCollector'>;

// @public
export type InferSingleValueCollectorType<T extends SingleValueCollectorTypes> = T extends 'TextCollector' ? TextCollector : T extends 'SingleSelectCollector' ? SingleSelectCollector : T extends 'ValidatedTextCollector' ? ValidatedTextCollector : T extends 'PasswordCollector' ? PasswordCollector : SingleValueCollectorWithValue<'SingleValueCollector'> | SingleValueCollectorNoValue<'SingleValueCollector'>;
Expand Down Expand Up @@ -1170,15 +1178,15 @@ value: Record<string, unknown>;
}, string>;

// @public
export const nodeCollectorReducer: Reducer<(TextCollector | SingleSelectCollector | ValidatedTextCollector | PasswordCollector | MultiSelectCollector | DeviceAuthenticationCollector | DeviceRegistrationCollector | PhoneNumberCollector | IdpCollector | SubmitCollector | FlowCollector | QrCodeCollectorBase | AgreementCollector | ReadOnlyCollector | UnknownCollector | ProtectCollector | FidoRegistrationCollector | FidoAuthenticationCollector | PollingCollector | ActionCollector<"ActionCollector"> | SingleValueCollector<"SingleValueCollector">)[]> & {
getInitialState: () => (TextCollector | SingleSelectCollector | ValidatedTextCollector | PasswordCollector | MultiSelectCollector | DeviceAuthenticationCollector | DeviceRegistrationCollector | PhoneNumberCollector | IdpCollector | SubmitCollector | FlowCollector | QrCodeCollectorBase | AgreementCollector | ReadOnlyCollector | UnknownCollector | ProtectCollector | FidoRegistrationCollector | FidoAuthenticationCollector | PollingCollector | ActionCollector<"ActionCollector"> | SingleValueCollector<"SingleValueCollector">)[];
export const nodeCollectorReducer: Reducer<(TextCollector | SingleSelectCollector | ValidatedTextCollector | PasswordCollector | MultiSelectCollector | DeviceAuthenticationCollector | DeviceRegistrationCollector | PhoneNumberCollector | IdpCollector | SubmitCollector | FlowCollector | QrCodeCollector | ReadOnlyCollector | AgreementCollector | UnknownCollector | ProtectCollector | FidoRegistrationCollector | FidoAuthenticationCollector | PollingCollector | ActionCollector<"ActionCollector"> | SingleValueCollector<"SingleValueCollector">)[]> & {
getInitialState: () => (TextCollector | SingleSelectCollector | ValidatedTextCollector | PasswordCollector | MultiSelectCollector | DeviceAuthenticationCollector | DeviceRegistrationCollector | PhoneNumberCollector | IdpCollector | SubmitCollector | FlowCollector | QrCodeCollector | ReadOnlyCollector | AgreementCollector | UnknownCollector | ProtectCollector | FidoRegistrationCollector | FidoAuthenticationCollector | PollingCollector | ActionCollector<"ActionCollector"> | SingleValueCollector<"SingleValueCollector">)[];
};

// @public (undocumented)
export type NodeStates = StartNode | ContinueNode | ErrorNode | SuccessNode | FailureNode;

// @public (undocumented)
export type NoValueCollector<T extends NoValueCollectorTypes> = NoValueCollectorBase<T>;
export type NoValueCollector<T extends NoValueCollectorTypes> = InferNoValueCollectorType<T>;

// @public (undocumented)
export interface NoValueCollectorBase<T extends NoValueCollectorTypes> {
Expand All @@ -1201,7 +1209,7 @@ export interface NoValueCollectorBase<T extends NoValueCollectorTypes> {
}

// @public (undocumented)
export type NoValueCollectors = NoValueCollectorBase<'NoValueCollector'> | NoValueCollectorBase<'ReadOnlyCollector'> | QrCodeCollectorBase | AgreementCollector;
export type NoValueCollectors = NoValueCollectorBase<'NoValueCollector'> | ReadOnlyCollector | QrCodeCollector | AgreementCollector;

// @public
export type NoValueCollectorTypes = 'ReadOnlyCollector' | 'NoValueCollector' | 'QrCodeCollector' | 'AgreementCollector';
Expand Down Expand Up @@ -1415,28 +1423,12 @@ export interface ProtectOutputValue {
universalDeviceIdentification: boolean;
}

// @public (undocumented)
export type QrCodeCollector = QrCodeCollectorBase;

// @public (undocumented)
export interface QrCodeCollectorBase {
// (undocumented)
category: 'NoValueCollector';
// (undocumented)
error: string | null;
// (undocumented)
id: string;
// (undocumented)
name: string;
// @public
export interface QrCodeCollector extends NoValueCollectorBase<'QrCodeCollector'> {
// (undocumented)
output: {
key: string;
label: string;
type: string;
output: NoValueCollectorBase<'QrCodeCollector'>['output'] & {
src: string;
};
// (undocumented)
type: 'QrCodeCollector';
}

// @public (undocumented)
Expand All @@ -1447,13 +1439,20 @@ export type QrCodeField = {
fallbackText?: string;
};

// @public (undocumented)
export type ReadOnlyCollector = NoValueCollectorBase<'ReadOnlyCollector'>;
// @public
export interface ReadOnlyCollector extends NoValueCollectorBase<'ReadOnlyCollector'> {
// (undocumented)
output: NoValueCollectorBase<'ReadOnlyCollector'>['output'] & {
content: string;
richContent: CollectorRichContent;
};
}

// @public (undocumented)
// @public
export type ReadOnlyField = {
type: 'LABEL';
content: string;
richContent?: RichContent;
key?: string;
};

Expand All @@ -1473,6 +1472,34 @@ export type RedirectFields = RedirectField;

export { RequestMiddleware }

// @public
export type RichContent = {
content: string;
replacements?: Record<string, RichContentReplacement>;
};

// @public
export interface RichContentLink {
// (undocumented)
href: string;
// (undocumented)
key: string;
// (undocumented)
target?: '_self' | '_blank';
// (undocumented)
type: 'link';
// (undocumented)
value: string;
}

// @public
export type RichContentReplacement = {
type: 'link';
value: string;
href: string;
target?: '_self' | '_blank';
};

// @public (undocumented)
export interface SelectorOption {
// (undocumented)
Expand Down
Loading
Loading