@promptbook/javascript 0.100.0 → 0.100.2

package/esm/index.es.js

@@ -19,7 +19,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.100.0';
+const PROMPTBOOK_ENGINE_VERSION = '0.100.2';
 /**
  * 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/agent-source/parseAgentSource.d.ts

@@ -1,7 +1,7 @@
 import type { string_agent_name } from '../../types/typeAliases';
 import type { string_url_image } from '../../types/typeAliases';
 import type { string_book } from './string_book';
-export interface AgentBasicInformation {
+export type AgentBasicInformation = {
     /**
      * Name of the agent
      * This is the first line of the agent source
@@ -17,7 +17,7 @@ export interface AgentBasicInformation {
      * This is the line starting with "META IMAGE"
      */
     profileImageUrl: string_url_image;
-}
+};
 /**
  * Parses basic information from agent source
  *

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

@@ -6,7 +6,7 @@ import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
  * - Creating regex patterns for parsing
  * - Applying its effects to agent model requirements
  */
-export interface CommitmentDefinition {
+export type CommitmentDefinition = {
     /**
      * The type/name of this commitment (e.g., 'PERSONA', 'KNOWLEDGE', etc.)
      */
@@ -45,4 +45,4 @@ export interface CommitmentDefinition {
      * @returns Updated agent model requirements
      */
     applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
-}
+};

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

@@ -4,7 +4,7 @@ import type { TODO_any } from '../../../utils/organization/TODO_any';
  *
  * This is like "compiled" version of agent source
  */
-export interface AgentModelRequirements {
+export type AgentModelRequirements = {
     /**
      * The system message that defines the agent's behavior and personality
      */
@@ -34,4 +34,4 @@ export interface AgentModelRequirements {
      * Each commitment can store its own data here
      */
     readonly metadata?: Record<string, TODO_any>;
-}
+};

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

@@ -2,7 +2,7 @@ import type { ParsedCommitment } from './ParsedCommitment';
 /**
  * Result of parsing agent source for commitments
  */
-export interface AgentSourceParseResult {
+export type AgentSourceParseResult = {
     /**
      * The agent name (first line)
      */
@@ -15,4 +15,4 @@ export interface AgentSourceParseResult {
      * Lines that are not commitments (for system message)
      */
     nonCommitmentLines: string[];
-}
+};

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

@@ -2,7 +2,7 @@ import type { BookCommitment } from '../_base/BookCommitment';
 /**
  * Parsed commitment line from agent source
  */
-export interface ParsedCommitment {
+export type ParsedCommitment = {
     /**
      * The commitment type (e.g., 'PERSONA', 'KNOWLEDGE')
      */
@@ -19,4 +19,4 @@ export interface ParsedCommitment {
      * Line number in the agent source (1-based)
      */
     lineNumber: number;
-}
+};

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

@@ -24,3 +24,6 @@ export type AvatarProfileProps = {
  * @public exported from `@promptbook/components`
  */
 export declare function AvatarProfile(props: AvatarProfileProps): import("react/jsx-runtime").JSX.Element;
+/**
+ * TODO: [🕛] Unite `AvatarProfileProps`, `ChatParticipant`, `LlmExecutionTools` +  `LlmToolsMetadata`
+ */

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

@@ -1,3 +1,4 @@
+import type { CSSProperties } from 'react';
 import type { string_book } from '../../book-2.0/agent-source/string_book';
 /**
  * Props of `BookEditor`
@@ -9,6 +10,10 @@ export type BookEditorProps = {
      * Additional CSS classes to apply to the editor container.
      */
     readonly className?: string;
+    /**
+     * Optional CSS style which will be added to root <div/> element
+     */
+    readonly style?: CSSProperties;
     /**
      * CSS className for a font (e.g. from next/font) to style the editor text.
      * If omitted, defaults to system serif fonts.

package/esm/typings/src/book-components/Chat/types/ChatParticipant.d.ts

@@ -1,7 +1,4 @@
-import type { string_color } from '../../../types/typeAliases';
-import type { string_name } from '../../../types/typeAliases';
-import type { string_person_fullname } from '../../../types/typeAliases';
-import type { string_url_image } from '../../../types/typeAliases';
+import type { string_color, string_name, string_person_fullname, string_url_image } from '../../../types/typeAliases';
 import { Color } from '../../../utils/color/Color';
 /**
  * A participant in the chat
@@ -30,3 +27,6 @@ export type ChatParticipant = {
      */
     color: string_color | Color;
 };
+/**
+ * TODO: [🕛] Unite `AvatarProfileProps`, `ChatParticipant`, `LlmExecutionTools` +  `LlmToolsMetadata`
+ */

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

@@ -1,13 +1,9 @@
 import type { Promisable } from 'type-fest';
 import type { ChatParticipant } from '../book-components/Chat/types/ChatParticipant';
 import type { Prompt } from '../types/Prompt';
-import type { string_markdown } from '../types/typeAliases';
-import type { string_markdown_text } from '../types/typeAliases';
-import type { string_title } from '../types/typeAliases';
+import type { string_markdown, string_markdown_text, string_title } from '../types/typeAliases';
 import type { AvailableModel } from './AvailableModel';
-import type { ChatPromptResult } from './PromptResult';
-import type { CompletionPromptResult } from './PromptResult';
-import type { EmbeddingPromptResult } from './PromptResult';
+import type { ChatPromptResult, CompletionPromptResult, EmbeddingPromptResult } from './PromptResult';
 /**
  * Container for all the tools needed to execute prompts to large language models like GPT-4
  * On its interface it exposes common methods for prompt execution.
@@ -60,6 +56,7 @@ export type LlmExecutionTools = {
     callEmbeddingModel?(prompt: Prompt): Promise<EmbeddingPromptResult>;
 };
 /**
+ * TODO: [🕛] Extend this from sth class
  * TODO: [🍚] Implement destroyable pattern to free resources
  * TODO: [🏳] Add `callTranslationModel`
  * TODO: [🧠] Emulation of one type of model with another one - emuate chat with completion; emulate translation with chat

package/esm/typings/src/execution/utils/validatePromptResult.d.ts

@@ -5,7 +5,7 @@ import type { string_postprocessing_function_name } from '../../types/typeAliase
 /**
  * Options for validating a prompt result
  */
-export interface ValidatePromptResultOptions {
+export type ValidatePromptResultOptions = {
     /**
      * The result string to validate
      */
@@ -23,11 +23,11 @@ export interface ValidatePromptResultOptions {
      * Note: This is for validation purposes only - postprocessing should be done before calling this function
      */
     postprocessingFunctionNames?: ReadonlyArray<string_postprocessing_function_name>;
-}
+};
 /**
  * Result of prompt result validation
  */
-export interface ValidatePromptResultResult {
+export type ValidatePromptResultResult = {
     /**
      * Whether the result is valid (passes all expectations and format checks)
      */
@@ -40,7 +40,7 @@ export interface ValidatePromptResultResult {
      * Error that occurred during validation, if any
      */
     error?: ExpectError;
-}
+};
 /**
  * Validates a prompt result against expectations and format requirements.
  * This function provides a common abstraction for result validation that can be used

package/esm/typings/src/llm-providers/_common/profiles/llmProviderProfiles.d.ts

@@ -76,6 +76,6 @@ export declare function getLlmProviderProfile(providerKey: keyof typeof LLM_PROV
 export declare function createCustomLlmProfile(baseProfile: ChatParticipant, overrides: Partial<ChatParticipant>): ChatParticipant;
 /**
  * TODO: Refactor this - each profile must be alongside the provider definition
- * TODO: Unite `AvatarProfileProps` and `ChatParticipant`
+ * TODO: [🕛] Unite `AvatarProfileProps`, `ChatParticipant`, `LlmExecutionTools` +  `LlmToolsMetadata`
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */

package/esm/typings/src/llm-providers/_common/register/LlmToolsMetadata.d.ts

@@ -1,7 +1,5 @@
-import { MODEL_ORDERS } from '../../../constants';
-import { MODEL_TRUST_LEVELS } from '../../../constants';
-import type { string_name } from '../../../types/typeAliases';
-import type { string_title } from '../../../types/typeAliases';
+import { MODEL_ORDERS, MODEL_TRUST_LEVELS } from '../../../constants';
+import type { string_name, string_title } from '../../../types/typeAliases';
 import type { Registered } from '../../../utils/$Register';
 import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
@@ -52,6 +50,7 @@ export type LlmToolsMetadata = Registered & {
     createConfigurationFromEnv(env: Record<string_name, string>): LlmToolsConfiguration[number] | null;
 };
 /**
+ * TODO: [🕛] Extend this
  * TODO: Add configuration schema and maybe some documentation link
  * TODO: Maybe constrain LlmToolsConfiguration[number] by generic to ensure that `createConfigurationFromEnv` and `getBoilerplateConfiguration` always create same `packageName` and `className`
  * TODO: [®] DRY Register logic

package/esm/typings/src/utils/color/Color.d.ts

@@ -1,5 +1,4 @@
-import type { string_color } from '../../types/typeAliases';
-import type { string_url_image } from '../../types/typeAliases';
+import type { string_color, string_url_image } from '../../types/typeAliases';
 import type { WithTake } from '../take/interfaces/ITakeChain';
 import { CSS_COLORS } from './css-colors';
 /**

package/esm/typings/src/utils/take/interfaces/ITakeChain.d.ts

@@ -6,7 +6,7 @@ import type { Takeable } from './Takeable';
  * @deprecated [🤡] Use some better functional library instead of `TakeChain`
  */
 export type WithTake<TValue extends Takeable> = TValue & ITakeChain<TValue>;
-export interface ITakeChain<TValue extends Takeable> {
+export type ITakeChain<TValue extends Takeable> = {
     readonly value: TValue;
     then<TResultValue extends Takeable>(callback: (value: TValue) => TResultValue): WithTake<TResultValue>;
-}
+};

package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts

@@ -1,7 +1,7 @@
 import type { string_filename } from '../../../types/typeAliases';
 import type { really_unknown } from '../../organization/really_unknown';
 /**
- * Tests if given string is valid URL.
+ * Tests if given string is valid file path.
  *
  * Note: This does not check if the file exists only if the path is valid
  * @public exported from `@promptbook/utils`

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

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

@@ -9,12 +9,12 @@ import type { string_pipeline_url } from '../types/typeAliases';
 /**
  * Options for wizard methods
  */
-interface WizardOptions {
+type WizardOptions = {
     /**
      * Whether to enable verbose logging
      */
     isVerbose?: boolean;
-}
+};
 /**
  * Wizard for simple usage of the Promptbook
  * Look at `wizard` for more details

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/javascript",
-    "version": "0.100.0",
+    "version": "0.100.2",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -94,7 +94,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/javascript.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.100.0"
+        "@promptbook/core": "0.100.2"
     },
     "dependencies": {
         "crypto": "1.0.1",

package/umd/index.umd.js

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