@promptbook/vercel 0.100.0-5 → 0.100.0-61
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -8
- package/esm/index.es.js +8 -1
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/_packages/color.index.d.ts +50 -0
- package/esm/typings/src/_packages/components.index.d.ts +36 -0
- package/esm/typings/src/_packages/core.index.d.ts +30 -0
- package/esm/typings/src/_packages/types.index.d.ts +38 -0
- package/esm/typings/src/book-2.0/agent-source/parseAgentSource.d.ts +30 -0
- package/esm/typings/src/book-2.0/agent-source/parseAgentSource.test.d.ts +1 -0
- package/esm/typings/src/book-2.0/agent-source/string_book.d.ts +26 -0
- package/esm/typings/src/book-2.0/commitments/ACTION/ACTION.d.ts +38 -0
- package/esm/typings/src/book-2.0/commitments/FORMAT/FORMAT.d.ts +39 -0
- package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/KNOWLEDGE.d.ts +45 -0
- package/esm/typings/src/book-2.0/commitments/META_IMAGE/META_IMAGE.d.ts +44 -0
- package/esm/typings/src/book-2.0/commitments/META_LINK/META_LINK.d.ts +56 -0
- package/esm/typings/src/book-2.0/commitments/MODEL/MODEL.d.ts +39 -0
- package/esm/typings/src/book-2.0/commitments/NOTE/NOTE.d.ts +49 -0
- package/esm/typings/src/book-2.0/commitments/PERSONA/PERSONA.d.ts +46 -0
- package/esm/typings/src/book-2.0/commitments/RULE/RULE.d.ts +44 -0
- package/esm/typings/src/book-2.0/commitments/SAMPLE/SAMPLE.d.ts +44 -0
- package/esm/typings/src/book-2.0/commitments/STYLE/STYLE.d.ts +38 -0
- package/esm/typings/src/book-2.0/commitments/_base/BaseCommitmentDefinition.d.ts +52 -0
- package/esm/typings/src/book-2.0/commitments/_base/BookCommitment.d.ts +5 -0
- package/esm/typings/src/book-2.0/commitments/_base/CommitmentDefinition.d.ts +48 -0
- package/esm/typings/src/book-2.0/commitments/_base/NotYetImplementedCommitmentDefinition.d.ts +22 -0
- package/esm/typings/src/book-2.0/commitments/_base/createEmptyAgentModelRequirements.d.ts +19 -0
- package/esm/typings/src/book-2.0/commitments/_misc/AgentModelRequirements.d.ts +37 -0
- package/esm/typings/src/book-2.0/commitments/_misc/AgentSourceParseResult.d.ts +18 -0
- package/esm/typings/src/book-2.0/commitments/_misc/ParsedCommitment.d.ts +22 -0
- package/esm/typings/src/book-2.0/commitments/_misc/createAgentModelRequirements.d.ts +62 -0
- package/esm/typings/src/book-2.0/commitments/_misc/createAgentModelRequirementsWithCommitments.d.ts +36 -0
- package/esm/typings/src/book-2.0/commitments/_misc/createCommitmentRegex.d.ts +20 -0
- package/esm/typings/src/book-2.0/commitments/_misc/parseAgentSourceWithCommitments.d.ts +24 -0
- package/esm/typings/src/book-2.0/commitments/_misc/removeCommentsFromSystemMessage.d.ts +11 -0
- package/esm/typings/src/book-2.0/commitments/index.d.ts +56 -0
- package/esm/typings/src/book-2.0/utils/profileImageUtils.d.ts +39 -0
- package/esm/typings/src/book-components/AvatarProfile/AvatarChip/AvatarChip.d.ts +35 -0
- package/esm/typings/src/book-components/AvatarProfile/AvatarChip/AvatarChipFromSource.d.ts +21 -0
- package/esm/typings/src/book-components/AvatarProfile/AvatarChip/index.d.ts +2 -0
- package/esm/typings/src/book-components/AvatarProfile/AvatarProfile/AvatarProfile.d.ts +26 -0
- package/esm/typings/src/book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource.d.ts +19 -0
- package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts +35 -0
- package/esm/typings/src/book-components/BookEditor/BookEditorInner.d.ts +15 -0
- package/esm/typings/src/book-components/BookEditor/config.d.ts +10 -0
- package/esm/typings/src/book-components/BookEditor/injectCssModuleIntoShadowRoot.d.ts +11 -0
- package/esm/typings/src/book-components/Chat/Chat/Chat.d.ts +20 -0
- package/esm/typings/src/book-components/Chat/Chat/ChatProps.d.ts +110 -0
- package/esm/typings/src/book-components/Chat/LlmChat/LlmChat.d.ts +14 -0
- package/esm/typings/src/book-components/Chat/LlmChat/LlmChat.test.d.ts +1 -0
- package/esm/typings/src/book-components/Chat/LlmChat/LlmChatProps.d.ts +24 -0
- package/esm/typings/src/book-components/Chat/types/ChatMessage.d.ts +16 -0
- package/esm/typings/src/book-components/Chat/types/ChatParticipant.d.ts +32 -0
- package/esm/typings/src/book-components/Chat/utils/ChatPersistence.d.ts +25 -0
- package/esm/typings/src/book-components/Chat/utils/ExportFormat.d.ts +4 -0
- package/esm/typings/src/book-components/Chat/utils/addUtmParamsToUrl.d.ts +7 -0
- package/esm/typings/src/book-components/Chat/utils/createShortLinkForChat.d.ts +7 -0
- package/esm/typings/src/book-components/Chat/utils/downloadFile.d.ts +6 -0
- package/esm/typings/src/book-components/Chat/utils/exportChatHistory.d.ts +9 -0
- package/esm/typings/src/book-components/Chat/utils/generatePdfContent.d.ts +8 -0
- package/esm/typings/src/book-components/Chat/utils/generateQrDataUrl.d.ts +7 -0
- package/esm/typings/src/book-components/Chat/utils/getPromptbookBranding.d.ts +6 -0
- package/esm/typings/src/book-components/Chat/utils/messagesToHtml.d.ts +8 -0
- package/esm/typings/src/book-components/Chat/utils/messagesToJson.d.ts +7 -0
- package/esm/typings/src/book-components/Chat/utils/messagesToMarkdown.d.ts +8 -0
- package/esm/typings/src/book-components/Chat/utils/messagesToText.d.ts +8 -0
- package/esm/typings/src/book-components/_common/react-utils/classNames.d.ts +7 -0
- package/esm/typings/src/book-components/_common/react-utils/collectCssTextsForClass.d.ts +7 -0
- package/esm/typings/src/book-components/_common/react-utils/escapeHtml.d.ts +6 -0
- package/esm/typings/src/book-components/_common/react-utils/escapeRegex.d.ts +6 -0
- package/esm/typings/src/config.d.ts +19 -0
- package/esm/typings/src/execution/AvailableModel.d.ts +4 -0
- package/esm/typings/src/execution/ExecutionTask.d.ts +27 -1
- package/esm/typings/src/execution/LlmExecutionTools.d.ts +8 -0
- package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +6 -1
- package/esm/typings/src/llm-providers/_common/filterModels.d.ts +0 -3
- package/esm/typings/src/llm-providers/_common/profiles/llmProviderProfiles.d.ts +81 -0
- package/esm/typings/src/llm-providers/_common/profiles/test/llmProviderProfiles.test.d.ts +1 -0
- package/esm/typings/src/llm-providers/_multiple/MultipleLlmExecutionTools.d.ts +5 -0
- package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +5 -5
- package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
- package/esm/typings/src/llm-providers/deepseek/deepseek-models.d.ts +1 -1
- package/esm/typings/src/llm-providers/google/google-models.d.ts +1 -1
- package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +5 -0
- package/esm/typings/src/llm-providers/ollama/ollama-models.d.ts +1 -1
- package/esm/typings/src/llm-providers/openai/OpenAiCompatibleExecutionTools.d.ts +8 -0
- package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +5 -0
- package/esm/typings/src/llm-providers/openai/openai-models.d.ts +1 -1
- package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +5 -0
- package/esm/typings/src/pipeline/book-notation.d.ts +2 -1
- package/esm/typings/src/playground/permanent/error-handling-playground.d.ts +5 -0
- package/esm/typings/src/types/ModelRequirements.d.ts +0 -2
- package/esm/typings/src/types/typeAliases.d.ts +6 -0
- package/esm/typings/src/utils/color/$randomColor.d.ts +11 -0
- package/esm/typings/src/utils/color/Color.d.ts +180 -0
- package/esm/typings/src/utils/color/css-colors.d.ts +159 -0
- package/esm/typings/src/utils/color/internal-utils/checkChannelValue.d.ts +14 -0
- package/esm/typings/src/utils/color/internal-utils/hslToRgb.d.ts +17 -0
- package/esm/typings/src/utils/color/internal-utils/rgbToHsl.d.ts +17 -0
- package/esm/typings/src/utils/color/operators/ColorTransformer.d.ts +5 -0
- package/esm/typings/src/utils/color/operators/darken.d.ts +9 -0
- package/esm/typings/src/utils/color/operators/furthest.d.ts +16 -0
- package/esm/typings/src/utils/color/operators/grayscale.d.ts +9 -0
- package/esm/typings/src/utils/color/operators/lighten.d.ts +12 -0
- package/esm/typings/src/utils/color/operators/mixWithColor.d.ts +11 -0
- package/esm/typings/src/utils/color/operators/nearest.d.ts +10 -0
- package/esm/typings/src/utils/color/operators/negative.d.ts +7 -0
- package/esm/typings/src/utils/color/operators/negativeLightness.d.ts +7 -0
- package/esm/typings/src/utils/color/operators/withAlpha.d.ts +9 -0
- package/esm/typings/src/utils/color/utils/areColorsEqual.d.ts +14 -0
- package/esm/typings/src/utils/color/utils/colorDistance.d.ts +21 -0
- package/esm/typings/src/utils/color/utils/colorHue.d.ts +11 -0
- package/esm/typings/src/utils/color/utils/colorHueDistance.d.ts +11 -0
- package/esm/typings/src/utils/color/utils/colorHueDistance.test.d.ts +1 -0
- package/esm/typings/src/utils/color/utils/colorLuminance.d.ts +9 -0
- package/esm/typings/src/utils/color/utils/colorSatulightion.d.ts +7 -0
- package/esm/typings/src/utils/color/utils/colorSaturation.d.ts +9 -0
- package/esm/typings/src/utils/color/utils/colorToDataUrl.d.ts +10 -0
- package/esm/typings/src/utils/color/utils/mixColors.d.ts +11 -0
- package/esm/typings/src/utils/organization/preserve.d.ts +21 -0
- package/esm/typings/src/utils/take/classes/TakeChain.d.ts +11 -0
- package/esm/typings/src/utils/take/interfaces/ITakeChain.d.ts +12 -0
- package/esm/typings/src/utils/take/interfaces/Takeable.d.ts +7 -0
- package/esm/typings/src/utils/take/take.d.ts +12 -0
- package/esm/typings/src/utils/take/take.test.d.ts +1 -0
- package/esm/typings/src/version.d.ts +1 -1
- package/package.json +2 -2
- package/umd/index.umd.js +8 -1
- package/umd/index.umd.js.map +1 -1
- package/esm/typings/src/scripting/javascript/utils/preserve.d.ts +0 -14
package/esm/typings/src/book-2.0/commitments/_misc/createAgentModelRequirementsWithCommitments.d.ts
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import type { string_model_name } from '../../../types/typeAliases';
|
|
2
|
+
import type { string_book } from '../../agent-source/string_book';
|
|
3
|
+
import type { AgentModelRequirements } from './AgentModelRequirements';
|
|
4
|
+
/**
|
|
5
|
+
* Creates agent model requirements using the new commitment system
|
|
6
|
+
* This function uses a reduce-like pattern where each commitment applies its changes
|
|
7
|
+
* to build the final requirements starting from a basic empty model
|
|
8
|
+
*
|
|
9
|
+
* @private
|
|
10
|
+
*/
|
|
11
|
+
export declare function createAgentModelRequirementsWithCommitments(agentSource: string_book, modelName?: string_model_name): Promise<AgentModelRequirements>;
|
|
12
|
+
/**
|
|
13
|
+
* Cached version of createAgentModelRequirementsWithCommitments
|
|
14
|
+
* This maintains the same caching behavior as the original function
|
|
15
|
+
*
|
|
16
|
+
* @private
|
|
17
|
+
*/
|
|
18
|
+
export declare function createAgentModelRequirementsWithCommitmentsCached(agentSource: string_book, modelName?: string_model_name): Promise<AgentModelRequirements>;
|
|
19
|
+
/**
|
|
20
|
+
* Clears the cache for createAgentModelRequirementsWithCommitments
|
|
21
|
+
*
|
|
22
|
+
* @private
|
|
23
|
+
*/
|
|
24
|
+
export declare function clearAgentModelRequirementsWithCommitmentsCache(): void;
|
|
25
|
+
/**
|
|
26
|
+
* Removes cache entries for a specific agent source
|
|
27
|
+
*
|
|
28
|
+
* @private
|
|
29
|
+
*/
|
|
30
|
+
export declare function invalidateAgentModelRequirementsWithCommitmentsCache(agentSource: string_book): void;
|
|
31
|
+
/**
|
|
32
|
+
* Gets the current cache size
|
|
33
|
+
*
|
|
34
|
+
* @private
|
|
35
|
+
*/
|
|
36
|
+
export declare function getAgentModelRequirementsWithCommitmentsCacheSize(): number;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type { BookCommitment } from '../_base/BookCommitment';
|
|
2
|
+
/**
|
|
3
|
+
* Generates a regex pattern to match a specific commitment
|
|
4
|
+
*
|
|
5
|
+
* Note: It always creates new Regex object
|
|
6
|
+
* Note: Uses word boundaries to ensure only full words are matched (e.g., "PERSONA" matches but "PERSONALITY" does not)
|
|
7
|
+
*
|
|
8
|
+
* @private
|
|
9
|
+
*/
|
|
10
|
+
export declare function createCommitmentRegex(commitment: BookCommitment): RegExp;
|
|
11
|
+
/**
|
|
12
|
+
* Generates a regex pattern to match a specific commitment type
|
|
13
|
+
*
|
|
14
|
+
* Note: It just matches the type part of the commitment
|
|
15
|
+
* Note: It always creates new Regex object
|
|
16
|
+
* Note: Uses word boundaries to ensure only full words are matched (e.g., "PERSONA" matches but "PERSONALITY" does not)
|
|
17
|
+
*
|
|
18
|
+
* @private
|
|
19
|
+
*/
|
|
20
|
+
export declare function createCommitmentTypeRegex(commitment: BookCommitment): RegExp;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { AgentBasicInformation } from '../../agent-source/parseAgentSource';
|
|
2
|
+
import type { string_book } from '../../agent-source/string_book';
|
|
3
|
+
import type { AgentSourceParseResult } from './AgentSourceParseResult';
|
|
4
|
+
/**
|
|
5
|
+
* Parses agent source using the new commitment system with multiline support
|
|
6
|
+
* This function replaces the hardcoded commitment parsing in the original parseAgentSource
|
|
7
|
+
*
|
|
8
|
+
* @private
|
|
9
|
+
*/
|
|
10
|
+
export declare function parseAgentSourceWithCommitments(agentSource: string_book): AgentSourceParseResult;
|
|
11
|
+
/**
|
|
12
|
+
* Extracts basic information from agent source using the new commitment system
|
|
13
|
+
* This maintains compatibility with the original parseAgentSource interface
|
|
14
|
+
*
|
|
15
|
+
* @private
|
|
16
|
+
*/
|
|
17
|
+
export declare function parseAgentSourceBasicInfo(agentSource: string_book): AgentBasicInformation;
|
|
18
|
+
/**
|
|
19
|
+
* Extracts META LINK commitments from agent source
|
|
20
|
+
* Returns an array of all META LINK URLs found in the agent source
|
|
21
|
+
*
|
|
22
|
+
* @private
|
|
23
|
+
*/
|
|
24
|
+
export declare function extractMetaLinks(agentSource: string_book): string[];
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Removes comment lines (lines starting with #) from a system message
|
|
3
|
+
* This is used to clean up the final system message before sending it to the AI model
|
|
4
|
+
* while preserving the original content with comments in metadata
|
|
5
|
+
*
|
|
6
|
+
* @param systemMessage The system message that may contain comment lines
|
|
7
|
+
* @returns The system message with comment lines removed
|
|
8
|
+
*
|
|
9
|
+
* @private - TODO: [🧠] Maybe should be public?
|
|
10
|
+
*/
|
|
11
|
+
export declare function removeCommentsFromSystemMessage(systemMessage: string): string;
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import type { BookCommitment } from './_base/BookCommitment';
|
|
2
|
+
import type { CommitmentDefinition } from './_base/CommitmentDefinition';
|
|
3
|
+
import { ActionCommitmentDefinition } from './ACTION/ACTION';
|
|
4
|
+
import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
|
|
5
|
+
import { KnowledgeCommitmentDefinition } from './KNOWLEDGE/KNOWLEDGE';
|
|
6
|
+
import { MetaImageCommitmentDefinition } from './META_IMAGE/META_IMAGE';
|
|
7
|
+
import { MetaLinkCommitmentDefinition } from './META_LINK/META_LINK';
|
|
8
|
+
import { ModelCommitmentDefinition } from './MODEL/MODEL';
|
|
9
|
+
import { NoteCommitmentDefinition } from './NOTE/NOTE';
|
|
10
|
+
import { PersonaCommitmentDefinition } from './PERSONA/PERSONA';
|
|
11
|
+
import { RuleCommitmentDefinition } from './RULE/RULE';
|
|
12
|
+
import { SampleCommitmentDefinition } from './SAMPLE/SAMPLE';
|
|
13
|
+
import { StyleCommitmentDefinition } from './STYLE/STYLE';
|
|
14
|
+
import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplementedCommitmentDefinition';
|
|
15
|
+
/**
|
|
16
|
+
* Registry of all available commitment definitions
|
|
17
|
+
* This array contains instances of all commitment definitions
|
|
18
|
+
* This is the single source of truth for all commitments in the system
|
|
19
|
+
*
|
|
20
|
+
* @private Use functions to access commitments instead of this array directly
|
|
21
|
+
*/
|
|
22
|
+
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">];
|
|
23
|
+
/**
|
|
24
|
+
* Gets a commitment definition by its type
|
|
25
|
+
* @param type The commitment type to look up
|
|
26
|
+
* @returns The commitment definition or null if not found
|
|
27
|
+
*
|
|
28
|
+
* @public exported from `@promptbook/core`
|
|
29
|
+
*/
|
|
30
|
+
export declare function getCommitmentDefinition(type: BookCommitment): CommitmentDefinition | null;
|
|
31
|
+
/**
|
|
32
|
+
* Gets all available commitment definitions
|
|
33
|
+
* @returns Array of all commitment definitions
|
|
34
|
+
*
|
|
35
|
+
* @public exported from `@promptbook/core`
|
|
36
|
+
*/
|
|
37
|
+
export declare function getAllCommitmentDefinitions(): ReadonlyArray<CommitmentDefinition>;
|
|
38
|
+
/**
|
|
39
|
+
* Gets all available commitment types
|
|
40
|
+
* @returns Array of all commitment types
|
|
41
|
+
*
|
|
42
|
+
* @public exported from `@promptbook/core`
|
|
43
|
+
*/
|
|
44
|
+
export declare function getAllCommitmentTypes(): ReadonlyArray<BookCommitment>;
|
|
45
|
+
/**
|
|
46
|
+
* Checks if a commitment type is supported
|
|
47
|
+
* @param type The commitment type to check
|
|
48
|
+
* @returns True if the commitment type is supported
|
|
49
|
+
*
|
|
50
|
+
* @public exported from `@promptbook/core`
|
|
51
|
+
*/
|
|
52
|
+
export declare function isCommitmentSupported(type: BookCommitment): boolean;
|
|
53
|
+
/**
|
|
54
|
+
* TODO: [🧠] Maybe create through standardized $register
|
|
55
|
+
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
56
|
+
*/
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import type { string_url_image } from '../../types/typeAliases';
|
|
2
|
+
/**
|
|
3
|
+
* Extracts profile image URL from agent definition text and returns cleaned system message
|
|
4
|
+
* @param systemMessage The original system message that may contain META IMAGE line
|
|
5
|
+
* @returns Object with profileImageUrl (if found) and cleanedSystemMessage (without META IMAGE line)
|
|
6
|
+
*
|
|
7
|
+
* @private - TODO: [🧠] Maybe should be public?
|
|
8
|
+
*/
|
|
9
|
+
export declare function extractProfileImageFromSystemMessage(systemMessage: string): {
|
|
10
|
+
profileImageUrl?: string_url_image;
|
|
11
|
+
cleanedSystemMessage: string;
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* Extracts persona, examples, and profile image from agent definition text
|
|
15
|
+
* @param systemMessage The original system message that may contain PERSONA, EXAMPLE, and META IMAGE lines
|
|
16
|
+
* @returns Object with extracted information and cleaned system message
|
|
17
|
+
*
|
|
18
|
+
* @private - TODO: [🧠] Maybe should be public?
|
|
19
|
+
*/
|
|
20
|
+
export declare function extractAgentMetadata(systemMessage: string): {
|
|
21
|
+
persona?: {
|
|
22
|
+
name: string;
|
|
23
|
+
description?: string;
|
|
24
|
+
};
|
|
25
|
+
examples: string[];
|
|
26
|
+
profileImageUrl?: string_url_image;
|
|
27
|
+
cleanedSystemMessage: string;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Generates a gravatar URL based on agent name for fallback avatar
|
|
31
|
+
* @param name The agent name to generate avatar for
|
|
32
|
+
* @returns Gravatar URL
|
|
33
|
+
*
|
|
34
|
+
* @private - TODO: [🧠] Maybe should be public?
|
|
35
|
+
*/
|
|
36
|
+
export declare function generateGravatarUrl(name?: string | null): string;
|
|
37
|
+
/**
|
|
38
|
+
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
39
|
+
*/
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import type { AgentBasicInformation } from '../../../book-2.0/agent-source/parseAgentSource';
|
|
2
|
+
import type { string_css_class } from '../../../types/typeAliases';
|
|
3
|
+
/**
|
|
4
|
+
* Props of `AvatarChip`
|
|
5
|
+
*
|
|
6
|
+
* @public exported from `@promptbook/components`
|
|
7
|
+
*/
|
|
8
|
+
export type AvatarChipProps = {
|
|
9
|
+
/**
|
|
10
|
+
* Avatar to be shown
|
|
11
|
+
*/
|
|
12
|
+
readonly avatarBasicInformation: AgentBasicInformation;
|
|
13
|
+
/**
|
|
14
|
+
* Whether this chip is a template avatar
|
|
15
|
+
*/
|
|
16
|
+
readonly isTemplate: boolean;
|
|
17
|
+
/**
|
|
18
|
+
* Optional CSS class name which will be added to root <div> element
|
|
19
|
+
*/
|
|
20
|
+
readonly className?: string_css_class;
|
|
21
|
+
/**
|
|
22
|
+
* Called when chip is clicked
|
|
23
|
+
*/
|
|
24
|
+
readonly onSelect?: (avatar: AgentBasicInformation) => void;
|
|
25
|
+
/**
|
|
26
|
+
* Whether this chip is selected
|
|
27
|
+
*/
|
|
28
|
+
readonly isSelected?: boolean;
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* Shows a chip with avatar's avatar and name
|
|
32
|
+
*
|
|
33
|
+
* @public exported from `@promptbook/components`
|
|
34
|
+
*/
|
|
35
|
+
export declare function AvatarChip(props: AvatarChipProps): import("react/jsx-runtime").JSX.Element;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type { string_book } from '../../../book-2.0/agent-source/string_book';
|
|
2
|
+
import type { AvatarChipProps } from './AvatarChip';
|
|
3
|
+
/**
|
|
4
|
+
* Props of `AvatarChipFromSource`
|
|
5
|
+
*
|
|
6
|
+
* @public exported from `@promptbook/components`
|
|
7
|
+
*/
|
|
8
|
+
export type AvatarChipFromSourceProps = Omit<AvatarChipProps, 'avatarBasicInformation'> & {
|
|
9
|
+
/**
|
|
10
|
+
* Avatar to be shown
|
|
11
|
+
*/
|
|
12
|
+
readonly source: string_book;
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* Shows a chip with avatar's avatar and name based on the avatar source string
|
|
16
|
+
*
|
|
17
|
+
* This component is wrapped around the `<AvatarChip/>`, it just parses the avatar source string into `AvatarBasicInformation` and passes it to the `<AvatarChip/>` component.
|
|
18
|
+
*
|
|
19
|
+
* @public exported from `@promptbook/components`
|
|
20
|
+
*/
|
|
21
|
+
export declare function AvatarChipFromSource(props: AvatarChipFromSourceProps): import("react/jsx-runtime").JSX.Element;
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import type { AgentBasicInformation } from '../../../book-2.0/agent-source/parseAgentSource';
|
|
2
|
+
import type { string_css_class } from '../../../types/typeAliases';
|
|
3
|
+
/**
|
|
4
|
+
* Props of `AvatarProfile`
|
|
5
|
+
*
|
|
6
|
+
* @public exported from `@promptbook/components`
|
|
7
|
+
*/
|
|
8
|
+
export type AvatarProfileProps = {
|
|
9
|
+
/**
|
|
10
|
+
* Agent to be shown
|
|
11
|
+
*/
|
|
12
|
+
readonly agent: AgentBasicInformation & {
|
|
13
|
+
agentTitle?: string;
|
|
14
|
+
agentDescription?: string;
|
|
15
|
+
};
|
|
16
|
+
/**
|
|
17
|
+
* Optional CSS class name which will be added to root <div> element
|
|
18
|
+
*/
|
|
19
|
+
readonly className?: string_css_class;
|
|
20
|
+
};
|
|
21
|
+
/**
|
|
22
|
+
* Shows a box with user avatar, name and description
|
|
23
|
+
*
|
|
24
|
+
* @public exported from `@promptbook/components`
|
|
25
|
+
*/
|
|
26
|
+
export declare function AvatarProfile(props: AvatarProfileProps): import("react/jsx-runtime").JSX.Element;
|
package/esm/typings/src/book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource.d.ts
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type { string_book } from '../../../book-2.0/agent-source/string_book';
|
|
2
|
+
import type { AvatarProfileProps } from './AvatarProfile';
|
|
3
|
+
/**
|
|
4
|
+
* Props of `AvatarProfileFromSource`
|
|
5
|
+
*
|
|
6
|
+
* @public exported from `@promptbook/components`
|
|
7
|
+
*/
|
|
8
|
+
export type AvatarProfileFromSourceProps = Omit<AvatarProfileProps, 'agent'> & {
|
|
9
|
+
/**
|
|
10
|
+
* Agent source to be shown
|
|
11
|
+
*/
|
|
12
|
+
readonly agentSource: string_book;
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* Shows a box with user avatar, name and description from a string source
|
|
16
|
+
*
|
|
17
|
+
* @public exported from `@promptbook/components`
|
|
18
|
+
*/
|
|
19
|
+
export declare function AvatarProfileFromSource(props: AvatarProfileFromSourceProps): import("react/jsx-runtime").JSX.Element;
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import type { string_book } from '../../book-2.0/agent-source/string_book';
|
|
2
|
+
/**
|
|
3
|
+
* Props of `BookEditor`
|
|
4
|
+
*
|
|
5
|
+
* @public exported from `@promptbook/components`
|
|
6
|
+
*/
|
|
7
|
+
export type BookEditorProps = {
|
|
8
|
+
/**
|
|
9
|
+
* Additional CSS classes to apply to the editor container.
|
|
10
|
+
*/
|
|
11
|
+
readonly className?: string;
|
|
12
|
+
/**
|
|
13
|
+
* CSS className for a font (e.g. from next/font) to style the editor text.
|
|
14
|
+
* If omitted, defaults to system serif fonts.
|
|
15
|
+
*/
|
|
16
|
+
readonly fontClassName?: string;
|
|
17
|
+
/**
|
|
18
|
+
* The book which is being edited.
|
|
19
|
+
*/
|
|
20
|
+
readonly value?: string_book;
|
|
21
|
+
/**
|
|
22
|
+
* Callback function to handle changes in the book content.
|
|
23
|
+
*/
|
|
24
|
+
onChange?(value: string_book): void;
|
|
25
|
+
/**
|
|
26
|
+
* If true, logs verbose debug info to the console and shows additional visual cues
|
|
27
|
+
*/
|
|
28
|
+
readonly isVerbose?: boolean;
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* Renders a book editor
|
|
32
|
+
*
|
|
33
|
+
* @public exported from `@promptbook/components`
|
|
34
|
+
*/
|
|
35
|
+
export declare function BookEditor(props: BookEditorProps): import("react/jsx-runtime").JSX.Element;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { string_book } from '../../book-2.0/agent-source/string_book';
|
|
2
|
+
/**
|
|
3
|
+
* @private util of `<BookEditor />`
|
|
4
|
+
*/
|
|
5
|
+
export type BookEditorInnerProps = {
|
|
6
|
+
className?: string;
|
|
7
|
+
fontClassName?: string;
|
|
8
|
+
value?: string_book;
|
|
9
|
+
onChange?(value: string_book): void;
|
|
10
|
+
isVerbose?: boolean;
|
|
11
|
+
};
|
|
12
|
+
/**
|
|
13
|
+
* @private util of `<BookEditor />`
|
|
14
|
+
*/
|
|
15
|
+
export declare function BookEditorInner(props: BookEditorInnerProps): import("react/jsx-runtime").JSX.Element;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Default font class name for the BookEditor component
|
|
3
|
+
* In Next.js environments, you can override this by importing the font directly
|
|
4
|
+
*
|
|
5
|
+
* @public exported from `@promptbook/components`
|
|
6
|
+
*/
|
|
7
|
+
export declare const DEFAULT_BOOK_FONT_CLASS: any;
|
|
8
|
+
/**
|
|
9
|
+
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
10
|
+
*/
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Inject the CSS module rules (derived from imported `styles`) into the provided shadow root.
|
|
3
|
+
* This allows CSS modules (which are normally emitted into the document head) to be
|
|
4
|
+
* available inside the component's shadow DOM.
|
|
5
|
+
*
|
|
6
|
+
* @private within the promptbook components <- TODO: Maybe make promptbook util from this
|
|
7
|
+
*/
|
|
8
|
+
export declare function injectCssModuleIntoShadowRoot(shadowRoot: ShadowRoot): void;
|
|
9
|
+
/**
|
|
10
|
+
* TODO: Make some utility functions for working with CSS modules in shadow DOM independent of `BookEditor.module.css`
|
|
11
|
+
*/
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type { ChatProps } from './ChatProps';
|
|
2
|
+
/**
|
|
3
|
+
* @deprecated use `isComplete` instead
|
|
4
|
+
* @private util of `<Chat />`
|
|
5
|
+
*/
|
|
6
|
+
export declare const LOADING_INTERACTIVE_IMAGE = "Loading...";
|
|
7
|
+
/**
|
|
8
|
+
* Renders a chat with messages and input for new messages
|
|
9
|
+
*
|
|
10
|
+
* Note: 🔇 This component does NOT have speak functionality, it just allows to trigger voice recognition
|
|
11
|
+
*
|
|
12
|
+
* Note: There are multiple chat components:
|
|
13
|
+
* - `<Chat/>` renders chat as it is without any logic
|
|
14
|
+
* - `<LlmChat/>` connected to LLM Execution Tools of Promptbook
|
|
15
|
+
*
|
|
16
|
+
* Use <WorkerChat/> or <SignalChat/> in most cases.
|
|
17
|
+
*
|
|
18
|
+
* @public exported from `@promptbook/components`
|
|
19
|
+
*/
|
|
20
|
+
export declare function Chat(props: ChatProps): import("react/jsx-runtime").JSX.Element;
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
import type { CSSProperties, ReactNode } from 'react';
|
|
2
|
+
import type { Promisable } from 'type-fest';
|
|
3
|
+
import type { ChatMessage } from '../types/ChatMessage';
|
|
4
|
+
import type { ChatParticipant } from '../types/ChatParticipant';
|
|
5
|
+
/**
|
|
6
|
+
* @public exported from `@promptbook/components`
|
|
7
|
+
*/
|
|
8
|
+
export type ChatProps = {
|
|
9
|
+
/**
|
|
10
|
+
* Optional callback to create a new agent from the template.
|
|
11
|
+
* If provided, renders the [Use this template] button.
|
|
12
|
+
*/
|
|
13
|
+
onUseTemplate?(): void;
|
|
14
|
+
/**
|
|
15
|
+
* Messages to render - they are rendered as they are
|
|
16
|
+
*/
|
|
17
|
+
readonly messages: ReadonlyArray<ChatMessage>;
|
|
18
|
+
/**
|
|
19
|
+
* Called every time the user types or dictated a message
|
|
20
|
+
*/
|
|
21
|
+
onChange?(messageContent: string): void;
|
|
22
|
+
/**
|
|
23
|
+
* Called when user sends a message
|
|
24
|
+
*
|
|
25
|
+
* Note: You must handle the message yourself and add it to the `messages` array
|
|
26
|
+
*/
|
|
27
|
+
onMessage(messageContent: string): Promisable<void>;
|
|
28
|
+
/**
|
|
29
|
+
* Optional callback, when set, button for resetting chat will be shown
|
|
30
|
+
*/
|
|
31
|
+
onReset?(): Promisable<void>;
|
|
32
|
+
/**
|
|
33
|
+
* Determines whether the voice recognition button is rendered
|
|
34
|
+
*/
|
|
35
|
+
readonly isVoiceRecognitionButtonShown?: boolean;
|
|
36
|
+
/**
|
|
37
|
+
* The language code to use for voice recognition
|
|
38
|
+
*/
|
|
39
|
+
readonly voiceLanguage?: string;
|
|
40
|
+
/**
|
|
41
|
+
* Optional placeholder message for the textarea
|
|
42
|
+
*
|
|
43
|
+
* @default "Write a message"
|
|
44
|
+
*/
|
|
45
|
+
readonly placeholderMessageContent?: string;
|
|
46
|
+
/**
|
|
47
|
+
* Optional preset message in chat
|
|
48
|
+
*/
|
|
49
|
+
readonly defaultMessage?: string;
|
|
50
|
+
/**
|
|
51
|
+
* List of tasks that are currently in progress that should be displayed
|
|
52
|
+
*/
|
|
53
|
+
readonly tasksProgress?: Array<{
|
|
54
|
+
id: string;
|
|
55
|
+
name: string;
|
|
56
|
+
progress?: number;
|
|
57
|
+
}>;
|
|
58
|
+
/**
|
|
59
|
+
* Content to be shown inside the chat bar in head
|
|
60
|
+
* If not provided, the chat bar will not be rendered
|
|
61
|
+
*/
|
|
62
|
+
readonly children?: ReactNode;
|
|
63
|
+
/**
|
|
64
|
+
* Optional CSS class name which will be added to root <div/> element
|
|
65
|
+
*/
|
|
66
|
+
readonly className?: string;
|
|
67
|
+
/**
|
|
68
|
+
* Optional CSS style which will be added to root <div/> element
|
|
69
|
+
*/
|
|
70
|
+
readonly style?: CSSProperties;
|
|
71
|
+
/**
|
|
72
|
+
* Voice call props - when provided, voice call button will be shown
|
|
73
|
+
*/
|
|
74
|
+
readonly voiceCallProps?: {
|
|
75
|
+
selectedModel: string;
|
|
76
|
+
providerClients: Map<string, unknown>;
|
|
77
|
+
currentPersonaContent?: string;
|
|
78
|
+
onVoiceMessage?: (content: string, isVoiceCall: boolean) => void;
|
|
79
|
+
onAssistantVoiceResponse?: (content: string, isVoiceCall: boolean) => void;
|
|
80
|
+
onVoiceCallStateChange?: (isVoiceCalling: boolean) => void;
|
|
81
|
+
};
|
|
82
|
+
/**
|
|
83
|
+
* Indicates whether a voice call is currently active
|
|
84
|
+
*/
|
|
85
|
+
readonly isVoiceCalling?: boolean;
|
|
86
|
+
/**
|
|
87
|
+
* Whether experimental features are enabled (required for voice calling)
|
|
88
|
+
*/
|
|
89
|
+
readonly isExperimental?: boolean;
|
|
90
|
+
/**
|
|
91
|
+
* Whether the save button is enabled and shown
|
|
92
|
+
*/
|
|
93
|
+
readonly isSaveButtonEnabled?: boolean;
|
|
94
|
+
/**
|
|
95
|
+
* Is the writing textarea automatically focused?
|
|
96
|
+
*
|
|
97
|
+
* @default true on Desktop false on mobile (to prevent mobile keyboard from popping up)
|
|
98
|
+
*/
|
|
99
|
+
readonly isFocusedOnLoad?: boolean;
|
|
100
|
+
/**
|
|
101
|
+
* Optional markdown header to include at the top of exported files.
|
|
102
|
+
* Example: "## Discussion Topic\n\nSome topic here"
|
|
103
|
+
*/
|
|
104
|
+
readonly exportHeaderMarkdown?: string;
|
|
105
|
+
/**
|
|
106
|
+
* Optional mapping of participant IDs (message.from) to display metadata for exports.
|
|
107
|
+
* Keys should match ChatMessage.from values (e.g., 'USER', 'AGENT_{id}', etc.)
|
|
108
|
+
*/
|
|
109
|
+
readonly participants?: ReadonlyArray<ChatParticipant>;
|
|
110
|
+
};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { LlmChatProps } from './LlmChatProps';
|
|
2
|
+
/**
|
|
3
|
+
* LlmChat component that provides chat functionality with LLM integration
|
|
4
|
+
*
|
|
5
|
+
* This component internally manages messages, participants, and task progress,
|
|
6
|
+
* and uses the provided LLM tools to generate responses via `LlmExecutionTools.callChatModel`.
|
|
7
|
+
*
|
|
8
|
+
* Note: There are multiple chat components:
|
|
9
|
+
* - `<Chat/>` renders chat as it is without any logic
|
|
10
|
+
* - `<LlmChat/>` connected to LLM Execution Tools of Promptbook
|
|
11
|
+
*
|
|
12
|
+
* @public exported from `@promptbook/components`
|
|
13
|
+
*/
|
|
14
|
+
export declare function LlmChat(props: LlmChatProps): import("react/jsx-runtime").JSX.Element;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
|
|
2
|
+
import type { ChatProps } from '../Chat/ChatProps';
|
|
3
|
+
import type { ChatMessage } from '../types/ChatMessage';
|
|
4
|
+
import type { ChatParticipant } from '../types/ChatParticipant';
|
|
5
|
+
/**
|
|
6
|
+
* Props for LlmChat component, derived from ChatProps but with LLM-specific modifications
|
|
7
|
+
*
|
|
8
|
+
* @public exported from `@promptbook/components`
|
|
9
|
+
*/
|
|
10
|
+
export type LlmChatProps = Omit<ChatProps, 'messages' | 'onMessage' | 'onChange'> & {
|
|
11
|
+
/**
|
|
12
|
+
* LLM execution tools for chatting with the model
|
|
13
|
+
*/
|
|
14
|
+
readonly llmTools: LlmExecutionTools;
|
|
15
|
+
/**
|
|
16
|
+
* Optional key for persisting conversation in localStorage
|
|
17
|
+
* When provided, the conversation will be saved and restored from localStorage
|
|
18
|
+
*/
|
|
19
|
+
readonly persistenceKey?: string;
|
|
20
|
+
/**
|
|
21
|
+
* Called when the chat state changes (messages, participants, etc.)
|
|
22
|
+
*/
|
|
23
|
+
onChange?(messages: ReadonlyArray<ChatMessage>, participants: ReadonlyArray<ChatParticipant>): void;
|
|
24
|
+
};
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { string_markdown } from '../../../types/typeAliases';
|
|
2
|
+
import type { string_name } from '../../../types/typeAliases';
|
|
3
|
+
/**
|
|
4
|
+
* A message in the chat
|
|
5
|
+
*
|
|
6
|
+
* @public exported from `@promptbook/components`
|
|
7
|
+
*/
|
|
8
|
+
export type ChatMessage = {
|
|
9
|
+
id: string;
|
|
10
|
+
date: Date;
|
|
11
|
+
from: string_name;
|
|
12
|
+
content: string_markdown;
|
|
13
|
+
isComplete?: boolean;
|
|
14
|
+
expectedAnswer?: string;
|
|
15
|
+
isVoiceCall?: boolean;
|
|
16
|
+
};
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import type { string_color } from '../../../types/typeAliases';
|
|
2
|
+
import type { string_name } from '../../../types/typeAliases';
|
|
3
|
+
import type { string_person_fullname } from '../../../types/typeAliases';
|
|
4
|
+
import type { string_url_image } from '../../../types/typeAliases';
|
|
5
|
+
import { Color } from '../../../utils/color/Color';
|
|
6
|
+
/**
|
|
7
|
+
* A participant in the chat
|
|
8
|
+
*
|
|
9
|
+
* @public exported from `@promptbook/components`
|
|
10
|
+
*/
|
|
11
|
+
export type ChatParticipant = {
|
|
12
|
+
/**
|
|
13
|
+
* Identifies the participant by their name, same as `message.from`
|
|
14
|
+
*/
|
|
15
|
+
name: string_name;
|
|
16
|
+
/**
|
|
17
|
+
* Full name of the participant
|
|
18
|
+
*/
|
|
19
|
+
fullname: string_person_fullname;
|
|
20
|
+
/**
|
|
21
|
+
* Am I the participant? (i.e. is this the user)
|
|
22
|
+
*/
|
|
23
|
+
isMe?: boolean;
|
|
24
|
+
/**
|
|
25
|
+
* Profile picture
|
|
26
|
+
*/
|
|
27
|
+
avatarSrc?: string_url_image;
|
|
28
|
+
/**
|
|
29
|
+
* Color associated with the participant
|
|
30
|
+
*/
|
|
31
|
+
color: string_color | Color;
|
|
32
|
+
};
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import type { ChatMessage } from '../types/ChatMessage';
|
|
2
|
+
/**
|
|
3
|
+
* Utility functions for persisting chat conversations in localStorage
|
|
4
|
+
*
|
|
5
|
+
* @private util of `LlmChat`
|
|
6
|
+
*/
|
|
7
|
+
export declare class ChatPersistence {
|
|
8
|
+
private static readonly STORAGE_PREFIX;
|
|
9
|
+
/**
|
|
10
|
+
* Save messages to localStorage under the given key
|
|
11
|
+
*/
|
|
12
|
+
static saveMessages(persistenceKey: string, messages: ReadonlyArray<ChatMessage>): void;
|
|
13
|
+
/**
|
|
14
|
+
* Load messages from localStorage for the given key
|
|
15
|
+
*/
|
|
16
|
+
static loadMessages(persistenceKey: string): ChatMessage[];
|
|
17
|
+
/**
|
|
18
|
+
* Clear messages from localStorage for the given key
|
|
19
|
+
*/
|
|
20
|
+
static clearMessages(persistenceKey: string): void;
|
|
21
|
+
/**
|
|
22
|
+
* Check if localStorage is available
|
|
23
|
+
*/
|
|
24
|
+
static isAvailable(): boolean;
|
|
25
|
+
}
|