@promptbook/utils 0.104.0-0 → 0.104.0-2

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

@@ -0,0 +1,13 @@
+type CodeBlockProps = {
+    code: string;
+    language?: string;
+    className?: string;
+    onCreateAgent?: (bookContent: string) => void;
+};
+/**
+ * Component to render a code block with syntax highlighting, copy, download, and create agent options.
+ *
+ * @private Internal utility of `<ChatMessage />` component
+ */
+export declare function CodeBlock({ code, language, className, onCreateAgent }: CodeBlockProps): import("react/jsx-runtime").JSX.Element;
+export {};

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

@@ -2,6 +2,7 @@ import type { string_markdown } from '../../../types/typeAliases';
 type MarkdownContentProps = {
     content: string_markdown;
     className?: string;
+    onCreateAgent?: (bookContent: string) => void;
 };
 /**
  * Renders markdown content with support for code highlighting, math, and tables.

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

@@ -1,7 +1,7 @@
-import { JSX } from 'react';
+import { ReactNode } from 'react';
 type DropdownProps = {
     actions: Array<{
-        icon: JSX.Element;
+        icon: ReactNode;
         name: string;
         onClick: () => void;
     }>;

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

@@ -0,0 +1,56 @@
+import { ReactNode } from 'react';
+/**
+ * Item that can be hoisted to the top menu
+ *
+ * @private mechanism inside Promptbook
+ */
+export type HoistedMenuItem = {
+    /**
+     * Unique key for the menu item
+     */
+    key?: string;
+    /**
+     * Icon to display
+     */
+    icon: ReactNode;
+    /**
+     * Name/Tooltip of the item
+     */
+    name: string;
+    /**
+     * Action to perform when clicked
+     */
+    onClick: () => void;
+    /**
+     * If true, the item is active/toggled
+     */
+    isActive?: boolean;
+};
+type MenuHoistingContextType = {
+    /**
+     * The currently hoisted menu items
+     */
+    menu: HoistedMenuItem[];
+    /**
+     * Set the hoisted menu items
+     */
+    setMenu: (items: HoistedMenuItem[]) => void;
+};
+/**
+ * Provider for menu hoisting
+ *
+ * @private mechanism inside Promptbook
+ */
+export declare function MenuHoistingProvider({ children }: {
+    children: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
+/**
+ * Hook to use the menu hoisting system
+ *
+ * @private mechanism inside Promptbook
+ */
+export declare function useMenuHoisting(): MenuHoistingContextType | null;
+export {};
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -34,15 +34,15 @@ export declare class AgentCollectionInSupabase {
      *
      * Note: You can set 'PARENT' in the agent source to inherit from another agent in the collection.
      */
-    createAgent(agentSource: string_book): Promise<AgentBasicInformation>;
+    createAgent(agentSource: string_book): Promise<AgentBasicInformation & Required<Pick<AgentBasicInformation, 'permanentId'>>>;
     /**
      * Updates an existing agent in the collection
      */
     updateAgentSource(agentName: string_agent_name, agentSource: string_book): Promise<void>;
     /**
-     * Deletes an agent from the collection
+     * List agents that are soft deleted (deletedAt IS NOT NULL)
      */
-    deleteAgent(agentName: string_agent_name): Promise<void>;
+    listDeletedAgents(): Promise<ReadonlyArray<AgentBasicInformation>>;
     /**
      * List history of an agent
      */
@@ -53,13 +53,19 @@ export declare class AgentCollectionInSupabase {
         promptbookEngineVersion: string;
     }>>;
     /**
-     * List agents that are in history but not in the active agents list
+     * Restore a soft-deleted agent by setting deletedAt to NULL
      */
-    listDeletedAgents(): Promise<ReadonlyArray<string_agent_name>>;
+    restoreAgent(agentIdentifier: string): Promise<void>;
     /**
-     * Restore an agent from history
+     * Restore an agent from a specific history entry
+     *
+     * This will update the current agent with the source from the history entry
+     */
+    restoreAgentFromHistory(historyId: number): Promise<void>;
+    /**
+     * Soft delete an agent by setting deletedAt to current timestamp
      */
-    restoreAgent(historyId: number): Promise<void>;
+    deleteAgent(agentIdentifier: string): Promise<void>;
     /**
      * Get the Supabase table name with prefix
      *

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

@@ -22,6 +22,7 @@ export type AgentsDatabaseSchema = {
                     agentName: string;
                     createdAt: string;
                     updatedAt: string | null;
+                    permanentId: string | null;
                     agentHash: string;
                     agentSource: string;
                     agentProfile: Json;
@@ -29,12 +30,14 @@ export type AgentsDatabaseSchema = {
                     usage: Json | null;
                     preparedModelRequirements: Json | null;
                     preparedExternals: Json | null;
+                    deletedAt: string | null;
                 };
                 Insert: {
                     id?: number;
                     agentName: string;
                     createdAt: string;
                     updatedAt?: string | null;
+                    permanentId?: string | null;
                     agentHash: string;
                     agentSource: string;
                     agentProfile: Json;
@@ -42,12 +45,14 @@ export type AgentsDatabaseSchema = {
                     usage?: Json | null;
                     preparedModelRequirements?: Json | null;
                     preparedExternals?: Json | null;
+                    deletedAt?: string | null;
                 };
                 Update: {
                     id?: number;
                     agentName?: string;
                     createdAt?: string;
                     updatedAt?: string | null;
+                    permanentId?: string | null;
                     agentHash?: string;
                     agentSource?: string;
                     agentProfile?: Json;
@@ -55,6 +60,7 @@ export type AgentsDatabaseSchema = {
                     usage?: Json | null;
                     preparedModelRequirements?: Json | null;
                     preparedExternals?: Json | null;
+                    deletedAt?: string | null;
                 };
                 Relationships: [];
             };

package/esm/typings/src/commitments/DICTIONARY/DICTIONARY.d.ts

@@ -0,0 +1,46 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * DICTIONARY commitment definition
+ *
+ * The DICTIONARY commitment defines specific terms and their meanings that the agent should use correctly
+ * in its reasoning and responses. This ensures consistent terminology usage.
+ *
+ * Key features:
+ * - Multiple DICTIONARY commitments are automatically merged into one
+ * - Content is placed in a dedicated section of the system message
+ * - Terms and definitions are stored in metadata.DICTIONARY for debugging
+ * - Agent should use the defined terms correctly in responses
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * Legal Assistant
+ *
+ * PERSONA You are a knowledgeable legal assistant
+ * DICTIONARY Misdemeanor is a minor wrongdoing or criminal offense
+ * DICTIONARY Felony is a serious crime usually punishable by imprisonment for more than one year
+ * DICTIONARY Tort is a civil wrong that causes harm or loss to another person, leading to legal liability
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class DictionaryCommitmentDefinition extends BaseCommitmentDefinition<'DICTIONARY'> {
+    constructor();
+    /**
+     * Short one-line description of DICTIONARY.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for DICTIONARY commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/commitments/index.d.ts

@@ -4,6 +4,7 @@ import { ActionCommitmentDefinition } from './ACTION/ACTION';
 import { ClosedCommitmentDefinition } from './CLOSED/CLOSED';
 import { ComponentCommitmentDefinition } from './COMPONENT/COMPONENT';
 import { DeleteCommitmentDefinition } from './DELETE/DELETE';
+import { DictionaryCommitmentDefinition } from './DICTIONARY/DICTIONARY';
 import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
 import { FromCommitmentDefinition } from './FROM/FROM';
 import { GoalCommitmentDefinition } from './GOAL/GOAL';
@@ -39,7 +40,7 @@ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplemented
  *
  * @private Use functions to access commitments instead of this array directly
  */
-export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, FromCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseMcpCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
+export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, FromCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseMcpCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
 /**
  * Gets a commitment definition by its type
  * @param type The commitment type to look up

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/types/typeAliases.d.ts

@@ -154,6 +154,12 @@ export type string_agent_name_in_book = string;
  * For example `"b126926439c5fcb83609888a11283723c1ef137c0ad599a77a1be81812bd221d"`
  */
 export type string_agent_hash = string_sha256;
+/**
+ * Semantic helper
+ *
+ * For example `"3mJr7AoUXx2Wqd"`
+ */
+export type string_agent_permanent_id = string_base_58;
 /**
  * Unstructured description of the persona
  *
@@ -499,6 +505,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/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-1`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/utils",
-    "version": "0.104.0-0",
+    "version": "0.104.0-2",
     "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-2';
     /**
      * 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: [🎺]
      */