@promptbook/javascript 0.110.0-8 → 0.110.0-9

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.110.0-8';
+const PROMPTBOOK_ENGINE_VERSION = '0.110.0-9';
 /**
  * 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

@@ -18,6 +18,7 @@ import { Chat } from '../book-components/Chat/Chat/Chat';
 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';
+import { ChatVibrationToggle } from '../book-components/Chat/Chat/ChatSoundToggle';
 import { ChatEffectsSystem } from '../book-components/Chat/effects/ChatEffectsSystem';
 import { ConfettiEffect } from '../book-components/Chat/effects/components/ConfettiEffect';
 import { HeartsEffect } from '../book-components/Chat/effects/components/HeartsEffect';
@@ -88,6 +89,7 @@ export { Chat };
 export type { ChatSoundSystem };
 export type { ChatProps };
 export { ChatSoundToggle };
+export { ChatVibrationToggle };
 export { ChatEffectsSystem };
 export { ConfettiEffect };
 export { HeartsEffect };

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

@@ -16,6 +16,7 @@ import type { AgentChipProps } from '../book-components/Chat/AgentChip/AgentChip
 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';
+import type { ChatVibrationToggleProps } from '../book-components/Chat/Chat/ChatSoundToggle';
 import type { ChatEffect } from '../book-components/Chat/effects/types/ChatEffect';
 import type { ChatEffectConfig } from '../book-components/Chat/effects/types/ChatEffectConfig';
 import type { ChatEffectsSystemProps } from '../book-components/Chat/effects/types/ChatEffectsSystemProps';
@@ -373,6 +374,7 @@ import type { number_gigabytes } from '../types/typeAliases';
 import type { number_terabytes } from '../types/typeAliases';
 import type { Updatable } from '../types/Updatable';
 import type { ColorTransformer } from '../utils/color/operators/ColorTransformer';
+import type { ThinkingMessageVariant } from '../utils/DEFAULT_THINKING_MESSAGES';
 import type { PipelineEditableSerialized } from '../utils/editable/types/PipelineEditableSerialized';
 import type { ExecCommandOptions } from '../utils/execCommand/ExecCommandOptions';
 import type { ExecCommandOptionsAdvanced } from '../utils/execCommand/ExecCommandOptions';
@@ -419,6 +421,7 @@ export type { AgentChipProps };
 export type { ChatSoundSystem };
 export type { ChatProps };
 export type { ChatSoundToggleProps };
+export type { ChatVibrationToggleProps };
 export type { ChatEffect };
 export type { ChatEffectConfig };
 export type { ChatEffectsSystemProps };
@@ -776,6 +779,7 @@ export type { number_gigabytes };
 export type { number_terabytes };
 export type { Updatable };
 export type { ColorTransformer };
+export type { ThinkingMessageVariant };
 export type { PipelineEditableSerialized };
 export type { ExecCommandOptions };
 export type { ExecCommandOptionsAdvanced };

package/esm/typings/src/book-2.0/agent-source/AgentModelRequirements.d.ts

@@ -1,6 +1,6 @@
 import type { LlmToolDefinition } from '../../types/LlmToolDefinition';
 import type { string_agent_url, string_knowledge_source_link } from '../../types/typeAliases';
-import type { TODO_any } from '../../utils/organization/TODO_any';
+import { chococake } from '../../utils/organization/really_any';
 /**
  * Model requirements for an agent
  *
@@ -12,22 +12,16 @@ export type AgentModelRequirements = {
      */
     readonly systemMessage: string;
     /**
-     * The model name to use for this agent
+     * Text appended to every user prompt after the user's input and before tools/messages.
+     *
+     * This allows commitments to emphasize important rules or reminders that should be
+     * visible in the prompt in addition to the system message.
      */
-    readonly modelName: string;
+    readonly promptSuffix: string;
     /**
-     * Optional list of MCP servers that the agent can connect to
-     */
-    readonly mcpServers?: ReadonlyArray<string>;
-    /**
-     * Optional link to the parent agent from which this agent inherits
-     *
-     * Note: [🆓] There are several cases what the agent ancestor could be:
-     * -  1) `parentAgentUrl` is `string_agent_url` valid agent URL
-     * -  2) `parentAgentUrl` is explicitly `null` (forcefully no parent)
-     * -  3) `parentAgentUrl` is not defined `undefined`,  the default ancestor agent, Adam,  will be used
+     * The model name to use for this agent
      */
-    readonly parentAgentUrl?: string_agent_url | null;
+    readonly modelName: string;
     /**
      * List of imported agent URLs
      */
@@ -64,17 +58,24 @@ export type AgentModelRequirements = {
      */
     readonly tools?: ReadonlyArray<LlmToolDefinition>;
     /**
-     * Arbitrary metadata storage for commitments
-     * Each commitment can store its own data here
+     * Optional list of MCP servers that the agent can connect to
      */
-    readonly metadata?: Record<string, TODO_any>;
+    readonly mcpServers?: ReadonlyArray<string>;
     /**
-     * Notes associated with the agent
-     *
-     * Note: This does not affect agent behavior in any way
+     * The URL of the parent agent to inherit from, or null if there is no parent (i.e., do not inherit from any agent)
+     */
+    readonly parentAgentUrl: string_agent_url | null;
+    /**
+     * Is the agent closed to modification by conversation (i.e., it will not learn from interactions and its source code will remain static during conversation)
+     */
+    readonly isClosed: boolean;
+    /**
+     * Arbitrary metadata storage for commitments
+     * Each commitment can store its own data here
      */
-    readonly notes?: ReadonlyArray<string>;
+    readonly _metadata?: Record<string, chococake>;
 };
 /**
  * TODO: [🐤] DRY `AgentModelRequirements` and `ModelRequirements`
+ * TODO: [🧠] `isClosed` and `parentAgentUrl` doesn't truly belong to `AgentModelRequirements` nor agent profile but it is in the `AgentModelRequirements` because of some legacy - maybe figure out better place
  */

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

@@ -29,6 +29,7 @@ export type ChatInputAreaProps = {
     onChange?: ChatProps['onChange'];
     onFileUpload?: ChatProps['onFileUpload'];
     speechRecognition?: ChatProps['speechRecognition'];
+    speechRecognitionLanguage?: ChatProps['speechRecognitionLanguage'];
     defaultMessage?: string;
     placeholderMessageContent?: string;
     isFocusedOnLoad?: boolean;

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

@@ -52,6 +52,10 @@ type ChatMessageItemProps = Pick<ChatProps, 'onMessage' | 'participants'> & {
      * Called when a source citation chip is clicked.
      */
     onCitationClick?: (citation: ParsedCitation) => void;
+    /**
+     * Optional sound system for triggering tool chip events.
+     */
+    soundSystem?: ChatProps['soundSystem'];
 };
 /**
  * Metadata for a teammate agent tool.

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

@@ -27,6 +27,7 @@ export type ChatMessageListProps = {
     teammates?: ChatProps['teammates'];
     onToolCallClick?: (toolCall: NonNullable<ChatMessage['toolCalls']>[number]) => void;
     onCitationClick?: (citation: ParsedCitation) => void;
+    soundSystem?: ChatProps['soundSystem'];
     setChatMessagesElement: (element: HTMLDivElement | null) => void;
     onScroll: (event: UIEvent<HTMLDivElement>) => void;
     chatMessagesClassName?: string;

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

@@ -20,6 +20,16 @@ export type ChatSoundSystem = {
     isEnabled(): boolean;
     setEnabled(enabled: boolean): void;
     toggle(): boolean;
+    /**
+     * Optional helpers for haptic vibration state.
+     */
+    isVibrationEnabled?(): boolean;
+    setVibrationEnabled?(enabled: boolean): void;
+    toggleVibration?(): boolean;
+    /**
+     * Optional vibration helper to stay in sync with sound events.
+     */
+    vibrate?(event: string): void;
 };
 /**
  * @public exported from `@promptbook/components`
@@ -66,6 +76,11 @@ export type ChatProps = {
      * Speech recognition provider
      */
     readonly speechRecognition?: SpeechRecognition;
+    /**
+     * Optional language tag (BCP 47) to force speech recognition to use a specific language.
+     * When not provided, the browser preferences are used with a fallback to `en-US`.
+     */
+    readonly speechRecognitionLanguage?: string;
     /**
      * Optional placeholder message for the textarea
      *

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

@@ -21,3 +21,22 @@ export type ChatSoundToggleProps = {
  * @public exported from `@promptbook/components`
  */
 export declare function ChatSoundToggle(props: ChatSoundToggleProps): import("react/jsx-runtime").JSX.Element;
+/**
+ * Props for the chat vibration toggle.
+ */
+export type ChatVibrationToggleProps = {
+    /**
+     * The sound system instance that supports vibration helpers.
+     */
+    soundSystem: ChatSoundSystem;
+    /**
+     * Optional CSS class name.
+     */
+    className?: string;
+};
+/**
+ * ChatVibrationToggle component that controls haptic feedback.
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function ChatVibrationToggle(props: ChatVibrationToggleProps): import("react/jsx-runtime").JSX.Element | null;

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

@@ -62,6 +62,12 @@ export type LlmChatProps = Omit<ChatProps, 'messages' | 'onMessage' | 'onChange'
      * e.g., { "web_search": "Searching the web..." }
      */
     readonly toolTitles?: Record<string, string>;
+    /**
+     * Custom variants for the placeholder thinking message shown while the agent buffers its response.
+     *
+     * @default Shared thinking message variants
+     */
+    readonly thinkingMessages?: ReadonlyArray<string>;
     /**
      * Optional custom error handler that will be called when an error occurs during chat.
      * If not provided, errors will be displayed as messages in the chat.

package/esm/typings/src/commitments/_base/BaseCommitmentDefinition.d.ts

@@ -57,6 +57,15 @@ export declare abstract class BaseCommitmentDefinition<TBookCommitment extends s
      * Helper method to append content to the system message
      */
     protected appendToSystemMessage(requirements: AgentModelRequirements, content: string, separator?: string): AgentModelRequirements;
+    /**
+     * Helper method to create a new requirements object with updated prompt suffix
+     */
+    protected updatePromptSuffix(requirements: AgentModelRequirements, contentUpdate: string | ((currentSuffix: string) => string)): AgentModelRequirements;
+    /**
+     * Helper method to append content to the prompt suffix
+     * Default separator is a single newline for bullet lists.
+     */
+    protected appendToPromptSuffix(requirements: AgentModelRequirements, content: string, separator?: string): AgentModelRequirements;
     /**
      * Helper method to add a comment section to the system message
      * Comments are lines starting with # that will be removed from the final system message

package/esm/typings/src/llm-providers/agent/AgentLlmExecutionTools.test.d.ts

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

package/esm/typings/src/llm-providers/openai/OpenAiAgentKitExecutionTools.d.ts

@@ -1,4 +1,6 @@
 import { Agent as AgentFromKit } from '@openai/agents';
+import OpenAI from 'openai';
+import { TODO_any } from '../../_packages/types.index';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { ChatPromptResult } from '../../execution/PromptResult';
 import type { ModelRequirements } from '../../types/ModelRequirements';
@@ -6,6 +8,42 @@ import type { Prompt } from '../../types/Prompt';
 import type { string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
 import type { OpenAiAgentKitExecutionToolsOptions } from './OpenAiAgentKitExecutionToolsOptions';
 import { OpenAiVectorStoreHandler } from './OpenAiVectorStoreHandler';
+/**
+ * Represents the AgentKit output configuration used to match OpenAI `response_format` expectations.
+ *
+ * @private utility of Open AI
+ */
+export type AgentOutputType = 'text' | JsonSchemaDefinition;
+type JsonSchemaDefinitionEntry = {
+    type?: string;
+    description?: string;
+    properties?: Record<string, JsonSchemaDefinitionEntry>;
+    required?: Array<string>;
+    items?: JsonSchemaDefinitionEntry;
+    [key: string]: TODO_any;
+};
+type JsonSchemaDefinition = {
+    type: 'json_schema';
+    name: string;
+    strict: boolean;
+    schema: {
+        type: 'object';
+        properties: Record<string, JsonSchemaDefinitionEntry>;
+        required: Array<string>;
+        additionalProperties: boolean;
+        description?: string;
+    };
+};
+type OpenAiChatResponseFormat = OpenAI.Chat.Completions.ChatCompletionCreateParamsNonStreaming['response_format'];
+/**
+ * Maps OpenAI `response_format` payloads to AgentKit output types so the runner can forward
+ * structured-output preferences to OpenAI while still reusing the same AgentKit agent instance.
+ *
+ * @param responseFormat - The OpenAI `response_format` payload from the user request.
+ * @returns An Agent output type compatible with the requested schema or `undefined` when no impact is required.
+ * @private utility of Open AI
+ */
+export declare function mapResponseFormatToAgentOutputType(responseFormat?: OpenAiChatResponseFormat): AgentOutputType | undefined;
 /**
  * Alias for OpenAI AgentKit agent to avoid naming confusion with Promptbook agents.
  */
@@ -82,6 +120,7 @@ export declare class OpenAiAgentKitExecutionTools extends OpenAiVectorStoreHandl
         readonly prompt: Prompt;
         readonly rawPromptContent?: string;
         readonly onProgress: (chunk: ChatPromptResult) => void;
+        readonly responseFormatOutputType?: AgentOutputType;
     }): Promise<ChatPromptResult>;
     /**
      * Builds AgentKit input items from the prompt and optional thread.

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

@@ -23,5 +23,6 @@ export type LlmToolDefinition = {
             description?: string;
         }>;
         readonly required?: string[];
+        readonly additionalProperties?: boolean;
     };
 };

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

@@ -1,6 +1,7 @@
 import type { LlmToolDefinition } from './LlmToolDefinition';
 import type { ModelVariant } from './ModelVariant';
 import type { number_model_temperature, number_seed, string_model_name, string_system_message } from './typeAliases';
+import type OpenAI from 'openai';
 /**
  * Abstract way to specify the LLM.
  * It does not specify the LLM with concrete version itself, only the requirements for the LLM.
@@ -54,6 +55,14 @@ export type ChatModelRequirements = CommonModelRequirements & {
      * Maximum number of tokens that can be generated by the model
      */
     readonly maxTokens?: number;
+    /**
+     * Optional OpenAI `response_format` override that should be forwarded to compatible APIs.
+     */
+    readonly responseFormat?: OpenAI.Chat.Completions.ChatCompletionCreateParamsNonStreaming['response_format'];
+    /**
+     * Optional OpenAI `tool_choice` override that should be forwarded to compatible APIs.
+     */
+    readonly toolChoice?: OpenAI.Chat.Completions.ChatCompletionToolChoiceOption;
 };
 /**
  * Model requirements for the image generation variant

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

@@ -0,0 +1,8 @@
+/**
+ * Default placeholder variants shown when an agent is still composing a response.
+ *
+ * @private BUT maybe export via some package
+ */
+export declare const DEFAULT_THINKING_MESSAGES: readonly ["Thinking...", "Searching for information...", "Sorting information..."];
+/** @internal */
+export type ThinkingMessageVariant = (typeof DEFAULT_THINKING_MESSAGES)[number];

package/esm/typings/src/utils/knowledge/inlineKnowledgeSource.d.ts

@@ -0,0 +1,38 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import type { string_data_url, string_filename } from '../../types/typeAliases';
+/**
+ * @@@
+ *
+ * @private thing of inline knowledge
+ */
+export type InlineKnowledgeSourceFile = {
+    readonly filename: string_filename;
+    readonly mimeType: string;
+    readonly url: string_data_url;
+};
+/**
+ * Creates a data URL that represents the inline knowledge content as a text file.
+ *
+ * @private thing of inline knowledge
+ */
+export declare function createInlineKnowledgeSourceFile(content: string): InlineKnowledgeSourceFile;
+/**
+ * Checks whether the provided source string is a data URL that can be decoded.
+ *
+ * @private thing of inline knowledge
+ */
+export declare function isDataUrlKnowledgeSource(source: string): source is string_data_url;
+/**
+ * Parses a data URL-based knowledge source into its raw buffer, filename, and MIME type.
+ *
+ * @private thing of inline knowledge
+ */
+export declare function parseDataUrlKnowledgeSource(source: string): {
+    readonly buffer: Buffer;
+    readonly filename: string_filename;
+    readonly mimeType: string;
+} | null;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/utils/knowledge/inlineKnowledgeSource.test.d.ts

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

package/esm/typings/src/utils/language/getBrowserPreferredSpeechRecognitionLanguage.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @@@
+ *
+ * @private function of Agents Server speech recognition language resolution, not a general-purpose utility
+ */
+type ResolveSpeechRecognitionLanguageOptions = {
+    /**
+     * Overrides the default language resolution when provided.
+     */
+    readonly overrideLanguage?: string | null;
+    /**
+     * Optional Accept-Language header string to derive the speaker language from server-side requests.
+     */
+    readonly acceptLanguageHeader?: string | null;
+};
+/**
+ * Parses the primary language out of an Accept-Language header value.
+ *
+ * @private function of Agents Server speech recognition language resolution, not a general-purpose utility
+ */
+export declare function parseSpeechRecognitionLanguageFromAcceptLanguageHeader(header?: string | null): string | undefined;
+/**
+ * Reads the browser-reported preferred language list and returns the first valid tag.
+ *
+ * @private function of Agents Server speech recognition language resolution, not a general-purpose utility
+ */
+export declare function getBrowserPreferredSpeechRecognitionLanguage(): string | undefined;
+/**
+ * Resolves a speech recognition language tag by checking an optional override, then the Accept-Language header,
+ * then the browser preferences, and finally falling back to a default of `en-US`.
+ *
+ * @private function of Agents Server speech recognition language resolution, not a general-purpose utility
+ */
+export declare function resolveSpeechRecognitionLanguage(options?: ResolveSpeechRecognitionLanguageOptions): string;
+export {};

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.110.0-7`).
+ * It follows semantic versioning (e.g., `0.110.0-8`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/javascript",
-    "version": "0.110.0-8",
+    "version": "0.110.0-9",
     "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.110.0-8"
+        "@promptbook/core": "0.110.0-9"
     },
     "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.110.0-8';
+    const PROMPTBOOK_ENGINE_VERSION = '0.110.0-9';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name