@promptbook/utils 0.104.0-0 → 0.104.0-10

package/esm/typings/src/llm-providers/ollama/OllamaExecutionTools.d.ts

@@ -39,7 +39,7 @@ export declare class OllamaExecutionTools extends OpenAiCompatibleExecutionTools
      */
     protected getDefaultEmbeddingModel(): AvailableModel;
     /**
-     * Default model for image generation variant.
+     * Default model for completion variant.
      */
     protected getDefaultImageGenerationModel(): AvailableModel;
 }

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

@@ -64,7 +64,7 @@ export declare class HardcodedOpenAiCompatibleExecutionTools extends OpenAiCompa
      */
     protected getDefaultEmbeddingModel(): AvailableModel;
     /**
-     * Default model for image generation variant.
+     * Default model for completion variant.
      */
     protected getDefaultImageGenerationModel(): AvailableModel;
 }

package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts

@@ -46,6 +46,7 @@ export declare class RemoteLlmExecutionTools<TCustomOptions = undefined> impleme
     private callCommonModel;
 }
 /**
+ * TODO: !!!! Deprecate pipeline server and all of its components
  * TODO: Maybe use `$exportJson`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
  * TODO: [🍓] Allow to list compatible models with each variant

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

@@ -0,0 +1,49 @@
+import { Arrayable } from 'type-fest';
+import { really_any } from '../_packages/types.index';
+import { id, string_date_iso8601, string_markdown } from './typeAliases';
+/**
+ * A generic message structure for various communication channels
+ */
+export type Message<TParticipant> = {
+    /**
+     * Unique identifier of the message
+     */
+    readonly id?: id;
+    /**
+     * Date when the message was created
+     */
+    readonly createdAt?: Date | string_date_iso8601;
+    /**
+     * The communication channel of the message
+     */
+    readonly channel?: 'PROMPTBOOK_CHAT' | 'EMAIL' | 'SMS' | 'WHATSAPP' | 'TELEGRAM' | 'SIGNAL' | string | 'UNKNOWN';
+    /**
+     * Is the message send from the Promptbook or to the Promptbook
+     */
+    readonly direction?: 'INBOUND' | 'OUTBOUND' | 'INTERNAL' | 'INITIAL';
+    /**
+     * Who sent the message
+     */
+    readonly sender: TParticipant;
+    /**
+     * Who are the recipients of the message
+     */
+    readonly recipients?: Readonly<Arrayable<TParticipant>>;
+    /**
+     * The content of the message as markdown
+     *
+     * Note: We are converting all message content to markdown for consistency
+     */
+    readonly content: string_markdown;
+    /**
+     * The thread identifier the message belongs to
+     *
+     * - `null` means the message is not part of any thread
+     * - `undefined` means that we don't know if the message is part of a thread or not
+     */
+    readonly threadId?: id | null;
+    /**
+     * Arbitrary metadata associated with the message
+     */
+    readonly metadata?: Readonly<Record<string, really_any>>;
+};

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

@@ -17,7 +17,17 @@ export type CompletionModelRequirements = CommonModelRequirements & {
     /**
      * Completion model variant
      */
-    modelVariant: 'COMPLETION';
+    readonly modelVariant: 'COMPLETION';
+    /**
+     * The temperature of the model
+     *
+     * Note: [💱] Promptbook is using just `temperature` (not `top_k` and `top_p`)
+     */
+    readonly temperature?: number_model_temperature;
+    /**
+     * Maximum number of tokens that can be generated by the model
+     */
+    readonly maxTokens?: number;
 };
 /**
  * Model requirements for the chat variant
@@ -28,11 +38,21 @@ export type ChatModelRequirements = CommonModelRequirements & {
     /**
      * Chat model variant
      */
-    modelVariant: 'CHAT';
+    readonly modelVariant: 'CHAT';
     /**
      * System message to be used in the model
      */
     readonly systemMessage?: string_system_message;
+    /**
+     * The temperature of the model
+     *
+     * Note: [💱] Promptbook is using just `temperature` (not `top_k` and `top_p`)
+     */
+    readonly temperature?: number_model_temperature;
+    /**
+     * Maximum number of tokens that can be generated by the model
+     */
+    readonly maxTokens?: number;
 };
 /**
  * Model requirements for the image generation variant
@@ -43,7 +63,21 @@ export type ImageGenerationModelRequirements = CommonModelRequirements & {
     /**
      * Image generation model variant
      */
-    modelVariant: 'IMAGE_GENERATION';
+    readonly modelVariant: 'IMAGE_GENERATION';
+    /**
+     * Size of the generated image
+     *
+     * e.g. '1536x1536'
+     */
+    readonly size?: '1024x1024' | '1792x1024' | '1024x1792' | `${number}x${number}`;
+    /**
+     * Quality of the generated image
+     */
+    readonly quality?: 'standard' | 'hd';
+    /**
+     * Style of the generated image
+     */
+    readonly style?: 'vivid' | 'natural';
 };
 /**
  * Model requirements for the embedding variant
@@ -54,7 +88,7 @@ export type EmbeddingModelRequirements = CommonModelRequirements & {
     /**
      * Embedding model variant
      */
-    modelVariant: 'EMBEDDING';
+    readonly modelVariant: 'EMBEDDING';
 };
 /**
  * Common properties for all model requirements variants
@@ -84,20 +118,10 @@ export type CommonModelRequirements = {
      * @example 'gpt-4', 'gpt-4-32k-0314', 'gpt-3.5-turbo-instruct',...
      */
     readonly modelName?: string_model_name;
-    /**
-     * The temperature of the model
-     *
-     * Note: [💱] Promptbook is using just `temperature` (not `top_k` and `top_p`)
-     */
-    readonly temperature?: number_model_temperature;
     /**
      * Seed for the model
      */
     readonly seed?: number_seed;
-    /**
-     * Maximum number of tokens that can be generated by the model
-     */
-    readonly maxTokens?: number;
 };
 /**
  * TODO: [🧠][🈁] `seed` should maybe be somewhere else (not in `ModelRequirements`) (similar that `user` identification is not here)

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

@@ -14,9 +14,15 @@ export type string_model_name = 'gpt-4' | 'gpt-4-0314' | 'gpt-4-0613' | 'gpt-4-3
 /**
  * Semantic helper
  *
- * For example `"A cat wearing a hat"`
+ * For example `"How many eyes does a cat have?"`
  */
 export type string_prompt = string;
+/**
+ * Semantic helper
+ *
+ * For example `"A cat wearing a hat"`
+ */
+export type string_prompt_image = string;
 /**
  * Semantic helper
  *
@@ -140,6 +146,8 @@ export type string_title = string;
  * Semantic helper
  *
  * For example `"My AI Assistant"`
+ *
+ * TODO: !!!! Brand the type
  */
 export type string_agent_name = string;
 /**
@@ -154,6 +162,14 @@ export type string_agent_name_in_book = string;
  * For example `"b126926439c5fcb83609888a11283723c1ef137c0ad599a77a1be81812bd221d"`
  */
 export type string_agent_hash = string_sha256;
+/**
+ * Semantic helper
+ *
+ * For example `"3mJr7AoUXx2Wqd"`
+ *
+ * TODO: !!!! Brand the type
+ */
+export type string_agent_permanent_id = string_base_58;
 /**
  * Unstructured description of the persona
  *
@@ -499,6 +515,12 @@ export type string_user_id = id | string_email;
  * For example `"b126926439c5fcb83609888a11283723c1ef137c0ad599a77a1be81812bd221d"`
  */
 export type string_sha256 = string;
+/**
+ * Semantic helper
+ *
+ * For example `"4JmF3b2J5dGVz"`
+ */
+export type string_base_58 = string;
 /**
  * Semantic helper
  *

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

@@ -1,10 +1,11 @@
+import { string_color, string_data_url, string_url_image } from '../../../types/typeAliases';
 import { Color } from '../Color';
 /**
  * Makes data url from color
  *
  * @public exported from `@promptbook/color`
  */
-export declare function colorToDataUrl(color: Color): string;
+export declare function colorToDataUrl(color: Color | string_color): string_data_url & string_url_image;
 /**
  * TODO: Make as functions NOT const
  */

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

@@ -6,10 +6,10 @@
  * @public exported from `@promptbook/utils`
  */
 export declare function $detectRuntimeEnvironment(): {
-    isRunningInBrowser: any;
-    isRunningInJest: any;
-    isRunningInNode: any;
-    isRunningInWebWorker: any;
+    isRunningInBrowser: boolean;
+    isRunningInJest: boolean;
+    isRunningInNode: boolean;
+    isRunningInWebWorker: boolean;
 };
 /**
  * TODO: [🎺] Also detect and report node version here

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

@@ -5,7 +5,7 @@
  *
  * @public exported from `@promptbook/utils`
  */
-export declare const $isRunningInBrowser: Function;
+export declare function $isRunningInBrowser(): boolean;
 /**
  * TODO: [🎺]
  */

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

@@ -5,7 +5,7 @@
  *
  * @public exported from `@promptbook/utils`
  */
-export declare const $isRunningInJest: Function;
+export declare function $isRunningInJest(): boolean;
 /**
  * TODO: [🎺]
  */

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

@@ -5,7 +5,7 @@
  *
  * @public exported from `@promptbook/utils`
  */
-export declare const $isRunningInNode: Function;
+export declare function $isRunningInNode(): boolean;
 /**
  * TODO: [🎺]
  */

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

@@ -5,7 +5,7 @@
  *
  * @public exported from `@promptbook/utils`
  */
-export declare const $isRunningInWebWorker: Function;
+export declare function $isRunningInWebWorker(): boolean;
 /**
  * TODO: [🎺]
  */

package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts

@@ -2,7 +2,7 @@ import type { string_markdown } from '../../types/typeAliases';
 /**
  * Single code block inside markdown.
  */
-export type CodeBlock = {
+export type MarkdownCodeBlock = {
     /**
      * Which notation was used to open the code block
      */
@@ -30,7 +30,7 @@ export type CodeBlock = {
  * @throws {ParseError} if block is not closed properly
  * @public exported from `@promptbook/markdown-utils`
  */
-export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): ReadonlyArray<CodeBlock>;
+export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): ReadonlyArray<MarkdownCodeBlock>;
 /**
  * TODO: Maybe name for `blockNotation` instead of  '```' and '>'
  */

package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts

@@ -1,5 +1,5 @@
 import type { string_markdown } from '../../types/typeAliases';
-import type { CodeBlock } from './extractAllBlocksFromMarkdown';
+import type { MarkdownCodeBlock } from './extractAllBlocksFromMarkdown';
 /**
  * Extracts exactly ONE code block from markdown.
  *
@@ -16,7 +16,7 @@ import type { CodeBlock } from './extractAllBlocksFromMarkdown';
  * @public exported from `@promptbook/markdown-utils`
  * @throws {ParseError} if there is not exactly one code block in the markdown
  */
-export declare function extractOneBlockFromMarkdown(markdown: string_markdown): CodeBlock;
+export declare function extractOneBlockFromMarkdown(markdown: string_markdown): MarkdownCodeBlock;
 /***
  * TODO: [🍓][🌻] Decide of this is internal utility, external util OR validator/postprocessor
  */

package/esm/typings/src/utils/random/$randomBase58.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Generates random base58 string
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
+ * Note: This function is cryptographically secure (it uses crypto.randomBytes internally)
+ *
+ * @param length - length of the string
+ * @returns secure random base58 string
+ *
+ * @private internal helper function
+ */
+export declare function $randomBase58(length: number): string;

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

package/package.json

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

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.104.0-0';
+    const PROMPTBOOK_ENGINE_VERSION = '0.104.0-10';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -2790,13 +2790,14 @@
      *
      * @public exported from `@promptbook/utils`
      */
-    const $isRunningInBrowser = new Function(`
-    try {
-        return this === window;
-    } catch (e) {
-        return false;
+    function $isRunningInBrowser() {
+        try {
+            return typeof window !== 'undefined' && typeof window.document !== 'undefined';
+        }
+        catch (e) {
+            return false;
+        }
     }
-`);
     /**
      * TODO: [🎺]
      */
@@ -2808,13 +2809,15 @@
      *
      * @public exported from `@promptbook/utils`
      */
-    const $isRunningInJest = new Function(`
-    try {
-        return process.env.JEST_WORKER_ID !== undefined;
-    } catch (e) {
-        return false;
+    function $isRunningInJest() {
+        var _a;
+        try {
+            return typeof process !== 'undefined' && ((_a = process.env) === null || _a === void 0 ? void 0 : _a.JEST_WORKER_ID) !== undefined;
+        }
+        catch (e) {
+            return false;
+        }
     }
-`);
     /**
      * TODO: [🎺]
      */
@@ -2826,13 +2829,14 @@
      *
      * @public exported from `@promptbook/utils`
      */
-    const $isRunningInNode = new Function(`
-    try {
-        return this === global;
-    } catch (e) {
-        return false;
+    function $isRunningInNode() {
+        try {
+            return typeof process !== 'undefined' && process.versions != null && process.versions.node != null;
+        }
+        catch (e) {
+            return false;
+        }
     }
-`);
     /**
      * TODO: [🎺]
      */
@@ -2844,17 +2848,17 @@
      *
      * @public exported from `@promptbook/utils`
      */
-    const $isRunningInWebWorker = new Function(`
-    try {
-        if (typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope) {
-            return true;
-        } else {
+    function $isRunningInWebWorker() {
+        try {
+            // Note: Check for importScripts which is specific to workers
+            //       and not available in the main browser thread
+            return (typeof self !== 'undefined' &&
+                typeof self.importScripts === 'function');
+        }
+        catch (e) {
             return false;
         }
-    } catch (e) {
-        return false;
     }
-`);
     /**
      * TODO: [🎺]
      */