@promptbook/legacy-documents 0.103.0-54 → 0.103.0-55

package/esm/index.es.js

@@ -26,7 +26,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.103.0-54';
+const PROMPTBOOK_ENGINE_VERSION = '0.103.0-55';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/esm/typings/src/_packages/core.index.d.ts

@@ -21,12 +21,13 @@ import { pipelineCollectionToJson } from '../collection/pipeline-collection/pipe
 import { createEmptyAgentModelRequirements } from '../commitments/_base/createEmptyAgentModelRequirements';
 import { createBasicAgentModelRequirements } from '../commitments/_base/createEmptyAgentModelRequirements';
 import { NotYetImplementedCommitmentDefinition } from '../commitments/_base/NotYetImplementedCommitmentDefinition';
-import { getCommitmentDefinition } from '../commitments/index';
-import { getAllCommitmentDefinitions } from '../commitments/index';
-import { getAllCommitmentTypes } from '../commitments/index';
-import { isCommitmentSupported } from '../commitments/index';
-import type { GroupedCommitmentDefinition } from '../commitments/index';
-import { getGroupedCommitmentDefinitions } from '../commitments/index';
+import { registerCommitment } from '../commitments/registry';
+import { getCommitmentDefinition } from '../commitments/registry';
+import { getAllCommitmentDefinitions } from '../commitments/registry';
+import { getAllCommitmentTypes } from '../commitments/registry';
+import { isCommitmentSupported } from '../commitments/registry';
+import type { GroupedCommitmentDefinition } from '../commitments/registry';
+import { getGroupedCommitmentDefinitions } from '../commitments/registry';
 import { NAME } from '../config';
 import { ADMIN_EMAIL } from '../config';
 import { ADMIN_GITHUB_NAME } from '../config';
@@ -216,6 +217,7 @@ export { pipelineCollectionToJson };
 export { createEmptyAgentModelRequirements };
 export { createBasicAgentModelRequirements };
 export { NotYetImplementedCommitmentDefinition };
+export { registerCommitment };
 export { getCommitmentDefinition };
 export { getAllCommitmentDefinitions };
 export { getAllCommitmentTypes };

package/esm/typings/src/_packages/types.index.d.ts

@@ -57,7 +57,7 @@ import type { InstrumentCommand } from '../commands/X_INSTRUMENT/InstrumentComma
 import type { BookCommitment } from '../commitments/_base/BookCommitment';
 import type { CommitmentDefinition } from '../commitments/_base/CommitmentDefinition';
 import type { ParsedCommitment } from '../commitments/_base/ParsedCommitment';
-import type { GroupedCommitmentDefinition } from '../commitments/index';
+import type { GroupedCommitmentDefinition } from '../commitments/registry';
 import type { PrettifyOptions } from '../conversion/prettify/PrettifyOptions';
 import type { renderPipelineMermaidOptions } from '../conversion/prettify/renderPipelineMermaidOptions';
 import type { CallbackInterfaceToolsOptions } from '../dialogs/callback/CallbackInterfaceToolsOptions';

package/esm/typings/src/book-2.0/agent-source/AgentModelRequirements.d.ts

@@ -18,6 +18,10 @@ export type AgentModelRequirements = {
      * Optional list of MCP servers that the agent can connect to
      */
     readonly mcpServers?: ReadonlyArray<string>;
+    /**
+     * Optional link to the parent agent from which this agent inherits
+     */
+    readonly parentAgentUrl?: string_knowledge_source_link;
     /**
      * Optional list of knowledge source links that the agent can use
      */

package/esm/typings/src/commitments/CLOSED/CLOSED.d.ts

@@ -0,0 +1,35 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * CLOSED commitment definition
+ *
+ * The CLOSED commitment specifies that the agent CANNOT be modified by conversation.
+ * It prevents the agent from learning from interactions and updating its source code.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * CLOSED
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class ClosedCommitmentDefinition extends BaseCommitmentDefinition<'CLOSED'> {
+    constructor();
+    /**
+     * Short one-line description of CLOSED.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for CLOSED commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, _content: string): AgentModelRequirements;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/commitments/COMPONENT/COMPONENT.d.ts

@@ -0,0 +1,28 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * COMPONENT commitment definition
+ *
+ * The COMPONENT commitment defines a UI component that the agent can render in the chat.
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class ComponentCommitmentDefinition extends BaseCommitmentDefinition<'COMPONENT'> {
+    constructor();
+    /**
+     * Short one-line description of COMPONENT.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for COMPONENT commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/commitments/FROM/FROM.d.ts

@@ -0,0 +1,34 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * FROM commitment definition
+ *
+ * The FROM commitment tells the agent that its `agentSource` is inherited from another agent.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * FROM https://s6.ptbk.io/benjamin-white
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class FromCommitmentDefinition extends BaseCommitmentDefinition<'FROM'> {
+    constructor(type?: 'FROM');
+    /**
+     * Short one-line description of FROM.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for FROM commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/commitments/IMPORTANT/IMPORTANT.d.ts

@@ -0,0 +1,26 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * IMPORTANT co-commitment definition
+ *
+ * The IMPORTANT co-commitment modifies another commitment to emphasize its importance.
+ * It is typically used with RULE to mark it as critical.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * IMPORTANT RULE Never provide medical advice
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class ImportantCommitmentDefinition extends BaseCommitmentDefinition<'IMPORTANT'> {
+    constructor();
+    get description(): string;
+    get icon(): string;
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/commitments/LANGUAGE/LANGUAGE.d.ts

@@ -0,0 +1,35 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * LANGUAGE commitment definition
+ *
+ * The LANGUAGE/LANGUAGES commitment specifies the language(s) the agent should use in its responses.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * LANGUAGE English
+ * LANGUAGE French, English and Czech
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class LanguageCommitmentDefinition extends BaseCommitmentDefinition<'LANGUAGE' | 'LANGUAGES'> {
+    constructor(type?: 'LANGUAGE' | 'LANGUAGES');
+    /**
+     * Short one-line description of LANGUAGE/LANGUAGES.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for LANGUAGE/LANGUAGES commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/commitments/OPEN/OPEN.d.ts

@@ -0,0 +1,35 @@
+import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+/**
+ * OPEN commitment definition
+ *
+ * The OPEN commitment specifies that the agent can be modified by conversation.
+ * This is the default behavior.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * OPEN
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class OpenCommitmentDefinition extends BaseCommitmentDefinition<'OPEN'> {
+    constructor();
+    /**
+     * Short one-line description of OPEN.
+     */
+    get description(): string;
+    /**
+     * Icon for this commitment.
+     */
+    get icon(): string;
+    /**
+     * Markdown documentation for OPEN commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, _content: string): AgentModelRequirements;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/commitments/index.d.ts

@@ -1,82 +1 @@
-import type { BookCommitment } from './_base/BookCommitment';
-import type { CommitmentDefinition } from './_base/CommitmentDefinition';
-import { ActionCommitmentDefinition } from './ACTION/ACTION';
-import { DeleteCommitmentDefinition } from './DELETE/DELETE';
-import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
-import { GoalCommitmentDefinition } from './GOAL/GOAL';
-import { KnowledgeCommitmentDefinition } from './KNOWLEDGE/KNOWLEDGE';
-import { MemoryCommitmentDefinition } from './MEMORY/MEMORY';
-import { AgentMessageCommitmentDefinition } from './MESSAGE/AgentMessageCommitmentDefinition';
-import { InitialMessageCommitmentDefinition } from './MESSAGE/InitialMessageCommitmentDefinition';
-import { MessageCommitmentDefinition } from './MESSAGE/MESSAGE';
-import { UserMessageCommitmentDefinition } from './MESSAGE/UserMessageCommitmentDefinition';
-import { MetaCommitmentDefinition } from './META/META';
-import { MetaColorCommitmentDefinition } from './META_COLOR/META_COLOR';
-import { MetaImageCommitmentDefinition } from './META_IMAGE/META_IMAGE';
-import { ModelCommitmentDefinition } from './MODEL/MODEL';
-import { NoteCommitmentDefinition } from './NOTE/NOTE';
-import { PersonaCommitmentDefinition } from './PERSONA/PERSONA';
-import { RuleCommitmentDefinition } from './RULE/RULE';
-import { SampleCommitmentDefinition } from './SAMPLE/SAMPLE';
-import { ScenarioCommitmentDefinition } from './SCENARIO/SCENARIO';
-import { StyleCommitmentDefinition } from './STYLE/STYLE';
-import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplementedCommitmentDefinition';
-/**
- * Registry of all available commitment definitions
- * This array contains instances of all commitment definitions
- * This is the single source of truth for all commitments in the system
- *
- * @private Use functions to access commitments instead of this array directly
- */
-export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, MetaImageCommitmentDefinition, MetaColorCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, InitialMessageCommitmentDefinition, UserMessageCommitmentDefinition, AgentMessageCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
-/**
- * Gets a commitment definition by its type
- * @param type The commitment type to look up
- * @returns The commitment definition or null if not found
- *
- * @public exported from `@promptbook/core`
- */
-export declare function getCommitmentDefinition(type: BookCommitment): CommitmentDefinition | null;
-/**
- * Gets all available commitment definitions
- * @returns Array of all commitment definitions
- *
- * @public exported from `@promptbook/core`
- */
-export declare function getAllCommitmentDefinitions(): ReadonlyArray<CommitmentDefinition>;
-/**
- * Gets all available commitment types
- * @returns Array of all commitment types
- *
- * @public exported from `@promptbook/core`
- */
-export declare function getAllCommitmentTypes(): ReadonlyArray<BookCommitment>;
-/**
- * Checks if a commitment type is supported
- * @param type The commitment type to check
- * @returns True if the commitment type is supported
- *
- * @public exported from `@promptbook/core`
- */
-export declare function isCommitmentSupported(type: BookCommitment): boolean;
-/**
- * Grouped commitment definition
- *
- * @public exported from `@promptbook/core`
- */
-export type GroupedCommitmentDefinition = {
-    primary: CommitmentDefinition;
-    aliases: string[];
-};
-/**
- * Gets all commitment definitions grouped by their aliases
- *
- * @returns Array of grouped commitment definitions
- *
- * @public exported from `@promptbook/core`
- */
-export declare function getGroupedCommitmentDefinitions(): ReadonlyArray<GroupedCommitmentDefinition>;
-/**
- * TODO: [🧠] Maybe create through standardized $register
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */
+export * from './registry';

package/esm/typings/src/commitments/registry.d.ts

@@ -0,0 +1,68 @@
+import type { BookCommitment } from './_base/BookCommitment';
+import type { CommitmentDefinition } from './_base/CommitmentDefinition';
+/**
+ * Registry of all available commitment definitions
+ * This array contains instances of all commitment definitions
+ * This is the single source of truth for all commitments in the system
+ *
+ * @private Use functions to access commitments instead of this array directly
+ */
+export declare const COMMITMENT_REGISTRY: CommitmentDefinition[];
+/**
+ * Registers a new commitment definition
+ * @param definition The commitment definition to register
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function registerCommitment(definition: CommitmentDefinition): void;
+/**
+ * Gets a commitment definition by its type
+ * @param type The commitment type to look up
+ * @returns The commitment definition or null if not found
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getCommitmentDefinition(type: BookCommitment): CommitmentDefinition | null;
+/**
+ * Gets all available commitment definitions
+ * @returns Array of all commitment definitions
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getAllCommitmentDefinitions(): ReadonlyArray<CommitmentDefinition>;
+/**
+ * Gets all available commitment types
+ * @returns Array of all commitment types
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getAllCommitmentTypes(): ReadonlyArray<BookCommitment>;
+/**
+ * Checks if a commitment type is supported
+ * @param type The commitment type to check
+ * @returns True if the commitment type is supported
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function isCommitmentSupported(type: BookCommitment): boolean;
+/**
+ * Grouped commitment definition
+ *
+ * @public exported from `@promptbook/core`
+ */
+export type GroupedCommitmentDefinition = {
+    primary: CommitmentDefinition;
+    aliases: string[];
+};
+/**
+ * Gets all commitment definitions grouped by their aliases
+ *
+ * @returns Array of grouped commitment definitions
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function getGroupedCommitmentDefinitions(): ReadonlyArray<GroupedCommitmentDefinition>;
+/**
+ * TODO: !!!! Proofread this file
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.103.0-53`).
+ * It follows semantic versioning (e.g., `0.103.0-54`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/legacy-documents",
-    "version": "0.103.0-54",
+    "version": "0.103.0-55",
     "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
     "private": false,
     "sideEffects": false,
@@ -88,14 +88,14 @@
     },
     "homepage": "https://ptbk.io/",
     "engines": {
-        "node": ">=16.0.0",
+        "node": ">=18.18.0",
         "npm": ">=8.0.0"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/legacy-documents.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.103.0-54"
+        "@promptbook/core": "0.103.0-55"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -25,7 +25,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-54';
+    const PROMPTBOOK_ENGINE_VERSION = '0.103.0-55';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name