@promptbook/markdown-utils 0.100.3-0 → 0.101.0-0

package/esm/index.es.js

@@ -26,7 +26,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.100.3-0';
+const PROMPTBOOK_ENGINE_VERSION = '0.101.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
@@ -2680,7 +2680,7 @@ const LLM_PROVIDER_PROFILES = {
 };
 /**
  * TODO: Refactor this - each profile must be alongside the provider definition
- * TODO: [🕛] Unite `AvatarProfileProps`, `ChatParticipant`, `LlmExecutionTools` +  `LlmToolsMetadata`
+ * TODO: [🕛] Unite `AgentBasicInformation`, `ChatParticipant`, `LlmExecutionTools` +  `LlmToolsMetadata`
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */
 
@@ -4889,6 +4889,7 @@ function countCharacters(text) {
 }
 /**
  * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
  */
 
 /**
@@ -4923,6 +4924,7 @@ function countLines(text) {
 }
 /**
  * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
  */
 
 /**
@@ -4937,6 +4939,7 @@ function countPages(text) {
 }
 /**
  * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
  */
 
 /**
@@ -4949,6 +4952,7 @@ function countParagraphs(text) {
 }
 /**
  * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
  */
 
 /**
@@ -4969,6 +4973,7 @@ function countSentences(text) {
 }
 /**
  * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
  */
 
 /**
@@ -4985,6 +4990,8 @@ function countWords(text) {
 }
 /**
  * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
+ * TODO: [✌️] `countWords` should be just `splitWords(...).length`, and all other counters should use this pattern as well
  */
 
 /**
@@ -6773,6 +6780,108 @@ function flattenMarkdown(markdown) {
  *       NOW we are working just with markdown string and its good enough
  */
 
+/**
+ * Change ellipsis character to three dots `…` -> `...`
+ *
+ * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+function humanizeAiTextEllipsis(aiText) {
+    return aiText.replace(/…/g, '...');
+}
+/**
+ * Note: [🏂] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
+ */
+
+/**
+ * Change em-dashes to regular dashes `—` -> `-`
+ *
+ * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+function humanizeAiTextEmdashed(aiText) {
+    return aiText.replace(/—/g, '-');
+}
+/**
+ * Note: [🏂] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
+ */
+
+/**
+ * Change smart quotes to regular quotes
+ *
+ * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+function humanizeAiTextQuotes(aiText) {
+    return aiText
+        .replace(/[“”]/g, '"')
+        .replace(/[‚‘’]/g, "'")
+        .replace(/«/g, '"')
+        .replace(/»/g, '"')
+        .replace(/„/g, '"')
+        .replace(/‹/g, "'")
+        .replace(/›/g, "'");
+}
+/**
+ * Note: [🏂] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
+ */
+
+/**
+ * Change unprintable hard spaces to regular spaces
+ *
+ * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+function humanizeAiTextWhitespace(aiText) {
+    return aiText.replace(/\u00A0/g, ' ');
+}
+/**
+ * Note: [🏂] This function is not tested by itself but together with other cleanup functions with `humanizeAiText`
+ */
+
+/**
+ * Function `humanizeAiText` will remove traces of AI text generation artifacts
+ *
+ * Tip: If you want more control, look for other functions for example `humanizeAiTextEmdashed` exported `@promptbook/markdown-utils`
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+function humanizeAiText(aiText) {
+    let cleanedText = aiText;
+    cleanedText = humanizeAiTextEllipsis(cleanedText);
+    cleanedText = humanizeAiTextEmdashed(cleanedText);
+    cleanedText = humanizeAiTextQuotes(cleanedText);
+    cleanedText = humanizeAiTextWhitespace(cleanedText);
+    return cleanedText;
+}
+/**
+ * TODO: [🅾️] !!! Use this across the project where AI text is involved
+ */
+
+/**
+ * Function `promptbookifyAiText` will slightly modify the text so we know it was processed by Promptbook
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+function promptbookifyAiText(text) {
+    // Note: Duplicating some spaces
+    const words = text.split(' '); // <- Note: [✌️] Use `splitWords` when available
+    const wordLength = words.length; // <- Note: [✌️] `countWords` should be just `splitWords(...).length`
+    for (const wordIndex of [3, 7, 11, 19].filter((i) => i < wordLength)) {
+        words[wordIndex] = ' ' + words[wordIndex];
+    }
+    const promptbookifiedText = words.join(' ');
+    return promptbookifiedText;
+}
+/**
+ * TODO: [🅾️]!!! Use this across the project where AI text is involved
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
+ */
+
 /**
  * Removes Markdown formatting tags from a string.
  *
@@ -6790,5 +6899,20 @@ function removeMarkdownFormatting(str) {
     return str;
 }
 
-export { BOOK_LANGUAGE_VERSION, MarkdownScraper, PROMPTBOOK_ENGINE_VERSION, _MarkdownScraperRegistration, addAutoGeneratedSection, createMarkdownChart, createMarkdownScraper, createMarkdownTable, escapeMarkdownBlock, extractAllBlocksFromMarkdown, extractAllListItemsFromMarkdown, extractBlock, extractJsonBlock, extractOneBlockFromMarkdown, flattenMarkdown, parseMarkdownSection, removeMarkdownComments, removeMarkdownFormatting, splitMarkdownIntoSections };
+/**
+ * Removes Markdown link tags from a string.
+ *
+ * @param {string} str - The string to remove Markdown tags from.
+ * @returns {string} The input string with all Markdown tags removed.
+ * @public exported from `@promptbook/markdown-utils`
+ */
+function removeMarkdownLinks(str) {
+    // Use regular expressions to remove Markdown tags from the string
+    return str.replace(/\[([^\]]+)\]\(([^)]+)\)/g, '$1');
+}
+/**
+ * @see https://chat.openai.com/chat/bb7c3a5b-fe9c-4ccc-9057-f47e0fd66489
+ */
+
+export { BOOK_LANGUAGE_VERSION, MarkdownScraper, PROMPTBOOK_ENGINE_VERSION, _MarkdownScraperRegistration, addAutoGeneratedSection, createMarkdownChart, createMarkdownScraper, createMarkdownTable, escapeMarkdownBlock, extractAllBlocksFromMarkdown, extractAllListItemsFromMarkdown, extractBlock, extractJsonBlock, extractOneBlockFromMarkdown, flattenMarkdown, humanizeAiText, humanizeAiTextEllipsis, humanizeAiTextEmdashed, humanizeAiTextQuotes, humanizeAiTextWhitespace, parseMarkdownSection, promptbookifyAiText, removeMarkdownComments, removeMarkdownFormatting, removeMarkdownLinks, splitMarkdownIntoSections };
 //# sourceMappingURL=index.es.js.map