@promptbook/components 0.114.0-25 → 0.114.0-26

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.
@@ -3,23 +3,30 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
3
  /**
4
4
  * `WRITING RULES` commitment definition.
5
5
  *
6
- * It adds constraints that apply strictly to writing style and presentation
7
- * rather than task-solving behavior.
6
+ * The `WRITING RULES`/`WRITING RULE` commitment adds constraints that apply strictly to writing style
7
+ * and presentation rather than task-solving behavior.
8
+ *
9
+ * Example usage in agent source:
10
+ *
11
+ * ```book
12
+ * WRITING RULES Keep every response under 120 words
13
+ * WRITING RULE Always end the message with an emoji
14
+ * ```
8
15
  *
9
16
  * @private [🪔] Maybe export the commitments through some package
10
17
  */
11
- export declare class WritingRulesCommitmentDefinition extends BaseCommitmentDefinition<'WRITING RULES'> {
12
- constructor();
18
+ export declare class WritingRulesCommitmentDefinition extends BaseCommitmentDefinition<'WRITING RULES' | 'WRITING RULE'> {
19
+ constructor(type?: 'WRITING RULES' | 'WRITING RULE');
13
20
  /**
14
- * Short one-line description of `WRITING RULES`.
21
+ * Short one-line description of `WRITING RULES`/`WRITING RULE`.
15
22
  */
16
23
  get description(): string;
17
24
  /**
18
- * Icon for `WRITING RULES`.
25
+ * Icon for `WRITING RULES`/`WRITING RULE`.
19
26
  */
20
27
  get icon(): string;
21
28
  /**
22
- * Markdown documentation for `WRITING RULES`.
29
+ * Markdown documentation for `WRITING RULES`/`WRITING RULE` commitment.
23
30
  */
24
31
  get documentation(): string;
25
32
  applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
@@ -55,4 +55,4 @@ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplemented
55
55
  *
56
56
  * @private Use functions to access commitments instead of this array directly
57
57
  */
58
- export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, WritingSampleCommitmentDefinition, WritingRulesCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, TemplateCommitmentDefinition, TemplateCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, MetaAvatarCommitmentDefinition, MetaAvatarCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaDomainCommitmentDefinition, MetaDescriptionCommitmentDefinition, MetaDisclaimerCommitmentDefinition, MetaFullnameCommitmentDefinition, MetaIdCommitmentDefinition, MetaInputPlaceholderCommitmentDefinition, MetaThinkingMessageCommitmentDefinition, MetaVisibilityCommitmentDefinition, MetaVoiceCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, InternalMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageSuffixCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, TeamCommitmentDefinition, UseUserLocationCommitmentDefinition, UseCalendarCommitmentDefinition, UsePopupCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseMcpCommitmentDefinition, UsePrivacyCommitmentDefinition, UseProjectCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
58
+ export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, WritingSampleCommitmentDefinition, WritingRulesCommitmentDefinition, WritingRulesCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, TemplateCommitmentDefinition, TemplateCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, MetaAvatarCommitmentDefinition, MetaAvatarCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaDomainCommitmentDefinition, MetaDescriptionCommitmentDefinition, MetaDisclaimerCommitmentDefinition, MetaFullnameCommitmentDefinition, MetaIdCommitmentDefinition, MetaInputPlaceholderCommitmentDefinition, MetaThinkingMessageCommitmentDefinition, MetaVisibilityCommitmentDefinition, MetaVoiceCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, InternalMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageSuffixCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, TeamCommitmentDefinition, UseUserLocationCommitmentDefinition, UseCalendarCommitmentDefinition, UsePopupCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseMcpCommitmentDefinition, UsePrivacyCommitmentDefinition, UseProjectCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
@@ -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.114.0-24`).
18
+ * It follows semantic versioning (e.g., `0.114.0-25`).
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.114.0-25",
3
+ "version": "0.114.0-26",
4
4
  "description": "Promptbook: Create persistent AI agents that turn your company's scattered knowledge into action",
5
5
  "private": false,
6
6
  "sideEffects": false,
package/umd/index.umd.js CHANGED
@@ -33,7 +33,7 @@
33
33
  * @generated
34
34
  * @see https://github.com/webgptorg/promptbook
35
35
  */
36
- const PROMPTBOOK_ENGINE_VERSION = '0.114.0-25';
36
+ const PROMPTBOOK_ENGINE_VERSION = '0.114.0-26';
37
37
  /**
38
38
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
39
39
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -18027,29 +18027,36 @@
18027
18027
  /**
18028
18028
  * `WRITING RULES` commitment definition.
18029
18029
  *
18030
- * It adds constraints that apply strictly to writing style and presentation
18031
- * rather than task-solving behavior.
18030
+ * The `WRITING RULES`/`WRITING RULE` commitment adds constraints that apply strictly to writing style
18031
+ * and presentation rather than task-solving behavior.
18032
+ *
18033
+ * Example usage in agent source:
18034
+ *
18035
+ * ```book
18036
+ * WRITING RULES Keep every response under 120 words
18037
+ * WRITING RULE Always end the message with an emoji
18038
+ * ```
18032
18039
  *
18033
18040
  * @private [🪔] Maybe export the commitments through some package
18034
18041
  */
18035
18042
  class WritingRulesCommitmentDefinition extends BaseCommitmentDefinition {
18036
- constructor() {
18037
- super('WRITING RULES');
18043
+ constructor(type = 'WRITING RULES') {
18044
+ super(type);
18038
18045
  }
18039
18046
  /**
18040
- * Short one-line description of `WRITING RULES`.
18047
+ * Short one-line description of `WRITING RULES`/`WRITING RULE`.
18041
18048
  */
18042
18049
  get description() {
18043
18050
  return 'Add writing-only constraints such as tone, length, formatting, or emoji usage.';
18044
18051
  }
18045
18052
  /**
18046
- * Icon for `WRITING RULES`.
18053
+ * Icon for `WRITING RULES`/`WRITING RULE`.
18047
18054
  */
18048
18055
  get icon() {
18049
18056
  return '📝';
18050
18057
  }
18051
18058
  /**
18052
- * Markdown documentation for `WRITING RULES`.
18059
+ * Markdown documentation for `WRITING RULES`/`WRITING RULE` commitment.
18053
18060
  */
18054
18061
  get documentation() {
18055
18062
  return spacetrim.spaceTrim(`
@@ -18059,6 +18066,7 @@
18059
18066
 
18060
18067
  ## Key aspects
18061
18068
 
18069
+ - All writing rules are treated equally regardless of singular/plural form.
18062
18070
  - Use it for writing-only constraints such as tone, formatting, length, emoji usage, punctuation, or reading level.
18063
18071
  - Do **not** use it for problem-solving behavior, policy, tool usage, or decision-making logic. Use \`RULE\` for that.
18064
18072
  - Newer writing-rules blocks override conflicting earlier writing-rules blocks.
@@ -18257,7 +18265,8 @@
18257
18265
  new LanguageCommitmentDefinition('LANGUAGE'),
18258
18266
  new LanguageCommitmentDefinition('LANGUAGES'),
18259
18267
  new WritingSampleCommitmentDefinition(),
18260
- new WritingRulesCommitmentDefinition(),
18268
+ new WritingRulesCommitmentDefinition('WRITING RULES'),
18269
+ new WritingRulesCommitmentDefinition('WRITING RULE'),
18261
18270
  new SampleCommitmentDefinition('SAMPLE'),
18262
18271
  new SampleCommitmentDefinition('EXAMPLE'),
18263
18272
  new FormatCommitmentDefinition('FORMAT'),