@promptbook/core 0.104.0-5 → 0.104.0-7

package/esm/typings/servers.d.ts

@@ -22,6 +22,14 @@ type ServerConfiguration = {
      */
     urls: Array<string_promptbook_server_url>;
 };
+/**
+ * Core Promptbook server configuration.
+ *
+ * This server is also used for auto-federation in the Agents Server.
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const CORE_SERVER: ServerConfiguration;
 /**
  * Available remote servers for the Promptbook
  *

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

@@ -191,6 +191,7 @@ import { SectionTypes } from '../types/SectionType';
 import { TaskTypes } from '../types/TaskType';
 import { aboutPromptbookInformation } from '../utils/misc/aboutPromptbookInformation';
 import { $generateBookBoilerplate } from '../utils/random/$generateBookBoilerplate';
+import { CORE_SERVER } from '../../servers';
 import { REMOTE_SERVER_URLS } from '../../servers';
 import { AUTO_FEDERATED_AGENT_SERVER_URLS } from '../../servers';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
@@ -386,5 +387,6 @@ export { SectionTypes };
 export { TaskTypes };
 export { aboutPromptbookInformation };
 export { $generateBookBoilerplate };
+export { CORE_SERVER };
 export { REMOTE_SERVER_URLS };
 export { AUTO_FEDERATED_AGENT_SERVER_URLS };

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

@@ -206,6 +206,7 @@ import type { string_char_emoji } from '../types/typeAliasEmoji';
 import type { string_business_category_name } from '../types/typeAliases';
 import type { string_model_name } from '../types/typeAliases';
 import type { string_prompt } from '../types/typeAliases';
+import type { string_prompt_image } from '../types/typeAliases';
 import type { string_template } from '../types/typeAliases';
 import type { string_text_prompt } from '../types/typeAliases';
 import type { string_chat_prompt } from '../types/typeAliases';
@@ -573,6 +574,7 @@ export type { string_char_emoji };
 export type { string_business_category_name };
 export type { string_model_name };
 export type { string_prompt };
+export type { string_prompt_image };
 export type { string_template };
 export type { string_text_prompt };
 export type { string_chat_prompt };

package/esm/typings/src/book-2.0/agent-source/createAgentModelRequirements.d.ts

@@ -1,6 +1,6 @@
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-import type { string_model_name } from '../../types/typeAliases';
+import type { string_agent_name, string_model_name, string_system_message, string_url_image } from '../../types/typeAliases';
 import type { AgentModelRequirements } from './AgentModelRequirements';
 import type { string_book } from './string_book';
 /**
@@ -27,18 +27,18 @@ export declare function extractMcpServers(agentSource: string_book): string[];
  * @deprecated Use createAgentModelRequirements instead
  * @private
  */
-export declare function createAgentSystemMessage(agentSource: string_book): Promise<string>;
+export declare function createAgentSystemMessage(agentSource: string_book): Promise<string_system_message>;
 /**
  * Extracts the agent name from the first line of the agent source
  * @deprecated Use parseAgentSource instead
  * @private
  */
-export declare function extractAgentName(agentSource: string_book): string;
+export declare function extractAgentName(agentSource: string_book): string_agent_name;
 /**
- * Extracts the profile image URL from agent source or returns gravatar fallback
+ * Extracts the profile image URL from agent source or returns default avatar fallback
  * @param agentSource The agent source string that may contain META IMAGE line
- * @returns Profile image URL (from source or gravatar fallback)
+ * @returns Profile image URL (from source or default avatar fallback)
  * @deprecated Use parseAgentSource instead
  * @private
  */
-export declare function extractAgentProfileImage(agentSource: string_book): string;
+export declare function extractAgentProfileImage(agentSource: string_book): string_url_image | null;

package/esm/typings/src/book-2.0/utils/generatePlaceholderAgentProfileImageUrl.d.ts

@@ -1,13 +1,13 @@
-import type { string_agent_name, string_url_image } from '../../types/typeAliases';
+import type { string_agent_name, string_agent_permanent_id, string_url_image } from '../../types/typeAliases';
 /**
  * Generates an image for the agent to use as profile image
  *
- * @param agentName The agent name to generate avatar for
+ * @param agentId - The permanent ID of the agent
  * @returns The placeholder profile image URL for the agent
  *
  * @public exported from `@promptbook/core`
  */
-export declare function generatePlaceholderAgentProfileImageUrl(agentName?: string_agent_name): string_url_image;
+export declare function generatePlaceholderAgentProfileImageUrl(agentIdOrName: string_agent_permanent_id | string_agent_name, agentsServerUrl?: URL): string_url_image;
 /**
  * TODO: [🤹] Figure out best placeholder image generator https://i.pravatar.cc/1000?u=568
  */

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;
 /**
@@ -158,6 +166,8 @@ 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;
 /**

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

package/package.json

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

package/umd/index.umd.js

@@ -28,7 +28,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.104.0-5';
+    const PROMPTBOOK_ENGINE_VERSION = '0.104.0-7';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -38,6 +38,8 @@
      * Core Promptbook server configuration.
      *
      * This server is also used for auto-federation in the Agents Server.
+     *
+     * @public exported from `@promptbook/core`
      */
     const CORE_SERVER = {
         title: 'Promptbook Core',
@@ -11438,44 +11440,6 @@
      * TODO: [🌺] Use some intermediate util splitWords
      */
 
-    /**
-     * Generates a gravatar URL based on agent name for fallback avatar
-     *
-     * @param agentName The agent name to generate avatar for
-     * @returns Gravatar URL
-     *
-     * @private - [🤹] The fact that profile image is Gravatar is just implementation detail which should be hidden for consumer
-     */
-    function generateGravatarUrl(agentName) {
-        // Use a default name if none provided
-        const safeName = agentName || 'Anonymous Agent';
-        // Create a simple hash from the name for consistent avatar
-        let hash = 0;
-        for (let i = 0; i < safeName.length; i++) {
-            const char = safeName.charCodeAt(i);
-            hash = (hash << 5) - hash + char;
-            hash = hash & hash; // Convert to 32bit integer
-        }
-        const avatarId = Math.abs(hash).toString();
-        return `https://www.gravatar.com/avatar/${avatarId}?default=robohash&size=200&rating=x`;
-    }
-
-    /**
-     * Generates an image for the agent to use as profile image
-     *
-     * @param agentName The agent name to generate avatar for
-     * @returns The placeholder profile image URL for the agent
-     *
-     * @public exported from `@promptbook/core`
-     */
-    function generatePlaceholderAgentProfileImageUrl(agentName) {
-        // Note: [🤹] The fact that profile image is Gravatar is just implementation detail which should be hidden for consumer
-        return generateGravatarUrl(agentName);
-    }
-    /**
-     * TODO: [🤹] Figure out best placeholder image generator https://i.pravatar.cc/1000?u=568
-     */
-
     /**
      * Creates a Mermaid graph based on the promptbook
      *
@@ -11957,10 +11921,6 @@
             const metaType = normalizeTo_camelCase(metaTypeRaw);
             meta[metaType] = spaceTrim__default["default"](commitment.content.substring(metaTypeRaw.length));
         }
-        // Generate gravatar fallback if no meta image specified
-        if (!meta.image) {
-            meta.image = generatePlaceholderAgentProfileImageUrl(parseResult.agentName || '!!');
-        }
         // Generate fullname fallback if no meta fullname specified
         if (!meta.fullname) {
             meta.fullname = parseResult.agentName || createDefaultAgentName(agentSource);
@@ -12164,6 +12124,21 @@
     //                  <- [🐱‍🚀] Buttons into genesis book
     // <- TODO: [🐱‍🚀] generateBookBoilerplate and deprecate `DEFAULT_BOOK`
 
+    /**
+     * Generates an image for the agent to use as profile image
+     *
+     * @param agentId - The permanent ID of the agent
+     * @returns The placeholder profile image URL for the agent
+     *
+     * @public exported from `@promptbook/core`
+     */
+    function generatePlaceholderAgentProfileImageUrl(agentIdOrName, agentsServerUrl = new URL(CORE_SERVER.urls[0])) {
+        return `${agentsServerUrl}agents/${agentIdOrName}/images/default-avatar.png`;
+    }
+    /**
+     * TODO: [🤹] Figure out best placeholder image generator https://i.pravatar.cc/1000?u=568
+     */
+
     /**
      * Base58 characters
      */
@@ -14207,11 +14182,7 @@
             // TODO: [🚜] DRY
             if ($taskJson.modelRequirements[command.key] !== undefined) {
                 if ($taskJson.modelRequirements[command.key] === command.value) {
-                    console.warn(`Multiple commands \`MODEL ${{
-                    modelName: 'NAME',
-                    modelVariant: 'VARIANT',
-                    maxTokens: '???',
-                }[command.key]} ${command.value}\` in the task "${$taskJson.title || $taskJson.name}"`);
+                    console.warn(`Multiple commands \`MODEL ${command.key} ${command.value}\` in the task "${$taskJson.title || $taskJson.name}"`);
                     // <- TODO: [🏮] Some standard way how to transform errors into warnings and how to handle non-critical fails during the tasks
                 }
                 else {
@@ -18563,13 +18534,14 @@
             const modelName = currentModelRequirements.modelName || this.getDefaultImageGenerationModel().modelName;
             const modelSettings = {
                 model: modelName,
-                // size: currentModelRequirements.size,
-                // quality: currentModelRequirements.quality,
-                // style: currentModelRequirements.style,
+                size: currentModelRequirements.size,
+                quality: currentModelRequirements.quality,
+                style: currentModelRequirements.style,
             };
             const rawPromptContent = templateParameters(content, { ...parameters, modelName });
             const rawRequest = {
                 ...modelSettings,
+                size: modelSettings.size || '1024x1024',
                 prompt: rawPromptContent,
                 user: (_a = this.options.userId) === null || _a === void 0 ? void 0 : _a.toString(),
                 response_format: 'url', // TODO: [🧠] Maybe allow b64_json
@@ -21468,6 +21440,7 @@
     exports.BoilerplateFormfactorDefinition = BoilerplateFormfactorDefinition;
     exports.CLAIM = CLAIM;
     exports.CLI_APP_ID = CLI_APP_ID;
+    exports.CORE_SERVER = CORE_SERVER;
     exports.CallbackInterfaceTools = CallbackInterfaceTools;
     exports.ChatbotFormfactorDefinition = ChatbotFormfactorDefinition;
     exports.CollectionError = CollectionError;