@promptbook/azure-openai 0.103.0-48 → 0.103.0-49

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/agent/Agent.d.ts

@@ -2,17 +2,18 @@ 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_hash, 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`
  */
@@ -26,6 +27,14 @@ export declare class Agent extends AgentLlmExecutionTools implements LlmExecutio
      * 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
      */
@@ -49,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,11 +10,12 @@ 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`
  */
@@ -60,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

@@ -9,11 +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:
+ * 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`
  */
@@ -32,6 +33,10 @@ export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools
      * Calls OpenAI API to use a chat model.
      */
     callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'format'>): 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>;
     /**
      * Get an existing assistant tool wrapper
      */

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/azure-openai",
-    "version": "0.103.0-48",
+    "version": "0.103.0-49",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -105,7 +105,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/azure-openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.103.0-48"
+        "@promptbook/core": "0.103.0-49"
     },
     "dependencies": {
         "@azure/openai": "1.0.0-beta.13",

package/umd/index.umd.js

@@ -24,7 +24,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-48';
+    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-49';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -360,6 +360,9 @@
             if (hex.length === 3) {
                 return Color.fromHex3(hex);
             }
+            if (hex.length === 4) {
+                return Color.fromHex4(hex);
+            }
             if (hex.length === 6) {
                 return Color.fromHex6(hex);
             }
@@ -380,6 +383,19 @@
             const b = parseInt(hex.substr(2, 1), 16) * 16;
             return take(new Color(r, g, b));
         }
+        /**
+         * 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
+         */
+        static fromHex4(hex) {
+            const r = parseInt(hex.substr(0, 1), 16) * 16;
+            const g = parseInt(hex.substr(1, 1), 16) * 16;
+            const b = parseInt(hex.substr(2, 1), 16) * 16;
+            const a = parseInt(hex.substr(3, 1), 16) * 16;
+            return take(new Color(r, g, b, a));
+        }
         /**
          * Creates a new Color instance from color in hex format with 6 color digits (without alpha channel)
          *
@@ -570,7 +586,8 @@
          * @returns true if the value is a valid hex color string (e.g., `#009edd`, `#fff`, etc.)
          */
         static isHexColorString(value) {
-            return typeof value === 'string' && /^#(?:[0-9a-fA-F]{3}){1,2}$/.test(value);
+            return (typeof value === 'string' &&
+                /^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$/.test(value));
         }
         /**
          * Creates new Color object
@@ -877,6 +894,7 @@
     ({
         TITLE: Color.fromHex('#244EA8'),
         LINE: Color.fromHex('#eeeeee'),
+        SEPARATOR: Color.fromHex('#cccccc'),
         COMMITMENT: Color.fromHex('#DA0F78'),
         PARAMETER: Color.fromHex('#8e44ad'),
     });
@@ -1816,7 +1834,7 @@
         TODO: [🧠] Is there a better implementation?
         > const propertyNames = Object.getOwnPropertyNames(objectValue);
         > for (const propertyName of propertyNames) {
-        >     const value = (objectValue as really_any)[propertyName];
+        >     const value = (objectValue as chococake)[propertyName];
         >     if (value && typeof value === 'object') {
         >         deepClone(value);
         >     }