@promptbook/cli 0.62.2 → 0.63.0-0

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

@@ -1,34 +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
- *
- */
-export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): Array<CodeBlock>;
-/**
- * TODO: Maybe name for `blockNotation` instead of  '```' and '>'
- */
+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/umd/typings/src/utils/markdown/extractAllBlocksFromMarkdown.test.d.ts

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

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

@@ -1,14 +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
- */
-export declare function extractAllListItemsFromMarkdown(markdown: string_markdown): string_markdown_text[];
+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/umd/typings/src/utils/markdown/extractAllListItemsFromMarkdown.test.d.ts

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

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

@@ -1,19 +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
- */
-export declare function extractOneBlockFromMarkdown(markdown: string_markdown): CodeBlock;
-/***
- * TODO: [🍓][🌻] Decide of this is internal util, external util OR validator/postprocessor
- */
+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/umd/typings/src/utils/markdown/extractOneBlockFromMarkdown.test.d.ts

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

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

@@ -1,14 +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
- */
-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
- */
+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/umd/typings/src/utils/markdown/flattenMarkdown.test.d.ts

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

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

@@ -1,30 +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
- */
-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
- */
-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
- */
+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/umd/typings/src/utils/markdown/parseMarkdownSection.test.d.ts

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

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

@@ -1,9 +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;
+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

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

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

@@ -1,9 +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.
- */
-export declare function removeContentComments<TContent extends string_html | string_markdown>(content: TContent): TContent;
+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/umd/typings/src/utils/markdown/removeContentComments.test.d.ts

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

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

@@ -1,8 +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.
- */
-export declare function removeMarkdownFormatting(str: string_markdown_text): string;
+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/umd/typings/src/utils/markdown/removeMarkdownFormatting.test.d.ts

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

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

@@ -1,12 +1,15 @@
-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
- */
+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/umd/typings/src/utils/markdown/splitMarkdownIntoSections.test.d.ts

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

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

@@ -1,10 +1,12 @@
-/**
- * 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>;
+/**
+ * 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/umd/typings/src/utils/normalization/IKeywords.d.ts

@@ -1,18 +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"`
- */
-export type string_keyword = string;
-/**
- * Semantic helper
- * Set of keywords @see string_keyword
- *
- */
-export type IKeywords = Set<string_keyword>;
-/**
- * TODO: [🌮] Keywords with weight
- */
+/**
+ * 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/umd/typings/src/utils/normalization/capitalize.d.ts

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

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

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

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

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

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

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

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

@@ -1,8 +1,10 @@
-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;
+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/umd/typings/src/utils/normalization/isValidKeyword.test.d.ts

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

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

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

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

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

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

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

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

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

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

@@ -1,8 +1,18 @@
-/**
- * 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;
+/**
+ * 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/umd/typings/src/utils/normalization/normalize-to-kebab-case.test.d.ts

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

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

@@ -1,8 +1,17 @@
-/**
- * Semantic helper for PascalCase strings
- *
- * @example 'HelloWorld'
- * @example 'ILovePromptbook'
- */
-export type string_PascalCase = string;
-export declare function normalizeTo_PascalCase(text: string): string_PascalCase;
+/**
+ * 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/umd/typings/src/utils/normalization/normalizeTo_PascalCase.test.d.ts

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

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

@@ -1,16 +1,26 @@
-/**
- * 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
- */
+/**
+ * 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
+ */