@promptbook/utils 0.103.0-52 → 0.103.0-53

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 (24) hide show
  1. package/esm/index.es.js +14 -2
  2. package/esm/index.es.js.map +1 -1
  3. package/esm/typings/servers.d.ts +8 -1
  4. package/esm/typings/src/_packages/components.index.d.ts +2 -0
  5. package/esm/typings/src/_packages/core.index.d.ts +6 -0
  6. package/esm/typings/src/_packages/types.index.d.ts +2 -0
  7. package/esm/typings/src/_packages/utils.index.d.ts +2 -0
  8. package/esm/typings/src/book-2.0/agent-source/AgentModelRequirements.d.ts +7 -0
  9. package/esm/typings/src/book-components/Chat/Chat/ChatProps.d.ts +4 -0
  10. package/esm/typings/src/book-components/_common/HamburgerMenu/HamburgerMenu.d.ts +12 -0
  11. package/esm/typings/src/book-components/icons/MicIcon.d.ts +8 -0
  12. package/esm/typings/src/collection/agent-collection/constructors/agent-collection-in-supabase/AgentCollectionInSupabase.d.ts +17 -0
  13. package/esm/typings/src/commitments/MESSAGE/AgentMessageCommitmentDefinition.d.ts +28 -0
  14. package/esm/typings/src/commitments/MESSAGE/UserMessageCommitmentDefinition.d.ts +28 -0
  15. package/esm/typings/src/commitments/index.d.ts +20 -1
  16. package/esm/typings/src/execution/LlmExecutionTools.d.ts +9 -0
  17. package/esm/typings/src/llm-providers/agent/AgentLlmExecutionTools.d.ts +2 -1
  18. package/esm/typings/src/llm-providers/agent/RemoteAgent.d.ts +10 -1
  19. package/esm/typings/src/utils/normalization/normalizeMessageText.d.ts +9 -0
  20. package/esm/typings/src/utils/normalization/normalizeMessageText.test.d.ts +1 -0
  21. package/esm/typings/src/version.d.ts +1 -1
  22. package/package.json +1 -1
  23. package/umd/index.umd.js +14 -1
  24. package/umd/index.umd.js.map +1 -1
@@ -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
  *
@@ -0,0 +1,28 @@
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
+ * Markdown documentation for AGENT MESSAGE commitment.
25
+ */
26
+ get documentation(): string;
27
+ applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
28
+ }
@@ -0,0 +1,28 @@
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
+ * Markdown documentation for USER MESSAGE commitment.
25
+ */
26
+ get documentation(): string;
27
+ applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
28
+ }
@@ -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-52`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/utils",
3
- "version": "0.103.0-52",
3
+ "version": "0.103.0-53",
4
4
  "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
5
5
  "private": false,
6
6
  "sideEffects": false,
package/umd/index.umd.js CHANGED
@@ -23,7 +23,7 @@
23
23
  * @generated
24
24
  * @see https://github.com/webgptorg/promptbook
25
25
  */
26
- const PROMPTBOOK_ENGINE_VERSION = '0.103.0-52';
26
+ const PROMPTBOOK_ENGINE_VERSION = '0.103.0-53';
27
27
  /**
28
28
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
29
29
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -3217,6 +3217,18 @@
3217
3217
  .filter((value) => value !== '');
3218
3218
  }
3219
3219
 
3220
+ /**
3221
+ * Normalizes message text for comparison
3222
+ *
3223
+ * @param text The message text to normalize
3224
+ * @returns The normalized message text
3225
+ *
3226
+ * @public exported from `@promptbook/utils`
3227
+ */
3228
+ function normalizeMessageText(text) {
3229
+ return spaceTrim$1.spaceTrim(text);
3230
+ }
3231
+
3220
3232
  /**
3221
3233
  * Normalizes a given text to PascalCase format.
3222
3234
  *
@@ -3904,6 +3916,7 @@
3904
3916
  exports.jsonStringsToJsons = jsonStringsToJsons;
3905
3917
  exports.nameToUriPart = nameToUriPart;
3906
3918
  exports.nameToUriParts = nameToUriParts;
3919
+ exports.normalizeMessageText = normalizeMessageText;
3907
3920
  exports.normalizeToKebabCase = normalizeToKebabCase;
3908
3921
  exports.normalizeTo_PascalCase = normalizeTo_PascalCase;
3909
3922
  exports.normalizeTo_SCREAMING_CASE = normalizeTo_SCREAMING_CASE;