@promptbook/types 0.103.0-47 → 0.103.0-49

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

@@ -1,6 +1,9 @@
 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
+import { computeAgentHash } from '../book-2.0/agent-source/computeAgentHash';
 import { createAgentModelRequirements } from '../book-2.0/agent-source/createAgentModelRequirements';
 import { createAgentModelRequirementsWithCommitments } from '../book-2.0/agent-source/createAgentModelRequirementsWithCommitments';
+import { createDefaultAgentName } from '../book-2.0/agent-source/createDefaultAgentName';
+import { normalizeAgentName } from '../book-2.0/agent-source/normalizeAgentName';
 import { PADDING_LINES } from '../book-2.0/agent-source/padBook';
 import { padBook } from '../book-2.0/agent-source/padBook';
 import { parseAgentSource } from '../book-2.0/agent-source/parseAgentSource';
@@ -188,8 +191,11 @@ import { aboutPromptbookInformation } from '../utils/misc/aboutPromptbookInforma
 import { $generateBookBoilerplate } from '../utils/random/$generateBookBoilerplate';
 import { REMOTE_SERVER_URLS } from '../../servers';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
+export { computeAgentHash };
 export { createAgentModelRequirements };
 export { createAgentModelRequirementsWithCommitments };
+export { createDefaultAgentName };
+export { normalizeAgentName };
 export { PADDING_LINES };
 export { padBook };
 export { parseAgentSource };

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

@@ -21,6 +21,7 @@ import type { ChatParticipant } from '../book-components/Chat/types/ChatParticip
 import type { MessageButton } from '../book-components/Chat/utils/parseMessageButtons';
 import type { QrCodeOptions } from '../book-components/Qr/useQrCode';
 import type { AgentCollection } from '../collection/agent-collection/AgentCollection';
+import type { AgentCollectionInSupabaseOptions } from '../collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabaseOptions';
 import type { Json } from '../collection/agent-collection/constructors/agent-collection-in-supabase/AgentsDatabaseSchema';
 import type { AgentsDatabaseSchema } from '../collection/agent-collection/constructors/agent-collection-in-supabase/AgentsDatabaseSchema';
 import type { Tables } from '../collection/agent-collection/constructors/agent-collection-in-supabase/AgentsDatabaseSchema';
@@ -219,6 +220,7 @@ import type { ReservedParameters } from '../types/typeAliases';
 import type { string_title } from '../types/typeAliases';
 import type { string_agent_name } from '../types/typeAliases';
 import type { string_agent_name_in_book } from '../types/typeAliases';
+import type { string_agent_hash } from '../types/typeAliases';
 import type { string_persona_description } from '../types/typeAliases';
 import type { string_model_description } from '../types/typeAliases';
 import type { string_knowledge_source_content } from '../types/typeAliases';
@@ -376,6 +378,7 @@ export type { ChatParticipant };
 export type { MessageButton };
 export type { QrCodeOptions };
 export type { AgentCollection };
+export type { AgentCollectionInSupabaseOptions };
 export type { Json };
 export type { AgentsDatabaseSchema };
 export type { Tables };
@@ -574,6 +577,7 @@ export type { ReservedParameters };
 export type { string_title };
 export type { string_agent_name };
 export type { string_agent_name_in_book };
+export type { string_agent_hash };
 export type { string_persona_description };
 export type { string_model_description };
 export type { string_knowledge_source_content };

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

@@ -27,6 +27,7 @@ import { countSentences } from '../utils/expectation-counters/countSentences';
 import { countWords } from '../utils/expectation-counters/countWords';
 import { CountUtils } from '../utils/expectation-counters/index';
 import { $getCurrentDate } from '../utils/misc/$getCurrentDate';
+import { computeHash } from '../utils/misc/computeHash';
 import { debounce } from '../utils/misc/debounce';
 import { parseNumber } from '../utils/misc/parseNumber';
 import { capitalize } from '../utils/normalization/capitalize';
@@ -113,6 +114,7 @@ export { countSentences };
 export { countWords };
 export { CountUtils };
 export { $getCurrentDate };
+export { computeHash };
 export { debounce };
 export { parseNumber };
 export { capitalize };

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

@@ -1,4 +1,4 @@
-import type { string_agent_name, string_color, string_url_image } from '../../types/typeAliases';
+import type { string_agent_hash, string_agent_name, string_agent_url, string_color, string_url_image } from '../../types/typeAliases';
 /**
  * Unified parameter representation that supports two different notations:
  * 1. @Parameter - single word parameter starting with @
@@ -28,12 +28,21 @@ export type AgentBasicInformation = {
      * Name of the agent
      * This is the first line of the agent source
      */
-    agentName: string_agent_name | null;
+    agentName: string_agent_name;
+    /**
+     * Hash of the agent source for integrity verification
+     */
+    agentHash: string_agent_hash;
     /**
      * Optional description of the agent
      * This is the line starting with "PERSONA"
      */
     personaDescription: string | null;
+    /**
+     * The initial message shown to the user when the chat starts
+     * This is the line starting with "INITIAL MESSAGE"
+     */
+    initialMessage: string | null;
     /**
      * Metadata commitments parsed from META lines
      * Each META commitment has the format "META TYPE content"
@@ -44,6 +53,11 @@ export type AgentBasicInformation = {
         color?: string_color;
         [key: string]: string | undefined;
     };
+    /**
+     * Links found in the agent source
+     * This corresponds to META LINK commitments
+     */
+    links: Array<string_agent_url>;
     /**
      * Parameters found in the agent source
      * Supports two different notations for the same syntax feature:
@@ -53,6 +67,6 @@ export type AgentBasicInformation = {
     parameters: BookParameter[];
 };
 /**
- * TODO: All readonly
+ * TODO: [🐱‍🚀] Make all properties of `AgentBasicInformation` readonly
  * TODO: [🕛] Unite `AgentBasicInformation`, `ChatParticipant`, `LlmExecutionTools` +  `LlmToolsMetadata`
  */

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

@@ -1,4 +1,5 @@
 import type { ParsedCommitment } from '../../commitments/_base/ParsedCommitment';
+import { string_agent_name } from '../../types/typeAliases';
 /**
  * Result of parsing agent source for commitments
  *
@@ -8,7 +9,7 @@ export type AgentSourceParseResult = {
     /**
      * The agent name (first line)
      */
-    agentName: string | null;
+    agentName: string_agent_name | null;
     /**
      * All parsed commitments
      */

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

@@ -0,0 +1,8 @@
+import { string_agent_hash } from '../../types/typeAliases';
+import { string_book } from './string_book';
+/**
+ * Computes SHA-256 hash of the agent source
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function computeAgentHash(agentSource: string_book): string_agent_hash;

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

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

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

@@ -0,0 +1,8 @@
+import { string_agent_name } from '../../types/typeAliases';
+import { string_book } from './string_book';
+/**
+ * Creates temporary default agent name based on agent source hash
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function createDefaultAgentName(agentSource: string_book): string_agent_name;

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

@@ -0,0 +1,9 @@
+import { string_agent_name } from '../../types/typeAliases';
+/**
+ * Normalizes agent name from arbitrary string to valid agent name
+ *
+ * Note: [🔂] This function is idempotent.
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function normalizeAgentName(rawAgentName: string): string_agent_name;

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

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

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

@@ -6,4 +6,4 @@ import type { string_book } from './string_book';
  *
  * @private internal utility of `parseAgentSource`
  */
-export declare function parseAgentSourceWithCommitments(agentSource: string_book): AgentSourceParseResult;
+export declare function parseAgentSourceWithCommitments(agentSource: string_book): Omit<AgentSourceParseResult, 'agentHash'>;

package/esm/typings/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabase.d.ts

@@ -1,9 +1,8 @@
 import type { SupabaseClient } from '@supabase/supabase-js';
 import type { AgentBasicInformation } from '../../../../book-2.0/agent-source/AgentBasicInformation';
 import type { string_book } from '../../../../book-2.0/agent-source/string_book';
-import type { CommonToolsOptions } from '../../../../execution/CommonToolsOptions';
-import type { PrepareAndScrapeOptions } from '../../../../prepare/PrepareAndScrapeOptions';
 import type { string_agent_name } from '../../../../types/typeAliases';
+import { AgentCollectionInSupabaseOptions } from './AgentCollectionInSupabaseOptions';
 import type { AgentsDatabaseSchema } from './AgentsDatabaseSchema';
 /**
  * Agent collection stored in Supabase table
@@ -11,23 +10,23 @@ import type { AgentsDatabaseSchema } from './AgentsDatabaseSchema';
  * Note: This object can work both from Node.js and browser environment depending on the Supabase client provided
  *
  * @public exported from `@promptbook/core`
- * <- TODO: !!! Move to `@promptbook/supabase` package
+ * <- TODO: [🐱‍🚀] Move to `@promptbook/supabase` package
  */
 export declare class AgentCollectionInSupabase {
     private readonly supabaseClient;
-    readonly options?: (PrepareAndScrapeOptions & CommonToolsOptions) | undefined;
+    readonly options?: AgentCollectionInSupabaseOptions | undefined;
     /**
      * @param rootPath - path to the directory with agents
-     * @param tools - Execution tools to be used in !!! `Agent` itself and listing the agents
+     * @param tools - Execution tools to be used in [🐱‍🚀] `Agent` itself and listing the agents
      * @param options - Options for the collection creation
      */
-    constructor(supabaseClient: SupabaseClient<AgentsDatabaseSchema>, options?: (PrepareAndScrapeOptions & CommonToolsOptions) | undefined);
+    constructor(supabaseClient: SupabaseClient<AgentsDatabaseSchema>, options?: AgentCollectionInSupabaseOptions | undefined);
     /**
      * Gets all agents in the collection
      */
     listAgents(): Promise<ReadonlyArray<AgentBasicInformation>>;
     /**
-     * !!!@@@
+     * [🐱‍🚀]@@@
      */
     getAgentSource(agentName: string_agent_name): Promise<string_book>;
     /**
@@ -44,9 +43,16 @@ export declare class AgentCollectionInSupabase {
      * Deletes an agent from the collection
      */
     deleteAgent(agentName: string_agent_name): Promise<void>;
+    /**
+     * Get the Supabase table name with prefix
+     *
+     * @param tableName - The original table name
+     * @returns The prefixed table name
+     */
+    private getTableName;
 }
 /**
- * TODO: !!!! Implement it here correctly and update JSDoc comments here, and on interface + other implementations
+ * TODO: [🐱‍🚀] Implement it here correctly and update JSDoc comments here, and on interface + other implementations
  * TODO: Write unit test
  * TODO: [🧠][🚙] `AgentXxx` vs `AgentsXxx` naming convention
  */

package/esm/typings/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabaseOptions.d.ts

@@ -0,0 +1,10 @@
+import type { CommonToolsOptions } from '../../../../execution/CommonToolsOptions';
+import type { PrepareAndScrapeOptions } from '../../../../prepare/PrepareAndScrapeOptions';
+export type AgentCollectionInSupabaseOptions = PrepareAndScrapeOptions & CommonToolsOptions & {
+    /**
+     * The Supabase tables prefix to use
+     *
+     * @default ''
+     */
+    tablePrefix?: string;
+};

package/esm/typings/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentsDatabaseSchema.d.ts

@@ -1,65 +1,90 @@
+/**
+ * AUTO-GENERATED SUBSET TYPES FROM `/apps/agents-server/src/database/schema.ts`
+ * Source of truth: `/apps/agents-server/src/database/schema.sql` *(do not edit table structure here manually)*
+ *
+ * [💽] Prompt:
+ * Re-generate this sub-schema
+ * Generate Supabase TypeScript schema which is a subset of `AgentsServerDatabase`
+ * containing only tables `Agent` and `AgentHistory`
+ *
+ * NOTE: This file intentionally omits all other tables (EnvironmentVariable, ChatHistory, ChatFeedback)
+ *       and any extra schemas (e.g. `graphql_public`) to remain a strict subset.
+ */
 export type Json = string | number | boolean | null | {
     [key: string]: Json | undefined;
 } | Json[];
 export type AgentsDatabaseSchema = {
-    graphql_public: {
-        Tables: {
-            [_ in never]: never;
-        };
-        Views: {
-            [_ in never]: never;
-        };
-        Functions: {
-            graphql: {
-                Args: {
-                    operationName?: string;
-                    query?: string;
-                    variables?: Json;
-                    extensions?: Json;
-                };
-                Returns: Json;
-            };
-        };
-        Enums: {
-            [_ in never]: never;
-        };
-        CompositeTypes: {
-            [_ in never]: never;
-        };
-    };
     public: {
         Tables: {
-            AgentCollection: {
+            Agent: {
                 Row: {
                     id: number;
                     agentName: string;
-                    agentProfile: Json;
                     createdAt: string;
                     updatedAt: string | null;
-                    agentVersion: number;
+                    agentHash: string;
+                    agentSource: string;
+                    agentProfile: Json;
                     promptbookEngineVersion: string;
                     usage: Json | null;
-                    agentSource: string;
+                    preparedModelRequirements: Json | null;
+                    preparedExternals: Json | null;
                 };
                 Insert: {
                     id?: number;
                     agentName: string;
                     createdAt: string;
                     updatedAt?: string | null;
-                    agentVersion: number;
+                    agentHash: string;
+                    agentSource: string;
+                    agentProfile: Json;
                     promptbookEngineVersion: string;
                     usage?: Json | null;
-                    agentSource: string;
+                    preparedModelRequirements?: Json | null;
+                    preparedExternals?: Json | null;
                 };
                 Update: {
                     id?: number;
                     agentName?: string;
                     createdAt?: string;
                     updatedAt?: string | null;
-                    agentVersion?: number;
+                    agentHash?: string;
+                    agentSource?: string;
+                    agentProfile?: Json;
                     promptbookEngineVersion?: string;
                     usage?: Json | null;
+                    preparedModelRequirements?: Json | null;
+                    preparedExternals?: Json | null;
+                };
+                Relationships: [];
+            };
+            AgentHistory: {
+                Row: {
+                    id: number;
+                    createdAt: string;
+                    agentName: string;
+                    agentHash: string;
+                    previousAgentHash: string | null;
+                    agentSource: string;
+                    promptbookEngineVersion: string;
+                };
+                Insert: {
+                    id?: number;
+                    createdAt: string;
+                    agentName: string;
+                    agentHash: string;
+                    previousAgentHash?: string | null;
+                    agentSource: string;
+                    promptbookEngineVersion: string;
+                };
+                Update: {
+                    id?: number;
+                    createdAt?: string;
+                    agentName?: string;
+                    agentHash?: string;
+                    previousAgentHash?: string | null;
                     agentSource?: string;
+                    promptbookEngineVersion?: string;
                 };
                 Relationships: [];
             };

package/esm/typings/src/commitments/MESSAGE/InitialMessageCommitmentDefinition.d.ts

@@ -0,0 +1,28 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * INITIAL MESSAGE commitment definition
+ *
+ * The INITIAL MESSAGE commitment defines the first message that the user sees when opening the chat.
+ * It is used to greet the user and set the tone of the conversation.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * INITIAL MESSAGE Hello! I am ready to help you with your tasks.
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class InitialMessageCommitmentDefinition extends BaseCommitmentDefinition<'INITIAL MESSAGE'> {
+    constructor();
+    /**
+     * Short one-line description of INITIAL MESSAGE.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for INITIAL MESSAGE commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}

package/esm/typings/src/commitments/index.d.ts

@@ -6,6 +6,7 @@ import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
 import { GoalCommitmentDefinition } from './GOAL/GOAL';
 import { KnowledgeCommitmentDefinition } from './KNOWLEDGE/KNOWLEDGE';
 import { MemoryCommitmentDefinition } from './MEMORY/MEMORY';
+import { InitialMessageCommitmentDefinition } from './MESSAGE/InitialMessageCommitmentDefinition';
 import { MessageCommitmentDefinition } from './MESSAGE/MESSAGE';
 import { MetaCommitmentDefinition } from './META/META';
 import { ModelCommitmentDefinition } from './MODEL/MODEL';
@@ -23,7 +24,7 @@ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplemented
  *
  * @private Use functions to access commitments instead of this array directly
  */
-export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
+export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
 /**
  * Gets a commitment definition by its type
  * @param type The commitment type to look up

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

@@ -54,6 +54,7 @@ export declare const PROMPTBOOK_COLOR: import("./utils/take/interfaces/ITakeChai
 export declare const PROMPTBOOK_SYNTAX_COLORS: {
     readonly TITLE: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
     readonly LINE: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
+    readonly SEPARATOR: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
     readonly COMMITMENT: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
     readonly PARAMETER: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
 };

package/esm/typings/src/errors/DatabaseError.d.ts

@@ -8,5 +8,5 @@ export declare class DatabaseError extends Error {
     constructor(message: string);
 }
 /**
- * TODO: !!!! Explain that NotFoundError (!!! and other specific errors) has priority over DatabaseError in some contexts
- */ 
+ * TODO: [🐱‍🚀] Explain that NotFoundError ([🐱‍🚀] and other specific errors) has priority over DatabaseError in some contexts
+ */

package/esm/typings/src/errors/WrappedError.d.ts

@@ -1,4 +1,4 @@
-import type { really_any } from '../utils/organization/really_any';
+import type { chococake } from '../utils/organization/really_any';
 /**
  * This error type indicates that somewhere in the code non-Error object was thrown and it was wrapped into the `WrappedError`
  *
@@ -6,5 +6,5 @@ import type { really_any } from '../utils/organization/really_any';
  */
 export declare class WrappedError extends Error {
     readonly name = "WrappedError";
-    constructor(whatWasThrown: really_any);
+    constructor(whatWasThrown: chococake);
 }

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

@@ -3,7 +3,7 @@ import { PartialDeep } from 'type-fest';
 import type { LlmCall } from '../types/LlmCall';
 import type { number_percent, task_id } from '../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
-import type { really_any } from '../utils/organization/really_any';
+import type { chococake } from '../utils/organization/really_any';
 import type { string_promptbook_version } from '../version';
 import type { AbstractTaskResult } from './AbstractTaskResult';
 import type { PipelineExecutorResult } from './PipelineExecutorResult';
@@ -144,7 +144,7 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
     /**
      * Optional nonce to correlate logs with version of the Promptbook engine
      */
-    readonly ptbkNonce?: really_any;
+    readonly ptbkNonce?: chococake;
 };
 export type Task = ExecutionTask | PreparationTask;
 export {};

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

@@ -9,11 +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:
+ * 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`
+ * - `RemoteAgent` - which is an `Agent` that connects to a Promptbook Agents Server
  *
  * @see https://github.com/webgptorg/promptbook#llm-execution-tools
  */
@@ -52,6 +53,10 @@ export type LlmExecutionTools = {
      * Calls a chat model
      */
     callChatModel?(prompt: Prompt): Promise<ChatPromptResult>;
+    /**
+     * Calls a chat model with streaming
+     */
+    callChatModelStream?(prompt: Prompt, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
     /**
      * Calls a completion model
      */

package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts

@@ -1,7 +1,7 @@
 import { Promisable } from 'type-fest';
 import type { Identification } from '../../../remote-server/socket-types/_subtypes/Identification';
 import type { string_app_id, string_url } from '../../../types/typeAliases';
-import type { really_any } from '../../../utils/organization/really_any';
+import type { chococake } from '../../../utils/organization/really_any';
 import type { CacheLlmToolsOptions } from '../utils/cache/CacheLlmToolsOptions';
 import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
 type ProvideLlmToolsForWizardOrCliOptions = {
@@ -38,7 +38,7 @@ type ProvideLlmToolsForWizardOrCliOptions = {
      *
      * Note: When login prompt fails, `process.exit(1)` is called
      */
-    loginPrompt(): Promisable<Identification<really_any>>;
+    loginPrompt(): Promisable<Identification<chococake>>;
 });
 /**
  * Returns LLM tools for CLI

package/esm/typings/src/llm-providers/_common/utils/assertUniqueModels.d.ts

@@ -0,0 +1,12 @@
+import { AvailableModel } from '../../../execution/AvailableModel';
+/**
+ * Utility to assert that all models in the provided array have unique `modelName` values.
+ *
+ * This is internal utility for unit tests to ensure no duplicate model names exist.
+ *
+ * @private internal utility of unit tests
+ */
+export declare function assertUniqueModels(models: ReadonlyArray<AvailableModel>): void;
+/**
+ * Note: [⚪] This should never be in any released package
+ */

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

@@ -2,29 +2,43 @@ import { BehaviorSubject } from 'rxjs';
 import type { AgentBasicInformation, BookParameter } from '../../book-2.0/agent-source/AgentBasicInformation';
 import type { string_book } from '../../book-2.0/agent-source/string_book';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { string_agent_name, string_url_image } from '../../types/typeAliases';
+import type { string_agent_hash, string_agent_name, string_agent_url, string_url_image } from '../../types/typeAliases';
 import { AgentLlmExecutionTools } from './AgentLlmExecutionTools';
 import type { AgentOptions } from './AgentOptions';
 /**
  * Represents one AI Agent
  *
- * !!! Note: [🦖] There are several different things in Promptbook:
+ * 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`
+ * - `RemoteAgent` - which is an `Agent` that connects to a Promptbook Agents Server
  *
  * @public exported from `@promptbook/core`
  */
 export declare class Agent extends AgentLlmExecutionTools implements LlmExecutionTools, AgentBasicInformation {
+    private _agentName;
     /**
      * Name of the agent
      */
-    agentName: string_agent_name | null;
+    get agentName(): string_agent_name;
     /**
      * Description of the agent
      */
     personaDescription: string | null;
+    /**
+     * The initial message shown to the user when the chat starts
+     */
+    initialMessage: string | null;
+    /**
+     * Links found in the agent source
+     */
+    links: Array<string_agent_url>;
+    /**
+     * Computed hash of the agent source for integrity verification
+     */
+    get agentHash(): string_agent_hash;
     /**
      * Metadata like image or color
      */
@@ -44,5 +58,4 @@ export declare class Agent extends AgentLlmExecutionTools implements LlmExecutio
 }
 /**
  * TODO: [🧠][😰]Agent is not working with the parameters, should it be?
- * TODO: !!! Agent on remote server
  */

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

@@ -10,16 +10,21 @@ import type { CreateAgentLlmExecutionToolsOptions } from './CreateAgentLlmExecut
  * 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:
+ * 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`
+ * - `RemoteAgent` - which is an `Agent` that connects to a Promptbook Agents Server
  *
  * @public exported from `@promptbook/core`
  */
 export declare class AgentLlmExecutionTools implements LlmExecutionTools {
     private readonly options;
+    /**
+     * Cache of OpenAI assistants to avoid creating duplicates
+     */
+    private static assistantCache;
     /**
      * Cached model requirements to avoid re-parsing the agent source
      */
@@ -56,6 +61,10 @@ export declare class AgentLlmExecutionTools implements LlmExecutionTools {
      * Calls the chat model with agent-specific system prompt and requirements
      */
     callChatModel(prompt: Prompt): Promise<ChatPromptResult>;
+    /**
+     * Calls the chat model with agent-specific system prompt and requirements with streaming
+     */
+    callChatModelStream(prompt: Prompt, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
 }
 /**
  * TODO: [🍚] Implement Destroyable pattern to free resources

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

@@ -5,12 +5,12 @@ import type { RemoteAgentOptions } from './RemoteAgentOptions';
 /**
  * Represents one AI Agent
  *
- * !!! Note: [🦖] There are several different things in Promptbook:
+ * 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:
- * !!!! `RemoteAgent`
  * - `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`
+ * - `RemoteAgent` - which is an `Agent` that connects to a Promptbook Agents Server
  *
  * @public exported from `@promptbook/core`
  */
@@ -25,6 +25,10 @@ export declare class RemoteAgent extends Agent {
      * Calls the agent on agents remote server
      */
     callChatModel(prompt: Prompt): Promise<ChatPromptResult>;
+    /**
+     * Calls the agent on agents remote server with streaming
+     */
+    callChatModelStream(prompt: Prompt, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
 }
 /**
  * TODO: [🧠][😰]Agent is not working with the parameters, should it be?

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

@@ -1,7 +1,7 @@
 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 { string_markdown, string_markdown_text, string_title, string_token } from '../../types/typeAliases';
 import type { OpenAiAssistantExecutionToolsOptions } from './OpenAiAssistantExecutionToolsOptions';
 import { OpenAiExecutionTools } from './OpenAiExecutionTools';
 /**
@@ -9,16 +9,17 @@ 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:
+ * 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`
+ * - `RemoteAgent` - which is an `Agent` that connects to a Promptbook Agents Server
  *
  * @public exported from `@promptbook/openai`
  */
 export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
-    private readonly assistantId;
+    readonly assistantId: string_token;
     private readonly isCreatingNewAssistantsAllowed;
     /**
      * Creates OpenAI Execution Tools.
@@ -32,7 +33,14 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
      * Calls OpenAI API to use a chat model.
      */
     callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'format'>): Promise<ChatPromptResult>;
-    playground(): Promise<void>;
+    /**
+     * Calls OpenAI API to use a chat model with streaming.
+     */
+    callChatModelStream(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'format'>, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
+    /**
+     * Get an existing assistant tool wrapper
+     */
+    getAssistant(assistantId: string_token): OpenAiAssistantExecutionTools;
     createNewAssistant(options: {
         /**
          * Name of the new assistant
@@ -47,6 +55,24 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
          */
         readonly knowledgeSources?: ReadonlyArray<string>;
     }): Promise<OpenAiAssistantExecutionTools>;
+    updateAssistant(options: {
+        /**
+         * ID of the assistant to update
+         */
+        readonly assistantId: string_token;
+        /**
+         * Name of the assistant
+         */
+        readonly name?: string_title;
+        /**
+         * Instructions for the assistant
+         */
+        readonly instructions?: string_markdown;
+        /**
+         * Optional list of knowledge source links (URLs or file paths) to attach to the assistant via vector store
+         */
+        readonly knowledgeSources?: ReadonlyArray<string>;
+    }): Promise<OpenAiAssistantExecutionTools>;
     /**
      * Discriminant for type guards
      */

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

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠] Maybe do this test for all model providers + boilerplate
+ */

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

@@ -9,7 +9,7 @@ type AgentsServerOptions = {
     port: number_port;
 };
 /**
- * !!!!!
+ * [🐱‍🚀]
  * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
  *
  * You can simply use `RemoteExecutionTools` on client-side javascript and connect to your remote server.
@@ -17,7 +17,7 @@ type AgentsServerOptions = {
  *
  * @see https://github.com/webgptorg/promptbook#remote-server
  * @public exported from `@promptbook/remote-server`
- * <- TODO: !!!! Maybe change to `@promptbook/agent-server`
+ * <- TODO: [🐱‍🚀] Change to `@promptbook/agent-server`
  */
 export declare function startAgentServer(options: AgentsServerOptions): Promise<TODO_any>;
 export {};

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

@@ -11,8 +11,7 @@ import type { RemoteServerOptions } from './types/RemoteServerOptions';
  */
 export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): RemoteServer;
 /**
- * TODO !!!! Add agent
- * TODO: !!!! Allow to chat with agents directly via remote server
+
  * TODO: [🕋] Use here `aboutPromptbookInformation`
  * TODO: [🌡] Add CORS and security - probably via `helmet`
  * TODO: Split this file into multiple functions - handler for each request

package/esm/typings/src/transpilers/openai-sdk/register.d.ts

@@ -7,7 +7,7 @@ import type { Registration } from '../../utils/misc/$Register';
  * @public exported from `@promptbook/wizard`
  * @public exported from `@promptbook/cli`
  *
- * TODO: !!!! Which package should export this?
+ * TODO: [🧠] Which package should export this?
  */
 export declare const _OpenAiSdkTranspilerRegistration: Registration;
 /**

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

@@ -148,6 +148,12 @@ export type string_agent_name = string;
  * For example `"My AI Assistant"`
  */
 export type string_agent_name_in_book = string;
+/**
+ * Semantic helper
+ *
+ * For example `"b126926439c5fcb83609888a11283723c1ef137c0ad599a77a1be81812bd221d"`
+ */
+export type string_agent_hash = string_sha256;
 /**
  * Unstructured description of the persona
  *

package/esm/typings/src/utils/color/Color.d.ts

@@ -59,6 +59,13 @@ export declare class Color {
      * @returns Color object
      */
     private static fromHex3;
+    /**
+     * Creates a new Color instance from color in hex format with 4 digits (with alpha channel)
+     *
+     * @param color in hex for example `09df`
+     * @returns Color object
+     */
+    private static fromHex4;
     /**
      * Creates a new Color instance from color in hex format with 6 color digits (without alpha channel)
      *

package/esm/typings/src/utils/color/Color.test.d.ts

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

package/esm/typings/src/utils/environment/$getGlobalScope.d.ts

@@ -1,4 +1,4 @@
-import type { really_any } from '../organization/really_any';
+import type { chococake } from '../organization/really_any';
 /**
  * Safely retrieves the global scope object (window in browser, global in Node.js)
  * regardless of the JavaScript environment in which the code is running
@@ -7,4 +7,4 @@ import type { really_any } from '../organization/really_any';
  *
  *  @private internal function of `$Register`
  */
-export declare function $getGlobalScope(): really_any;
+export declare function $getGlobalScope(): chococake;

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

@@ -0,0 +1,11 @@
+import { string_sha256 } from '../../types/typeAliases';
+import { really_unknown } from '../organization/really_unknown';
+/**
+ * Computes SHA-256 hash of the given object
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function computeHash(value: really_unknown): string_sha256;
+/**
+ * TODO: [🥬][🥬] Use this ACRY
+ */

package/esm/typings/src/utils/misc/computeHash.test.d.ts

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

package/esm/typings/src/utils/normalization/normalize-to-kebab-case.d.ts

@@ -9,6 +9,8 @@ export type string_kebab_case = string;
 /**
  * Converts a given text to kebab-case format.
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param text The text to be converted.
  * @returns The kebab-case formatted string.
  * @example 'hello-world'

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

@@ -7,6 +7,9 @@
  */
 export type string_PascalCase = string;
 /**
+ * Normalizes a given text to PascalCase format.
+ *
+ * Note: [🔂] This function is idempotent.
  *
  * @param text @public exported from `@promptbook/utils`
  * @returns

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

@@ -9,6 +9,8 @@ export type string_camelCase = string;
 /**
  * Normalizes a given text to camelCase format.
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param text The text to be normalized.
  * @param _isFirstLetterCapital Whether the first letter should be capitalized.
  * @returns The camelCase formatted string.

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

@@ -1,6 +1,8 @@
 /**
  * Converts a title string into a normalized name.
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param value The title string to be converted to a name.
  * @returns A normalized name derived from the input title.
  * @example 'Hello World!' -> 'hello-world'

package/esm/typings/src/utils/organization/$sideEffect.d.ts

@@ -1,4 +1,4 @@
-import type { really_any } from './really_any';
+import type { chococake } from './really_any';
 /**
  * Just says that the variable is not used directlys but should be kept because the existence of the variable is important
  *
@@ -6,4 +6,4 @@ import type { really_any } from './really_any';
  * @returns void
  * @private within the repository
  */
-export declare function $sideEffect(...sideEffectSubjects: ReadonlyArray<really_any>): void;
+export declare function $sideEffect(...sideEffectSubjects: ReadonlyArray<chococake>): void;

package/esm/typings/src/utils/organization/$side_effect.d.ts

@@ -1,7 +1,7 @@
-import type { really_any } from './really_any';
+import type { chococake } from './really_any';
 /**
  * Organizational helper to mark a function that produces side effects
  *
  * @private within the repository
  */
-export type $side_effect = void | really_any;
+export type $side_effect = void | chococake;

package/esm/typings/src/utils/organization/TODO_USE.d.ts

@@ -1,4 +1,4 @@
-import type { really_any } from './really_any';
+import type { chococake } from './really_any';
 /**
  * Just marks a place of place where should be something implemented
  * No side effects.
@@ -9,4 +9,4 @@ import type { really_any } from './really_any';
  * @returns void
  * @private within the repository
  */
-export declare function TODO_USE(...value: ReadonlyArray<really_any>): void;
+export declare function TODO_USE(...value: ReadonlyArray<chococake>): void;

package/esm/typings/src/utils/organization/keepUnused.d.ts

@@ -1,4 +1,4 @@
-import type { really_any } from './really_any';
+import type { chococake } from './really_any';
 /**
  * Just says that the variable is not used but should be kept
  * No side effects.
@@ -13,4 +13,4 @@ import type { really_any } from './really_any';
  * @returns void
  * @private within the repository
  */
-export declare function keepUnused<TTypeToKeep1 = really_any, TTypeToKeep2 = really_any, TTypeToKeep3 = really_any>(...valuesToKeep: ReadonlyArray<really_any>): void;
+export declare function keepUnused<TTypeToKeep1 = chococake, TTypeToKeep2 = chococake, TTypeToKeep3 = chococake>(...valuesToKeep: ReadonlyArray<chococake>): void;

package/esm/typings/src/utils/organization/preserve.d.ts

@@ -1,4 +1,4 @@
-import type { really_any } from './really_any';
+import type { chococake } from './really_any';
 /**
  * Does nothing, but preserves the function in the bundle
  * Compiler is tricked into thinking the function is used
@@ -7,7 +7,7 @@ import type { really_any } from './really_any';
  * @returns nothing
  * @private within the repository
  */
-export declare function $preserve(...value: Array<really_any>): void;
+export declare function $preserve(...value: Array<chococake>): void;
 /**
  * DO NOT USE THIS FUNCTION
  * Only purpose of this function is to trick the compiler and javascript engine
@@ -15,7 +15,7 @@ export declare function $preserve(...value: Array<really_any>): void;
  *
  * @private internal for `preserve`
  */
-export declare function __DO_NOT_USE_getPreserved(): Array<really_any>;
+export declare function __DO_NOT_USE_getPreserved(): Array<chococake>;
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */

package/esm/typings/src/utils/organization/really_any.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Organizational helper to tell to use intentionally `any`
+ *
+ * @alias really_any
+ * @private within the repository
+ */
+export type chococake = really_any;
 /**
  * Organizational helper to mark a place where to really use `any`
  *

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

@@ -1,4 +1,4 @@
-import type { really_any } from '../organization/really_any';
+import type { chococake } from '../organization/really_any';
 /**
  * Function `asSerializable` will convert values which are not serializable to serializable values
  * It walks deeply through the object and converts all values
@@ -12,4 +12,4 @@ import type { really_any } from '../organization/really_any';
  *
  * @private Internal helper function
  */
-export declare function asSerializable(value: really_any): really_any;
+export declare function asSerializable(value: chococake): chococake;

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.103.0-46`).
+ * It follows semantic versioning (e.g., `0.103.0-48`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.103.0-47",
+    "version": "0.103.0-49",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -92,6 +92,6 @@
     },
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.103.0-47"
+        "@promptbook/core": "0.103.0-49"
     }
 }