@promptbook/openai 0.100.0-4 → 0.100.0-41

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/book-components/AvatarProfile/AvatarChip/AvatarChip.d.ts

@@ -0,0 +1,35 @@
+import type { AgentBasicInformation } from '../../../book-2.0/agent-source/parseAgentSource';
+import type { string_css_class } from '../../../types/typeAliases';
+/**
+ * Props of `AvatarChip`
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type AvatarChipProps = {
+    /**
+     * Avatar to be shown
+     */
+    readonly avatarBasicInformation: AgentBasicInformation;
+    /**
+     * Whether this chip is a template avatar
+     */
+    readonly isTemplate: boolean;
+    /**
+     * Optional CSS class name which will be added to root <div> element
+     */
+    readonly className?: string_css_class;
+    /**
+     * Called when chip is clicked
+     */
+    readonly onSelect?: (avatar: AgentBasicInformation) => void;
+    /**
+     * Whether this chip is selected
+     */
+    readonly isSelected?: boolean;
+};
+/**
+ * Shows a chip with avatar's avatar and name
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function AvatarChip(props: AvatarChipProps): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/AvatarProfile/AvatarChip/AvatarChipFromSource.d.ts

@@ -0,0 +1,21 @@
+import type { string_book } from '../../../book-2.0/agent-source/string_book';
+import type { AvatarChipProps } from './AvatarChip';
+/**
+ * Props of `AvatarChipFromSource`
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type AvatarChipFromSource = Omit<AvatarChipProps, 'avatarBasicInformation'> & {
+    /**
+     * Avatar to be shown
+     */
+    readonly source: string_book;
+};
+/**
+ * Shows a chip with avatar's avatar and name based on the avatar source string
+ *
+ * This component is wrapped around the `<AvatarChip/>`, it just parses the avatar source string into `AvatarBasicInformation` and passes it to the `<AvatarChip/>` component.
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function AvatarChipFromSource(props: AvatarChipFromSource): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/AvatarProfile/AvatarChip/index.d.ts

@@ -0,0 +1,2 @@
+export * from './AvatarChip';
+export * from './AvatarChipFromSource';

package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts

@@ -0,0 +1,35 @@
+import type { string_book } from '../../book-2.0/agent-source/string_book';
+/**
+ * Props of `BookEditor`
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type BookEditorProps = {
+    /**
+     * Additional CSS classes to apply to the editor container.
+     */
+    readonly className?: string;
+    /**
+     * CSS className for a font (e.g. from next/font) to style the editor text.
+     * If omitted, defaults to system serif fonts.
+     */
+    readonly fontClassName?: string;
+    /**
+     * The book which is being edited.
+     */
+    readonly value?: string_book;
+    /**
+     * Callback function to handle changes in the book content.
+     */
+    onChange?(value: string_book): void;
+    /**
+     * If true, logs verbose debug info to the console and shows additional visual cues
+     */
+    readonly isVerbose?: boolean;
+};
+/**
+ * Renders a book editor
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function BookEditor(props: BookEditorProps): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/BookEditor/config.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Default font class name for the BookEditor component
+ * In Next.js environments, you can override this by importing the font directly
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare const DEFAULT_BOOK_FONT_CLASS: any;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-components/BookEditor/injectCssModuleIntoShadowRoot.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Inject the CSS module rules (derived from imported `styles`) into the provided shadow root.
+ * This allows CSS modules (which are normally emitted into the document head) to be
+ * available inside the component's shadow DOM.
+ *
+ * @private within the promptbook components <- TODO: Maybe make promptbook util from this
+ */
+export declare function injectCssModuleIntoShadowRoot(shadowRoot: ShadowRoot): void;
+/**
+ * TODO: Make some utility functions for working with CSS modules in shadow DOM independent of `BookEditor.module.css`
+ */

package/esm/typings/src/book-components/_common/react-utils/classNames.d.ts

@@ -0,0 +1,7 @@
+import type { string_css_class } from '../../../types/typeAliases';
+/**
+ * Utility function for joining multiple truthy class names into one string
+ *
+ * @private within the `@promptbook/components`
+ */
+export declare function classNames(...classes: Array<string_css_class | undefined | false | null>): string_css_class;

package/esm/typings/src/book-components/_common/react-utils/collectCssTextsForClass.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Collect matching CSS texts from document stylesheets for a given class.
+ * This will skip cross-origin stylesheets (they throw when accessed).
+ *
+ * @private within the promptbook components <- TODO: Maybe make promptbook util from this
+ */
+export declare function collectCssTextsForClass(className: string): string[];

package/esm/typings/src/book-components/_common/react-utils/escapeHtml.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Escape HTML to safely render user text inside a <pre> with dangerouslySetInnerHTML.
+ *
+ * @private within the promptbook components <- TODO: Maybe make promptbook util from this
+ */
+export declare function escapeHtml(input: string): string;

package/esm/typings/src/book-components/_common/react-utils/escapeRegex.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Escape text for safe use inside a RegExp pattern.
+ *
+ * @private within the promptbook components <- TODO: Maybe make promptbook util from this
+ */
+export declare function escapeRegex(input: string): string;

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

@@ -281,6 +281,12 @@ export declare function SET_IS_VERBOSE(isVerbose: boolean): void;
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_IS_AUTO_INSTALLED = false;
+/**
+ * Default simulated duration for a task in milliseconds (used for progress reporting)
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_TASK_SIMULATED_DURATION_MS: number;
 /**
  * Function name for generated function via `ptbk make` to get the pipeline collection
  *

package/esm/typings/src/execution/AvailableModel.d.ts

@@ -40,6 +40,10 @@ export type AvailableModel = {
         readonly prompt: number_usd;
         readonly output: number_usd;
     };
+    /**
+     * If the model is deprecated, it should not be used for new tasks
+     */
+    readonly isDeprecated?: boolean;
 };
 /**
  * TODO: [🧠] Maybe rename to something else - like `ModelInformation` or `ModelMetadata`

package/esm/typings/src/execution/ExecutionTask.d.ts

@@ -1,5 +1,6 @@
 import type { Observable } from 'rxjs';
 import { PartialDeep } from 'type-fest';
+import type { number_percent } from '../types/typeAliases';
 import type { task_id } from '../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { string_promptbook_version } from '../version';
@@ -28,6 +29,19 @@ type CreateTaskOptions<TTaskResult extends AbstractTaskResult> = {
          */
         readonly title?: AbstractTask<TTaskResult>['title'];
     }) => void): Promise<TTaskResult>;
+    /**
+     * Optional callback to provide custom tldr information
+     * @param createdAt When the task was created
+     * @param status Current task status
+     * @param currentValue Current partial result
+     * @param errors Current errors
+     * @param warnings Current warnings
+     * @returns Custom tldr information
+     */
+    tldrProvider?(createdAt: Date, status: task_status, currentValue: PartialDeep<TTaskResult>, errors: Array<Error>, warnings: Array<Error>): {
+        readonly percent: number_percent;
+        readonly message: string;
+    };
 };
 /**
  * Helper to create a new task
@@ -80,6 +94,19 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
      * Status of the task
      */
     readonly status: task_status;
+    /**
+     * Short summary of the task status for quick overview in the UI
+     */
+    readonly tldr: {
+        /**
+         * Progress in percentage from 0 to 1 (100%) that can be used to display a progress bar
+         */
+        readonly percent: number_percent;
+        /**
+         * Short summary message of the task status that can be displayed in the UI
+         */
+        readonly message: string;
+    };
     /**
      * Date when the task was created
      */

package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts

@@ -1,10 +1,11 @@
-import type { ReadonlyDeep, WritableDeep } from 'type-fest';
+import type { PartialDeep, Promisable, ReadonlyDeep, WritableDeep } from 'type-fest';
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
 import type { Parameters } from '../../types/typeAliases';
 import type { string_parameter_name } from '../../types/typeAliases';
 import type { TODO_string } from '../../utils/organization/TODO_string';
 import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
+import type { PipelineExecutorResult } from '../PipelineExecutorResult';
 import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
 /**
  * Options for executing attempts of a pipeline task, including configuration for jokers, priority,
@@ -46,6 +47,10 @@ export type ExecuteAttemptsOptions = Required<Omit<CreatePipelineExecutorOptions
      * The pipeline structure prepared for execution, as a deeply immutable PipelineJson object.
      */
     readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
+    /**
+     * Callback invoked with partial results as the execution progresses.
+     */
+    onProgress(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
     /**
      * The execution report object, which is updated during execution.
      */

package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts

@@ -2,7 +2,6 @@ import Anthropic from '@anthropic-ai/sdk';
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { ChatPromptResult } from '../../execution/PromptResult';
-import type { CompletionPromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_markdown_text } from '../../types/typeAliases';
@@ -42,10 +41,6 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
      * Calls Anthropic Claude API to use a chat model.
      */
     callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<ChatPromptResult>;
-    /**
-     * Calls Anthropic Claude API to use a completion model.
-     */
-    callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<CompletionPromptResult>;
     /**
      * Get the model that should be used as default
      */

package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts

@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
 /**
  * List of available Anthropic Claude models with pricing
  *
- * Note: Done at 2025-05-06
+ * Note: Synced with official API docs at 2025-08-20
  *
  * @see https://docs.anthropic.com/en/docs/models-overview
  * @public exported from `@promptbook/anthropic-claude`

package/esm/typings/src/llm-providers/deepseek/deepseek-models.d.ts

@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
 /**
  * List of available Deepseek models with descriptions
  *
- * Note: Done at 2025-05-06
+ * Note: Synced with official API docs at 2025-08-20
  *
  * @see https://www.deepseek.com/models
  * @public exported from `@promptbook/deepseek`

package/esm/typings/src/llm-providers/google/google-models.d.ts

@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
 /**
  * List of available Google models with descriptions
  *
- * Note: Done at 2025-05-06
+ * Note: Synced with official API docs at 2025-08-20
  *
  * @see https://ai.google.dev/models/gemini
  * @public exported from `@promptbook/google`

package/esm/typings/src/llm-providers/ollama/ollama-models.d.ts

@@ -2,7 +2,7 @@ import type { AvailableModel } from '../../execution/AvailableModel';
 /**
  * List of available models in Ollama library
  *
- * Note: Done at 2025-05-19
+ * Note: Synced with official API docs at 2025-08-20
  *
  * @see https://ollama.com/library
  * @public exported from `@promptbook/ollama`

package/esm/typings/src/llm-providers/openai/openai-models.d.ts

@@ -2,7 +2,7 @@ import type { AvailableModel } from '../../execution/AvailableModel';
 /**
  * List of available OpenAI models with pricing
  *
- * Note: Done at 2025-05-06
+ * Note: Synced with official API docs at 2025-08-20
  *
  * @see https://platform.openai.com/docs/models/
  * @see https://openai.com/api/pricing/

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/ModelRequirements.d.ts

@@ -87,8 +87,6 @@ export type CommonModelRequirements = {
     readonly seed?: number_seed;
     /**
      * Maximum number of tokens that can be generated by the model
-     *
-     * Note: [🌾]
      */
     readonly maxTokens?: number;
 };

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.100.0-4",
+    "version": "0.100.0-41",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -102,7 +102,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.100.0-4"
+        "@promptbook/core": "0.100.0-41"
     },
     "dependencies": {
         "bottleneck": "^2.19.5",