@promptbook/utils 0.103.0-36 → 0.103.0-37

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

@@ -56,7 +56,7 @@ export type LlmExecutionTools = {
     callEmbeddingModel?(prompt: Prompt): Promise<EmbeddingPromptResult>;
 };
 /**
- * TODO: [🕛] Extend this from sth class
+ * TODO: [🕛] Extend this from sth class -  like `AgentBasicInformation` / `ModelBasicInformation``
  * TODO: [🍚] Implement destroyable pattern to free resources
  * TODO: [🏳] Add `callTranslationModel`
  * TODO: [🧠] Emulation of one type of model with another one - emuate chat with completion; emulate translation with chat

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

@@ -0,0 +1,44 @@
+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`
+ *
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class Agent implements AgentBasicInformation {
+    private readonly options;
+    /**
+     * Name of the agent
+     */
+    agentName: string_agent_name | null;
+    /**
+     * Description of the agent
+     */
+    personaDescription: string | null;
+    /**
+     * Metadata like image or color
+     */
+    meta: {
+        image?: string_url_image;
+        link?: string;
+        title?: string;
+        description?: string;
+        [key: string]: string | undefined;
+    };
+    /**
+     * Not used in Agent, always returns empty array
+     */
+    get parameters(): BookParameter[];
+    readonly agentSource: BehaviorSubject<string_book>;
+    constructor(options: AgentOptions);
+    /**
+     * Creates LlmExecutionTools which exposes the agent as a model
+     */
+    getLlmExecutionTools(): LlmExecutionTools;
+}
+/**
+ * TODO: [🧠][😰]Agent is not working with the parameters, should it be?
+ * TODO: !!! Agent on remote server
+ */

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

@@ -0,0 +1,17 @@
+import { CommonToolsOptions, ExecutionTools, string_book } from '../../_packages/types.index';
+import { Updatable } from '../../types/Updatable';
+/**
+ * Options for creating an Agent
+ */
+export type AgentOptions = CommonToolsOptions & {
+    /**
+     * The execution tools available to the agent
+     *
+     * Here the agent has access to various LLM models, browser, scrapers, LibreOffice, tools, etc.
+     */
+    executionTools: ExecutionTools;
+    /**
+     * The source of the agent
+     */
+    agentSource: Updatable<string_book>;
+};

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

@@ -0,0 +1,16 @@
+import type { string_book } from '../../_packages/types.index';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { OpenAiAssistantExecutionTools } from '../openai/OpenAiAssistantExecutionTools';
+/**
+ * Options for creating AgentLlmExecutionTools
+ */
+export type CreateAgentLlmExecutionToolsOptions = {
+    /**
+     * The underlying LLM execution tools to wrap
+     */
+    llmTools: LlmExecutionTools | OpenAiAssistantExecutionTools;
+    /**
+     * The agent source string that defines the agent's behavior
+     */
+    agentSource: string_book;
+};

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

@@ -1,19 +1,5 @@
-import type { string_book } from '../../book-2.0/agent-source/string_book';
-import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import { AgentLlmExecutionTools } from './AgentLlmExecutionTools';
-/**
- * Options for creating AgentLlmExecutionTools
- */
-export type CreateAgentLlmExecutionToolsOptions = {
-    /**
-     * The underlying LLM execution tools to wrap
-     */
-    llmTools: LlmExecutionTools;
-    /**
-     * The agent source string that defines the agent's behavior
-     */
-    agentSource: string_book;
-};
+import { CreateAgentLlmExecutionToolsOptions } from './CreateAgentLlmExecutionToolsOptions';
 /**
  * Creates new AgentLlmExecutionTools that wrap underlying LLM tools with agent-specific behavior
  *

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

@@ -13,6 +13,7 @@ import { OpenAiExecutionTools } from './OpenAiExecutionTools';
  */
 export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
     private readonly assistantId;
+    private readonly isCreatingNewAssistantsAllowed;
     /**
      * Creates OpenAI Execution Tools.
      *
@@ -25,6 +26,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>;
+    /**
+     * Discriminant for type guards
+     */
+    protected get discriminant(): string;
+    /**
+     * Type guard to check if given `LlmExecutionTools` are instanceof `OpenAiAssistantExecutionTools`
+     *
+     * Note: This is useful when you can possibly have multiple versions of `@promptbook/openai` installed
+     */
+    static isOpenAiAssistantExecutionTools(llmExecutionTools: LlmExecutionTools): llmExecutionTools is OpenAiAssistantExecutionTools;
 }
 /**
  * TODO: [🧠][🧙‍♂️] Maybe there can be some wizard for those who want to use just OpenAI

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

@@ -7,8 +7,14 @@ import type { OpenAiCompatibleExecutionToolsOptions } from './OpenAiCompatibleEx
  * @public exported from `@promptbook/openai`
  */
 export type OpenAiAssistantExecutionToolsOptions = OpenAiCompatibleExecutionToolsOptions & ClientOptions & {
+    /**
+     * Whether creating new assistants is allowed
+     *
+     * @default false
+     */
+    readonly isCreatingNewAssistantsAllowed?: boolean;
     /**
      * Which assistant to use
      */
-    assistantId: string_token;
+    readonly assistantId: string_token;
 };

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

@@ -11,6 +11,8 @@ 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/types/Updatable.d.ts

@@ -0,0 +1,19 @@
+import { BehaviorSubject } from 'rxjs';
+/**
+ * A type that represents a value that can be updated over time:
+ *
+ * 1) It can be a static value of type `TValue`
+ * 2) Or a `BehaviorSubject` that emits values of type `TValue`
+ * 3) Or pair of `[getValue, setValue]` functions for getting and setting the value
+ */
+export type Updatable<TValue> = TValue | BehaviorSubject<TValue> | [TValue, (value: TValue) => void];
+/**
+ * Restricts an Updatable to a (2) BehaviorSubject variant
+ *
+ * @see Updatable
+ * @private internal utility <- TODO: [🧠] Maybe export from `@promptbook/types`
+ */
+export declare function asUpdatableSubject<TValue>(value: Updatable<TValue>): BehaviorSubject<TValue>;
+/**
+ * TODO: [🧠] Maybe `BehaviorSubject` is too heavy for this use case, maybe just tuple `[value,setValue]` is enough
+ */

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/utils",
-    "version": "0.103.0-36",
+    "version": "0.103.0-37",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -22,7 +22,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-36';
+    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-37';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -2161,6 +2161,19 @@
         }
     }
 
+    /**
+     * This error indicates that promptbook operation is not allowed
+     *
+     * @public exported from `@promptbook/core`
+     */
+    class NotAllowed extends Error {
+        constructor(message) {
+            super(message);
+            this.name = 'NotAllowed';
+            Object.setPrototypeOf(this, NotAllowed.prototype);
+        }
+    }
+
     /**
      * This error indicates that promptbook not found in the collection
      *
@@ -2310,6 +2323,7 @@
         PromptbookFetchError,
         UnexpectedError,
         WrappedError,
+        NotAllowed,
         // TODO: [🪑]> VersionMismatchError,
     };
     /**