@promptbook/wizard 0.100.0-21 → 0.100.0-22

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-21';
+const PROMPTBOOK_ENGINE_VERSION = '0.100.0-22';
 /**
  * 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

@@ -17,6 +17,10 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
  */
 export declare class ActionCommitmentDefinition extends BaseCommitmentDefinition<'ACTION'> {
     constructor();
+    /**
+     * Markdown documentation for ACTION commitment.
+     */
+    get description(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
 /**

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

@@ -18,6 +18,10 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
  */
 export declare class FormatCommitmentDefinition extends BaseCommitmentDefinition<'FORMAT'> {
     constructor();
+    /**
+     * Markdown documentation for FORMAT commitment.
+     */
+    get description(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
 /**

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

@@ -22,6 +22,10 @@ import { FrontendRAGService } from './FrontendRAGService';
 export declare class KnowledgeCommitmentDefinition extends BaseCommitmentDefinition<'KNOWLEDGE'> {
     private ragService;
     constructor();
+    /**
+     * Markdown documentation for KNOWLEDGE commitment.
+     */
+    get description(): 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

@@ -18,6 +18,10 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
  */
 export declare class MetaImageCommitmentDefinition extends BaseCommitmentDefinition<'META IMAGE'> {
     constructor();
+    /**
+     * Markdown documentation for META IMAGE commitment.
+     */
+    get description(): 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

@@ -26,6 +26,10 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
  */
 export declare class MetaLinkCommitmentDefinition extends BaseCommitmentDefinition<'META LINK'> {
     constructor();
+    /**
+     * Markdown documentation for META LINK commitment.
+     */
+    get description(): 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

@@ -18,6 +18,10 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
  */
 export declare class ModelCommitmentDefinition extends BaseCommitmentDefinition<'MODEL'> {
     constructor();
+    /**
+     * Markdown documentation for MODEL commitment.
+     */
+    get description(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
 /**

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

@@ -28,6 +28,10 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
  */
 export declare class NoteCommitmentDefinition extends BaseCommitmentDefinition<'NOTE'> {
     constructor();
+    /**
+     * Markdown documentation for NOTE commitment.
+     */
+    get description(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
 /**

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

@@ -25,6 +25,10 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
  */
 export declare class PersonaCommitmentDefinition extends BaseCommitmentDefinition<'PERSONA'> {
     constructor();
+    /**
+     * Markdown documentation for PERSONA commitment.
+     */
+    get description(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
 /**

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

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

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

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

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

@@ -17,6 +17,10 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
  */
 export declare class StyleCommitmentDefinition extends BaseCommitmentDefinition<'STYLE'> {
     constructor();
+    /**
+     * Markdown documentation for STYLE commitment.
+     */
+    get description(): string;
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }
 /**

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

@@ -9,6 +9,11 @@ import type { CommitmentDefinition } from './CommitmentDefinition';
 export declare abstract class BaseCommitmentDefinition<TBookCommitment extends string> implements CommitmentDefinition {
     readonly type: TBookCommitment;
     constructor(type: TBookCommitment);
+    /**
+     * Human-readable markdown documentation for this commitment, available at runtime.
+     * Must be implemented by each concrete commitment.
+     */
+    abstract get description(): 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,6 +11,12 @@ export interface CommitmentDefinition {
      * The type/name of this commitment (e.g., 'PERSONA', 'KNOWLEDGE', etc.)
      */
     readonly type: 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;
     /**
      * 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

@@ -10,5 +10,9 @@ import { BaseCommitmentDefinition } from './BaseCommitmentDefinition';
  */
 export declare class NotYetImplementedCommitmentDefinition<TBookCommitment extends string> extends BaseCommitmentDefinition<TBookCommitment> {
     constructor(type: TBookCommitment);
+    /**
+     * Markdown documentation available at runtime.
+     */
+    get description(): 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-20`).
+ * It follows semantic versioning (e.g., `0.100.0-21`).
  *
  * @generated
  */

package/package.json

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