@promptbook/browser 0.63.0-0

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

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

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

@@ -0,0 +1,7 @@
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+/**
+ * Counts number of pages in the text
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function countPages(text: string): ExpectationAmount;

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

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

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

@@ -0,0 +1,7 @@
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+/**
+ * Counts number of paragraphs in the text
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function countParagraphs(text: string): ExpectationAmount;

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

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

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

@@ -0,0 +1,13 @@
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+/**
+ * Split text into sentences
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function splitIntoSentences(text: string): Array<string>;
+/**
+ * Counts number of sentences in the text
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function countSentences(text: string): ExpectationAmount;

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

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

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

@@ -0,0 +1,7 @@
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+/**
+ * Counts number of words in the text
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function countWords(text: string): ExpectationAmount;

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

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

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

@@ -0,0 +1,8 @@
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+import type { ExpectationUnit } from '../../types/PipelineJson/Expectations';
+/**
+ * Index of all counter functions
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const CountUtils: Record<ExpectationUnit, (text: string) => ExpectationAmount>;

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

@@ -0,0 +1,10 @@
+import type { string_parameter_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
+ * @public exported from `@promptbook/utils`
+ */
+export declare function extractParameterNames(template: string_template): Set<string_parameter_name>;

package/esm/typings/src/utils/extractParameterNames.test.d.ts

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

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

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

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

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

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

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

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

@@ -0,0 +1,14 @@
+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
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function addAutoGeneratedSection(content: string_markdown, options: {
+    readonly sectionName: string_name;
+    readonly sectionContent: string_markdown;
+}): string_markdown;
+/**
+ * TODO: [🏛] This can be part of markdown builder
+ */

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

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

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

@@ -0,0 +1,38 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { FromtoItems } from '../FromtoItems';
+/**
+ * Options for `CreateMarkdownChartOptions`
+ */
+type CreateMarkdownChartOptions = {
+    /**
+     * The header for the first column - the name of the item
+     */
+    readonly nameHeader: string;
+    /**
+     * The header for the second column - the value of the item
+     */
+    readonly valueHeader: string;
+    /**
+     * The items to be charted
+     */
+    readonly items: FromtoItems;
+    /**
+     * The width of the chart in squares
+     */
+    readonly width: number;
+    /**
+     * The name of the unit shown in the chart
+     */
+    readonly unitName: string;
+};
+/**
+ * Function createMarkdownChart will draw a chart in markdown from ⬛+🟦 tiles
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+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/src/utils/markdown/createMarkdownChart.test.d.ts

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

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

@@ -0,0 +1,11 @@
+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
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function createMarkdownTable(table: Array<Array<string_markdown_text>>): string_markdown;
+/**
+ * TODO: [🏛] This can be part of markdown builder
+ */

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

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

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

@@ -0,0 +1,11 @@
+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
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function escapeMarkdownBlock(value: string_markdown_text): string_markdown_text;
+/**
+ * TODO: [🏛] This can be part of markdown builder
+ */

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

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

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,34 @@
+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 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
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): Array<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,20 @@
+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
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function extractOneBlockFromMarkdown(markdown: string_markdown): CodeBlock;
+/***
+ * TODO: [🍓][🌻] Decide of this is internal util, 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 "# Untitled"
+ * - 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/removeContentComments.d.ts

@@ -0,0 +1,10 @@
+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.
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function removeContentComments<TContent extends string_html | string_markdown>(content: TContent): TContent;

package/esm/typings/src/utils/markdown/removeContentComments.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): Array<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 IKeywords
+ *
+ * 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 IKeywords = 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,18 @@
+/**
+ * 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;

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 {};