@promptbook/core 0.112.0 → 0.113.0-1

package/umd/index.umd.js

@@ -1,8 +1,8 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('crypto-js'), require('crypto-js/enc-hex'), require('spacetrim'), require('rxjs'), require('waitasecond'), require('crypto-js/sha256'), require('path'), require('mime-types'), require('papaparse'), require('moment'), require('crypto'), require('colors'), require('@openai/agents'), require('bottleneck'), require('openai')) :
-    typeof define === 'function' && define.amd ? define(['exports', 'crypto-js', 'crypto-js/enc-hex', 'spacetrim', 'rxjs', 'waitasecond', 'crypto-js/sha256', 'path', 'mime-types', 'papaparse', 'moment', 'crypto', 'colors', '@openai/agents', 'bottleneck', 'openai'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-core"] = {}, global.CryptoJS, global.hexEncoder, global.spacetrim, global.rxjs, global.waitasecond, global.sha256, global.path, global.mimeTypes, global.papaparse, global.moment, global.crypto, global.colors, global.agents, global.Bottleneck, global.OpenAI));
-})(this, (function (exports, CryptoJS, hexEncoder, spacetrim, rxjs, waitasecond, sha256, path, mimeTypes, papaparse, moment, crypto, colors, agents, Bottleneck, OpenAI) { 'use strict';
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('spacetrim'), require('crypto-js'), require('crypto-js/enc-hex'), require('rxjs'), require('waitasecond'), require('crypto-js/sha256'), require('path'), require('mime-types'), require('papaparse'), require('moment'), require('crypto'), require('colors'), require('@openai/agents'), require('bottleneck'), require('openai')) :
+    typeof define === 'function' && define.amd ? define(['exports', 'spacetrim', 'crypto-js', 'crypto-js/enc-hex', 'rxjs', 'waitasecond', 'crypto-js/sha256', 'path', 'mime-types', 'papaparse', 'moment', 'crypto', 'colors', '@openai/agents', 'bottleneck', 'openai'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-core"] = {}, global.spacetrim, global.CryptoJS, global.hexEncoder, global.rxjs, global.waitasecond, global.sha256, global.path, global.mimeTypes, global.papaparse, global.moment, global.crypto, global.colors, global.agents, global.Bottleneck, global.OpenAI));
+})(this, (function (exports, spacetrim, CryptoJS, hexEncoder, rxjs, waitasecond, sha256, path, mimeTypes, papaparse, moment, crypto, colors, agents, Bottleneck, OpenAI) { 'use strict';
 
     function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -29,12 +29,26 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.112.0';
+    const PROMPTBOOK_ENGINE_VERSION = '0.113.0-1';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
      */
 
+    /**
+     * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
+     *
+     * @public exported from `@promptbook/core`
+     */
+    class ParseError extends Error {
+        constructor(message) {
+            super(message);
+            this.name = 'ParseError';
+            Object.setPrototypeOf(this, ParseError.prototype);
+        }
+    }
+    // TODO: Maybe split `ParseError` and `ApplyError`
+
     /**
      * Trims string from all 4 sides
      *
@@ -47,6 +61,181 @@
      */
     const spaceTrim = spacetrim.spaceTrim;
 
+    /**
+     * Supported visibility states for persisted agents.
+     *
+     * @public exported from `@promptbook/core`
+     */
+    const AGENT_VISIBILITY_VALUES = ['PRIVATE', 'UNLISTED', 'PUBLIC'];
+    /**
+     * Fallback visibility used when no valid value is configured.
+     *
+     * @public exported from `@promptbook/core`
+     */
+    const DEFAULT_AGENT_VISIBILITY = 'UNLISTED';
+    /**
+     * Matches a single-line `META VISIBILITY` commitment in book source.
+     */
+    const META_VISIBILITY_LINE_PATTERN = /^(\s*)META\s+VISIBILITY\b([\s\S]*)$/iu;
+    /**
+     * Returns `true` when the value is one of supported visibility states.
+     *
+     * @param value - Raw value to validate.
+     * @returns Whether the value is a valid `AgentVisibility`.
+     *
+     * @public exported from `@promptbook/core`
+     */
+    function isAgentVisibility(value) {
+        return typeof value === 'string' && AGENT_VISIBILITY_VALUES.includes(value);
+    }
+    /**
+     * Normalizes raw visibility text into a supported value.
+     *
+     * @param value - Raw visibility value.
+     * @returns Normalized visibility, or `null` when invalid.
+     *
+     * @public exported from `@promptbook/core`
+     */
+    function normalizeAgentVisibility(value) {
+        if (typeof value !== 'string') {
+            return null;
+        }
+        const normalized = value.trim().toUpperCase();
+        return isAgentVisibility(normalized) ? normalized : null;
+    }
+    /**
+     * Parses visibility from an unknown value with a safe fallback.
+     *
+     * @param value - Raw visibility value.
+     * @param fallback - Fallback when the value is invalid.
+     * @returns Parsed visibility.
+     *
+     * @public exported from `@promptbook/core`
+     */
+    function parseAgentVisibility(value, fallback = DEFAULT_AGENT_VISIBILITY) {
+        var _a;
+        return (_a = normalizeAgentVisibility(value)) !== null && _a !== void 0 ? _a : fallback;
+    }
+    /**
+     * Parses visibility and throws when the value is not supported.
+     *
+     * @param value - Raw visibility value.
+     * @param sourceLabel - Human-readable source used in the error message.
+     * @returns Parsed visibility.
+     *
+     * @public exported from `@promptbook/core`
+     */
+    function parseAgentVisibilityStrict(value, sourceLabel = 'visibility') {
+        const visibility = normalizeAgentVisibility(value);
+        if (visibility) {
+            return visibility;
+        }
+        throw new ParseError(spaceTrim(`
+            Invalid ${sourceLabel}.
+
+            Value must be one of: ${AGENT_VISIBILITY_VALUES.map((allowedValue) => `\`${allowedValue}\``).join(', ')}.
+        `));
+    }
+    /**
+     * Extracts the last `META VISIBILITY` value from an agent source.
+     *
+     * @param agentSource - Raw book source.
+     * @param options - Strict parsing options.
+     * @returns Normalized visibility, or `null` when no commitment is present.
+     *
+     * @public exported from `@promptbook/core`
+     */
+    function parseAgentSourceVisibility(agentSource, options = {}) {
+        let visibilityContent = null;
+        for (const line of agentSource.split(/\r?\n/u)) {
+            const lineMatch = META_VISIBILITY_LINE_PATTERN.exec(line);
+            if (lineMatch) {
+                visibilityContent = lineMatch[2].trim();
+            }
+        }
+        if (visibilityContent === null) {
+            return null;
+        }
+        const visibility = normalizeAgentVisibility(visibilityContent);
+        if (visibility || !options.isStrict) {
+            return visibility;
+        }
+        return parseAgentVisibilityStrict(visibilityContent, '`META VISIBILITY` commitment');
+    }
+    /**
+     * Returns whether an agent should be listed publicly in anonymous views.
+     *
+     * @param visibility - Agent visibility to evaluate.
+     * @returns `true` for publicly listed agents.
+     *
+     * @public exported from `@promptbook/core`
+     */
+    function isPublicAgentVisibility(visibility) {
+        return visibility === 'PUBLIC';
+    }
+    /**
+     * Returns the next visibility in UI rotation order.
+     *
+     * @param visibility - Current visibility.
+     * @returns Next visibility value.
+     *
+     * @public exported from `@promptbook/core`
+     */
+    function getNextAgentVisibility(visibility) {
+        switch (visibility) {
+            case 'PRIVATE':
+                return 'UNLISTED';
+            case 'UNLISTED':
+                return 'PUBLIC';
+            case 'PUBLIC':
+            default:
+                return 'PRIVATE';
+        }
+    }
+    /**
+     * Inserts or replaces the `META VISIBILITY` commitment in a book source.
+     *
+     * @param agentSource - Raw book source.
+     * @param visibility - Visibility to persist.
+     * @returns Source with exactly one normalized `META VISIBILITY` line.
+     *
+     * @public exported from `@promptbook/core`
+     */
+    function setAgentSourceVisibility(agentSource, visibility) {
+        var _a;
+        const normalizedVisibility = parseAgentVisibilityStrict(visibility, '`META VISIBILITY` commitment');
+        const lines = agentSource.split(/\r?\n/u);
+        const nextLines = [];
+        let isVisibilityLineWritten = false;
+        for (const line of lines) {
+            const lineMatch = META_VISIBILITY_LINE_PATTERN.exec(line);
+            if (!lineMatch) {
+                nextLines.push(line);
+                continue;
+            }
+            if (isVisibilityLineWritten) {
+                continue;
+            }
+            nextLines.push(`${(_a = lineMatch[1]) !== null && _a !== void 0 ? _a : ''}META VISIBILITY ${normalizedVisibility}`);
+            isVisibilityLineWritten = true;
+        }
+        if (!isVisibilityLineWritten) {
+            nextLines.splice(findMetaVisibilityInsertIndex(nextLines), 0, `META VISIBILITY ${normalizedVisibility}`);
+        }
+        return nextLines.join('\n');
+    }
+    /**
+     * Finds the position after the first non-empty line, which is the agent title.
+     *
+     * @param lines - Source lines.
+     * @returns Insertion index for profile metadata.
+     */
+    function findMetaVisibilityInsertIndex(lines) {
+        const titleLineIndex = lines.findIndex((line) => line.trim().length > 0);
+        return titleLineIndex === -1 ? 0 : titleLineIndex + 1;
+    }
+    // Note: [💞] Ignore a discrepancy between file name and entity name
+
     /**
      * Class implementing take chain.
      *
@@ -1770,20 +1959,6 @@
         }
     }
 
-    /**
-     * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
-     *
-     * @public exported from `@promptbook/core`
-     */
-    class ParseError extends Error {
-        constructor(message) {
-            super(message);
-            this.name = 'ParseError';
-            Object.setPrototypeOf(this, ParseError.prototype);
-        }
-    }
-    // TODO: Maybe split `ParseError` and `ApplyError`
-
     /**
      * Function isValidJsonString will tell you if the string is valid JSON or not
      *
@@ -18591,6 +18766,70 @@
     }
     // Note: [💞] Ignore a discrepancy between file name and entity name
 
+    /**
+     * META VISIBILITY commitment definition.
+     *
+     * The `META VISIBILITY` commitment stores whether an agent is public, private, or unlisted.
+     * Agents Server mirrors this value into the database for efficient filtering, but the book
+     * commitment remains the editable source of truth.
+     *
+     * @private Metadata-only commitment used by Agents Server.
+     */
+    class MetaVisibilityCommitmentDefinition extends BaseCommitmentDefinition {
+        constructor() {
+            super('META VISIBILITY');
+        }
+        /**
+         * Short one-line description of META VISIBILITY.
+         */
+        get description() {
+            return 'Set whether the agent is private, unlisted, or public.';
+        }
+        /**
+         * Icon for this commitment.
+         */
+        get icon() {
+            return '👁️';
+        }
+        /**
+         * Markdown documentation for META VISIBILITY commitment.
+         */
+        get documentation() {
+            return spacetrim.spaceTrim(`
+            # META VISIBILITY
+
+            Sets the agent visibility used by Agents Server.
+
+            ## Allowed values
+
+            - \`PRIVATE\` - accessible only to signed-in users with access.
+            - \`UNLISTED\` - accessible by direct link but hidden from public listings.
+            - \`PUBLIC\` - visible in public listings and accessible by anyone.
+
+            ## Key aspects
+
+            - Does not modify the agent's behavior, system message, or tools.
+            - Whitespace and letter case are normalized when persisted.
+            - If multiple \`META VISIBILITY\` commitments are present, persistence keeps one normalized value.
+            - Agents Server mirrors the value into the database for filtering, but the book is the source of truth.
+
+            ## Example
+
+            \`\`\`book
+            Helpful Assistant
+
+            GOAL Be helpful and friendly.
+            META VISIBILITY PUBLIC
+            \`\`\`
+        `);
+        }
+        applyToAgentModelRequirements(requirements, content) {
+            // META VISIBILITY is metadata only and does not alter model requirements.
+            return requirements;
+        }
+    }
+    // Note: [💞] Ignore a discrepancy between file name and entity name
+
     /**
      * META VOICE commitment definition
      *
@@ -27114,6 +27353,7 @@
         new MetaDomainCommitmentDefinition(),
         new MetaDisclaimerCommitmentDefinition(),
         new MetaInputPlaceholderCommitmentDefinition(),
+        new MetaVisibilityCommitmentDefinition(),
         new MetaCommitmentDefinition(),
         new MetaVoiceCommitmentDefinition(),
         new NoteCommitmentDefinition('NOTE'),
@@ -28458,6 +28698,7 @@
         'META COLOR': applyMetaColorContent,
         'META FONT': applyMetaFontContent,
         'META VOICE': applyMetaVoiceContent,
+        'META VISIBILITY': applyMetaVisibilityContent,
     };
     /**
      * Applies META-style commitments that mutate parsed profile metadata.
@@ -28487,6 +28728,10 @@
             applyMetaAvatarContent(state, metaValue);
             return;
         }
+        if (metaTypeRaw.toUpperCase() === 'VISIBILITY') {
+            applyMetaVisibilityContent(state, metaValue);
+            return;
+        }
         const metaType = normalizeTo_camelCase(metaTypeRaw);
         state.meta[metaType] = metaValue;
     }
@@ -28563,6 +28808,15 @@
     function applyMetaVoiceContent(state, content) {
         state.meta.voice = spacetrim.spaceTrim(content);
     }
+    /**
+     * Applies META VISIBILITY content into the normalized `meta.visibility` field.
+     */
+    function applyMetaVisibilityContent(state, content) {
+        const visibility = normalizeAgentVisibility(content);
+        if (visibility) {
+            state.meta.visibility = visibility;
+        }
+    }
     /**
      * Normalizes the separator in the content
      *
@@ -29668,6 +29922,7 @@
         'META DESCRIPTION',
         'META DISCLAIMER',
         'META INPUT PLACEHOLDER',
+        'META VISIBILITY',
         'META COLOR',
         'META FONT',
         'META VOICE',
@@ -30343,18 +30598,23 @@
      *
      * @private shared persistence helper for `AgentCollectionInSupabase`
      */
-    function prepareAgentSourceForPersistence(agentSource) {
-        let agentProfile = parseAgentSource(agentSource);
-        const permanentId = agentProfile.permanentId;
-        const strippedAgentSource = stripMetaIdLines(agentSource);
-        if (strippedAgentSource !== agentSource) {
-            agentSource = strippedAgentSource;
-            agentProfile = parseAgentSource(agentSource);
-        }
+    function prepareAgentSourceForPersistence(agentSource, options = {}) {
+        var _a, _b, _c;
+        const originalAgentProfile = parseAgentSource(agentSource);
+        const permanentId = originalAgentProfile.permanentId;
+        agentSource = stripMetaIdLines(agentSource);
+        const sourceVisibility = parseAgentSourceVisibility(agentSource, { isStrict: true });
+        const resolvedVisibility = options.isVisibilityOverride || !sourceVisibility
+            ? (_b = (_a = options.visibility) !== null && _a !== void 0 ? _a : sourceVisibility) !== null && _b !== void 0 ? _b : DEFAULT_AGENT_VISIBILITY
+            : sourceVisibility;
+        agentSource = setAgentSourceVisibility(agentSource, resolvedVisibility);
+        const agentProfile = parseAgentSource(agentSource);
+        const visibility = (_c = parseAgentSourceVisibility(agentSource, { isStrict: true })) !== null && _c !== void 0 ? _c : undefined;
         return {
             agentProfile,
             agentSource,
             permanentId,
+            visibility,
         };
     }
     /**
@@ -30385,8 +30645,11 @@
      * @private shared persistence helper for `AgentCollectionInSupabase`
      */
     function createAgentPersistenceRecords(agentSource, options = {}, createdAt = new Date().toISOString()) {
-        const preparedAgentSource = prepareAgentSourceForPersistence(agentSource);
-        const { agentProfile, agentSource: normalizedAgentSource } = preparedAgentSource;
+        const preparedAgentSource = prepareAgentSourceForPersistence(agentSource, {
+            visibility: options.visibility,
+            isVisibilityOverride: options.visibility !== undefined,
+        });
+        const { agentProfile, agentSource: normalizedAgentSource, visibility } = preparedAgentSource;
         const permanentId = preparedAgentSource.permanentId || $randomBase58(14);
         const { agentName, agentHash } = agentProfile;
         const agentInsertRecord = {
@@ -30406,8 +30669,8 @@
         if (options.sortOrder !== undefined) {
             agentInsertRecord.sortOrder = options.sortOrder;
         }
-        if (options.visibility !== undefined) {
-            agentInsertRecord.visibility = options.visibility;
+        if (visibility !== undefined) {
+            agentInsertRecord.visibility = visibility;
         }
         return {
             createdAgent: {
@@ -30624,7 +30887,7 @@
         async updateAgentSource(permanentId, agentSource, options = {}) {
             const selectPreviousAgentResult = await this.supabaseClient
                 .from(this.getTableName('Agent'))
-                .select('agentHash,agentName,permanentId')
+                .select('agentHash,agentName,permanentId,visibility')
                 .eq('permanentId', permanentId)
                 .single();
             if (selectPreviousAgentResult.error) {
@@ -30639,8 +30902,11 @@
             selectPreviousAgentResult.data.agentName;
             const previousAgentHash = selectPreviousAgentResult.data.agentHash;
             const previousPermanentId = selectPreviousAgentResult.data.permanentId;
-            const preparedAgentSource = prepareAgentSourceForPersistence(agentSource);
-            const { agentProfile, agentSource: normalizedAgentSource } = preparedAgentSource;
+            const previousVisibility = selectPreviousAgentResult.data.visibility;
+            const preparedAgentSource = prepareAgentSourceForPersistence(agentSource, {
+                visibility: previousVisibility,
+            });
+            const { agentProfile, agentSource: normalizedAgentSource, visibility } = preparedAgentSource;
             let { permanentId: newPermanentId } = preparedAgentSource;
             const { agentHash, agentName } = agentProfile;
             if (!newPermanentId && previousPermanentId) {
@@ -30662,6 +30928,7 @@
                 updatedAt: new Date().toISOString(),
                 agentHash: agentProfile.agentHash,
                 agentSource: normalizedAgentSource,
+                visibility: visibility !== null && visibility !== void 0 ? visibility : previousVisibility,
                 promptbookEngineVersion: PROMPTBOOK_ENGINE_VERSION,
             })
                 .eq('permanentId', permanentId);
@@ -50852,6 +51119,7 @@
     exports.$scrapersRegister = $scrapersRegister;
     exports.ADMIN_EMAIL = ADMIN_EMAIL;
     exports.ADMIN_GITHUB_NAME = ADMIN_GITHUB_NAME;
+    exports.AGENT_VISIBILITY_VALUES = AGENT_VISIBILITY_VALUES;
     exports.API_REQUEST_TIMEOUT = API_REQUEST_TIMEOUT;
     exports.AbstractFormatError = AbstractFormatError;
     exports.Agent = Agent;
@@ -50879,6 +51147,7 @@
     exports.CsvFormatError = CsvFormatError;
     exports.CsvFormatParser = CsvFormatParser;
     exports.DEFAULT_AGENTS_DIRNAME = DEFAULT_AGENTS_DIRNAME;
+    exports.DEFAULT_AGENT_VISIBILITY = DEFAULT_AGENT_VISIBILITY;
     exports.DEFAULT_BOOK = DEFAULT_BOOK;
     exports.DEFAULT_BOOKS_DIRNAME = DEFAULT_BOOKS_DIRNAME;
     exports.DEFAULT_BOOK_OUTPUT_PARAMETER_NAME = DEFAULT_BOOK_OUTPUT_PARAMETER_NAME;
@@ -51025,14 +51294,17 @@
     exports.getAllCommitmentsToolTitles = getAllCommitmentsToolTitles;
     exports.getCommitmentDefinition = getCommitmentDefinition;
     exports.getGroupedCommitmentDefinitions = getGroupedCommitmentDefinitions;
+    exports.getNextAgentVisibility = getNextAgentVisibility;
     exports.getPipelineInterface = getPipelineInterface;
     exports.getSingleLlmExecutionTools = getSingleLlmExecutionTools;
     exports.identificationToPromptbookToken = identificationToPromptbookToken;
+    exports.isAgentVisibility = isAgentVisibility;
     exports.isCommitmentSupported = isCommitmentSupported;
     exports.isPassingExpectations = isPassingExpectations;
     exports.isPipelineImplementingInterface = isPipelineImplementingInterface;
     exports.isPipelineInterfacesEqual = isPipelineInterfacesEqual;
     exports.isPipelinePrepared = isPipelinePrepared;
+    exports.isPublicAgentVisibility = isPublicAgentVisibility;
     exports.isValidBook = isValidBook;
     exports.isValidPipelineString = isValidPipelineString;
     exports.joinLlmExecutionTools = joinLlmExecutionTools;
@@ -51040,9 +51312,13 @@
     exports.makeKnowledgeSourceHandler = makeKnowledgeSourceHandler;
     exports.migratePipeline = migratePipeline;
     exports.normalizeAgentName = normalizeAgentName;
+    exports.normalizeAgentVisibility = normalizeAgentVisibility;
     exports.normalizeChatAttachments = normalizeChatAttachments;
     exports.padBook = padBook;
     exports.parseAgentSource = parseAgentSource;
+    exports.parseAgentSourceVisibility = parseAgentSourceVisibility;
+    exports.parseAgentVisibility = parseAgentVisibility;
+    exports.parseAgentVisibilityStrict = parseAgentVisibilityStrict;
     exports.parseParameters = parseParameters;
     exports.parsePipeline = parsePipeline;
     exports.pipelineCollectionToJson = pipelineCollectionToJson;
@@ -51054,6 +51330,7 @@
     exports.promptbookFetch = promptbookFetch;
     exports.promptbookTokenToIdentification = promptbookTokenToIdentification;
     exports.resolveChatAttachmentContents = resolveChatAttachmentContents;
+    exports.setAgentSourceVisibility = setAgentSourceVisibility;
     exports.unpreparePipeline = unpreparePipeline;
     exports.usageToHuman = usageToHuman;
     exports.usageToWorktime = usageToWorktime;