@promptbook/javascript 0.103.0-9 → 0.104.0-0

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

@@ -0,0 +1,42 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * META FONT commitment definition
+ *
+ * The META FONT commitment sets the agent's font.
+ * This commitment is special because it doesn't affect the system message,
+ * but is handled separately in the parsing logic.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * META FONT Poppins, Arial, sans-serif
+ * META FONT Roboto
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class MetaFontCommitmentDefinition extends BaseCommitmentDefinition<'META FONT'> {
+    constructor();
+    /**
+     * Short one-line description of META FONT.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for META FONT commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+    /**
+     * Extracts the font from the content
+     * This is used by the parsing logic
+     */
+    extractProfileFont(content: string): string | null;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/{book-2.0/commitments → commitments}/META_IMAGE/META_IMAGE.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
  * META IMAGE commitment definition
@@ -22,6 +22,10 @@ export declare class MetaImageCommitmentDefinition extends BaseCommitmentDefinit
      * Short one-line description of META IMAGE.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for META IMAGE commitment.
      */

package/esm/typings/src/{book-2.0/commitments → commitments}/META_LINK/META_LINK.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
  * META LINK commitment definition
@@ -30,6 +30,10 @@ export declare class MetaLinkCommitmentDefinition extends BaseCommitmentDefiniti
      * Short one-line description of META LINK.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for META LINK commitment.
      */

package/esm/typings/src/{book-2.0/commitments → commitments}/MODEL/MODEL.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
  * MODEL commitment definition
@@ -31,6 +31,10 @@ export declare class ModelCommitmentDefinition extends BaseCommitmentDefinition<
      * Short one-line description of MODEL.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for MODEL commitment.
      */

package/esm/typings/src/{book-2.0/commitments → commitments}/NOTE/NOTE.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
  * NOTE commitment definition
@@ -32,6 +32,10 @@ export declare class NoteCommitmentDefinition extends BaseCommitmentDefinition<'
      * Short one-line description of NOTE.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for NOTE commitment.
      */

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

@@ -0,0 +1,35 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * OPEN commitment definition
+ *
+ * The OPEN commitment specifies that the agent can be modified by conversation.
+ * This is the default behavior.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * OPEN
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class OpenCommitmentDefinition extends BaseCommitmentDefinition<'OPEN'> {
+    constructor();
+    /**
+     * Short one-line description of OPEN.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for OPEN commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, _content: string): AgentModelRequirements;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/{book-2.0/commitments → commitments}/PERSONA/PERSONA.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
  * PERSONA commitment definition
@@ -29,6 +29,10 @@ export declare class PersonaCommitmentDefinition extends BaseCommitmentDefinitio
      * Short one-line description of PERSONA.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for PERSONA commitment.
      */

package/esm/typings/src/{book-2.0/commitments → commitments}/RULE/RULE.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
  * RULE commitment definition
@@ -21,6 +21,10 @@ export declare class RuleCommitmentDefinition extends BaseCommitmentDefinition<'
      * Short one-line description of RULE/RULES.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for RULE/RULES commitment.
      */

package/esm/typings/src/{book-2.0/commitments → commitments}/SAMPLE/SAMPLE.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
  * SAMPLE commitment definition
@@ -21,6 +21,10 @@ export declare class SampleCommitmentDefinition extends BaseCommitmentDefinition
      * Short one-line description of SAMPLE/EXAMPLE.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for SAMPLE/EXAMPLE commitment.
      */

package/esm/typings/src/{book-2.0/commitments → commitments}/SCENARIO/SCENARIO.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
  * SCENARIO commitment definition
@@ -23,6 +23,10 @@ export declare class ScenarioCommitmentDefinition extends BaseCommitmentDefiniti
      * Short one-line description of SCENARIO.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for SCENARIO commitment.
      */

package/esm/typings/src/{book-2.0/commitments → commitments}/STYLE/STYLE.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
 /**
  * STYLE commitment definition
@@ -21,6 +21,10 @@ export declare class StyleCommitmentDefinition extends BaseCommitmentDefinition<
      * Short one-line description of STYLE.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation for STYLE commitment.
      */

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

@@ -0,0 +1,53 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * USE commitment definition
+ *
+ * The USE commitment indicates that the agent should utilize specific tools or capabilities
+ * to access and interact with external systems when necessary.
+ *
+ * Supported USE types:
+ * - USE BROWSER: Enables the agent to use a web browser tool
+ * - USE SEARCH ENGINE (future): Enables search engine access
+ * - USE FILE SYSTEM (future): Enables file system operations
+ * - USE MCP (future): Enables MCP server connections
+ *
+ * The content following the USE commitment is ignored (similar to NOTE).
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * USE BROWSER
+ * USE SEARCH ENGINE
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class UseCommitmentDefinition extends BaseCommitmentDefinition<`USE${string}`> {
+    constructor();
+    /**
+     * Short one-line description of USE commitments.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for USE commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+    /**
+     * Extracts the tool type from the USE commitment
+     * This is used by the parsing logic
+     */
+    extractToolType(content: string): string | null;
+    /**
+     * Checks if this is a known USE type
+     */
+    isKnownUseType(useType: string): boolean;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,42 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * USE BROWSER commitment definition
+ *
+ * The `USE BROWSER` commitment indicates that the agent should utilize a web browser tool
+ * to access and retrieve up-to-date information from the internet when necessary.
+ *
+ * The content following `USE BROWSER` is ignored (similar to NOTE).
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * USE BROWSER
+ * USE BROWSER This will be ignored
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class UseBrowserCommitmentDefinition extends BaseCommitmentDefinition<'USE BROWSER'> {
+    constructor();
+    /**
+     * The `USE BROWSER` commitment is standalone.
+     */
+    get requiresContent(): boolean;
+    /**
+     * Short one-line description of USE BROWSER.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for USE BROWSER 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/USE_BROWSER/USE_BROWSER.test.d.ts

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

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

@@ -0,0 +1,37 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * USE MCP commitment definition
+ *
+ * The `USE MCP` commitment allows to specify an MCP server URL which the agent will connect to
+ * for retrieving additional instructions and actions.
+ *
+ * The content following `USE MCP` is the URL of the MCP server.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * USE MCP http://mcp-server-url.com
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class UseMcpCommitmentDefinition extends BaseCommitmentDefinition<'USE MCP'> {
+    constructor();
+    /**
+     * Short one-line description of USE MCP.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for USE MCP 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/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.d.ts

@@ -0,0 +1,38 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * USE SEARCH ENGINE commitment definition
+ *
+ * The `USE SEARCH ENGINE` commitment indicates that the agent should utilize a search engine tool
+ * to access and retrieve up-to-date information from the internet when necessary.
+ *
+ * The content following `USE SEARCH ENGINE` is ignored (similar to NOTE).
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * USE SEARCH ENGINE
+ * USE SEARCH ENGINE This will be ignored
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class UseSearchEngineCommitmentDefinition extends BaseCommitmentDefinition<'USE SEARCH ENGINE'> {
+    constructor();
+    /**
+     * Short one-line description of USE SEARCH ENGINE.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for USE SEARCH ENGINE commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/{book-2.0/commitments → commitments}/_base/BaseCommitmentDefinition.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import type { CommitmentDefinition } from './CommitmentDefinition';
 /**
  * Base implementation of CommitmentDefinition that provides common functionality
@@ -8,12 +8,24 @@ import type { CommitmentDefinition } from './CommitmentDefinition';
  */
 export declare abstract class BaseCommitmentDefinition<TBookCommitment extends string> implements CommitmentDefinition {
     readonly type: TBookCommitment;
-    constructor(type: TBookCommitment);
+    readonly aliases: string[];
+    constructor(type: TBookCommitment, aliases?: string[]);
     /**
      * Short one-line markdown description; concise, may use inline **markdown**.
      * Must be implemented by each concrete commitment.
      */
     abstract get description(): string;
+    /**
+     * Whether this commitment requires content.
+     * If true, regex will match only if there is content after the commitment keyword.
+     * If false, regex will match even if there is no content.
+     */
+    get requiresContent(): boolean;
+    /**
+     * Icon for this commitment.
+     * It should be a single emoji.
+     */
+    abstract get icon(): string;
     /**
      * Human-readable markdown documentation for this commitment, available at runtime.
      * Must be implemented by each concrete commitment.

package/esm/typings/src/{book-2.0/commitments → commitments}/_base/CommitmentDefinition.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 /**
  * Definition of a commitment that can be applied to agent model requirements
  *
@@ -16,6 +16,11 @@ export type CommitmentDefinition = {
      * Keep it concise; may use inline markdown like **bold** or *italic*.
      */
     readonly description: string;
+    /**
+     * Icon for this commitment.
+     * It should be a single emoji.
+     */
+    readonly icon: string;
     /**
      * Human-readable markdown documentation for this commitment.
      * Should explain what the commitment does and include example usage.

package/esm/typings/src/{book-2.0/commitments → commitments}/_base/NotYetImplementedCommitmentDefinition.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 import { BaseCommitmentDefinition } from './BaseCommitmentDefinition';
 /**
  * Placeholder commitment definition for commitments that are not yet implemented
@@ -14,6 +14,10 @@ export declare class NotYetImplementedCommitmentDefinition<TBookCommitment exten
      * Short one-line description of a placeholder commitment.
      */
     get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
     /**
      * Markdown documentation available at runtime.
      */

package/esm/typings/src/{book-2.0/commitments → commitments}/_base/createEmptyAgentModelRequirements.d.ts

@@ -1,4 +1,4 @@
-import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
 /**
  * Creates an empty/basic agent model requirements object
  * This serves as the starting point for the reduce-like pattern

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

@@ -0,0 +1,93 @@
+import type { BookCommitment } from './_base/BookCommitment';
+import type { CommitmentDefinition } from './_base/CommitmentDefinition';
+import { ActionCommitmentDefinition } from './ACTION/ACTION';
+import { ClosedCommitmentDefinition } from './CLOSED/CLOSED';
+import { ComponentCommitmentDefinition } from './COMPONENT/COMPONENT';
+import { DeleteCommitmentDefinition } from './DELETE/DELETE';
+import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
+import { FromCommitmentDefinition } from './FROM/FROM';
+import { GoalCommitmentDefinition } from './GOAL/GOAL';
+import { KnowledgeCommitmentDefinition } from './KNOWLEDGE/KNOWLEDGE';
+import { LanguageCommitmentDefinition } from './LANGUAGE/LANGUAGE';
+import { MemoryCommitmentDefinition } from './MEMORY/MEMORY';
+import { AgentMessageCommitmentDefinition } from './MESSAGE/AgentMessageCommitmentDefinition';
+import { InitialMessageCommitmentDefinition } from './MESSAGE/InitialMessageCommitmentDefinition';
+import { MessageCommitmentDefinition } from './MESSAGE/MESSAGE';
+import { UserMessageCommitmentDefinition } from './MESSAGE/UserMessageCommitmentDefinition';
+import { MetaCommitmentDefinition } from './META/META';
+import { MetaColorCommitmentDefinition } from './META_COLOR/META_COLOR';
+import { MetaFontCommitmentDefinition } from './META_FONT/META_FONT';
+import { MetaImageCommitmentDefinition } from './META_IMAGE/META_IMAGE';
+import { MetaLinkCommitmentDefinition } from './META_LINK/META_LINK';
+import { ModelCommitmentDefinition } from './MODEL/MODEL';
+import { NoteCommitmentDefinition } from './NOTE/NOTE';
+import { OpenCommitmentDefinition } from './OPEN/OPEN';
+import { PersonaCommitmentDefinition } from './PERSONA/PERSONA';
+import { RuleCommitmentDefinition } from './RULE/RULE';
+import { SampleCommitmentDefinition } from './SAMPLE/SAMPLE';
+import { ScenarioCommitmentDefinition } from './SCENARIO/SCENARIO';
+import { StyleCommitmentDefinition } from './STYLE/STYLE';
+import { UseCommitmentDefinition } from './USE/USE';
+import { UseBrowserCommitmentDefinition } from './USE_BROWSER/USE_BROWSER';
+import { UseMcpCommitmentDefinition } from './USE_MCP/USE_MCP';
+import { UseSearchEngineCommitmentDefinition } from './USE_SEARCH_ENGINE/USE_SEARCH_ENGINE';
+import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplementedCommitmentDefinition';
+/**
+ * Registry of all available commitment definitions
+ * This array contains instances of all commitment definitions
+ * This is the single source of truth for all commitments in the system
+ *
+ * @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">];
+/**
+ * Gets a commitment definition by its type
+ * @param type The commitment type to look up
+ * @returns The commitment definition or null if not found
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getCommitmentDefinition(type: BookCommitment): CommitmentDefinition | null;
+/**
+ * Gets all available commitment definitions
+ * @returns Array of all commitment definitions
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getAllCommitmentDefinitions(): ReadonlyArray<CommitmentDefinition>;
+/**
+ * Gets all available commitment types
+ * @returns Array of all commitment types
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getAllCommitmentTypes(): ReadonlyArray<BookCommitment>;
+/**
+ * Checks if a commitment type is supported
+ * @param type The commitment type to check
+ * @returns True if the commitment type is supported
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function isCommitmentSupported(type: BookCommitment): boolean;
+/**
+ * Grouped commitment definition
+ *
+ * @public exported from `@promptbook/core`
+ */
+export type GroupedCommitmentDefinition = {
+    primary: CommitmentDefinition;
+    aliases: string[];
+};
+/**
+ * Gets all commitment definitions grouped by their aliases
+ *
+ * @returns Array of grouped commitment definitions
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getGroupedCommitmentDefinitions(): ReadonlyArray<GroupedCommitmentDefinition>;
+/**
+ * TODO: [🧠] Maybe create through standardized $register
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -1,7 +1,7 @@
-import { Color } from './_packages/color.index';
 import type { CsvSettings } from './formats/csv/CsvSettings';
 import type { IntermediateFilesStrategy } from './types/IntermediateFilesStrategy';
 import type { string_app_id, string_email, string_name, string_promptbook_server_url } from './types/typeAliases';
+import { Color } from './utils/color/Color';
 /**
  * Warning message for the generated sections and files files
  *
@@ -45,7 +45,21 @@ export declare const CLAIM = "Turn your company's scattered knowledge into AI re
  */
 export declare const PROMPTBOOK_COLOR: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
 /**
- * Dark color of the Promptbook
+ * Colors for syntax highlighting in the `<BookEditor/>`
+ *
+ * TODO: [🗽] Unite branding and make single place for it
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const PROMPTBOOK_SYNTAX_COLORS: {
+    readonly TITLE: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
+    readonly LINE: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
+    readonly SEPARATOR: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
+    readonly COMMITMENT: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
+    readonly PARAMETER: import("./utils/take/interfaces/ITakeChain").WithTake<Color>;
+};
+/**
+ * Chat color of the Promptbook (in chat)
  *
  * TODO: [🗽] Unite branding and make single place for it
  *
@@ -220,6 +234,13 @@ export declare const DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_BOOKS_DIRNAME = "./books";
+/**
+ * Where to store your agents (also book files)
+ * This is kind of a "src" for your books
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_AGENTS_DIRNAME = "./agents";
 /**
  * Where to store the temporary downloads
  *
@@ -257,7 +278,7 @@ export declare const CLI_APP_ID: string_app_id;
  */
 export declare const PLAYGROUND_APP_ID: string_app_id;
 /**
- * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
+ * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createPipelineCollectionFromDirectory`
  *
  * @public exported from `@promptbook/core`
  */

package/esm/typings/src/conversion/validation/validatePipeline.d.ts

@@ -9,6 +9,8 @@ import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
  * -   if it is valid json
  * -   if it is meaningful
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param pipeline valid or invalid PipelineJson
  * @returns the same pipeline if it is logically valid
  * @throws {PipelineLogicError} on logical error in the pipeline