@promptbook/node 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/node",
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,
@@ -97,7 +97,7 @@
97
97
  "types": "./esm/src/_packages/node.index.d.ts",
98
98
  "typings": "./esm/src/_packages/node.index.d.ts",
99
99
  "peerDependencies": {
100
- "@promptbook/core": "0.114.0-25"
100
+ "@promptbook/core": "0.114.0-26"
101
101
  },
102
102
  "dependencies": {
103
103
  "@openai/agents": "0.4.15",
package/umd/index.umd.js CHANGED
@@ -47,7 +47,7 @@
47
47
  * @generated
48
48
  * @see https://github.com/webgptorg/promptbook
49
49
  */
50
- const PROMPTBOOK_ENGINE_VERSION = '0.114.0-25';
50
+ const PROMPTBOOK_ENGINE_VERSION = '0.114.0-26';
51
51
  /**
52
52
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
53
53
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -27948,29 +27948,36 @@
27948
27948
  /**
27949
27949
  * `WRITING RULES` commitment definition.
27950
27950
  *
27951
- * It adds constraints that apply strictly to writing style and presentation
27952
- * rather than task-solving behavior.
27951
+ * The `WRITING RULES`/`WRITING RULE` commitment adds constraints that apply strictly to writing style
27952
+ * and presentation rather than task-solving behavior.
27953
+ *
27954
+ * Example usage in agent source:
27955
+ *
27956
+ * ```book
27957
+ * WRITING RULES Keep every response under 120 words
27958
+ * WRITING RULE Always end the message with an emoji
27959
+ * ```
27953
27960
  *
27954
27961
  * @private [🪔] Maybe export the commitments through some package
27955
27962
  */
27956
27963
  class WritingRulesCommitmentDefinition extends BaseCommitmentDefinition {
27957
- constructor() {
27958
- super('WRITING RULES');
27964
+ constructor(type = 'WRITING RULES') {
27965
+ super(type);
27959
27966
  }
27960
27967
  /**
27961
- * Short one-line description of `WRITING RULES`.
27968
+ * Short one-line description of `WRITING RULES`/`WRITING RULE`.
27962
27969
  */
27963
27970
  get description() {
27964
27971
  return 'Add writing-only constraints such as tone, length, formatting, or emoji usage.';
27965
27972
  }
27966
27973
  /**
27967
- * Icon for `WRITING RULES`.
27974
+ * Icon for `WRITING RULES`/`WRITING RULE`.
27968
27975
  */
27969
27976
  get icon() {
27970
27977
  return '📝';
27971
27978
  }
27972
27979
  /**
27973
- * Markdown documentation for `WRITING RULES`.
27980
+ * Markdown documentation for `WRITING RULES`/`WRITING RULE` commitment.
27974
27981
  */
27975
27982
  get documentation() {
27976
27983
  return _spaceTrim.spaceTrim(`
@@ -27980,6 +27987,7 @@
27980
27987
 
27981
27988
  ## Key aspects
27982
27989
 
27990
+ - All writing rules are treated equally regardless of singular/plural form.
27983
27991
  - Use it for writing-only constraints such as tone, formatting, length, emoji usage, punctuation, or reading level.
27984
27992
  - Do **not** use it for problem-solving behavior, policy, tool usage, or decision-making logic. Use \`RULE\` for that.
27985
27993
  - Newer writing-rules blocks override conflicting earlier writing-rules blocks.
@@ -28178,7 +28186,8 @@
28178
28186
  new LanguageCommitmentDefinition('LANGUAGE'),
28179
28187
  new LanguageCommitmentDefinition('LANGUAGES'),
28180
28188
  new WritingSampleCommitmentDefinition(),
28181
- new WritingRulesCommitmentDefinition(),
28189
+ new WritingRulesCommitmentDefinition('WRITING RULES'),
28190
+ new WritingRulesCommitmentDefinition('WRITING RULE'),
28182
28191
  new SampleCommitmentDefinition('SAMPLE'),
28183
28192
  new SampleCommitmentDefinition('EXAMPLE'),
28184
28193
  new FormatCommitmentDefinition('FORMAT'),