@promptbook/markitdown 0.84.0-10

package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown-real.test.d.ts

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

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

@@ -0,0 +1,36 @@
+import type { string_markdown } from '../../types/typeAliases';
+/**
+ * Single code block inside markdown.
+ */
+export type CodeBlock = {
+    /**
+     * Which notation was used to open the code block
+     */
+    readonly blockNotation: '```' | '>';
+    /**
+     * Language of the code block OR null if the language is not specified in opening ```
+     */
+    readonly language: string | null;
+    /**
+     * Content of the code block (unescaped)
+     */
+    readonly content: string;
+};
+/**
+ * Extracts all code blocks from markdown.
+ *
+ * Note: There are multiple simmilar function:
+ * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
+ * - `extractJsonBlock` extracts exactly one valid JSON code block
+ * - `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
+ * @throws {ParseError} if block is not closed properly
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): ReadonlyArray<CodeBlock>;
+/**
+ * TODO: Maybe name for `blockNotation` instead of  '```' and '>'
+ */

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

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

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

@@ -0,0 +1,15 @@
+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 @@@
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function extractAllListItemsFromMarkdown(markdown: string_markdown): string_markdown_text[];

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

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

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

@@ -0,0 +1,22 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { CodeBlock } from './extractAllBlocksFromMarkdown';
+/**
+ * Extracts exactly ONE code block from markdown.
+ *
+ * - When there are multiple or no code blocks the function throws a `ParseError`
+ *
+ * Note: There are multiple simmilar function:
+ * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
+ * - `extractJsonBlock` extracts exactly one valid JSON code block
+ * - `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
+ * @public exported from `@promptbook/markdown-utils`
+ * @throws {ParseError} if there is not exactly one code block in the markdown
+ */
+export declare function extractOneBlockFromMarkdown(markdown: string_markdown): CodeBlock;
+/***
+ * TODO: [🍓][🌻] Decide of this is internal utility, external util OR validator/postprocessor
+ */

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

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

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

@@ -0,0 +1,17 @@
+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 `DEFAULT_BOOK_TITLE`
+ * - All other headings are normalized to h2
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function flattenMarkdown<TContent extends string_markdown>(markdown: TContent): TContent;
+/**
+ * TODO: [🏛] This can be part of markdown builder
+ * 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/esm/typings/src/utils/markdown/flattenMarkdown.test.d.ts

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

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

@@ -0,0 +1,34 @@
+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
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export type MarkdownSection = {
+    /**
+     * Title of the section
+     */
+    readonly title: string_markdown_text;
+    /**
+     * Level of the section like h1, h2, h3, h4, h5, h6
+     */
+    readonly level: 1 | 2 | 3 | 4 | 5 | 6;
+    /**
+     * Content of the section with markdown formatting, blocks, lists, etc.
+     */
+    readonly content: string_markdown_section_content;
+};
+/**
+ * Parses markdown section to title its level and content
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+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/esm/typings/src/utils/markdown/parseMarkdownSection.test.d.ts

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

package/esm/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/esm/typings/src/utils/markdown/prettifyMarkdown.test.d.ts

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

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

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

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

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

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

@@ -0,0 +1,9 @@
+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.
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function removeMarkdownFormatting(str: string_markdown_text): string;

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

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

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

@@ -0,0 +1,15 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_section } from '../../types/typeAliases';
+/**
+ * Splits the markdown into sections by headings
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function splitMarkdownIntoSections(markdown: string_markdown): ReadonlyArray<string_markdown_section>;
+/**
+ * TODO: [🏛] This can be part of markdown builder
+ * 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/esm/typings/src/utils/markdown/splitMarkdownIntoSections.test.d.ts

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

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

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

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

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

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

@@ -0,0 +1,6 @@
+/**
+ * Makes first letter of a string uppercase
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function capitalize(word: string): string;

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

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

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

@@ -0,0 +1,6 @@
+/**
+ * Makes first letter of a string uppercase
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function decapitalize(word: string): string;

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

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

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

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

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

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

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

@@ -0,0 +1,9 @@
+/**
+ * @@@
+ *
+ * @param name @@@
+ * @returns @@@
+ * @example @@@
+ * @public exported from `@promptbook/utils`
+ */
+export declare function nameToUriPart(name: string): string;

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

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

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

@@ -0,0 +1,9 @@
+/**
+ * @@@
+ *
+ * @param name @@@
+ * @returns @@@
+ * @example @@@
+ * @public exported from `@promptbook/utils`
+ */
+export declare function nameToUriParts(name: string): string[];

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

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

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

@@ -0,0 +1,21 @@
+/**
+ * Semantic helper for kebab-case strings
+ *
+ * @example 'hello-world'
+ * @example 'i-love-promptbook'
+ * @public exported from `@promptbook/utils`
+ */
+export type string_kebab_case = string;
+/**
+ * @@@
+ *
+ * @param text @@@
+ * @returns @@@
+ * @example 'hello-world'
+ * @example 'i-love-promptbook'
+ * @public exported from `@promptbook/utils`
+ */
+export declare function normalizeToKebabCase(text: string): string_kebab_case;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

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

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

@@ -0,0 +1,17 @@
+/**
+ * Semantic helper for PascalCase strings
+ *
+ * @example 'HelloWorld'
+ * @example 'ILovePromptbook'
+ * @public exported from `@promptbook/utils`
+ */
+export type string_PascalCase = string;
+/**
+ *
+ * @param text @public exported from `@promptbook/utils`
+ * @returns
+ * @example 'HelloWorld'
+ * @example 'ILovePromptbook'
+ * @public exported from `@promptbook/utils`
+ */
+export declare function normalizeTo_PascalCase(text: string): string_PascalCase;

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

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

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

@@ -0,0 +1,26 @@
+/**
+ * Semantic helper for SCREAMING_CASE strings
+ *
+ * @example 'HELLO_WORLD'
+ * @example 'I_LOVE_PROMPTBOOK'
+ * @public exported from `@promptbook/utils`
+ */
+export type string_SCREAMING_CASE = string;
+/**
+ * @@@
+ *
+ * @param text @@@
+ * @returns @@@
+ * @example 'HELLO_WORLD'
+ * @example 'I_LOVE_PROMPTBOOK'
+ * @public exported from `@promptbook/utils`
+ */
+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/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.test.d.ts

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

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

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

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

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

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

@@ -0,0 +1,17 @@
+/**
+ * Semantic helper for snake_case strings
+ *
+ * @example 'hello_world'
+ * @example 'i_love_promptbook'
+ */
+export type string_snake_case = string;
+/**
+ * @@@
+ *
+ * @param text @@@
+ * @returns @@@
+ * @example 'hello_world'
+ * @example 'i_love_promptbook'
+ * @public exported from `@promptbook/utils`
+ */
+export declare function normalizeTo_snake_case(text: string): string_snake_case;

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

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

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

@@ -0,0 +1,6 @@
+/**
+ * Take every whitespace (space, new line, tab) and replace it with a single space
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function normalizeWhitespaces(sentence: string): string;

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

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

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

@@ -0,0 +1,21 @@
+import type { JsonArray, JsonObject } from 'type-fest';
+/**
+ * Options for the `orderJson` function
+ */
+export type OrderJsonOptions<TObject extends JsonObject | JsonArray> = {
+    /**
+     * Value to checked, ordered and deeply frozen
+     */
+    value: TObject;
+    /**
+     * Order of the object properties
+     */
+    order: Array<keyof TObject>;
+};
+/**
+ * Orders JSON object by keys
+ *
+ * @returns The same type of object as the input re-ordered
+ * @public exported from `@promptbook/utils`
+ */
+export declare function orderJson<TObject extends JsonObject | JsonArray>(options: OrderJsonOptions<TObject>): TObject;

package/esm/typings/src/utils/normalization/orderJson.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠] Is there a way how to test order of value better way than via `JSON.stringify`
+ */

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

@@ -0,0 +1,16 @@
+import type { really_unknown } from '../organization/really_unknown';
+import type { Keywords } 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
+ * @public exported from `@promptbook/utils`
+ */
+export declare function parseKeywords(input: really_unknown): Keywords;
+/**
+ * Note: Not using spread in input param because of keeping second parameter for options
+ * TODO: [🌺] Use some intermediate util splitWords
+ */

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

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

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

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

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

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

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

@@ -0,0 +1,11 @@
+/**
+ * @@@
+ *
+ * @param input @@@
+ * @returns @@@
+ * @public exported from `@promptbook/utils`
+ */
+export declare function removeDiacritics(input: string): string;
+/**
+ * TODO: [Ж] Variant for cyrillic (and in general non-latin) letters
+ */

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

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

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

@@ -0,0 +1,10 @@
+import type { Keywords } from './IKeywords';
+/**
+ * @@@
+ *
+ * @param haystack
+ * @param needle
+ * @returns
+ * @public exported from `@promptbook/utils`
+ */
+export declare function searchKeywords(haystack: Keywords, needle: Keywords): boolean;

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

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

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

@@ -0,0 +1,9 @@
+/**
+ * @@@
+ *
+ * @param value @@@
+ * @returns @@@
+ * @example @@@
+ * @public exported from `@promptbook/utils`
+ */
+export declare function titleToName(value: string): string;

package/esm/typings/src/utils/normalization/titleToName.test.d.ts

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

package/esm/typings/src/utils/organization/$sideEffect.d.ts

@@ -0,0 +1,9 @@
+import type { really_any } from './really_any';
+/**
+ * Just says that the variable is not used directlys but should be kept because the existence of the variable is important
+ *
+ * @param value any values
+ * @returns void
+ * @private within the repository
+ */
+export declare function $sideEffect(...sideEffectSubjects: ReadonlyArray<really_any>): void;

package/esm/typings/src/utils/organization/TODO_USE.d.ts

@@ -0,0 +1,12 @@
+import type { really_any } from './really_any';
+/**
+ * Just marks a place of place where should be something implemented
+ * No side effects.
+ *
+ * Note: It can be usefull suppressing eslint errors of unused variables
+ *
+ * @param value any values
+ * @returns void
+ * @private within the repository
+ */
+export declare function TODO_USE(...value: ReadonlyArray<really_any>): void;

package/esm/typings/src/utils/organization/TODO_any.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to better mark the place where the type is missing
+ *
+ * @private within the repository
+ */
+export type TODO_any = any;

package/esm/typings/src/utils/organization/TODO_object.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to better mark the place where the type is missing
+ *
+ * @private within the repository
+ */
+export type TODO_object = object;

package/esm/typings/src/utils/organization/TODO_remove_as.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to better mark the place is used as but should not be
+ *
+ * @private within the repository
+ */
+export type TODO_remove_as<T> = T;

package/esm/typings/src/utils/organization/TODO_string.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to better mark the place where the more specific string type is missing
+ *
+ * @private within the repository
+ */
+export type TODO_string = string;

package/esm/typings/src/utils/organization/TODO_unknown.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to better mark the place where the type is missing
+ *
+ * @private within the repository
+ */
+export type TODO_unknown = unknown;

package/esm/typings/src/utils/organization/___and___.d.ts

@@ -0,0 +1,7 @@
+import type { really_unknown } from './really_unknown';
+/**
+ * Formatting helper to put void to keep longer version of prettier
+ *
+ * @private within the repository
+ */
+export type ___and___ = really_unknown;