@promptbook/editable 0.101.0-5 → 0.101.0-7

package/esm/index.es.js

@@ -17,7 +17,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.101.0-5';
+const PROMPTBOOK_ENGINE_VERSION = '0.101.0-7';
 /**
  * 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/components.index.d.ts

@@ -7,6 +7,9 @@ import type { AvatarProfileProps } from '../book-components/AvatarProfile/Avatar
 import { AvatarProfile } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfile';
 import type { AvatarProfileFromSourceProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
 import { AvatarProfileFromSource } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
+import type { MockedChatDelayConfig } from '../book-components/AvatarProfile/AvatarProfile/MockedChat';
+import type { MockedChatProps } from '../book-components/AvatarProfile/AvatarProfile/MockedChat';
+import { MockedChat } from '../book-components/AvatarProfile/AvatarProfile/MockedChat';
 import type { BookEditorProps } from '../book-components/BookEditor/BookEditor';
 import { BookEditor } from '../book-components/BookEditor/BookEditor';
 import { DEFAULT_BOOK_FONT_CLASS } from '../book-components/BookEditor/config';
@@ -31,6 +34,9 @@ export type { AvatarProfileProps };
 export { AvatarProfile };
 export type { AvatarProfileFromSourceProps };
 export { AvatarProfileFromSource };
+export type { MockedChatDelayConfig };
+export type { MockedChatProps };
+export { MockedChat };
 export type { BookEditorProps };
 export { BookEditor };
 export { DEFAULT_BOOK_FONT_CLASS };

package/esm/typings/src/_packages/types.index.d.ts

@@ -8,6 +8,8 @@ import type { AvatarChipProps } from '../book-components/AvatarProfile/AvatarChi
 import type { AvatarChipFromSourceProps } from '../book-components/AvatarProfile/AvatarChip/AvatarChipFromSource';
 import type { AvatarProfileProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfile';
 import type { AvatarProfileFromSourceProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
+import type { MockedChatDelayConfig } from '../book-components/AvatarProfile/AvatarProfile/MockedChat';
+import type { MockedChatProps } from '../book-components/AvatarProfile/AvatarProfile/MockedChat';
 import type { BookEditorProps } from '../book-components/BookEditor/BookEditor';
 import type { ChatProps } from '../book-components/Chat/Chat/ChatProps';
 import type { LlmChatProps } from '../book-components/Chat/LlmChat/LlmChatProps';
@@ -330,6 +332,8 @@ export type { AvatarChipProps };
 export type { AvatarChipFromSourceProps };
 export type { AvatarProfileProps };
 export type { AvatarProfileFromSourceProps };
+export type { MockedChatDelayConfig };
+export type { MockedChatProps };
 export type { BookEditorProps };
 export type { ChatProps };
 export type { LlmChatProps };

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

@@ -0,0 +1,59 @@
+import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * DELETE commitment definition
+ *
+ * The DELETE commitment (and its aliases CANCEL, DISCARD, REMOVE) is used to
+ * remove or disregard certain information or context. This can be useful for
+ * overriding previous commitments or removing unwanted behaviors.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * DELETE Previous formatting requirements
+ * CANCEL All emotional responses
+ * DISCARD Technical jargon explanations
+ * REMOVE Casual conversational style
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class DeleteCommitmentDefinition extends BaseCommitmentDefinition<'DELETE' | 'CANCEL' | 'DISCARD' | 'REMOVE'> {
+    constructor(type: 'DELETE' | 'CANCEL' | 'DISCARD' | 'REMOVE');
+    /**
+     * Short one-line description of DELETE/CANCEL/DISCARD/REMOVE.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for DELETE commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Singleton instances of the DELETE commitment definitions with aliases
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const DeleteCommitment: DeleteCommitmentDefinition;
+/**
+ * Singleton instances of the DELETE commitment definitions with aliases
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const CancelCommitment: DeleteCommitmentDefinition;
+/**
+ * Singleton instances of the DELETE commitment definitions with aliases
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const DiscardCommitment: DeleteCommitmentDefinition;
+/**
+ * Singleton instances of the DELETE commitment definitions with aliases
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const RemoveCommitment: DeleteCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,39 @@
+import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * GOAL commitment definition
+ *
+ * The GOAL commitment defines the main goal which should be achieved by the AI assistant.
+ * There can be multiple goals. Later goals are more important than earlier goals.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * GOAL Help users understand complex technical concepts
+ * GOAL Provide accurate and up-to-date information
+ * GOAL Always prioritize user safety and ethical guidelines
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class GoalCommitmentDefinition extends BaseCommitmentDefinition<'GOAL'> {
+    constructor();
+    /**
+     * Short one-line description of GOAL.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for GOAL commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Singleton instance of the GOAL commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const GoalCommitment: GoalCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,40 @@
+import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * MEMORY commitment definition
+ *
+ * The MEMORY commitment is similar to KNOWLEDGE but has a focus on remembering past
+ * interactions and user preferences. It helps the agent maintain context about the
+ * user's history, preferences, and previous conversations.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * MEMORY User prefers detailed technical explanations
+ * MEMORY Previously worked on React projects
+ * MEMORY Timezone: UTC-5 (Eastern Time)
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class MemoryCommitmentDefinition extends BaseCommitmentDefinition<'MEMORY'> {
+    constructor();
+    /**
+     * Short one-line description of MEMORY.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for MEMORY commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Singleton instance of the MEMORY commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const MemoryCommitment: MemoryCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,41 @@
+import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * MESSAGE commitment definition
+ *
+ * The MESSAGE commitment contains 1:1 text of the message which AI assistant already
+ * sent during the conversation. Later messages are later in the conversation.
+ * It is similar to EXAMPLE but it is not example, it is the real message which
+ * AI assistant already sent.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * MESSAGE Hello! How can I help you today?
+ * MESSAGE I understand you're looking for information about our services.
+ * MESSAGE Based on your requirements, I'd recommend our premium package.
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class MessageCommitmentDefinition extends BaseCommitmentDefinition<'MESSAGE'> {
+    constructor();
+    /**
+     * Short one-line description of MESSAGE.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for MESSAGE commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Singleton instance of the MESSAGE commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const MessageCommitment: MessageCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,62 @@
+import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * META commitment definition
+ *
+ * The META commitment handles all meta-information about the agent such as:
+ * - META IMAGE: Sets the agent's avatar/profile image URL
+ * - META LINK: Provides profile/source links for the person the agent models
+ * - META TITLE: Sets the agent's display title
+ * - META DESCRIPTION: Sets the agent's description
+ * - META [ANYTHING]: Any other meta information in uppercase format
+ *
+ * These commitments are special because they don't affect the system message,
+ * but are handled separately in the parsing logic for profile display.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * META IMAGE https://example.com/avatar.jpg
+ * META LINK https://twitter.com/username
+ * META TITLE Professional Assistant
+ * META DESCRIPTION An AI assistant specialized in business tasks
+ * META AUTHOR John Doe
+ * META VERSION 1.0
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class MetaCommitmentDefinition extends BaseCommitmentDefinition<`META${string}`> {
+    constructor();
+    /**
+     * Short one-line description of META commitments.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for META commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+    /**
+     * Extracts meta information from the content based on the meta type
+     * This is used by the parsing logic
+     */
+    extractMetaValue(metaType: string, content: string): string | null;
+    /**
+     * Validates if the provided content is a valid URL (for IMAGE and LINK types)
+     */
+    isValidUrl(content: string): boolean;
+    /**
+     * Checks if this is a known meta type
+     */
+    isKnownMetaType(metaType: string): boolean;
+}
+/**
+ * Singleton instance of the META commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const MetaCommitment: MetaCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,40 @@
+import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * SCENARIO commitment definition
+ *
+ * The SCENARIO commitment defines a specific situation or context in which the AI
+ * assistant should operate. It helps to set the scene for the AI's responses.
+ * Later scenarios are more important than earlier scenarios.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * SCENARIO You are in a customer service call center during peak hours
+ * SCENARIO The customer is frustrated and has been on hold for 20 minutes
+ * SCENARIO This is the customer's third call about the same issue
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class ScenarioCommitmentDefinition extends BaseCommitmentDefinition<'SCENARIO'> {
+    constructor();
+    /**
+     * Short one-line description of SCENARIO.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for SCENARIO commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Singleton instance of the SCENARIO commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const ScenarioCommitment: ScenarioCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -1,15 +1,19 @@
 import type { BookCommitment } from './_base/BookCommitment';
 import type { CommitmentDefinition } from './_base/CommitmentDefinition';
 import { ActionCommitmentDefinition } from './ACTION/ACTION';
+import { DeleteCommitmentDefinition } from './DELETE/DELETE';
 import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
+import { GoalCommitmentDefinition } from './GOAL/GOAL';
 import { KnowledgeCommitmentDefinition } from './KNOWLEDGE/KNOWLEDGE';
-import { MetaImageCommitmentDefinition } from './META_IMAGE/META_IMAGE';
-import { MetaLinkCommitmentDefinition } from './META_LINK/META_LINK';
+import { MemoryCommitmentDefinition } from './MEMORY/MEMORY';
+import { MessageCommitmentDefinition } from './MESSAGE/MESSAGE';
+import { MetaCommitmentDefinition } from './META/META';
 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 { ScenarioCommitmentDefinition } from './SCENARIO/SCENARIO';
 import { StyleCommitmentDefinition } from './STYLE/STYLE';
 import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplementedCommitmentDefinition';
 /**
@@ -19,7 +23,7 @@ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplemented
  *
  * @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">];
+export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"SCENARIOS">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"GOALS">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
 /**
  * Gets a commitment definition by its type
  * @param type The commitment type to look up

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

@@ -0,0 +1,46 @@
+import type { ChatProps } from '../../Chat/Chat/ChatProps';
+/**
+ * Delay configuration for the MockedChat component
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type MockedChatDelayConfig = {
+    /**
+     * Delay before showing the first message (in milliseconds)
+     * @default 1000
+     */
+    beforeFirstMessage?: number;
+    /**
+     * Emulated thinking time between messages (in milliseconds)
+     * @default 2000
+     */
+    thinkingBetweenMessages?: number;
+    /**
+     * Wait time after each written word (in milliseconds)
+     * @default 100
+     */
+    waitAfterWord?: number;
+    /**
+     * Extra delay on top of the word waiting (in milliseconds)
+     * @default 50
+     */
+    extraWordDelay?: number;
+};
+/**
+ * Props for MockedChat component
+ *
+ * @public exported from `@promptbook/components`
+ */
+export type MockedChatProps = ChatProps & {
+    /**
+     * Optional delays configuration for emulating typing behavior
+     */
+    delayConfig?: MockedChatDelayConfig;
+};
+/**
+ * MockedChat component that shows the same chat as Chat but emulates ongoing discussion
+ * with realistic typing delays and thinking pauses.
+ *
+ * @public exported from `@promptbook/components`
+ */
+export declare function MockedChat(props: MockedChatProps): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,3 @@
+export * from './AvatarProfile';
+export * from './AvatarProfileFromSource';
+export * from './MockedChat';

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

@@ -1,5 +1,7 @@
 import type { CSSProperties } from 'react';
+import type { Promisable } from 'type-fest';
 import type { string_book } from '../../book-2.0/agent-source/string_book';
+import { string_knowledge_source_content } from '../../types/typeAliases';
 /**
  * Props of `BookEditor`
  *
@@ -30,7 +32,7 @@ export type BookEditorProps = {
     /**
      * returns the URL of the uploaded file on CDN or storage
      */
-    onFileUpload?(file: File): Promise<string>;
+    onFileUpload?(file: File): Promisable<string_knowledge_source_content>;
     /**
      * If true, logs verbose debug info to the console and shows additional visual cues
      */

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

@@ -1,3 +1,4 @@
+import { Promisable } from 'type-fest';
 import type { string_book } from '../../book-2.0/agent-source/string_book';
 /**
  * @private util of `<BookEditor />`
@@ -7,7 +8,7 @@ export type BookEditorInnerProps = {
     fontClassName?: string;
     value?: string_book;
     onChange?(value: string_book): void;
-    onFileUpload?(file: File): Promise<string>;
+    onFileUpload?(file: File): Promisable<string>;
     isVerbose?: boolean;
     isBorderRadiusDisabled?: boolean;
 };

package/esm/typings/src/utils/markdown/humanizeAiText.d.ts

@@ -9,5 +9,6 @@ import { string_markdown } from '../../types/typeAliases';
  */
 export declare function humanizeAiText(aiText: string_markdown): string_markdown;
 /**
+ * TODO: [🧠] Maybe this should be exported from `@promptbook/utils` not `@promptbook/markdown-utils`
  * TODO: [🅾️] !!! Use this across the project where AI text is involved
  */

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/editable",
-    "version": "0.101.0-5",
+    "version": "0.101.0-7",
     "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/editable.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.101.0-5"
+        "@promptbook/core": "0.101.0-7"
     },
     "dependencies": {
         "crypto-js": "4.2.0",

package/umd/index.umd.js

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