@promptbook/components 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/components",
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,
@@ -97,7 +97,7 @@
97
97
  "dependencies": {
98
98
  "@monaco-editor/react": "4.7.0",
99
99
  "bottleneck": "2.19.5",
100
- "colors": "^1.4.0",
100
+ "colors": "1.4.0",
101
101
  "crypto": "1.0.1",
102
102
  "crypto-js": "4.2.0",
103
103
  "destroyable": "0.12.141",
@@ -105,7 +105,7 @@
105
105
  "katex": "0.16.25",
106
106
  "openai": "4.63.0",
107
107
  "papaparse": "5.4.1",
108
- "qrcode": "^1.5.4",
108
+ "qrcode": "1.5.4",
109
109
  "rxjs": "7.8.2",
110
110
  "showdown": "2.1.0",
111
111
  "spacetrim": "0.11.60",
package/umd/index.umd.js CHANGED
@@ -31,7 +31,7 @@
31
31
  * @generated
32
32
  * @see https://github.com/webgptorg/promptbook
33
33
  */
34
- const PROMPTBOOK_ENGINE_VERSION = '0.103.0-53';
34
+ const PROMPTBOOK_ENGINE_VERSION = '0.103.0-54';
35
35
  /**
36
36
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
37
37
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -3718,6 +3718,12 @@
3718
3718
  get description() {
3719
3719
  return 'Define agent capabilities and actions it can perform.';
3720
3720
  }
3721
+ /**
3722
+ * Icon for this commitment.
3723
+ */
3724
+ get icon() {
3725
+ return '⚡';
3726
+ }
3721
3727
  /**
3722
3728
  * Markdown documentation for ACTION commitment.
3723
3729
  */
@@ -3797,6 +3803,12 @@
3797
3803
  get description() {
3798
3804
  return 'Remove or **disregard** certain information, context, or previous commitments.';
3799
3805
  }
3806
+ /**
3807
+ * Icon for this commitment.
3808
+ */
3809
+ get icon() {
3810
+ return 'đŸ—‘ī¸';
3811
+ }
3800
3812
  /**
3801
3813
  * Markdown documentation for DELETE commitment.
3802
3814
  */
@@ -3913,6 +3925,12 @@
3913
3925
  get description() {
3914
3926
  return 'Specify output structure or formatting requirements.';
3915
3927
  }
3928
+ /**
3929
+ * Icon for this commitment.
3930
+ */
3931
+ get icon() {
3932
+ return '📜';
3933
+ }
3916
3934
  /**
3917
3935
  * Markdown documentation for FORMAT commitment.
3918
3936
  */
@@ -3988,6 +4006,12 @@
3988
4006
  get description() {
3989
4007
  return 'Define main **goals** the AI assistant should achieve, with later goals having higher priority.';
3990
4008
  }
4009
+ /**
4010
+ * Icon for this commitment.
4011
+ */
4012
+ get icon() {
4013
+ return 'đŸŽ¯';
4014
+ }
3991
4015
  /**
3992
4016
  * Markdown documentation for GOAL commitment.
3993
4017
  */
@@ -4084,6 +4108,12 @@
4084
4108
  get description() {
4085
4109
  return 'Add domain **knowledge** via direct text or external sources (RAG).';
4086
4110
  }
4111
+ /**
4112
+ * Icon for this commitment.
4113
+ */
4114
+ get icon() {
4115
+ return '🧠';
4116
+ }
4087
4117
  /**
4088
4118
  * Markdown documentation for KNOWLEDGE commitment.
4089
4119
  */
@@ -4185,6 +4215,12 @@
4185
4215
  get description() {
4186
4216
  return 'Remember past interactions and user **preferences** for personalized responses.';
4187
4217
  }
4218
+ /**
4219
+ * Icon for this commitment.
4220
+ */
4221
+ get icon() {
4222
+ return '🧠';
4223
+ }
4188
4224
  /**
4189
4225
  * Markdown documentation for MEMORY commitment.
4190
4226
  */
@@ -4300,6 +4336,12 @@
4300
4336
  get description() {
4301
4337
  return 'Defines a **message from the agent** in the conversation history.';
4302
4338
  }
4339
+ /**
4340
+ * Icon for this commitment.
4341
+ */
4342
+ get icon() {
4343
+ return '🤖';
4344
+ }
4303
4345
  /**
4304
4346
  * Markdown documentation for AGENT MESSAGE commitment.
4305
4347
  */
@@ -4371,6 +4413,12 @@
4371
4413
  get description() {
4372
4414
  return 'Defines the **initial message** shown to the user when the chat starts.';
4373
4415
  }
4416
+ /**
4417
+ * Icon for this commitment.
4418
+ */
4419
+ get icon() {
4420
+ return '👋';
4421
+ }
4374
4422
  /**
4375
4423
  * Markdown documentation for INITIAL MESSAGE commitment.
4376
4424
  */
@@ -4429,6 +4477,12 @@
4429
4477
  get description() {
4430
4478
  return 'Include actual **messages** the AI assistant has sent during conversation history.';
4431
4479
  }
4480
+ /**
4481
+ * Icon for this commitment.
4482
+ */
4483
+ get icon() {
4484
+ return 'đŸ’Ŧ';
4485
+ }
4432
4486
  /**
4433
4487
  * Markdown documentation for MESSAGE commitment.
4434
4488
  */
@@ -4535,6 +4589,12 @@
4535
4589
  get description() {
4536
4590
  return 'Defines a **message from the user** in the conversation history.';
4537
4591
  }
4592
+ /**
4593
+ * Icon for this commitment.
4594
+ */
4595
+ get icon() {
4596
+ return '🧑';
4597
+ }
4538
4598
  /**
4539
4599
  * Markdown documentation for USER MESSAGE commitment.
4540
4600
  */
@@ -4608,6 +4668,12 @@
4608
4668
  get description() {
4609
4669
  return 'Set meta-information about the agent (IMAGE, LINK, TITLE, DESCRIPTION, etc.).';
4610
4670
  }
4671
+ /**
4672
+ * Icon for this commitment.
4673
+ */
4674
+ get icon() {
4675
+ return 'â„šī¸';
4676
+ }
4611
4677
  /**
4612
4678
  * Markdown documentation for META commitment.
4613
4679
  */
@@ -4735,6 +4801,12 @@
4735
4801
  get description() {
4736
4802
  return "Set the agent's accent color.";
4737
4803
  }
4804
+ /**
4805
+ * Icon for this commitment.
4806
+ */
4807
+ get icon() {
4808
+ return '🎨';
4809
+ }
4738
4810
  /**
4739
4811
  * Markdown documentation for META COLOR commitment.
4740
4812
  */
@@ -4813,6 +4885,12 @@
4813
4885
  get description() {
4814
4886
  return "Set the agent's profile image URL.";
4815
4887
  }
4888
+ /**
4889
+ * Icon for this commitment.
4890
+ */
4891
+ get icon() {
4892
+ return 'đŸ–ŧī¸';
4893
+ }
4816
4894
  /**
4817
4895
  * Markdown documentation for META IMAGE commitment.
4818
4896
  */
@@ -4903,6 +4981,12 @@
4903
4981
  get description() {
4904
4982
  return 'Enforce AI model requirements including name and technical parameters.';
4905
4983
  }
4984
+ /**
4985
+ * Icon for this commitment.
4986
+ */
4987
+ get icon() {
4988
+ return 'âš™ī¸';
4989
+ }
4906
4990
  /**
4907
4991
  * Markdown documentation for MODEL commitment.
4908
4992
  */
@@ -5138,6 +5222,12 @@
5138
5222
  get description() {
5139
5223
  return 'Add developer-facing notes without changing behavior or output.';
5140
5224
  }
5225
+ /**
5226
+ * Icon for this commitment.
5227
+ */
5228
+ get icon() {
5229
+ return '📝';
5230
+ }
5141
5231
  /**
5142
5232
  * Markdown documentation for NOTE commitment.
5143
5233
  */
@@ -5240,6 +5330,12 @@
5240
5330
  get description() {
5241
5331
  return 'Define who the agent is: background, expertise, and personality.';
5242
5332
  }
5333
+ /**
5334
+ * Icon for this commitment.
5335
+ */
5336
+ get icon() {
5337
+ return '👤';
5338
+ }
5243
5339
  /**
5244
5340
  * Markdown documentation for PERSONA commitment.
5245
5341
  */
@@ -5367,6 +5463,12 @@
5367
5463
  get description() {
5368
5464
  return 'Add behavioral rules the agent must follow.';
5369
5465
  }
5466
+ /**
5467
+ * Icon for this commitment.
5468
+ */
5469
+ get icon() {
5470
+ return 'âš–ī¸';
5471
+ }
5370
5472
  /**
5371
5473
  * Markdown documentation for RULE/RULES commitment.
5372
5474
  */
@@ -5443,6 +5545,12 @@
5443
5545
  get description() {
5444
5546
  return 'Provide example responses to guide behavior.';
5445
5547
  }
5548
+ /**
5549
+ * Icon for this commitment.
5550
+ */
5551
+ get icon() {
5552
+ return '🔍';
5553
+ }
5446
5554
  /**
5447
5555
  * Markdown documentation for SAMPLE/EXAMPLE commitment.
5448
5556
  */
@@ -5520,6 +5628,12 @@
5520
5628
  get description() {
5521
5629
  return 'Define specific **situations** or contexts for AI responses, with later scenarios having higher priority.';
5522
5630
  }
5631
+ /**
5632
+ * Icon for this commitment.
5633
+ */
5634
+ get icon() {
5635
+ return '🎭';
5636
+ }
5523
5637
  /**
5524
5638
  * Markdown documentation for SCENARIO commitment.
5525
5639
  */
@@ -5636,6 +5750,12 @@
5636
5750
  get description() {
5637
5751
  return 'Control the tone and writing style of responses.';
5638
5752
  }
5753
+ /**
5754
+ * Icon for this commitment.
5755
+ */
5756
+ get icon() {
5757
+ return 'đŸ–‹ī¸';
5758
+ }
5639
5759
  /**
5640
5760
  * Markdown documentation for STYLE commitment.
5641
5761
  */
@@ -5705,6 +5825,12 @@
5705
5825
  get description() {
5706
5826
  return 'Placeholder commitment that appends content verbatim to the system message.';
5707
5827
  }
5828
+ /**
5829
+ * Icon for this commitment.
5830
+ */
5831
+ get icon() {
5832
+ return '🚧';
5833
+ }
5708
5834
  /**
5709
5835
  * Markdown documentation available at runtime.
5710
5836
  */