@promptbook/node 0.56.0-3

package/esm/typings/utils/emojis.d.ts

@@ -0,0 +1,22 @@
+import type { string_char_emoji } from '../types/typeAliasEmoji';
+/**
+ * All possible emoji chars like "🍆", "🍡", "🍤"...
+ * Note: this will be needed to update annually - now updated at 2022-01-19
+ *
+ * @see https://getemoji.com/
+ *
+ * @private within the library
+ * @deprecated Use /\p{Extended_Pictographic}/ instead
+ */
+export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoji>>;
+/**
+ *
+ * All possible emoji chars like "🍆", "🍡", "🍤"...
+ *
+ * @private within the library
+ * @deprecated Use /\p{Extended_Pictographic}/ instead
+ */
+export declare const EMOJIS: Set<string_char_emoji>;
+/**
+ * TODO: Mirror from Collboard or some common library
+ */

package/esm/typings/utils/expectation-counters/countCharacters.d.ts

@@ -0,0 +1,5 @@
+import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+/**
+ * Counts number of characters in the text
+ */
+export declare function countCharacters(text: string): ExpectationAmount;

package/esm/typings/utils/expectation-counters/countCharacters.test.d.ts

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

package/esm/typings/utils/expectation-counters/countLines.d.ts

@@ -0,0 +1,5 @@
+import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+/**
+ * Counts number of lines in the text
+ */
+export declare function countLines(text: string): ExpectationAmount;

package/esm/typings/utils/expectation-counters/countLines.test.d.ts

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

package/esm/typings/utils/expectation-counters/countPages.d.ts

@@ -0,0 +1,5 @@
+import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+/**
+ * Counts number of pages in the text
+ */
+export declare function countPages(text: string): ExpectationAmount;

package/esm/typings/utils/expectation-counters/countPages.test.d.ts

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

package/esm/typings/utils/expectation-counters/countParagraphs.d.ts

@@ -0,0 +1,5 @@
+import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+/**
+ * Counts number of paragraphs in the text
+ */
+export declare function countParagraphs(text: string): ExpectationAmount;

package/esm/typings/utils/expectation-counters/countParagraphs.test.d.ts

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

package/esm/typings/utils/expectation-counters/countSentences.d.ts

@@ -0,0 +1,9 @@
+import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+/**
+ * Split text into sentences
+ */
+export declare function splitIntoSentences(text: string): Array<string>;
+/**
+ * Counts number of sentences in the text
+ */
+export declare function countSentences(text: string): ExpectationAmount;

package/esm/typings/utils/expectation-counters/countSentences.test.d.ts

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

package/esm/typings/utils/expectation-counters/countWords.d.ts

@@ -0,0 +1,5 @@
+import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+/**
+ * Counts number of words in the text
+ */
+export declare function countWords(text: string): ExpectationAmount;

package/esm/typings/utils/expectation-counters/countWords.test.d.ts

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

package/esm/typings/utils/expectation-counters/index.d.ts

@@ -0,0 +1,6 @@
+import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationUnit } from '../../types/PromptbookJson/PromptTemplateJson';
+/**
+ * Index of all counter functions
+ */
+export declare const CountUtils: Record<ExpectationUnit, (text: string) => ExpectationAmount>;

package/esm/typings/utils/extractParameters.d.ts

@@ -0,0 +1,9 @@
+import type { string_name } from '../types/typeAliases';
+import type { string_template } from '../types/typeAliases';
+/**
+ * Parses the template and returns the list of all parameter names
+ *
+ * @param template the template with parameters in {curly} braces
+ * @returns the list of parameter names
+ */
+export declare function extractParameters(template: string_template): Set<string_name>;

package/esm/typings/utils/extractParameters.test.d.ts

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

package/esm/typings/utils/formatNumber.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Format either small or big number
+ *
+ * @private within the library
+ */
+export declare function formatNumber(value: number): string;

package/esm/typings/utils/formatNumber.test.d.ts

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

package/esm/typings/utils/getCurrentIsoDate.d.ts

@@ -0,0 +1,7 @@
+import type { string_date_iso8601 } from '../types/typeAliases';
+/**
+ * Get current date in ISO 8601 format
+ *
+ * @private This is internal util of the promptbook
+ */
+export declare function getCurrentIsoDate(): string_date_iso8601;

package/esm/typings/utils/isRunningInWhatever.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Detects if the code is running in a browser environment in main thread (Not in a web worker)
+ */
+export declare const isRunningInBrowser: Function;
+/**
+ * Detects if the code is running in a Node.js environment
+ */
+export declare const isRunningInNode: Function;
+/**
+ * Detects if the code is running in a web worker
+ */
+export declare const isRunningInWebWorker: Function;

package/esm/typings/utils/isValidJsonString.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Function isValidJsonString will tell you if the string is valid JSON or not
+ */
+export declare function isValidJsonString(value: string): boolean;

package/esm/typings/utils/isValidJsonString.test.d.ts

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

package/esm/typings/utils/just.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Returns the same value that is passed as argument.
+ * No side effects.
+ *
+ * Note: It can be usefull for leveling indentation
+ *
+ * @param value any values
+ * @returns the same values
+ */
+export declare function just<T>(value?: T): T;

package/esm/typings/utils/markdown/addAutoGeneratedSection.d.ts

@@ -0,0 +1,11 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+/**
+ * Add or modify an auto-generated section in a markdown file
+ *
+ * @private within the library
+ */
+export declare function addAutoGeneratedSection(content: string_markdown, options: {
+    sectionName: string_name;
+    sectionContent: string_markdown;
+}): string_markdown;

package/esm/typings/utils/markdown/addAutoGeneratedSection.test.d.ts

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

package/esm/typings/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 library
+ */
+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/esm/typings/utils/markdown/createMarkdownChart.test.d.ts

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

package/esm/typings/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 library
+ */
+export declare function createMarkdownTable(table: Array<Array<string_markdown_text>>): string_markdown;

package/esm/typings/utils/markdown/createMarkdownTable.test.d.ts

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,8 @@
+import type { string_html } from '../../types/typeAliases';
+/**
+ * Prettify the html code
+ *
+ * @param content raw html code
+ * @returns formatted html code
+ */
+export declare function prettifyMarkdown<TContent extends string_html>(content: TContent): TContent;

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

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

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

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

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

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

package/esm/typings/utils/markdown-json/MarkdownStructure.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Represents the structure of a markdown file.
+ *
+ * @private within the library
+ */
+export type MarkdownStructure = {
+    /**
+     * The section level of the markdown file.
+     * h1 is level 1, h2 is level 2, etc.
+     */
+    level: number;
+    /**
+     * The title of the markdown file.
+     */
+    title: string;
+    /**
+     * Content of the section.
+     * It contains text, images, formatting, ul, ol, hr, blockquotes, etc. BUT not headings and sub-sections
+     */
+    content: string;
+    /**
+     * The sub-sections of current section which are recursively structured.
+     */
+    sections: MarkdownStructure[];
+};

package/esm/typings/utils/markdown-json/countMarkdownStructureDeepness.d.ts

@@ -0,0 +1,7 @@
+import type { MarkdownStructure } from './MarkdownStructure';
+/**
+ * Computes the deepness of the markdown structure.
+ *
+ * @private within the library
+ */
+export declare function countMarkdownStructureDeepness(markdownStructure: MarkdownStructure): number;

package/esm/typings/utils/markdown-json/countMarkdownStructureDeepness.test.d.ts

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

package/esm/typings/utils/markdown-json/markdownToMarkdownStructure.d.ts

@@ -0,0 +1,13 @@
+import type { MarkdownStructure } from './MarkdownStructure';
+/**
+ * Parse a markdown string into a MarkdownStructure object.
+ *
+ * Note: This function does work with code blocks
+ * Note: This function does not work with markdown comments
+ *
+ * @param markdown The markdown string to parse.
+ * @returns The MarkdownStructure object.
+ *
+ * @private within the library
+ */
+export declare function markdownToMarkdownStructure(markdown: string): MarkdownStructure;

package/esm/typings/utils/markdown-json/markdownToMarkdownStructure.test.d.ts

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

package/esm/typings/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/esm/typings/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/esm/typings/utils/normalization/capitalize.d.ts

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

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

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

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

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

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

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

package/esm/typings/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/esm/typings/utils/normalization/isValidKeyword.test.d.ts

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1 @@
+export declare function normalizeToKebabCase(sentence: string): string;

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

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

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

@@ -0,0 +1 @@
+export declare function normalizeTo_PascalCase(sentence: string): string;

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

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

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

@@ -0,0 +1,4 @@
+export declare function normalizeTo_SCREAMING_CASE(sentence: string): string;
+/**
+ * TODO: [🌺] Use some intermediate util splitWords
+ */

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

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

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

@@ -0,0 +1,4 @@
+export declare function normalizeTo_camelCase(sentence: string, __firstLetterCapital?: boolean): string;
+/**
+ * TODO: [🌺] Use some intermediate util splitWords
+ */

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

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

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

@@ -0,0 +1 @@
+export declare function normalizeTo_snake_case(sentence: string): string;

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

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

package/esm/typings/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/esm/typings/utils/normalization/normalizeWhitespaces.test.d.ts

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

package/esm/typings/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/esm/typings/utils/normalization/parseKeywords.test.d.ts

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

package/esm/typings/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/esm/typings/utils/normalization/parseKeywordsFromString.test.d.ts

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

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

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

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

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

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

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

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

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

package/esm/typings/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/esm/typings/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;