@promptbook/markdown-utils 0.111.0-10 → 0.111.0-11

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.
package/esm/index.es.js CHANGED
@@ -23,7 +23,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
23
23
  * @generated
24
24
  * @see https://github.com/webgptorg/promptbook
25
25
  */
26
- const PROMPTBOOK_ENGINE_VERSION = '0.111.0-10';
26
+ const PROMPTBOOK_ENGINE_VERSION = '0.111.0-11';
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
@@ -82,6 +82,7 @@ export type AgentBasicInformation = {
82
82
  disclaimer?: string;
83
83
  messageSuffix?: string;
84
84
  image?: string_url_image;
85
+ domain?: string;
85
86
  font?: string_fonts;
86
87
  color?: string_color;
87
88
  voice?: string;
@@ -6,6 +6,7 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
6
6
  * The META commitment handles all meta-information about the agent such as:
7
7
  * - META IMAGE: Sets the agent's avatar/profile image URL
8
8
  * - META LINK: Provides profile/source links for the person the agent models
9
+ * - META DOMAIN: Sets the canonical custom domain/host of the agent
9
10
  * - META TITLE: Sets the agent's display title
10
11
  * - META DESCRIPTION: Sets the agent's description
11
12
  * - META [ANYTHING]: Any other meta information in uppercase format
@@ -18,6 +19,7 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
18
19
  * ```book
19
20
  * META IMAGE https://example.com/avatar.jpg
20
21
  * META LINK https://twitter.com/username
22
+ * META DOMAIN my-agent.com
21
23
  * META TITLE Professional Assistant
22
24
  * META DESCRIPTION An AI assistant specialized in business tasks
23
25
  * META AUTHOR John Doe
@@ -0,0 +1,33 @@
1
+ import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
+ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
+ /**
4
+ * META DOMAIN commitment definition
5
+ *
6
+ * The `META DOMAIN` commitment sets the canonical host/domain of the agent.
7
+ * This commitment is metadata-only and does not modify model requirements.
8
+ *
9
+ * @private [🪔] Maybe export the commitments through some package
10
+ */
11
+ export declare class MetaDomainCommitmentDefinition extends BaseCommitmentDefinition<'META DOMAIN'> {
12
+ constructor();
13
+ /**
14
+ * Short one-line description of META DOMAIN.
15
+ */
16
+ get description(): string;
17
+ /**
18
+ * Icon for this commitment.
19
+ */
20
+ get icon(): string;
21
+ /**
22
+ * Markdown documentation for META DOMAIN commitment.
23
+ */
24
+ get documentation(): string;
25
+ applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
26
+ /**
27
+ * Extracts the domain value from commitment content.
28
+ */
29
+ extractDomain(content: string): string | null;
30
+ }
31
+ /**
32
+ * Note: [💞] Ignore a discrepancy between file name and entity name
33
+ */
@@ -17,6 +17,7 @@ import { UserMessageCommitmentDefinition } from './MESSAGE/UserMessageCommitment
17
17
  import { MessageSuffixCommitmentDefinition } from './MESSAGE_SUFFIX/MESSAGE_SUFFIX';
18
18
  import { MetaCommitmentDefinition } from './META/META';
19
19
  import { MetaColorCommitmentDefinition } from './META_COLOR/META_COLOR';
20
+ import { MetaDomainCommitmentDefinition } from './META_DOMAIN/META_DOMAIN';
20
21
  import { MetaDisclaimerCommitmentDefinition } from './META_DISCLAIMER/META_DISCLAIMER';
21
22
  import { MetaFontCommitmentDefinition } from './META_FONT/META_FONT';
22
23
  import { MetaImageCommitmentDefinition } from './META_IMAGE/META_IMAGE';
@@ -48,7 +49,7 @@ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplemented
48
49
  *
49
50
  * @private Use functions to access commitments instead of this array directly
50
51
  */
51
- export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, TemplateCommitmentDefinition, TemplateCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaDisclaimerCommitmentDefinition, MetaCommitmentDefinition, MetaVoiceCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageSuffixCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, TeamCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseTimeCommitmentDefinition, UseUserLocationCommitmentDefinition, UseEmailCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseMcpCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
52
+ export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, TemplateCommitmentDefinition, TemplateCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaDomainCommitmentDefinition, MetaDisclaimerCommitmentDefinition, MetaCommitmentDefinition, MetaVoiceCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageSuffixCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, TeamCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseTimeCommitmentDefinition, UseUserLocationCommitmentDefinition, UseEmailCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseMcpCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
52
53
  /**
53
54
  * TODO: [🧠] Maybe create through standardized $register
54
55
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -0,0 +1,11 @@
1
+ /**
2
+ * Normalizes a domain-like string into a comparable hostname form.
3
+ *
4
+ * The returned value is lowercased and stripped to hostname only
5
+ * (protocol, path, query, hash, and port are removed).
6
+ *
7
+ * @param rawDomain - Raw domain value (for example `my-agent.com` or `https://my-agent.com/path`).
8
+ * @returns Normalized hostname or `null` when the value cannot be normalized.
9
+ * @private utility for host/domain matching
10
+ */
11
+ export declare function normalizeDomainForMatching(rawDomain: string): string | null;
@@ -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.111.0-9`).
18
+ * It follows semantic versioning (e.g., `0.111.0-10`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/markdown-utils",
3
- "version": "0.111.0-10",
3
+ "version": "0.111.0-11",
4
4
  "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
5
5
  "private": false,
6
6
  "sideEffects": false,
package/umd/index.umd.js CHANGED
@@ -24,7 +24,7 @@
24
24
  * @generated
25
25
  * @see https://github.com/webgptorg/promptbook
26
26
  */
27
- const PROMPTBOOK_ENGINE_VERSION = '0.111.0-10';
27
+ const PROMPTBOOK_ENGINE_VERSION = '0.111.0-11';
28
28
  /**
29
29
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
30
30
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -82,6 +82,7 @@ export type AgentBasicInformation = {
82
82
  disclaimer?: string;
83
83
  messageSuffix?: string;
84
84
  image?: string_url_image;
85
+ domain?: string;
85
86
  font?: string_fonts;
86
87
  color?: string_color;
87
88
  voice?: string;
@@ -6,6 +6,7 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
6
6
  * The META commitment handles all meta-information about the agent such as:
7
7
  * - META IMAGE: Sets the agent's avatar/profile image URL
8
8
  * - META LINK: Provides profile/source links for the person the agent models
9
+ * - META DOMAIN: Sets the canonical custom domain/host of the agent
9
10
  * - META TITLE: Sets the agent's display title
10
11
  * - META DESCRIPTION: Sets the agent's description
11
12
  * - META [ANYTHING]: Any other meta information in uppercase format
@@ -18,6 +19,7 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
18
19
  * ```book
19
20
  * META IMAGE https://example.com/avatar.jpg
20
21
  * META LINK https://twitter.com/username
22
+ * META DOMAIN my-agent.com
21
23
  * META TITLE Professional Assistant
22
24
  * META DESCRIPTION An AI assistant specialized in business tasks
23
25
  * META AUTHOR John Doe
@@ -0,0 +1,33 @@
1
+ import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
2
+ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
3
+ /**
4
+ * META DOMAIN commitment definition
5
+ *
6
+ * The `META DOMAIN` commitment sets the canonical host/domain of the agent.
7
+ * This commitment is metadata-only and does not modify model requirements.
8
+ *
9
+ * @private [🪔] Maybe export the commitments through some package
10
+ */
11
+ export declare class MetaDomainCommitmentDefinition extends BaseCommitmentDefinition<'META DOMAIN'> {
12
+ constructor();
13
+ /**
14
+ * Short one-line description of META DOMAIN.
15
+ */
16
+ get description(): string;
17
+ /**
18
+ * Icon for this commitment.
19
+ */
20
+ get icon(): string;
21
+ /**
22
+ * Markdown documentation for META DOMAIN commitment.
23
+ */
24
+ get documentation(): string;
25
+ applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
26
+ /**
27
+ * Extracts the domain value from commitment content.
28
+ */
29
+ extractDomain(content: string): string | null;
30
+ }
31
+ /**
32
+ * Note: [💞] Ignore a discrepancy between file name and entity name
33
+ */
@@ -17,6 +17,7 @@ import { UserMessageCommitmentDefinition } from './MESSAGE/UserMessageCommitment
17
17
  import { MessageSuffixCommitmentDefinition } from './MESSAGE_SUFFIX/MESSAGE_SUFFIX';
18
18
  import { MetaCommitmentDefinition } from './META/META';
19
19
  import { MetaColorCommitmentDefinition } from './META_COLOR/META_COLOR';
20
+ import { MetaDomainCommitmentDefinition } from './META_DOMAIN/META_DOMAIN';
20
21
  import { MetaDisclaimerCommitmentDefinition } from './META_DISCLAIMER/META_DISCLAIMER';
21
22
  import { MetaFontCommitmentDefinition } from './META_FONT/META_FONT';
22
23
  import { MetaImageCommitmentDefinition } from './META_IMAGE/META_IMAGE';
@@ -48,7 +49,7 @@ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplemented
48
49
  *
49
50
  * @private Use functions to access commitments instead of this array directly
50
51
  */
51
- export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, TemplateCommitmentDefinition, TemplateCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaDisclaimerCommitmentDefinition, MetaCommitmentDefinition, MetaVoiceCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageSuffixCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, TeamCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseTimeCommitmentDefinition, UseUserLocationCommitmentDefinition, UseEmailCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseMcpCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
52
+ export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, LanguageCommitmentDefinition, LanguageCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, TemplateCommitmentDefinition, TemplateCommitmentDefinition, FromCommitmentDefinition, ImportCommitmentDefinition, ImportCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, ComponentCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaFontCommitmentDefinition, MetaLinkCommitmentDefinition, MetaDomainCommitmentDefinition, MetaDisclaimerCommitmentDefinition, MetaCommitmentDefinition, MetaVoiceCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageSuffixCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DictionaryCommitmentDefinition, OpenCommitmentDefinition, ClosedCommitmentDefinition, TeamCommitmentDefinition, UseBrowserCommitmentDefinition, UseSearchEngineCommitmentDefinition, UseTimeCommitmentDefinition, UseUserLocationCommitmentDefinition, UseEmailCommitmentDefinition, UseImageGeneratorCommitmentDefinition, UseMcpCommitmentDefinition, UseCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
52
53
  /**
53
54
  * TODO: [🧠] Maybe create through standardized $register
54
55
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -0,0 +1,11 @@
1
+ /**
2
+ * Normalizes a domain-like string into a comparable hostname form.
3
+ *
4
+ * The returned value is lowercased and stripped to hostname only
5
+ * (protocol, path, query, hash, and port are removed).
6
+ *
7
+ * @param rawDomain - Raw domain value (for example `my-agent.com` or `https://my-agent.com/path`).
8
+ * @returns Normalized hostname or `null` when the value cannot be normalized.
9
+ * @private utility for host/domain matching
10
+ */
11
+ export declare function normalizeDomainForMatching(rawDomain: string): string | null;
@@ -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.111.0-9`).
18
+ * It follows semantic versioning (e.g., `0.111.0-10`).
19
19
  *
20
20
  * @generated
21
21
  */