@promptbook/utils 0.41.0 → 0.41.2

package/umd/typings/utils/FromtoItems.d.ts

@@ -1,19 +1,19 @@
-/**
- * Represents items which are compared to each other
- */
-export type FromtoItems = Array<{
-    /**
-     * The title of the item
-     */
-    title: string;
-    /**
-     * The start of the item
-     *
-     * This can mean anything, like seconds, milliseconds, dollars, etc.
-     */
-    from: number;
-    /**
-     * The end of the item
-     */
-    to: number;
-}>;
+/**
+ * Represents items which are compared to each other
+ */
+export type FromtoItems = Array<{
+    /**
+     * The title of the item
+     */
+    title: string;
+    /**
+     * The start of the item
+     *
+     * This can mean anything, like seconds, milliseconds, dollars, etc.
+     */
+    from: number;
+    /**
+     * The end of the item
+     */
+    to: number;
+}>;

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

@@ -1,22 +1,22 @@
-import { 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
- */
+import { 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/umd/typings/utils/expectation-counters/countCharacters.d.ts

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,10 +1,10 @@
-import { string_name, 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
- *
- * @private within the library
- */
-export declare function extractParameters(template: string_template): Array<string_name>;
+import { string_name, 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
+ *
+ * @private within the library
+ */
+export declare function extractParameters(template: string_template): Array<string_name>;

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

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

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

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

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

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

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

@@ -1,7 +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;
+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/umd/typings/utils/isRunningInWhatever.d.ts

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

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

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

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

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

@@ -1,10 +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;
+/**
+ * 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/umd/typings/utils/markdown/addAutoGeneratedSection.d.ts

@@ -1,10 +1,10 @@
-import type { string_markdown, 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;
+import type { string_markdown, 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/umd/typings/utils/markdown/addAutoGeneratedSection.test.d.ts

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

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

@@ -1,41 +1,41 @@
-import { string_markdown } from '../../types/typeAliases';
-import { 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/
- */
+import { string_markdown } from '../../types/typeAliases';
+import { 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/umd/typings/utils/markdown/createMarkdownChart.test.d.ts

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

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

@@ -1,7 +1,7 @@
-import { string_markdown, 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;
+import { string_markdown, 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/umd/typings/utils/markdown/createMarkdownTable.test.d.ts

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

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

@@ -1,6 +1,6 @@
-import { 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;
+import { 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/utils/markdown/escapeMarkdownBlock.test.d.ts

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

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

@@ -1,27 +1,27 @@
-import { 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>;
+import { 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/utils/markdown/extractAllBlocksFromMarkdown.test.d.ts

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

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

@@ -1,13 +1,13 @@
-import { string_markdown, 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 { string_markdown, 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/utils/markdown/extractAllListItemsFromMarkdown.test.d.ts

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

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

@@ -1,19 +1,19 @@
-import { string_markdown } from '../.././types/typeAliases';
-import { 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 { string_markdown } from '../.././types/typeAliases';
+import { 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/utils/markdown/extractOneBlockFromMarkdown.test.d.ts

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

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

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

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

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