@promptbook/markdown-utils 0.103.0-47 → 0.103.0-49

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/markdown-utils",
-    "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,

package/umd/index.umd.js

@@ -24,7 +24,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-47';
+    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
@@ -503,6 +503,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);
             }
@@ -523,6 +526,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)
          *
@@ -713,7 +729,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
@@ -1046,6 +1063,7 @@
     ({
         TITLE: Color.fromHex('#244EA8'),
         LINE: Color.fromHex('#eeeeee'),
+        SEPARATOR: Color.fromHex('#cccccc'),
         COMMITMENT: Color.fromHex('#DA0F78'),
         PARAMETER: Color.fromHex('#8e44ad'),
     });
@@ -1896,7 +1914,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);
         >     }
@@ -2743,7 +2761,7 @@
         }
     }
     /**
-     * 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
      */
 
     /**
@@ -4311,6 +4329,8 @@
     /**
      * 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'
@@ -4466,6 +4486,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'