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

package/esm/typings/src/utils/markdown/removeMarkdownLinks.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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`
+ */
+export declare function removeMarkdownLinks(str: string): string;
+/**
+ * @see https://chat.openai.com/chat/bb7c3a5b-fe9c-4ccc-9057-f47e0fd66489
+ */

package/esm/typings/src/utils/markdown/removeMarkdownLinks.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * @see https://chat.openai.com/chat/bb7c3a5b-fe9c-4ccc-9057-f47e0fd66489
+ */

package/esm/typings/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.100.2`).
+ * It follows semantic versioning (e.g., `0.100.4-0`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/markdown-utils",
-    "version": "0.100.3-0",
+    "version": "0.101.0-0",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -26,7 +26,7 @@
      * @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 @@
     };
     /**
      * 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 @@
     }
     /**
      * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+     * TODO: [🧠][✌️] Make some Promptbook-native token system
      */
 
     /**
@@ -4923,6 +4924,7 @@
     }
     /**
      * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+     * TODO: [🧠][✌️] Make some Promptbook-native token system
      */
 
     /**
@@ -4937,6 +4939,7 @@
     }
     /**
      * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+     * TODO: [🧠][✌️] Make some Promptbook-native token system
      */
 
     /**
@@ -4949,6 +4952,7 @@
     }
     /**
      * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+     * TODO: [🧠][✌️] Make some Promptbook-native token system
      */
 
     /**
@@ -4969,6 +4973,7 @@
     }
     /**
      * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+     * TODO: [🧠][✌️] Make some Promptbook-native token system
      */
 
     /**
@@ -4985,6 +4990,8 @@
     }
     /**
      * 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 @@
      *       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,6 +6899,21 @@
         return str;
     }
 
+    /**
+     * 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
+     */
+
     exports.BOOK_LANGUAGE_VERSION = BOOK_LANGUAGE_VERSION;
     exports.MarkdownScraper = MarkdownScraper;
     exports.PROMPTBOOK_ENGINE_VERSION = PROMPTBOOK_ENGINE_VERSION;
@@ -6805,9 +6929,16 @@
     exports.extractJsonBlock = extractJsonBlock;
     exports.extractOneBlockFromMarkdown = extractOneBlockFromMarkdown;
     exports.flattenMarkdown = flattenMarkdown;
+    exports.humanizeAiText = humanizeAiText;
+    exports.humanizeAiTextEllipsis = humanizeAiTextEllipsis;
+    exports.humanizeAiTextEmdashed = humanizeAiTextEmdashed;
+    exports.humanizeAiTextQuotes = humanizeAiTextQuotes;
+    exports.humanizeAiTextWhitespace = humanizeAiTextWhitespace;
     exports.parseMarkdownSection = parseMarkdownSection;
+    exports.promptbookifyAiText = promptbookifyAiText;
     exports.removeMarkdownComments = removeMarkdownComments;
     exports.removeMarkdownFormatting = removeMarkdownFormatting;
+    exports.removeMarkdownLinks = removeMarkdownLinks;
     exports.splitMarkdownIntoSections = splitMarkdownIntoSections;
 
     Object.defineProperty(exports, '__esModule', { value: true });