@promptbook/utils 0.110.0 → 0.111.0-1

package/README.md

@@ -27,6 +27,10 @@ Turn your company's scattered knowledge into AI ready Books
 
 
 
+<blockquote style="color: #ff8811">
+    <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
+</blockquote>
+
 ## 📦 Package `@promptbook/utils`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).

package/esm/index.es.js

@@ -18,7 +18,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.110.0';
+const PROMPTBOOK_ENGINE_VERSION = '0.111.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
@@ -3070,6 +3070,79 @@ const promptTemplate = prompt;
  * 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$2(`
+        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)
  *
@@ -5681,5 +5754,5 @@ function isValidUuid(value) {
     return /^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$/i.test(value);
 }
 
-export { $deepFreeze, $detectRuntimeEnvironment, $getCurrentDate, $isRunningInBrowser, $isRunningInJest, $isRunningInNode, $isRunningInWebWorker, BOOK_LANGUAGE_VERSION, CHARACTERS_PER_STANDARD_LINE, CountUtils, DIACRITIC_VARIANTS_LETTERS, LINES_PER_STANDARD_PAGE, PROMPTBOOK_ENGINE_VERSION, PromptString, SMALL_NUMBER, VALUE_STRINGS, capitalize, checkSerializableAsJson, clonePipeline, computeHash, countCharacters, countLines, countPages, countParagraphs, countSentences, countWords, debounce, decapitalize, deepClone, deserializeError, difference, exportJson, extractParameterNames, forEachAsync, intersection, isHostnameOnPrivateNetwork, isRootPath, isSerializableAsJson, isUrlOnPrivateNetwork, isValidAgentUrl, isValidCsvString, isValidEmail, isValidFilePath, isValidJavascriptName, isValidJsonString, isValidKeyword, isValidPipelineUrl, isValidPromptbookVersion, isValidSemanticVersion, isValidUrl, isValidUuid, isValidXmlString, jsonParse, jsonStringsToJsons, linguisticHash, nameToUriPart, nameToUriParts, normalizeMessageText, normalizeToKebabCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_camelCase, normalizeTo_snake_case, normalizeWhitespaces, numberToString, orderJson, parseKeywords, parseKeywordsFromString, parseNumber, prompt, promptTemplate, removeDiacritics, removeEmojis, removeQuotes, renderPromptbookMermaid, searchKeywords, serializeError, serializeToPromptbookJavascript, spaceTrim, splitIntoSentences, suffixUrl, templateParameters, titleToName, union, unwrapResult, valueToString };
+export { $deepFreeze, $detectRuntimeEnvironment, $getCurrentDate, $isRunningInBrowser, $isRunningInJest, $isRunningInNode, $isRunningInWebWorker, BOOK_LANGUAGE_VERSION, CHARACTERS_PER_STANDARD_LINE, CLIENT_LATEST_VERSION, CLIENT_VERSION_HEADER, CountUtils, DIACRITIC_VARIANTS_LETTERS, LINES_PER_STANDARD_PAGE, PROMPTBOOK_ENGINE_VERSION, PromptString, SMALL_NUMBER, VALUE_STRINGS, attachClientVersionHeader, capitalize, checkSerializableAsJson, clonePipeline, computeHash, countCharacters, countLines, countPages, countParagraphs, countSentences, countWords, debounce, decapitalize, deepClone, deserializeError, difference, exportJson, extractParameterNames, forEachAsync, formatClientVersionMismatchMessage, getClientVersionFromHeaders, intersection, isClientVersionCompatible, isHostnameOnPrivateNetwork, isRootPath, isSerializableAsJson, isUrlOnPrivateNetwork, isValidAgentUrl, isValidCsvString, isValidEmail, isValidFilePath, isValidJavascriptName, isValidJsonString, isValidKeyword, isValidPipelineUrl, isValidPromptbookVersion, isValidSemanticVersion, isValidUrl, isValidUuid, isValidXmlString, jsonParse, jsonStringsToJsons, linguisticHash, nameToUriPart, nameToUriParts, normalizeMessageText, normalizeToKebabCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_camelCase, normalizeTo_snake_case, normalizeWhitespaces, numberToString, orderJson, parseKeywords, parseKeywordsFromString, parseNumber, prompt, promptTemplate, removeDiacritics, removeEmojis, removeQuotes, renderPromptbookMermaid, searchKeywords, serializeError, serializeToPromptbookJavascript, spaceTrim, splitIntoSentences, suffixUrl, templateParameters, titleToName, union, unwrapResult, valueToString };
 //# sourceMappingURL=index.es.js.map