@promptbook/markdown-utils 0.61.0-7

package/umd/typings/src/utils/markdown/createMarkdownChart.d.ts

@@ -0,0 +1,41 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { FromtoItems } from '../FromtoItems';
+/**
+ * Options for creating a markdown chart
+ */
+/**
+ * Options for creating a markdown chart.
+ */
+type CreateMarkdownChartOptions = {
+    /**
+     * The header for the first column - the name of the item
+     */
+    nameHeader: string;
+    /**
+     * The header for the second column - the value of the item
+     */
+    valueHeader: string;
+    /**
+     * The items to be charted
+     */
+    items: FromtoItems;
+    /**
+     * The width of the chart in squares
+     */
+    width: number;
+    /**
+     * The name of the unit shown in the chart
+     */
+    unitName: string;
+};
+/**
+ * Function createMarkdownChart will draw a chart in markdown from ⬛+🟦 tiles
+ *
+ * @private within the package
+ */
+export declare function createMarkdownChart(options: CreateMarkdownChartOptions): string_markdown;
+export {};
+/**
+ * TODO: Maybe use Mermain Gant Diagrams
+ *       @see https://jojozhuang.github.io/tutorial/mermaid-cheat-sheet/
+ */

package/umd/typings/src/utils/markdown/createMarkdownChart.test.d.ts

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

package/umd/typings/src/utils/markdown/createMarkdownTable.d.ts

@@ -0,0 +1,8 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+/**
+ * Create a markdown table from a 2D array of strings
+ *
+ * @private within the package
+ */
+export declare function createMarkdownTable(table: Array<Array<string_markdown_text>>): string_markdown;

package/umd/typings/src/utils/markdown/createMarkdownTable.test.d.ts

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

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

@@ -0,0 +1,6 @@
+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
+ */
+export declare function escapeMarkdownBlock(value: string_markdown_text): string_markdown_text;

package/umd/typings/src/utils/markdown/escapeMarkdownBlock.test.d.ts

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

package/umd/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts

@@ -0,0 +1,27 @@
+import type { string_markdown } from '../../types/typeAliases';
+/**
+ * Single code block inside markdown.
+ */
+export type CodeBlock = {
+    /**
+     * Language of the code block OR null if the language is not specified in opening ```
+     */
+    language: string | null;
+    /**
+     * Content of the code block (unescaped)
+     */
+    content: string;
+};
+/**
+ * Extracts all code blocks from markdown.
+ *
+ * Note: There are 3 simmilar function:
+ * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
+ * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
+ * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
+ *
+ * @param markdown any valid markdown
+ * @returns code blocks with language and content
+ *
+ */
+export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): Array<CodeBlock>;

package/umd/typings/src/utils/markdown/extractAllBlocksFromMarkdown.test.d.ts

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

package/umd/typings/src/utils/markdown/extractAllListItemsFromMarkdown.d.ts

@@ -0,0 +1,14 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+/**
+ * Utility function to extract all list items from markdown
+ *
+ * Note: It works with both ul and ol
+ * Note: It omits list items in code blocks
+ * Note: It flattens nested lists
+ * Note: It can not work with html syntax and comments
+ *
+ * @param markdown any valid markdown
+ * @returns
+ */
+export declare function extractAllListItemsFromMarkdown(markdown: string_markdown): string_markdown_text[];

package/umd/typings/src/utils/markdown/extractAllListItemsFromMarkdown.test.d.ts

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

package/umd/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts

@@ -0,0 +1,19 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { CodeBlock } from './extractAllBlocksFromMarkdown';
+/**
+ * Extracts exactly ONE code block from markdown.
+ *
+ * Note: If there are multiple or no code blocks the function throws an error
+ *
+ * Note: There are 3 simmilar function:
+ * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
+ * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
+ * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
+ *
+ * @param markdown any valid markdown
+ * @returns code block with language and content
+ */
+export declare function extractOneBlockFromMarkdown(markdown: string_markdown): CodeBlock;
+/***
+ * TODO: [🍓][🌻] !!! Decide of this is internal util, external util OR validator/postprocessor
+ */

package/umd/typings/src/utils/markdown/extractOneBlockFromMarkdown.test.d.ts

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

package/umd/typings/src/utils/markdown/flattenMarkdown.d.ts

@@ -0,0 +1,14 @@
+import type { string_markdown } from '../../types/typeAliases';
+/**
+ * Normalizes the markdown by flattening the structure
+ *
+ * - It always have h1 - if there is no h1 in the markdown, it will be added "# Untitled"
+ * - All other headings are normalized to h2
+ */
+export declare function flattenMarkdown<TContent extends string_markdown>(markdown: TContent): TContent;
+/**
+ * Note: [🕞] In past (commit 42086e1603cbed506482997c00a8ee979af0a247) there was much more
+ *       sophisticated implementation of this function through parsing markdown into JSON structure
+ *       and flattening the actual structure
+ *       NOW we are working just with markdown string and its good enough
+ */

package/umd/typings/src/utils/markdown/flattenMarkdown.test.d.ts

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

package/umd/typings/src/utils/markdown/parseMarkdownSection.d.ts

@@ -0,0 +1,30 @@
+import type { string_markdown_section } from '../../types/typeAliases';
+import type { string_markdown_section_content } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+/**
+ * Parsed markdown section
+ */
+export type MarkdownSection = {
+    /**
+     * Title of the section
+     */
+    title: string_markdown_text;
+    /**
+     * Level of the section like h1, h2, h3, h4, h5, h6
+     */
+    level: 1 | 2 | 3 | 4 | 5 | 6;
+    /**
+     * Content of the section with markdown formatting, blocks, lists, etc.
+     */
+    content: string_markdown_section_content;
+};
+/**
+ * Parses markdown section to title its level and content
+ */
+export declare function parseMarkdownSection(value: string_markdown_section): MarkdownSection;
+/**
+ * Note: [🕞] In past (commit 42086e1603cbed506482997c00a8ee979af0a247) there was much more
+ *       sophisticated implementation of this function through parsing markdown into JSON structure
+ *       and flattening the actual structure
+ *       NOW we are working just with markdown string and its good enough
+ */

package/umd/typings/src/utils/markdown/parseMarkdownSection.test.d.ts

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

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

@@ -0,0 +1,9 @@
+import type { string_html } from '../../types/typeAliases';
+/**
+ * Prettify the html code
+ *
+ * @param content raw html code
+ * @returns formatted html code
+ * @private withing the package because of HUGE size of prettier dependency
+ */
+export declare function prettifyMarkdown<TContent extends string_html>(content: TContent): TContent;

package/umd/typings/src/utils/markdown/prettifyMarkdown.test.d.ts

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

package/umd/typings/src/utils/markdown/removeContentComments.d.ts

@@ -0,0 +1,9 @@
+import type { string_html } from '../../types/typeAliases';
+import type { string_markdown } from '../../types/typeAliases';
+/**
+ * Removes HTML or Markdown comments from a string.
+ *
+ * @param {string} content - The string to remove comments from.
+ * @returns {string} The input string with all comments removed.
+ */
+export declare function removeContentComments<TContent extends string_html | string_markdown>(content: TContent): TContent;

package/umd/typings/src/utils/markdown/removeContentComments.test.d.ts

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

package/umd/typings/src/utils/markdown/removeMarkdownFormatting.d.ts

@@ -0,0 +1,8 @@
+import type { string_markdown_text } from '../../types/typeAliases';
+/**
+ * Removes Markdown formatting tags from a string.
+ *
+ * @param {string} str - The string to remove Markdown tags from.
+ * @returns {string} The input string with all Markdown tags removed.
+ */
+export declare function removeMarkdownFormatting(str: string_markdown_text): string;

package/umd/typings/src/utils/markdown/removeMarkdownFormatting.test.d.ts

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

package/umd/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts

@@ -0,0 +1,12 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_section } from '../../types/typeAliases';
+/**
+ * Splits the markdown into sections by headings
+ */
+export declare function splitMarkdownIntoSections(markdown: string_markdown): Array<string_markdown_section>;
+/**
+ * Note: [🕞] In past (commit 42086e1603cbed506482997c00a8ee979af0a247) there was much more
+ *       sophisticated implementation of this function through parsing markdown into JSON structure
+ *       and flattening the actual structure
+ *       NOW we are working just with markdown string and its good enough
+ */

package/umd/typings/src/utils/markdown/splitMarkdownIntoSections.test.d.ts

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

package/umd/typings/src/utils/normalization/DIACRITIC_VARIANTS_LETTERS.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Map of letters from diacritic variant to diacritless variant
+ * Contains lowercase and uppercase separatelly
+ *
+ * > "á" => "a"
+ * > "ě" => "e"
+ * > "Ă" => "A"
+ * > ...
+ */
+export declare const DIACRITIC_VARIANTS_LETTERS: Record<string, string>;

package/umd/typings/src/utils/normalization/IKeywords.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Semantic helper
+ *
+ * Keyword is string without diacritics in lowercase [a-z1-9]
+ * Words are splitted between multiple keywords @see IKeywords
+ *
+ * For example `"keyword"`
+ */
+export type string_keyword = string;
+/**
+ * Semantic helper
+ * Set of keywords @see string_keyword
+ *
+ */
+export type IKeywords = Set<string_keyword>;
+/**
+ * TODO: [🌮] Keywords with weight
+ */

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

@@ -0,0 +1,5 @@
+/**
+ * Makes first letter of a string uppercase
+ *
+ */
+export declare function capitalize(word: string): string;

package/umd/typings/src/utils/normalization/capitalize.test.d.ts

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

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

@@ -0,0 +1,5 @@
+/**
+ * Makes first letter of a string uppercase
+ *
+ */
+export declare function decapitalize(word: string): string;

package/umd/typings/src/utils/normalization/decapitalize.test.d.ts

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

package/umd/typings/src/utils/normalization/isValidKeyword.d.ts

@@ -0,0 +1,8 @@
+import type { string_keyword } from './IKeywords';
+/**
+ * Tests if keyword is valid
+ *
+ * @param keyword to test
+ * @returns if keyword is valid or not
+ */
+export declare function isValidKeyword(keyword: string): keyword is string_keyword;

package/umd/typings/src/utils/normalization/isValidKeyword.test.d.ts

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

package/umd/typings/src/utils/normalization/nameToUriPart.d.ts

@@ -0,0 +1 @@
+export declare function nameToUriPart(name: string): string;

package/umd/typings/src/utils/normalization/nameToUriPart.test.d.ts

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

package/umd/typings/src/utils/normalization/nameToUriParts.d.ts

@@ -0,0 +1 @@
+export declare function nameToUriParts(name: string): string[];

package/umd/typings/src/utils/normalization/nameToUriParts.test.d.ts

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

package/umd/typings/src/utils/normalization/normalize-to-kebab-case.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Semantic helper for kebab-case strings
+ *
+ * @example 'hello-world'
+ * @example 'i-love-promptbook'
+ */
+export type string_kebab_case = string;
+export declare function normalizeToKebabCase(text: string): string_kebab_case;

package/umd/typings/src/utils/normalization/normalize-to-kebab-case.test.d.ts

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

package/umd/typings/src/utils/normalization/normalizeTo_PascalCase.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Semantic helper for PascalCase strings
+ *
+ * @example 'HelloWorld'
+ * @example 'ILovePromptbook'
+ */
+export type string_PascalCase = string;
+export declare function normalizeTo_PascalCase(text: string): string_PascalCase;

package/umd/typings/src/utils/normalization/normalizeTo_PascalCase.test.d.ts

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

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

@@ -0,0 +1,16 @@
+/**
+ * Semantic helper for SCREAMING_CASE strings
+ *
+ * @example 'HELLO_WORLD'
+ * @example 'I_LOVE_PROMPTBOOK'
+ */
+export type string_SCREAMING_CASE = string;
+export declare function normalizeTo_SCREAMING_CASE(text: string): string_SCREAMING_CASE;
+/**
+ * TODO: Tests
+ *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: 'Moje tabule' })).toEqual('/VtG7sR9rRJqwNEdM2/Moje tabule');
+ *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: 'ěščřžžýáíúů' })).toEqual('/VtG7sR9rRJqwNEdM2/escrzyaieuu');
+ *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: '  ahoj  ' })).toEqual('/VtG7sR9rRJqwNEdM2/ahoj');
+ *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: '  ahoj_ahojAhoj    ahoj  ' })).toEqual('/VtG7sR9rRJqwNEdM2/ahoj-ahoj-ahoj-ahoj');
+ * TODO: [🌺] Use some intermediate util splitWords
+ */

package/umd/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.test.d.ts

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

package/umd/typings/src/utils/normalization/normalizeTo_camelCase.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Semantic helper for camelCase strings
+ *
+ * @example 'helloWorld'
+ * @example 'iLovePromptbook'
+ */
+export type string_camelCase = string;
+export declare function normalizeTo_camelCase(text: string, _isFirstLetterCapital?: boolean): string_camelCase;
+/**
+ * TODO: [🌺] Use some intermediate util splitWords
+ */

package/umd/typings/src/utils/normalization/normalizeTo_camelCase.test.d.ts

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

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

@@ -0,0 +1,8 @@
+/**
+ * Semantic helper for snake_case strings
+ *
+ * @example 'hello_world'
+ * @example 'i_love_promptbook'
+ */
+export type string_snake_case = string;
+export declare function normalizeTo_snake_case(text: string): string_snake_case;

package/umd/typings/src/utils/normalization/normalizeTo_snake_case.test.d.ts

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

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

@@ -0,0 +1,4 @@
+/**
+ * Take every whitespace (space, new line, tab) and replace it with a single space.
+ */
+export declare function normalizeWhitespaces(sentence: string): string;

package/umd/typings/src/utils/normalization/normalizeWhitespaces.test.d.ts

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

package/umd/typings/src/utils/normalization/parseKeywords.d.ts

@@ -0,0 +1,14 @@
+import type { IKeywords } from './IKeywords';
+/**
+ * Parses keywords from any object and recursively walks through
+ *
+ * Tip: If you want to parse multiple inputs, just wrap them in an array
+ *
+ * @param input of any kind
+ * @returns {Set} of keywords without diacritics in lowercase
+ */
+export declare function parseKeywords(input: unknown): IKeywords;
+/**
+ * Note: Not using spread in input param because of keeping second parameter for options
+ * TODO: [🌺] Use some intermediate util splitWords
+ */

package/umd/typings/src/utils/normalization/parseKeywords.test.d.ts

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

package/umd/typings/src/utils/normalization/parseKeywordsFromString.d.ts

@@ -0,0 +1,8 @@
+import type { IKeywords } from './IKeywords';
+/**
+ * Parses keywords from a string
+ *
+ * @param {string} input
+ * @returns {Set} of keywords without diacritics in lowercase
+ */
+export declare function parseKeywordsFromString(input: string): IKeywords;

package/umd/typings/src/utils/normalization/parseKeywordsFromString.test.d.ts

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

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

@@ -0,0 +1,4 @@
+/**
+ *
+ */
+export declare function removeDiacritics(input: string): string;

package/umd/typings/src/utils/normalization/removeDiacritics.test.d.ts

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

package/umd/typings/src/utils/normalization/searchKeywords.d.ts

@@ -0,0 +1,5 @@
+import type { IKeywords } from './IKeywords';
+/**
+ *
+ */
+export declare function searchKeywords(haystack: IKeywords, needle: IKeywords): boolean;

package/umd/typings/src/utils/normalization/searchKeywords.test.d.ts

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

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

@@ -0,0 +1,15 @@
+/**
+ * Function parseNumber will parse number from string
+ *
+ * Unlike Number.parseInt, Number.parseFloat it will never ever result in NaN
+ * Note: it also works only with decimal numbers
+ *
+ * @returns parsed number
+ * @throws {ParsingError} if the value is not a number
+ *
+ * @private within the parseCommand
+ */
+export declare function parseNumber(value: string | number): number;
+/**
+ * TODO: Maybe use sth. like safe-eval in fraction/calculation case @see https://www.npmjs.com/package/safe-eval
+ */

package/umd/typings/src/utils/parseNumber.test.d.ts

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

package/umd/typings/src/utils/postprocessing/extractBlock.d.ts

@@ -0,0 +1,12 @@
+import type { string_markdown } from '../../types/typeAliases';
+/**
+ * Extracts code block from markdown.
+ *
+ * Note: If there are multiple or no code blocks the function throws an error
+ *
+ * Note: There are 3 simmilar function:
+ * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
+ * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
+ * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
+ */
+export declare function extractBlock(markdown: string_markdown): string;

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

@@ -0,0 +1,7 @@
+/**
+ * Removes emojis from a string and fix whitespaces
+ *
+ * @param text with emojis
+ * @returns text without emojis
+ */
+export declare function removeEmojis(text: string): string;

package/umd/typings/src/utils/removeEmojis.test.d.ts

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

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

@@ -0,0 +1,13 @@
+/**
+ * Removes quotes from a string
+ *
+ * Tip: This is very usefull 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 simmilar functions:
+ * - `removeQuotes` which removes only bounding quotes
+ * - `unwrapResult` which removes whole introduce sentence
+ *
+ * @param text optionally quoted text
+ * @returns text without quotes
+ */
+export declare function removeQuotes(text: string): string;

package/umd/typings/src/utils/removeQuotes.test.d.ts

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

package/umd/typings/src/utils/sets/difference.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Create difference set of two sets.
+ *
+ * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
+ */
+export declare function difference<TItem>(a: Set<TItem>, b: Set<TItem>, isEqual?: (a: TItem, b: TItem) => boolean): Set<TItem>;

package/umd/typings/src/utils/sets/difference.test.d.ts

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

package/umd/typings/src/utils/sets/intersection.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Creates a new set with all elements that are present in all sets
+ *
+ * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
+ */
+export declare function intersection<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;

package/umd/typings/src/utils/sets/intersection.test.d.ts

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

package/umd/typings/src/utils/sets/union.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Creates a new set with all elements that are present in either set
+ *
+ * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
+ */
+export declare function union<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;

package/umd/typings/src/utils/sets/union.test.d.ts

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

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

@@ -0,0 +1,8 @@
+/**
+ * Function trimCodeBlock will trim starting and ending code block from the string if it is present.
+ *
+ * Note: This is usefull for post-processing of the result of the chat LLM model
+ *       when the model wraps the result in the (markdown) code block.
+ *
+ */
+export declare function trimCodeBlock(value: string): string;

package/umd/typings/src/utils/trimCodeBlock.test.d.ts

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

package/umd/typings/src/utils/trimEndOfCodeBlock.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Function trimEndOfCodeBlock will remove ending code block from the string if it is present.
+ *
+ * Note: This is usefull for post-processing of the result of the completion LLM model
+ *       if you want to start code block in the prompt but you don't want to end it in the result.
+ */
+export declare function trimEndOfCodeBlock(value: string): string;

package/umd/typings/src/utils/trimEndOfCodeBlock.test.d.ts

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