@promptbook/utils 0.105.0-14 → 0.105.0-15

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

@@ -1,6 +1,7 @@
 import { Message } from '../../../types/Message';
+import type { ToolCall } from '../../../types/ToolCall';
 import type { id, string_markdown } from '../../../types/typeAliases';
-import type { TODO_any } from '../../../utils/organization/TODO_any';
+export type ChatToolCall = ToolCall;
 /**
  * Represents a single message within a chat interface.
  *
@@ -37,45 +38,17 @@ export type ChatMessage = Omit<Message<id>, 'direction' | 'recipients' | 'thread
     /**
      * Optional tool calls made during the execution
      */
-    readonly ongoingToolCalls?: ReadonlyArray<{
-        /**
-         * Name of the tool
-         */
-        readonly name: string;
-        /**
-         * Arguments for the tool call
-         */
-        readonly arguments?: string | Record<string, TODO_any>;
-        /**
-         * Result of the tool call
-         */
-        readonly result?: TODO_any;
-        /**
-         * Raw tool call from the model
-         */
-        readonly rawToolCall?: TODO_any;
-    }>;
+    readonly ongoingToolCalls?: ReadonlyArray<ChatToolCall>;
+    /**
+     * Optional tool calls used to produce this message.
+     */
+    readonly toolCalls?: ReadonlyArray<ChatToolCall>;
     /**
      * Optional tool calls that have been completed
+     *
+     * @deprecated Use `toolCalls` instead.
      */
-    readonly completedToolCalls?: ReadonlyArray<{
-        /**
-         * Name of the tool
-         */
-        readonly name: string;
-        /**
-         * Arguments for the tool call
-         */
-        readonly arguments?: string | Record<string, TODO_any>;
-        /**
-         * Result of the tool call
-         */
-        readonly result?: TODO_any;
-        /**
-         * Raw tool call from the model
-         */
-        readonly rawToolCall?: TODO_any;
-    }>;
+    readonly completedToolCalls?: ReadonlyArray<ChatToolCall>;
     /**
      * Optional file attachments
      */

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

@@ -1,4 +1,4 @@
-import type { TODO_any } from '../../../utils/organization/TODO_any';
+import type { ToolCall } from '../../../types/ToolCall';
 /**
  * Utility to format tool call information for user-friendly display.
  */
@@ -16,7 +16,4 @@ export declare const TOOL_TITLES: Record<string, {
  *
  * @private [🧠] Maybe public?
  */
-export declare function getToolCallChipletText(toolCall: {
-    name: string;
-    arguments?: string | Record<string, TODO_any>;
-}): string;
+export declare function getToolCallChipletText(toolCall: ToolCall): string;

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

@@ -0,0 +1,41 @@
+import type { ToolCall } from '../../../types/ToolCall';
+import type { TODO_any } from '../../../utils/organization/TODO_any';
+/**
+ * @@@
+ *
+ * @private utility of `<Chat/>` component
+ */
+export declare function parseToolCallArguments(toolCall: Pick<ToolCall, 'arguments'>): Record<string, TODO_any>;
+/**
+ * @@@
+ *
+ * @private utility of `<Chat/>` component
+ */
+export declare function parseToolCallResult(result: ToolCall['result']): TODO_any;
+type SearchResultsExtraction = {
+    results: Array<TODO_any>;
+    rawText: string | null;
+};
+/**
+ * @@@
+ *
+ * @private utility of `<Chat/>` component
+ */
+export declare function extractSearchResults(resultRaw: TODO_any): SearchResultsExtraction;
+/**
+ * @@@
+ *
+ * @private utility of `<Chat/>` component
+ */
+export declare function getToolCallTimestamp(toolCall: Pick<ToolCall, 'createdAt'>): Date | null;
+/**
+ * @@@
+ *
+ * @private utility of `<Chat/>` component
+ */
+export declare function getToolCallResultDate(result: ToolCall['result']): Date | null;
+export {};
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ *         <- TODO: But maybe split into multiple files later?
+ */

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

@@ -21,6 +21,7 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
  */
 export declare class UseSearchEngineCommitmentDefinition extends BaseCommitmentDefinition<'USE SEARCH ENGINE'> {
     constructor();
+    get requiresContent(): boolean;
     /**
      * Short one-line description of USE SEARCH ENGINE.
      */

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

@@ -11,12 +11,14 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
  *
  * ```book
  * USE TIME
+ * USE TIME Prefer the user's local timezone.
  * ```
  *
  * @private [🪔] Maybe export the commitments through some package
  */
 export declare class UseTimeCommitmentDefinition extends BaseCommitmentDefinition<'USE TIME'> {
     constructor();
+    get requiresContent(): boolean;
     /**
      * Short one-line description of USE TIME.
      */

package/esm/typings/src/commitments/_base/formatOptionalInstructionBlock.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @@@
+ *
+ * @private utility for commitments
+ */
+export declare function formatOptionalInstructionBlock(label: string, content: string): string;

package/esm/typings/src/constants.d.ts

@@ -71,6 +71,131 @@ export declare const RESERVED_PARAMETER_RESTRICTED: string;
  * @public exported from `@promptbook/core`
  */
 export declare const RESERVED_PARAMETER_NAMES: readonly ["content", "context", "knowledge", "examples", "modelName", "currentDate"];
+/**
+ * Limits for IDs, names, and other strings
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const LIMITS: {
+    /**
+     * Minimum length of a name (e.g. agent name, persona name)
+     */
+    readonly NAME_MIN_LENGTH: 3;
+    /**
+     * Recommended maximum length of a name
+     */
+    readonly NAME_MAX_LENGTH: 20;
+    /**
+     * Maximum length of a short description or a hash
+     */
+    readonly SHORT_TEXT_MAX_LENGTH: 30;
+    /**
+     * Gone
+     */
+    readonly GONE: 410;
+    /**
+     * Gateway timeout
+     */
+    readonly GATEWAY_TIMEOUT: 504;
+    /**
+     * Too many requests
+     */
+    readonly TOO_MANY_REQUESTS: 429;
+    /**
+     * Maximum length of a file path segment
+     */
+    readonly FILE_PATH_SEGMENT_MAX_LENGTH: 8;
+    /**
+     * Default length of a short name (e.g. for default agent names)
+     */
+    readonly SHORT_NAME_LENGTH: 6;
+};
+/**
+ * Common time intervals in milliseconds
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const TIME_INTERVALS: {
+    /**
+     * One second in milliseconds
+     */
+    readonly SECOND: 1000;
+    /**
+     * Two seconds in milliseconds
+     */
+    readonly TWO_SECONDS: 2000;
+    /**
+     * One minute in milliseconds
+     */
+    readonly MINUTE: 60000;
+    /**
+     * Thirty seconds in milliseconds
+     */
+    readonly THIRTY_SECONDS: 30000;
+    /**
+     * Five seconds in milliseconds
+     */
+    readonly FIVE_SECONDS: 5000;
+};
+/**
+ * Common ports and network limits
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const NETWORK_LIMITS: {
+    /**
+     * Maximum valid port number
+     */
+    readonly MAX_PORT: 65535;
+};
+/**
+ * Common color and image constants
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const COLOR_CONSTANTS: {
+    /**
+     * Maximum value for a color channel (0-255)
+     */
+    readonly MAX_CHANNEL_VALUE: 255;
+    /**
+     * Number of possible colors in 24-bit color (0xFFFFFF)
+     */
+    readonly MAX_24BIT_COLOR: 16777215;
+    /**
+     * Base for hexadecimal strings
+     */
+    readonly HEX_BASE: 16;
+    /**
+     * Length of a hex color without alpha (e.g. "FF0000")
+     */
+    readonly HEX_COLOR_LENGTH: 6;
+    /**
+     * Full circle in degrees
+     */
+    readonly FULL_CIRCLE_DEGREES: 360;
+    /**
+     * Half circle in degrees
+     */
+    readonly HALF_CIRCLE_DEGREES: 180;
+};
+/**
+ * HTTP Status Codes
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const HTTP_STATUS_CODES: {
+    readonly OK: 200;
+    readonly CREATED: 201;
+    readonly BAD_REQUEST: 400;
+    readonly UNAUTHORIZED: 401;
+    readonly NOT_FOUND: 404;
+    readonly INTERNAL_SERVER_ERROR: 500;
+    readonly BAD_GATEWAY: 502;
+    readonly SERVICE_UNAVAILABLE: 503;
+    readonly GATEWAY_TIMEOUT: 504;
+    readonly TOO_MANY_REQUESTS: 429;
+};
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */

package/esm/typings/src/execution/PromptResult.d.ts

@@ -1,5 +1,5 @@
+import type { ToolCall } from '../types/ToolCall';
 import type { string_date_iso8601, string_model_name, string_prompt } from '../types/typeAliases';
-import type { TODO_any } from '../utils/organization/TODO_any';
 import type { TODO_object } from '../utils/organization/TODO_object';
 import type { EmbeddingVector } from './EmbeddingVector';
 import type { Usage } from './Usage';
@@ -26,24 +26,7 @@ export type ChatPromptResult = CommonPromptResult & {
     /**
      * Optional tool calls made during the execution
      */
-    readonly toolCalls?: ReadonlyArray<{
-        /**
-         * Name of the tool
-         */
-        readonly name: string;
-        /**
-         * Arguments of the tool call
-         */
-        readonly arguments: string;
-        /**
-         * Result of the tool call
-         */
-        readonly result: string;
-        /**
-         * Raw tool call from the model
-         */
-        readonly rawToolCall: TODO_any;
-    }>;
+    readonly toolCalls?: ReadonlyArray<ToolCall>;
 };
 /**
  * Image prompt result

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

@@ -0,0 +1,37 @@
+import type { string_date_iso8601 } from './typeAliases';
+import type { TODO_any } from '../utils/organization/TODO_any';
+/**
+ * Represents a single tool call with its inputs, outputs, and timing.
+ *
+ * Note: This is fully serializable as JSON.
+ */
+export type ToolCall = {
+    /**
+     * Name of the tool.
+     */
+    readonly name: string;
+    /**
+     * Arguments for the tool call.
+     */
+    readonly arguments?: string | Record<string, TODO_any>;
+    /**
+     * Result of the tool call.
+     */
+    readonly result?: TODO_any;
+    /**
+     * Raw tool call payload from the model.
+     */
+    readonly rawToolCall?: TODO_any;
+    /**
+     * Timestamp when the tool call was initiated.
+     */
+    readonly createdAt?: string_date_iso8601;
+    /**
+     * Errors thrown during tool execution.
+     */
+    readonly errors?: ReadonlyArray<TODO_any>;
+    /**
+     * Warnings reported during tool execution.
+     */
+    readonly warnings?: ReadonlyArray<TODO_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.105.0-13`).
+ * It follows semantic versioning (e.g., `0.105.0-14`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/utils",
-    "version": "0.105.0-14",
+    "version": "0.105.0-15",
     "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.105.0-14';
+    const PROMPTBOOK_ENGINE_VERSION = '0.105.0-15';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name