@promptbook/documents 0.105.0-3 → 0.105.0-5

package/README.md

@@ -61,19 +61,20 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
 
 ## 📖 The Book Whitepaper
 
-For most business applications nowadays, the biggest challenge isn't about the raw capabilities of AI models. Large language models like GPT-5 or Claude-4.1 are extremely capable.
+Nowadays, the biggest challenge for most business applications isn't the raw capabilities of AI models. Large language models such as GPT-5.2 and Claude-4.5 are incredibly capable.
 
-The main challenge is to narrow it down, constrain it, set the proper **context, rules, knowledge, and personality**. There are a lot of tools which can do exactly this. On one side, there are no-code platforms which can launch your agent in seconds. On the other side, there are heavy frameworks like Langchain or Semantic Kernel, which can give you deep control.
+The main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.
 
-Promptbook takes the best from both worlds. You are defining your AI behavior by simple **books**, which are very explicit. They are automatically enforced, but they are very easy to understand, very easy to write, and very reliable and portable.
+In Promptbook, you can define your context **using simple Books** that are very explicit, easy to understand and write, reliable, and highly portable.
 
 <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
 
-**<ins>Paul Smith & Associés</ins>**<br/>
+**<ins>Paul Smith</ins>**<br/>
 <br/>
 **PERSONA** You are a company lawyer.<br/>
 Your job is to provide legal advice and support to the company and its employees.<br/>
-You are knowledgeable, professional, and detail-oriented.<br/>
+**RULE** You are knowledgeable, professional, and detail-oriented.<br/>
+TEAM You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law.<br/>
 
 </td></tr></table>
 
@@ -83,7 +84,9 @@ You are knowledgeable, professional, and detail-oriented.<br/>
 
 We have created a language called **Book**, which allows you to write AI agents in their native language and create your own AI persona. Book provides a guide to define all the traits and commitments.
 
-You can look at it as prompting (or writing a system message), but decorated by **commitments**.
+You can look at it as "prompting" _(or writing a system message)_, but decorated by **commitments**.
+
+**Commitments** are special syntax elements that define contracts between you and the AI agent. They are transformed by Promptbook Engine into low-level parameters like which model to use, its temperature, system message, RAG index, MCP servers, and many other parameters. For some commitments _(for example `RULE` commitment)_ Promptbook Engine can even create adversary agents and extra checks to enforce the rules.
 
 #### `Persona` commitment
 
@@ -94,8 +97,6 @@ Personas define the character of your AI persona, its role, and how it should in
 **<ins>Paul Smith & Associés</ins>**<br/>
 <br/>
 **PERSONA** You are a company lawyer.<br/>
-Your job is to provide legal advice and support to the company and its employees.<br/>
-You are knowledgeable, professional, and detail-oriented.<br/>
 
 </td></tr></table>
 
@@ -115,7 +116,7 @@ Promptbook Engine will automatically enforce this knowledge during interactions.
 Your job is to provide legal advice and support to the company and its employees.<br/>
 You are knowledgeable, professional, and detail-oriented.<br/>
 <br/>
-**KNOWLEDGE** https://company.com/company-policies.pdf<br/>
+**KNOWLEDGE**  https://company.com/company-policies.pdf<br/>
 **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
 
 </td></tr></table>
@@ -137,14 +138,14 @@ You are knowledgeable, professional, and detail-oriented.<br/>
 **RULE** Always ensure compliance with laws and regulations.<br/>
 **RULE** Never provide legal advice outside your area of expertise.<br/>
 **RULE** Never provide legal advice about criminal law.<br/>
-**KNOWLEDGE** https://company.com/company-policies.pdf<br/>
+**KNOWLEDGE**  https://company.com/company-policies.pdf<br/>
 **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
 
 </td></tr></table>
 
-#### `Action` commitment
+#### `Team` commitment
 
-Action Commitment allows you to define specific actions that the AI can take during interactions. This can include things like posting on a social media platform, sending emails, creating calendar events, or interacting with your internal systems.
+Team commitment allows you to define the team structure and advisory fellow members the AI can consult with. This allows the AI to simulate collaboration and consultation with other experts, enhancing the quality of its responses.
 
 <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
 
@@ -157,81 +158,36 @@ You are knowledgeable, professional, and detail-oriented.<br/>
 **RULE** Always ensure compliance with laws and regulations.<br/>
 **RULE** Never provide legal advice outside your area of expertise.<br/>
 **RULE** Never provide legal advice about criminal law.<br/>
-**KNOWLEDGE** https://company.com/company-policies.pdf<br/>
+**KNOWLEDGE**  https://company.com/company-policies.pdf<br/>
 **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
-**ACTION** When a user asks about an issue that could be treated as a crime, notify legal@company.com.<br/>
+TEAM You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law.<br/>
 
 </td></tr></table>
 
-[Read more about the language](./BLUEPRINT.md)
-
-<div style="page-break-after: always;"></div>
-
-### Where to use your AI agent in book
-
-Books can be useful in various applications and scenarios. Here are some examples:
-
-#### Chat apps:
 
-Create your own chat shopping assistant and place it in your eShop.
-You will be able to answer customer questions, help them find products, and provide personalized recommendations. Everything is tightly controlled by the book you have written.
 
-#### Reply Agent:
+### Promptbook Ecosystem
 
-Create your own AI agent, which will look at your emails and reply to them. It can even create drafts for you to review before sending.
+!!!@@@
 
-#### Coding Agent:
-
-Do you love Vibecoding, but the AI code is not always aligned with your coding style and architecture, rules, security, etc.? Create your own coding agent to help enforce your specific coding standards and practices.
-
-This can be integrated to almost any Vibecoding platform, like GitHub Copilot, Amazon CodeWhisperer, Cursor, Cline, Kilocode, Roocode,...
-
-They will work the same as you are used to, but with your specific rules written in book.
-
-#### Internal Expertise
-
-Do you have an app written in TypeScript, Python, C#, Java, or any other language, and you are integrating the AI.
-
-You can avoid struggle with choosing the best model, its settings like temperature, max tokens, etc., by writing a book agent and using it as your AI expertise.
-
-Doesn't matter if you do automations, data analysis, customer support, sentiment analysis, classification, or any other task. Your AI agent will be tailored to your specific needs and requirements.
-
-Even works in no-code platforms!
-
-<div style="page-break-after: always;"></div>
+#### Promptbook Server
 
-### How to create your AI agent in book
+!!!@@@
 
-Now you want to use it. There are several ways how to write your first book:
+#### Promptbook Engine
 
-#### From scratch with help from Paul
+!!!@@@
 
-We have written ai asistant in book who can help you with writing your first book.
 
-#### Your AI twin
 
-Copy your own behavior, personality, and knowledge into book and create your AI twin. It can help you with your work, personal life, or any other task.
 
-#### AI persona workpool
 
-Or you can pick from our library of pre-written books for various roles and tasks. You can find books for customer support, coding, marketing, sales, HR, legal, and many other roles.
 
 
 
 
 
 
-## 🚀 Get started
-
-Take a look at the simple starter kit with books integrated into the **Hello World** sample applications:
-
--   [Hello Book](https://github.com/webgptorg/hello-world)
--   [Hello Book in Node.js](https://github.com/webgptorg/hello-world-node-js)
--   [Hello Book in Next.js](https://github.com/webgptorg/hello-world-next-js)
-
-
-
-
 
 
 ## 💜 The Promptbook Project
@@ -247,33 +203,32 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
   </thead>
   <tbody>
     <tr>
-      <td><a href="https://github.com/webgptorg/book">Book language</a></td>
+      <td><a href="https://gallery.ptbk.io/">Agents Server</a></td>
       <td>
-          Book is a human-understandable markup language for writing AI applications such as chatbots, knowledge bases, agents, avarars, translators, automations and more.
-          <hr>
-          There is also <a href="https://github.com/webgptorg/book-extension">a plugin for VSCode</a> to support <code>.book</code> file extension
+          Place where you "AI agents live". It allows to create, manage, deploy, and interact with AI agents created in Book language.
       </td>
     </tr>
     <tr>
-      <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
+      <td><a href="https://github.com/webgptorg/book">Book language</a></td>
       <td>
-          Promptbook engine can run applications written in Book language. It is released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a> and <a href="https://hub.docker.com/r/hejny/promptbook">Docker HUB</a>
+          Human-friendly, high-level language that abstracts away low-level details of AI. It allows to focus on personality, behavior, knowledge, and rules of AI agents rather than on models, parameters, and prompt engineering.
+          <hr>
+          There is also <a href="https://github.com/webgptorg/book-extension">a plugin for VSCode</a> to support <code>.book</code> file extension
       </td>
     </tr>
     <tr>
-      <td><a href="https://promptbook.studio">Promptbook Studio</a></td>
+      <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
       <td>
-          Promptbook.studio is a web-based editor and runner for book applications. It is still in the experimental MVP stage.
+          Promptbook engine can run AI agents based on Book language.
+          It is released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a> and <a href="https://hub.docker.com/r/hejny/promptbook">Promptbook Agent Server as Docker Package</a>
+          Agent Server is based on Promptbook Engine.
       </td>
     </tr>
+    
   </tbody>
 </table>
 
-Hello world examples:
 
--   [Hello world](https://github.com/webgptorg/hello-world)
--   [Hello world in Node.js](https://github.com/webgptorg/hello-world-node-js)
--   [Hello world in Next.js](https://github.com/webgptorg/hello-world-next-js)
 
 ### 🌐 Community & Social Media
 
@@ -331,6 +286,8 @@ Join our growing community of developers and users:
 
 
 
+
+
 ## 📚 Documentation
 
 See detailed guides and API reference in the [docs](https://github.com/webgptorg/promptbook/discussions/categories/concepts) or [online](https://discord.gg/x3QWNaa89N).
@@ -407,6 +364,8 @@ The following glossary is used to clarify certain concepts:
 
 _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
 
+
+
 ### 💯 Core concepts
 
 -   [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)

package/esm/index.es.js

@@ -26,7 +26,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.105.0-3';
+const PROMPTBOOK_ENGINE_VERSION = '0.105.0-5';
 /**
  * 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/browser.index.d.ts

@@ -1,6 +1,7 @@
 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { SimplePromptInterfaceTools } from '../dialogs/simple-prompt/SimplePromptInterfaceTools';
 import { $provideScrapersForBrowser } from '../scrapers/_common/register/$provideScrapersForBrowser';
+import { BrowserSpeechRecognition } from '../speech-recognition/BrowserSpeechRecognition';
 import { getIndexedDbStorage } from '../storage/local-storage/getIndexedDbStorage';
 import { getLocalStorage } from '../storage/local-storage/getLocalStorage';
 import { getSessionStorage } from '../storage/local-storage/getSessionStorage';
@@ -10,6 +11,7 @@ import { ObjectUrl } from '../utils/files/ObjectUrl';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { SimplePromptInterfaceTools };
 export { $provideScrapersForBrowser };
+export { BrowserSpeechRecognition };
 export { getIndexedDbStorage };
 export { getLocalStorage };
 export { getSessionStorage };

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

@@ -183,6 +183,7 @@ import type { PostprocessingFunction } from '../scripting/javascript/JavascriptE
 import type { ToolFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
 import type { SearchEngine } from '../search-engines/SearchEngine';
 import type { SearchResult } from '../search-engines/SearchResult';
+import type { OpenAiSpeechRecognitionOptions } from '../speech-recognition/OpenAiSpeechRecognition';
 import type { PromptbookStorage } from '../storage/_common/PromptbookStorage';
 import type { FileCacheStorageOptions } from '../storage/file-cache-storage/FileCacheStorageOptions';
 import type { IndexedDbStorageOptions } from '../storage/local-storage/utils/IndexedDbStorageOptions';
@@ -207,6 +208,10 @@ import type { ImagePrompt } from '../types/Prompt';
 import type { EmbeddingPrompt } from '../types/Prompt';
 import type { ScriptLanguage } from '../types/ScriptLanguage';
 import type { SectionType } from '../types/SectionType';
+import type { SpeechRecognition } from '../types/SpeechRecognition';
+import type { SpeechRecognitionStartOptions } from '../types/SpeechRecognition';
+import type { SpeechRecognitionState } from '../types/SpeechRecognition';
+import type { SpeechRecognitionEvent } from '../types/SpeechRecognition';
 import type { TaskType } from '../types/TaskType';
 import type { string_char_emoji } from '../types/typeAliasEmoji';
 import type { string_business_category_name } from '../types/typeAliases';
@@ -316,6 +321,7 @@ import type { string_license_token } from '../types/typeAliases';
 import type { string_password } from '../types/typeAliases';
 import type { string_ssh_key } from '../types/typeAliases';
 import type { string_pgp_key } from '../types/typeAliases';
+import type { string_language } from '../types/typeAliases';
 import type { string_date_iso8601 } from '../types/typeAliases';
 import type { number_usd } from '../types/typeAliases';
 import type { number_id } from '../types/typeAliases';
@@ -557,6 +563,7 @@ export type { PostprocessingFunction };
 export type { ToolFunction };
 export type { SearchEngine };
 export type { SearchResult };
+export type { OpenAiSpeechRecognitionOptions };
 export type { PromptbookStorage };
 export type { FileCacheStorageOptions };
 export type { IndexedDbStorageOptions };
@@ -581,6 +588,10 @@ export type { ImagePrompt };
 export type { EmbeddingPrompt };
 export type { ScriptLanguage };
 export type { SectionType };
+export type { SpeechRecognition };
+export type { SpeechRecognitionStartOptions };
+export type { SpeechRecognitionState };
+export type { SpeechRecognitionEvent };
 export type { TaskType };
 export type { string_char_emoji };
 export type { string_business_category_name };
@@ -690,6 +701,7 @@ export type { string_license_token };
 export type { string_password };
 export type { string_ssh_key };
 export type { string_pgp_key };
+export type { string_language };
 export type { string_date_iso8601 };
 export type { number_usd };
 export type { number_id };

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

@@ -31,7 +31,7 @@ export type AgentCapability = {
     /**
      * The type of the capability
      */
-    type: 'browser' | 'search-engine' | 'knowledge' | 'time';
+    type: 'browser' | 'search-engine' | 'knowledge' | 'time' | 'inheritance' | 'import';
     /**
      * The label to display for this capability
      */
@@ -40,6 +40,11 @@ export type AgentCapability = {
      * The name of the icon to display for this capability
      */
     iconName: string;
+    /**
+     * Optional link to another agent
+     * This is used for 'inheritance' and 'import' types
+     */
+    agentUrl?: string_agent_url;
 };
 export type AgentBasicInformation = {
     /**

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

@@ -5,6 +5,7 @@ import type { ChatMessage } from '../types/ChatMessage';
 import type { ChatParticipant } from '../types/ChatParticipant';
 import { string_color } from '../../../types/typeAliases';
 import { Color } from '../../../_packages/color.index';
+import { SpeechRecognition } from '../../../types/SpeechRecognition';
 /**
  * @public exported from `@promptbook/components`
  */
@@ -47,13 +48,9 @@ export type ChatProps = {
      */
     readonly isVoiceRecognitionButtonShown?: boolean;
     /**
-     * Optional callback to trigger voice input
+     * Speech recognition provider
      */
-    onVoiceInput?(): void;
-    /**
-     * The language code to use for voice recognition
-     */
-    readonly voiceLanguage?: string;
+    readonly speechRecognition?: SpeechRecognition;
     /**
      * Optional placeholder message for the textarea
      *

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

@@ -33,6 +33,15 @@ export type ChatMessage = Omit<Message<id>, 'direction' | 'recipients' | 'thread
      * Indicates if the message was sent via a voice call
      */
     isVoiceCall?: boolean;
+    /**
+     * Optional tool calls made during the execution
+     */
+    readonly ongoingToolCalls?: ReadonlyArray<{
+        /**
+         * Name of the tool
+         */
+        readonly name: string;
+    }>;
     /**
      * Optional file attachments
      */

package/esm/typings/src/execution/LlmExecutionTools.d.ts

@@ -56,7 +56,9 @@ export type LlmExecutionTools = {
     /**
      * Calls a chat model with streaming
      */
-    callChatModelStream?(prompt: Prompt, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
+    callChatModelStream?(prompt: Prompt, onProgress: (chunk: ChatPromptResult & {
+        isFinished?: boolean;
+    }) => void): Promise<ChatPromptResult>;
     /**
      * Calls a voice chat model
      */

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

@@ -39,10 +39,17 @@ export declare abstract class OpenAiCompatibleExecutionTools implements LlmExecu
      * List all available OpenAI compatible models that can be used
      */
     listModels(): Promise<ReadonlyArray<AvailableModel>>;
+    /**
+     * Calls OpenAI compatible API to use a chat model.
+     */
     /**
      * Calls OpenAI compatible API to use a chat model.
      */
     callChatModel(prompt: Prompt): Promise<ChatPromptResult>;
+    /**
+     * Calls OpenAI compatible API to use a chat model with streaming.
+     */
+    callChatModelStream(prompt: Prompt, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
     /**
      * Internal method that handles parameter retry for chat model calls
      */

package/esm/typings/src/search-engines/_index.d.ts

@@ -0,0 +1,6 @@
+export * from './bing/BingSearchEngine';
+export * from './dummy/DummySearchEngine';
+export * from './google/GoogleSearchEngine';
+export * from './SearchEngine';
+export * from './SearchResult';
+export * from './serp/SerpSearchEngine';

package/esm/typings/src/search-engines/google/GoogleSearchEngine.d.ts

@@ -0,0 +1,18 @@
+import type { Promisable } from 'type-fest';
+import type { string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
+import type { SearchEngine } from '../SearchEngine';
+import type { SearchResult } from '../SearchResult';
+/**
+ * A search engine implementation that uses the Google Custom Search JSON API.
+ *
+ * @private <- TODO: !!!! Export via some package
+ */
+export declare class GoogleSearchEngine implements SearchEngine {
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    /**
+     * @see https://developers.google.com/custom-search/v1/overview
+     */
+    checkConfiguration(): Promisable<void>;
+    search(query: string): Promise<SearchResult[]>;
+}

package/esm/typings/src/search-engines/serp/SerpSearchEngine.d.ts

@@ -0,0 +1,15 @@
+import type { Promisable } from 'type-fest';
+import type { string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
+import type { SearchEngine } from '../SearchEngine';
+import type { SearchResult } from '../SearchResult';
+/**
+ * A search engine implementation that uses the SerpApi to fetch Google search results.
+ *
+ * @private <- TODO: !!!! Export via some package
+ */
+export declare class SerpSearchEngine implements SearchEngine {
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    checkConfiguration(): Promisable<void>;
+    search(query: string): Promise<SearchResult[]>;
+}

package/esm/typings/src/speech-recognition/BrowserSpeechRecognition.d.ts

@@ -0,0 +1,21 @@
+import type { SpeechRecognition, SpeechRecognitionEvent, SpeechRecognitionStartOptions, SpeechRecognitionState } from '../types/SpeechRecognition';
+/**
+ * Speech recognition using Web Speech API `SpeechRecognition` available in modern browsers
+ *
+ * @public exported from `@promptbook/browser`
+ */
+export declare class BrowserSpeechRecognition implements SpeechRecognition {
+    private recognition;
+    private callbacks;
+    private _state;
+    get state(): SpeechRecognitionState;
+    constructor();
+    $start(options?: SpeechRecognitionStartOptions): void;
+    $stop(): void;
+    subscribe(callback: (event: SpeechRecognitionEvent) => void): () => void;
+    private emit;
+}
+/**
+ * TODO: !!!! Search ACRY for `window` and put -> [🔵]
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
+ */

package/esm/typings/src/speech-recognition/OpenAiSpeechRecognition.d.ts

@@ -0,0 +1,32 @@
+import type { SpeechRecognition, SpeechRecognitionEvent, SpeechRecognitionStartOptions, SpeechRecognitionState } from '../types/SpeechRecognition';
+/**
+ * Options for OpenAiSpeechRecognition
+ */
+export type OpenAiSpeechRecognitionOptions = {
+    /**
+     * OpenAI API base URL or proxy endpoint
+     * @default '/api/openai/v1'
+     */
+    readonly baseUrl?: string;
+};
+/**
+ * Speech recognition using OpenAI Whisper API to transcribe audio into text
+ *
+ * @private because it requires server-client communication with a proxy endpoint
+ *
+ * Note: This implementation uses a server-side proxy to avoid exposing the OpenAI API key on the client.
+ */
+export declare class OpenAiSpeechRecognition implements SpeechRecognition {
+    private readonly options;
+    private mediaRecorder;
+    private audioChunks;
+    private callbacks;
+    private _state;
+    get state(): SpeechRecognitionState;
+    constructor(options?: OpenAiSpeechRecognitionOptions);
+    $start(options?: SpeechRecognitionStartOptions): Promise<void>;
+    $stop(): void;
+    private transcribe;
+    subscribe(callback: (event: SpeechRecognitionEvent) => void): () => void;
+    private emit;
+}

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

@@ -0,0 +1,58 @@
+import type { string_language } from './typeAliases';
+/**
+ * Interface for speech-to-text recognition
+ *
+ * @🚉 fully serializable as JSON
+ */
+export type SpeechRecognition = {
+    /**
+     * Start the speech recognition
+     */
+    $start(options: SpeechRecognitionStartOptions): void;
+    /**
+     * Stop the speech recognition
+     */
+    $stop(): void;
+    /**
+     * Current state of the speech recognition
+     */
+    readonly state: SpeechRecognitionState;
+    /**
+     * Subscribe to speech recognition events
+     */
+    subscribe(callback: (event: SpeechRecognitionEvent) => void): () => void;
+};
+/**
+ * Options for starting speech recognition
+ */
+export type SpeechRecognitionStartOptions = {
+    /**
+     * Language for speech recognition
+     * @default 'en-US'
+     */
+    readonly language?: string_language;
+    /**
+     * Whether to return interim results
+     * @default true
+     */
+    readonly interimResults?: boolean;
+};
+/**
+ * Current state of the speech recognition
+ */
+export type SpeechRecognitionState = 'IDLE' | 'STARTING' | 'RECORDING' | 'TRANSCRIBING' | 'ERROR';
+/**
+ * Event emitted by speech recognition
+ */
+export type SpeechRecognitionEvent = {
+    readonly type: 'START';
+} | {
+    readonly type: 'RESULT';
+    readonly text: string;
+    readonly isFinal: boolean;
+} | {
+    readonly type: 'ERROR';
+    readonly message: string;
+} | {
+    readonly type: 'STOP';
+};

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

@@ -668,6 +668,10 @@ export type string_license_token = string_token;
 export type string_password = string;
 export type string_ssh_key = string;
 export type string_pgp_key = string;
+/**
+ * Language as a string, e.g. 'en-US', 'cs-CZ', 'en'
+ */
+export type string_language = string;
 /**
  * Semantic helper for `Date.toISOString()` result
  *

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/documents",
-    "version": "0.105.0-3",
+    "version": "0.105.0-5",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -95,7 +95,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/documents.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.105.0-3"
+        "@promptbook/core": "0.105.0-5"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

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