@promptbook/javascript 0.111.0-3 → 0.111.0-7

package/umd/src/utils/files/$induceFileDownload.d.ts

@@ -0,0 +1,13 @@
+import type { string_url } from '../../types/typeAliases';
+import type { $side_effect } from '../organization/$side_effect';
+/**
+ * Download a File in a browser
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - its purpose is to cause a side effect (download a file)
+ *
+ * @public exported from `@promptbook/browser`
+ */
+export declare function $induceFileDownload(fileOrBlobOrUrl: File | Blob | URL | string_url): Promise<$side_effect>;
+/**
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
+ */

package/umd/src/utils/files/ObjectUrl.d.ts

@@ -0,0 +1,46 @@
+import { IDestroyable, Registration } from 'destroyable';
+import type { string_mime_type, string_url } from '../../types/typeAliases';
+/**
+ * Converts Blob, File or MediaSource to url using URL.createObjectURL
+ *
+ * @public exported from `@promptbook/browser`
+ */
+export declare class ObjectUrl extends Registration implements IDestroyable {
+    readonly src: string_url;
+    private constructor();
+    /**
+     * Creates ObjectUrl from multiple input types
+     * Note: DO NOT forget to call destroy() when you are done with it
+     */
+    static from(source: Blob | File | MediaSource | string, mimeType: string_mime_type): ObjectUrl;
+    /**
+     * Creates ObjectUrl from string
+     * Note: DO NOT forget to call destroy() when you are done with it
+     */
+    static fromString(source: string, mimeType: string_mime_type): ObjectUrl;
+    /**
+     * Creates ObjectUrl
+     * DO NOT forget to call destroy() when you are done with it
+     */
+    static fromBlob(source: Blob | File | MediaSource): ObjectUrl;
+    /**
+     * Creates ObjectUrl:
+     * 1) With functionality for Blobs, Files or MediaSources
+     * 2) Just a wrapper for string urls
+     *
+     * DO NOT forget to call destroy() when you are done with it
+     */
+    static fromBlobOrUrl(source: Blob | File | MediaSource | URL | string_url): ObjectUrl;
+    /**
+     * Gets object url as string
+     * @alias src
+     */
+    get href(): string_url;
+    /**
+     * Gets object url as URL object
+     */
+    get url(): URL;
+}
+/**
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
+ */

package/umd/src/utils/files/extensionToMimeType.d.ts

@@ -0,0 +1,8 @@
+import type { string_file_extension } from '../../types/typeAliases';
+import type { string_mime_type } from '../../types/typeAliases';
+/**
+ * Convert file extension to mime type
+ *
+ * @private within the repository
+ */
+export declare function extensionToMimeType(value: string_file_extension): string_mime_type;

package/umd/src/utils/files/extensionToMimeType.test.d.ts

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

package/umd/src/utils/files/getFileExtension.d.ts

@@ -0,0 +1,8 @@
+import type { string_filename } from '../../types/typeAliases';
+import type { string_mime_type } from '../../types/typeAliases';
+/**
+ * Get the file extension from a file name
+ *
+ * @private within the repository
+ */
+export declare function getFileExtension(value: string_filename): string_mime_type | null;

package/umd/src/utils/files/getFileExtension.test.d.ts

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

package/umd/src/utils/files/isDirectoryExisting.d.ts

@@ -0,0 +1,14 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+import type { string_dirname } from '../../types/typeAliases';
+/**
+ * Checks if the directory exists
+ *
+ * @private within the repository
+ */
+export declare function isDirectoryExisting(directoryPath: string_dirname, fs: FilesystemTools): Promise<boolean>;
+/**
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
+ * TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
+ * TODO: [🧠][📂] "directory" vs "folder"
+ * TODO: [🖇] What about symlinks?
+ */

package/umd/src/utils/files/isDirectoryExisting.test.d.ts

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

package/umd/src/utils/files/isExecutable.d.ts

@@ -0,0 +1,11 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+/**
+ * Checks if the file is executable
+ *
+ * @private within the repository
+ */
+export declare function isExecutable(path: string, fs: FilesystemTools): Promise<boolean>;
+/**
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
+ * TODO: [🖇] What about symlinks?
+ */

package/umd/src/utils/files/isFileExisting.d.ts

@@ -0,0 +1,13 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+import type { string_filename } from '../../types/typeAliases';
+/**
+ * Checks if the file exists
+ *
+ * @private within the repository
+ */
+export declare function isFileExisting(filename: string_filename, fs: FilesystemTools): Promise<boolean>;
+/**
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
+ * TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
+ * TODO: [🖇] What about symlinks?
+ */

package/umd/src/utils/files/isFileExisting.test.d.ts

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

package/umd/src/utils/files/listAllFiles.d.ts

@@ -0,0 +1,16 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+import type { string_dirname, string_filename } from '../../types/typeAliases';
+/**
+ * Reads all files in the directory
+ *
+ * @param path
+ * @param isRecursive
+ * @returns List of all files in the directory
+ * @private internal function of `AgentCollectionInDirectory` and `createPipelineCollectionFromDirectory`
+ */
+export declare function listAllFiles(path: string_dirname, isRecursive: boolean, fs: FilesystemTools): Promise<Array<string_filename>>;
+/**
+ * TODO: [😶] Unite folder listing
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
+ * TODO: [🖇] What about symlinks?
+ */

package/umd/src/utils/files/listAllFiles.test.d.ts

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

package/umd/src/utils/files/mimeTypeToExtension.d.ts

@@ -0,0 +1,10 @@
+import type { string_file_extension } from '../../types/typeAliases';
+import type { string_mime_type } from '../../types/typeAliases';
+/**
+ * Convert mime type to file extension
+ *
+ * Note: If the mime type is invalid, `null` is returned
+ *
+ * @private within the repository
+ */
+export declare function mimeTypeToExtension(value: string_mime_type): string_file_extension | null;

package/umd/src/utils/files/mimeTypeToExtension.test.d.ts

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

package/umd/src/utils/knowledge/inlineKnowledgeSource.d.ts

@@ -0,0 +1,42 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import type { string_data_url, string_filename, string_knowledge_source_link } from '../../types/typeAliases';
+/**
+ * @private Internal representation of inline knowledge prepared for uploads.
+ */
+export type InlineKnowledgeSourceFile = {
+    readonly filename: string_filename;
+    readonly mimeType: string;
+    readonly buffer: Buffer;
+};
+/**
+ * @private Function signature used to upload inline knowledge files to external storage.
+ */
+export type InlineKnowledgeSourceUploader = (file: InlineKnowledgeSourceFile) => Promise<string_knowledge_source_link>;
+/**
+ * @private Converts inline knowledge into the internal metadata form used for uploads.
+ */
+export declare function createInlineKnowledgeSourceFile(content: string): InlineKnowledgeSourceFile;
+/**
+ * Checks whether the provided source string is a data URL that can be decoded.
+ *
+ * @private thing of inline knowledge
+ */
+export declare function isDataUrlKnowledgeSource(source: string): source is string_data_url;
+/**
+ * @private Converts a stored inline knowledge file into a data URL for backwards compatibility.
+ */
+export declare function inlineKnowledgeSourceToDataUrl(source: InlineKnowledgeSourceFile): string_knowledge_source_link;
+/**
+ * Parses a data URL-based knowledge source into its raw buffer, filename, and MIME type.
+ *
+ * @private utility of inline knowledge processing
+ */
+export declare function parseDataUrlKnowledgeSource(source: string): {
+    readonly buffer: Buffer;
+    readonly filename: string_filename;
+    readonly mimeType: string;
+} | null;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/umd/src/utils/knowledge/inlineKnowledgeSource.test.d.ts

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

package/umd/src/utils/knowledge/simplifyKnowledgeLabel.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Simplifies knowledge labels for UI chips by:
+ * - extracting filename from URL/path-like values,
+ * - removing extension,
+ * - removing trailing random ID segment when detected,
+ * - truncating to 20 characters with ellipsis.
+ *
+ * @param label - Raw knowledge label or source value.
+ * @returns Display-friendly chip label.
+ * @private utility of knowledge/source chip rendering
+ */
+export declare function simplifyKnowledgeLabel(label: string): string;
+/**
+ * Heuristic that classifies a short text as human-readable, identifier-like, or unknown.
+ *
+ * @param text - Candidate value (typically a filename segment).
+ * @returns `'HUMAN'`, `'ID'`, or `'UNKNOWN'`.
+ * @private utility of knowledge/source chip rendering
+ */
+export declare function isHumanOrID(text: string): 'HUMAN' | 'ID' | 'UNKNOWN';

package/umd/src/utils/knowledge/simplifyKnowledgeLabel.test.d.ts

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

package/umd/src/utils/language/getBrowserPreferredSpeechRecognitionLanguage.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @@@
+ *
+ * @private function of Agents Server speech recognition language resolution, not a general-purpose utility
+ */
+type ResolveSpeechRecognitionLanguageOptions = {
+    /**
+     * Overrides the default language resolution when provided.
+     */
+    readonly overrideLanguage?: string | null;
+    /**
+     * Optional Accept-Language header string to derive the speaker language from server-side requests.
+     */
+    readonly acceptLanguageHeader?: string | null;
+};
+/**
+ * Parses the primary language out of an Accept-Language header value.
+ *
+ * @private function of Agents Server speech recognition language resolution, not a general-purpose utility
+ */
+export declare function parseSpeechRecognitionLanguageFromAcceptLanguageHeader(header?: string | null): string | undefined;
+/**
+ * Reads the browser-reported preferred language list and returns the first valid tag.
+ *
+ * @private function of Agents Server speech recognition language resolution, not a general-purpose utility
+ */
+export declare function getBrowserPreferredSpeechRecognitionLanguage(): string | undefined;
+/**
+ * Resolves a speech recognition language tag by checking an optional override, then the Accept-Language header,
+ * then the browser preferences, and finally falling back to a default of `en-US`.
+ *
+ * @private function of Agents Server speech recognition language resolution, not a general-purpose utility
+ */
+export declare function resolveSpeechRecognitionLanguage(options?: ResolveSpeechRecognitionLanguageOptions): string;
+export {};

package/umd/src/utils/linguistic-hash/LinguisticHashLanguage.d.ts

@@ -0,0 +1,41 @@
+import type { LinguisticHashWordLists } from './linguisticHashTypes';
+/**
+ * Supported language codes for linguistic hash output.
+ *
+ * @private utility of `linguisticHash`
+ */
+export type LinguisticHashLanguage = 'en' | 'cs';
+/**
+ * Language-specific configuration for linguistic hash generation.
+ *
+ * @private utility of `linguisticHash`
+ */
+export type LinguisticHashLanguageConfig = {
+    language: LinguisticHashLanguage;
+    label: string;
+    wordLists: LinguisticHashWordLists;
+};
+/**
+ * Default language used for linguistic hashes.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare const DEFAULT_LINGUISTIC_HASH_LANGUAGE: LinguisticHashLanguage;
+/**
+ * Ordered list of supported linguistic hash languages.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare const LINGUISTIC_HASH_LANGUAGES: readonly LinguisticHashLanguageConfig[];
+/**
+ * Normalizes a requested language to a supported linguistic hash language.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare function normalizeLinguisticHashLanguage(language?: string | null): LinguisticHashLanguage;
+/**
+ * Returns the language configuration for linguistic hash generation.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare function getLinguisticHashLanguageConfig(language?: string | null): LinguisticHashLanguageConfig;

package/umd/src/utils/linguistic-hash/linguisticHash.d.ts

@@ -0,0 +1,14 @@
+import type { LinguisticHashLanguage } from './LinguisticHashLanguage';
+export { DEFAULT_LINGUISTIC_HASH_LANGUAGE, LINGUISTIC_HASH_LANGUAGES, normalizeLinguisticHashLanguage, } from './LinguisticHashLanguage';
+export type { LinguisticHashLanguage } from './LinguisticHashLanguage';
+export { DEFAULT_LINGUISTIC_HASH_WORD_COUNT, MAX_LINGUISTIC_HASH_WORD_COUNT, MIN_LINGUISTIC_HASH_WORD_COUNT, normalizeLinguisticHashWordCount, } from './linguisticHashWordCount';
+/**
+ * Creates a human-readable hash as a short, story-like phrase.
+ *
+ * @param wordCount how many words to include (defaults to {@link DEFAULT_LINGUISTIC_HASH_WORD_COUNT}, clamped to
+ * {@link MIN_LINGUISTIC_HASH_WORD_COUNT}..{@link MAX_LINGUISTIC_HASH_WORD_COUNT})
+ * @param language optional language code (defaults to {@link DEFAULT_LINGUISTIC_HASH_LANGUAGE})
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function linguisticHash(input: string, wordCount?: number, language?: LinguisticHashLanguage): Promise<string>;

package/umd/src/utils/linguistic-hash/linguisticHash.test.d.ts

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

package/umd/src/utils/linguistic-hash/linguisticHashTypes.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Types of words used in linguistic hash output.
+ *
+ * @private utility of `linguisticHash`
+ */
+export type LinguisticHashWordKind = 'adjective' | 'noun' | 'verb';
+/**
+ * Word lists used to build linguistic hashes.
+ *
+ * @private utility of `linguisticHash`
+ */
+export type LinguisticHashWordLists = {
+    adjective: readonly string[];
+    noun: readonly string[];
+    verb: readonly string[];
+};
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/umd/src/utils/linguistic-hash/linguisticHashWordCount.d.ts

@@ -0,0 +1,31 @@
+import { MAX_LINGUISTIC_HASH_WORD_COUNT } from './linguisticHashWordSelection';
+/**
+ * The minimum number of words for a linguistic hash.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare const MIN_LINGUISTIC_HASH_WORD_COUNT = 1;
+/**
+ * The default number of words for a linguistic hash.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare const DEFAULT_LINGUISTIC_HASH_WORD_COUNT = 7;
+/**
+ * Normalizes the word count to a supported integer range.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare function normalizeLinguisticHashWordCount(wordCount?: number | null): number;
+export { MAX_LINGUISTIC_HASH_WORD_COUNT };
+/**
+ * Bundled helpers for linguistic hash word count handling.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare const linguisticHashWordCount: {
+    DEFAULT_LINGUISTIC_HASH_WORD_COUNT: number;
+    MAX_LINGUISTIC_HASH_WORD_COUNT: number;
+    MIN_LINGUISTIC_HASH_WORD_COUNT: number;
+    normalizeLinguisticHashWordCount: typeof normalizeLinguisticHashWordCount;
+};

package/umd/src/utils/linguistic-hash/linguisticHashWordSelection.d.ts

@@ -0,0 +1,22 @@
+import type { LinguisticHashWordLists } from './linguisticHashTypes';
+/**
+ * The maximum number of words for a linguistic hash.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare const MAX_LINGUISTIC_HASH_WORD_COUNT: number;
+/**
+ * Selects the requested number of words from the hash output.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare function createLinguisticHashWords(hash: string, wordCount: number, wordLists: LinguisticHashWordLists): string[];
+/**
+ * Bundled helpers for the linguistic hash word selection module.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare const linguisticHashWordSelection: {
+    createLinguisticHashWords: typeof createLinguisticHashWords;
+    MAX_LINGUISTIC_HASH_WORD_COUNT: number;
+};

package/umd/src/utils/linguistic-hash/linguisticHashWords.cs.d.ts

@@ -0,0 +1,10 @@
+import type { LinguisticHashWordLists } from './linguisticHashTypes';
+/**
+ * Czech word lists used by the linguistic hash.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare const LINGUISTIC_HASH_WORD_LISTS_CS: LinguisticHashWordLists;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/umd/src/utils/linguistic-hash/linguisticHashWords.en.d.ts

@@ -0,0 +1,10 @@
+import type { LinguisticHashWordLists } from './linguisticHashTypes';
+/**
+ * English word lists used by the linguistic hash.
+ *
+ * @private utility of `linguisticHash`
+ */
+export declare const LINGUISTIC_HASH_WORD_LISTS_EN: LinguisticHashWordLists;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/umd/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/umd/src/utils/markdown/addAutoGeneratedSection.test.d.ts

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

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

@@ -0,0 +1,38 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { FromtoItems } from '../misc/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/umd/src/utils/markdown/createMarkdownChart.test.d.ts

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

package/umd/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/umd/src/utils/markdown/createMarkdownTable.test.d.ts

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

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

@@ -0,0 +1,13 @@
+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
+ *
+ * Note: [🔂] This function is idempotent.
+ *
+ * @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/umd/src/utils/markdown/escapeMarkdownBlock.test.d.ts

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

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

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

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

@@ -0,0 +1,36 @@
+import type { string_markdown } from '../../types/typeAliases';
+/**
+ * Single code block inside markdown.
+ */
+export type MarkdownCodeBlock = {
+    /**
+     * 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 similar functions:
+ * - `extractBlock` just extracts the content of the code block which is also used as built-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<MarkdownCodeBlock>;
+/**
+ * TODO: Maybe name for `blockNotation` instead of  '```' and '>'
+ */

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

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

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

@@ -0,0 +1,14 @@
+import type { 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 An array of strings, each representing an individual list item found in the markdown
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function extractAllListItemsFromMarkdown(markdown: string_markdown): string_markdown_text[];

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

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

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

@@ -0,0 +1,22 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { MarkdownCodeBlock } 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 similar functions:
+ * - `extractBlock` just extracts the content of the code block which is also used as built-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): MarkdownCodeBlock;
+/***
+ * TODO: [🍓][🌻] Decide of this is internal utility, external util OR validator/postprocessor
+ */

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

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

package/umd/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/umd/src/utils/markdown/flattenMarkdown.test.d.ts

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