@promptbook/core 0.104.0-10 → 0.104.0-11

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

@@ -1,4 +1,5 @@
 import type { BookParameter } from '../book-2.0/agent-source/AgentBasicInformation';
+import type { AgentCapability } from '../book-2.0/agent-source/AgentBasicInformation';
 import type { AgentBasicInformation } from '../book-2.0/agent-source/AgentBasicInformation';
 import type { AgentModelRequirements } from '../book-2.0/agent-source/AgentModelRequirements';
 import type { string_book } from '../book-2.0/agent-source/string_book';
@@ -178,6 +179,8 @@ import type { ScraperSourceHandler } from '../scrapers/_common/Scraper';
 import type { ScraperIntermediateSource } from '../scrapers/_common/ScraperIntermediateSource';
 import type { JavascriptExecutionToolsOptions } from '../scripting/javascript/JavascriptExecutionToolsOptions';
 import type { PostprocessingFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
+import type { SearchEngine } from '../search-engines/SearchEngine';
+import type { SearchResult } from '../search-engines/SearchResult';
 import type { PromptbookStorage } from '../storage/_common/PromptbookStorage';
 import type { FileCacheStorageOptions } from '../storage/file-cache-storage/FileCacheStorageOptions';
 import type { IndexedDbStorageOptions } from '../storage/local-storage/utils/IndexedDbStorageOptions';
@@ -367,6 +370,7 @@ import type { ExportJsonOptions } from '../utils/serialization/exportJson';
 import type { ITakeChain } from '../utils/take/interfaces/ITakeChain';
 import type { string_promptbook_version } from '../version';
 export type { BookParameter };
+export type { AgentCapability };
 export type { AgentBasicInformation };
 export type { AgentModelRequirements };
 export type { string_book };
@@ -546,6 +550,8 @@ export type { ScraperSourceHandler };
 export type { ScraperIntermediateSource };
 export type { JavascriptExecutionToolsOptions };
 export type { PostprocessingFunction };
+export type { SearchEngine };
+export type { SearchResult };
 export type { PromptbookStorage };
 export type { FileCacheStorageOptions };
 export type { IndexedDbStorageOptions };

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

@@ -23,6 +23,24 @@ export type BookParameter = {
      */
     description?: string;
 };
+/**
+ * Capability of the agent
+ * This is parsed from commitments like USE BROWSER, USE SEARCH ENGINE, KNOWLEDGE, etc.
+ */
+export type AgentCapability = {
+    /**
+     * The type of the capability
+     */
+    type: 'browser' | 'search-engine' | 'knowledge';
+    /**
+     * The label to display for this capability
+     */
+    label: string;
+    /**
+     * The name of the icon to display for this capability
+     */
+    iconName: string;
+};
 export type AgentBasicInformation = {
     /**
      * Name of the agent
@@ -72,6 +90,11 @@ export type AgentBasicInformation = {
      * - {parameterName} or {parameter with multiple words} or {parameterName: description text}
      */
     parameters: BookParameter[];
+    /**
+     * Capabilities of the agent
+     * This is parsed from commitments like USE BROWSER, USE SEARCH ENGINE, KNOWLEDGE, etc.
+     */
+    capabilities: AgentCapability[];
 };
 /**
  * TODO: [🐱‍🚀] Make all properties of `AgentBasicInformation` readonly

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

@@ -23,11 +23,11 @@ export type ChatMessage = Omit<Message<id>, 'direction' | 'recipients' | 'thread
      */
     isComplete?: boolean;
     /**
-     * @@@
+     * The expected answer for the message (used for testing or validation)
      */
     expectedAnswer?: string;
     /**
-     * @@@
+     * Indicates if the message was sent via a voice call
      */
     isVoiceCall?: boolean;
 };

package/esm/typings/src/book-components/_common/Dropdown/Dropdown.d.ts

@@ -7,7 +7,7 @@ type DropdownProps = {
     }>;
 };
 /**
- * @@@
+ * A dropdown menu component that displays a list of actions triggered by a hamburger menu button.
  *
  * @private internal subcomponent used by various components
  */

package/esm/typings/src/book-components/_common/HamburgerMenu/HamburgerMenu.d.ts

@@ -4,7 +4,7 @@ type HamburgerMenuProps = {
     className?: string;
 };
 /**
- * @@@
+ * An animated hamburger menu button component.
  *
  * @private Internal component
  */

package/esm/typings/src/book-components/icons/AboutIcon.d.ts

@@ -1,6 +1,6 @@
 import { SVGProps } from 'react';
 /**
- * @@@
+ * Renders an about icon
  *
  * @private internal subcomponent used by various components
  */

package/esm/typings/src/book-components/icons/AttachmentIcon.d.ts

@@ -3,7 +3,7 @@ type AttachmentIconProps = {
     color?: string;
 };
 /**
- * @@@
+ * Renders an attachment icon
  *
  * @public exported from `@promptbook/components`
  */

package/esm/typings/src/book-components/icons/CameraIcon.d.ts

@@ -3,7 +3,7 @@ type CameraIconProps = {
     color?: string;
 };
 /**
- * @@@
+ * Renders a camera icon
  *
  * @public exported from `@promptbook/components`
  */

package/esm/typings/src/book-components/icons/DownloadIcon.d.ts

@@ -1,6 +1,6 @@
 import { SVGProps } from 'react';
 /**
- * @@@
+ * Renders a download icon
  *
  * @private internal subcomponent used by various components
  */

package/esm/typings/src/book-components/icons/MenuIcon.d.ts

@@ -1,6 +1,6 @@
 import { SVGProps } from 'react';
 /**
- * @@@
+ * Renders a menu icon
  *
  * @private internal subcomponent used by various components
  */

package/esm/typings/src/book-components/icons/SaveIcon.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 /**
- * @@@
+ * Renders a save icon
  *
  * @public exported from `@promptbook/components`
  */

package/esm/typings/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabase.d.ts

@@ -26,11 +26,11 @@ export declare class AgentCollectionInSupabase {
      */
     listAgents(): Promise<ReadonlyArray<AgentBasicInformation>>;
     /**
-     * [🐱‍🚀]@@@
+     * Retrieves the permanent ID of an agent by its name or permanent ID.
      */
     getAgentPermanentId(agentNameOrPermanentId: string_agent_name | string_agent_permanent_id): Promise<string_agent_permanent_id>;
     /**
-     * [🐱‍🚀]@@@
+     * Retrieves the source code of an agent by its name or permanent ID.
      */
     getAgentSource(agentNameOrPermanentId: string_agent_name | string_agent_permanent_id): Promise<string_book>;
     /**

package/esm/typings/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentsDatabaseSchema.d.ts

@@ -108,60 +108,6 @@ export type AgentsDatabaseSchema = {
                     }
                 ];
             };
-            GenerationLock: {
-                Row: {
-                    id: number;
-                    createdAt: string;
-                    updatedAt: string;
-                    lockKey: string;
-                    expiresAt: string;
-                };
-                Insert: {
-                    id?: number;
-                    createdAt?: string;
-                    updatedAt?: string;
-                    lockKey: string;
-                    expiresAt: string;
-                };
-                Update: {
-                    id?: number;
-                    createdAt?: string;
-                    updatedAt?: string;
-                    lockKey?: string;
-                    expiresAt?: string;
-                };
-                Relationships: [];
-            };
-            Image: {
-                Row: {
-                    id: number;
-                    createdAt: string;
-                    updatedAt: string;
-                    filename: string;
-                    prompt: string;
-                    cdnUrl: string;
-                    cdnKey: string;
-                };
-                Insert: {
-                    id?: number;
-                    createdAt?: string;
-                    updatedAt?: string;
-                    filename: string;
-                    prompt: string;
-                    cdnUrl: string;
-                    cdnKey: string;
-                };
-                Update: {
-                    id?: number;
-                    createdAt?: string;
-                    updatedAt?: string;
-                    filename?: string;
-                    prompt?: string;
-                    cdnUrl?: string;
-                    cdnKey?: string;
-                };
-                Relationships: [];
-            };
         };
         Views: Record<string, never>;
         Functions: Record<string, never>;

package/esm/typings/src/llm-providers/_common/utils/count-total-usage/countUsage.d.ts

@@ -13,5 +13,5 @@ export declare function countUsage(llmTools: LlmExecutionTools): LlmExecutionToo
  * TODO: [🧠] Is there some meaningfull way how to test this util
  * TODO: [🧠][🌯] Maybe a way how to hide ability to `get totalUsage`
  *     > const [llmToolsWithUsage,getUsage] = countTotalUsage(llmTools);
- * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ * TODO: [👷‍♂️] Write a comprehensive manual explaining the construction and usage of LLM tools in the Promptbook ecosystem
  */

package/esm/typings/src/llm-providers/agent/Agent.d.ts

@@ -1,5 +1,5 @@
 import { BehaviorSubject } from 'rxjs';
-import type { AgentBasicInformation, BookParameter } from '../../book-2.0/agent-source/AgentBasicInformation';
+import type { AgentBasicInformation, AgentCapability, 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 { ChatPromptResult } from '../../execution/PromptResult';
@@ -37,6 +37,11 @@ export declare class Agent extends AgentLlmExecutionTools implements LlmExecutio
      * Links found in the agent source
      */
     links: Array<string_agent_url>;
+    /**
+     * Capabilities of the agent
+     * This is parsed from commitments like USE BROWSER, USE SEARCH ENGINE, KNOWLEDGE, etc.
+     */
+    capabilities: AgentCapability[];
     /**
      * Computed hash of the agent source for integrity verification
      */

package/esm/typings/src/remote-server/ui/ServerApp.d.ts

@@ -1,6 +1,6 @@
 import type { ServerInfo } from './types';
 /**
- * @@@
+ * Renders the HTML document for the Promptbook Server UI.
  *
  * @private internal utility of Remote Server
  */

package/esm/typings/src/search-engines/SearchEngine.d.ts

@@ -0,0 +1,9 @@
+import type { Promisable } from 'type-fest';
+import type { string_markdown, string_markdown_text, string_title } from '../types/typeAliases';
+import type { SearchResult } from './SearchResult';
+export type SearchEngine = {
+    readonly title: string_title & string_markdown_text;
+    readonly description?: string_markdown;
+    checkConfiguration(): Promisable<void>;
+    search(query: string): Promise<SearchResult[]>;
+};

package/esm/typings/src/search-engines/SearchResult.d.ts

@@ -0,0 +1,18 @@
+import type { string_url } from '../types/typeAliases';
+/**
+ * @@@
+ */
+export type SearchResult = {
+    /**
+     * @@@
+     */
+    title: string;
+    /**
+     * @@@
+     */
+    url: string_url;
+    /**
+     * @@@
+     */
+    snippet: string;
+};

package/esm/typings/src/search-engines/bing/BingSearchEngine.d.ts

@@ -0,0 +1,15 @@
+import type { Promisable } from 'type-fest';
+import type { string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
+import type { SearchEngine } from '../SearchEngine';
+import type { SearchResult } from '../SearchResult';
+/**
+ * @@@
+ *
+ * @private <- TODO: !!!! Export via some package
+ */
+export declare class BingSearchEngine implements SearchEngine {
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    checkConfiguration(): Promisable<void>;
+    search(query: string): Promise<SearchResult[]>;
+}

package/esm/typings/src/search-engines/dummy/DummySearchEngine.d.ts

@@ -0,0 +1,15 @@
+import type { Promisable } from 'type-fest';
+import type { string_markdown, string_markdown_text, string_title } from '../../types/typeAliases';
+import type { SearchEngine } from '../SearchEngine';
+import type { SearchResult } from '../SearchResult';
+/**
+ * @@@
+ *
+ * @private <- TODO: !!!! Export via some package, maybe `@promptbook/search-engines` or `@promptbook/fake-llm`
+ */
+export declare class DummySearchEngine implements SearchEngine {
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    checkConfiguration(): Promisable<void>;
+    search(query: string): Promise<SearchResult[]>;
+}

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

@@ -1,9 +1,10 @@
+import type { string_persona_description } from '../../types/typeAliases';
 /**
- * @@@@
+ * Generates a random agent persona description.
  *
  * @private internal helper function
  */
-export declare function $randomAgentPersona(): string;
+export declare function $randomAgentPersona(): string_persona_description;
 /**
  * TODO: [🤶] Maybe export through `@promptbook/utils` or `@promptbook/random` package
  */

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/core",
-    "version": "0.104.0-10",
+    "version": "0.104.0-11",
     "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-10';
+    const PROMPTBOOK_ENGINE_VERSION = '0.104.0-11';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -3764,7 +3764,7 @@
      * TODO: [🧠] Is there some meaningfull way how to test this util
      * TODO: [🧠][🌯] Maybe a way how to hide ability to `get totalUsage`
      *     > const [llmToolsWithUsage,getUsage] = countTotalUsage(llmTools);
-     * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+     * TODO: [👷‍♂️] Write a comprehensive manual explaining the construction and usage of LLM tools in the Promptbook ecosystem
      */
 
     /**
@@ -11896,7 +11896,57 @@
         }
         const meta = {};
         const links = [];
+        const capabilities = [];
         for (const commitment of parseResult.commitments) {
+            if (commitment.type === 'USE BROWSER') {
+                capabilities.push({
+                    type: 'browser',
+                    label: 'Browser',
+                    iconName: 'Globe',
+                });
+                continue;
+            }
+            if (commitment.type === 'USE SEARCH ENGINE') {
+                capabilities.push({
+                    type: 'search-engine',
+                    label: 'Search Internet',
+                    iconName: 'Search',
+                });
+                continue;
+            }
+            if (commitment.type === 'KNOWLEDGE') {
+                const content = spaceTrim__default["default"](commitment.content).split('\n')[0] || '';
+                let label = content;
+                let iconName = 'Book';
+                if (content.startsWith('http://') || content.startsWith('https://')) {
+                    try {
+                        const url = new URL(content);
+                        if (url.pathname.endsWith('.pdf')) {
+                            label = url.pathname.split('/').pop() || 'Document.pdf';
+                            iconName = 'FileText';
+                        }
+                        else {
+                            label = url.hostname.replace(/^www\./, '');
+                        }
+                    }
+                    catch (e) {
+                        // Invalid URL, treat as text
+                    }
+                }
+                else {
+                    // Text content - take first few words
+                    const words = content.split(/\s+/);
+                    if (words.length > 4) {
+                        label = words.slice(0, 4).join(' ') + '...';
+                    }
+                }
+                capabilities.push({
+                    type: 'knowledge',
+                    label,
+                    iconName,
+                });
+                continue;
+            }
             if (commitment.type === 'META LINK') {
                 const linkValue = spaceTrim__default["default"](commitment.content);
                 links.push(linkValue);
@@ -11943,6 +11993,7 @@
             meta,
             links,
             parameters,
+            capabilities,
         };
     }
     /**
@@ -12245,7 +12296,7 @@
             });
         }
         /**
-         * [🐱‍🚀]@@@
+         * Retrieves the permanent ID of an agent by its name or permanent ID.
          */
         async getAgentPermanentId(agentNameOrPermanentId) {
             const selectResult = await this.supabaseClient
@@ -12259,7 +12310,7 @@
             return selectResult.data.permanentId;
         }
         /**
-         * [🐱‍🚀]@@@
+         * Retrieves the source code of an agent by its name or permanent ID.
          */
         async getAgentSource(agentNameOrPermanentId) {
             const selectResult = await this.supabaseClient
@@ -12536,6 +12587,7 @@
         getTableName(tableName) {
             const { tablePrefix = '' } = this.options || {};
             return `${tablePrefix}${tableName}`;
+            // <- TODO: [🏧] DRY
         }
     }
     /**
@@ -19592,6 +19644,11 @@
              * Links found in the agent source
              */
             this.links = [];
+            /**
+             * Capabilities of the agent
+             * This is parsed from commitments like USE BROWSER, USE SEARCH ENGINE, KNOWLEDGE, etc.
+             */
+            this.capabilities = [];
             /**
              * Metadata like image or color
              */
@@ -19601,11 +19658,12 @@
             this.agentSource = agentSource;
             this.agentSource.subscribe((source) => {
                 this.updateAgentSource(source);
-                const { agentName, personaDescription, initialMessage, links, meta } = parseAgentSource(source);
+                const { agentName, personaDescription, initialMessage, links, meta, capabilities } = parseAgentSource(source);
                 this._agentName = agentName;
                 this.personaDescription = personaDescription;
                 this.initialMessage = initialMessage;
                 this.links = links;
+                this.capabilities = capabilities;
                 this.meta = { ...this.meta, ...meta };
             });
         }
@@ -21176,7 +21234,7 @@
         'Serious and focused AI consultant.',
     ];
     /**
-     * @@@@
+     * Generates a random agent persona description.
      *
      * @private internal helper function
      */