@promptbook/documents 0.112.0-11 → 0.112.0-110

package/esm/src/commitments/_base/CommitmentDefinition.d.ts

@@ -1,6 +1,6 @@
-import { string_javascript_name } from '../../_packages/types.index';
 import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
-import { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
+import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
+import type { string_javascript_name } from '../../types/string_person_fullname';
 /**
  * Optional UI/docs-only deprecation metadata for one commitment keyword.
  *
@@ -17,11 +17,13 @@ type CommitmentDeprecation = {
     readonly replacedBy?: ReadonlyArray<string>;
 };
 /**
- * Definition of a commitment that can be applied to agent model requirements
+ * Definition of a commitment that can be applied to agent model requirements.
  *
  * Each commitment is self-contained and manages its own logic for:
  * - Creating regex patterns for parsing
  * - Applying its effects to agent model requirements
+ *
+ * @public exported from `@promptbook/core`
  */
 export type CommitmentDefinition = {
     /**
@@ -38,6 +40,24 @@ export type CommitmentDefinition = {
      * It should be a single emoji.
      */
     readonly icon: string;
+    /**
+     * Whether this commitment should be prioritized in menus, documentation, and intellisense.
+     */
+    readonly isImportant: boolean;
+    /**
+     * Whether this commitment is unfinished and not ready to use.
+     *
+     * Unfinished commitments are surfaced with low-level caution in the UI,
+     * documentation, and editor diagnostics.
+     */
+    readonly isUnfinished: boolean;
+    /**
+     * Whether this commitment is low-level and should be surfaced with caution.
+     *
+     * Low-level commitments are fully implemented, but they are intended for
+     * advanced use and are not used by most users.
+     */
+    readonly isLowLevel: boolean;
     /**
      * Human-readable markdown documentation for this commitment.
      * Should explain what the commitment does and include example usage.

package/esm/src/commitments/_base/createEmptyAgentModelRequirements.d.ts

@@ -14,6 +14,3 @@ export declare function createEmptyAgentModelRequirements(): AgentModelRequireme
  * @public exported from `@promptbook/core`
  */
 export declare function createBasicAgentModelRequirements(agentName: string | null): AgentModelRequirements;
-/**
- * TODO: [🐤] Deduplicate `AgentModelRequirements` and `ModelRequirements` model requirements
- */

package/esm/src/commitments/_common/commitmentToolFunctions.d.ts

@@ -1,5 +1,5 @@
-import { ToolFunction } from '../../_packages/types.index';
-import { string_javascript_name } from '../../types/typeAliases';
+import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
+import type { string_javascript_name } from '../../types/string_person_fullname';
 /**
  * Map of tool functions keyed by function name.
  *
@@ -10,6 +10,7 @@ export type CommitmentToolFunctions = Record<string_javascript_name, ToolFunctio
  * Collects tool functions from all commitment definitions.
  *
  * @returns Map of tool function implementations.
+ *
  * @private internal helper for commitment tool registry
  */
 export declare function collectCommitmentToolFunctions(): CommitmentToolFunctions;
@@ -18,9 +19,7 @@ export declare function collectCommitmentToolFunctions(): CommitmentToolFunction
  *
  * @param getFunctions - Provider of current tool functions.
  * @returns Proxy exposing tool functions as properties.
+ *
  * @private internal helper for commitment tool registry
  */
 export declare function createToolFunctionsProxy(getFunctions: () => CommitmentToolFunctions): CommitmentToolFunctions;
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/esm/src/commitments/_common/createSerpSearchToolFunction.d.ts

@@ -0,0 +1,12 @@
+import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
+import type { string_javascript_name } from '../../types/string_person_fullname';
+/**
+ * Creates one SERP-backed tool function used as a local fallback for search-like commitments.
+ *
+ * @param toolName - Technical tool name used for validation messages.
+ * @param resultLabel - Human-readable label used in formatted results.
+ * @returns Async tool function compatible with commitment tool registration.
+ *
+ * @private internal helper for search-like commitments
+ */
+export declare function createSerpSearchToolFunction(toolName: string_javascript_name, resultLabel: string): ToolFunction;

package/esm/src/commitments/_common/createWritingCommitmentSections.d.ts

@@ -3,6 +3,7 @@
  *
  * @param content - Explicit 1:1 sample text.
  * @returns Writing-sample guidance ready for one system-message section.
+ *
  * @private internal utility of writing commitments
  */
 export declare function createWritingSampleSection(content: string): string;
@@ -11,9 +12,7 @@ export declare function createWritingSampleSection(content: string): string;
  *
  * @param content - Writing-only instructions.
  * @returns Writing-rules guidance ready for one system-message section.
+ *
  * @private internal utility of writing commitments
  */
 export declare function createWritingRulesSection(content: string): string;
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/esm/src/commitments/_common/getAllCommitmentDefinitions.d.ts

@@ -1,6 +1,7 @@
 import type { CommitmentDefinition } from '../_base/CommitmentDefinition';
 /**
  * Gets all available commitment definitions
+ *
  * @returns Array of all commitment definitions
  *
  * @public exported from `@promptbook/core`

package/esm/src/commitments/_common/getAllCommitmentDefinitions.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/src/commitments/_common/getAllCommitmentTypes.d.ts

@@ -1,6 +1,7 @@
 import type { BookCommitment } from '../_base/BookCommitment';
 /**
  * Gets all available commitment types
+ *
  * @returns Array of all commitment types
  *
  * @public exported from `@promptbook/core`

package/esm/src/commitments/_common/getAllCommitmentsToolFunctionsForNode.d.ts

@@ -1,4 +1,4 @@
-import { type CommitmentToolFunctions } from './commitmentToolFunctions';
+import type { CommitmentToolFunctions } from './commitmentToolFunctions';
 /**
  * Gets all function implementations provided by all commitments
  *
@@ -7,7 +7,3 @@ import { type CommitmentToolFunctions } from './commitmentToolFunctions';
  * @public exported from `@promptbook/node`
  */
 export declare function getAllCommitmentsToolFunctionsForNode(): CommitmentToolFunctions;
-/**
- * Note: [??] Code in this file should never be never released in packages that could be imported into browser environment
- * TODO: [??] Unite `xxxForServer` and `xxxForNode` naming
- */

package/esm/src/commitments/_common/getAllCommitmentsToolTitles.d.ts

@@ -1,4 +1,4 @@
-import { string_javascript_name } from '../../types/typeAliases';
+import type { string_javascript_name } from '../../types/string_person_fullname';
 /**
  * Gets all tool titles provided by all commitments
  *

package/esm/src/commitments/_common/getCommitmentDefinition.d.ts

@@ -2,6 +2,7 @@ import type { BookCommitment } from '../_base/BookCommitment';
 import type { CommitmentDefinition } from '../_base/CommitmentDefinition';
 /**
  * Gets a commitment definition by its type
+ *
  * @param type The commitment type to look up
  * @returns The commitment definition or null if not found
  *

package/esm/src/commitments/_common/getCommitmentNoticeMetadata.d.ts

@@ -0,0 +1,51 @@
+import type { CommitmentDefinition } from '../_base/CommitmentDefinition';
+/**
+ * Type of commitment notice surfaced in docs and editor UI.
+ *
+ * @private internal type of commitment catalog presentation
+ */
+export type CommitmentNoticeMetadata = {
+    /**
+     * Machine-readable notice kind.
+     */
+    readonly kind: 'deprecated' | 'unfinished' | 'lowLevel';
+    /**
+     * Short badge label shown in documentation and menus.
+     */
+    readonly badgeLabel: string;
+    /**
+     * Longer label used in documentation bodies and editor details.
+     */
+    readonly detailLabel: string;
+    /**
+     * Human-readable notice message shown in editor and documentation callouts.
+     */
+    readonly message: string;
+};
+/**
+ * Formats preferred replacement guidance for deprecated commitments.
+ *
+ * @param replacedBy - Preferred replacement commitment keywords.
+ * @returns Optional replacement guidance sentence with leading space.
+ *
+ * @private internal utility of commitment catalog notices
+ */
+export declare function formatCommitmentReplacementText(replacedBy?: ReadonlyArray<string>): string;
+/**
+ * Returns true when one commitment notice should be rendered with low-visibility styling.
+ *
+ * @param notice - Commitment notice metadata or null.
+ * @returns True for unfinished and low-level notices.
+ *
+ * @private internal utility of commitment catalog notices
+ */
+export declare function isLowVisibilityCommitmentNotice(notice: CommitmentNoticeMetadata | null): boolean;
+/**
+ * Resolves the notice metadata for deprecated, unfinished, or low-level commitments.
+ *
+ * @param definition - Commitment definition to inspect.
+ * @returns Notice metadata when the commitment should be surfaced with caution.
+ *
+ * @private internal utility of commitment catalog notices
+ */
+export declare function getCommitmentNoticeMetadata(definition: Pick<CommitmentDefinition, 'deprecation'> & Partial<Pick<CommitmentDefinition, 'isUnfinished' | 'isLowLevel'>>): CommitmentNoticeMetadata | null;

package/esm/src/commitments/_common/getCommitmentNoticeMetadata.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/src/commitments/_common/getGroupedCommitmentDefinitions.d.ts

@@ -1,4 +1,4 @@
-import { CommitmentDefinition } from '../_base/CommitmentDefinition';
+import type { CommitmentDefinition } from '../_base/CommitmentDefinition';
 /**
  * Grouped commitment definition
  */

package/esm/src/commitments/_common/getGroupedCommitmentDefinitions.openClosed.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/src/commitments/_common/getGroupedCommitmentDefinitions.order.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/src/commitments/_common/getGroupedCommitmentDefinitions.use.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/src/commitments/_common/isCommitmentSupported.d.ts

@@ -1,6 +1,7 @@
 import type { BookCommitment } from '../_base/BookCommitment';
 /**
  * Checks if a commitment type is supported
+ *
  * @param type The commitment type to check
  * @returns True if the commitment type is supported
  *

package/esm/src/commitments/_common/sortCommitmentDefinitions.d.ts

@@ -0,0 +1,31 @@
+import type { CommitmentDefinition } from '../_base/CommitmentDefinition';
+/**
+ * Sorting options for commitment definitions.
+ *
+ * @private internal helper of commitment catalog sorting
+ */
+type CommitmentDefinitionSortOptions = {
+    /**
+     * When enabled, deprecated commitments are moved behind all non-deprecated commitments.
+     */
+    readonly isDeprecatedLast?: boolean;
+    /**
+     * When enabled, unfinished commitments are moved behind all other commitments.
+     */
+    readonly isUnfinishedLast?: boolean;
+    /**
+     * When enabled, low-level commitments are moved behind all other commitments.
+     */
+    readonly isLowLevelLast?: boolean;
+};
+/**
+ * Sorts commitment definitions so the important ones stay at the top.
+ *
+ * @param commitmentDefinitions - Definitions to sort.
+ * @param options - Sorting options.
+ * @returns Sorted commitment definitions.
+ *
+ * @private internal helper of commitment catalog sorting
+ */
+export declare function sortCommitmentDefinitions<TCommitmentDefinition extends CommitmentDefinition>(commitmentDefinitions: ReadonlyArray<TCommitmentDefinition>, options?: CommitmentDefinitionSortOptions): ReadonlyArray<TCommitmentDefinition>;
+export {};

package/esm/src/commitments/_common/teamInternalAgentAccess.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Header used for same-server TEAM calls that may access private teammate agents.
+ *
+ * @private internal Agents Server access wiring
+ */
+export declare const TEAM_INTERNAL_AGENT_ACCESS_HEADER = "x-promptbook-team-agent-access-token";
+/**
+ * Options for creating same-server TEAM access headers.
+ *
+ * @private internal Agents Server access wiring
+ */
+export type TeamInternalAgentAccessHeadersOptions = {
+    /**
+     * URL of the teammate agent that is about to be contacted.
+     */
+    readonly agentUrl: string;
+    /**
+     * Origin of the current Agents Server.
+     */
+    readonly localServerUrl?: string;
+    /**
+     * Resolved internal access token carried by the runtime context.
+     */
+    readonly accessToken?: string | null;
+};
+/**
+ * Resolves the internal token used by same-server TEAM calls.
+ *
+ * @returns Hashed token, or `null` when the server does not have a private secret.
+ *
+ * @private internal Agents Server access wiring
+ */
+export declare function resolveTeamInternalAgentAccessToken(): string | null;
+/**
+ * Creates request headers for same-server TEAM calls.
+ *
+ * @param options - Target agent URL, local server URL, and resolved access token.
+ * @returns Header map when the target is same-origin; otherwise an empty map.
+ *
+ * @private internal Agents Server access wiring
+ */
+export declare function createTeamInternalAgentAccessHeaders(options: TeamInternalAgentAccessHeadersOptions): Record<string, string>;
+/**
+ * Checks whether an incoming header carries the current same-server TEAM access token.
+ *
+ * @param value - Raw request header value.
+ * @returns `true` only when the server has a private token and the value matches it.
+ *
+ * @private internal Agents Server access wiring
+ */
+export declare function isTeamInternalAgentAccessToken(value: string | null | undefined): boolean;

package/esm/src/commitments/_common/toolExecutionEnvelope.d.ts

@@ -1,4 +1,4 @@
-import type { TODO_any } from '../../_packages/types.index';
+import type { TODO_any } from '../../utils/organization/TODO_any';
 /**
  * Creates one serialized tool-execution envelope.
  *
@@ -17,6 +17,3 @@ export declare function parseToolExecutionEnvelope(rawValue: unknown): {
     assistantMessage: string;
     toolResult: TODO_any;
 } | null;
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/esm/src/commitments/_common/toolRuntimeContext.d.ts

@@ -1,6 +1,6 @@
-import { TODO_any } from '../../_packages/types.index';
 import type { ToolCallLogEntry, ToolCallState } from '../../types/ToolCall';
 import type { ChatAttachment } from '../../utils/chat/chatAttachments';
+import type { TODO_any } from '../../utils/organization/TODO_any';
 /**
  * Prompt parameter key used to pass hidden runtime context to tool execution.
  *
@@ -85,6 +85,19 @@ export type ToolRuntimeContext = {
         smtpCredential?: string;
         fromAddress?: string;
     };
+    calendars?: {
+        googleAccessToken?: string;
+        connections?: Array<{
+            provider: string;
+            url: string;
+            calendarId: string;
+            scopes?: string[];
+        }>;
+    };
+    agentsServer?: {
+        localServerUrl?: string;
+        teamInternalAccessToken?: string;
+    };
     spawn?: {
         depth?: number;
         parentRunId?: string;
@@ -95,6 +108,10 @@ export type ToolRuntimeContext = {
         userId?: number;
         agentId?: string;
         agentName?: string;
+        /**
+         * Optional assistant message id currently being generated in durable web chat.
+         */
+        assistantMessageId?: string;
         parameters?: Record<string, string>;
         attachments?: ReadonlyArray<ChatAttachment>;
     };
@@ -131,6 +148,7 @@ export declare function serializeToolRuntimeContext(context: ToolRuntimeContext)
  *
  * @param listener - Listener notified about tool progress.
  * @returns Hidden token used to route progress updates.
+ *
  * @private internal runtime wiring for commitment tools
  */
 export declare function registerToolCallProgressListener(listener: ToolCallProgressListener): string;
@@ -138,6 +156,7 @@ export declare function registerToolCallProgressListener(listener: ToolCallProgr
  * Unregisters one in-memory progress listener.
  *
  * @param token - Token previously created by `registerToolCallProgressListener`.
+ *
  * @private internal runtime wiring for commitment tools
  */
 export declare function unregisterToolCallProgressListener(token: string): void;
@@ -147,10 +166,8 @@ export declare function unregisterToolCallProgressListener(token: string): void;
  * @param args - Raw tool arguments including hidden runtime keys.
  * @param update - Incremental progress update.
  * @returns `true` when a listener was found and notified.
+ *
  * @private internal runtime wiring for commitment tools
  */
 export declare function emitToolCallProgressFromToolArgs(args: Record<string, TODO_any>, update: ToolCallProgressUpdate): boolean;
 export {};
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

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

@@ -17,6 +17,7 @@ import { MessageCommitmentDefinition } from './MESSAGE/MESSAGE';
 import { UserMessageCommitmentDefinition } from './MESSAGE/UserMessageCommitmentDefinition';
 import { MessageSuffixCommitmentDefinition } from './MESSAGE_SUFFIX/MESSAGE_SUFFIX';
 import { MetaCommitmentDefinition } from './META/META';
+import { MetaAvatarCommitmentDefinition } from './META_AVATAR/META_AVATAR';
 import { MetaColorCommitmentDefinition } from './META_COLOR/META_COLOR';
 import { MetaDomainCommitmentDefinition } from './META_DOMAIN/META_DOMAIN';
 import { MetaDisclaimerCommitmentDefinition } from './META_DISCLAIMER/META_DISCLAIMER';
@@ -35,8 +36,9 @@ import { ScenarioCommitmentDefinition } from './SCENARIO/SCENARIO';
 import { StyleCommitmentDefinition } from './STYLE/STYLE';
 import { TeamCommitmentDefinition } from './TEAM/TEAM';
 import { TemplateCommitmentDefinition } from './TEMPLATE/TEMPLATE';
-import { UseCommitmentDefinition } from './USE/USE';
 import { UseBrowserCommitmentDefinition } from './USE_BROWSER/USE_BROWSER';
+import { UseCalendarCommitmentDefinition } from './USE_CALENDAR/USE_CALENDAR';
+import { UseDeepSearchCommitmentDefinition } from './USE_DEEPSEARCH/USE_DEEPSEARCH';
 import { UseEmailCommitmentDefinition } from './USE_EMAIL/USE_EMAIL';
 import { UseImageGeneratorCommitmentDefinition } from './USE_IMAGE_GENERATOR/USE_IMAGE_GENERATOR';
 import { UseMcpCommitmentDefinition } from './USE_MCP/USE_MCP';
@@ -48,6 +50,7 @@ import { UseSpawnCommitmentDefinition } from './USE_SPAWN/USE_SPAWN';
 import { UseTimeoutCommitmentDefinition } from './USE_TIMEOUT/USE_TIMEOUT';
 import { UseTimeCommitmentDefinition } from './USE_TIME/USE_TIME';
 import { UseUserLocationCommitmentDefinition } from './USE_USER_LOCATION/USE_USER_LOCATION';
+import { WalletCommitmentDefinition } from './WALLET/WALLET';
 import { WritingRulesCommitmentDefinition } from './WRITING_RULES/WRITING_RULES';
 import { WritingSampleCommitmentDefinition } from './WRITING_SAMPLE/WRITING_SAMPLE';
 import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplementedCommitmentDefinition';
@@ -58,8 +61,4 @@ 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, WritingSampleCommitmentDefinition, WritingRulesCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, TemplateCommitmentDefinition, TemplateCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaDomainCommitmentDefinition, MetaDisclaimerCommitmentDefinition, MetaInputPlaceholderCommitmentDefinition, MetaCommitmentDefinition, MetaVoiceCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, InternalMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageSuffixCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, TeamCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseSpawnCommitmentDefinition, UseTimeoutCommitmentDefinition, UseTimeCommitmentDefinition, UseUserLocationCommitmentDefinition, UseEmailCommitmentDefinition, UsePopupCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseMcpCommitmentDefinition, UsePrivacyCommitmentDefinition, UseProjectCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
-/**
- * TODO: [🧠] Maybe create through standardized $register
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */
+export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, WritingSampleCommitmentDefinition, WritingRulesCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, TemplateCommitmentDefinition, TemplateCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaAvatarCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaDomainCommitmentDefinition, MetaDisclaimerCommitmentDefinition, MetaInputPlaceholderCommitmentDefinition, MetaCommitmentDefinition, MetaVoiceCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, InternalMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageSuffixCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, WalletCommitmentDefinition, WalletCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, TeamCommitmentDefinition, UseBrowserCommitmentDefinition, UseDeepSearchCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseSpawnCommitmentDefinition, UseTimeoutCommitmentDefinition, UseTimeCommitmentDefinition, UseUserLocationCommitmentDefinition, UseCalendarCommitmentDefinition, UseEmailCommitmentDefinition, UsePopupCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseMcpCommitmentDefinition, UsePrivacyCommitmentDefinition, UseProjectCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];

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

@@ -0,0 +1 @@
+export {};

package/esm/src/config.d.ts

@@ -1,6 +1,10 @@
 import type { CsvSettings } from './formats/csv/CsvSettings';
 import type { IntermediateFilesStrategy } from './types/IntermediateFilesStrategy';
-import type { string_app_id, string_email, string_legal_entity, string_name, string_promptbook_server_url } from './types/typeAliases';
+import type { string_email } from './types/string_email';
+import type { string_name } from './types/string_name';
+import type { string_legal_entity } from './types/string_person_fullname';
+import type { string_promptbook_server_url } from './types/string_promptbook_server_url';
+import type { string_app_id } from './types/string_token';
 import { Color } from './utils/color/Color';
 /**
  * Warning message for the generated sections and files files
@@ -41,7 +45,7 @@ export declare const ADMIN_GITHUB_NAME: string_name;
  *
  * @public exported from `@promptbook/core`
  */
-export declare const CLAIM = "Turn your company's scattered knowledge into AI ready books";
+export declare const CLAIM = "Create persistent AI agents that turn your company's scattered knowledge into action";
 /**
  * Color of the Promptbook
  *
@@ -89,7 +93,7 @@ export declare const USER_CHAT_COLOR: import("./utils/take/interfaces/ITakeChain
  *
  * @public exported from `@promptbook/core`
  */
-export declare const DEFAULT_BOOK_TITLE = "\u2728 Untitled Book";
+export declare const DEFAULT_BOOK_TITLE = "\uD83D\uDC19 Untitled agent";
 /**
  * When the title of task is not provided, the default title is used
  *
@@ -270,7 +274,7 @@ export declare const DEFAULT_AGENTS_DIRNAME = "./agents";
  *
  * @public exported from `@promptbook/core`
  */
-export declare const DEFAULT_DOWNLOAD_CACHE_DIRNAME = "./.promptbook/download-cache";
+export declare const DEFAULT_DOWNLOAD_CACHE_DIRNAME: string;
 /**
  * Where to store the cache of executions for promptbook CLI
  *
@@ -278,7 +282,7 @@ export declare const DEFAULT_DOWNLOAD_CACHE_DIRNAME = "./.promptbook/download-ca
  *
  * @public exported from `@promptbook/core`
  */
-export declare const DEFAULT_EXECUTION_CACHE_DIRNAME = "./.promptbook/execution-cache";
+export declare const DEFAULT_EXECUTION_CACHE_DIRNAME: string;
 /**
  * Where to store the scrape cache
  *
@@ -286,7 +290,7 @@ export declare const DEFAULT_EXECUTION_CACHE_DIRNAME = "./.promptbook/execution-
  *
  * @public exported from `@promptbook/core`
  */
-export declare const DEFAULT_SCRAPE_CACHE_DIRNAME = "./.promptbook/scrape-cache";
+export declare const DEFAULT_SCRAPE_CACHE_DIRNAME: string;
 /**
  * Id of application for the CLI when using remote server
  *

package/esm/src/config.test.d.ts

@@ -1,4 +1 @@
 export {};
-/**
- * TODO: [🧠] Maybe more elegant how to prevent accidental costs
- */

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

@@ -15,6 +15,3 @@ export declare const CHAT_STREAM_KEEP_ALIVE_TOKEN = "STREAM_KEEP_ALIVE";
  * @private internal streaming helper for Promptbook chat connections
  */
 export declare const CHAT_STREAM_KEEP_ALIVE_INTERVAL_MS = 25000;
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/esm/src/constants.d.ts

@@ -206,6 +206,3 @@ export declare const HTTP_STATUS_CODES: {
     readonly GATEWAY_TIMEOUT: 504;
     readonly TOO_MANY_REQUESTS: 429;
 };
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/esm/src/conversion/archive/loadArchive.d.ts

@@ -1,6 +1,6 @@
 import type { FilesystemTools } from '../../execution/FilesystemTools';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
-import type { string_filename } from '../../types/typeAliases';
+import type { string_filename } from '../../types/string_filename';
 /**
  * Loads the books from the archive file with `.bookc` extension
  *
@@ -11,6 +11,3 @@ import type { string_filename } from '../../types/typeAliases';
  * @private utility of Promptbook
  */
 export declare function loadArchive(filePath: string_filename, fs: FilesystemTools): Promise<ReadonlyArray<PipelineJson>>;
-/**
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
- */

package/esm/src/conversion/archive/saveArchive.d.ts

@@ -1,6 +1,6 @@
 import type { FilesystemTools } from '../../execution/FilesystemTools';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
-import type { string_filename } from '../../types/typeAliases';
+import type { string_filename } from '../../types/string_filename';
 /**
  * Saves the given books into an archive file with `.bookc` extension
  *
@@ -11,8 +11,3 @@ import type { string_filename } from '../../types/typeAliases';
  * @private utility of Promptbook
  */
 export declare function saveArchive(filePath: string_filename, collectionJson: ReadonlyArray<PipelineJson>, fs: FilesystemTools): Promise<void>;
-/**
- * TODO: Add metadata to zip
- * TODO: Compression level and other zip options from config
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
- */

package/esm/src/conversion/compilePipeline.d.ts

@@ -5,21 +5,16 @@ import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions
 /**
  * Compile pipeline from string (markdown) format to JSON format
  *
- * @see https://github.com/webgptorg/promptbook/discussions/196
- *
  * Note: This function does not validate logic of the pipeline only the parsing
  * Note: This function acts as compilation process
  *
+ * @see https://github.com/webgptorg/promptbook/discussions/196
  * @param pipelineString {Promptbook} in string markdown format (.book.md)
  * @param tools - Tools for the preparation and scraping - if not provided together with `llm`, the preparation will be skipped
  * @param options - Options and tools for the compilation
  * @returns {Promptbook} compiled in JSON format (.bookc)
  * @throws {ParseError} if the promptbook string is not valid
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function compilePipeline(pipelineString: PipelineString, tools?: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
-/**
- * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
- * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
- * TODO: [🧠] Should be in generated JSON file GENERATOR_WARNING
- */

package/esm/src/conversion/compilePipelineOnRemoteServer.d.ts

@@ -4,18 +4,15 @@ import type { RemoteClientOptions } from '../remote-server/types/RemoteClientOpt
 /**
  * Compile pipeline from string (markdown) format to JSON format
  *
- * @see https://github.com/webgptorg/promptbook/discussions/196
- *
  * Note: This function does not validate logic of the pipeline only the parsing
  * Note: This function acts as compilation process
  *
+ * @see https://github.com/webgptorg/promptbook/discussions/196
  * @param pipelineString {Promptbook} in string markdown format (.book.md)
  * @param options - Configuration of the remote server
  * @returns {Promptbook} compiled in JSON format (.bookc)
  * @throws {ParseError} if the promptbook string is not valid
+ *
  * @public exported from `@promptbook/remote-client`
  */
 export declare function compilePipelineOnRemoteServer<TCustomOptions = undefined>(pipelineString: PipelineString, options: RemoteClientOptions<TCustomOptions>): Promise<PipelineJson>;
-/**
- * TODO: [🐚] Do not return `Promise<PipelineJson>` But `PreparationTask`
- */

package/esm/src/conversion/parsePipeline/applyPipelineHead.d.ts

@@ -0,0 +1,8 @@
+import type { $PipelineJson } from '../../commands/_common/types/CommandParser';
+import type { MarkdownSection } from '../../utils/markdown/parseMarkdownSection';
+/**
+ * Applies the pipeline head title, description, and head-level commands.
+ *
+ * @private internal utility of `parsePipeline`
+ */
+export declare function applyPipelineHead(pipelineHead: MarkdownSection, $pipelineJson: $PipelineJson): void;

package/esm/src/conversion/parsePipeline/createInitialPipelineJson.d.ts

@@ -0,0 +1,8 @@
+import type { $PipelineJson } from '../../commands/_common/types/CommandParser';
+import type { PipelineString } from '../../pipeline/PipelineString';
+/**
+ * Creates the mutable pipeline JSON structure used throughout parsing.
+ *
+ * @private internal utility of `parsePipeline`
+ */
+export declare function createInitialPipelineJson(pipelineString: PipelineString): $PipelineJson;