@promptbook/cli 0.114.0-3 → 0.114.0-5

package/src/commitments/USE_TIMEOUT/TimeoutToolRuntimeAdapter.ts

@@ -1,255 +0,0 @@
-import type { TODO_any } from '../../utils/organization/TODO_any';
-
-/**
- * Tool arguments for scheduling one timeout.
- *
- * @private type of UseTimeoutCommitmentDefinition
- */
-export type SetTimeoutToolArgs = {
-    milliseconds?: number;
-    message?: string;
-    [key: string]: TODO_any;
-};
-
-/**
- * Tool arguments for cancelling one timeout.
- *
- * @private type of UseTimeoutCommitmentDefinition
- */
-export type CancelTimeoutToolArgs = {
-    timeoutId?: string;
-    allActive?: boolean;
-    [key: string]: TODO_any;
-};
-
-/**
- * Tool arguments for updating one timeout or pausing/resuming all active queued timeouts.
- *
- * @private type of UseTimeoutCommitmentDefinition
- */
-export type UpdateTimeoutToolArgs = {
-    timeoutId?: string;
-    allActive?: boolean;
-    dueAt?: string;
-    extendByMs?: number;
-    recurrenceIntervalMs?: number | null;
-    message?: string | null;
-    parameters?: Record<string, unknown>;
-    paused?: boolean;
-    [key: string]: TODO_any;
-};
-
-/**
- * Tool arguments for listing scoped timeouts.
- *
- * @private type of UseTimeoutCommitmentDefinition
- */
-export type ListTimeoutsToolArgs = {
-    includeFinished?: boolean;
-    limit?: number;
-    [key: string]: TODO_any;
-};
-
-/**
- * Runtime context available to `USE TIMEOUT` tools.
- *
- * @private type of UseTimeoutCommitmentDefinition
- */
-export type TimeoutToolRuntimeContext = {
-    readonly enabled: boolean;
-    readonly chatId?: string;
-    readonly userId?: number;
-    readonly agentId?: string;
-    readonly agentName?: string;
-    readonly promptParameters: Record<string, string>;
-};
-
-/**
- * Lifecycle status exposed by `list_timeouts`.
- *
- * @private type of UseTimeoutCommitmentDefinition
- */
-export type TimeoutToolListItemStatus = 'QUEUED' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED';
-
-/**
- * One timeout row exposed by `list_timeouts`.
- *
- * @private type of UseTimeoutCommitmentDefinition
- */
-export type TimeoutToolListItem = {
-    timeoutId: string;
-    chatId: string;
-    status: TimeoutToolListItemStatus;
-    dueAt: string;
-    paused: boolean;
-    message?: string | null;
-    recurrenceIntervalMs?: number | null;
-};
-
-/**
- * Result payload returned by `set_timeout`.
- *
- * @private type of UseTimeoutCommitmentDefinition
- */
-export type SetTimeoutToolResult = {
-    action: 'set';
-    status: 'set' | 'disabled' | 'error';
-    timeoutId?: string;
-    dueAt?: string;
-    message?: string;
-};
-
-/**
- * Result payload returned by `cancel_timeout`.
- *
- * @private type of UseTimeoutCommitmentDefinition
- */
-export type CancelTimeoutToolResult = {
-    action: 'cancel';
-    status: 'cancelled' | 'cancelled_all' | 'not_found' | 'disabled' | 'error';
-    timeoutId?: string;
-    dueAt?: string;
-    cancelledCount?: number;
-    cancelledTimeoutIds?: Array<string>;
-    hasMore?: boolean;
-    message?: string;
-};
-
-/**
- * Result payload returned by `update_timeout`.
- *
- * @private type of UseTimeoutCommitmentDefinition
- */
-export type UpdateTimeoutToolResult = {
-    action: 'update';
-    status: 'updated' | 'updated_all' | 'not_found' | 'conflict' | 'disabled' | 'error';
-    timeoutId?: string;
-    dueAt?: string;
-    paused?: boolean;
-    recurrenceIntervalMs?: number | null;
-    updatedCount?: number;
-    matchedCount?: number;
-    updatedTimeoutIds?: Array<string>;
-    hasMore?: boolean;
-    message?: string;
-};
-
-/**
- * Result payload returned by `list_timeouts`.
- *
- * @private type of UseTimeoutCommitmentDefinition
- */
-export type ListTimeoutsToolResult = {
-    action: 'list';
-    status: 'listed' | 'disabled' | 'error';
-    items?: Array<TimeoutToolListItem>;
-    total?: number;
-    message?: string;
-};
-
-/**
- * Union of all `USE TIMEOUT` tool actions.
- *
- * @private type of UseTimeoutCommitmentDefinition
- */
-export type TimeoutToolAction =
-    | SetTimeoutToolResult['action']
-    | CancelTimeoutToolResult['action']
-    | ListTimeoutsToolResult['action']
-    | UpdateTimeoutToolResult['action'];
-
-/**
- * Union of all `USE TIMEOUT` tool results.
- *
- * @private type of UseTimeoutCommitmentDefinition
- */
-export type TimeoutToolResult =
-    | SetTimeoutToolResult
-    | CancelTimeoutToolResult
-    | ListTimeoutsToolResult
-    | UpdateTimeoutToolResult;
-
-/**
- * Runtime adapter used by `USE TIMEOUT` tools.
- *
- * @private type of UseTimeoutCommitmentDefinition
- */
-export type TimeoutToolRuntimeAdapter = {
-    scheduleTimeout(
-        args: {
-            milliseconds: number;
-            message?: string;
-        },
-        runtimeContext: TimeoutToolRuntimeContext,
-    ): Promise<{
-        timeoutId: string;
-        dueAt: string;
-    }>;
-    cancelTimeout(
-        args:
-            | {
-                  timeoutId: string;
-              }
-            | {
-                  allActive: true;
-              },
-        runtimeContext: TimeoutToolRuntimeContext,
-    ): Promise<{
-        status: 'cancelled' | 'cancelled_all' | 'not_found';
-        timeoutId?: string;
-        dueAt?: string;
-        cancelledCount?: number;
-        cancelledTimeoutIds?: Array<string>;
-        hasMore?: boolean;
-    }>;
-    listTimeouts(
-        args: {
-            includeFinished: boolean;
-            limit: number;
-        },
-        runtimeContext: TimeoutToolRuntimeContext,
-    ): Promise<{
-        items: Array<TimeoutToolListItem>;
-        total: number;
-    }>;
-    updateTimeout(
-        args:
-            | {
-                  timeoutId: string;
-                  patch: {
-                      dueAt?: string;
-                      extendByMs?: number;
-                      recurrenceIntervalMs?: number | null;
-                      message?: string | null;
-                      parameters?: Record<string, unknown>;
-                      paused?: boolean;
-                  };
-              }
-            | {
-                  allActive: true;
-                  paused: boolean;
-              },
-        runtimeContext: TimeoutToolRuntimeContext,
-    ): Promise<
-        | {
-              status: 'updated';
-              timeout: TimeoutToolListItem;
-          }
-        | {
-              status: 'not_found';
-              timeoutId: string;
-          }
-        | {
-              status: 'conflict';
-              timeoutId: string;
-              reason: 'finished' | 'running';
-          }
-        | {
-              status: 'updated_all';
-              updatedCount: number;
-              matchedCount: number;
-              updatedTimeoutIds: Array<string>;
-              hasMore?: boolean;
-          }
-    >;
-};

package/src/commitments/USE_TIMEOUT/USE_TIMEOUT.ts

@@ -1,117 +0,0 @@
-import { spaceTrim } from 'spacetrim';
-import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
-import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
-import type { string_javascript_name } from '../../types/string_person_fullname';
-import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
-import { formatOptionalInstructionBlock } from '../_base/formatOptionalInstructionBlock';
-import { createTimeoutSystemMessage } from './createTimeoutSystemMessage';
-import { createTimeoutToolFunctions } from './createTimeoutToolFunctions';
-import { createTimeoutTools } from './createTimeoutTools';
-import { TimeoutToolNames } from './TimeoutToolNames';
-
-export { setTimeoutToolRuntimeAdapter } from './setTimeoutToolRuntimeAdapter';
-export type {
-    CancelTimeoutToolResult,
-    ListTimeoutsToolResult,
-    SetTimeoutToolResult,
-    TimeoutToolListItem,
-    TimeoutToolRuntimeAdapter,
-    TimeoutToolRuntimeContext,
-    UpdateTimeoutToolResult,
-} from './TimeoutToolRuntimeAdapter';
-
-/**
- * `USE TIMEOUT` commitment definition.
- *
- * The `USE TIMEOUT` commitment enables timeout wake-ups and scoped timeout management.
- *
- * @private [🪔] Maybe export the commitments through some package
- */
-export class UseTimeoutCommitmentDefinition extends BaseCommitmentDefinition<'USE TIMEOUT'> {
-    public constructor() {
-        super('USE TIMEOUT');
-    }
-
-    override get requiresContent(): boolean {
-        return false;
-    }
-
-    /**
-     * Short one-line description of `USE TIMEOUT`.
-     */
-    get description(): string {
-        return 'Enable timeout wake-ups plus scoped timeout listing, updates, and cancellation across chats.';
-    }
-
-    /**
-     * Icon for this commitment.
-     */
-    get icon(): string {
-        return '⏱️';
-    }
-
-    /**
-     * Markdown documentation for `USE TIMEOUT`.
-     */
-    get documentation(): string {
-        return spaceTrim(`
-            # USE TIMEOUT
-
-            Enables timeout wake-ups and timeout management for the same user+agent scope.
-
-            ## Key aspects
-
-            - The agent uses \`set_timeout\` to schedule a future wake-up in the same chat thread.
-            - The tool returns immediately while the timeout is stored and executed by the runtime later.
-            - The wake-up arrives as a new user-like timeout message in the same conversation.
-            - The agent can inspect known timeout details via \`list_timeouts\`.
-            - The agent can cancel one timeout by \`timeoutId\` or cancel all active timeouts via \`cancel_timeout\`.
-            - The agent can pause/resume and edit timeout details via \`update_timeout\`.
-            - Commitment content is treated as optional timeout policy instructions.
-
-            ## Examples
-
-            \`\`\`book
-            Follow-up Agent
-            USE TIMEOUT Remind yourself only when follow-up work is explicitly requested.
-            \`\`\`
-        `);
-    }
-
-    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements {
-        const extraInstructions = formatOptionalInstructionBlock('Timeout instructions', content);
-
-        return this.appendToSystemMessage(
-            {
-                ...requirements,
-                tools: createTimeoutTools(requirements.tools || []),
-                _metadata: {
-                    ...requirements._metadata,
-                    useTimeout: content || true,
-                },
-            },
-            createTimeoutSystemMessage(extraInstructions),
-        );
-    }
-
-    /**
-     * Gets human-readable titles for tool functions provided by this commitment.
-     */
-    getToolTitles(): Record<string_javascript_name, string> {
-        return {
-            [TimeoutToolNames.set]: 'Set timer',
-            [TimeoutToolNames.cancel]: 'Cancel timer',
-            [TimeoutToolNames.list]: 'List timers',
-            [TimeoutToolNames.update]: 'Update timer',
-        };
-    }
-
-    /**
-     * Gets `USE TIMEOUT` tool function implementations.
-     */
-    getToolFunctions(): Record<string_javascript_name, ToolFunction> {
-        return createTimeoutToolFunctions();
-    }
-}
-
-// Note: [💞] Ignore a discrepancy between file name and entity name

package/src/commitments/USE_TIMEOUT/createTimeoutSystemMessage.ts

@@ -1,22 +0,0 @@
-import { spaceTrim } from 'spacetrim';
-
-/**
- * Creates system-message instructions for `USE TIMEOUT`.
- *
- * @private internal utility of USE TIMEOUT
- */
-export function createTimeoutSystemMessage(extraInstructions: string): string {
-    return spaceTrim(
-        (block) => `
-            ## Timeout scheduling
-
-            -   Use \`set_timeout\` to wake this same chat thread in the future.
-            -   Use \`list_timeouts\` to review timeout ids/details across all chats for the same user+agent scope.
-            -   \`cancel_timeout\` accepts either one timeout id or \`allActive: true\` to cancel all active timeouts in this same user+agent scope.
-            -   Use \`update_timeout\` to pause/resume, edit next run, edit recurrence, or update timeout payload details.
-            -   When one timeout elapses, you will receive a new user-like message that explicitly says it is a timeout wake-up and includes the \`timeoutId\`.
-            -   Do not claim a timer was set or cancelled unless the tool confirms it.
-            ${block(extraInstructions)}
-        `,
-    );
-}