@promptbook/node 0.104.0-2 → 0.104.0-4

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

@@ -185,6 +185,7 @@ import type { BookTranspiler } from '../transpilers/_common/BookTranspiler';
 import type { BookTranspilerOptions } from '../transpilers/_common/BookTranspilerOptions';
 import type { IntermediateFilesStrategy } from '../types/IntermediateFilesStrategy';
 import type { LlmCall } from '../types/LlmCall';
+import type { Message } from '../types/Message';
 import type { ModelRequirements } from '../types/ModelRequirements';
 import type { CompletionModelRequirements } from '../types/ModelRequirements';
 import type { ChatModelRequirements } from '../types/ModelRequirements';
@@ -551,6 +552,7 @@ export type { BookTranspiler };
 export type { BookTranspilerOptions };
 export type { IntermediateFilesStrategy };
 export type { LlmCall };
+export type { Message };
 export type { ModelRequirements };
 export type { CompletionModelRequirements };
 export type { ChatModelRequirements };

package/esm/typings/src/book-components/Chat/types/ChatMessage.d.ts

@@ -1,22 +1,17 @@
+import { Message } from '../../../types/Message';
 import type { id, string_markdown } from '../../../types/typeAliases';
 /**
  * A message in the chat
  *
  * @public exported from `@promptbook/components`
  */
-export type ChatMessage = {
+export type ChatMessage = Omit<Message<id>, 'direction' | 'recipients' | 'threadId' | 'metadata'> & {
     /**
-     * Unique identifier of the message
-     */
-    id?: id;
-    /**
-     * Date when the message was created
-     */
-    date?: Date;
-    /**
-     * The name of the participant who sent the message
+     * Force the channel to be 'PROMPTBOOK_CHAT'
+     *
+     * @default 'PROMPTBOOK_CHAT'
      */
-    from: id;
+    channel?: 'PROMPTBOOK_CHAT';
     /**
      * The content of the message with optional markdown formatting
      */
@@ -37,6 +32,7 @@ export type ChatMessage = {
     isVoiceCall?: boolean;
 };
 /**
+ * TODO: Make all fields readonly
  * TODO: Delete `expectedAnswer` from ChatMessage
  * TODO: Rename `date` into `created`+`modified`
  */

package/esm/typings/src/llm-providers/_multiple/MultipleLlmExecutionTools.d.ts

@@ -1,8 +1,8 @@
 import type { ChatParticipant } from '../../book-components/Chat/types/ChatParticipant';
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult, PromptResult } from '../../execution/PromptResult';
-import type { ChatPrompt, CompletionPrompt, EmbeddingPrompt, Prompt } from '../../types/Prompt';
+import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult, ImagePromptResult, PromptResult } from '../../execution/PromptResult';
+import type { ChatPrompt, CompletionPrompt, EmbeddingPrompt, ImagePrompt, Prompt } from '../../types/Prompt';
 import type { string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
 /**
  * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
@@ -43,6 +43,10 @@ export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
      * Calls the best available embedding model
      */
     callEmbeddingModel(prompt: EmbeddingPrompt): Promise<EmbeddingPromptResult>;
+    /**
+     * Calls the best available embedding model
+     */
+    callImageGenerationModel(prompt: ImagePrompt): Promise<ImagePromptResult>;
     /**
      * Calls the best available model
      *

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/node",
-    "version": "0.104.0-2",
+    "version": "0.104.0-4",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -93,7 +93,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/node.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.104.0-2"
+        "@promptbook/core": "0.104.0-4"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -45,7 +45,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.104.0-2';
+    const PROMPTBOOK_ENGINE_VERSION = '0.104.0-4';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -4056,6 +4056,12 @@
         callEmbeddingModel(prompt) {
             return this.callCommonModel(prompt);
         }
+        /**
+         * Calls the best available embedding model
+         */
+        callImageGenerationModel(prompt) {
+            return this.callCommonModel(prompt);
+        }
         // <- Note: [🤖]
         /**
          * Calls the best available model
@@ -4082,6 +4088,11 @@
                                 continue llm;
                             }
                             return await llmExecutionTools.callEmbeddingModel(prompt);
+                        case 'IMAGE_GENERATION':
+                            if (llmExecutionTools.callImageGenerationModel === undefined) {
+                                continue llm;
+                            }
+                            return await llmExecutionTools.callImageGenerationModel(prompt);
                         // <- case [🤖]:
                         default:
                             throw new UnexpectedError(`Unknown model variant "${prompt.modelRequirements.modelVariant}" in ${llmExecutionTools.title}`);
@@ -4985,8 +4996,9 @@
                                         $ongoingTaskResult.$resultString = $ongoingTaskResult.$completionResult.content;
                                         break variant;
                                     case 'EMBEDDING':
+                                    case 'IMAGE_GENERATION':
                                         throw new PipelineExecutionError(spaceTrim$1.spaceTrim((block) => `
-                                                Embedding model can not be used in pipeline
+                                                ${modelRequirements.modelVariant} model can not be used in pipeline
 
                                                 This should be catched during parsing
 
@@ -6211,6 +6223,15 @@
                 return promptResult;
             };
         }
+        if (llmTools.callImageGenerationModel !== undefined) {
+            proxyTools.callImageGenerationModel = async (prompt) => {
+                // console.info('[🚕] callImageGenerationModel through countTotalUsage');
+                const promptResult = await llmTools.callImageGenerationModel(prompt);
+                totalUsage = addUsage(totalUsage, promptResult.usage);
+                spending.next(promptResult.usage);
+                return promptResult;
+            };
+        }
         // <- Note: [🤖]
         return proxyTools;
     }