@promptbook/components 0.114.0-10 → 0.114.0-12

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

@@ -1,5 +1,6 @@
 import type { ParsedCommitment } from '../../commitments/_base/ParsedCommitment';
 import type { string_agent_name } from '../../types/string_agent_name';
+import type { ParsedUnknownCommitment } from './ParsedUnknownCommitment';
 /**
  * Result of parsing agent source for commitments
  *
@@ -18,6 +19,10 @@ export type AgentSourceParseResult = {
      * All parsed commitments
      */
     commitments: ParsedCommitment[];
+    /**
+     * Uppercase commitment blocks whose types are not registered by Promptbook.
+     */
+    unknownCommitments: ParsedUnknownCommitment[];
     /**
      * Lines that are not commitments (for system message)
      */

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

@@ -0,0 +1,26 @@
+/**
+ * An uppercase Book commitment block whose keyword is not registered by Promptbook.
+ *
+ * Unknown commitments are retained as system-message context instead of being applied
+ * as executable commitments.
+ *
+ * @private internal type of `parseAgentSourceWithCommitments`
+ */
+export type ParsedUnknownCommitment = {
+    /**
+     * Uppercase unknown commitment type, for example `FOO` or `BAR BZZ`.
+     */
+    readonly type: string;
+    /**
+     * Original first line, retained for precise editor diagnostics.
+     */
+    readonly originalLine: string;
+    /**
+     * Line number in the agent source (1-based).
+     */
+    readonly lineNumber: number;
+    /**
+     * Complete unknown commitment block, including its keyword and continuation lines.
+     */
+    readonly source: string;
+};

package/esm/src/book-2.0/agent-source/createAgentModelRequirementsWithCommitments.unknown.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,19 @@
+/**
+ * Creates the regex used to recognize the uppercase commitment type at the beginning of a Book line.
+ *
+ * A fresh regular expression keeps Monaco tokenizer state isolated from parser calls.
+ *
+ * @returns Regular expression matching one Book commitment-like line.
+ *
+ * @private internal utility of Book parsing and `<BookEditor/>`
+ */
+export declare function createBookCommitmentLineTypeRegex(): RegExp;
+/**
+ * Extracts the uppercase commitment type from a Book line, including types not registered by Promptbook.
+ *
+ * @param line - One raw Book source line.
+ * @returns Matched commitment type or `null` when the line does not begin with commitment syntax.
+ *
+ * @private internal utility of Book parsing and `<BookEditor/>`
+ */
+export declare function getBookCommitmentLineType(line: string): string | null;

package/esm/src/book-2.0/agent-source/parseAgentSourceWithCommitments.unknown.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/src/book-components/BookEditor/createUnknownCommitmentDiagnostics.d.ts

@@ -0,0 +1,28 @@
+import type { string_book } from '../../book-2.0/agent-source/string_book';
+/**
+ * Monaco diagnostic shown when a Book source uses an uppercase commitment not registered by Promptbook.
+ *
+ * @private internal type of `BookEditorMonaco`
+ */
+type UnknownCommitmentDiagnostic = {
+    readonly startLineNumber: number;
+    readonly startColumn: number;
+    readonly endLineNumber: number;
+    readonly endColumn: number;
+    readonly message: string;
+    readonly source: string;
+    readonly severity: 'error';
+};
+/**
+ * Creates Book editor diagnostics for uppercase commitments not registered by Promptbook.
+ *
+ * Unknown commitment blocks remain valid extra context in the generated system message,
+ * but the editor marks their keywords so authors can spot likely typos immediately.
+ *
+ * @param agentSource - Current editor content.
+ * @returns Error markers for all unknown commitment keywords.
+ *
+ * @private internal utility of `BookEditorMonaco`
+ */
+export declare function createUnknownCommitmentDiagnostics(agentSource?: string_book): ReadonlyArray<UnknownCommitmentDiagnostic>;
+export {};

package/esm/src/book-components/BookEditor/createUnknownCommitmentDiagnostics.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/src/cli/cli-commands/common/harness/$checkHarnessInstallation.d.ts

@@ -1,10 +1,10 @@
 import type { HarnessDefinition } from './HarnessDefinition';
 import type { HarnessInstallationStatus } from './HarnessInstallationStatus';
 /**
- * Detects whether one CLI coding harness is installed globally and whether it is up to date.
+ * Detects whether one CLI coding harness is installed globally and, when enabled, whether it is up to date.
  *
- * Note: `$` is used to indicate that this function is not a pure function - it runs the harness command and queries npm
+ * Note: `$` is used to indicate that this function is not a pure function - it runs the harness command and may query npm
  *
  * @private internal utility of `promptbookCli`
  */
-export declare function $checkHarnessInstallation(definition: HarnessDefinition): Promise<HarnessInstallationStatus>;
+export declare function $checkHarnessInstallation(definition: HarnessDefinition, isHarnessUpdateCheckEnabled?: boolean): Promise<HarnessInstallationStatus>;

package/esm/src/cli/cli-commands/common/harness/$checkHarnessInstallation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/src/cli/cli-commands/common/harness/$ensureHarnessInstallations.d.ts

@@ -1,7 +1,7 @@
 import type { PromptRunnerHarnessName } from '../promptRunnerCliOptions';
 /**
- * Checks that every given CLI coding harness is installed globally and up to date and offers to
- * install or update the ones which are not.
+ * Checks that every given CLI coding harness is installed globally and, when enabled, up to date.
+ * Offers to install missing harnesses and update outdated ones.
  *
  * Harness names which are `undefined`, for example when no `--harness` is selected in a dry run,
  * are ignored so that every call site can pass its raw selection.
@@ -10,4 +10,4 @@ import type { PromptRunnerHarnessName } from '../promptRunnerCliOptions';
  *
  * @private internal utility of `promptbookCli`
  */
-export declare function $ensureHarnessInstallations(harnessNames: ReadonlyArray<PromptRunnerHarnessName | undefined>): Promise<void>;
+export declare function $ensureHarnessInstallations(harnessNames: ReadonlyArray<PromptRunnerHarnessName | undefined>, isHarnessUpdateCheckEnabled?: boolean): Promise<void>;

package/esm/src/cli/cli-commands/common/harness/HarnessInstallationStatus.d.ts

@@ -5,11 +5,12 @@ import type { HarnessDefinition } from './HarnessDefinition';
  * - `up-to-date` the newest published version is installed
  * - `outdated` an older version is installed
  * - `not-installed` the harness command is not available globally
+ * - `installed` the harness is installed and automatic update checking was disabled
  * - `unknown` the harness is installed but the newest published version could not be resolved, for example when offline
  *
  * @private internal utility of `promptbookCli`
  */
-export type HarnessInstallationState = 'up-to-date' | 'outdated' | 'not-installed' | 'unknown';
+export type HarnessInstallationState = 'up-to-date' | 'outdated' | 'not-installed' | 'installed' | 'unknown';
 /**
  * Installation state of one CLI coding harness on the current machine.
  *
@@ -21,7 +22,7 @@ export type HarnessInstallationStatus = {
      */
     readonly definition: HarnessDefinition;
     /**
-     * Comparison of the installed version with the newest published one.
+     * Installation state, including whether the newest published version was checked.
      */
     readonly installationState: HarnessInstallationState;
     /**

package/esm/src/cli/cli-commands/common/harnessUpdateCliOptions.d.ts

@@ -0,0 +1,29 @@
+import type { Command as Program } from 'commander';
+/**
+ * Commander option bag for opting out of automatic coding-harness update checks.
+ *
+ * @private internal utility of `promptbookCli`
+ */
+export type HarnessUpdateCliOptions = {
+    readonly harnessUpdate: boolean;
+};
+/**
+ * Normalized automatic coding-harness update-check option.
+ *
+ * @private internal utility of `promptbookCli`
+ */
+export type NormalizedHarnessUpdateCliOptions = {
+    readonly isHarnessUpdateCheckEnabled: boolean;
+};
+/**
+ * Registers the shared `--no-harness-update` option on a `ptbk coder` command that uses a coding harness.
+ *
+ * @private internal utility of `promptbookCli`
+ */
+export declare function addHarnessUpdateOption(command: Program): void;
+/**
+ * Converts the Commander harness-update flag into the normalized harness-check option.
+ *
+ * @private internal utility of `promptbookCli`
+ */
+export declare function normalizeHarnessUpdateCliOptions(cliOptions: HarnessUpdateCliOptions): NormalizedHarnessUpdateCliOptions;

package/esm/src/cli/cli-commands/common/harnessUpdateCliOptions.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/src/executables/platforms/locateAppOnWindows.d.ts

@@ -1,7 +1,7 @@
 import type { string_executable_path } from '../../types/string_filename';
 import type { LocateAppOptions } from '../locateApp';
 /**
- * Attempts to locate the specified application on a Windows system by searching common installation directories.
+ * Attempts to locate the specified application on a Windows system by searching PATH and common installation directories.
  * Returns the path to the executable if found, or null otherwise.
  *
  * @private within the repository

package/esm/src/executables/platforms/locateAppOnWindows.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/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.114.0-9`).
+ * It follows semantic versioning (e.g., `0.114.0-10`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/components",
-    "version": "0.114.0-10",
+    "version": "0.114.0-12",
     "description": "Promptbook: Create persistent AI agents that turn your company's scattered knowledge into action",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -33,7 +33,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.114.0-10';
+    const PROMPTBOOK_ENGINE_VERSION = '0.114.0-12';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -18316,6 +18316,42 @@
     // TODO: [🧠] Maybe create through standardized $register
     // Note: [💞] Ignore a discrepancy between file name and entity name
 
+    /**
+     * Pattern shared by Book parsing and editor highlighting for a commitment-like line.
+     *
+     * A Book commitment keyword consists of one or more all-uppercase words with at least
+     * two characters each. This deliberately mirrors the Book editor syntax rule so an
+     * unknown keyword starts a new source block everywhere it is interpreted.
+     *
+     * @private internal constant of `getBookCommitmentLineType`
+     */
+    const BOOK_COMMITMENT_LINE_TYPE_REGEX = /^\s*(?<type>[A-Z][A-Z0-9]+(?:\s+[A-Z][A-Z0-9]+)*)(?=\s|$)/;
+    /**
+     * Creates the regex used to recognize the uppercase commitment type at the beginning of a Book line.
+     *
+     * A fresh regular expression keeps Monaco tokenizer state isolated from parser calls.
+     *
+     * @returns Regular expression matching one Book commitment-like line.
+     *
+     * @private internal utility of Book parsing and `<BookEditor/>`
+     */
+    function createBookCommitmentLineTypeRegex() {
+        return new RegExp(BOOK_COMMITMENT_LINE_TYPE_REGEX.source);
+    }
+    /**
+     * Extracts the uppercase commitment type from a Book line, including types not registered by Promptbook.
+     *
+     * @param line - One raw Book source line.
+     * @returns Matched commitment type or `null` when the line does not begin with commitment syntax.
+     *
+     * @private internal utility of Book parsing and `<BookEditor/>`
+     */
+    function getBookCommitmentLineType(line) {
+        var _a;
+        const match = BOOK_COMMITMENT_LINE_TYPE_REGEX.exec(line);
+        return ((_a = match === null || match === void 0 ? void 0 : match.groups) === null || _a === void 0 ? void 0 : _a.type) || null;
+    }
+
     /**
      * Consumes the agent-name prelude from raw source.
      *
@@ -18373,13 +18409,15 @@
             return {
                 agentName: null,
                 commitments: [],
+                unknownCommitments: [],
                 nonCommitmentLines: [],
             };
         }
         const { lines, agentName, agentNameLineIndex, agentNameLineNumber } = parseAgentSourcePrelude(agentSource);
         const commitments = [];
+        const unknownCommitments = [];
         const nonCommitmentLines = agentNameLineIndex >= 0 ? [lines[agentNameLineIndex]] : [];
-        // Parse commitments with multiline support
+        // Parse commitments with multiline support.
         let currentCommitment = null;
         // Process lines starting from after the agent name line
         const startIndex = agentNameLineIndex >= 0 ? agentNameLineIndex + 1 : 0;
@@ -18393,25 +18431,11 @@
             // Check if this line starts or ends a code block
             if (trimmedLine.startsWith('```')) {
                 isInsideCodeBlock = !isInsideCodeBlock;
-                if (currentCommitment) {
-                    // If we are inside a commitment, the code block is part of it
-                    currentCommitment.contentLines.push(line);
-                }
-                else {
-                    // If we are not inside a commitment, the code block is non-commitment
-                    nonCommitmentLines.push(line);
-                }
+                appendLineToCurrentCommitmentOrNonCommitmentLines(currentCommitment, line, nonCommitmentLines);
                 continue;
             }
             if (isInsideCodeBlock) {
-                if (currentCommitment) {
-                    // If we are inside a commitment and a code block, the line is part of the commitment
-                    currentCommitment.contentLines.push(line);
-                }
-                else {
-                    // If we are inside a code block but not a commitment, the line is non-commitment
-                    nonCommitmentLines.push(line);
-                }
+                appendLineToCurrentCommitmentOrNonCommitmentLines(currentCommitment, line, nonCommitmentLines);
                 continue;
             }
             // Check if this line starts a new commitment
@@ -18420,22 +18444,14 @@
                 const typeRegex = definition.createTypeRegex();
                 const match = typeRegex.exec(line.trim());
                 if (match && ((_a = match.groups) === null || _a === void 0 ? void 0 : _a.type)) {
-                    // Save the previous commitment if it exists
-                    if (currentCommitment) {
-                        const fullContent = currentCommitment.contentLines.join('\n');
-                        commitments.push({
-                            type: currentCommitment.type,
-                            content: spacetrim.spaceTrim(fullContent),
-                            originalLine: currentCommitment.originalStartLine,
-                            lineNumber: currentCommitment.startLineNumber,
-                        });
-                    }
+                    appendCurrentCommitment(currentCommitment, commitments, unknownCommitments);
                     // Extract the initial content from the commitment line
                     const fullRegex = definition.createRegex();
                     const fullMatch = fullRegex.exec(line.trim());
                     const initialContent = ((_b = fullMatch === null || fullMatch === void 0 ? void 0 : fullMatch.groups) === null || _b === void 0 ? void 0 : _b.contents) || '';
                     // Start a new commitment
                     currentCommitment = {
+                        kind: 'known',
                         type: definition.type,
                         startLineNumber: i + 1,
                         originalStartLine: line,
@@ -18445,52 +18461,90 @@
                     break;
                 }
             }
+            if (foundNewCommitment) {
+                continue;
+            }
+            const unknownCommitmentType = getBookCommitmentLineType(line);
+            if (unknownCommitmentType) {
+                appendCurrentCommitment(currentCommitment, commitments, unknownCommitments);
+                currentCommitment = {
+                    kind: 'unknown',
+                    type: unknownCommitmentType,
+                    startLineNumber: i + 1,
+                    originalStartLine: line,
+                    sourceLines: [line],
+                };
+                continue;
+            }
             // Check if this is a horizontal line (ends any current commitment)
             const isHorizontalLine = HORIZONTAL_LINE_PATTERN$2.test(line);
             if (isHorizontalLine) {
-                // Save the current commitment if it exists
-                if (currentCommitment) {
-                    const fullContent = currentCommitment.contentLines.join('\n');
-                    commitments.push({
-                        type: currentCommitment.type,
-                        content: spacetrim.spaceTrim(fullContent),
-                        originalLine: currentCommitment.originalStartLine,
-                        lineNumber: currentCommitment.startLineNumber,
-                    });
-                    currentCommitment = null;
-                }
+                appendCurrentCommitment(currentCommitment, commitments, unknownCommitments);
+                currentCommitment = null;
                 // Add horizontal line to non-commitment lines
                 nonCommitmentLines.push(line);
                 continue;
             }
-            if (!foundNewCommitment) {
-                if (currentCommitment) {
-                    // This line belongs to the current commitment
-                    currentCommitment.contentLines.push(line);
-                }
-                else {
-                    // This line is not part of any commitment
-                    nonCommitmentLines.push(line);
-                }
-            }
-        }
-        // Don't forget to save the last commitment if it exists
-        if (currentCommitment) {
-            const fullContent = currentCommitment.contentLines.join('\n');
-            commitments.push({
-                type: currentCommitment.type,
-                content: spacetrim.spaceTrim(fullContent),
-                originalLine: currentCommitment.originalStartLine,
-                lineNumber: currentCommitment.startLineNumber,
-            });
+            appendLineToCurrentCommitmentOrNonCommitmentLines(currentCommitment, line, nonCommitmentLines);
         }
+        appendCurrentCommitment(currentCommitment, commitments, unknownCommitments);
         return {
             agentName,
             agentNameLineNumber,
             commitments,
+            unknownCommitments,
             nonCommitmentLines,
         };
     }
+    /**
+     * Stores the current known or unknown commitment in its appropriate parsed collection.
+     *
+     * @param currentCommitment - Commitment-like block collected so far.
+     * @param commitments - Parsed registered commitments to append to.
+     * @param unknownCommitments - Parsed unregistered commitments to append to.
+     *
+     * @private internal utility of `parseAgentSourceWithCommitments`
+     */
+    function appendCurrentCommitment(currentCommitment, commitments, unknownCommitments) {
+        if (!currentCommitment) {
+            return;
+        }
+        if (currentCommitment.kind === 'unknown') {
+            unknownCommitments.push({
+                type: currentCommitment.type,
+                originalLine: currentCommitment.originalStartLine,
+                lineNumber: currentCommitment.startLineNumber,
+                source: spacetrim.spaceTrim(currentCommitment.sourceLines.join('\n')),
+            });
+            return;
+        }
+        commitments.push({
+            type: currentCommitment.type,
+            content: spacetrim.spaceTrim(currentCommitment.contentLines.join('\n')),
+            originalLine: currentCommitment.originalStartLine,
+            lineNumber: currentCommitment.startLineNumber,
+        });
+    }
+    /**
+     * Adds one source line to the active commitment-like block, or to plain source content when none is active.
+     *
+     * @param currentCommitment - Commitment-like block currently being collected.
+     * @param line - Source line to append.
+     * @param nonCommitmentLines - Plain source lines to append to when no block is active.
+     *
+     * @private internal utility of `parseAgentSourceWithCommitments`
+     */
+    function appendLineToCurrentCommitmentOrNonCommitmentLines(currentCommitment, line, nonCommitmentLines) {
+        if (!currentCommitment) {
+            nonCommitmentLines.push(line);
+            return;
+        }
+        if (currentCommitment.kind === 'unknown') {
+            currentCommitment.sourceLines.push(line);
+            return;
+        }
+        currentCommitment.contentLines.push(line);
+    }
 
     /**
      * Parses parameters from text using both supported notations:
@@ -19995,6 +20049,35 @@
         return [];
     }
 
+    /**
+     * Creates Book editor diagnostics for uppercase commitments not registered by Promptbook.
+     *
+     * Unknown commitment blocks remain valid extra context in the generated system message,
+     * but the editor marks their keywords so authors can spot likely typos immediately.
+     *
+     * @param agentSource - Current editor content.
+     * @returns Error markers for all unknown commitment keywords.
+     *
+     * @private internal utility of `BookEditorMonaco`
+     */
+    function createUnknownCommitmentDiagnostics(agentSource) {
+        if (!(agentSource === null || agentSource === void 0 ? void 0 : agentSource.trim())) {
+            return [];
+        }
+        return parseAgentSourceWithCommitments(agentSource).unknownCommitments.map((commitment) => {
+            const startColumn = commitment.originalLine.indexOf(commitment.type) + 1;
+            return {
+                startLineNumber: commitment.lineNumber,
+                startColumn,
+                endLineNumber: commitment.lineNumber,
+                endColumn: startColumn + commitment.type.length,
+                message: `Unknown commitment \`${commitment.type}\` is added to the system message as extra context.`,
+                source: 'Promptbook',
+                severity: 'error',
+            };
+        });
+    }
+
     /**
      * Adds visual decorations for separators and code blocks inside `BookEditorMonaco`.
      *
@@ -20441,7 +20524,7 @@
      *
      * @private function of BookEditorMonaco
      */
-    const DYNAMIC_COMMITMENT_REGEX = /^\s*[A-Z][A-Z0-9]+(?:\s+[A-Z][A-Z0-9]+)*(?=\s|$)/;
+    const DYNAMIC_COMMITMENT_REGEX = createBookCommitmentLineTypeRegex();
     /**
      * Regex pattern to match horizontal lines.
      *
@@ -22144,7 +22227,11 @@
             editor,
             handleFiles,
         });
-        const combinedDiagnostics = [...(diagnostics || []), ...createDeprecatedCommitmentDiagnostics()];
+        const combinedDiagnostics = [
+            ...(diagnostics || []),
+            ...createDeprecatedCommitmentDiagnostics(),
+            ...createUnknownCommitmentDiagnostics(value),
+        ];
         const isActionBarVisible = isBookEditorMonacoActionbarVisible({
             hoistedMenuItems,
             isUploadButtonShown,
@@ -49293,7 +49380,8 @@
         requirements = await importReferencedFiles(requirements);
         requirements = appendMcpServers(requirements, agentSource);
         requirements = appendNonCommitmentContent(requirements, parseResult);
-        return appendExampleInteractions(requirements, parseResult);
+        requirements = appendExampleInteractions(requirements, parseResult);
+        return appendUnknownCommitmentContent(requirements, parseResult);
     }
     /**
      * Imports text files referenced by IMPORT commitments and appends their transformed content to the system message.
@@ -49415,6 +49503,36 @@
         }
         return appendSystemMessageSection(requirements, nonCommitmentContent);
     }
+    /**
+     * Appends unknown commitment blocks as final extra context without applying commitment side effects.
+     *
+     * @param requirements - Current requirements snapshot.
+     * @param parseResult - Parsed source including unknown commitment blocks.
+     * @returns Requirements with unknown commitment context appended at the end of the system message.
+     *
+     * @private internal utility of `augmentAgentModelRequirementsFromSource`
+     */
+    function appendUnknownCommitmentContent(requirements, parseResult) {
+        const unknownCommitmentContent = getUnknownCommitmentContent(parseResult);
+        if (!unknownCommitmentContent) {
+            return requirements;
+        }
+        return appendSystemMessageSection(requirements, unknownCommitmentContent);
+    }
+    /**
+     * Joins unknown commitment blocks into their final extra-context representation.
+     *
+     * @param parseResult - Parsed source including unknown commitment blocks.
+     * @returns Unknown commitment source blocks in their original order.
+     *
+     * @private internal utility of `appendUnknownCommitmentContent`
+     */
+    function getUnknownCommitmentContent(parseResult) {
+        return parseResult.unknownCommitments
+            .map((commitment) => commitment.source)
+            .filter(Boolean)
+            .join('\n\n');
+    }
     /**
      * Collects plain-text lines that were not parsed as commitments and should still become part of the final system message.
      *