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

package/esm/typings/src/_packages/components.index.d.ts

@@ -16,6 +16,8 @@ import { LlmChat } from '../book-components/Chat/LlmChat/LlmChat';
 import type { LlmChatProps } from '../book-components/Chat/LlmChat/LlmChatProps';
 import type { ChatMessage } from '../book-components/Chat/types/ChatMessage';
 import type { ChatParticipant } from '../book-components/Chat/types/ChatParticipant';
+import { renderMarkdown } from '../book-components/Chat/utils/renderMarkdown';
+import { isMarkdownContent } from '../book-components/Chat/utils/renderMarkdown';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export type { AvatarChipProps };
 export { AvatarChip };
@@ -34,3 +36,5 @@ export { LlmChat };
 export type { LlmChatProps };
 export type { ChatMessage };
 export type { ChatParticipant };
+export { renderMarkdown };
+export { isMarkdownContent };

package/esm/typings/src/book-components/Chat/examples/ChatMarkdownDemo.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Demo component showing Chat with markdown rendering capabilities
+ *
+ * This example demonstrates various markdown features supported by the Chat component:
+ * - Headers
+ * - Bold and italic text
+ * - Code blocks and inline code
+ * - Lists (ordered and unordered)
+ * - Links
+ * - Blockquotes
+ * - Tables
+ * - Strikethrough text
+ *
+ * @private temporary for testing purposes
+ */
+export declare function ChatMarkdownDemo(): import("react/jsx-runtime").JSX.Element;

package/esm/typings/src/book-components/Chat/utils/renderMarkdown.d.ts

@@ -0,0 +1,21 @@
+import type { string_html, string_markdown } from '../../../types/typeAliases';
+/**
+ * Convert markdown content to HTML for display in chat messages
+ *
+ * @param markdown - The markdown content to convert
+ * @returns HTML string ready for rendering
+ *
+ * @public exported from `@promptbook/components`
+ *         <- TODO: [🧠] Maybe export from `@promptbook/markdown-utils`
+ */
+export declare function renderMarkdown(markdown: string_markdown): string_html;
+/**
+ * Check if content appears to be markdown (contains markdown syntax)
+ *
+ * @param content - Content to check
+ * @returns true if content appears to contain markdown syntax
+ *
+ * @public exported from `@promptbook/components`
+ *         <- TODO: [🧠] Maybe export from `@promptbook/markdown-utils`
+ */
+export declare function isMarkdownContent(content: string): boolean;

package/esm/typings/src/book-components/Chat/utils/renderMarkdown.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -3,6 +3,8 @@ import type { string_markdown_text } from '../../types/typeAliases';
  * Function escapeMarkdownBlock will escape markdown block if needed
  * It is useful when you want have block in block
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @public exported from `@promptbook/markdown-utils`
  */
 export declare function escapeMarkdownBlock(value: string_markdown_text): string_markdown_text;

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

@@ -2,6 +2,7 @@ import { string_markdown } from '../../types/typeAliases';
 /**
  * Function `humanizeAiText` will remove traces of AI text generation artifacts
  *
+ * Note: [🔂] This function is idempotent.
  * Tip: If you want more control, look for other functions for example `humanizeAiTextEmdashed` exported `@promptbook/markdown-utils`
  *
  * @public exported from `@promptbook/markdown-utils`

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

@@ -2,6 +2,7 @@ import { string_markdown } from '../../types/typeAliases';
 /**
  * Change ellipsis character to three dots `…` -> `...`
  *
+ * Note: [🔂] This function is idempotent.
  * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`
  *
  * @public exported from `@promptbook/markdown-utils`

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

@@ -2,6 +2,7 @@ import { string_markdown } from '../../types/typeAliases';
 /**
  * Change em-dashes to regular dashes `—` -> `-`
  *
+ * Note: [🔂] This function is idempotent.
  * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`
  *
  * @public exported from `@promptbook/markdown-utils`

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

@@ -2,6 +2,7 @@ import { string_markdown } from '../../types/typeAliases';
 /**
  * Change smart quotes to regular quotes
  *
+ * Note: [🔂] This function is idempotent.
  * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`
  *
  * @public exported from `@promptbook/markdown-utils`

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

@@ -2,6 +2,7 @@ import { string_markdown } from '../../types/typeAliases';
 /**
  * Change unprintable hard spaces to regular spaces
  *
+ * Note: [🔂] This function is idempotent.
  * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`
  *
  * @public exported from `@promptbook/markdown-utils`

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

@@ -7,3 +7,11 @@ import type { string_html } from '../../types/typeAliases';
  * @private withing the package because of HUGE size of prettier dependency
  */
 export declare function prettifyMarkdown<TContent extends string_html>(content: TContent): TContent;
+/**
+ * Async version of prettifyMarkdown using dynamic imports
+ *
+ * @param content raw html code
+ * @returns formatted html code
+ * @private withing the package because of HUGE size of prettier dependency
+ */
+export declare function prettifyMarkdownAsync<TContent extends string_html>(content: TContent): Promise<TContent>;

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

@@ -6,6 +6,7 @@ import { string_markdown } from '../../types/typeAliases';
  */
 export declare function promptbookifyAiText(text: string_markdown): string_markdown;
 /**
+ * TODO: !!!!! Make the function idempotent and add "Note: [🔂] This function is idempotent."
  * TODO: [🅾️]!!! Use this across the project where AI text is involved
  * TODO: [🧠][✌️] Make some Promptbook-native token system
  */

package/esm/typings/src/utils/normalization/capitalize.d.ts

@@ -1,6 +1,8 @@
 /**
  * Makes first letter of a string uppercase
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function capitalize(word: string): string;

package/esm/typings/src/utils/normalization/decapitalize.d.ts

@@ -1,5 +1,7 @@
 /**
- * Makes first letter of a string uppercase
+ * Makes first letter of a string lowercase
+ *
+ * Note: [🔂] This function is idempotent.
  *
  * @public exported from `@promptbook/utils`
  */

package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts

@@ -9,6 +9,8 @@ export type string_SCREAMING_CASE = string;
 /**
  * Normalizes a text string to SCREAMING_CASE (all uppercase with underscores).
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param text The text string to be converted to SCREAMING_CASE format.
  * @returns The normalized text in SCREAMING_CASE format.
  * @example 'HELLO_WORLD'

package/esm/typings/src/utils/normalization/normalizeTo_snake_case.d.ts

@@ -8,6 +8,8 @@ export type string_snake_case = string;
 /**
  * Normalizes a text string to snake_case format.
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param text The text string to be converted to snake_case format.
  * @returns The normalized text in snake_case format.
  * @example 'hello_world'

package/esm/typings/src/utils/normalization/normalizeWhitespaces.d.ts

@@ -1,6 +1,8 @@
 /**
  * Take every whitespace (space, new line, tab) and replace it with a single space
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function normalizeWhitespaces(sentence: string): string;

package/esm/typings/src/utils/normalization/removeDiacritics.d.ts

@@ -1,6 +1,8 @@
 /**
  * Removes diacritic marks (accents) from characters in a string.
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param input The string containing diacritics to be normalized.
  * @returns The string with diacritics removed or normalized.
  * @public exported from `@promptbook/utils`

package/esm/typings/src/utils/parseNumber.d.ts

@@ -1,6 +1,7 @@
 /**
  * Function parseNumber will parse number from string
  *
+ * Note: [🔂] This function is idempotent.
  * Unlike Number.parseInt, Number.parseFloat it will never ever result in NaN
  * Note: it also works only with decimal numbers
  *

package/esm/typings/src/utils/removeEmojis.d.ts

@@ -1,6 +1,8 @@
 /**
  * Removes emojis from a string and fix whitespaces
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @param text with emojis
  * @returns text without emojis
  * @public exported from `@promptbook/utils`

package/esm/typings/src/utils/removeQuotes.d.ts

@@ -1,6 +1,7 @@
 /**
  * Removes quotes from a string
  *
+ * Note: [🔂] This function is idempotent.
  * Tip: This is very useful for post-processing of the result of the LLM model
  * Note: This function removes only the same quotes from the beginning and the end of the string
  * Note: There are two similar functions:

package/esm/typings/src/utils/serialization/deepClone.d.ts

@@ -2,6 +2,7 @@ import type { WritableDeep } from 'type-fest';
 /**
  * Creates a deep clone of the given object
  *
+ * Note: [🔂] This function is idempotent.
  * Note: This method only works for objects that are fully serializable to JSON and do not contain functions, Dates, or special types.
  *
  * @param objectValue The object to clone.

package/esm/typings/src/utils/trimCodeBlock.d.ts

@@ -1,6 +1,7 @@
 /**
  * Function trimCodeBlock will trim starting and ending code block from the string if it is present.
  *
+ * Note: [🔂] This function is idempotent.
  * Note: This is useful for post-processing of the result of the chat LLM model
  *       when the model wraps the result in the (markdown) code block.
  *

package/esm/typings/src/utils/validators/url/isValidUrl.d.ts

@@ -3,6 +3,7 @@ import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid URL.
  *
+ * Note: [🔂] This function is idempotent.
  * Note: Dataurl are considered perfectly valid.
  * Note: There are two similar functions:
  * - `isValidUrl` which tests any URL

package/esm/typings/src/utils/validators/uuid/isValidUuid.d.ts

@@ -3,6 +3,8 @@ import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Checks if value is valid uuid
  *
+ * Note: [🔂] This function is idempotent.
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function isValidUuid(value: really_unknown): value is string_uuid;

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.4-0`).
+ * It follows semantic versioning (e.g., `0.101.0-0`).
  *
  * @generated
  */

package/package.json

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

package/umd/index.umd.js

@@ -1,14 +1,12 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('spacetrim'), require('prettier/parser-html'), require('prettier/parser-markdown'), require('prettier/standalone'), require('crypto'), require('rxjs'), require('waitasecond'), require('crypto-js/enc-hex'), require('crypto-js/sha256'), require('path'), require('crypto-js'), require('mime-types'), require('papaparse')) :
-    typeof define === 'function' && define.amd ? define(['exports', 'spacetrim', 'prettier/parser-html', 'prettier/parser-markdown', 'prettier/standalone', 'crypto', 'rxjs', 'waitasecond', 'crypto-js/enc-hex', 'crypto-js/sha256', 'path', 'crypto-js', 'mime-types', 'papaparse'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-markdown-utils"] = {}, global.spaceTrim, global.parserHtml, global.parserMarkdown, global.standalone, global.crypto, global.rxjs, global.waitasecond, global.hexEncoder, global.sha256, global.path, global.cryptoJs, global.mimeTypes, global.papaparse));
-})(this, (function (exports, spaceTrim, parserHtml, parserMarkdown, standalone, crypto, rxjs, waitasecond, hexEncoder, sha256, path, cryptoJs, mimeTypes, papaparse) { 'use strict';
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('spacetrim'), require('crypto'), require('rxjs'), require('waitasecond'), require('crypto-js/enc-hex'), require('crypto-js/sha256'), require('path'), require('crypto-js'), require('mime-types'), require('papaparse')) :
+    typeof define === 'function' && define.amd ? define(['exports', 'spacetrim', 'crypto', 'rxjs', 'waitasecond', 'crypto-js/enc-hex', 'crypto-js/sha256', 'path', 'crypto-js', 'mime-types', 'papaparse'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-markdown-utils"] = {}, global.spaceTrim, global.crypto, global.rxjs, global.waitasecond, global.hexEncoder, global.sha256, global.path, global.cryptoJs, global.mimeTypes, global.papaparse));
+})(this, (function (exports, spaceTrim, crypto, rxjs, waitasecond, hexEncoder, sha256, path, cryptoJs, mimeTypes, papaparse) { 'use strict';
 
     function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
     var spaceTrim__default = /*#__PURE__*/_interopDefaultLegacy(spaceTrim);
-    var parserHtml__default = /*#__PURE__*/_interopDefaultLegacy(parserHtml);
-    var parserMarkdown__default = /*#__PURE__*/_interopDefaultLegacy(parserMarkdown);
     var hexEncoder__default = /*#__PURE__*/_interopDefaultLegacy(hexEncoder);
     var sha256__default = /*#__PURE__*/_interopDefaultLegacy(sha256);
 
@@ -26,7 +24,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.101.0-0';
+    const PROMPTBOOK_ENGINE_VERSION = '0.101.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
@@ -51,6 +49,8 @@
     /**
      * Makes first letter of a string uppercase
      *
+     * Note: [🔂] This function is idempotent.
+     *
      * @public exported from `@promptbook/utils`
      */
     function capitalize(word) {
@@ -642,6 +642,7 @@
     /**
      * Tests if given string is valid URL.
      *
+     * Note: [🔂] This function is idempotent.
      * Note: Dataurl are considered perfectly valid.
      * Note: There are two similar functions:
      * - `isValidUrl` which tests any URL
@@ -705,10 +706,20 @@
      * @private withing the package because of HUGE size of prettier dependency
      */
     function prettifyMarkdown(content) {
+        // In browser/Next.js environments, just return the original content
+        // since prettier parsers are not available and would cause bundling issues
+        if (typeof window !== 'undefined') {
+            return content;
+        }
         try {
-            return standalone.format(content, {
+            // Use dynamic require to avoid static imports that cause bundling issues
+            // This will only work in Node.js environments
+            const prettierStandalone = eval('require')('prettier/standalone');
+            const parserMarkdown = eval('require')('prettier/parser-markdown');
+            const parserHtml = eval('require')('prettier/parser-html');
+            return prettierStandalone.format(content, {
                 parser: 'markdown',
-                plugins: [parserMarkdown__default["default"], parserHtml__default["default"]],
+                plugins: [parserMarkdown, parserHtml],
                 // TODO: DRY - make some import or auto-copy of .prettierrc
                 endOfLine: 'lf',
                 tabWidth: 4,
@@ -1054,6 +1065,7 @@
     /**
      * Creates a deep clone of the given object
      *
+     * Note: [🔂] This function is idempotent.
      * Note: This method only works for objects that are fully serializable to JSON and do not contain functions, Dates, or special types.
      *
      * @param objectValue The object to clone.
@@ -2989,6 +3001,8 @@
     /**
      * Normalizes a text string to SCREAMING_CASE (all uppercase with underscores).
      *
+     * Note: [🔂] This function is idempotent.
+     *
      * @param text The text string to be converted to SCREAMING_CASE format.
      * @returns The normalized text in SCREAMING_CASE format.
      * @example 'HELLO_WORLD'
@@ -3044,6 +3058,8 @@
     /**
      * Normalizes a text string to snake_case format.
      *
+     * Note: [🔂] This function is idempotent.
+     *
      * @param text The text string to be converted to snake_case format.
      * @returns The normalized text in snake_case format.
      * @example 'hello_world'
@@ -3461,6 +3477,8 @@
     /**
      * Removes diacritic marks (accents) from characters in a string.
      *
+     * Note: [🔂] This function is idempotent.
+     *
      * @param input The string containing diacritics to be normalized.
      * @returns The string with diacritics removed or normalized.
      * @public exported from `@promptbook/utils`
@@ -3615,6 +3633,8 @@
     /**
      * Removes emojis from a string and fix whitespaces
      *
+     * Note: [🔂] This function is idempotent.
+     *
      * @param text with emojis
      * @returns text without emojis
      * @public exported from `@promptbook/utils`
@@ -6616,6 +6636,8 @@
      * Function escapeMarkdownBlock will escape markdown block if needed
      * It is useful when you want have block in block
      *
+     * Note: [🔂] This function is idempotent.
+     *
      * @public exported from `@promptbook/markdown-utils`
      */
     function escapeMarkdownBlock(value) {
@@ -6783,6 +6805,7 @@
     /**
      * Change ellipsis character to three dots `…` -> `...`
      *
+     * Note: [🔂] This function is idempotent.
      * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`
      *
      * @public exported from `@promptbook/markdown-utils`
@@ -6797,6 +6820,7 @@
     /**
      * Change em-dashes to regular dashes `—` -> `-`
      *
+     * Note: [🔂] This function is idempotent.
      * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`
      *
      * @public exported from `@promptbook/markdown-utils`
@@ -6811,6 +6835,7 @@
     /**
      * Change smart quotes to regular quotes
      *
+     * Note: [🔂] This function is idempotent.
      * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`
      *
      * @public exported from `@promptbook/markdown-utils`
@@ -6832,6 +6857,7 @@
     /**
      * Change unprintable hard spaces to regular spaces
      *
+     * Note: [🔂] This function is idempotent.
      * Tip: If you want to do the full cleanup, look for `humanizeAiText` exported `@promptbook/markdown-utils`
      *
      * @public exported from `@promptbook/markdown-utils`
@@ -6846,6 +6872,7 @@
     /**
      * Function `humanizeAiText` will remove traces of AI text generation artifacts
      *
+     * Note: [🔂] This function is idempotent.
      * Tip: If you want more control, look for other functions for example `humanizeAiTextEmdashed` exported `@promptbook/markdown-utils`
      *
      * @public exported from `@promptbook/markdown-utils`
@@ -6878,6 +6905,7 @@
         return promptbookifiedText;
     }
     /**
+     * TODO: !!!!! Make the function idempotent and add "Note: [🔂] This function is idempotent."
      * TODO: [🅾️]!!! Use this across the project where AI text is involved
      * TODO: [🧠][✌️] Make some Promptbook-native token system
      */