@promptbook/core 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
@@ -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/core",
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,
@@ -92,7 +92,7 @@
92
92
  "typings": "./esm/typings/src/_packages/core.index.d.ts",
93
93
  "dependencies": {
94
94
  "bottleneck": "2.19.5",
95
- "colors": "^1.4.0",
95
+ "colors": "1.4.0",
96
96
  "crypto": "1.0.1",
97
97
  "crypto-js": "4.2.0",
98
98
  "dotenv": "16.3.2",
package/umd/index.umd.js CHANGED
@@ -28,7 +28,7 @@
28
28
  * @generated
29
29
  * @see https://github.com/webgptorg/promptbook
30
30
  */
31
- const PROMPTBOOK_ENGINE_VERSION = '0.103.0-53';
31
+ const PROMPTBOOK_ENGINE_VERSION = '0.103.0-54';
32
32
  /**
33
33
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
34
34
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -7587,6 +7587,12 @@
7587
7587
  get description() {
7588
7588
  return 'Define agent capabilities and actions it can perform.';
7589
7589
  }
7590
+ /**
7591
+ * Icon for this commitment.
7592
+ */
7593
+ get icon() {
7594
+ return '⚡';
7595
+ }
7590
7596
  /**
7591
7597
  * Markdown documentation for ACTION commitment.
7592
7598
  */
@@ -7666,6 +7672,12 @@
7666
7672
  get description() {
7667
7673
  return 'Remove or **disregard** certain information, context, or previous commitments.';
7668
7674
  }
7675
+ /**
7676
+ * Icon for this commitment.
7677
+ */
7678
+ get icon() {
7679
+ return 'đŸ—‘ī¸';
7680
+ }
7669
7681
  /**
7670
7682
  * Markdown documentation for DELETE commitment.
7671
7683
  */
@@ -7782,6 +7794,12 @@
7782
7794
  get description() {
7783
7795
  return 'Specify output structure or formatting requirements.';
7784
7796
  }
7797
+ /**
7798
+ * Icon for this commitment.
7799
+ */
7800
+ get icon() {
7801
+ return '📜';
7802
+ }
7785
7803
  /**
7786
7804
  * Markdown documentation for FORMAT commitment.
7787
7805
  */
@@ -7857,6 +7875,12 @@
7857
7875
  get description() {
7858
7876
  return 'Define main **goals** the AI assistant should achieve, with later goals having higher priority.';
7859
7877
  }
7878
+ /**
7879
+ * Icon for this commitment.
7880
+ */
7881
+ get icon() {
7882
+ return 'đŸŽ¯';
7883
+ }
7860
7884
  /**
7861
7885
  * Markdown documentation for GOAL commitment.
7862
7886
  */
@@ -7953,6 +7977,12 @@
7953
7977
  get description() {
7954
7978
  return 'Add domain **knowledge** via direct text or external sources (RAG).';
7955
7979
  }
7980
+ /**
7981
+ * Icon for this commitment.
7982
+ */
7983
+ get icon() {
7984
+ return '🧠';
7985
+ }
7956
7986
  /**
7957
7987
  * Markdown documentation for KNOWLEDGE commitment.
7958
7988
  */
@@ -8054,6 +8084,12 @@
8054
8084
  get description() {
8055
8085
  return 'Remember past interactions and user **preferences** for personalized responses.';
8056
8086
  }
8087
+ /**
8088
+ * Icon for this commitment.
8089
+ */
8090
+ get icon() {
8091
+ return '🧠';
8092
+ }
8057
8093
  /**
8058
8094
  * Markdown documentation for MEMORY commitment.
8059
8095
  */
@@ -8152,6 +8188,12 @@
8152
8188
  get description() {
8153
8189
  return 'Defines a **message from the agent** in the conversation history.';
8154
8190
  }
8191
+ /**
8192
+ * Icon for this commitment.
8193
+ */
8194
+ get icon() {
8195
+ return '🤖';
8196
+ }
8155
8197
  /**
8156
8198
  * Markdown documentation for AGENT MESSAGE commitment.
8157
8199
  */
@@ -8223,6 +8265,12 @@
8223
8265
  get description() {
8224
8266
  return 'Defines the **initial message** shown to the user when the chat starts.';
8225
8267
  }
8268
+ /**
8269
+ * Icon for this commitment.
8270
+ */
8271
+ get icon() {
8272
+ return '👋';
8273
+ }
8226
8274
  /**
8227
8275
  * Markdown documentation for INITIAL MESSAGE commitment.
8228
8276
  */
@@ -8281,6 +8329,12 @@
8281
8329
  get description() {
8282
8330
  return 'Include actual **messages** the AI assistant has sent during conversation history.';
8283
8331
  }
8332
+ /**
8333
+ * Icon for this commitment.
8334
+ */
8335
+ get icon() {
8336
+ return 'đŸ’Ŧ';
8337
+ }
8284
8338
  /**
8285
8339
  * Markdown documentation for MESSAGE commitment.
8286
8340
  */
@@ -8387,6 +8441,12 @@
8387
8441
  get description() {
8388
8442
  return 'Defines a **message from the user** in the conversation history.';
8389
8443
  }
8444
+ /**
8445
+ * Icon for this commitment.
8446
+ */
8447
+ get icon() {
8448
+ return '🧑';
8449
+ }
8390
8450
  /**
8391
8451
  * Markdown documentation for USER MESSAGE commitment.
8392
8452
  */
@@ -8460,6 +8520,12 @@
8460
8520
  get description() {
8461
8521
  return 'Set meta-information about the agent (IMAGE, LINK, TITLE, DESCRIPTION, etc.).';
8462
8522
  }
8523
+ /**
8524
+ * Icon for this commitment.
8525
+ */
8526
+ get icon() {
8527
+ return 'â„šī¸';
8528
+ }
8463
8529
  /**
8464
8530
  * Markdown documentation for META commitment.
8465
8531
  */
@@ -8587,6 +8653,12 @@
8587
8653
  get description() {
8588
8654
  return "Set the agent's accent color.";
8589
8655
  }
8656
+ /**
8657
+ * Icon for this commitment.
8658
+ */
8659
+ get icon() {
8660
+ return '🎨';
8661
+ }
8590
8662
  /**
8591
8663
  * Markdown documentation for META COLOR commitment.
8592
8664
  */
@@ -8665,6 +8737,12 @@
8665
8737
  get description() {
8666
8738
  return "Set the agent's profile image URL.";
8667
8739
  }
8740
+ /**
8741
+ * Icon for this commitment.
8742
+ */
8743
+ get icon() {
8744
+ return 'đŸ–ŧī¸';
8745
+ }
8668
8746
  /**
8669
8747
  * Markdown documentation for META IMAGE commitment.
8670
8748
  */
@@ -8755,6 +8833,12 @@
8755
8833
  get description() {
8756
8834
  return 'Enforce AI model requirements including name and technical parameters.';
8757
8835
  }
8836
+ /**
8837
+ * Icon for this commitment.
8838
+ */
8839
+ get icon() {
8840
+ return 'âš™ī¸';
8841
+ }
8758
8842
  /**
8759
8843
  * Markdown documentation for MODEL commitment.
8760
8844
  */
@@ -8990,6 +9074,12 @@
8990
9074
  get description() {
8991
9075
  return 'Add developer-facing notes without changing behavior or output.';
8992
9076
  }
9077
+ /**
9078
+ * Icon for this commitment.
9079
+ */
9080
+ get icon() {
9081
+ return '📝';
9082
+ }
8993
9083
  /**
8994
9084
  * Markdown documentation for NOTE commitment.
8995
9085
  */
@@ -9092,6 +9182,12 @@
9092
9182
  get description() {
9093
9183
  return 'Define who the agent is: background, expertise, and personality.';
9094
9184
  }
9185
+ /**
9186
+ * Icon for this commitment.
9187
+ */
9188
+ get icon() {
9189
+ return '👤';
9190
+ }
9095
9191
  /**
9096
9192
  * Markdown documentation for PERSONA commitment.
9097
9193
  */
@@ -9219,6 +9315,12 @@
9219
9315
  get description() {
9220
9316
  return 'Add behavioral rules the agent must follow.';
9221
9317
  }
9318
+ /**
9319
+ * Icon for this commitment.
9320
+ */
9321
+ get icon() {
9322
+ return 'âš–ī¸';
9323
+ }
9222
9324
  /**
9223
9325
  * Markdown documentation for RULE/RULES commitment.
9224
9326
  */
@@ -9295,6 +9397,12 @@
9295
9397
  get description() {
9296
9398
  return 'Provide example responses to guide behavior.';
9297
9399
  }
9400
+ /**
9401
+ * Icon for this commitment.
9402
+ */
9403
+ get icon() {
9404
+ return '🔍';
9405
+ }
9298
9406
  /**
9299
9407
  * Markdown documentation for SAMPLE/EXAMPLE commitment.
9300
9408
  */
@@ -9372,6 +9480,12 @@
9372
9480
  get description() {
9373
9481
  return 'Define specific **situations** or contexts for AI responses, with later scenarios having higher priority.';
9374
9482
  }
9483
+ /**
9484
+ * Icon for this commitment.
9485
+ */
9486
+ get icon() {
9487
+ return '🎭';
9488
+ }
9375
9489
  /**
9376
9490
  * Markdown documentation for SCENARIO commitment.
9377
9491
  */
@@ -9488,6 +9602,12 @@
9488
9602
  get description() {
9489
9603
  return 'Control the tone and writing style of responses.';
9490
9604
  }
9605
+ /**
9606
+ * Icon for this commitment.
9607
+ */
9608
+ get icon() {
9609
+ return 'đŸ–‹ī¸';
9610
+ }
9491
9611
  /**
9492
9612
  * Markdown documentation for STYLE commitment.
9493
9613
  */
@@ -9557,6 +9677,12 @@
9557
9677
  get description() {
9558
9678
  return 'Placeholder commitment that appends content verbatim to the system message.';
9559
9679
  }
9680
+ /**
9681
+ * Icon for this commitment.
9682
+ */
9683
+ get icon() {
9684
+ return '🚧';
9685
+ }
9560
9686
  /**
9561
9687
  * Markdown documentation available at runtime.
9562
9688
  */