@promptbook/javascript 0.112.0-23 → 0.112.0-24

package/esm/index.es.js

@@ -18,7 +18,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.112.0-23';
+const PROMPTBOOK_ENGINE_VERSION = '0.112.0-24';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/src/_packages/components.index.d.ts

@@ -16,6 +16,7 @@ import { AgentChat } from '../book-components/Chat/AgentChat/AgentChat';
 import type { AgentChatProps } from '../book-components/Chat/AgentChat/AgentChatProps';
 import { Chat } from '../book-components/Chat/Chat/Chat';
 import type { ChatFeedbackResponse } from '../book-components/Chat/Chat/ChatProps';
+import type { ChatFeedbackMode } from '../book-components/Chat/Chat/ChatProps';
 import type { ChatSoundSystem } from '../book-components/Chat/Chat/ChatProps';
 import type { ChatProps } from '../book-components/Chat/Chat/ChatProps';
 import { ChatSoundToggle } from '../book-components/Chat/Chat/ChatSoundToggle';
@@ -92,6 +93,7 @@ export { AgentChat };
 export type { AgentChatProps };
 export { Chat };
 export type { ChatFeedbackResponse };
+export type { ChatFeedbackMode };
 export type { ChatSoundSystem };
 export type { ChatProps };
 export { ChatSoundToggle };

package/esm/src/_packages/types.index.d.ts

@@ -17,6 +17,7 @@ import type { AgentChatProps } from '../book-components/Chat/AgentChat/AgentChat
 import type { AgentChipData } from '../book-components/Chat/AgentChip/AgentChip';
 import type { AgentChipProps } from '../book-components/Chat/AgentChip/AgentChip';
 import type { ChatFeedbackResponse } from '../book-components/Chat/Chat/ChatProps';
+import type { ChatFeedbackMode } from '../book-components/Chat/Chat/ChatProps';
 import type { ChatSoundSystem } from '../book-components/Chat/Chat/ChatProps';
 import type { ChatProps } from '../book-components/Chat/Chat/ChatProps';
 import type { ChatSoundToggleProps } from '../book-components/Chat/Chat/ChatSoundToggle';
@@ -440,6 +441,7 @@ export type { AgentChatProps };
 export type { AgentChipData };
 export type { AgentChipProps };
 export type { ChatFeedbackResponse };
+export type { ChatFeedbackMode };
 export type { ChatSoundSystem };
 export type { ChatProps };
 export type { ChatSoundToggleProps };

package/esm/src/book-components/Chat/Chat/ChatMessageItem.d.ts

@@ -26,6 +26,10 @@ type ChatMessageItemProps = Pick<ChatProps, 'onMessage' | 'onActionButton' | 'pa
      * Enables the feedback (rating) UI for this message bubble.
      */
     isFeedbackEnabled?: boolean;
+    /**
+     * Chooses which feedback controls should be rendered.
+     */
+    feedbackMode?: ChatProps['feedbackMode'];
     /**
      * Called when the copy button is pressed.
      */

package/esm/src/book-components/Chat/Chat/ChatMessageItem.test.d.ts

@@ -0,0 +1,2 @@
+/** @jest-environment jsdom */
+export {};

package/esm/src/book-components/Chat/Chat/ChatMessageList.d.ts

@@ -20,6 +20,10 @@ export type ChatMessageListProps = {
     mode: 'LIGHT' | 'DARK';
     isCopyButtonEnabled?: boolean;
     isFeedbackEnabled?: boolean;
+    /**
+     * Chooses which feedback controls should be rendered.
+     */
+    feedbackMode?: ChatProps['feedbackMode'];
     onCopy?: () => void;
     onMessage?: (messageContent: string) => Promisable<void>;
     onActionButton?: ChatProps['onActionButton'];

package/esm/src/book-components/Chat/Chat/ChatProps.d.ts

@@ -18,6 +18,12 @@ export type ChatFeedbackResponse = {
      */
     readonly message?: string;
 };
+/**
+ * Visual mode for post-response feedback actions.
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type ChatFeedbackMode = 'off' | 'stars' | 'report_issue';
 /**
  * Interface for sound system that can be passed to Chat component
  * This allows the chat to trigger sounds without tight coupling
@@ -275,11 +281,11 @@ export type ChatProps = {
     onCreateAgent?: (bookContent: string) => void;
     /**
      * Optional callback for handling user feedback on messages
-     * When provided, star rating buttons (1-5 stars) will be displayed next to each message
+     * When provided, message feedback actions are displayed according to `feedbackMode`.
      *
      * @param feedback - Object containing the feedback data
      * @param feedback.message - The message being rated
-     * @param feedback.rating - Star rating from 1 to 5
+     * @param feedback.rating - Numeric feedback rating value
      * @param feedback.textRating - Optional text feedback/note from user
      * @param feedback.chatThread - Complete chat thread as string
      * @param feedback.expectedAnswer - Optional expected answer provided by user
@@ -293,6 +299,12 @@ export type ChatProps = {
         expectedAnswer: string | null;
         url: string;
     }): Promisable<void>;
+    /**
+     * Selects which feedback action UI is shown on assistant responses.
+     *
+     * @default 'stars'
+     */
+    readonly feedbackMode?: ChatFeedbackMode;
     /**
      * Optional callback for handling file uploads
      * When provided, enables file upload functionality via drag-and-drop and file button

package/esm/src/book-components/Chat/Chat/ChatRatingModal.d.ts

@@ -1,5 +1,6 @@
 import type { id } from '../../../types/typeAliases';
 import type { ChatMessage } from '../types/ChatMessage';
+import type { ChatFeedbackMode } from './ChatProps';
 /**
  * Props for the rating modal used in Chat.
  *
@@ -13,6 +14,10 @@ export type ChatRatingModalProps = {
     hoveredRating: number;
     messageRatings: Map<id, number>;
     textRating: string;
+    /**
+     * Chooses which feedback flow the modal should render.
+     */
+    feedbackMode: ChatFeedbackMode;
     mode: 'LIGHT' | 'DARK';
     isMobile: boolean;
     onClose: () => void;

package/esm/src/book-components/Chat/SourceChip/SourceChip.d.ts

@@ -19,6 +19,10 @@ export type SourceChipProps = {
      * Optional suffix text to display after the citation label.
      */
     suffix?: string;
+    /**
+     * Controls whether the technical citation id is shown inside the chip label.
+     */
+    isCitationIdVisible?: boolean;
 };
 /**
  * SourceChip component - displays a chip with source document information
@@ -36,4 +40,4 @@ export type SourceChipProps = {
  *
  * @private utility of `ChatMessageItem` component
  */
-export declare function SourceChip({ citation, onClick, className, suffix }: SourceChipProps): import("react/jsx-runtime").JSX.Element;
+export declare function SourceChip({ citation, onClick, className, suffix, isCitationIdVisible }: SourceChipProps): import("react/jsx-runtime").JSX.Element;

package/esm/src/book-components/Chat/hooks/useChatRatings.d.ts

@@ -1,7 +1,7 @@
 import type { Promisable } from 'type-fest';
 import type { id } from '../../../types/typeAliases';
 import type { ChatMessage } from '../types/ChatMessage';
-import type { ChatFeedbackResponse } from '../Chat/ChatProps';
+import type { ChatFeedbackMode, ChatFeedbackResponse } from '../Chat/ChatProps';
 /**
  * Input parameters for the chat rating hook.
  *
@@ -23,6 +23,10 @@ export type UseChatRatingsOptions = {
         expectedAnswer: string | null;
         url: string;
     }) => Promisable<ChatFeedbackResponse | void>;
+    /**
+     * Feedback mode currently used by the chat UI.
+     */
+    feedbackMode: ChatFeedbackMode;
     /**
      * Whether the UI should apply mobile-specific behavior.
      */

package/esm/src/book-components/Chat/utils/createCitationFootnoteRenderModel.d.ts

@@ -0,0 +1,53 @@
+import type { ChatMessage } from '../types/ChatMessage';
+import { type ParsedCitation } from './parseCitationsFromContent';
+/**
+ * Minimal message shape required to derive inline citation references and footnotes.
+ *
+ * @private utility of `<Chat/>`
+ */
+type CitationFootnoteMessage = Pick<ChatMessage, 'content' | 'citations'>;
+/**
+ * One rendered citation footnote entry shown below the message body.
+ *
+ * @private utility of `<Chat/>`
+ */
+export type CitationFootnoteEntry = {
+    /**
+     * Visible footnote number assigned by first appearance in the message body.
+     */
+    readonly number: number;
+    /**
+     * Citation metadata rendered for this footnote.
+     */
+    readonly citation: ParsedCitation;
+};
+/**
+ * Render-ready message citation payload containing transformed content plus footnotes.
+ *
+ * @private utility of `<Chat/>`
+ */
+export type CitationFootnoteRenderModel = {
+    /**
+     * Markdown/HTML content with inline citation tokens replaced by numeric superscripts.
+     */
+    readonly content: ChatMessage['content'];
+    /**
+     * Deduplicated footnotes ordered by first appearance in the message body.
+     */
+    readonly footnotes: ReadonlyArray<CitationFootnoteEntry>;
+};
+/**
+ * Creates one render model that replaces raw citation tokens with numeric footnotes.
+ *
+ * Supported input markers:
+ * - OpenAI-style full markers that already include the document source name.
+ * - Bracketed id-only tokens, for example `[0:0]` or `[8:13]`
+ *
+ * Footnotes are deduplicated by document source while preserving the first-seen order.
+ *
+ * @param message - Message content plus optional structured citation metadata.
+ * @returns Render-ready content and matching footnote entries.
+ * @private utility of `<Chat/>`
+ */
+export declare function createCitationFootnoteRenderModel(message: CitationFootnoteMessage): CitationFootnoteRenderModel;
+export {};

package/esm/src/book-components/Chat/utils/createCitationFootnoteRenderModel.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.112.0-22`).
+ * It follows semantic versioning (e.g., `0.112.0-23`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/javascript",
-    "version": "0.112.0-23",
+    "version": "0.112.0-24",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -97,7 +97,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/javascript.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.112.0-23"
+        "@promptbook/core": "0.112.0-24"
     },
     "dependencies": {
         "crypto": "1.0.1",

package/umd/index.umd.js

@@ -22,7 +22,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.112.0-23';
+    const PROMPTBOOK_ENGINE_VERSION = '0.112.0-24';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name

package/umd/src/_packages/components.index.d.ts

@@ -16,6 +16,7 @@ import { AgentChat } from '../book-components/Chat/AgentChat/AgentChat';
 import type { AgentChatProps } from '../book-components/Chat/AgentChat/AgentChatProps';
 import { Chat } from '../book-components/Chat/Chat/Chat';
 import type { ChatFeedbackResponse } from '../book-components/Chat/Chat/ChatProps';
+import type { ChatFeedbackMode } from '../book-components/Chat/Chat/ChatProps';
 import type { ChatSoundSystem } from '../book-components/Chat/Chat/ChatProps';
 import type { ChatProps } from '../book-components/Chat/Chat/ChatProps';
 import { ChatSoundToggle } from '../book-components/Chat/Chat/ChatSoundToggle';
@@ -92,6 +93,7 @@ export { AgentChat };
 export type { AgentChatProps };
 export { Chat };
 export type { ChatFeedbackResponse };
+export type { ChatFeedbackMode };
 export type { ChatSoundSystem };
 export type { ChatProps };
 export { ChatSoundToggle };

package/umd/src/_packages/types.index.d.ts

@@ -17,6 +17,7 @@ import type { AgentChatProps } from '../book-components/Chat/AgentChat/AgentChat
 import type { AgentChipData } from '../book-components/Chat/AgentChip/AgentChip';
 import type { AgentChipProps } from '../book-components/Chat/AgentChip/AgentChip';
 import type { ChatFeedbackResponse } from '../book-components/Chat/Chat/ChatProps';
+import type { ChatFeedbackMode } from '../book-components/Chat/Chat/ChatProps';
 import type { ChatSoundSystem } from '../book-components/Chat/Chat/ChatProps';
 import type { ChatProps } from '../book-components/Chat/Chat/ChatProps';
 import type { ChatSoundToggleProps } from '../book-components/Chat/Chat/ChatSoundToggle';
@@ -440,6 +441,7 @@ export type { AgentChatProps };
 export type { AgentChipData };
 export type { AgentChipProps };
 export type { ChatFeedbackResponse };
+export type { ChatFeedbackMode };
 export type { ChatSoundSystem };
 export type { ChatProps };
 export type { ChatSoundToggleProps };

package/umd/src/book-components/Chat/Chat/ChatMessageItem.d.ts

@@ -26,6 +26,10 @@ type ChatMessageItemProps = Pick<ChatProps, 'onMessage' | 'onActionButton' | 'pa
      * Enables the feedback (rating) UI for this message bubble.
      */
     isFeedbackEnabled?: boolean;
+    /**
+     * Chooses which feedback controls should be rendered.
+     */
+    feedbackMode?: ChatProps['feedbackMode'];
     /**
      * Called when the copy button is pressed.
      */

package/umd/src/book-components/Chat/Chat/ChatMessageItem.test.d.ts

@@ -0,0 +1,2 @@
+/** @jest-environment jsdom */
+export {};

package/umd/src/book-components/Chat/Chat/ChatMessageList.d.ts

@@ -20,6 +20,10 @@ export type ChatMessageListProps = {
     mode: 'LIGHT' | 'DARK';
     isCopyButtonEnabled?: boolean;
     isFeedbackEnabled?: boolean;
+    /**
+     * Chooses which feedback controls should be rendered.
+     */
+    feedbackMode?: ChatProps['feedbackMode'];
     onCopy?: () => void;
     onMessage?: (messageContent: string) => Promisable<void>;
     onActionButton?: ChatProps['onActionButton'];

package/umd/src/book-components/Chat/Chat/ChatProps.d.ts

@@ -18,6 +18,12 @@ export type ChatFeedbackResponse = {
      */
     readonly message?: string;
 };
+/**
+ * Visual mode for post-response feedback actions.
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type ChatFeedbackMode = 'off' | 'stars' | 'report_issue';
 /**
  * Interface for sound system that can be passed to Chat component
  * This allows the chat to trigger sounds without tight coupling
@@ -275,11 +281,11 @@ export type ChatProps = {
     onCreateAgent?: (bookContent: string) => void;
     /**
      * Optional callback for handling user feedback on messages
-     * When provided, star rating buttons (1-5 stars) will be displayed next to each message
+     * When provided, message feedback actions are displayed according to `feedbackMode`.
      *
      * @param feedback - Object containing the feedback data
      * @param feedback.message - The message being rated
-     * @param feedback.rating - Star rating from 1 to 5
+     * @param feedback.rating - Numeric feedback rating value
      * @param feedback.textRating - Optional text feedback/note from user
      * @param feedback.chatThread - Complete chat thread as string
      * @param feedback.expectedAnswer - Optional expected answer provided by user
@@ -293,6 +299,12 @@ export type ChatProps = {
         expectedAnswer: string | null;
         url: string;
     }): Promisable<void>;
+    /**
+     * Selects which feedback action UI is shown on assistant responses.
+     *
+     * @default 'stars'
+     */
+    readonly feedbackMode?: ChatFeedbackMode;
     /**
      * Optional callback for handling file uploads
      * When provided, enables file upload functionality via drag-and-drop and file button

package/umd/src/book-components/Chat/Chat/ChatRatingModal.d.ts

@@ -1,5 +1,6 @@
 import type { id } from '../../../types/typeAliases';
 import type { ChatMessage } from '../types/ChatMessage';
+import type { ChatFeedbackMode } from './ChatProps';
 /**
  * Props for the rating modal used in Chat.
  *
@@ -13,6 +14,10 @@ export type ChatRatingModalProps = {
     hoveredRating: number;
     messageRatings: Map<id, number>;
     textRating: string;
+    /**
+     * Chooses which feedback flow the modal should render.
+     */
+    feedbackMode: ChatFeedbackMode;
     mode: 'LIGHT' | 'DARK';
     isMobile: boolean;
     onClose: () => void;

package/umd/src/book-components/Chat/SourceChip/SourceChip.d.ts

@@ -19,6 +19,10 @@ export type SourceChipProps = {
      * Optional suffix text to display after the citation label.
      */
     suffix?: string;
+    /**
+     * Controls whether the technical citation id is shown inside the chip label.
+     */
+    isCitationIdVisible?: boolean;
 };
 /**
  * SourceChip component - displays a chip with source document information
@@ -36,4 +40,4 @@ export type SourceChipProps = {
  *
  * @private utility of `ChatMessageItem` component
  */
-export declare function SourceChip({ citation, onClick, className, suffix }: SourceChipProps): import("react/jsx-runtime").JSX.Element;
+export declare function SourceChip({ citation, onClick, className, suffix, isCitationIdVisible }: SourceChipProps): import("react/jsx-runtime").JSX.Element;

package/umd/src/book-components/Chat/hooks/useChatRatings.d.ts

@@ -1,7 +1,7 @@
 import type { Promisable } from 'type-fest';
 import type { id } from '../../../types/typeAliases';
 import type { ChatMessage } from '../types/ChatMessage';
-import type { ChatFeedbackResponse } from '../Chat/ChatProps';
+import type { ChatFeedbackMode, ChatFeedbackResponse } from '../Chat/ChatProps';
 /**
  * Input parameters for the chat rating hook.
  *
@@ -23,6 +23,10 @@ export type UseChatRatingsOptions = {
         expectedAnswer: string | null;
         url: string;
     }) => Promisable<ChatFeedbackResponse | void>;
+    /**
+     * Feedback mode currently used by the chat UI.
+     */
+    feedbackMode: ChatFeedbackMode;
     /**
      * Whether the UI should apply mobile-specific behavior.
      */

package/umd/src/book-components/Chat/utils/createCitationFootnoteRenderModel.d.ts

@@ -0,0 +1,53 @@
+import type { ChatMessage } from '../types/ChatMessage';
+import { type ParsedCitation } from './parseCitationsFromContent';
+/**
+ * Minimal message shape required to derive inline citation references and footnotes.
+ *
+ * @private utility of `<Chat/>`
+ */
+type CitationFootnoteMessage = Pick<ChatMessage, 'content' | 'citations'>;
+/**
+ * One rendered citation footnote entry shown below the message body.
+ *
+ * @private utility of `<Chat/>`
+ */
+export type CitationFootnoteEntry = {
+    /**
+     * Visible footnote number assigned by first appearance in the message body.
+     */
+    readonly number: number;
+    /**
+     * Citation metadata rendered for this footnote.
+     */
+    readonly citation: ParsedCitation;
+};
+/**
+ * Render-ready message citation payload containing transformed content plus footnotes.
+ *
+ * @private utility of `<Chat/>`
+ */
+export type CitationFootnoteRenderModel = {
+    /**
+     * Markdown/HTML content with inline citation tokens replaced by numeric superscripts.
+     */
+    readonly content: ChatMessage['content'];
+    /**
+     * Deduplicated footnotes ordered by first appearance in the message body.
+     */
+    readonly footnotes: ReadonlyArray<CitationFootnoteEntry>;
+};
+/**
+ * Creates one render model that replaces raw citation tokens with numeric footnotes.
+ *
+ * Supported input markers:
+ * - OpenAI-style full markers that already include the document source name.
+ * - Bracketed id-only tokens, for example `[0:0]` or `[8:13]`
+ *
+ * Footnotes are deduplicated by document source while preserving the first-seen order.
+ *
+ * @param message - Message content plus optional structured citation metadata.
+ * @returns Render-ready content and matching footnote entries.
+ * @private utility of `<Chat/>`
+ */
+export declare function createCitationFootnoteRenderModel(message: CitationFootnoteMessage): CitationFootnoteRenderModel;
+export {};

package/umd/src/book-components/Chat/utils/createCitationFootnoteRenderModel.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.112.0-22`).
+ * It follows semantic versioning (e.g., `0.112.0-23`).
  *
  * @generated
  */