@promptbook/openai 0.103.0-37 → 0.103.0-40

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

@@ -16,11 +16,11 @@ import { getAllCommitmentDefinitions } from '../book-2.0/commitments/index';
 import { getAllCommitmentTypes } from '../book-2.0/commitments/index';
 import { isCommitmentSupported } from '../book-2.0/commitments/index';
 import { generatePlaceholderAgentProfileImageUrl } from '../book-2.0/utils/generatePlaceholderAgentProfileImageUrl';
-import { collectionToJson } from '../collection/collectionToJson';
-import { createCollectionFromJson } from '../collection/constructors/createCollectionFromJson';
-import { createCollectionFromPromise } from '../collection/constructors/createCollectionFromPromise';
-import { createCollectionFromUrl } from '../collection/constructors/createCollectionFromUrl';
-import { createSubcollection } from '../collection/constructors/createSubcollection';
+import { createPipelineCollectionFromJson } from '../collection/pipeline-collection/constructors/createPipelineCollectionFromJson';
+import { createPipelineCollectionFromPromise } from '../collection/pipeline-collection/constructors/createPipelineCollectionFromPromise';
+import { createPipelineCollectionFromUrl } from '../collection/pipeline-collection/constructors/createPipelineCollectionFromUrl';
+import { createPipelineSubcollection } from '../collection/pipeline-collection/constructors/createPipelineSubcollection';
+import { pipelineCollectionToJson } from '../collection/pipeline-collection/pipelineCollectionToJson';
 import { NAME } from '../config';
 import { ADMIN_EMAIL } from '../config';
 import { ADMIN_GITHUB_NAME } from '../config';
@@ -44,6 +44,7 @@ import { DEFAULT_MAX_EXECUTION_ATTEMPTS } from '../config';
 import { DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH } from '../config';
 import { DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL } from '../config';
 import { DEFAULT_BOOKS_DIRNAME } from '../config';
+import { DEFAULT_AGENTS_DIRNAME } from '../config';
 import { DEFAULT_DOWNLOAD_CACHE_DIRNAME } from '../config';
 import { DEFAULT_EXECUTION_CACHE_DIRNAME } from '../config';
 import { DEFAULT_SCRAPE_CACHE_DIRNAME } from '../config';
@@ -200,11 +201,11 @@ export { getAllCommitmentDefinitions };
 export { getAllCommitmentTypes };
 export { isCommitmentSupported };
 export { generatePlaceholderAgentProfileImageUrl };
-export { collectionToJson };
-export { createCollectionFromJson };
-export { createCollectionFromPromise };
-export { createCollectionFromUrl };
-export { createSubcollection };
+export { createPipelineCollectionFromJson };
+export { createPipelineCollectionFromPromise };
+export { createPipelineCollectionFromUrl };
+export { createPipelineSubcollection };
+export { pipelineCollectionToJson };
 export { NAME };
 export { ADMIN_EMAIL };
 export { ADMIN_GITHUB_NAME };
@@ -228,6 +229,7 @@ export { DEFAULT_MAX_EXECUTION_ATTEMPTS };
 export { DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH };
 export { DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL };
 export { DEFAULT_BOOKS_DIRNAME };
+export { DEFAULT_AGENTS_DIRNAME };
 export { DEFAULT_DOWNLOAD_CACHE_DIRNAME };
 export { DEFAULT_EXECUTION_CACHE_DIRNAME };
 export { DEFAULT_SCRAPE_CACHE_DIRNAME };

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

@@ -1,5 +1,6 @@
 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
-import { createCollectionFromDirectory } from '../collection/constructors/createCollectionFromDirectory';
+import { AgentCollectionInDirectory } from '../collection/agent-collection/constructors/AgentCollectionInDirectory';
+import { createPipelineCollectionFromDirectory } from '../collection/pipeline-collection/constructors/createPipelineCollectionFromDirectory';
 import { $provideExecutablesForNode } from '../executables/$provideExecutablesForNode';
 import { $provideExecutionToolsForNode } from '../execution/utils/$provideExecutionToolsForNode';
 import { $provideLlmToolsConfigurationFromEnv } from '../llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv';
@@ -11,7 +12,8 @@ import { FileCacheStorage } from '../storage/file-cache-storage/FileCacheStorage
 import { $execCommand } from '../utils/execCommand/$execCommand';
 import { $execCommands } from '../utils/execCommand/$execCommands';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
-export { createCollectionFromDirectory };
+export { AgentCollectionInDirectory };
+export { createPipelineCollectionFromDirectory };
 export { $provideExecutablesForNode };
 export { $provideExecutionToolsForNode };
 export { $provideLlmToolsConfigurationFromEnv };

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

@@ -22,7 +22,8 @@ import type { ChatMessage } from '../book-components/Chat/types/ChatMessage';
 import type { ChatParticipant } from '../book-components/Chat/types/ChatParticipant';
 import type { MessageButton } from '../book-components/Chat/utils/parseMessageButtons';
 import type { QrCodeOptions } from '../book-components/Qr/useQrCode';
-import type { PipelineCollection } from '../collection/PipelineCollection';
+import type { AgentCollection } from '../collection/agent-collection/AgentCollection';
+import type { PipelineCollection } from '../collection/pipeline-collection/PipelineCollection';
 import type { Command } from '../commands/_common/types/Command';
 import type { CommandParser } from '../commands/_common/types/CommandParser';
 import type { PipelineBothCommandParser } from '../commands/_common/types/CommandParser';
@@ -362,6 +363,7 @@ export type { ChatMessage };
 export type { ChatParticipant };
 export type { MessageButton };
 export type { QrCodeOptions };
+export type { AgentCollection };
 export type { PipelineCollection };
 export type { Command };
 export type { CommandParser };

package/esm/typings/src/book-components/_common/Modal/Modal.d.ts

@@ -9,5 +9,5 @@ export declare function Modal({ children, onClose, className, }: {
     className?: string;
 }): import("react").ReactPortal;
 /**
- * TODO: !!!! Use this also for feedback modal in Chat component - Make modals DRY
+ * TODO: Use this also for feedback modal in Chat component - Make modals DRY
  */

package/esm/typings/src/cli/cli-commands/start-agents-server.d.ts

@@ -0,0 +1,14 @@
+import type { Command as Program } from 'commander';
+import { $side_effect } from '../../utils/organization/$side_effect';
+/**
+ * Initializes `start-agents-server` command for Promptbook CLI utilities
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it registers a command in the CLI
+ *
+ * @private internal function of `promptbookCli`
+ */
+export declare function $initializeStartAgentsServerCommand(program: Program): $side_effect;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
+ */

package/esm/typings/src/cli/cli-commands/{start-server.d.ts → start-pipelines-server.d.ts}

@@ -1,13 +1,13 @@
 import type { Command as Program } from 'commander';
 import { $side_effect } from '../../utils/organization/$side_effect';
 /**
- * Initializes `start-server` command for Promptbook CLI utilities
+ * Initializes `start-pipelines-server` command for Promptbook CLI utilities
  *
  * Note: `$` is used to indicate that this function is not a pure function - it registers a command in the CLI
  *
  * @private internal function of `promptbookCli`
  */
-export declare function $initializeStartServerCommand(program: Program): $side_effect;
+export declare function $initializeStartPipelinesServerCommand(program: Program): $side_effect;
 /**
  * TODO: [🕋] Use here `aboutPromptbookInformation`
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/collection/agent-collection/AgentCollection.d.ts

@@ -0,0 +1,36 @@
+import type { Promisable } from 'type-fest';
+import { Agent } from '../../_packages/core.index';
+import { string_book } from '../../_packages/types.index';
+import type { string_agent_name } from '../../types/typeAliases';
+/**
+ * Collection that groups together multiple AI Agents
+ *
+ * Note: [🧸] There are two types of collections:
+ * - `AgentCollection` - which groups together AI Agents
+ * - `PipelineCollection` - which groups together *(deprecated)* pipelines
+ */
+export type AgentCollection = {
+    /**
+     * Gets all agents in the collection
+     */
+    listAgents(): Promisable<ReadonlyArray<string_agent_name>>;
+    /**
+     * Get one agent by its name
+     *
+     * Note: Agents are existing independently of you getting them or not, you can get the same agent multiple times.
+     * Note: Agents are changed by interacting with `Agent` objects directly. Only creation and deletion is done via the collection.
+     */
+    getAgentByName(agentName: string_agent_name): Promisable<Agent>;
+    /**
+     * Deletes an agent from the collection
+     *
+     * Note: When you want delete an agent by name, first get the agent using `getAgentByName` and then pass it to `deleteAgent`.
+     */
+    deleteAgent(agent: Agent): Promisable<void>;
+    /**
+     * Creates a new agent in the collection
+     *
+     * Note: You can set 'PARENT' in the agent source to inherit from another agent in the collection.
+     */
+    createAgent(agentSource: string_book): Promisable<Agent>;
+};

package/esm/typings/src/collection/agent-collection/constructors/AgentCollectionInDirectory.d.ts

@@ -0,0 +1,88 @@
+import { Agent } from '../../../_packages/core.index';
+import { CommonToolsOptions, string_book } from '../../../_packages/types.index';
+import type { ExecutionTools } from '../../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+import type { string_agent_name, string_dirname } from '../../../types/typeAliases';
+import type { AgentCollection } from '../AgentCollection';
+/**
+ * Options for `createAgentCollectionFromDirectory` function
+ *
+ * Note: `rootDirname` is not needed because it is the folder in which `.book` or `.book` file is located
+ *       This is not same as `path` which is the first argument of `createAgentCollectionFromDirectory` - it can be a subfolder
+ */
+type CreateAgentCollectionInDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & CommonToolsOptions & {
+    /**
+     * If true, the directory is searched recursively for pipelines
+     *
+     * @default true
+     */
+    isRecursive?: boolean;
+    /**
+     * If true, directory will be scanned only when needed not during the construction
+     *
+     * @default false
+     */
+    isLazyLoaded?: boolean;
+    /**
+     * If true, whole collection creation crashes on error in any pipeline
+     * If true and isLazyLoaded is true, the error is thrown on first access to the pipeline
+     *
+     * @default true
+     */
+    isCrashedOnError?: boolean;
+};
+/**
+ * Agent collection stored in directory
+ *
+ * Note: Works only in Node.js environment because it reads the file system
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare class AgentCollectionInDirectory implements AgentCollection {
+    readonly rootPath: string_dirname;
+    private readonly tools?;
+    readonly options?: CreateAgentCollectionInDirectoryOptions | undefined;
+    /**
+     * @param rootPath - path to the directory with agents
+     * @param tools - Execution tools to be used in `Agent` itself and listing the agents
+     * @param options - Options for the collection creation
+     */
+    constructor(rootPath: string_dirname, tools?: Pick<ExecutionTools, "llm" | "fs" | "scrapers"> | undefined, options?: CreateAgentCollectionInDirectoryOptions | undefined);
+    /**
+     * Cached defined execution tools
+     */
+    private _definedTools;
+    /**
+     * Gets or creates execution tools for the collection
+     */
+    private getTools;
+    /**
+     * Gets all agents in the collection
+     */
+    listAgents(): Promise<ReadonlyArray<string_agent_name>>;
+    /**
+     * Get one agent by its name
+     *
+     * Note: Agents are existing independently of you getting them or not, you can get the same agent multiple times.
+     * Note: Agents are changed by interacting with `Agent` objects directly. Only creation and deletion is done via the collection.
+     */
+    getAgentByName(agentName: string_agent_name): Promise<Agent>;
+    /**
+     * Deletes an agent from the collection
+     *
+     * Note: When you want delete an agent by name, first get the agent using `getAgentByName` and then pass it to `deleteAgent`.
+     */
+    deleteAgent(agent: Agent): Promise<void>;
+    /**
+     * Creates a new agent in the collection
+     *
+     * Note: You can set 'PARENT' in the agent source to inherit from another agent in the collection.
+     */
+    createAgent(agentSource: string_book): Promise<Agent>;
+}
+export {};
+/**
+ * TODO: [🖇] What about symlinks? Maybe option `isSymlinksFollowed`
+ * TODO: [🧠] Maybe add option `isImmutable`
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/collection/{PipelineCollection.d.ts → pipeline-collection/PipelineCollection.d.ts}

@@ -1,9 +1,13 @@
 import type { Promisable } from 'type-fest';
-import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
-import type { Prompt } from '../types/Prompt';
-import type { string_pipeline_url } from '../types/typeAliases';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { Prompt } from '../../types/Prompt';
+import type { string_pipeline_url } from '../../types/typeAliases';
 /**
  * Collection that groups together pipelines, knowledge, personas, tools and actions
+ *
+ * Note: [🧸] There are two types of collections:
+ * - `AgentCollection` - which groups together AI Agents
+ * - `PipelineCollection` - which groups together *(deprecated)* pipelines
  */
 export type PipelineCollection = {
     /**

package/esm/typings/src/collection/{SimplePipelineCollection.d.ts → pipeline-collection/SimplePipelineCollection.d.ts}

@@ -1,12 +1,12 @@
-import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
-import type { Prompt } from '../types/Prompt';
-import type { string_pipeline_url } from '../types/typeAliases';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { Prompt } from '../../types/Prompt';
+import type { string_pipeline_url } from '../../types/typeAliases';
 import type { PipelineCollection } from './PipelineCollection';
 /**
  * Library of pipelines that groups together pipelines for an application.
  * This implementation is a very thin wrapper around the Array / Map of pipelines.
  *
- * @private internal function of `createCollectionFromJson`, use `createCollectionFromJson` instead
+ * @private internal function of `createPipelineCollectionFromJson`, use `createPipelineCollectionFromJson` instead
  * @see https://github.com/webgptorg/pipeline#pipeline-collection
  */
 export declare class SimplePipelineCollection implements PipelineCollection {
@@ -17,7 +17,7 @@ export declare class SimplePipelineCollection implements PipelineCollection {
      * @param pipelines Array of pipeline JSON objects to include in the collection
      *
      * Note: During the construction logic of all pipelines are validated
-     * Note: It is not recommended to use this constructor directly, use `createCollectionFromJson` *(or other variant)* instead
+     * Note: It is not recommended to use this constructor directly, use `createPipelineCollectionFromJson` *(or other variant)* instead
      */
     constructor(...pipelines: ReadonlyArray<PipelineJson>);
     /**

package/esm/typings/src/collection/{constructors/createCollectionFromDirectory.d.ts → pipeline-collection/constructors/createPipelineCollectionFromDirectory.d.ts}

@@ -1,12 +1,12 @@
-import type { ExecutionTools } from '../../execution/ExecutionTools';
-import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
-import type { string_dirname, string_pipeline_root_url } from '../../types/typeAliases';
+import type { ExecutionTools } from '../../../execution/ExecutionTools';
+import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
+import type { string_dirname, string_pipeline_root_url } from '../../../types/typeAliases';
 import type { PipelineCollection } from '../PipelineCollection';
 /**
- * Options for `createCollectionFromDirectory` function
+ * Options for `createPipelineCollectionFromDirectory` function
  *
  * Note: `rootDirname` is not needed because it is the folder in which `.book` or `.book` file is located
- *       This is not same as `path` which is the first argument of `createCollectionFromDirectory` - it can be a subfolder
+ *       This is not same as `path` which is the first argument of `createPipelineCollectionFromDirectory` - it can be a subfolder
  */
 type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & {
     /**
@@ -27,8 +27,6 @@ type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions
      * It has 2 purposes:
      * 1) Every pipeline in the collection is checked if it is a child of `rootUrl`
      * 2) If the pipeline does not have a URL, it is created from the `rootUrl` and path to the pipeline
-     *
-     * @default false
      */
     rootUrl?: string_pipeline_root_url;
     /**
@@ -46,7 +44,7 @@ type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions
     isCrashedOnError?: boolean;
 };
 /**
- * Constructs Pipeline from given directory
+ * Constructs `PipelineCollection` from given directory
  *
  * Note: Works only in Node.js environment because it reads the file system
  *
@@ -56,9 +54,9 @@ type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions
  * @returns PipelineCollection
  * @public exported from `@promptbook/node`
  */
-export declare function createCollectionFromDirectory(rootPath: string_dirname, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
+export declare function createPipelineCollectionFromDirectory(rootPath: string_dirname, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
 export {};
 /**
- * TODO: [🖇] What about symlinks? Maybe option isSymlinksFollowed
+ * TODO: [🖇] What about symlinks? Maybe option `isSymlinksFollowed`
  * TODO: Maybe move from `@promptbook/node` to `@promptbook/core` as we removes direct dependency on `fs`
  */

package/esm/typings/src/collection/pipeline-collection/constructors/createPipelineCollectionFromJson.d.ts

@@ -0,0 +1,13 @@
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
+import type { PipelineCollection } from '../PipelineCollection';
+/**
+ * Creates `PipelineCollection` from array of PipelineJson or PipelineString
+ *
+ * Note: Functions `pipelineCollectionToJson` and `createPipelineCollectionFromJson` are complementary
+ * Note: Syntax, parsing, and logic consistency checks are performed on all sources during build
+ *
+ * @param promptbookSources
+ * @returns PipelineCollection
+ * @public exported from `@promptbook/core`
+ */
+export declare function createPipelineCollectionFromJson(...promptbooks: ReadonlyArray<PipelineJson>): PipelineCollection;

package/esm/typings/src/collection/{constructors/createCollectionFromPromise.d.ts → pipeline-collection/constructors/createPipelineCollectionFromPromise.d.ts}

@@ -1,23 +1,24 @@
-import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
 import type { PipelineCollection } from '../PipelineCollection';
 /**
- * Constructs Promptbook from async sources
+ * Constructs `PipelineCollection` from async sources
+ *
  * It can be one of the following:
  * - Promise of array of PipelineJson or PipelineString
  * - Factory function that returns Promise of array of PipelineJson or PipelineString
  *
  * Note: This is useful as internal tool for other constructor functions like
- *       `createCollectionFromUrl` or `createCollectionFromDirectory`
+ *       `createPipelineCollectionFromUrl` or `createPipelineCollectionFromDirectory`
  *       Consider using those functions instead of this one
  *
  * Note: The function does NOT return promise it returns the collection directly which waits for the sources to be resolved
  *       when error occurs in given promise or factory function, it is thrown during `listPipelines` or `getPipelineByUrl` call
  *
- * Note: Consider using  `createCollectionFromDirectory` or `createCollectionFromUrl`
+ * Note: Consider using  `createPipelineCollectionFromDirectory` or `createPipelineCollectionFromUrl`
  *
  * @param promptbookSourcesPromiseOrFactory
  * @returns PipelineCollection
  * @deprecated Do not use, it will became internal tool for other constructor functions
  * @public exported from `@promptbook/core`
  */
-export declare function createCollectionFromPromise(promptbookSourcesPromiseOrFactory: Promise<ReadonlyArray<PipelineJson>> | (() => Promise<ReadonlyArray<PipelineJson>>)): PipelineCollection;
+export declare function createPipelineCollectionFromPromise(promptbookSourcesPromiseOrFactory: Promise<ReadonlyArray<PipelineJson>> | (() => Promise<ReadonlyArray<PipelineJson>>)): PipelineCollection;

package/esm/typings/src/collection/pipeline-collection/constructors/createPipelineCollectionFromPromise.test.d.ts

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

package/esm/typings/src/collection/{constructors/createCollectionFromUrl.d.ts → pipeline-collection/constructors/createPipelineCollectionFromUrl.d.ts}

@@ -1,7 +1,7 @@
-import type { string_url } from '../../types/typeAliases';
+import type { string_url } from '../../../types/typeAliases';
 import type { PipelineCollection } from '../PipelineCollection';
 /**
- * Options for `createCollectionFromDirectory` function
+ * Options for `createPipelineCollectionFromDirectory` function
  */
 type CreatePipelineCollectionFromUrlyOptions = {
     /**
@@ -22,7 +22,7 @@ type CreatePipelineCollectionFromUrlyOptions = {
  * @returns PipelineCollection
  * @public exported from `@promptbook/core`
  */
-export declare function createCollectionFromUrl(url: string_url | URL, options: CreatePipelineCollectionFromUrlyOptions): Promise<PipelineCollection>;
+export declare function createPipelineCollectionFromUrl(url: string_url | URL, options: CreatePipelineCollectionFromUrlyOptions): Promise<PipelineCollection>;
 export {};
 /**
  * TODO: [main] !!4 [🧠] Library precompilation and do not mix markdown and json promptbooks

package/esm/typings/src/collection/{constructors/createSubcollection.d.ts → pipeline-collection/constructors/createPipelineSubcollection.d.ts}

@@ -1,7 +1,7 @@
-import type { string_pipeline_url } from '../../types/typeAliases';
+import type { string_pipeline_url } from '../../../types/typeAliases';
 import type { PipelineCollection } from '../PipelineCollection';
 /**
- * Creates PipelineCollection as a subset of another PipelineCollection
+ * Creates `PipelineCollection` as a subset of another `PipelineCollection`
  *
  * Note: You can use any type of collection as a parent collection - local, remote, etc.
  * Note: This is just a thin wrapper / proxy around the parent collection
@@ -10,4 +10,4 @@ import type { PipelineCollection } from '../PipelineCollection';
  * @returns PipelineCollection
  * @public exported from `@promptbook/core`
  */
-export declare function createSubcollection(collection: PipelineCollection, predicate: (url: string_pipeline_url) => boolean): PipelineCollection;
+export declare function createPipelineSubcollection(collection: PipelineCollection, predicate: (url: string_pipeline_url) => boolean): PipelineCollection;

package/esm/typings/src/collection/pipeline-collection/pipelineCollectionToJson.d.ts

@@ -0,0 +1,13 @@
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+import type { PipelineCollection } from './PipelineCollection';
+/**
+ * Converts PipelineCollection to serialized JSON
+ *
+ * Note: Functions `pipelineCollectionToJson` and `createPipelineCollectionFromJson` are complementary
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function pipelineCollectionToJson(collection: PipelineCollection): Promise<ReadonlyArray<PipelineJson>>;
+/**
+ * TODO: [🧠] Maybe clear `sourceFile` or clear when exposing through API or remote server
+ */

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

@@ -233,6 +233,13 @@ export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_BOOKS_DIRNAME = "./books";
+/**
+ * Where to store your agents (also book files)
+ * This is kind of a "src" for your books
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_AGENTS_DIRNAME = "./agents";
 /**
  * Where to store the temporary downloads
  *
@@ -270,7 +277,7 @@ export declare const CLI_APP_ID: string_app_id;
  */
 export declare const PLAYGROUND_APP_ID: string_app_id;
 /**
- * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
+ * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createPipelineCollectionFromDirectory`
  *
  * @public exported from `@promptbook/core`
  */

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

@@ -3,7 +3,7 @@ import type fs from 'fs/promises';
 /**
  * Container for all the tools needed to manipulate with filesystem
  */
-export type FilesystemTools = Pick<typeof fs, 'access' | 'constants' | 'readFile' | 'writeFile' | 'stat' | 'readdir' | 'mkdir'>;
+export type FilesystemTools = Pick<typeof fs, 'access' | 'constants' | 'readFile' | 'writeFile' | 'stat' | 'readdir' | 'mkdir' | 'watch'>;
 /**
  * TODO: Implement destroyable pattern to free resources
  */

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

@@ -9,6 +9,12 @@ import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult }
  * On its interface it exposes common methods for prompt execution.
  * Inside (in constructor) it calls OpenAI, Azure, GPU, proxy, cache, logging,...
  *
+ * Note: [🦖] There are several different things in Promptbook:
+ * - `Agent` - which represents an AI Agent with its source, memories, actions, etc. Agent is a higher-level abstraction which is internally using:
+ * - `LlmExecutionTools` - which wraps one or more LLM models and provides an interface to execute them
+ * - `AgentLlmExecutionTools` - which is a specific implementation of `LlmExecutionTools` that wraps another LlmExecutionTools and applies agent-specific system prompts and requirements
+ * - `OpenAiAssistantExecutionTools` - which is a specific implementation of `LlmExecutionTools` for OpenAI models with assistant capabilities, recommended for usage in `Agent` or `AgentLlmExecutionTools`
+ *
  * @see https://github.com/webgptorg/promptbook#llm-execution-tools
  */
 export type LlmExecutionTools = {

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

@@ -2,8 +2,13 @@ import { BehaviorSubject } from 'rxjs';
 import { AgentBasicInformation, BookParameter, LlmExecutionTools, string_agent_name, string_book, string_url_image } from '../../_packages/types.index';
 import { AgentOptions } from './AgentOptions';
 /**
- * Note: !!!! `Agent` vs `LlmExecutionTools`
+ * Represents one AI Agent
  *
+ * Note: [🦖] There are several different things in Promptbook:
+ * - `Agent` - which represents an AI Agent with its source, memories, actions, etc. Agent is a higher-level abstraction which is internally using:
+ * - `LlmExecutionTools` - which wraps one or more LLM models and provides an interface to execute them
+ * - `AgentLlmExecutionTools` - which is a specific implementation of `LlmExecutionTools` that wraps another LlmExecutionTools and applies agent-specific system prompts and requirements
+ * - `OpenAiAssistantExecutionTools` - which is a specific implementation of `LlmExecutionTools` for OpenAI models with assistant capabilities, recommended for usage in `Agent` or `AgentLlmExecutionTools`
  *
  * @public exported from `@promptbook/core`
  */

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

@@ -1,20 +1,25 @@
 import type { Promisable } from 'type-fest';
-import type { string_book } from '../../book-2.0/agent-source/string_book';
 import type { ChatParticipant } from '../../book-components/Chat/types/ChatParticipant';
 import type { AvailableModel } from '../../execution/AvailableModel';
 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_model_name, string_title } from '../../types/typeAliases';
+import { CreateAgentLlmExecutionToolsOptions } from './CreateAgentLlmExecutionToolsOptions';
 /**
  * Execution Tools for calling LLM models with a predefined agent "soul"
  * This wraps underlying LLM execution tools and applies agent-specific system prompts and requirements
  *
+ * Note: [🦖] There are several different things in Promptbook:
+ * - `Agent` - which represents an AI Agent with its source, memories, actions, etc. Agent is a higher-level abstraction which is internally using:
+ * - `LlmExecutionTools` - which wraps one or more LLM models and provides an interface to execute them
+ * - `AgentLlmExecutionTools` - which is a specific implementation of `LlmExecutionTools` that wraps another LlmExecutionTools and applies agent-specific system prompts and requirements
+ * - `OpenAiAssistantExecutionTools` - which is a specific implementation of `LlmExecutionTools` for OpenAI models with assistant capabilities, recommended for usage in `Agent` or `AgentLlmExecutionTools`
+ *
  * @public exported from `@promptbook/core`
  */
 export declare class AgentLlmExecutionTools implements LlmExecutionTools {
-    private readonly llmTools;
-    private readonly agentSource;
+    private readonly options;
     /**
      * Cached model requirements to avoid re-parsing the agent source
      */
@@ -29,7 +34,7 @@ export declare class AgentLlmExecutionTools implements LlmExecutionTools {
      * @param llmTools The underlying LLM execution tools to wrap
      * @param agentSource The agent source string that defines the agent's behavior
      */
-    constructor(llmTools: LlmExecutionTools, agentSource: string_book);
+    constructor(options: CreateAgentLlmExecutionToolsOptions);
     /**
      * Get cached or parse agent information
      */

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

@@ -9,7 +9,3 @@ export declare const createAgentLlmExecutionTools: ((options: CreateAgentLlmExec
     packageName: string;
     className: string;
 };
-/**
- * TODO: [🧠] Consider adding validation for agent source format
- * TODO: [🧠] Consider adding options for caching behavior
- */

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

@@ -9,6 +9,12 @@ import { OpenAiExecutionTools } from './OpenAiExecutionTools';
  *
  * This is useful for calling OpenAI API with a single assistant, for more wide usage use `OpenAiExecutionTools`.
  *
+ * Note: [🦖] There are several different things in Promptbook:
+ * - `Agent` - which represents an AI Agent with its source, memories, actions, etc. Agent is a higher-level abstraction which is internally using:
+ * - `LlmExecutionTools` - which wraps one or more LLM models and provides an interface to execute them
+ * - `AgentLlmExecutionTools` - which is a specific implementation of `LlmExecutionTools` that wraps another LlmExecutionTools and applies agent-specific system prompts and requirements
+ * - `OpenAiAssistantExecutionTools` - which is a specific implementation of `LlmExecutionTools` for OpenAI models with assistant capabilities, recommended for usage in `Agent` or `AgentLlmExecutionTools`
+ *
  * @public exported from `@promptbook/openai`
  */
 export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
@@ -26,7 +32,17 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
      * Calls OpenAI API to use a chat model.
      */
     callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'format'>): Promise<ChatPromptResult>;
-    createNewAssistant(): Promise<OpenAiAssistantExecutionTools>;
+    playground(): Promise<void>;
+    createNewAssistant(options: {
+        /**
+         * Name of the new assistant
+         */
+        readonly name: string_title;
+        /**
+         * Instructions for the new assistant
+         */
+        readonly instructions: string_markdown;
+    }): Promise<OpenAiAssistantExecutionTools>;
     /**
      * Discriminant for type guards
      */

package/esm/typings/src/other/templates/getTemplatesPipelineCollection.d.ts

@@ -1,4 +1,4 @@
-import type { PipelineCollection } from '../../collection/PipelineCollection';
+import type { PipelineCollection } from '../../collection/pipeline-collection/pipeline-collection/PipelineCollection';
 /**
  * Get pipeline collection for Untitled Promptbook project
  *

package/esm/typings/src/remote-server/startRemoteServer.d.ts

@@ -18,7 +18,7 @@ export declare function startRemoteServer<TCustomOptions = undefined>(options: R
  * TODO: Split this file into multiple functions - handler for each request
  * TODO: Maybe use `$exportJson`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
- * TODO: [⚖] Expose the collection to be able to connect to same collection via createCollectionFromUrl
+ * TODO: [⚖] Expose the collection to be able to connect to same collection via createPipelineCollectionFromUrl
  * TODO: Handle progress - support streaming
  * TODO: [🗯] Do not hang up immediately but wait until client closes OR timeout
  * TODO: [🗯] Timeout on chat to free up resources