@promptbook/wizard 0.103.0-53 → 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 (30) hide show
  1. package/esm/index.es.js +127 -1
  2. package/esm/index.es.js.map +1 -1
  3. package/esm/typings/src/commitments/ACTION/ACTION.d.ts +4 -0
  4. package/esm/typings/src/commitments/DELETE/DELETE.d.ts +4 -0
  5. package/esm/typings/src/commitments/FORMAT/FORMAT.d.ts +4 -0
  6. package/esm/typings/src/commitments/GOAL/GOAL.d.ts +4 -0
  7. package/esm/typings/src/commitments/KNOWLEDGE/KNOWLEDGE.d.ts +4 -0
  8. package/esm/typings/src/commitments/MEMORY/MEMORY.d.ts +4 -0
  9. package/esm/typings/src/commitments/MESSAGE/AgentMessageCommitmentDefinition.d.ts +4 -0
  10. package/esm/typings/src/commitments/MESSAGE/InitialMessageCommitmentDefinition.d.ts +4 -0
  11. package/esm/typings/src/commitments/MESSAGE/MESSAGE.d.ts +4 -0
  12. package/esm/typings/src/commitments/MESSAGE/UserMessageCommitmentDefinition.d.ts +4 -0
  13. package/esm/typings/src/commitments/META/META.d.ts +4 -0
  14. package/esm/typings/src/commitments/META_COLOR/META_COLOR.d.ts +4 -0
  15. package/esm/typings/src/commitments/META_IMAGE/META_IMAGE.d.ts +4 -0
  16. package/esm/typings/src/commitments/META_LINK/META_LINK.d.ts +4 -0
  17. package/esm/typings/src/commitments/MODEL/MODEL.d.ts +4 -0
  18. package/esm/typings/src/commitments/NOTE/NOTE.d.ts +4 -0
  19. package/esm/typings/src/commitments/PERSONA/PERSONA.d.ts +4 -0
  20. package/esm/typings/src/commitments/RULE/RULE.d.ts +4 -0
  21. package/esm/typings/src/commitments/SAMPLE/SAMPLE.d.ts +4 -0
  22. package/esm/typings/src/commitments/SCENARIO/SCENARIO.d.ts +4 -0
  23. package/esm/typings/src/commitments/STYLE/STYLE.d.ts +4 -0
  24. package/esm/typings/src/commitments/_base/BaseCommitmentDefinition.d.ts +5 -0
  25. package/esm/typings/src/commitments/_base/CommitmentDefinition.d.ts +5 -0
  26. package/esm/typings/src/commitments/_base/NotYetImplementedCommitmentDefinition.d.ts +4 -0
  27. package/esm/typings/src/version.d.ts +1 -1
  28. package/package.json +3 -3
  29. package/umd/index.umd.js +127 -1
  30. package/umd/index.umd.js.map +1 -1
@@ -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
  */
@@ -20,6 +20,10 @@ export declare class AgentMessageCommitmentDefinition extends BaseCommitmentDefi
20
20
  * Short one-line description of AGENT 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 AGENT MESSAGE commitment.
25
29
  */
@@ -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
  */
@@ -20,6 +20,10 @@ export declare class UserMessageCommitmentDefinition extends BaseCommitmentDefin
20
20
  * Short one-line description of USER 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 USER MESSAGE commitment.
25
29
  */
@@ -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
  */
@@ -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-52`).
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/wizard",
3
- "version": "0.103.0-53",
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,7 +95,7 @@
95
95
  "module": "./esm/index.es.js",
96
96
  "typings": "./esm/typings/src/_packages/wizard.index.d.ts",
97
97
  "peerDependencies": {
98
- "@promptbook/core": "0.103.0-53"
98
+ "@promptbook/core": "0.103.0-54"
99
99
  },
100
100
  "dependencies": {
101
101
  "@ai-sdk/deepseek": "0.1.17",
@@ -104,7 +104,7 @@
104
104
  "@azure/openai": "1.0.0-beta.13",
105
105
  "@mozilla/readability": "0.6.0",
106
106
  "bottleneck": "2.19.5",
107
- "colors": "^1.4.0",
107
+ "colors": "1.4.0",
108
108
  "crypto": "1.0.1",
109
109
  "crypto-js": "4.2.0",
110
110
  "dotenv": "16.3.2",
package/umd/index.umd.js CHANGED
@@ -48,7 +48,7 @@
48
48
  * @generated
49
49
  * @see https://github.com/webgptorg/promptbook
50
50
  */
51
- const PROMPTBOOK_ENGINE_VERSION = '0.103.0-53';
51
+ const PROMPTBOOK_ENGINE_VERSION = '0.103.0-54';
52
52
  /**
53
53
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
54
54
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -13570,6 +13570,12 @@
13570
13570
  get description() {
13571
13571
  return 'Define agent capabilities and actions it can perform.';
13572
13572
  }
13573
+ /**
13574
+ * Icon for this commitment.
13575
+ */
13576
+ get icon() {
13577
+ return '⚡';
13578
+ }
13573
13579
  /**
13574
13580
  * Markdown documentation for ACTION commitment.
13575
13581
  */
@@ -13649,6 +13655,12 @@
13649
13655
  get description() {
13650
13656
  return 'Remove or **disregard** certain information, context, or previous commitments.';
13651
13657
  }
13658
+ /**
13659
+ * Icon for this commitment.
13660
+ */
13661
+ get icon() {
13662
+ return 'đŸ—‘ī¸';
13663
+ }
13652
13664
  /**
13653
13665
  * Markdown documentation for DELETE commitment.
13654
13666
  */
@@ -13765,6 +13777,12 @@
13765
13777
  get description() {
13766
13778
  return 'Specify output structure or formatting requirements.';
13767
13779
  }
13780
+ /**
13781
+ * Icon for this commitment.
13782
+ */
13783
+ get icon() {
13784
+ return '📜';
13785
+ }
13768
13786
  /**
13769
13787
  * Markdown documentation for FORMAT commitment.
13770
13788
  */
@@ -13840,6 +13858,12 @@
13840
13858
  get description() {
13841
13859
  return 'Define main **goals** the AI assistant should achieve, with later goals having higher priority.';
13842
13860
  }
13861
+ /**
13862
+ * Icon for this commitment.
13863
+ */
13864
+ get icon() {
13865
+ return 'đŸŽ¯';
13866
+ }
13843
13867
  /**
13844
13868
  * Markdown documentation for GOAL commitment.
13845
13869
  */
@@ -13936,6 +13960,12 @@
13936
13960
  get description() {
13937
13961
  return 'Add domain **knowledge** via direct text or external sources (RAG).';
13938
13962
  }
13963
+ /**
13964
+ * Icon for this commitment.
13965
+ */
13966
+ get icon() {
13967
+ return '🧠';
13968
+ }
13939
13969
  /**
13940
13970
  * Markdown documentation for KNOWLEDGE commitment.
13941
13971
  */
@@ -14037,6 +14067,12 @@
14037
14067
  get description() {
14038
14068
  return 'Remember past interactions and user **preferences** for personalized responses.';
14039
14069
  }
14070
+ /**
14071
+ * Icon for this commitment.
14072
+ */
14073
+ get icon() {
14074
+ return '🧠';
14075
+ }
14040
14076
  /**
14041
14077
  * Markdown documentation for MEMORY commitment.
14042
14078
  */
@@ -14135,6 +14171,12 @@
14135
14171
  get description() {
14136
14172
  return 'Defines a **message from the agent** in the conversation history.';
14137
14173
  }
14174
+ /**
14175
+ * Icon for this commitment.
14176
+ */
14177
+ get icon() {
14178
+ return '🤖';
14179
+ }
14138
14180
  /**
14139
14181
  * Markdown documentation for AGENT MESSAGE commitment.
14140
14182
  */
@@ -14206,6 +14248,12 @@
14206
14248
  get description() {
14207
14249
  return 'Defines the **initial message** shown to the user when the chat starts.';
14208
14250
  }
14251
+ /**
14252
+ * Icon for this commitment.
14253
+ */
14254
+ get icon() {
14255
+ return '👋';
14256
+ }
14209
14257
  /**
14210
14258
  * Markdown documentation for INITIAL MESSAGE commitment.
14211
14259
  */
@@ -14264,6 +14312,12 @@
14264
14312
  get description() {
14265
14313
  return 'Include actual **messages** the AI assistant has sent during conversation history.';
14266
14314
  }
14315
+ /**
14316
+ * Icon for this commitment.
14317
+ */
14318
+ get icon() {
14319
+ return 'đŸ’Ŧ';
14320
+ }
14267
14321
  /**
14268
14322
  * Markdown documentation for MESSAGE commitment.
14269
14323
  */
@@ -14370,6 +14424,12 @@
14370
14424
  get description() {
14371
14425
  return 'Defines a **message from the user** in the conversation history.';
14372
14426
  }
14427
+ /**
14428
+ * Icon for this commitment.
14429
+ */
14430
+ get icon() {
14431
+ return '🧑';
14432
+ }
14373
14433
  /**
14374
14434
  * Markdown documentation for USER MESSAGE commitment.
14375
14435
  */
@@ -14443,6 +14503,12 @@
14443
14503
  get description() {
14444
14504
  return 'Set meta-information about the agent (IMAGE, LINK, TITLE, DESCRIPTION, etc.).';
14445
14505
  }
14506
+ /**
14507
+ * Icon for this commitment.
14508
+ */
14509
+ get icon() {
14510
+ return 'â„šī¸';
14511
+ }
14446
14512
  /**
14447
14513
  * Markdown documentation for META commitment.
14448
14514
  */
@@ -14570,6 +14636,12 @@
14570
14636
  get description() {
14571
14637
  return "Set the agent's accent color.";
14572
14638
  }
14639
+ /**
14640
+ * Icon for this commitment.
14641
+ */
14642
+ get icon() {
14643
+ return '🎨';
14644
+ }
14573
14645
  /**
14574
14646
  * Markdown documentation for META COLOR commitment.
14575
14647
  */
@@ -14648,6 +14720,12 @@
14648
14720
  get description() {
14649
14721
  return "Set the agent's profile image URL.";
14650
14722
  }
14723
+ /**
14724
+ * Icon for this commitment.
14725
+ */
14726
+ get icon() {
14727
+ return 'đŸ–ŧī¸';
14728
+ }
14651
14729
  /**
14652
14730
  * Markdown documentation for META IMAGE commitment.
14653
14731
  */
@@ -14738,6 +14816,12 @@
14738
14816
  get description() {
14739
14817
  return 'Enforce AI model requirements including name and technical parameters.';
14740
14818
  }
14819
+ /**
14820
+ * Icon for this commitment.
14821
+ */
14822
+ get icon() {
14823
+ return 'âš™ī¸';
14824
+ }
14741
14825
  /**
14742
14826
  * Markdown documentation for MODEL commitment.
14743
14827
  */
@@ -14973,6 +15057,12 @@
14973
15057
  get description() {
14974
15058
  return 'Add developer-facing notes without changing behavior or output.';
14975
15059
  }
15060
+ /**
15061
+ * Icon for this commitment.
15062
+ */
15063
+ get icon() {
15064
+ return '📝';
15065
+ }
14976
15066
  /**
14977
15067
  * Markdown documentation for NOTE commitment.
14978
15068
  */
@@ -15075,6 +15165,12 @@
15075
15165
  get description() {
15076
15166
  return 'Define who the agent is: background, expertise, and personality.';
15077
15167
  }
15168
+ /**
15169
+ * Icon for this commitment.
15170
+ */
15171
+ get icon() {
15172
+ return '👤';
15173
+ }
15078
15174
  /**
15079
15175
  * Markdown documentation for PERSONA commitment.
15080
15176
  */
@@ -15202,6 +15298,12 @@
15202
15298
  get description() {
15203
15299
  return 'Add behavioral rules the agent must follow.';
15204
15300
  }
15301
+ /**
15302
+ * Icon for this commitment.
15303
+ */
15304
+ get icon() {
15305
+ return 'âš–ī¸';
15306
+ }
15205
15307
  /**
15206
15308
  * Markdown documentation for RULE/RULES commitment.
15207
15309
  */
@@ -15278,6 +15380,12 @@
15278
15380
  get description() {
15279
15381
  return 'Provide example responses to guide behavior.';
15280
15382
  }
15383
+ /**
15384
+ * Icon for this commitment.
15385
+ */
15386
+ get icon() {
15387
+ return '🔍';
15388
+ }
15281
15389
  /**
15282
15390
  * Markdown documentation for SAMPLE/EXAMPLE commitment.
15283
15391
  */
@@ -15355,6 +15463,12 @@
15355
15463
  get description() {
15356
15464
  return 'Define specific **situations** or contexts for AI responses, with later scenarios having higher priority.';
15357
15465
  }
15466
+ /**
15467
+ * Icon for this commitment.
15468
+ */
15469
+ get icon() {
15470
+ return '🎭';
15471
+ }
15358
15472
  /**
15359
15473
  * Markdown documentation for SCENARIO commitment.
15360
15474
  */
@@ -15471,6 +15585,12 @@
15471
15585
  get description() {
15472
15586
  return 'Control the tone and writing style of responses.';
15473
15587
  }
15588
+ /**
15589
+ * Icon for this commitment.
15590
+ */
15591
+ get icon() {
15592
+ return 'đŸ–‹ī¸';
15593
+ }
15474
15594
  /**
15475
15595
  * Markdown documentation for STYLE commitment.
15476
15596
  */
@@ -15540,6 +15660,12 @@
15540
15660
  get description() {
15541
15661
  return 'Placeholder commitment that appends content verbatim to the system message.';
15542
15662
  }
15663
+ /**
15664
+ * Icon for this commitment.
15665
+ */
15666
+ get icon() {
15667
+ return '🚧';
15668
+ }
15543
15669
  /**
15544
15670
  * Markdown documentation available at runtime.
15545
15671
  */