@promptbook/legacy-documents 0.103.0-52 → 0.103.0-54

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.
Files changed (44) hide show
  1. package/esm/index.es.js +1 -1
  2. package/esm/typings/servers.d.ts +8 -1
  3. package/esm/typings/src/_packages/components.index.d.ts +2 -0
  4. package/esm/typings/src/_packages/core.index.d.ts +6 -0
  5. package/esm/typings/src/_packages/types.index.d.ts +2 -0
  6. package/esm/typings/src/_packages/utils.index.d.ts +2 -0
  7. package/esm/typings/src/book-2.0/agent-source/AgentModelRequirements.d.ts +7 -0
  8. package/esm/typings/src/book-components/Chat/Chat/ChatProps.d.ts +4 -0
  9. package/esm/typings/src/book-components/_common/HamburgerMenu/HamburgerMenu.d.ts +12 -0
  10. package/esm/typings/src/book-components/icons/MicIcon.d.ts +8 -0
  11. package/esm/typings/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabase.d.ts +17 -0
  12. package/esm/typings/src/commitments/ACTION/ACTION.d.ts +4 -0
  13. package/esm/typings/src/commitments/DELETE/DELETE.d.ts +4 -0
  14. package/esm/typings/src/commitments/FORMAT/FORMAT.d.ts +4 -0
  15. package/esm/typings/src/commitments/GOAL/GOAL.d.ts +4 -0
  16. package/esm/typings/src/commitments/KNOWLEDGE/KNOWLEDGE.d.ts +4 -0
  17. package/esm/typings/src/commitments/MEMORY/MEMORY.d.ts +4 -0
  18. package/esm/typings/src/commitments/MESSAGE/AgentMessageCommitmentDefinition.d.ts +32 -0
  19. package/esm/typings/src/commitments/MESSAGE/InitialMessageCommitmentDefinition.d.ts +4 -0
  20. package/esm/typings/src/commitments/MESSAGE/MESSAGE.d.ts +4 -0
  21. package/esm/typings/src/commitments/MESSAGE/UserMessageCommitmentDefinition.d.ts +32 -0
  22. package/esm/typings/src/commitments/META/META.d.ts +4 -0
  23. package/esm/typings/src/commitments/META_COLOR/META_COLOR.d.ts +4 -0
  24. package/esm/typings/src/commitments/META_IMAGE/META_IMAGE.d.ts +4 -0
  25. package/esm/typings/src/commitments/META_LINK/META_LINK.d.ts +4 -0
  26. package/esm/typings/src/commitments/MODEL/MODEL.d.ts +4 -0
  27. package/esm/typings/src/commitments/NOTE/NOTE.d.ts +4 -0
  28. package/esm/typings/src/commitments/PERSONA/PERSONA.d.ts +4 -0
  29. package/esm/typings/src/commitments/RULE/RULE.d.ts +4 -0
  30. package/esm/typings/src/commitments/SAMPLE/SAMPLE.d.ts +4 -0
  31. package/esm/typings/src/commitments/SCENARIO/SCENARIO.d.ts +4 -0
  32. package/esm/typings/src/commitments/STYLE/STYLE.d.ts +4 -0
  33. package/esm/typings/src/commitments/_base/BaseCommitmentDefinition.d.ts +5 -0
  34. package/esm/typings/src/commitments/_base/CommitmentDefinition.d.ts +5 -0
  35. package/esm/typings/src/commitments/_base/NotYetImplementedCommitmentDefinition.d.ts +4 -0
  36. package/esm/typings/src/commitments/index.d.ts +20 -1
  37. package/esm/typings/src/execution/LlmExecutionTools.d.ts +9 -0
  38. package/esm/typings/src/llm-providers/agent/AgentLlmExecutionTools.d.ts +2 -1
  39. package/esm/typings/src/llm-providers/agent/RemoteAgent.d.ts +10 -1
  40. package/esm/typings/src/utils/normalization/normalizeMessageText.d.ts +9 -0
  41. package/esm/typings/src/utils/normalization/normalizeMessageText.test.d.ts +1 -0
  42. package/esm/typings/src/version.d.ts +1 -1
  43. package/package.json +3 -3
  44. package/umd/index.umd.js +1 -1
package/esm/index.es.js CHANGED
@@ -26,7 +26,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
26
26
  * @generated
27
27
  * @see https://github.com/webgptorg/promptbook
28
28
  */
29
- const PROMPTBOOK_ENGINE_VERSION = '0.103.0-52';
29
+ const PROMPTBOOK_ENGINE_VERSION = '0.103.0-54';
30
30
  /**
31
31
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
32
32
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -28,8 +28,15 @@ type ServerConfiguration = {
28
28
  * @public exported from `@promptbook/core`
29
29
  */
30
30
  export declare const REMOTE_SERVER_URLS: Array<ServerConfiguration>;
31
+ /**
32
+ * Remote servers that are auto-federated by the Agents Server.
33
+ *
34
+ * These servers are always added in addition to the `FEDERATED_SERVERS` metadata.
35
+ *
36
+ * @public exported from `@promptbook/core`
37
+ */
38
+ export declare const AUTO_FEDERATED_AGENT_SERVER_URLS: Array<string_promptbook_server_url>;
31
39
  export {};
32
40
  /**
33
- * TODO: [🐱‍🚀] Auto-federated server from url in here
34
41
  * Note: [💞] Ignore a discrepancy between file name and entity name
35
42
  */
@@ -45,6 +45,7 @@ import type { MessageButton } from '../book-components/Chat/utils/parseMessageBu
45
45
  import { parseMessageButtons } from '../book-components/Chat/utils/parseMessageButtons';
46
46
  import { ArrowIcon } from '../book-components/icons/ArrowIcon';
47
47
  import { AttachmentIcon } from '../book-components/icons/AttachmentIcon';
48
+ import { MicIcon } from '../book-components/icons/MicIcon';
48
49
  import { PauseIcon } from '../book-components/icons/PauseIcon';
49
50
  import { PlayIcon } from '../book-components/icons/PlayIcon';
50
51
  import { ResetIcon } from '../book-components/icons/ResetIcon';
@@ -104,6 +105,7 @@ export type { MessageButton };
104
105
  export { parseMessageButtons };
105
106
  export { ArrowIcon };
106
107
  export { AttachmentIcon };
108
+ export { MicIcon };
107
109
  export { PauseIcon };
108
110
  export { PlayIcon };
109
111
  export { ResetIcon };
@@ -25,6 +25,8 @@ import { getCommitmentDefinition } from '../commitments/index';
25
25
  import { getAllCommitmentDefinitions } from '../commitments/index';
26
26
  import { getAllCommitmentTypes } from '../commitments/index';
27
27
  import { isCommitmentSupported } from '../commitments/index';
28
+ import type { GroupedCommitmentDefinition } from '../commitments/index';
29
+ import { getGroupedCommitmentDefinitions } from '../commitments/index';
28
30
  import { NAME } from '../config';
29
31
  import { ADMIN_EMAIL } from '../config';
30
32
  import { ADMIN_GITHUB_NAME } from '../config';
@@ -190,6 +192,7 @@ import { TaskTypes } from '../types/TaskType';
190
192
  import { aboutPromptbookInformation } from '../utils/misc/aboutPromptbookInformation';
191
193
  import { $generateBookBoilerplate } from '../utils/random/$generateBookBoilerplate';
192
194
  import { REMOTE_SERVER_URLS } from '../../servers';
195
+ import { AUTO_FEDERATED_AGENT_SERVER_URLS } from '../../servers';
193
196
  export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
194
197
  export { computeAgentHash };
195
198
  export { createAgentModelRequirements };
@@ -217,6 +220,8 @@ export { getCommitmentDefinition };
217
220
  export { getAllCommitmentDefinitions };
218
221
  export { getAllCommitmentTypes };
219
222
  export { isCommitmentSupported };
223
+ export type { GroupedCommitmentDefinition };
224
+ export { getGroupedCommitmentDefinitions };
220
225
  export { NAME };
221
226
  export { ADMIN_EMAIL };
222
227
  export { ADMIN_GITHUB_NAME };
@@ -382,3 +387,4 @@ export { TaskTypes };
382
387
  export { aboutPromptbookInformation };
383
388
  export { $generateBookBoilerplate };
384
389
  export { REMOTE_SERVER_URLS };
390
+ export { AUTO_FEDERATED_AGENT_SERVER_URLS };
@@ -57,6 +57,7 @@ import type { InstrumentCommand } from '../commands/X_INSTRUMENT/InstrumentComma
57
57
  import type { BookCommitment } from '../commitments/_base/BookCommitment';
58
58
  import type { CommitmentDefinition } from '../commitments/_base/CommitmentDefinition';
59
59
  import type { ParsedCommitment } from '../commitments/_base/ParsedCommitment';
60
+ import type { GroupedCommitmentDefinition } from '../commitments/index';
60
61
  import type { PrettifyOptions } from '../conversion/prettify/PrettifyOptions';
61
62
  import type { renderPipelineMermaidOptions } from '../conversion/prettify/renderPipelineMermaidOptions';
62
63
  import type { CallbackInterfaceToolsOptions } from '../dialogs/callback/CallbackInterfaceToolsOptions';
@@ -414,6 +415,7 @@ export type { InstrumentCommand };
414
415
  export type { BookCommitment };
415
416
  export type { CommitmentDefinition };
416
417
  export type { ParsedCommitment };
418
+ export type { GroupedCommitmentDefinition };
417
419
  export type { PrettifyOptions };
418
420
  export type { renderPipelineMermaidOptions };
419
421
  export type { CallbackInterfaceToolsOptions };
@@ -40,6 +40,7 @@ import { nameToUriPart } from '../utils/normalization/nameToUriPart';
40
40
  import { nameToUriParts } from '../utils/normalization/nameToUriParts';
41
41
  import type { string_kebab_case } from '../utils/normalization/normalize-to-kebab-case';
42
42
  import { normalizeToKebabCase } from '../utils/normalization/normalize-to-kebab-case';
43
+ import { normalizeMessageText } from '../utils/normalization/normalizeMessageText';
43
44
  import type { string_camelCase } from '../utils/normalization/normalizeTo_camelCase';
44
45
  import { normalizeTo_camelCase } from '../utils/normalization/normalizeTo_camelCase';
45
46
  import type { string_PascalCase } from '../utils/normalization/normalizeTo_PascalCase';
@@ -127,6 +128,7 @@ export { nameToUriPart };
127
128
  export { nameToUriParts };
128
129
  export type { string_kebab_case };
129
130
  export { normalizeToKebabCase };
131
+ export { normalizeMessageText };
130
132
  export type { string_camelCase };
131
133
  export { normalizeTo_camelCase };
132
134
  export type { string_PascalCase };
@@ -22,6 +22,13 @@ export type AgentModelRequirements = {
22
22
  * Optional list of knowledge source links that the agent can use
23
23
  */
24
24
  readonly knowledgeSources?: ReadonlyArray<string_knowledge_source_link>;
25
+ /**
26
+ * List of sample conversations (question/answer pairs)
27
+ */
28
+ readonly samples?: ReadonlyArray<{
29
+ question: string;
30
+ answer: string;
31
+ }>;
25
32
  /**
26
33
  * Temperature for the agent's responses, controlling randomness
27
34
  */
@@ -44,6 +44,10 @@ export type ChatProps = {
44
44
  * Determines whether the voice recognition button is rendered
45
45
  */
46
46
  readonly isVoiceRecognitionButtonShown?: boolean;
47
+ /**
48
+ * Optional callback to trigger voice input
49
+ */
50
+ onVoiceInput?(): void;
47
51
  /**
48
52
  * The language code to use for voice recognition
49
53
  */
@@ -0,0 +1,12 @@
1
+ type HamburgerMenuProps = {
2
+ isOpen: boolean;
3
+ onClick?: () => void;
4
+ className?: string;
5
+ };
6
+ /**
7
+ * @@@
8
+ *
9
+ * @private Internal component
10
+ */
11
+ export declare function HamburgerMenu({ isOpen, onClick, className }: HamburgerMenuProps): import("react/jsx-runtime").JSX.Element;
12
+ export {};
@@ -0,0 +1,8 @@
1
+ /**
2
+ * Shows simple microphone icon
3
+ *
4
+ * @public exported from `@promptbook/components`
5
+ */
6
+ export declare const MicIcon: ({ size }: {
7
+ size: number;
8
+ }) => import("react/jsx-runtime").JSX.Element;
@@ -43,6 +43,23 @@ export declare class AgentCollectionInSupabase {
43
43
  * Deletes an agent from the collection
44
44
  */
45
45
  deleteAgent(agentName: string_agent_name): Promise<void>;
46
+ /**
47
+ * List history of an agent
48
+ */
49
+ listAgentHistory(agentName: string_agent_name): Promise<ReadonlyArray<{
50
+ id: number;
51
+ createdAt: string;
52
+ agentHash: string;
53
+ promptbookEngineVersion: string;
54
+ }>>;
55
+ /**
56
+ * List agents that are in history but not in the active agents list
57
+ */
58
+ listDeletedAgents(): Promise<ReadonlyArray<string_agent_name>>;
59
+ /**
60
+ * Restore an agent from history
61
+ */
62
+ restoreAgent(historyId: number): Promise<void>;
46
63
  /**
47
64
  * Get the Supabase table name with prefix
48
65
  *
@@ -21,6 +21,10 @@ export declare class ActionCommitmentDefinition extends BaseCommitmentDefinition
21
21
  * Short one-line description of ACTION.
22
22
  */
23
23
  get description(): string;
24
+ /**
25
+ * Icon for this commitment.
26
+ */
27
+ get icon(): string;
24
28
  /**
25
29
  * Markdown documentation for ACTION commitment.
26
30
  */
@@ -24,6 +24,10 @@ export declare class DeleteCommitmentDefinition extends BaseCommitmentDefinition
24
24
  * Short one-line description of DELETE/CANCEL/DISCARD/REMOVE.
25
25
  */
26
26
  get description(): string;
27
+ /**
28
+ * Icon for this commitment.
29
+ */
30
+ get icon(): string;
27
31
  /**
28
32
  * Markdown documentation for DELETE commitment.
29
33
  */
@@ -22,6 +22,10 @@ export declare class FormatCommitmentDefinition extends BaseCommitmentDefinition
22
22
  * Short one-line description of FORMAT.
23
23
  */
24
24
  get description(): string;
25
+ /**
26
+ * Icon for this commitment.
27
+ */
28
+ get icon(): string;
25
29
  /**
26
30
  * Markdown documentation for FORMAT commitment.
27
31
  */
@@ -22,6 +22,10 @@ export declare class GoalCommitmentDefinition extends BaseCommitmentDefinition<'
22
22
  * Short one-line description of GOAL.
23
23
  */
24
24
  get description(): string;
25
+ /**
26
+ * Icon for this commitment.
27
+ */
28
+ get icon(): string;
25
29
  /**
26
30
  * Markdown documentation for GOAL commitment.
27
31
  */
@@ -24,6 +24,10 @@ export declare class KnowledgeCommitmentDefinition extends BaseCommitmentDefinit
24
24
  * Short one-line description of KNOWLEDGE.
25
25
  */
26
26
  get description(): string;
27
+ /**
28
+ * Icon for this commitment.
29
+ */
30
+ get icon(): string;
27
31
  /**
28
32
  * Markdown documentation for KNOWLEDGE commitment.
29
33
  */
@@ -23,6 +23,10 @@ export declare class MemoryCommitmentDefinition extends BaseCommitmentDefinition
23
23
  * Short one-line description of MEMORY.
24
24
  */
25
25
  get description(): string;
26
+ /**
27
+ * Icon for this commitment.
28
+ */
29
+ get icon(): string;
26
30
  /**
27
31
  * Markdown documentation for MEMORY commitment.
28
32
  */
@@ -0,0 +1,32 @@
1
+ import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
+ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
+ /**
4
+ * AGENT MESSAGE commitment definition
5
+ *
6
+ * The AGENT MESSAGE commitment defines a message from the agent in the conversation history.
7
+ * It is used to pre-fill the chat with a conversation history or to provide few-shot examples.
8
+ *
9
+ * Example usage in agent source:
10
+ *
11
+ * ```book
12
+ * AGENT MESSAGE What seems to be the issue?
13
+ * ```
14
+ *
15
+ * @private [🪔] Maybe export the commitments through some package
16
+ */
17
+ export declare class AgentMessageCommitmentDefinition extends BaseCommitmentDefinition<'AGENT MESSAGE'> {
18
+ constructor();
19
+ /**
20
+ * Short one-line description of AGENT MESSAGE.
21
+ */
22
+ get description(): string;
23
+ /**
24
+ * Icon for this commitment.
25
+ */
26
+ get icon(): string;
27
+ /**
28
+ * Markdown documentation for AGENT MESSAGE commitment.
29
+ */
30
+ get documentation(): string;
31
+ applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
32
+ }
@@ -20,6 +20,10 @@ export declare class InitialMessageCommitmentDefinition extends BaseCommitmentDe
20
20
  * Short one-line description of INITIAL MESSAGE.
21
21
  */
22
22
  get description(): string;
23
+ /**
24
+ * Icon for this commitment.
25
+ */
26
+ get icon(): string;
23
27
  /**
24
28
  * Markdown documentation for INITIAL MESSAGE commitment.
25
29
  */
@@ -24,6 +24,10 @@ export declare class MessageCommitmentDefinition extends BaseCommitmentDefinitio
24
24
  * Short one-line description of MESSAGE.
25
25
  */
26
26
  get description(): string;
27
+ /**
28
+ * Icon for this commitment.
29
+ */
30
+ get icon(): string;
27
31
  /**
28
32
  * Markdown documentation for MESSAGE commitment.
29
33
  */
@@ -0,0 +1,32 @@
1
+ import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
+ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
+ /**
4
+ * USER MESSAGE commitment definition
5
+ *
6
+ * The USER MESSAGE commitment defines a message from the user in the conversation history.
7
+ * It is used to pre-fill the chat with a conversation history or to provide few-shot examples.
8
+ *
9
+ * Example usage in agent source:
10
+ *
11
+ * ```book
12
+ * USER MESSAGE Hello, I have a problem.
13
+ * ```
14
+ *
15
+ * @private [🪔] Maybe export the commitments through some package
16
+ */
17
+ export declare class UserMessageCommitmentDefinition extends BaseCommitmentDefinition<'USER MESSAGE'> {
18
+ constructor();
19
+ /**
20
+ * Short one-line description of USER MESSAGE.
21
+ */
22
+ get description(): string;
23
+ /**
24
+ * Icon for this commitment.
25
+ */
26
+ get icon(): string;
27
+ /**
28
+ * Markdown documentation for USER MESSAGE commitment.
29
+ */
30
+ get documentation(): string;
31
+ applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
32
+ }
@@ -32,6 +32,10 @@ export declare class MetaCommitmentDefinition extends BaseCommitmentDefinition<`
32
32
  * Short one-line description of META commitments.
33
33
  */
34
34
  get description(): string;
35
+ /**
36
+ * Icon for this commitment.
37
+ */
38
+ get icon(): string;
35
39
  /**
36
40
  * Markdown documentation for META commitment.
37
41
  */
@@ -22,6 +22,10 @@ export declare class MetaColorCommitmentDefinition extends BaseCommitmentDefinit
22
22
  * Short one-line description of META COLOR.
23
23
  */
24
24
  get description(): string;
25
+ /**
26
+ * Icon for this commitment.
27
+ */
28
+ get icon(): string;
25
29
  /**
26
30
  * Markdown documentation for META COLOR commitment.
27
31
  */
@@ -22,6 +22,10 @@ export declare class MetaImageCommitmentDefinition extends BaseCommitmentDefinit
22
22
  * Short one-line description of META IMAGE.
23
23
  */
24
24
  get description(): string;
25
+ /**
26
+ * Icon for this commitment.
27
+ */
28
+ get icon(): string;
25
29
  /**
26
30
  * Markdown documentation for META IMAGE commitment.
27
31
  */
@@ -30,6 +30,10 @@ export declare class MetaLinkCommitmentDefinition extends BaseCommitmentDefiniti
30
30
  * Short one-line description of META LINK.
31
31
  */
32
32
  get description(): string;
33
+ /**
34
+ * Icon for this commitment.
35
+ */
36
+ get icon(): string;
33
37
  /**
34
38
  * Markdown documentation for META LINK commitment.
35
39
  */
@@ -31,6 +31,10 @@ export declare class ModelCommitmentDefinition extends BaseCommitmentDefinition<
31
31
  * Short one-line description of MODEL.
32
32
  */
33
33
  get description(): string;
34
+ /**
35
+ * Icon for this commitment.
36
+ */
37
+ get icon(): string;
34
38
  /**
35
39
  * Markdown documentation for MODEL commitment.
36
40
  */
@@ -32,6 +32,10 @@ export declare class NoteCommitmentDefinition extends BaseCommitmentDefinition<'
32
32
  * Short one-line description of NOTE.
33
33
  */
34
34
  get description(): string;
35
+ /**
36
+ * Icon for this commitment.
37
+ */
38
+ get icon(): string;
35
39
  /**
36
40
  * Markdown documentation for NOTE commitment.
37
41
  */
@@ -29,6 +29,10 @@ export declare class PersonaCommitmentDefinition extends BaseCommitmentDefinitio
29
29
  * Short one-line description of PERSONA.
30
30
  */
31
31
  get description(): string;
32
+ /**
33
+ * Icon for this commitment.
34
+ */
35
+ get icon(): string;
32
36
  /**
33
37
  * Markdown documentation for PERSONA commitment.
34
38
  */
@@ -21,6 +21,10 @@ export declare class RuleCommitmentDefinition extends BaseCommitmentDefinition<'
21
21
  * Short one-line description of RULE/RULES.
22
22
  */
23
23
  get description(): string;
24
+ /**
25
+ * Icon for this commitment.
26
+ */
27
+ get icon(): string;
24
28
  /**
25
29
  * Markdown documentation for RULE/RULES commitment.
26
30
  */
@@ -21,6 +21,10 @@ export declare class SampleCommitmentDefinition extends BaseCommitmentDefinition
21
21
  * Short one-line description of SAMPLE/EXAMPLE.
22
22
  */
23
23
  get description(): string;
24
+ /**
25
+ * Icon for this commitment.
26
+ */
27
+ get icon(): string;
24
28
  /**
25
29
  * Markdown documentation for SAMPLE/EXAMPLE commitment.
26
30
  */
@@ -23,6 +23,10 @@ export declare class ScenarioCommitmentDefinition extends BaseCommitmentDefiniti
23
23
  * Short one-line description of SCENARIO.
24
24
  */
25
25
  get description(): string;
26
+ /**
27
+ * Icon for this commitment.
28
+ */
29
+ get icon(): string;
26
30
  /**
27
31
  * Markdown documentation for SCENARIO commitment.
28
32
  */
@@ -21,6 +21,10 @@ export declare class StyleCommitmentDefinition extends BaseCommitmentDefinition<
21
21
  * Short one-line description of STYLE.
22
22
  */
23
23
  get description(): string;
24
+ /**
25
+ * Icon for this commitment.
26
+ */
27
+ get icon(): string;
24
28
  /**
25
29
  * Markdown documentation for STYLE commitment.
26
30
  */
@@ -15,6 +15,11 @@ export declare abstract class BaseCommitmentDefinition<TBookCommitment extends s
15
15
  * Must be implemented by each concrete commitment.
16
16
  */
17
17
  abstract get description(): string;
18
+ /**
19
+ * Icon for this commitment.
20
+ * It should be a single emoji.
21
+ */
22
+ abstract get icon(): string;
18
23
  /**
19
24
  * Human-readable markdown documentation for this commitment, available at runtime.
20
25
  * Must be implemented by each concrete commitment.
@@ -16,6 +16,11 @@ export type CommitmentDefinition = {
16
16
  * Keep it concise; may use inline markdown like **bold** or *italic*.
17
17
  */
18
18
  readonly description: string;
19
+ /**
20
+ * Icon for this commitment.
21
+ * It should be a single emoji.
22
+ */
23
+ readonly icon: string;
19
24
  /**
20
25
  * Human-readable markdown documentation for this commitment.
21
26
  * Should explain what the commitment does and include example usage.
@@ -14,6 +14,10 @@ export declare class NotYetImplementedCommitmentDefinition<TBookCommitment exten
14
14
  * Short one-line description of a placeholder commitment.
15
15
  */
16
16
  get description(): string;
17
+ /**
18
+ * Icon for this commitment.
19
+ */
20
+ get icon(): string;
17
21
  /**
18
22
  * Markdown documentation available at runtime.
19
23
  */
@@ -6,8 +6,10 @@ import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
6
6
  import { GoalCommitmentDefinition } from './GOAL/GOAL';
7
7
  import { KnowledgeCommitmentDefinition } from './KNOWLEDGE/KNOWLEDGE';
8
8
  import { MemoryCommitmentDefinition } from './MEMORY/MEMORY';
9
+ import { AgentMessageCommitmentDefinition } from './MESSAGE/AgentMessageCommitmentDefinition';
9
10
  import { InitialMessageCommitmentDefinition } from './MESSAGE/InitialMessageCommitmentDefinition';
10
11
  import { MessageCommitmentDefinition } from './MESSAGE/MESSAGE';
12
+ import { UserMessageCommitmentDefinition } from './MESSAGE/UserMessageCommitmentDefinition';
11
13
  import { MetaCommitmentDefinition } from './META/META';
12
14
  import { MetaColorCommitmentDefinition } from './META_COLOR/META_COLOR';
13
15
  import { MetaImageCommitmentDefinition } from './META_IMAGE/META_IMAGE';
@@ -26,7 +28,7 @@ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplemented
26
28
  *
27
29
  * @private Use functions to access commitments instead of this array directly
28
30
  */
29
- export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
31
+ export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
30
32
  /**
31
33
  * Gets a commitment definition by its type
32
34
  * @param type The commitment type to look up
@@ -57,6 +59,23 @@ export declare function getAllCommitmentTypes(): ReadonlyArray<BookCommitment>;
57
59
  * @public exported from `@promptbook/core`
58
60
  */
59
61
  export declare function isCommitmentSupported(type: BookCommitment): boolean;
62
+ /**
63
+ * Grouped commitment definition
64
+ *
65
+ * @public exported from `@promptbook/core`
66
+ */
67
+ export type GroupedCommitmentDefinition = {
68
+ primary: CommitmentDefinition;
69
+ aliases: string[];
70
+ };
71
+ /**
72
+ * Gets all commitment definitions grouped by their aliases
73
+ *
74
+ * @returns Array of grouped commitment definitions
75
+ *
76
+ * @public exported from `@promptbook/core`
77
+ */
78
+ export declare function getGroupedCommitmentDefinitions(): ReadonlyArray<GroupedCommitmentDefinition>;
60
79
  /**
61
80
  * TODO: [🧠] Maybe create through standardized $register
62
81
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -57,6 +57,15 @@ export type LlmExecutionTools = {
57
57
  * Calls a chat model with streaming
58
58
  */
59
59
  callChatModelStream?(prompt: Prompt, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
60
+ /**
61
+ * Calls a voice chat model
62
+ */
63
+ callVoiceChatModel?(audio: Blob, prompt: Prompt): Promise<{
64
+ text: string;
65
+ audio: Blob;
66
+ userMessage?: string;
67
+ agentMessage?: string;
68
+ }>;
60
69
  /**
61
70
  * Calls a completion model
62
71
  */
@@ -1,4 +1,5 @@
1
1
  import type { Promisable } from 'type-fest';
2
+ import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
3
  import type { string_book } from '../../book-2.0/agent-source/string_book';
3
4
  import type { ChatParticipant } from '../../book-components/Chat/types/ChatParticipant';
4
5
  import type { AvailableModel } from '../../execution/AvailableModel';
@@ -54,7 +55,7 @@ export declare class AgentLlmExecutionTools implements LlmExecutionTools {
54
55
  /**
55
56
  * Get cached or create agent model requirements
56
57
  */
57
- private getAgentModelRequirements;
58
+ protected getAgentModelRequirements(): Promise<AgentModelRequirements>;
58
59
  get title(): string_title & string_markdown_text;
59
60
  get description(): string_markdown;
60
61
  get profile(): ChatParticipant | undefined;
@@ -23,6 +23,7 @@ export declare class RemoteAgent extends Agent {
23
23
  private agentUrl;
24
24
  private _remoteAgentName;
25
25
  private _remoteAgentHash;
26
+ private _isVoiceCallingEnabled;
26
27
  private constructor();
27
28
  get agentName(): string_agent_name;
28
29
  get agentHash(): string_agent_hash;
@@ -31,8 +32,16 @@ export declare class RemoteAgent extends Agent {
31
32
  */
32
33
  callChatModel(prompt: Prompt): Promise<ChatPromptResult>;
33
34
  /**
34
- * Calls the agent on agents remote server with streaming
35
+ * Calls the agent on agents remote server with voice
36
+ * [✨✷] Only available when voice calling is enabled on the server
37
+ * Returns undefined if voice calling is disabled
35
38
  */
39
+ get callVoiceChatModel(): ((audio: Blob, prompt: Prompt) => Promise<{
40
+ text: string;
41
+ audio: Blob;
42
+ userMessage?: string;
43
+ agentMessage?: string;
44
+ }>) | undefined;
36
45
  callChatModelStream(prompt: Prompt, onProgress: (chunk: ChatPromptResult) => void): Promise<ChatPromptResult>;
37
46
  }
38
47
  /**
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Normalizes message text for comparison
3
+ *
4
+ * @param text The message text to normalize
5
+ * @returns The normalized message text
6
+ *
7
+ * @public exported from `@promptbook/utils`
8
+ */
9
+ export declare function normalizeMessageText(text: string): string;
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.103.0-51`).
18
+ * It follows semantic versioning (e.g., `0.103.0-53`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/legacy-documents",
3
- "version": "0.103.0-52",
3
+ "version": "0.103.0-54",
4
4
  "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -95,10 +95,10 @@
95
95
  "module": "./esm/index.es.js",
96
96
  "typings": "./esm/typings/src/_packages/legacy-documents.index.d.ts",
97
97
  "peerDependencies": {
98
- "@promptbook/core": "0.103.0-52"
98
+ "@promptbook/core": "0.103.0-54"
99
99
  },
100
100
  "dependencies": {
101
- "colors": "^1.4.0",
101
+ "colors": "1.4.0",
102
102
  "crypto": "1.0.1",
103
103
  "crypto-js": "4.2.0",
104
104
  "papaparse": "5.4.1",
package/umd/index.umd.js CHANGED
@@ -25,7 +25,7 @@
25
25
  * @generated
26
26
  * @see https://github.com/webgptorg/promptbook
27
27
  */
28
- const PROMPTBOOK_ENGINE_VERSION = '0.103.0-52';
28
+ const PROMPTBOOK_ENGINE_VERSION = '0.103.0-54';
29
29
  /**
30
30
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
31
31
  * Note: [💞] Ignore a discrepancy between file name and entity name