@promptbook/templates 0.100.0-2 → 0.100.0-22

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

@@ -0,0 +1,56 @@
+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 Use functions to access commitments instead of this array directly
+ */
+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 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;
+/**
+ * TODO: !!!! Maybe create through standardized $register
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-2.0/utils/profileImageUtils.d.ts

@@ -0,0 +1,39 @@
+import type { string_url_image } from '../../types/typeAliases';
+/**
+ * Extracts profile image URL from agent definition text and returns cleaned system message
+ * @param systemMessage The original system message that may contain META IMAGE line
+ * @returns Object with profileImageUrl (if found) and cleanedSystemMessage (without META IMAGE line)
+ *
+ * @private - TODO: [🧠] Maybe should be public?
+ */
+export declare function extractProfileImageFromSystemMessage(systemMessage: string): {
+    profileImageUrl?: string_url_image;
+    cleanedSystemMessage: string;
+};
+/**
+ * Extracts persona, examples, and profile image from agent definition text
+ * @param systemMessage The original system message that may contain PERSONA, EXAMPLE, and META IMAGE lines
+ * @returns Object with extracted information and cleaned system message
+ *
+ * @private - TODO: [🧠] Maybe should be public?
+ */
+export declare function extractAgentMetadata(systemMessage: string): {
+    persona?: {
+        name: string;
+        description?: string;
+    };
+    examples: string[];
+    profileImageUrl?: string_url_image;
+    cleanedSystemMessage: string;
+};
+/**
+ * Generates a gravatar URL based on agent name for fallback avatar
+ * @param name The agent name to generate avatar for
+ * @returns Gravatar URL
+ *
+ * @private - TODO: [🧠] Maybe should be public?
+ */
+export declare function generateGravatarUrl(name?: string | null): string;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/pipeline/book-notation.d.ts

@@ -1,3 +1,4 @@
+import type { string_book } from '../book-2.0/agent-source/string_book';
 import type { PipelineString } from './PipelineString';
 /**
  * Tag function for notating a pipeline with a book\`...\ notation as template literal
@@ -12,7 +13,7 @@ import type { PipelineString } from './PipelineString';
  * @returns the pipeline string
  * @public exported from `@promptbook/core`
  */
-export declare function book(strings: TemplateStringsArray, ...values: Array<string>): PipelineString;
+export declare function book(strings: TemplateStringsArray, ...values: Array<string>): string_book & PipelineString;
 /**
  * TODO: [🧠][🈴] Where is the best location for this file
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/types/typeAliases.d.ts

@@ -136,6 +136,12 @@ export type ReservedParameters = Record<string_reserved_parameter_name, string_p
  * For example `"Ai*nautes"`
  */
 export type string_title = string;
+/**
+ * Semantic helper
+ *
+ * For example `"My AI Assistant"`
+ */
+export type string_agent_name = string;
 /**
  * Unstructured description of the persona
  *

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

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

@@ -6,6 +6,15 @@ import type { InputParameters } from '../types/typeAliases';
 import type { string_filename } from '../types/typeAliases';
 import type { string_parameter_value } from '../types/typeAliases';
 import type { string_pipeline_url } from '../types/typeAliases';
+/**
+ * Options for wizard methods
+ */
+interface WizardOptions {
+    /**
+     * Whether to enable verbose logging
+     */
+    isVerbose?: boolean;
+}
 /**
  * Wizard for simple usage of the Promptbook
  * Look at `wizard` for more details
@@ -26,7 +35,7 @@ declare class Wizard {
      *
      * Note: This works similar to the `ptbk run` command
      */
-    execute(book: string_pipeline_url | string_filename | PipelineString, inputParameters: InputParameters): Promise<{
+    execute(book: string_pipeline_url | string_filename | PipelineString, inputParameters: InputParameters, options?: WizardOptions): Promise<{
         /**
          * Simple result of the execution
          */
@@ -36,9 +45,9 @@ declare class Wizard {
     /**
      * Provides the tools automatically for the Node.js environment
      *
-     * @param pipelineSource
+     * @param options
      */
-    getExecutionTools(): Promise<Required<Pick<ExecutionTools, 'fs' | 'fetch'>>>;
+    getExecutionTools(options?: WizardOptions): Promise<Required<Pick<ExecutionTools, 'fs' | 'fetch'>>>;
     /**
      * Load book from the source
      *
@@ -49,8 +58,9 @@ declare class Wizard {
      * 3) As a string
      *
      * @param pipelineSource
+     * @param options
      */
-    getCompiledBook(pipelineSource: string_filename | string_pipeline_url | PipelineString): Promise<PipelineJson>;
+    getCompiledBook(pipelineSource: string_filename | string_pipeline_url | PipelineString, options?: WizardOptions): Promise<PipelineJson>;
 }
 /**
  * Wizard for simple usage of the Promptbook

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/templates",
-    "version": "0.100.0-2",
+    "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/templates.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.100.0-2"
+        "@promptbook/core": "0.100.0-22"
     },
     "dependencies": {
         "prettier": "2.8.1",