@promptbook/browser 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 +2 -2
  29. package/umd/index.umd.js +127 -1
  30. package/umd/index.umd.js.map +1 -1
@@ -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/browser",
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,
@@ -94,7 +94,7 @@
94
94
  "module": "./esm/index.es.js",
95
95
  "typings": "./esm/typings/src/_packages/browser.index.d.ts",
96
96
  "peerDependencies": {
97
- "@promptbook/core": "0.103.0-53"
97
+ "@promptbook/core": "0.103.0-54"
98
98
  },
99
99
  "dependencies": {
100
100
  "crypto": "1.0.1",
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-53';
26
+ const PROMPTBOOK_ENGINE_VERSION = '0.103.0-54';
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
@@ -2787,6 +2787,12 @@
2787
2787
  get description() {
2788
2788
  return 'Define agent capabilities and actions it can perform.';
2789
2789
  }
2790
+ /**
2791
+ * Icon for this commitment.
2792
+ */
2793
+ get icon() {
2794
+ return '⚡';
2795
+ }
2790
2796
  /**
2791
2797
  * Markdown documentation for ACTION commitment.
2792
2798
  */
@@ -2866,6 +2872,12 @@
2866
2872
  get description() {
2867
2873
  return 'Remove or **disregard** certain information, context, or previous commitments.';
2868
2874
  }
2875
+ /**
2876
+ * Icon for this commitment.
2877
+ */
2878
+ get icon() {
2879
+ return 'đŸ—‘ī¸';
2880
+ }
2869
2881
  /**
2870
2882
  * Markdown documentation for DELETE commitment.
2871
2883
  */
@@ -2982,6 +2994,12 @@
2982
2994
  get description() {
2983
2995
  return 'Specify output structure or formatting requirements.';
2984
2996
  }
2997
+ /**
2998
+ * Icon for this commitment.
2999
+ */
3000
+ get icon() {
3001
+ return '📜';
3002
+ }
2985
3003
  /**
2986
3004
  * Markdown documentation for FORMAT commitment.
2987
3005
  */
@@ -3057,6 +3075,12 @@
3057
3075
  get description() {
3058
3076
  return 'Define main **goals** the AI assistant should achieve, with later goals having higher priority.';
3059
3077
  }
3078
+ /**
3079
+ * Icon for this commitment.
3080
+ */
3081
+ get icon() {
3082
+ return 'đŸŽ¯';
3083
+ }
3060
3084
  /**
3061
3085
  * Markdown documentation for GOAL commitment.
3062
3086
  */
@@ -3153,6 +3177,12 @@
3153
3177
  get description() {
3154
3178
  return 'Add domain **knowledge** via direct text or external sources (RAG).';
3155
3179
  }
3180
+ /**
3181
+ * Icon for this commitment.
3182
+ */
3183
+ get icon() {
3184
+ return '🧠';
3185
+ }
3156
3186
  /**
3157
3187
  * Markdown documentation for KNOWLEDGE commitment.
3158
3188
  */
@@ -3254,6 +3284,12 @@
3254
3284
  get description() {
3255
3285
  return 'Remember past interactions and user **preferences** for personalized responses.';
3256
3286
  }
3287
+ /**
3288
+ * Icon for this commitment.
3289
+ */
3290
+ get icon() {
3291
+ return '🧠';
3292
+ }
3257
3293
  /**
3258
3294
  * Markdown documentation for MEMORY commitment.
3259
3295
  */
@@ -3352,6 +3388,12 @@
3352
3388
  get description() {
3353
3389
  return 'Defines a **message from the agent** in the conversation history.';
3354
3390
  }
3391
+ /**
3392
+ * Icon for this commitment.
3393
+ */
3394
+ get icon() {
3395
+ return '🤖';
3396
+ }
3355
3397
  /**
3356
3398
  * Markdown documentation for AGENT MESSAGE commitment.
3357
3399
  */
@@ -3423,6 +3465,12 @@
3423
3465
  get description() {
3424
3466
  return 'Defines the **initial message** shown to the user when the chat starts.';
3425
3467
  }
3468
+ /**
3469
+ * Icon for this commitment.
3470
+ */
3471
+ get icon() {
3472
+ return '👋';
3473
+ }
3426
3474
  /**
3427
3475
  * Markdown documentation for INITIAL MESSAGE commitment.
3428
3476
  */
@@ -3481,6 +3529,12 @@
3481
3529
  get description() {
3482
3530
  return 'Include actual **messages** the AI assistant has sent during conversation history.';
3483
3531
  }
3532
+ /**
3533
+ * Icon for this commitment.
3534
+ */
3535
+ get icon() {
3536
+ return 'đŸ’Ŧ';
3537
+ }
3484
3538
  /**
3485
3539
  * Markdown documentation for MESSAGE commitment.
3486
3540
  */
@@ -3587,6 +3641,12 @@
3587
3641
  get description() {
3588
3642
  return 'Defines a **message from the user** in the conversation history.';
3589
3643
  }
3644
+ /**
3645
+ * Icon for this commitment.
3646
+ */
3647
+ get icon() {
3648
+ return '🧑';
3649
+ }
3590
3650
  /**
3591
3651
  * Markdown documentation for USER MESSAGE commitment.
3592
3652
  */
@@ -3660,6 +3720,12 @@
3660
3720
  get description() {
3661
3721
  return 'Set meta-information about the agent (IMAGE, LINK, TITLE, DESCRIPTION, etc.).';
3662
3722
  }
3723
+ /**
3724
+ * Icon for this commitment.
3725
+ */
3726
+ get icon() {
3727
+ return 'â„šī¸';
3728
+ }
3663
3729
  /**
3664
3730
  * Markdown documentation for META commitment.
3665
3731
  */
@@ -3787,6 +3853,12 @@
3787
3853
  get description() {
3788
3854
  return "Set the agent's accent color.";
3789
3855
  }
3856
+ /**
3857
+ * Icon for this commitment.
3858
+ */
3859
+ get icon() {
3860
+ return '🎨';
3861
+ }
3790
3862
  /**
3791
3863
  * Markdown documentation for META COLOR commitment.
3792
3864
  */
@@ -3865,6 +3937,12 @@
3865
3937
  get description() {
3866
3938
  return "Set the agent's profile image URL.";
3867
3939
  }
3940
+ /**
3941
+ * Icon for this commitment.
3942
+ */
3943
+ get icon() {
3944
+ return 'đŸ–ŧī¸';
3945
+ }
3868
3946
  /**
3869
3947
  * Markdown documentation for META IMAGE commitment.
3870
3948
  */
@@ -3955,6 +4033,12 @@
3955
4033
  get description() {
3956
4034
  return 'Enforce AI model requirements including name and technical parameters.';
3957
4035
  }
4036
+ /**
4037
+ * Icon for this commitment.
4038
+ */
4039
+ get icon() {
4040
+ return 'âš™ī¸';
4041
+ }
3958
4042
  /**
3959
4043
  * Markdown documentation for MODEL commitment.
3960
4044
  */
@@ -4190,6 +4274,12 @@
4190
4274
  get description() {
4191
4275
  return 'Add developer-facing notes without changing behavior or output.';
4192
4276
  }
4277
+ /**
4278
+ * Icon for this commitment.
4279
+ */
4280
+ get icon() {
4281
+ return '📝';
4282
+ }
4193
4283
  /**
4194
4284
  * Markdown documentation for NOTE commitment.
4195
4285
  */
@@ -4292,6 +4382,12 @@
4292
4382
  get description() {
4293
4383
  return 'Define who the agent is: background, expertise, and personality.';
4294
4384
  }
4385
+ /**
4386
+ * Icon for this commitment.
4387
+ */
4388
+ get icon() {
4389
+ return '👤';
4390
+ }
4295
4391
  /**
4296
4392
  * Markdown documentation for PERSONA commitment.
4297
4393
  */
@@ -4419,6 +4515,12 @@
4419
4515
  get description() {
4420
4516
  return 'Add behavioral rules the agent must follow.';
4421
4517
  }
4518
+ /**
4519
+ * Icon for this commitment.
4520
+ */
4521
+ get icon() {
4522
+ return 'âš–ī¸';
4523
+ }
4422
4524
  /**
4423
4525
  * Markdown documentation for RULE/RULES commitment.
4424
4526
  */
@@ -4495,6 +4597,12 @@
4495
4597
  get description() {
4496
4598
  return 'Provide example responses to guide behavior.';
4497
4599
  }
4600
+ /**
4601
+ * Icon for this commitment.
4602
+ */
4603
+ get icon() {
4604
+ return '🔍';
4605
+ }
4498
4606
  /**
4499
4607
  * Markdown documentation for SAMPLE/EXAMPLE commitment.
4500
4608
  */
@@ -4572,6 +4680,12 @@
4572
4680
  get description() {
4573
4681
  return 'Define specific **situations** or contexts for AI responses, with later scenarios having higher priority.';
4574
4682
  }
4683
+ /**
4684
+ * Icon for this commitment.
4685
+ */
4686
+ get icon() {
4687
+ return '🎭';
4688
+ }
4575
4689
  /**
4576
4690
  * Markdown documentation for SCENARIO commitment.
4577
4691
  */
@@ -4688,6 +4802,12 @@
4688
4802
  get description() {
4689
4803
  return 'Control the tone and writing style of responses.';
4690
4804
  }
4805
+ /**
4806
+ * Icon for this commitment.
4807
+ */
4808
+ get icon() {
4809
+ return 'đŸ–‹ī¸';
4810
+ }
4691
4811
  /**
4692
4812
  * Markdown documentation for STYLE commitment.
4693
4813
  */
@@ -4757,6 +4877,12 @@
4757
4877
  get description() {
4758
4878
  return 'Placeholder commitment that appends content verbatim to the system message.';
4759
4879
  }
4880
+ /**
4881
+ * Icon for this commitment.
4882
+ */
4883
+ get icon() {
4884
+ return '🚧';
4885
+ }
4760
4886
  /**
4761
4887
  * Markdown documentation available at runtime.
4762
4888
  */