@promptbook/browser 0.103.0-54 → 0.103.0-55

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/browser",
-    "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,
@@ -87,14 +87,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/browser.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.103.0-54"
+        "@promptbook/core": "0.103.0-55"
     },
     "dependencies": {
         "crypto": "1.0.1",