@promptbook/utils 0.110.0 → 0.111.0-0

package/umd/index.umd.js

@@ -23,7 +23,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.110.0';
+    const PROMPTBOOK_ENGINE_VERSION = '0.111.0-0';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -3075,6 +3075,79 @@
      * Note: [💞] Ignore a discrepancy between file name and entity name
      */
 
+    /**
+     * HTTP header used by Promptbook clients to advertise their release version.
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    const CLIENT_VERSION_HEADER = 'x-promptbook-client-version';
+    /**
+     * The latest client (engine) version that the server expects.
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    const CLIENT_LATEST_VERSION = PROMPTBOOK_ENGINE_VERSION;
+    /**
+     * Determines if the provided version string exactly matches the latest release.
+     *
+     * @param version - Version string obtained from a request header.
+     * @returns True when the version equals `CLIENT_LATEST_VERSION`.
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    function isClientVersionCompatible(version) {
+        return typeof version === 'string' && version === CLIENT_LATEST_VERSION;
+    }
+    /**
+     * Formats the message that should be shown when a client is out of date.
+     *
+     * @param clientVersion - The version reported by the client (optional).
+     * @returns User-facing text explaining how to fix the mismatch.
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    function formatClientVersionMismatchMessage(clientVersion) {
+        const reportedVersion = clientVersion !== null && clientVersion !== void 0 ? clientVersion : 'unknown';
+        return spaceTrim__default["default"](`
+        Your Promptbook client (v${reportedVersion}) is out of date.
+        This server runs on Vercel and now requires v${CLIENT_LATEST_VERSION}.
+        Please update the app or reload the latest release before you continue using chat.
+    `);
+    }
+    /**
+     * Creates a headers object that includes the client version header.
+     *
+     * @param headers - Optional base headers to clone.
+     * @returns New headers object augmented with `CLIENT_VERSION_HEADER`.
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    function attachClientVersionHeader(headers) {
+        return {
+            ...(headers !== null && headers !== void 0 ? headers : {}),
+            [CLIENT_VERSION_HEADER]: CLIENT_LATEST_VERSION,
+        };
+    }
+    /**
+     * Normalizes the client version reported inside a `HeadersInit` object.
+     *
+     * @param headers - Headers collection to read from.
+     * @returns The trimmed client version or `null` when it is missing.
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    function getClientVersionFromHeaders(headers) {
+        if (!headers) {
+            return null;
+        }
+        const normalizedHeaders = new Headers(headers);
+        const value = normalizedHeaders.get(CLIENT_VERSION_HEADER);
+        return value ? value.trim() : null;
+    }
+    /**
+     * Note: [💞] Ignore a discrepancy between file name and entity name
+     */
+
     /**
      * Detects if the code is running in a browser environment in main thread (Not in a web worker)
      *
@@ -5695,6 +5768,8 @@
     exports.$isRunningInWebWorker = $isRunningInWebWorker;
     exports.BOOK_LANGUAGE_VERSION = BOOK_LANGUAGE_VERSION;
     exports.CHARACTERS_PER_STANDARD_LINE = CHARACTERS_PER_STANDARD_LINE;
+    exports.CLIENT_LATEST_VERSION = CLIENT_LATEST_VERSION;
+    exports.CLIENT_VERSION_HEADER = CLIENT_VERSION_HEADER;
     exports.CountUtils = CountUtils;
     exports.DIACRITIC_VARIANTS_LETTERS = DIACRITIC_VARIANTS_LETTERS;
     exports.LINES_PER_STANDARD_PAGE = LINES_PER_STANDARD_PAGE;
@@ -5702,6 +5777,7 @@
     exports.PromptString = PromptString;
     exports.SMALL_NUMBER = SMALL_NUMBER;
     exports.VALUE_STRINGS = VALUE_STRINGS;
+    exports.attachClientVersionHeader = attachClientVersionHeader;
     exports.capitalize = capitalize;
     exports.checkSerializableAsJson = checkSerializableAsJson;
     exports.clonePipeline = clonePipeline;
@@ -5720,7 +5796,10 @@
     exports.exportJson = exportJson;
     exports.extractParameterNames = extractParameterNames;
     exports.forEachAsync = forEachAsync;
+    exports.formatClientVersionMismatchMessage = formatClientVersionMismatchMessage;
+    exports.getClientVersionFromHeaders = getClientVersionFromHeaders;
     exports.intersection = intersection;
+    exports.isClientVersionCompatible = isClientVersionCompatible;
     exports.isHostnameOnPrivateNetwork = isHostnameOnPrivateNetwork;
     exports.isRootPath = isRootPath;
     exports.isSerializableAsJson = isSerializableAsJson;