@promptbook/wizard 0.100.0-19 → 0.100.0-21

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-19';
+const PROMPTBOOK_ENGINE_VERSION = '0.100.0-21';
 /**
  * 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/_packages/core.index.d.ts

@@ -7,6 +7,10 @@ import { createEmptyAgentModelRequirements } from '../book-2.0/commitments/_base
 import { createBasicAgentModelRequirements } from '../book-2.0/commitments/_base/createEmptyAgentModelRequirements';
 import { NotYetImplementedCommitmentDefinition } from '../book-2.0/commitments/_base/NotYetImplementedCommitmentDefinition';
 import { createAgentModelRequirements } from '../book-2.0/commitments/_misc/createAgentModelRequirements';
+import { getCommitmentDefinition } from '../book-2.0/commitments/index';
+import { getAllCommitmentDefinitions } from '../book-2.0/commitments/index';
+import { getAllCommitmentTypes } from '../book-2.0/commitments/index';
+import { isCommitmentSupported } from '../book-2.0/commitments/index';
 import { collectionToJson } from '../collection/collectionToJson';
 import { createCollectionFromJson } from '../collection/constructors/createCollectionFromJson';
 import { createCollectionFromPromise } from '../collection/constructors/createCollectionFromPromise';
@@ -164,6 +168,10 @@ export { createEmptyAgentModelRequirements };
 export { createBasicAgentModelRequirements };
 export { NotYetImplementedCommitmentDefinition };
 export { createAgentModelRequirements };
+export { getCommitmentDefinition };
+export { getAllCommitmentDefinitions };
+export { getAllCommitmentTypes };
+export { isCommitmentSupported };
 export { collectionToJson };
 export { createCollectionFromJson };
 export { createCollectionFromPromise };

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

@@ -15,7 +15,7 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
  *
  * @private [🪔] Maybe export the commitments through some package
  */
-export declare class ActionCommitmentDefinition extends BaseCommitmentDefinition {
+export declare class ActionCommitmentDefinition extends BaseCommitmentDefinition<'ACTION'> {
     constructor();
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }

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

@@ -16,7 +16,7 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
  *
  * @private [🪔] Maybe export the commitments through some package
  */
-export declare class FormatCommitmentDefinition extends BaseCommitmentDefinition {
+export declare class FormatCommitmentDefinition extends BaseCommitmentDefinition<'FORMAT'> {
     constructor();
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }

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

@@ -19,7 +19,7 @@ import { FrontendRAGService } from './FrontendRAGService';
  *
  * @private [🪔] Maybe export the commitments through some package
  */
-export declare class KnowledgeCommitmentDefinition extends BaseCommitmentDefinition {
+export declare class KnowledgeCommitmentDefinition extends BaseCommitmentDefinition<'KNOWLEDGE'> {
     private ragService;
     constructor();
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;

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

@@ -16,7 +16,7 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
  *
  * @private [🪔] Maybe export the commitments through some package
  */
-export declare class MetaImageCommitmentDefinition extends BaseCommitmentDefinition {
+export declare class MetaImageCommitmentDefinition extends BaseCommitmentDefinition<'META IMAGE'> {
     constructor();
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
     /**

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

@@ -24,7 +24,7 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
  *
  * @private [🪔] Maybe export the commitments through some package
  */
-export declare class MetaLinkCommitmentDefinition extends BaseCommitmentDefinition {
+export declare class MetaLinkCommitmentDefinition extends BaseCommitmentDefinition<'META LINK'> {
     constructor();
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
     /**

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

@@ -16,7 +16,7 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
  *
  * @private [🪔] Maybe export the commitments through some package
  */
-export declare class ModelCommitmentDefinition extends BaseCommitmentDefinition {
+export declare class ModelCommitmentDefinition extends BaseCommitmentDefinition<'MODEL'> {
     constructor();
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }

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

@@ -26,7 +26,7 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
  *
  * @private [🪔] Maybe export the commitments through some package
  */
-export declare class NoteCommitmentDefinition extends BaseCommitmentDefinition {
+export declare class NoteCommitmentDefinition extends BaseCommitmentDefinition<'NOTE'> {
     constructor();
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }

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

@@ -23,7 +23,7 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
  *
  * @private [🪔] Maybe export the commitments through some package
  */
-export declare class PersonaCommitmentDefinition extends BaseCommitmentDefinition {
+export declare class PersonaCommitmentDefinition extends BaseCommitmentDefinition<'PERSONA'> {
     constructor();
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }

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

@@ -15,7 +15,7 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
  *
  * @private [🪔] Maybe export the commitments through some package
  */
-export declare class RuleCommitmentDefinition extends BaseCommitmentDefinition {
+export declare class RuleCommitmentDefinition extends BaseCommitmentDefinition<'RULE' | 'RULES'> {
     constructor(type?: 'RULE' | 'RULES');
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }

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

@@ -15,7 +15,7 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
  *
  * @private [🪔] Maybe export the commitments through some package
  */
-export declare class SampleCommitmentDefinition extends BaseCommitmentDefinition {
+export declare class SampleCommitmentDefinition extends BaseCommitmentDefinition<'SAMPLE' | 'EXAMPLE'> {
     constructor(type?: 'SAMPLE' | 'EXAMPLE');
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }

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

@@ -15,7 +15,7 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
  *
  * @private [🪔] Maybe export the commitments through some package
  */
-export declare class StyleCommitmentDefinition extends BaseCommitmentDefinition {
+export declare class StyleCommitmentDefinition extends BaseCommitmentDefinition<'STYLE'> {
     constructor();
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }

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

@@ -1,5 +1,4 @@
 import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
-import type { BookCommitment } from './BookCommitment';
 import type { CommitmentDefinition } from './CommitmentDefinition';
 /**
  * Base implementation of CommitmentDefinition that provides common functionality
@@ -7,9 +6,9 @@ import type { CommitmentDefinition } from './CommitmentDefinition';
  *
  * @private
  */
-export declare abstract class BaseCommitmentDefinition implements CommitmentDefinition {
-    readonly type: BookCommitment;
-    constructor(type: BookCommitment);
+export declare abstract class BaseCommitmentDefinition<TBookCommitment extends string> implements CommitmentDefinition {
+    readonly type: TBookCommitment;
+    constructor(type: TBookCommitment);
     /**
      * 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/NotYetImplementedCommitmentDefinition.d.ts

@@ -1,6 +1,5 @@
 import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
 import { BaseCommitmentDefinition } from './BaseCommitmentDefinition';
-import type { BookCommitment } from './BookCommitment';
 /**
  * Placeholder commitment definition for commitments that are not yet implemented
  *
@@ -9,7 +8,7 @@ import type { BookCommitment } from './BookCommitment';
  *
  * @public exported from `@promptbook/core`
  */
-export declare class NotYetImplementedCommitmentDefinition extends BaseCommitmentDefinition {
-    constructor(type: BookCommitment);
+export declare class NotYetImplementedCommitmentDefinition<TBookCommitment extends string> extends BaseCommitmentDefinition<TBookCommitment> {
+    constructor(type: TBookCommitment);
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
 }

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

@@ -1,53 +1,55 @@
 import type { BookCommitment } from './_base/BookCommitment';
 import type { CommitmentDefinition } from './_base/CommitmentDefinition';
+import { ActionCommitmentDefinition } from './ACTION/ACTION';
+import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
+import { KnowledgeCommitmentDefinition } from './KNOWLEDGE/KNOWLEDGE';
+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 { PersonaCommitmentDefinition } from './PERSONA/PERSONA';
+import { RuleCommitmentDefinition } from './RULE/RULE';
+import { SampleCommitmentDefinition } from './SAMPLE/SAMPLE';
+import { StyleCommitmentDefinition } from './STYLE/STYLE';
+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 TODO: Maybe should be public?
+ * @private Use functions to access commitments instead of this array directly
  */
-export declare const COMMITMENT_REGISTRY: Array<CommitmentDefinition>;
+export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, MetaImageCommitmentDefinition, MetaLinkCommitmentDefinition, NoteCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"SCENARIO">, NotYetImplementedCommitmentDefinition<"SCENARIOS">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"GOAL">, NotYetImplementedCommitmentDefinition<"GOALS">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
 /**
  * Gets a commitment definition by its type
  * @param type The commitment type to look up
- * @returns The commitment definition or undefined if not found
+ * @returns The commitment definition or null if not found
  *
- * @private TODO: Maybe should be public?
+ * @public exported from `@promptbook/core`
  */
-export declare function getCommitmentDefinition(type: BookCommitment): CommitmentDefinition | undefined;
+export declare function getCommitmentDefinition(type: BookCommitment): CommitmentDefinition | null;
 /**
  * Gets all available commitment definitions
  * @returns Array of all commitment definitions
  *
- * @private TODO: Maybe should be public?
+ * @public exported from `@promptbook/core`
  */
-export declare function getAllCommitmentDefinitions(): CommitmentDefinition[];
+export declare function getAllCommitmentDefinitions(): ReadonlyArray<CommitmentDefinition>;
 /**
  * Gets all available commitment types
  * @returns Array of all commitment types
  *
- * @private TODO: Maybe should be public?
+ * @public exported from `@promptbook/core`
  */
-export declare function getAllCommitmentTypes(): BookCommitment[];
+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
  *
- * @private
+ * @public exported from `@promptbook/core`
  */
 export declare function isCommitmentSupported(type: BookCommitment): boolean;
-/**
- * Creates a custom commitment registry with only specified commitments
- * This is useful for customers who want to disable certain commitments
- *
- * @param enabledCommitments Array of commitment types to enable
- * @returns New registry with only the specified commitments
- *
- * @private
- */
-export declare function createCustomCommitmentRegistry(enabledCommitments: BookCommitment[]): CommitmentDefinition[];
 /**
  * TODO: !!!! Maybe create through standardized $register
  * Note: [💞] Ignore a discrepancy between file name and entity name

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

package/package.json

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