@promptbook/javascript 0.105.0-9 → 0.105.0

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

@@ -23,7 +23,12 @@ export declare class RemoteAgent extends Agent {
     private agentUrl;
     private _remoteAgentName;
     private _remoteAgentHash;
+    toolTitles: Record<string, string>;
     private _isVoiceCallingEnabled;
+    knowledgeSources: Array<{
+        url: string;
+        filename: string;
+    }>;
     private constructor();
     get agentName(): string_agent_name;
     get agentHash(): string_agent_hash;

package/esm/typings/src/llm-providers/google/createGoogleExecutionTools.d.ts

@@ -10,5 +10,6 @@ export declare const createGoogleExecutionTools: ((options: GoogleExecutionTools
     className: string;
 };
 /**
+ * TODO: !!!!! Rename to `createGoogleLlmExecutionTools`, `...GoogleLlmExecutionTools`
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

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

@@ -0,0 +1,43 @@
+import OpenAI from 'openai';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { ChatPromptResult } from '../../execution/PromptResult';
+import type { Prompt } from '../../types/Prompt';
+import type { string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
+import type { OpenAiCompatibleExecutionToolsNonProxiedOptions } from './OpenAiCompatibleExecutionToolsOptions';
+import { OpenAiExecutionTools } from './OpenAiExecutionTools';
+/**
+ * Options for OpenAiAgentExecutionTools
+ */
+export type OpenAiAgentExecutionToolsOptions = OpenAiCompatibleExecutionToolsNonProxiedOptions & {
+    /**
+     * ID of the vector store to use for file search
+     */
+    readonly vectorStoreId?: string;
+};
+/**
+ * Execution Tools for calling OpenAI API using the Responses API (Agents)
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export declare class OpenAiAgentExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
+    readonly vectorStoreId?: string;
+    constructor(options: OpenAiAgentExecutionToolsOptions);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    /**
+     * Calls OpenAI API to use a chat model with streaming.
+     */
+    callChatModelStream(prompt: Prompt, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
+    /**
+     * Creates a vector store from knowledge sources
+     */
+    static createVectorStore(client: OpenAI, name: string, knowledgeSources: ReadonlyArray<string>): Promise<string>;
+    /**
+     * Discriminant for type guards
+     */
+    protected get discriminant(): string;
+    /**
+     * Type guard to check if given `LlmExecutionTools` are instanceof `OpenAiAgentExecutionTools`
+     */
+    static isOpenAiAgentExecutionTools(llmExecutionTools: LlmExecutionTools): llmExecutionTools is OpenAiAgentExecutionTools;
+}

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

@@ -18,6 +18,7 @@ import { OpenAiExecutionTools } from './OpenAiExecutionTools';
  * - `RemoteAgent` - which is an `Agent` that connects to a Promptbook Agents Server
  *
  * @public exported from `@promptbook/openai`
+ * @deprecated Use `OpenAiAgentExecutionTools` instead which uses the new OpenAI Responses API
  */
 export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
     readonly assistantId: string_token;
@@ -33,11 +34,11 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
     /**
      * Calls OpenAI API to use a chat model.
      */
-    callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'format'>): Promise<ChatPromptResult>;
+    callChatModel(prompt: Prompt): Promise<ChatPromptResult>;
     /**
      * Calls OpenAI API to use a chat model with streaming.
      */
-    callChatModelStream(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'format'>, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
+    callChatModelStream(prompt: Prompt, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
     /**
      * Get an existing assistant tool wrapper
      */
@@ -94,6 +95,7 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
     static isOpenAiAssistantExecutionTools(llmExecutionTools: LlmExecutionTools): llmExecutionTools is OpenAiAssistantExecutionTools;
 }
 /**
+ * TODO: !!!!! [✨🥚] Knowledge should work both with and without scrapers
  * TODO: [🙎] In `OpenAiAssistantExecutionTools` Allow to create abstract assistants with `isCreatingNewAssistantsAllowed`
  * TODO: [🧠][🧙‍♂️] Maybe there can be some wizard for those who want to use just OpenAI
  * TODO: Maybe make custom OpenAiError

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

@@ -73,7 +73,7 @@ export declare abstract class OpenAiCompatibleExecutionTools implements LlmExecu
     /**
      * Calls OpenAI compatible API to use a image generation model
      */
-    callImageGenerationModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<ImagePromptResult>;
+    callImageGenerationModel(prompt: Prompt): Promise<ImagePromptResult>;
     /**
      * Internal method that handles parameter retry for image generation model calls
      */

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

@@ -0,0 +1,11 @@
+import { OpenAiAgentExecutionTools } from './OpenAiAgentExecutionTools';
+import type { OpenAiAgentExecutionToolsOptions } from './OpenAiAgentExecutionTools';
+/**
+ * Execution Tools for calling OpenAI API using Responses API
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export declare const createOpenAiAgentExecutionTools: ((options: OpenAiAgentExecutionToolsOptions) => OpenAiAgentExecutionTools) & {
+    packageName: string;
+    className: string;
+};

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

@@ -0,0 +1,7 @@
+import OpenAI from 'openai';
+/**
+ * Uploads files to OpenAI and returns their IDs
+ *
+ * @private utility for `OpenAiAssistantExecutionTools` and `OpenAiCompatibleExecutionTools`
+ */
+export declare function uploadFilesToOpenAi(client: OpenAI, files: Array<File>): Promise<Array<string>>;

package/esm/typings/src/pipeline/prompt-notation.d.ts

@@ -1,4 +1,28 @@
 import type { string_prompt } from '../types/typeAliases';
+import type { really_unknown } from '../utils/organization/really_unknown';
+/**
+ * Prompt string wrapper to retain prompt context across interpolations.
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare class PromptString extends String {
+    /**
+     * @param value Prompt content.
+     */
+    constructor(value: string_prompt);
+    /**
+     * Returns the prompt as a primitive string.
+     */
+    toString(): string_prompt;
+    /**
+     * Returns the prompt as a primitive string for implicit coercion.
+     */
+    valueOf(): string_prompt;
+    /**
+     * Ensures template literal coercion returns the raw string.
+     */
+    [Symbol.toPrimitive](): string_prompt;
+}
 /**
  * Tag function for notating a prompt as template literal
  *
@@ -9,10 +33,10 @@ import type { string_prompt } from '../types/typeAliases';
  *
  * @param strings
  * @param values
- * @returns the prompt string
+ * @returns prompt content wrapped as a PromptString
  * @public exported from `@promptbook/utils`
  */
-export declare function prompt(strings: TemplateStringsArray, ...values: Array<string>): string_prompt;
+export declare function prompt(strings: TemplateStringsArray, ...values: Array<really_unknown>): PromptString;
 /**
  * Tag function for notating a prompt as template literal
  *
@@ -26,6 +50,7 @@ export declare function prompt(strings: TemplateStringsArray, ...values: Array<s
  */
 export declare const promptTemplate: typeof prompt;
 /**
+ * TODO: Maybe split into multiple files
  * TODO: [🧠][🈴] Where is the best location for this file
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */

package/esm/typings/src/pipeline/prompt-notation.test.d.ts

@@ -1,4 +1,4 @@
 export {};
 /**
- * TODO: [🧠][🈴] Where is the best location for this file
+ * TODO: [??][??] Where is the best location for this file
  */

package/esm/typings/src/scrapers/_common/register/$provideFilesystemForNode.d.ts

@@ -9,4 +9,5 @@ import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeO
 export declare function $provideFilesystemForNode(options?: Pick<PrepareAndScrapeOptions, 'isVerbose'>): FilesystemTools;
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
  */

package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts

@@ -10,4 +10,5 @@ import type { Scraper } from '../Scraper';
 export declare function $provideScrapersForNode(tools: Pick<ExecutionTools, 'fs' | 'llm' | 'executables'>, options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<Scraper>>;
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
  */

package/esm/typings/src/scrapers/_common/register/$provideScriptingForNode.d.ts

@@ -8,4 +8,5 @@ import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeO
 export declare function $provideScriptingForNode(options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<ScriptExecutionTools>>;
 /**
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
  */

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

@@ -5,5 +5,5 @@ export type SearchEngine = {
     readonly title: string_title & string_markdown_text;
     readonly description?: string_markdown;
     checkConfiguration(): Promisable<void>;
-    search(query: string): Promise<SearchResult[]>;
+    search(query: string, options?: Record<string, unknown>): Promise<SearchResult[]>;
 };

package/esm/typings/src/search-engines/bing/BingSearchEngine.d.ts

@@ -11,5 +11,5 @@ export declare class BingSearchEngine implements SearchEngine {
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
     checkConfiguration(): Promisable<void>;
-    search(query: string): Promise<SearchResult[]>;
+    search(query: string, options?: Record<string, unknown>): Promise<SearchResult[]>;
 }

package/esm/typings/src/search-engines/dummy/DummySearchEngine.d.ts

@@ -11,5 +11,5 @@ export declare class DummySearchEngine implements SearchEngine {
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
     checkConfiguration(): Promisable<void>;
-    search(query: string): Promise<SearchResult[]>;
+    search(query: string, options?: Record<string, unknown>): Promise<SearchResult[]>;
 }

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

@@ -14,5 +14,5 @@ export declare class GoogleSearchEngine implements SearchEngine {
      * @see https://developers.google.com/custom-search/v1/overview
      */
     checkConfiguration(): Promisable<void>;
-    search(query: string): Promise<SearchResult[]>;
+    search(query: string, options?: Record<string, unknown>): Promise<SearchResult[]>;
 }

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

@@ -11,5 +11,5 @@ 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[]>;
+    search(query: string, options?: Record<string, unknown>): Promise<SearchResult[]>;
 }

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

@@ -19,6 +19,9 @@ export type OpenAiSpeechRecognitionOptions = {
 export declare class OpenAiSpeechRecognition implements SpeechRecognition {
     private readonly options;
     private mediaRecorder;
+    private audioContext;
+    private analyser;
+    private silenceTimeout;
     private audioChunks;
     private callbacks;
     private _state;

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

@@ -129,6 +129,12 @@ export type CommonModelRequirements = {
      * Note: [🚉] This is fully serializable as JSON
      */
     readonly tools?: LlmToolDefinition[];
+    /**
+     * Optional list of knowledge source links that the model can use
+     *
+     * Note: [🚉] This is fully serializable as JSON
+     */
+    readonly knowledgeSources?: string[];
 };
 /**
  * TODO: [🧠][🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (similar that `user` identification is not here)

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

@@ -57,6 +57,10 @@ export type ChatPrompt = CommonPrompt & {
      * Optional tools that can be called by the model
      */
     tools?: Array<LlmToolDefinition>;
+    /**
+     * Optional file attachments
+     */
+    files?: Array<File>;
 };
 /**
  * Image prompt
@@ -68,6 +72,14 @@ export type ImagePrompt = CommonPrompt & {
      * Requirements for image generation model
      */
     modelRequirements: ImageGenerationModelRequirements;
+    /**
+     * Optional file attachments
+     */
+    attachments?: Array<{
+        name: string;
+        type: string;
+        url: string;
+    }>;
 };
 /**
  * Embedding prompt

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

@@ -0,0 +1,37 @@
+import type { string_date_iso8601 } from './typeAliases';
+import type { TODO_any } from '../utils/organization/TODO_any';
+/**
+ * Represents a single tool call with its inputs, outputs, and timing.
+ *
+ * Note: This is fully serializable as JSON.
+ */
+export type ToolCall = {
+    /**
+     * Name of the tool.
+     */
+    readonly name: string;
+    /**
+     * Arguments for the tool call.
+     */
+    readonly arguments?: string | Record<string, TODO_any>;
+    /**
+     * Result of the tool call.
+     */
+    readonly result?: TODO_any;
+    /**
+     * Raw tool call payload from the model.
+     */
+    readonly rawToolCall?: TODO_any;
+    /**
+     * Timestamp when the tool call was initiated.
+     */
+    readonly createdAt?: string_date_iso8601;
+    /**
+     * Errors thrown during tool execution.
+     */
+    readonly errors?: ReadonlyArray<TODO_any>;
+    /**
+     * Warnings reported during tool execution.
+     */
+    readonly warnings?: ReadonlyArray<TODO_any>;
+};

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

@@ -1,5 +1,4 @@
-import type { string_markdown } from '../../types/typeAliases';
-import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_markdown, string_markdown_text } from '../../types/typeAliases';
 /**
  * Utility function to extract all list items from markdown
  *

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

@@ -1,6 +1,6 @@
 import type { string_markdown } from '../../types/typeAliases';
 /**
- * Change ellipsis character to three dots `…` -> `...`
+ * Change ellipsis characters and dot leaders to three dots `…` -> `...`
  *
  * Note: [🔂] This function is idempotent.
  * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`

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

@@ -1,6 +1,6 @@
 import type { string_markdown } from '../../types/typeAliases';
 /**
- * Change em-dashes to regular dashes `—` -> `-`
+ * Change dash-like characters to regular dashes `—` -> `-` and remove soft hyphens
  *
  * Note: [🔂] This function is idempotent.
  * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`

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

@@ -1,6 +1,6 @@
 import type { string_markdown } from '../../types/typeAliases';
 /**
- * Change unprintable hard spaces to regular spaces
+ * Change unprintable hard spaces to regular spaces and drop zero-width spaces
  *
  * Note: [🔂] This function is idempotent.
  * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`

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

@@ -1,6 +1,4 @@
-import type { string_markdown_section } from '../../types/typeAliases';
-import type { string_markdown_section_content } from '../../types/typeAliases';
-import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_markdown_section, string_markdown_section_content, string_markdown_text } from '../../types/typeAliases';
 /**
  * Parsed markdown section
  *

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

@@ -1,5 +1,4 @@
-import type { string_markdown } from '../../types/typeAliases';
-import type { string_markdown_section } from '../../types/typeAliases';
+import type { string_markdown, string_markdown_section } from '../../types/typeAliases';
 /**
  * Splits the markdown into sections by headings
  *

package/esm/typings/src/utils/misc/linguisticHash.d.ts

@@ -1,6 +1,9 @@
 /**
- * Creates human-readable hash
+ * 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.
+ */

package/esm/typings/src/utils/parameters/templateParameters.d.ts

@@ -1,5 +1,4 @@
-import type { string_parameter_name } from '../../types/typeAliases';
-import type { string_template } from '../../types/typeAliases';
+import type { string_parameter_name, string_template } from '../../types/typeAliases';
 import type { really_unknown } from '../organization/really_unknown';
 /**
  * Replaces parameters in template with values from parameters object

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

package/esm/typings/src/wizard/wizard.d.ts

@@ -2,10 +2,7 @@ import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { PipelineExecutorResult } from '../execution/PipelineExecutorResult';
 import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 import type { PipelineString } from '../pipeline/PipelineString';
-import type { InputParameters } from '../types/typeAliases';
-import type { string_filename } from '../types/typeAliases';
-import type { string_parameter_value } from '../types/typeAliases';
-import type { string_pipeline_url } from '../types/typeAliases';
+import type { InputParameters, string_filename, string_parameter_value, string_pipeline_url } from '../types/typeAliases';
 /**
  * Options for wizard methods
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/javascript",
-    "version": "0.105.0-9",
+    "version": "0.105.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.105.0-9"
+        "@promptbook/core": "0.105.0"
     },
     "dependencies": {
         "crypto": "1.0.1",