@promptbook/wizard 0.101.0-1 → 0.101.0-10

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 (37) hide show
  1. package/esm/index.es.js +1 -1
  2. package/esm/index.es.js.map +1 -1
  3. package/esm/typings/src/_packages/components.index.d.ts +14 -0
  4. package/esm/typings/src/_packages/core.index.d.ts +2 -0
  5. package/esm/typings/src/_packages/types.index.d.ts +6 -0
  6. package/esm/typings/src/book-2.0/agent-source/AgentBasicInformation.d.ts +41 -3
  7. package/esm/typings/src/book-2.0/agent-source/parseParameters.d.ts +13 -0
  8. package/esm/typings/src/book-2.0/commitments/ACTION/ACTION.d.ts +8 -2
  9. package/esm/typings/src/book-2.0/commitments/DELETE/DELETE.d.ts +59 -0
  10. package/esm/typings/src/book-2.0/commitments/FORMAT/FORMAT.d.ts +8 -2
  11. package/esm/typings/src/book-2.0/commitments/GOAL/GOAL.d.ts +45 -0
  12. package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/KNOWLEDGE.d.ts +1 -1
  13. package/esm/typings/src/book-2.0/commitments/MEMORY/MEMORY.d.ts +46 -0
  14. package/esm/typings/src/book-2.0/commitments/MESSAGE/MESSAGE.d.ts +47 -0
  15. package/esm/typings/src/book-2.0/commitments/META/META.d.ts +62 -0
  16. package/esm/typings/src/book-2.0/commitments/MODEL/MODEL.d.ts +8 -2
  17. package/esm/typings/src/book-2.0/commitments/NOTE/NOTE.d.ts +8 -2
  18. package/esm/typings/src/book-2.0/commitments/PERSONA/PERSONA.d.ts +8 -2
  19. package/esm/typings/src/book-2.0/commitments/SCENARIO/SCENARIO.d.ts +46 -0
  20. package/esm/typings/src/book-2.0/commitments/STYLE/STYLE.d.ts +8 -2
  21. package/esm/typings/src/book-2.0/commitments/index.d.ts +7 -3
  22. package/esm/typings/src/book-components/AvatarProfile/AvatarProfile/MockedChat.d.ts +46 -0
  23. package/esm/typings/src/book-components/AvatarProfile/AvatarProfile/index.d.ts +3 -0
  24. package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts +10 -0
  25. package/esm/typings/src/book-components/BookEditor/BookEditorInner.d.ts +3 -0
  26. package/esm/typings/src/book-components/Chat/Chat/Chat.d.ts +0 -5
  27. package/esm/typings/src/book-components/Chat/Chat/ChatProps.d.ts +28 -2
  28. package/esm/typings/src/book-components/Chat/Chat/constants.d.ts +8 -0
  29. package/esm/typings/src/book-components/icons/ArrowIcon.d.ts +9 -0
  30. package/esm/typings/src/book-components/icons/ResetIcon.d.ts +6 -0
  31. package/esm/typings/src/book-components/icons/SendIcon.d.ts +8 -0
  32. package/esm/typings/src/book-components/icons/TemplateIcon.d.ts +8 -0
  33. package/esm/typings/src/utils/markdown/humanizeAiText.d.ts +1 -0
  34. package/esm/typings/src/version.d.ts +1 -1
  35. package/package.json +2 -2
  36. package/umd/index.umd.js +1 -1
  37. package/umd/index.umd.js.map +1 -1
@@ -7,6 +7,9 @@ import type { AvatarProfileProps } from '../book-components/AvatarProfile/Avatar
7
7
  import { AvatarProfile } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfile';
8
8
  import type { AvatarProfileFromSourceProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
9
9
  import { AvatarProfileFromSource } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
10
+ import type { MockedChatDelayConfig } from '../book-components/AvatarProfile/AvatarProfile/MockedChat';
11
+ import type { MockedChatProps } from '../book-components/AvatarProfile/AvatarProfile/MockedChat';
12
+ import { MockedChat } from '../book-components/AvatarProfile/AvatarProfile/MockedChat';
10
13
  import type { BookEditorProps } from '../book-components/BookEditor/BookEditor';
11
14
  import { BookEditor } from '../book-components/BookEditor/BookEditor';
12
15
  import { DEFAULT_BOOK_FONT_CLASS } from '../book-components/BookEditor/config';
@@ -18,6 +21,10 @@ import type { ChatMessage } from '../book-components/Chat/types/ChatMessage';
18
21
  import type { ChatParticipant } from '../book-components/Chat/types/ChatParticipant';
19
22
  import { renderMarkdown } from '../book-components/Chat/utils/renderMarkdown';
20
23
  import { isMarkdownContent } from '../book-components/Chat/utils/renderMarkdown';
24
+ import { ArrowIcon } from '../book-components/icons/ArrowIcon';
25
+ import { ResetIcon } from '../book-components/icons/ResetIcon';
26
+ import { SendIcon } from '../book-components/icons/SendIcon';
27
+ import { TemplateIcon } from '../book-components/icons/TemplateIcon';
21
28
  export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
22
29
  export type { AvatarChipProps };
23
30
  export { AvatarChip };
@@ -27,6 +34,9 @@ export type { AvatarProfileProps };
27
34
  export { AvatarProfile };
28
35
  export type { AvatarProfileFromSourceProps };
29
36
  export { AvatarProfileFromSource };
37
+ export type { MockedChatDelayConfig };
38
+ export type { MockedChatProps };
39
+ export { MockedChat };
30
40
  export type { BookEditorProps };
31
41
  export { BookEditor };
32
42
  export { DEFAULT_BOOK_FONT_CLASS };
@@ -38,3 +48,7 @@ export type { ChatMessage };
38
48
  export type { ChatParticipant };
39
49
  export { renderMarkdown };
40
50
  export { isMarkdownContent };
51
+ export { ArrowIcon };
52
+ export { ResetIcon };
53
+ export { SendIcon };
54
+ export { TemplateIcon };
@@ -1,6 +1,7 @@
1
1
  import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
2
2
  import { createAgentModelRequirements } from '../book-2.0/agent-source/createAgentModelRequirements';
3
3
  import { parseAgentSource } from '../book-2.0/agent-source/parseAgentSource';
4
+ import { parseParameters } from '../book-2.0/agent-source/parseParameters';
4
5
  import { isValidBook } from '../book-2.0/agent-source/string_book';
5
6
  import { validateBook } from '../book-2.0/agent-source/string_book';
6
7
  import { DEFAULT_BOOK } from '../book-2.0/agent-source/string_book';
@@ -166,6 +167,7 @@ import { REMOTE_SERVER_URLS } from '../../servers';
166
167
  export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
167
168
  export { createAgentModelRequirements };
168
169
  export { parseAgentSource };
170
+ export { parseParameters };
169
171
  export { isValidBook };
170
172
  export { validateBook };
171
173
  export { DEFAULT_BOOK };
@@ -1,3 +1,4 @@
1
+ import type { BookParameter } from '../book-2.0/agent-source/AgentBasicInformation';
1
2
  import type { AgentBasicInformation } from '../book-2.0/agent-source/AgentBasicInformation';
2
3
  import type { AgentModelRequirements } from '../book-2.0/agent-source/AgentModelRequirements';
3
4
  import type { string_book } from '../book-2.0/agent-source/string_book';
@@ -8,6 +9,8 @@ import type { AvatarChipProps } from '../book-components/AvatarProfile/AvatarChi
8
9
  import type { AvatarChipFromSourceProps } from '../book-components/AvatarProfile/AvatarChip/AvatarChipFromSource';
9
10
  import type { AvatarProfileProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfile';
10
11
  import type { AvatarProfileFromSourceProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
12
+ import type { MockedChatDelayConfig } from '../book-components/AvatarProfile/AvatarProfile/MockedChat';
13
+ import type { MockedChatProps } from '../book-components/AvatarProfile/AvatarProfile/MockedChat';
11
14
  import type { BookEditorProps } from '../book-components/BookEditor/BookEditor';
12
15
  import type { ChatProps } from '../book-components/Chat/Chat/ChatProps';
13
16
  import type { LlmChatProps } from '../book-components/Chat/LlmChat/LlmChatProps';
@@ -320,6 +323,7 @@ import type { CheckSerializableAsJsonOptions } from '../utils/serialization/chec
320
323
  import type { ExportJsonOptions } from '../utils/serialization/exportJson';
321
324
  import type { ITakeChain } from '../utils/take/interfaces/ITakeChain';
322
325
  import type { string_promptbook_version } from '../version';
326
+ export type { BookParameter };
323
327
  export type { AgentBasicInformation };
324
328
  export type { AgentModelRequirements };
325
329
  export type { string_book };
@@ -330,6 +334,8 @@ export type { AvatarChipProps };
330
334
  export type { AvatarChipFromSourceProps };
331
335
  export type { AvatarProfileProps };
332
336
  export type { AvatarProfileFromSourceProps };
337
+ export type { MockedChatDelayConfig };
338
+ export type { MockedChatProps };
333
339
  export type { BookEditorProps };
334
340
  export type { ChatProps };
335
341
  export type { LlmChatProps };
@@ -1,4 +1,28 @@
1
1
  import type { string_agent_name, string_url_image } from '../../types/typeAliases';
2
+ /**
3
+ * Unified parameter representation that supports two different notations:
4
+ * 1. @Parameter - single word parameter starting with @
5
+ * 2. {parameterName} or {parameter with multiple words} or {parameterName: description text}
6
+ * Both notations represent the same syntax feature - parameters
7
+ */
8
+ export type BookParameter = {
9
+ /**
10
+ * The raw text of the parameter as it appears in the source
11
+ */
12
+ text: string;
13
+ /**
14
+ * The notation used for this parameter
15
+ */
16
+ notation: 'at' | 'brace';
17
+ /**
18
+ * The parameter name (without @ or {})
19
+ */
20
+ name: string;
21
+ /**
22
+ * Optional description for {parameterName: description} notation
23
+ */
24
+ description?: string;
25
+ };
2
26
  export type AgentBasicInformation = {
3
27
  /**
4
28
  * Name of the agent
@@ -11,10 +35,24 @@ export type AgentBasicInformation = {
11
35
  */
12
36
  personaDescription: string | null;
13
37
  /**
14
- * Optional profile image URL
15
- * This is the line starting with "META IMAGE"
38
+ * Metadata commitments parsed from META lines
39
+ * Each META commitment has the format "META TYPE content"
40
+ * When there are multiple meta commitments of the same type, later overrides earlier
41
+ */
42
+ meta: {
43
+ image?: string_url_image;
44
+ link?: string;
45
+ title?: string;
46
+ description?: string;
47
+ [key: string]: string | undefined;
48
+ };
49
+ /**
50
+ * Parameters found in the agent source
51
+ * Supports two different notations for the same syntax feature:
52
+ * - @Parameter (single word parameter starting with @)
53
+ * - {parameterName} or {parameter with multiple words} or {parameterName: description text}
16
54
  */
17
- profileImageUrl: string_url_image;
55
+ parameters: BookParameter[];
18
56
  };
19
57
  /**
20
58
  * TODO: [🕛] Unite `AgentBasicInformation`, `ChatParticipant`, `LlmExecutionTools` + `LlmToolsMetadata`
@@ -0,0 +1,13 @@
1
+ import type { BookParameter } from './AgentBasicInformation';
2
+ /**
3
+ * Parses parameters from text using both supported notations:
4
+ * 1. @Parameter - single word parameter starting with @
5
+ * 2. {parameterName} or {parameter with multiple words} or {parameterName: description text}
6
+ *
7
+ * Both notations represent the same syntax feature - parameters
8
+ *
9
+ * @param text - Text to extract parameters from
10
+ * @returns Array of parsed parameters with unified representation
11
+ * @public exported from `@promptbook/core`
12
+ */
13
+ export declare function parseParameters(text: string): BookParameter[];
@@ -15,8 +15,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
15
15
  *
16
16
  * @private [🪔] Maybe export the commitments through some package
17
17
  */
18
- export declare class ActionCommitmentDefinition extends BaseCommitmentDefinition<'ACTION'> {
19
- constructor();
18
+ export declare class ActionCommitmentDefinition extends BaseCommitmentDefinition<'ACTION' | 'ACTIONS'> {
19
+ constructor(type?: 'ACTION' | 'ACTIONS');
20
20
  /**
21
21
  * Short one-line description of ACTION.
22
22
  */
@@ -33,6 +33,12 @@ export declare class ActionCommitmentDefinition extends BaseCommitmentDefinition
33
33
  * @private [🪔] Maybe export the commitments through some package
34
34
  */
35
35
  export declare const ActionCommitment: ActionCommitmentDefinition;
36
+ /**
37
+ * Singleton instance of the ACTIONS commitment definition
38
+ *
39
+ * @private [🪔] Maybe export the commitments through some package
40
+ */
41
+ export declare const ActionsCommitment: ActionCommitmentDefinition;
36
42
  /**
37
43
  * Note: [💞] Ignore a discrepancy between file name and entity name
38
44
  */
@@ -0,0 +1,59 @@
1
+ import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
2
+ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
+ /**
4
+ * DELETE commitment definition
5
+ *
6
+ * The DELETE commitment (and its aliases CANCEL, DISCARD, REMOVE) is used to
7
+ * remove or disregard certain information or context. This can be useful for
8
+ * overriding previous commitments or removing unwanted behaviors.
9
+ *
10
+ * Example usage in agent source:
11
+ *
12
+ * ```book
13
+ * DELETE Previous formatting requirements
14
+ * CANCEL All emotional responses
15
+ * DISCARD Technical jargon explanations
16
+ * REMOVE Casual conversational style
17
+ * ```
18
+ *
19
+ * @private [🪔] Maybe export the commitments through some package
20
+ */
21
+ export declare class DeleteCommitmentDefinition extends BaseCommitmentDefinition<'DELETE' | 'CANCEL' | 'DISCARD' | 'REMOVE'> {
22
+ constructor(type: 'DELETE' | 'CANCEL' | 'DISCARD' | 'REMOVE');
23
+ /**
24
+ * Short one-line description of DELETE/CANCEL/DISCARD/REMOVE.
25
+ */
26
+ get description(): string;
27
+ /**
28
+ * Markdown documentation for DELETE commitment.
29
+ */
30
+ get documentation(): string;
31
+ applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
32
+ }
33
+ /**
34
+ * Singleton instances of the DELETE commitment definitions with aliases
35
+ *
36
+ * @private [🪔] Maybe export the commitments through some package
37
+ */
38
+ export declare const DeleteCommitment: DeleteCommitmentDefinition;
39
+ /**
40
+ * Singleton instances of the DELETE commitment definitions with aliases
41
+ *
42
+ * @private [🪔] Maybe export the commitments through some package
43
+ */
44
+ export declare const CancelCommitment: DeleteCommitmentDefinition;
45
+ /**
46
+ * Singleton instances of the DELETE commitment definitions with aliases
47
+ *
48
+ * @private [🪔] Maybe export the commitments through some package
49
+ */
50
+ export declare const DiscardCommitment: DeleteCommitmentDefinition;
51
+ /**
52
+ * Singleton instances of the DELETE commitment definitions with aliases
53
+ *
54
+ * @private [🪔] Maybe export the commitments through some package
55
+ */
56
+ export declare const RemoveCommitment: DeleteCommitmentDefinition;
57
+ /**
58
+ * Note: [💞] Ignore a discrepancy between file name and entity name
59
+ */
@@ -16,8 +16,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
16
16
  *
17
17
  * @private [🪔] Maybe export the commitments through some package
18
18
  */
19
- export declare class FormatCommitmentDefinition extends BaseCommitmentDefinition<'FORMAT'> {
20
- constructor();
19
+ export declare class FormatCommitmentDefinition extends BaseCommitmentDefinition<'FORMAT' | 'FORMATS'> {
20
+ constructor(type?: 'FORMAT' | 'FORMATS');
21
21
  /**
22
22
  * Short one-line description of FORMAT.
23
23
  */
@@ -34,6 +34,12 @@ export declare class FormatCommitmentDefinition extends BaseCommitmentDefinition
34
34
  * @private [🪔] Maybe export the commitments through some package
35
35
  */
36
36
  export declare const FormatCommitment: FormatCommitmentDefinition;
37
+ /**
38
+ * Singleton instance of the FORMATS commitment definition
39
+ *
40
+ * @private [🪔] Maybe export the commitments through some package
41
+ */
42
+ export declare const FormatsCommitment: FormatCommitmentDefinition;
37
43
  /**
38
44
  * Note: [💞] Ignore a discrepancy between file name and entity name
39
45
  */
@@ -0,0 +1,45 @@
1
+ import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
2
+ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
+ /**
4
+ * GOAL commitment definition
5
+ *
6
+ * The GOAL commitment defines the main goal which should be achieved by the AI assistant.
7
+ * There can be multiple goals. Later goals are more important than earlier goals.
8
+ *
9
+ * Example usage in agent source:
10
+ *
11
+ * ```book
12
+ * GOAL Help users understand complex technical concepts
13
+ * GOAL Provide accurate and up-to-date information
14
+ * GOAL Always prioritize user safety and ethical guidelines
15
+ * ```
16
+ *
17
+ * @private [🪔] Maybe export the commitments through some package
18
+ */
19
+ export declare class GoalCommitmentDefinition extends BaseCommitmentDefinition<'GOAL' | 'GOALS'> {
20
+ constructor(type?: 'GOAL' | 'GOALS');
21
+ /**
22
+ * Short one-line description of GOAL.
23
+ */
24
+ get description(): string;
25
+ /**
26
+ * Markdown documentation for GOAL commitment.
27
+ */
28
+ get documentation(): string;
29
+ applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
30
+ }
31
+ /**
32
+ * Singleton instance of the GOAL commitment definition
33
+ *
34
+ * @private [🪔] Maybe export the commitments through some package
35
+ */
36
+ export declare const GoalCommitment: GoalCommitmentDefinition;
37
+ /**
38
+ * Singleton instance of the GOALS commitment definition
39
+ *
40
+ * @private [🪔] Maybe export the commitments through some package
41
+ */
42
+ export declare const GoalsCommitment: GoalCommitmentDefinition;
43
+ /**
44
+ * Note: [💞] Ignore a discrepancy between file name and entity name
45
+ */
@@ -35,7 +35,7 @@ export declare class KnowledgeCommitmentDefinition extends BaseCommitmentDefinit
35
35
  private isUrl;
36
36
  }
37
37
  /**
38
- * Singleton instance of the KNOWLEDGE commitment definition
38
+ * Singleton instance of the KNOWLEDGE commitment definition !!!!
39
39
  *
40
40
  * @private [🪔] Maybe export the commitments through some package
41
41
  */
@@ -0,0 +1,46 @@
1
+ import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
2
+ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
+ /**
4
+ * MEMORY commitment definition
5
+ *
6
+ * The MEMORY commitment is similar to KNOWLEDGE but has a focus on remembering past
7
+ * interactions and user preferences. It helps the agent maintain context about the
8
+ * user's history, preferences, and previous conversations.
9
+ *
10
+ * Example usage in agent source:
11
+ *
12
+ * ```book
13
+ * MEMORY User prefers detailed technical explanations
14
+ * MEMORY Previously worked on React projects
15
+ * MEMORY Timezone: UTC-5 (Eastern Time)
16
+ * ```
17
+ *
18
+ * @private [🪔] Maybe export the commitments through some package
19
+ */
20
+ export declare class MemoryCommitmentDefinition extends BaseCommitmentDefinition<'MEMORY' | 'MEMORIES'> {
21
+ constructor(type?: 'MEMORY' | 'MEMORIES');
22
+ /**
23
+ * Short one-line description of MEMORY.
24
+ */
25
+ get description(): string;
26
+ /**
27
+ * Markdown documentation for MEMORY commitment.
28
+ */
29
+ get documentation(): string;
30
+ applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
31
+ }
32
+ /**
33
+ * Singleton instance of the MEMORY commitment definition
34
+ *
35
+ * @private [🪔] Maybe export the commitments through some package
36
+ */
37
+ export declare const MemoryCommitment: MemoryCommitmentDefinition;
38
+ /**
39
+ * Singleton instance of the MEMORIES commitment definition
40
+ *
41
+ * @private [🪔] Maybe export the commitments through some package
42
+ */
43
+ export declare const MemoriesCommitment: MemoryCommitmentDefinition;
44
+ /**
45
+ * Note: [💞] Ignore a discrepancy between file name and entity name
46
+ */
@@ -0,0 +1,47 @@
1
+ import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
2
+ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
+ /**
4
+ * MESSAGE commitment definition
5
+ *
6
+ * The MESSAGE commitment contains 1:1 text of the message which AI assistant already
7
+ * sent during the conversation. Later messages are later in the conversation.
8
+ * It is similar to EXAMPLE but it is not example, it is the real message which
9
+ * AI assistant already sent.
10
+ *
11
+ * Example usage in agent source:
12
+ *
13
+ * ```book
14
+ * MESSAGE Hello! How can I help you today?
15
+ * MESSAGE I understand you're looking for information about our services.
16
+ * MESSAGE Based on your requirements, I'd recommend our premium package.
17
+ * ```
18
+ *
19
+ * @private [🪔] Maybe export the commitments through some package
20
+ */
21
+ export declare class MessageCommitmentDefinition extends BaseCommitmentDefinition<'MESSAGE' | 'MESSAGES'> {
22
+ constructor(type?: 'MESSAGE' | 'MESSAGES');
23
+ /**
24
+ * Short one-line description of MESSAGE.
25
+ */
26
+ get description(): string;
27
+ /**
28
+ * Markdown documentation for MESSAGE commitment.
29
+ */
30
+ get documentation(): string;
31
+ applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
32
+ }
33
+ /**
34
+ * Singleton instance of the MESSAGE commitment definition
35
+ *
36
+ * @private [🪔] Maybe export the commitments through some package
37
+ */
38
+ export declare const MessageCommitment: MessageCommitmentDefinition;
39
+ /**
40
+ * Singleton instance of the MESSAGES commitment definition
41
+ *
42
+ * @private [🪔] Maybe export the commitments through some package
43
+ */
44
+ export declare const MessagesCommitment: MessageCommitmentDefinition;
45
+ /**
46
+ * Note: [💞] Ignore a discrepancy between file name and entity name
47
+ */
@@ -0,0 +1,62 @@
1
+ import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
2
+ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
+ /**
4
+ * META commitment definition
5
+ *
6
+ * The META commitment handles all meta-information about the agent such as:
7
+ * - META IMAGE: Sets the agent's avatar/profile image URL
8
+ * - META LINK: Provides profile/source links for the person the agent models
9
+ * - META TITLE: Sets the agent's display title
10
+ * - META DESCRIPTION: Sets the agent's description
11
+ * - META [ANYTHING]: Any other meta information in uppercase format
12
+ *
13
+ * These commitments are special because they don't affect the system message,
14
+ * but are handled separately in the parsing logic for profile display.
15
+ *
16
+ * Example usage in agent source:
17
+ *
18
+ * ```book
19
+ * META IMAGE https://example.com/avatar.jpg
20
+ * META LINK https://twitter.com/username
21
+ * META TITLE Professional Assistant
22
+ * META DESCRIPTION An AI assistant specialized in business tasks
23
+ * META AUTHOR John Doe
24
+ * META VERSION 1.0
25
+ * ```
26
+ *
27
+ * @private [🪔] Maybe export the commitments through some package
28
+ */
29
+ export declare class MetaCommitmentDefinition extends BaseCommitmentDefinition<`META${string}`> {
30
+ constructor();
31
+ /**
32
+ * Short one-line description of META commitments.
33
+ */
34
+ get description(): string;
35
+ /**
36
+ * Markdown documentation for META commitment.
37
+ */
38
+ get documentation(): string;
39
+ applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
40
+ /**
41
+ * Extracts meta information from the content based on the meta type
42
+ * This is used by the parsing logic
43
+ */
44
+ extractMetaValue(metaType: string, content: string): string | null;
45
+ /**
46
+ * Validates if the provided content is a valid URL (for IMAGE and LINK types)
47
+ */
48
+ isValidUrl(content: string): boolean;
49
+ /**
50
+ * Checks if this is a known meta type
51
+ */
52
+ isKnownMetaType(metaType: string): boolean;
53
+ }
54
+ /**
55
+ * Singleton instance of the META commitment definition
56
+ *
57
+ * @private [🪔] Maybe export the commitments through some package
58
+ */
59
+ export declare const MetaCommitment: MetaCommitmentDefinition;
60
+ /**
61
+ * Note: [💞] Ignore a discrepancy between file name and entity name
62
+ */
@@ -16,8 +16,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
16
16
  *
17
17
  * @private [🪔] Maybe export the commitments through some package
18
18
  */
19
- export declare class ModelCommitmentDefinition extends BaseCommitmentDefinition<'MODEL'> {
20
- constructor();
19
+ export declare class ModelCommitmentDefinition extends BaseCommitmentDefinition<'MODEL' | 'MODELS'> {
20
+ constructor(type?: 'MODEL' | 'MODELS');
21
21
  /**
22
22
  * Short one-line description of MODEL.
23
23
  */
@@ -34,6 +34,12 @@ export declare class ModelCommitmentDefinition extends BaseCommitmentDefinition<
34
34
  * @private [🪔] Maybe export the commitments through some package
35
35
  */
36
36
  export declare const ModelCommitment: ModelCommitmentDefinition;
37
+ /**
38
+ * Singleton instance of the MODELS commitment definition
39
+ *
40
+ * @private [🪔] Maybe export the commitments through some package
41
+ */
42
+ export declare const ModelsCommitment: ModelCommitmentDefinition;
37
43
  /**
38
44
  * Note: [💞] Ignore a discrepancy between file name and entity name
39
45
  */
@@ -26,8 +26,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
26
26
  *
27
27
  * @private [🪔] Maybe export the commitments through some package
28
28
  */
29
- export declare class NoteCommitmentDefinition extends BaseCommitmentDefinition<'NOTE'> {
30
- constructor();
29
+ export declare class NoteCommitmentDefinition extends BaseCommitmentDefinition<'NOTE' | 'NOTES'> {
30
+ constructor(type?: 'NOTE' | 'NOTES');
31
31
  /**
32
32
  * Short one-line description of NOTE.
33
33
  */
@@ -44,6 +44,12 @@ export declare class NoteCommitmentDefinition extends BaseCommitmentDefinition<'
44
44
  * @private [🪔] Maybe export the commitments through some package
45
45
  */
46
46
  export declare const NoteCommitment: NoteCommitmentDefinition;
47
+ /**
48
+ * Singleton instance of the NOTES commitment definition
49
+ *
50
+ * @private [🪔] Maybe export the commitments through some package
51
+ */
52
+ export declare const NotesCommitment: NoteCommitmentDefinition;
47
53
  /**
48
54
  * [💞] Ignore a discrepancy between file name and entity name
49
55
  */
@@ -23,8 +23,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
23
23
  *
24
24
  * @private [🪔] Maybe export the commitments through some package
25
25
  */
26
- export declare class PersonaCommitmentDefinition extends BaseCommitmentDefinition<'PERSONA'> {
27
- constructor();
26
+ export declare class PersonaCommitmentDefinition extends BaseCommitmentDefinition<'PERSONA' | 'PERSONAE'> {
27
+ constructor(type?: 'PERSONA' | 'PERSONAE');
28
28
  /**
29
29
  * Short one-line description of PERSONA.
30
30
  */
@@ -41,6 +41,12 @@ export declare class PersonaCommitmentDefinition extends BaseCommitmentDefinitio
41
41
  * @private [🪔] Maybe export the commitments through some package
42
42
  */
43
43
  export declare const PersonaCommitment: PersonaCommitmentDefinition;
44
+ /**
45
+ * Singleton instance of the PERSONAE commitment definition
46
+ *
47
+ * @private [🪔] Maybe export the commitments through some package
48
+ */
49
+ export declare const PersonaeCommitment: PersonaCommitmentDefinition;
44
50
  /**
45
51
  * Note: [💞] Ignore a discrepancy between file name and entity name
46
52
  */
@@ -0,0 +1,46 @@
1
+ import type { AgentModelRequirements } from '../../agent-source/AgentModelRequirements';
2
+ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
+ /**
4
+ * SCENARIO commitment definition
5
+ *
6
+ * The SCENARIO commitment defines a specific situation or context in which the AI
7
+ * assistant should operate. It helps to set the scene for the AI's responses.
8
+ * Later scenarios are more important than earlier scenarios.
9
+ *
10
+ * Example usage in agent source:
11
+ *
12
+ * ```book
13
+ * SCENARIO You are in a customer service call center during peak hours
14
+ * SCENARIO The customer is frustrated and has been on hold for 20 minutes
15
+ * SCENARIO This is the customer's third call about the same issue
16
+ * ```
17
+ *
18
+ * @private [🪔] Maybe export the commitments through some package
19
+ */
20
+ export declare class ScenarioCommitmentDefinition extends BaseCommitmentDefinition<'SCENARIO' | 'SCENARIOS'> {
21
+ constructor(type?: 'SCENARIO' | 'SCENARIOS');
22
+ /**
23
+ * Short one-line description of SCENARIO.
24
+ */
25
+ get description(): string;
26
+ /**
27
+ * Markdown documentation for SCENARIO commitment.
28
+ */
29
+ get documentation(): string;
30
+ applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
31
+ }
32
+ /**
33
+ * Singleton instance of the SCENARIO commitment definition
34
+ *
35
+ * @private [🪔] Maybe export the commitments through some package
36
+ */
37
+ export declare const ScenarioCommitment: ScenarioCommitmentDefinition;
38
+ /**
39
+ * Singleton instance of the SCENARIOS commitment definition
40
+ *
41
+ * @private [🪔] Maybe export the commitments through some package
42
+ */
43
+ export declare const ScenariosCommitment: ScenarioCommitmentDefinition;
44
+ /**
45
+ * Note: [💞] Ignore a discrepancy between file name and entity name
46
+ */
@@ -15,8 +15,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
15
15
  *
16
16
  * @private [🪔] Maybe export the commitments through some package
17
17
  */
18
- export declare class StyleCommitmentDefinition extends BaseCommitmentDefinition<'STYLE'> {
19
- constructor();
18
+ export declare class StyleCommitmentDefinition extends BaseCommitmentDefinition<'STYLE' | 'STYLES'> {
19
+ constructor(type?: 'STYLE' | 'STYLES');
20
20
  /**
21
21
  * Short one-line description of STYLE.
22
22
  */
@@ -33,6 +33,12 @@ export declare class StyleCommitmentDefinition extends BaseCommitmentDefinition<
33
33
  * @private [🪔] Maybe export the commitments through some package
34
34
  */
35
35
  export declare const StyleCommitment: StyleCommitmentDefinition;
36
+ /**
37
+ * Singleton instance of the STYLES commitment definition
38
+ *
39
+ * @private [🪔] Maybe export the commitments through some package
40
+ */
41
+ export declare const StylesCommitment: StyleCommitmentDefinition;
36
42
  /**
37
43
  * [💞] Ignore a discrepancy between file name and entity name
38
44
  */
@@ -1,15 +1,19 @@
1
1
  import type { BookCommitment } from './_base/BookCommitment';
2
2
  import type { CommitmentDefinition } from './_base/CommitmentDefinition';
3
3
  import { ActionCommitmentDefinition } from './ACTION/ACTION';
4
+ import { DeleteCommitmentDefinition } from './DELETE/DELETE';
4
5
  import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
6
+ import { GoalCommitmentDefinition } from './GOAL/GOAL';
5
7
  import { KnowledgeCommitmentDefinition } from './KNOWLEDGE/KNOWLEDGE';
6
- import { MetaImageCommitmentDefinition } from './META_IMAGE/META_IMAGE';
7
- import { MetaLinkCommitmentDefinition } from './META_LINK/META_LINK';
8
+ import { MemoryCommitmentDefinition } from './MEMORY/MEMORY';
9
+ import { MessageCommitmentDefinition } from './MESSAGE/MESSAGE';
10
+ import { MetaCommitmentDefinition } from './META/META';
8
11
  import { ModelCommitmentDefinition } from './MODEL/MODEL';
9
12
  import { NoteCommitmentDefinition } from './NOTE/NOTE';
10
13
  import { PersonaCommitmentDefinition } from './PERSONA/PERSONA';
11
14
  import { RuleCommitmentDefinition } from './RULE/RULE';
12
15
  import { SampleCommitmentDefinition } from './SAMPLE/SAMPLE';
16
+ import { ScenarioCommitmentDefinition } from './SCENARIO/SCENARIO';
13
17
  import { StyleCommitmentDefinition } from './STYLE/STYLE';
14
18
  import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplementedCommitmentDefinition';
15
19
  /**
@@ -19,7 +23,7 @@ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplemented
19
23
  *
20
24
  * @private Use functions to access commitments instead of this array directly
21
25
  */
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">];
26
+ export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
23
27
  /**
24
28
  * Gets a commitment definition by its type
25
29
  * @param type The commitment type to look up