@promptbook/javascript 0.106.0-0 → 0.108.0-0

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.106.0-0';
+const PROMPTBOOK_ENGINE_VERSION = '0.108.0-0';
 /**
  * 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/typings/src/_packages/components.index.d.ts

@@ -8,6 +8,8 @@ import { AvatarProfile } from '../book-components/AvatarProfile/AvatarProfile/Av
 import type { AvatarProfileFromSourceProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
 import { AvatarProfileFromSource } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
 import { DEFAULT_BOOK_EDITOR_HEIGHT } from '../book-components/BookEditor/BookEditor';
+import type { BookEditorUploadProgressCallback } from '../book-components/BookEditor/BookEditor';
+import type { BookEditorUploadOptions } from '../book-components/BookEditor/BookEditor';
 import type { BookEditorProps } from '../book-components/BookEditor/BookEditor';
 import { BookEditor } from '../book-components/BookEditor/BookEditor';
 import { AgentChat } from '../book-components/Chat/AgentChat/AgentChat';
@@ -76,6 +78,8 @@ export { AvatarProfile };
 export type { AvatarProfileFromSourceProps };
 export { AvatarProfileFromSource };
 export { DEFAULT_BOOK_EDITOR_HEIGHT };
+export type { BookEditorUploadProgressCallback };
+export type { BookEditorUploadOptions };
 export type { BookEditorProps };
 export { BookEditor };
 export { AgentChat };

package/esm/typings/src/_packages/markdown-utils.index.d.ts

@@ -21,6 +21,7 @@ import { humanizeAiText } from '../utils/markdown/humanizeAiText';
 import { humanizeAiTextEllipsis } from '../utils/markdown/humanizeAiTextEllipsis';
 import { humanizeAiTextEmdashed } from '../utils/markdown/humanizeAiTextEmdashed';
 import { humanizeAiTextQuotes } from '../utils/markdown/humanizeAiTextQuotes';
+import { humanizeAiTextSources } from '../utils/markdown/humanizeAiTextSources';
 import { humanizeAiTextWhitespace } from '../utils/markdown/humanizeAiTextWhitespace';
 import type { MarkdownSection } from '../utils/markdown/parseMarkdownSection';
 import { parseMarkdownSection } from '../utils/markdown/parseMarkdownSection';
@@ -54,6 +55,7 @@ export { humanizeAiText };
 export { humanizeAiTextEllipsis };
 export { humanizeAiTextEmdashed };
 export { humanizeAiTextQuotes };
+export { humanizeAiTextSources };
 export { humanizeAiTextWhitespace };
 export type { MarkdownSection };
 export { parseMarkdownSection };

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

@@ -7,6 +7,8 @@ import type { AvatarChipProps } from '../book-components/AvatarProfile/AvatarChi
 import type { AvatarChipFromSourceProps } from '../book-components/AvatarProfile/AvatarChip/AvatarChipFromSource';
 import type { AvatarProfileProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfile';
 import type { AvatarProfileFromSourceProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
+import type { BookEditorUploadProgressCallback } from '../book-components/BookEditor/BookEditor';
+import type { BookEditorUploadOptions } from '../book-components/BookEditor/BookEditor';
 import type { BookEditorProps } from '../book-components/BookEditor/BookEditor';
 import type { AgentChatProps } from '../book-components/Chat/AgentChat/AgentChatProps';
 import type { AgentChipData } from '../book-components/Chat/AgentChip/AgentChip';
@@ -30,7 +32,7 @@ import type { SourceChipProps } from '../book-components/Chat/SourceChip/SourceC
 import type { ChatToolCall } from '../book-components/Chat/types/ChatMessage';
 import type { ChatMessage } from '../book-components/Chat/types/ChatMessage';
 import type { ChatParticipant } from '../book-components/Chat/types/ChatParticipant';
-import type { ToolCallChipletInfo } from '../book-components/Chat/utils/getToolCallChipletText';
+import type { ToolCallChipletInfo } from '../book-components/Chat/utils/getToolCallChipletInfo';
 import type { ParsedCitation } from '../book-components/Chat/utils/parseCitationsFromContent';
 import type { MessageButton } from '../book-components/Chat/utils/parseMessageButtons';
 import type { TeamToolResult } from '../book-components/Chat/utils/toolCallParsing';
@@ -228,6 +230,11 @@ import type { SpeechRecognitionState } from '../types/SpeechRecognition';
 import type { SpeechRecognitionEvent } from '../types/SpeechRecognition';
 import type { TaskType } from '../types/TaskType';
 import type { ToolCall } from '../types/ToolCall';
+import type { SelfLearningCommitmentTypeCounts } from '../types/ToolCall';
+import type { SelfLearningTeacherSummary } from '../types/ToolCall';
+import type { SelfLearningToolCallResult } from '../types/ToolCall';
+import type { ASSISTANT_PREPARATION_TOOL_CALL_NAME } from '../types/ToolCall';
+import type { isAssistantPreparationToolCall } from '../types/ToolCall';
 import type { string_char_emoji } from '../types/typeAliasEmoji';
 import type { string_business_category_name } from '../types/typeAliases';
 import type { string_model_name } from '../types/typeAliases';
@@ -402,6 +409,8 @@ export type { AvatarChipProps };
 export type { AvatarChipFromSourceProps };
 export type { AvatarProfileProps };
 export type { AvatarProfileFromSourceProps };
+export type { BookEditorUploadProgressCallback };
+export type { BookEditorUploadOptions };
 export type { BookEditorProps };
 export type { AgentChatProps };
 export type { AgentChipData };
@@ -623,6 +632,11 @@ export type { SpeechRecognitionState };
 export type { SpeechRecognitionEvent };
 export type { TaskType };
 export type { ToolCall };
+export type { SelfLearningCommitmentTypeCounts };
+export type { SelfLearningTeacherSummary };
+export type { SelfLearningToolCallResult };
+export type { ASSISTANT_PREPARATION_TOOL_CALL_NAME };
+export type { isAssistantPreparationToolCall };
 export type { string_char_emoji };
 export type { string_business_category_name };
 export type { string_model_name };

package/esm/typings/src/_packages/utils.index.d.ts

@@ -27,10 +27,10 @@ import { splitIntoSentences } from '../utils/expectation-counters/countSentences
 import { countSentences } from '../utils/expectation-counters/countSentences';
 import { countWords } from '../utils/expectation-counters/countWords';
 import { CountUtils } from '../utils/expectation-counters/index';
+import { linguisticHash } from '../utils/linguistic-hash/linguisticHash';
 import { $getCurrentDate } from '../utils/misc/$getCurrentDate';
 import { computeHash } from '../utils/misc/computeHash';
 import { debounce } from '../utils/misc/debounce';
-import { linguisticHash } from '../utils/misc/linguisticHash';
 import { parseNumber } from '../utils/misc/parseNumber';
 import { capitalize } from '../utils/normalization/capitalize';
 import { decapitalize } from '../utils/normalization/decapitalize';
@@ -118,10 +118,10 @@ export { splitIntoSentences };
 export { countSentences };
 export { countWords };
 export { CountUtils };
+export { linguisticHash };
 export { $getCurrentDate };
 export { computeHash };
 export { debounce };
-export { linguisticHash };
 export { parseNumber };
 export { capitalize };
 export { decapitalize };

package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts

@@ -10,6 +10,30 @@ import type { number_percent, number_positive, string_css_value, string_knowledg
  * @public exported from `@promptbook/components`
  */
 export declare const DEFAULT_BOOK_EDITOR_HEIGHT: number;
+/**
+ * Upload progress callback for BookEditor uploads.
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type BookEditorUploadProgressCallback = (progress: number_percent, stats?: {
+    loadedBytes: number;
+    totalBytes: number;
+}) => void;
+/**
+ * Options for BookEditor uploads.
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type BookEditorUploadOptions = {
+    /**
+     * Progress callback invoked during upload.
+     */
+    readonly onProgress?: BookEditorUploadProgressCallback;
+    /**
+     * Optional abort signal for canceling an upload.
+     */
+    readonly abortSignal?: AbortSignal;
+};
 /**
  * Props of `BookEditor`
  *
@@ -53,9 +77,9 @@ export type BookEditorProps = {
      */
     onChange?(value: string_book): void;
     /**
-     * returns the URL of the uploaded file on CDN or storage
+     * Returns the URL of the uploaded file on CDN or storage.
      */
-    onFileUpload?(file: File, onProgress?: (progress: number_percent) => void): Promisable<string_knowledge_source_content>;
+    onFileUpload?(file: File, options?: BookEditorUploadOptions | BookEditorUploadProgressCallback): Promisable<string_knowledge_source_content>;
     /**
      * If true, logs verbose debug info to the console and shows additional visual cues
      */

package/esm/typings/src/book-components/Chat/types/ChatMessage.d.ts

@@ -1,6 +1,6 @@
 import { Message } from '../../../types/Message';
 import type { ToolCall } from '../../../types/ToolCall';
-import type { id, string_markdown } from '../../../types/typeAliases';
+import type { id, string_date_iso8601, string_markdown } from '../../../types/typeAliases';
 export type ChatToolCall = ToolCall;
 /**
  * Represents a single message within a chat interface.
@@ -10,7 +10,7 @@ export type ChatToolCall = ToolCall;
  *
  * @public exported from `@promptbook/components`
  */
-export type ChatMessage = Omit<Message<id>, 'direction' | 'recipients' | 'threadId' | 'metadata'> & {
+export type ChatMessage = Omit<Message<id>, 'direction' | 'recipients' | 'threadId' | 'metadata' | 'createdAt'> & {
     /**
      * Force the channel to be 'PROMPTBOOK_CHAT'
      *
@@ -21,6 +21,14 @@ export type ChatMessage = Omit<Message<id>, 'direction' | 'recipients' | 'thread
      * The content of the message with optional markdown formatting
      */
     content: string_markdown;
+    /**
+     * ISO 8601 timestamp for when the message was sent
+     */
+    createdAt?: string_date_iso8601;
+    /**
+     * Optional duration of agent message generation in milliseconds
+     */
+    generationDurationMs?: number;
     /**
      * Whether the message is complete (for example, if it's still being generated by an AI)
      *

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

@@ -0,0 +1,26 @@
+import type { ChatMessage } from '../types/ChatMessage';
+/**
+ * Display-ready timestamp values for a chat message.
+ *
+ * @private utility of `<Chat/>` component
+ */
+export type ChatMessageTimingDisplay = {
+    /**
+     * Short, UI-friendly time label (localized).
+     */
+    readonly timeLabel: string;
+    /**
+     * Full timestamp label suitable for tooltips or exports.
+     */
+    readonly fullLabel: string;
+    /**
+     * Optional duration label for agent message generation.
+     */
+    readonly durationLabel?: string;
+};
+/**
+ * Builds display-ready timestamp and duration labels for a chat message.
+ *
+ * @private utility of `<Chat/>` component
+ */
+export declare function getChatMessageTimingDisplay(message: ChatMessage): ChatMessageTimingDisplay | null;

package/esm/typings/src/book-components/Chat/utils/{getToolCallChipletText.d.ts → getToolCallChipletInfo.d.ts}

@@ -1,4 +1,4 @@
-import type { ToolCall } from '../../../types/ToolCall';
+import { type ToolCall } from '../../../types/ToolCall';
 import type { AgentChipData } from '../AgentChip';
 /**
  * Utility to format tool call information for user-friendly display.
@@ -15,6 +15,12 @@ export type ToolCallChipletInfo = {
      * Agent data for team tools (if applicable)
      */
     agentData?: AgentChipData;
+    /**
+     * Whether to wrap the chip text in brackets when rendering.
+     *
+     * @default true
+     */
+    wrapInBrackets?: boolean;
 };
 /**
  * Technical to user-friendly tool names and emojis
@@ -24,14 +30,8 @@ export type ToolCallChipletInfo = {
 export declare const TOOL_TITLES: Record<string, {
     title: string;
     emoji: string;
+    wrapInBrackets?: boolean;
 }>;
-/**
- * Gets the user-friendly text for a tool call chiplet.
- *
- * @deprecated Use getToolCallChipletInfo instead which returns both text and agent data
- * @private [🧠] Maybe public?
- */
-export declare function getToolCallChipletText(toolCall: ToolCall): string;
 /**
  * Gets the chiplet information including text and agent data (for team tools).
  *

package/esm/typings/src/types/ToolCall.d.ts

@@ -1,5 +1,5 @@
-import type { string_date_iso8601 } from './typeAliases';
 import type { TODO_any } from '../utils/organization/TODO_any';
+import type { string_date_iso8601 } from './typeAliases';
 /**
  * Represents a single tool call with its inputs, outputs, and timing.
  *
@@ -35,3 +35,78 @@ export type ToolCall = {
      */
     readonly warnings?: ReadonlyArray<TODO_any>;
 };
+/**
+ * Breakdown of teacher-learned commitment categories for self-learning.
+ */
+export type SelfLearningCommitmentTypeCounts = {
+    /**
+     * Total number of learned commitments.
+     */
+    readonly total: number;
+    /**
+     * Count of knowledge commitments.
+     */
+    readonly knowledge: number;
+    /**
+     * Count of rule commitments.
+     */
+    readonly rule: number;
+    /**
+     * Count of persona commitments.
+     */
+    readonly persona: number;
+    /**
+     * Count of other commitment types.
+     */
+    readonly other: number;
+};
+/**
+ * Summary of the teacher review step during self-learning.
+ */
+export type SelfLearningTeacherSummary = {
+    /**
+     * Indicates whether the teacher step was used.
+     */
+    readonly used: boolean;
+    /**
+     * Commitment breakdown produced by the teacher step.
+     */
+    readonly commitmentTypes: SelfLearningCommitmentTypeCounts;
+};
+/**
+ * Result payload for the self-learning tool call.
+ */
+export type SelfLearningToolCallResult = {
+    /**
+     * Indicates whether self-learning completed successfully.
+     */
+    readonly success: boolean;
+    /**
+     * Timestamp for when self-learning started.
+     */
+    readonly startedAt?: string_date_iso8601;
+    /**
+     * Timestamp for when self-learning finished.
+     */
+    readonly completedAt?: string_date_iso8601;
+    /**
+     * Number of conversation examples saved from this turn.
+     */
+    readonly samplesAdded?: number;
+    /**
+     * Summary of the teacher review step.
+     */
+    readonly teacher?: SelfLearningTeacherSummary;
+};
+/**
+ * Tool call name emitted while preparing a GPT assistant for an agent.
+ *
+ * @public exported from `@promptbook/types`
+ */
+export declare const ASSISTANT_PREPARATION_TOOL_CALL_NAME = "assistant_preparation";
+/**
+ * Checks whether a tool call is the assistant preparation marker.
+ *
+ * @public exported from `@promptbook/types`
+ */
+export declare function isAssistantPreparationToolCall(toolCall: ToolCall): boolean;

package/esm/typings/src/utils/linguistic-hash/LinguisticHashLanguage.d.ts

@@ -0,0 +1,41 @@
+import type { LinguisticHashWordLists } from './linguisticHashTypes';
+/**
+ * Supported language codes for linguistic hash output.
+ *
+ * @private utility of `linguisticHash`
+ */
+export type LinguisticHashLanguage = 'en' | 'cs';
+/**
+ * Language-specific configuration for linguistic hash generation.
+ *
+ * @private utility of `linguisticHash`
+ */
+export type LinguisticHashLanguageConfig = {
+    language: LinguisticHashLanguage;
+    label: string;
+    wordLists: LinguisticHashWordLists;
+};
+/**
+ * Default language used for linguistic hashes.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare const DEFAULT_LINGUISTIC_HASH_LANGUAGE: LinguisticHashLanguage;
+/**
+ * Ordered list of supported linguistic hash languages.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare const LINGUISTIC_HASH_LANGUAGES: readonly LinguisticHashLanguageConfig[];
+/**
+ * Normalizes a requested language to a supported linguistic hash language.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare function normalizeLinguisticHashLanguage(language?: string | null): LinguisticHashLanguage;
+/**
+ * Returns the language configuration for linguistic hash generation.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare function getLinguisticHashLanguageConfig(language?: string | null): LinguisticHashLanguageConfig;

package/esm/typings/src/utils/linguistic-hash/linguisticHash.d.ts

@@ -0,0 +1,37 @@
+import type { LinguisticHashLanguage } from './LinguisticHashLanguage';
+export { DEFAULT_LINGUISTIC_HASH_LANGUAGE, LINGUISTIC_HASH_LANGUAGES, normalizeLinguisticHashLanguage, } from './LinguisticHashLanguage';
+export type { LinguisticHashLanguage } from './LinguisticHashLanguage';
+/**
+ * Creates a human-readable hash as a short, story-like phrase.
+ *
+ * @param wordCount how many words to include (defaults to {@link DEFAULT_LINGUISTIC_HASH_WORD_COUNT}, clamped to
+ * {@link MIN_LINGUISTIC_HASH_WORD_COUNT}..{@link MAX_LINGUISTIC_HASH_WORD_COUNT})
+ * @param language optional language code (defaults to {@link DEFAULT_LINGUISTIC_HASH_LANGUAGE})
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function linguisticHash(input: string, wordCount?: number, language?: LinguisticHashLanguage): Promise<string>;
+/**
+ * The minimum number of words for a linguistic hash.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare const MIN_LINGUISTIC_HASH_WORD_COUNT = 1;
+/**
+ * The default number of words for a linguistic hash.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare const DEFAULT_LINGUISTIC_HASH_WORD_COUNT = 7;
+/**
+ * The maximum number of words for a linguistic hash.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare const MAX_LINGUISTIC_HASH_WORD_COUNT: number;
+/**
+ * Normalizes the word count to a supported integer range.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare function normalizeLinguisticHashWordCount(wordCount?: number | null): number;

package/esm/typings/src/utils/linguistic-hash/linguisticHashTypes.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Types of words used in linguistic hash output.
+ *
+ * @private utility of `linguisticHash`
+ */
+export type LinguisticHashWordKind = 'adjective' | 'noun' | 'verb';
+/**
+ * Word lists used to build linguistic hashes.
+ *
+ * @private utility of `linguisticHash`
+ */
+export type LinguisticHashWordLists = {
+    adjective: readonly string[];
+    noun: readonly string[];
+    verb: readonly string[];
+};
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/utils/linguistic-hash/linguisticHashWords.cs.d.ts

@@ -0,0 +1,10 @@
+import type { LinguisticHashWordLists } from './linguisticHashTypes';
+/**
+ * Czech word lists used by the linguistic hash.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare const LINGUISTIC_HASH_WORD_LISTS_CS: LinguisticHashWordLists;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/utils/linguistic-hash/linguisticHashWords.en.d.ts

@@ -0,0 +1,10 @@
+import type { LinguisticHashWordLists } from './linguisticHashTypes';
+/**
+ * English word lists used by the linguistic hash.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare const LINGUISTIC_HASH_WORD_LISTS_EN: LinguisticHashWordLists;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/utils/markdown/humanizeAiTextSources.d.ts

@@ -0,0 +1,13 @@
+import type { string_markdown } from '../../types/typeAliases';
+/**
+ * Remove bracketed source citation artifacts like `\u30105:1\u2020source\u3011`.
+ *
+ * Note: [??] This function is idempotent.
+ * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function humanizeAiTextSources(aiText: string_markdown): string_markdown;
+/**
+ * Note: [??] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
+ */

package/esm/typings/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.105.0`).
+ * It follows semantic versioning (e.g., `0.107.0-0`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/javascript",
-    "version": "0.106.0-0",
+    "version": "0.108.0-0",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -94,7 +94,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/javascript.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.106.0-0"
+        "@promptbook/core": "0.108.0-0"
     },
     "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.106.0-0';
+    const PROMPTBOOK_ENGINE_VERSION = '0.108.0-0';
     /**
      * 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/typings/src/utils/misc/linguisticHash.d.ts

@@ -1,9 +0,0 @@
-/**
- * Creates a human-readable hash as a short story sentence.
- *
- * @public exported from `@promptbook/utils`
- */
-export declare function linguisticHash(input: string): Promise<string>;
-/**
- * TODO: Prompt: Extract number constants and word list to a separate file for reuse.
- */