@promptbook/node 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 (28) hide show
  1. package/esm/index.es.js +1 -1
  2. package/esm/typings/src/commitments/ACTION/ACTION.d.ts +4 -0
  3. package/esm/typings/src/commitments/DELETE/DELETE.d.ts +4 -0
  4. package/esm/typings/src/commitments/FORMAT/FORMAT.d.ts +4 -0
  5. package/esm/typings/src/commitments/GOAL/GOAL.d.ts +4 -0
  6. package/esm/typings/src/commitments/KNOWLEDGE/KNOWLEDGE.d.ts +4 -0
  7. package/esm/typings/src/commitments/MEMORY/MEMORY.d.ts +4 -0
  8. package/esm/typings/src/commitments/MESSAGE/AgentMessageCommitmentDefinition.d.ts +4 -0
  9. package/esm/typings/src/commitments/MESSAGE/InitialMessageCommitmentDefinition.d.ts +4 -0
  10. package/esm/typings/src/commitments/MESSAGE/MESSAGE.d.ts +4 -0
  11. package/esm/typings/src/commitments/MESSAGE/UserMessageCommitmentDefinition.d.ts +4 -0
  12. package/esm/typings/src/commitments/META/META.d.ts +4 -0
  13. package/esm/typings/src/commitments/META_COLOR/META_COLOR.d.ts +4 -0
  14. package/esm/typings/src/commitments/META_IMAGE/META_IMAGE.d.ts +4 -0
  15. package/esm/typings/src/commitments/META_LINK/META_LINK.d.ts +4 -0
  16. package/esm/typings/src/commitments/MODEL/MODEL.d.ts +4 -0
  17. package/esm/typings/src/commitments/NOTE/NOTE.d.ts +4 -0
  18. package/esm/typings/src/commitments/PERSONA/PERSONA.d.ts +4 -0
  19. package/esm/typings/src/commitments/RULE/RULE.d.ts +4 -0
  20. package/esm/typings/src/commitments/SAMPLE/SAMPLE.d.ts +4 -0
  21. package/esm/typings/src/commitments/SCENARIO/SCENARIO.d.ts +4 -0
  22. package/esm/typings/src/commitments/STYLE/STYLE.d.ts +4 -0
  23. package/esm/typings/src/commitments/_base/BaseCommitmentDefinition.d.ts +5 -0
  24. package/esm/typings/src/commitments/_base/CommitmentDefinition.d.ts +5 -0
  25. package/esm/typings/src/commitments/_base/NotYetImplementedCommitmentDefinition.d.ts +4 -0
  26. package/esm/typings/src/version.d.ts +1 -1
  27. package/package.json +3 -3
  28. package/umd/index.umd.js +1 -1
package/esm/index.es.js CHANGED
@@ -28,7 +28,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
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
@@ -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/node",
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,
@@ -93,10 +93,10 @@
93
93
  "module": "./esm/index.es.js",
94
94
  "typings": "./esm/typings/src/_packages/node.index.d.ts",
95
95
  "peerDependencies": {
96
- "@promptbook/core": "0.103.0-53"
96
+ "@promptbook/core": "0.103.0-54"
97
97
  },
98
98
  "dependencies": {
99
- "colors": "^1.4.0",
99
+ "colors": "1.4.0",
100
100
  "crypto": "1.0.1",
101
101
  "crypto-js": "4.2.0",
102
102
  "dotenv": "16.3.2",
package/umd/index.umd.js CHANGED
@@ -45,7 +45,7 @@
45
45
  * @generated
46
46
  * @see https://github.com/webgptorg/promptbook
47
47
  */
48
- const PROMPTBOOK_ENGINE_VERSION = '0.103.0-53';
48
+ const PROMPTBOOK_ENGINE_VERSION = '0.103.0-54';
49
49
  /**
50
50
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
51
51
  * Note: [💞] Ignore a discrepancy between file name and entity name