@promptbook/wizard 0.100.0-22 → 0.100.0-23

package/esm/index.es.js

@@ -38,7 +38,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.100.0-22';
+const PROMPTBOOK_ENGINE_VERSION = '0.100.0-23';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/book-2.0/commitments/ACTION/ACTION.d.ts

@@ -18,9 +18,13 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
 export declare class ActionCommitmentDefinition extends BaseCommitmentDefinition<'ACTION'> {
     constructor();
     /**
-     * Markdown documentation for ACTION commitment.
+     * Short one-line description of ACTION.
      */
     get description(): string;
+    /**
+     * Markdown documentation for ACTION commitment.
+     */
+    get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
 /**

package/esm/typings/src/book-2.0/commitments/FORMAT/FORMAT.d.ts

@@ -19,9 +19,13 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
 export declare class FormatCommitmentDefinition extends BaseCommitmentDefinition<'FORMAT'> {
     constructor();
     /**
-     * Markdown documentation for FORMAT commitment.
+     * Short one-line description of FORMAT.
      */
     get description(): string;
+    /**
+     * Markdown documentation for FORMAT commitment.
+     */
+    get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
 /**

package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/KNOWLEDGE.d.ts

@@ -23,9 +23,13 @@ export declare class KnowledgeCommitmentDefinition extends BaseCommitmentDefinit
     private ragService;
     constructor();
     /**
-     * Markdown documentation for KNOWLEDGE commitment.
+     * Short one-line description of KNOWLEDGE.
      */
     get description(): string;
+    /**
+     * Markdown documentation for KNOWLEDGE commitment.
+     */
+    get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
     /**
      * Check if content is a URL

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

@@ -19,9 +19,13 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
 export declare class MetaImageCommitmentDefinition extends BaseCommitmentDefinition<'META IMAGE'> {
     constructor();
     /**
-     * Markdown documentation for META IMAGE commitment.
+     * Short one-line description of META IMAGE.
      */
     get description(): string;
+    /**
+     * Markdown documentation for META IMAGE commitment.
+     */
+    get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
     /**
      * Extracts the profile image URL from the content

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

@@ -27,9 +27,13 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
 export declare class MetaLinkCommitmentDefinition extends BaseCommitmentDefinition<'META LINK'> {
     constructor();
     /**
-     * Markdown documentation for META LINK commitment.
+     * Short one-line description of META LINK.
      */
     get description(): string;
+    /**
+     * Markdown documentation for META LINK commitment.
+     */
+    get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
     /**
      * Extracts the profile link URL from the content

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

@@ -19,9 +19,13 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
 export declare class ModelCommitmentDefinition extends BaseCommitmentDefinition<'MODEL'> {
     constructor();
     /**
-     * Markdown documentation for MODEL commitment.
+     * Short one-line description of MODEL.
      */
     get description(): string;
+    /**
+     * Markdown documentation for MODEL commitment.
+     */
+    get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
 /**

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

@@ -29,9 +29,13 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
 export declare class NoteCommitmentDefinition extends BaseCommitmentDefinition<'NOTE'> {
     constructor();
     /**
-     * Markdown documentation for NOTE commitment.
+     * Short one-line description of NOTE.
      */
     get description(): string;
+    /**
+     * Markdown documentation for NOTE commitment.
+     */
+    get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
 /**

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

@@ -26,9 +26,13 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
 export declare class PersonaCommitmentDefinition extends BaseCommitmentDefinition<'PERSONA'> {
     constructor();
     /**
-     * Markdown documentation for PERSONA commitment.
+     * Short one-line description of PERSONA.
      */
     get description(): string;
+    /**
+     * Markdown documentation for PERSONA commitment.
+     */
+    get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
 /**

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

@@ -18,9 +18,13 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
 export declare class RuleCommitmentDefinition extends BaseCommitmentDefinition<'RULE' | 'RULES'> {
     constructor(type?: 'RULE' | 'RULES');
     /**
-     * Markdown documentation for RULE/RULES commitment.
+     * Short one-line description of RULE/RULES.
      */
     get description(): string;
+    /**
+     * Markdown documentation for RULE/RULES commitment.
+     */
+    get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
 /**

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

@@ -18,9 +18,13 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
 export declare class SampleCommitmentDefinition extends BaseCommitmentDefinition<'SAMPLE' | 'EXAMPLE'> {
     constructor(type?: 'SAMPLE' | 'EXAMPLE');
     /**
-     * Markdown documentation for SAMPLE/EXAMPLE commitment.
+     * Short one-line description of SAMPLE/EXAMPLE.
      */
     get description(): string;
+    /**
+     * Markdown documentation for SAMPLE/EXAMPLE commitment.
+     */
+    get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
 /**

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

@@ -18,9 +18,13 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
 export declare class StyleCommitmentDefinition extends BaseCommitmentDefinition<'STYLE'> {
     constructor();
     /**
-     * Markdown documentation for STYLE commitment.
+     * Short one-line description of STYLE.
      */
     get description(): string;
+    /**
+     * Markdown documentation for STYLE commitment.
+     */
+    get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
 /**

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

@@ -10,10 +10,15 @@ export declare abstract class BaseCommitmentDefinition<TBookCommitment extends s
     readonly type: TBookCommitment;
     constructor(type: TBookCommitment);
     /**
-     * Human-readable markdown documentation for this commitment, available at runtime.
+     * Short one-line markdown description; concise, may use inline **markdown**.
      * Must be implemented by each concrete commitment.
      */
     abstract get description(): string;
+    /**
+     * Human-readable markdown documentation for this commitment, available at runtime.
+     * Must be implemented by each concrete commitment.
+     */
+    abstract get documentation(): string;
     /**
      * Creates a regex pattern to match this commitment in agent source
      * Uses the existing createCommitmentRegex function as internal helper

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

@@ -11,12 +11,17 @@ export interface CommitmentDefinition {
      * The type/name of this commitment (e.g., 'PERSONA', 'KNOWLEDGE', etc.)
      */
     readonly type: string;
+    /**
+     * Short one-line markdown description of this commitment (no lists or code blocks).
+     * Keep it concise; may use inline markdown like **bold** or *italic*.
+     */
+    readonly description: string;
     /**
      * Human-readable markdown documentation for this commitment.
      * Should explain what the commitment does and include example usage.
      * This is available at runtime for UIs, docs, and tooling.
      */
-    readonly description: string;
+    readonly documentation: string;
     /**
      * Creates a regex pattern to match this commitment in agent source
      * This regex should capture the commitment content in a 'contents' named group

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

@@ -11,8 +11,12 @@ import { BaseCommitmentDefinition } from './BaseCommitmentDefinition';
 export declare class NotYetImplementedCommitmentDefinition<TBookCommitment extends string> extends BaseCommitmentDefinition<TBookCommitment> {
     constructor(type: TBookCommitment);
     /**
-     * Markdown documentation available at runtime.
+     * Short one-line description of a placeholder commitment.
      */
     get description(): string;
+    /**
+     * Markdown documentation available at runtime.
+     */
+    get documentation(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }

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.100.0-21`).
+ * It follows semantic versioning (e.g., `0.100.0-22`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/wizard",
-    "version": "0.100.0-22",
+    "version": "0.100.0-23",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -95,7 +95,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/wizard.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.100.0-22"
+        "@promptbook/core": "0.100.0-23"
     },
     "dependencies": {
         "@ai-sdk/deepseek": "0.1.6",

package/umd/index.umd.js

@@ -49,7 +49,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.100.0-22';
+    const PROMPTBOOK_ENGINE_VERSION = '0.100.0-23';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name