@promptbook/wizard 0.101.0-0 → 0.101.0-10

package/esm/typings/src/book-2.0/commitments/index.d.ts

@@ -1,15 +1,19 @@
 import type { BookCommitment } from './_base/BookCommitment';
 import type { CommitmentDefinition } from './_base/CommitmentDefinition';
 import { ActionCommitmentDefinition } from './ACTION/ACTION';
+import { DeleteCommitmentDefinition } from './DELETE/DELETE';
 import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
+import { GoalCommitmentDefinition } from './GOAL/GOAL';
 import { KnowledgeCommitmentDefinition } from './KNOWLEDGE/KNOWLEDGE';
-import { MetaImageCommitmentDefinition } from './META_IMAGE/META_IMAGE';
-import { MetaLinkCommitmentDefinition } from './META_LINK/META_LINK';
+import { MemoryCommitmentDefinition } from './MEMORY/MEMORY';
+import { MessageCommitmentDefinition } from './MESSAGE/MESSAGE';
+import { MetaCommitmentDefinition } from './META/META';
 import { ModelCommitmentDefinition } from './MODEL/MODEL';
 import { NoteCommitmentDefinition } from './NOTE/NOTE';
 import { PersonaCommitmentDefinition } from './PERSONA/PERSONA';
 import { RuleCommitmentDefinition } from './RULE/RULE';
 import { SampleCommitmentDefinition } from './SAMPLE/SAMPLE';
+import { ScenarioCommitmentDefinition } from './SCENARIO/SCENARIO';
 import { StyleCommitmentDefinition } from './STYLE/STYLE';
 import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplementedCommitmentDefinition';
 /**
@@ -19,7 +23,7 @@ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplemented
  *
  * @private Use functions to access commitments instead of this array directly
  */
-export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, MetaImageCommitmentDefinition, MetaLinkCommitmentDefinition, NoteCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"SCENARIO">, NotYetImplementedCommitmentDefinition<"SCENARIOS">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"GOAL">, NotYetImplementedCommitmentDefinition<"GOALS">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
+export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
 /**
  * Gets a commitment definition by its type
  * @param type The commitment type to look up

package/esm/typings/src/book-components/AvatarProfile/AvatarProfile/MockedChat.d.ts

@@ -0,0 +1,46 @@
+import type { ChatProps } from '../../Chat/Chat/ChatProps';
+/**
+ * Delay configuration for the MockedChat component
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type MockedChatDelayConfig = {
+    /**
+     * Delay before showing the first message (in milliseconds)
+     * @default 1000
+     */
+    beforeFirstMessage?: number;
+    /**
+     * Emulated thinking time between messages (in milliseconds)
+     * @default 2000
+     */
+    thinkingBetweenMessages?: number;
+    /**
+     * Wait time after each written word (in milliseconds)
+     * @default 100
+     */
+    waitAfterWord?: number;
+    /**
+     * Extra delay on top of the word waiting (in milliseconds)
+     * @default 50
+     */
+    extraWordDelay?: number;
+};
+/**
+ * Props for MockedChat component
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type MockedChatProps = ChatProps & {
+    /**
+     * Optional delays configuration for emulating typing behavior
+     */
+    delayConfig?: MockedChatDelayConfig;
+};
+/**
+ * MockedChat component that shows the same chat as Chat but emulates ongoing discussion
+ * with realistic typing delays and thinking pauses.
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function MockedChat(props: MockedChatProps): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/AvatarProfile/AvatarProfile/index.d.ts

@@ -0,0 +1,3 @@
+export * from './AvatarProfile';
+export * from './AvatarProfileFromSource';
+export * from './MockedChat';

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

@@ -1,5 +1,7 @@
 import type { CSSProperties } from 'react';
+import type { Promisable } from 'type-fest';
 import type { string_book } from '../../book-2.0/agent-source/string_book';
+import { string_knowledge_source_content } from '../../types/typeAliases';
 /**
  * Props of `BookEditor`
  *
@@ -27,10 +29,18 @@ export type BookEditorProps = {
      * Callback function to handle changes in the book content.
      */
     onChange?(value: string_book): void;
+    /**
+     * returns the URL of the uploaded file on CDN or storage
+     */
+    onFileUpload?(file: File): Promisable<string_knowledge_source_content>;
     /**
      * If true, logs verbose debug info to the console and shows additional visual cues
      */
     readonly isVerbose?: boolean;
+    /**
+     * If true, disables border radius making the editor have sharp corners
+     */
+    readonly isBorderRadiusDisabled?: boolean;
 };
 /**
  * Renders a book editor

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

@@ -1,3 +1,4 @@
+import { Promisable } from 'type-fest';
 import type { string_book } from '../../book-2.0/agent-source/string_book';
 /**
  * @private util of `<BookEditor />`
@@ -7,7 +8,9 @@ export type BookEditorInnerProps = {
     fontClassName?: string;
     value?: string_book;
     onChange?(value: string_book): void;
+    onFileUpload?(file: File): Promisable<string>;
     isVerbose?: boolean;
+    isBorderRadiusDisabled?: boolean;
 };
 /**
  * @private util of `<BookEditor />`

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

@@ -1,9 +1,4 @@
 import type { ChatProps } from './ChatProps';
-/**
- * @deprecated use `isComplete` instead
- * @private util of `<Chat />`
- */
-export declare const LOADING_INTERACTIVE_IMAGE = "Loading...";
 /**
  * Renders a chat with messages and input for new messages
  *

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

@@ -23,10 +23,16 @@ export type ChatProps = {
      * Called when user sends a message
      *
      * Note: You must handle the message yourself and add it to the `messages` array
+     *
+     * - When set, the send textarea and button will be shown
+     * - When undefined, the chat has no input and is read-only showing only the messages
      */
-    onMessage(messageContent: string): Promisable<void>;
+    onMessage?(messageContent: string): Promisable<void>;
     /**
-     * Optional callback, when set, button for resetting chat will be shown
+     * Optional callback
+     *
+     * - When set, button for resetting chat will be shown
+     * - When undefined, no reset button will be shown
      */
     onReset?(): Promisable<void>;
     /**
@@ -113,4 +119,24 @@ export type ChatProps = {
      * Keys should match ChatMessage.from values (e.g., 'USER', 'AGENT_{id}', etc.)
      */
     readonly participants?: ReadonlyArray<ChatParticipant>;
+    /**
+     * Optional callback for handling user feedback on messages
+     * When provided, star rating buttons (1-5 stars) will be displayed next to each message
+     *
+     * @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.textRating - Optional text feedback/note from user
+     * @param feedback.chatThread - Complete chat thread as string
+     * @param feedback.expectedAnswer - Optional expected answer provided by user
+     * @param feedback.url - Current page URL where feedback was given
+     */
+    onFeedback?(feedback: {
+        message: ChatMessage;
+        rating: number;
+        textRating: string;
+        chatThread: string;
+        expectedAnswer: string | null;
+        url: string;
+    }): Promisable<void>;
 };

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

@@ -0,0 +1,8 @@
+/**
+ * @deprecated use `isComplete` instead
+ * @private util of `<Chat />`
+ */
+export declare const LOADING_INTERACTIVE_IMAGE = "Loading...";
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-components/Chat/examples/ChatMarkdownDemo.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Demo component showing Chat with markdown rendering capabilities
+ *
+ * This example demonstrates various markdown features supported by the Chat component:
+ * - Headers
+ * - Bold and italic text
+ * - Code blocks and inline code
+ * - Lists (ordered and unordered)
+ * - Links
+ * - Blockquotes
+ * - Tables
+ * - Strikethrough text
+ *
+ * @private temporary for testing purposes
+ */
+export declare function ChatMarkdownDemo(): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,21 @@
+import type { string_html, string_markdown } from '../../../types/typeAliases';
+/**
+ * Convert markdown content to HTML for display in chat messages
+ *
+ * @param markdown - The markdown content to convert
+ * @returns HTML string ready for rendering
+ *
+ * @public exported from `@promptbook/components`
+ *         <- TODO: [🧠] Maybe export from `@promptbook/markdown-utils`
+ */
+export declare function renderMarkdown(markdown: string_markdown): string_html;
+/**
+ * Check if content appears to be markdown (contains markdown syntax)
+ *
+ * @param content - Content to check
+ * @returns true if content appears to contain markdown syntax
+ *
+ * @public exported from `@promptbook/components`
+ *         <- TODO: [🧠] Maybe export from `@promptbook/markdown-utils`
+ */
+export declare function isMarkdownContent(content: string): boolean;

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

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

package/esm/typings/src/book-components/icons/ArrowIcon.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Shows simple arrow icon pointing up or down
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const ArrowIcon: ({ direction, size }: {
+    direction: string;
+    size: number;
+}) => import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/icons/ResetIcon.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Shows simple reset icon
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const ResetIcon: () => import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/icons/SendIcon.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Shows simple send icon
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const SendIcon: ({ size }: {
+    size: number;
+}) => import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/icons/TemplateIcon.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Shows simple template icon
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const TemplateIcon: ({ size }: {
+    size: number;
+}) => import("react/jsx-runtime").JSX.Element;

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

@@ -3,6 +3,8 @@ import type { string_markdown_text } from '../../types/typeAliases';
  * Function escapeMarkdownBlock will escape markdown block if needed
  * It is useful when you want have block in block
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @public exported from `@promptbook/markdown-utils`
  */
 export declare function escapeMarkdownBlock(value: string_markdown_text): string_markdown_text;

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

@@ -2,11 +2,13 @@ import { string_markdown } from '../../types/typeAliases';
 /**
  * Function `humanizeAiText` will remove traces of AI text generation artifacts
  *
+ * Note: [🔂] This function is idempotent.
  * Tip: If you want more control, look for other functions for example `humanizeAiTextEmdashed` exported `@promptbook/markdown-utils`
  *
  * @public exported from `@promptbook/markdown-utils`
  */
 export declare function humanizeAiText(aiText: string_markdown): string_markdown;
 /**
+ * TODO: [🧠] Maybe this should be exported from `@promptbook/utils` not `@promptbook/markdown-utils`
  * TODO: [🅾️] !!! Use this across the project where AI text is involved
  */

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

@@ -2,6 +2,7 @@ import { string_markdown } from '../../types/typeAliases';
 /**
  * Change ellipsis character to three dots `…` -> `...`
  *
+ * 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`

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

@@ -2,6 +2,7 @@ import { string_markdown } from '../../types/typeAliases';
 /**
  * Change em-dashes to regular dashes `—` -> `-`
  *
+ * 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`

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

@@ -2,6 +2,7 @@ import { string_markdown } from '../../types/typeAliases';
 /**
  * Change smart quotes to regular quotes
  *
+ * 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`

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

@@ -2,6 +2,7 @@ import { string_markdown } from '../../types/typeAliases';
 /**
  * Change unprintable hard spaces to regular spaces
  *
+ * 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`

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

@@ -7,3 +7,11 @@ import type { string_html } from '../../types/typeAliases';
  * @private withing the package because of HUGE size of prettier dependency
  */
 export declare function prettifyMarkdown<TContent extends string_html>(content: TContent): TContent;
+/**
+ * Async version of prettifyMarkdown using dynamic imports
+ *
+ * @param content raw html code
+ * @returns formatted html code
+ * @private withing the package because of HUGE size of prettier dependency
+ */
+export declare function prettifyMarkdownAsync<TContent extends string_html>(content: TContent): Promise<TContent>;

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

@@ -6,6 +6,7 @@ import { string_markdown } from '../../types/typeAliases';
  */
 export declare function promptbookifyAiText(text: string_markdown): string_markdown;
 /**
+ * TODO: !!!!! Make the function idempotent and add "Note: [🔂] This function is idempotent."
  * TODO: [🅾️]!!! Use this across the project where AI text is involved
  * TODO: [🧠][✌️] Make some Promptbook-native token system
  */

package/esm/typings/src/utils/normalization/capitalize.d.ts

@@ -1,6 +1,8 @@
 /**
  * Makes first letter of a string uppercase
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function capitalize(word: string): string;

package/esm/typings/src/utils/normalization/decapitalize.d.ts

@@ -1,5 +1,7 @@
 /**
- * Makes first letter of a string uppercase
+ * Makes first letter of a string lowercase
+ *
+ * Note: [🔂] This function is idempotent.
  *
  * @public exported from `@promptbook/utils`
  */

package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts

@@ -9,6 +9,8 @@ export type string_SCREAMING_CASE = string;
 /**
  * Normalizes a text string to SCREAMING_CASE (all uppercase with underscores).
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param text The text string to be converted to SCREAMING_CASE format.
  * @returns The normalized text in SCREAMING_CASE format.
  * @example 'HELLO_WORLD'

package/esm/typings/src/utils/normalization/normalizeTo_snake_case.d.ts

@@ -8,6 +8,8 @@ export type string_snake_case = string;
 /**
  * Normalizes a text string to snake_case format.
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param text The text string to be converted to snake_case format.
  * @returns The normalized text in snake_case format.
  * @example 'hello_world'

package/esm/typings/src/utils/normalization/normalizeWhitespaces.d.ts

@@ -1,6 +1,8 @@
 /**
  * Take every whitespace (space, new line, tab) and replace it with a single space
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function normalizeWhitespaces(sentence: string): string;

package/esm/typings/src/utils/normalization/removeDiacritics.d.ts

@@ -1,6 +1,8 @@
 /**
  * Removes diacritic marks (accents) from characters in a string.
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param input The string containing diacritics to be normalized.
  * @returns The string with diacritics removed or normalized.
  * @public exported from `@promptbook/utils`

package/esm/typings/src/utils/parseNumber.d.ts

@@ -1,6 +1,7 @@
 /**
  * Function parseNumber will parse number from string
  *
+ * Note: [🔂] This function is idempotent.
  * Unlike Number.parseInt, Number.parseFloat it will never ever result in NaN
  * Note: it also works only with decimal numbers
  *

package/esm/typings/src/utils/removeEmojis.d.ts

@@ -1,6 +1,8 @@
 /**
  * Removes emojis from a string and fix whitespaces
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param text with emojis
  * @returns text without emojis
  * @public exported from `@promptbook/utils`

package/esm/typings/src/utils/removeQuotes.d.ts

@@ -1,6 +1,7 @@
 /**
  * Removes quotes from a string
  *
+ * Note: [🔂] This function is idempotent.
  * Tip: This is very useful for post-processing of the result of the LLM model
  * Note: This function removes only the same quotes from the beginning and the end of the string
  * Note: There are two similar functions:

package/esm/typings/src/utils/serialization/deepClone.d.ts

@@ -2,6 +2,7 @@ import type { WritableDeep } from 'type-fest';
 /**
  * Creates a deep clone of the given object
  *
+ * Note: [🔂] This function is idempotent.
  * Note: This method only works for objects that are fully serializable to JSON and do not contain functions, Dates, or special types.
  *
  * @param objectValue The object to clone.

package/esm/typings/src/utils/trimCodeBlock.d.ts

@@ -1,6 +1,7 @@
 /**
  * Function trimCodeBlock will trim starting and ending code block from the string if it is present.
  *
+ * Note: [🔂] This function is idempotent.
  * Note: This is useful for post-processing of the result of the chat LLM model
  *       when the model wraps the result in the (markdown) code block.
  *

package/esm/typings/src/utils/validators/url/isValidUrl.d.ts

@@ -3,6 +3,7 @@ import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid URL.
  *
+ * Note: [🔂] This function is idempotent.
  * Note: Dataurl are considered perfectly valid.
  * Note: There are two similar functions:
  * - `isValidUrl` which tests any URL

package/esm/typings/src/utils/validators/uuid/isValidUuid.d.ts

@@ -3,6 +3,8 @@ import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Checks if value is valid uuid
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function isValidUuid(value: really_unknown): value is string_uuid;

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.100.4-0`).
+ * It follows semantic versioning (e.g., `0.101.0-9`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/wizard",
-    "version": "0.101.0-0",
+    "version": "0.101.0-10",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -95,7 +95,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/wizard.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.101.0-0"
+        "@promptbook/core": "0.101.0-10"
     },
     "dependencies": {
         "@ai-sdk/deepseek": "0.1.6",