@promptbook/openai 0.60.1 → 0.61.0-1

package/esm/typings/src/scripting/javascript/utils/preserve.d.ts

@@ -1,3 +1,4 @@
+import type { really_any } from '../../../types/typeAliases';
 /**
  * Does nothing, but preserves the function in the bundle
  * Compiler is tricked into thinking the function is used
@@ -5,7 +6,7 @@
  * @param value any function to preserve
  * @returns nothing
  */
-export declare function preserve(func: (...params: Array<any>) => unknown): void;
+export declare function preserve(func: (...params: Array<really_any>) => unknown): void;
 /**
  * TODO: !! [1] This maybe does memory leak
  */

package/esm/typings/src/types/Arrayable.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Item or array of items
+ *
+ * 1) Any item except array and undefined represents array with that one item (also null)
+ * 2) Undefined represents empty array
+ * 3) Array represents itself
+ *
+ * @private Internal utility type
+ */
+export type Arrayable<TItem> = TItem | Array<TItem> | undefined;

package/esm/typings/src/types/PipelineJson/Expectations.d.ts

@@ -0,0 +1,28 @@
+import type { number_integer } from '../typeAliases';
+import type { number_positive } from '../typeAliases';
+/**
+ * Expect this amount of each unit in the answer
+ *
+ * For example 5 words, 3 sentences, 2 paragraphs, ...
+ *
+ * Note: Expectations are performed after all postprocessing steps
+ */
+export type Expectations = Partial<Record<Lowercase<ExpectationUnit>, {
+    min?: ExpectationAmount;
+    max?: ExpectationAmount;
+}>>;
+/**
+ * Units of text measurement
+ */
+export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "LINES", "PARAGRAPHS", "PAGES"];
+/**
+ * Unit of text measurement
+ */
+export type ExpectationUnit = typeof EXPECTATION_UNITS[number];
+/**
+ * Amount of text measurement
+ */
+export type ExpectationAmount = number_integer & (number_positive | 0);
+/**
+ * TODO: [💝] Unite object for expecting amount and format - remove expectFormat
+ */

package/esm/typings/src/types/PipelineJson/LlmTemplateJson.d.ts

@@ -0,0 +1,16 @@
+import type { ModelRequirements } from '../ModelRequirements';
+import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
+/**
+ * Template for prompt to LLM
+ */
+export type LlmTemplateJson = PromptTemplateJsonCommon & {
+    readonly blockType: 'PROMPT_TEMPLATE';
+    /**
+     * Requirements for the model
+     * - This is required only for blockType PROMPT_TEMPLATE
+     */
+    readonly modelRequirements: ModelRequirements;
+};
+/**
+ * TODO: [👙][🧠] Just selecting gpt3 or gpt4 level of modelT
+ */

package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts

@@ -1,6 +1,7 @@
+import type { string_file_path } from '../typeAliases';
 import type { string_markdown_text } from '../typeAliases';
 import type { string_pipeline_url } from '../typeAliases';
-import type { string_version } from '../typeAliases';
+import type { string_semantic_version } from '../typeAliases';
 import type { KnowledgeJson } from './KnowledgeJson';
 import type { PromptTemplateJson } from './PromptTemplateJson';
 import type { PromptTemplateParameterJson } from './PromptTemplateParameterJson';
@@ -21,6 +22,10 @@ export type PipelineJson = {
      * Warning: Do not hash part of the URL, hash part is used for identification of the prompt template in the pipeline
      */
     readonly pipelineUrl?: string_pipeline_url;
+    /**
+     * Internal helper for tracking the source `.ptbk.md` file of the pipeline
+     */
+    readonly sourceFile?: string_file_path;
     /**
      * Title of the promptbook
      * -It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
@@ -29,7 +34,7 @@ export type PipelineJson = {
     /**
      * Version of the .ptbk.json file
      */
-    readonly promptbookVersion: string_version;
+    readonly promptbookVersion: string_semantic_version;
     /**
      * Description of the promptbook
      * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
@@ -49,6 +54,7 @@ export type PipelineJson = {
     readonly knowledge: KnowledgeJson;
 };
 /**
+ * TODO: !!!!! Implement new commands
  * Note: There was a proposal for multiple types of promptbook objects 78816ff33e2705ee1a187aa2eb8affd976d4ea1a
  *       But then immediately reverted back to the single type
  *       With knowledge as part of the promptbook and collection just as a collection of promptbooks

package/esm/typings/src/types/PipelineJson/PromptDialogJson.d.ts

@@ -0,0 +1,7 @@
+import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
+/**
+ * Template for prompt to user
+ */
+export interface PromptDialogJson extends PromptTemplateJsonCommon {
+    readonly blockType: 'PROMPT_DIALOG';
+}

package/esm/typings/src/types/PipelineJson/PromptTemplateJson.d.ts

@@ -1,145 +1,9 @@
-import type { ExpectFormatCommand } from '../Command';
-import type { ExecutionType } from '../ExecutionTypes';
-import type { ModelRequirements } from '../ModelRequirements';
-import type { ScriptLanguage } from '../ScriptLanguage';
-import type { number_integer } from '../typeAliases';
-import type { number_positive } from '../typeAliases';
-import type { string_javascript } from '../typeAliases';
-import type { string_javascript_name } from '../typeAliases';
-import type { string_markdown } from '../typeAliases';
-import type { string_markdown_text } from '../typeAliases';
-import type { string_name } from '../typeAliases';
-import type { string_prompt } from '../typeAliases';
-import type { string_template } from '../typeAliases';
+import type { ___ } from '../typeAliases';
+import type { LlmTemplateJson } from './LlmTemplateJson';
+import type { PromptDialogJson } from './PromptDialogJson';
+import type { ScriptJson } from './ScriptJson';
+import type { SimpleTemplateJson } from './SimpleTemplateJson';
 /**
  * Describes one prompt template in the promptbook
  */
-export type PromptTemplateJson = LlmTemplateJson | SimpleTemplateJson | ScriptJson | PromptDialogJson;
-/**
- * Template for prompt to LLM
- */
-export type LlmTemplateJson = PromptTemplateJsonCommon & {
-    readonly executionType: 'PROMPT_TEMPLATE';
-    /**
-     * Requirements for the model
-     * - This is required only for executionType PROMPT_TEMPLATE
-     */
-    readonly modelRequirements: ModelRequirements;
-};
-/**
- * Expect this amount of each unit in the answer
- *
- * For example 5 words, 3 sentences, 2 paragraphs, ...
- *
- * Note: Expectations are performed after all postprocessing steps
- */
-export type Expectations = Partial<Record<Lowercase<ExpectationUnit>, {
-    min?: ExpectationAmount;
-    max?: ExpectationAmount;
-}>>;
-/**
- * Units of text measurement
- */
-export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "LINES", "PARAGRAPHS", "PAGES"];
-/**
- * Unit of text measurement
- */
-export type ExpectationUnit = typeof EXPECTATION_UNITS[number];
-/**
- * Amount of text measurement
- */
-export type ExpectationAmount = number_integer & (number_positive | 0);
-/**
- * Template for simple concatenation of strings
- */
-export interface SimpleTemplateJson extends PromptTemplateJsonCommon {
-    readonly executionType: 'SIMPLE_TEMPLATE';
-}
-/**
- * Template for script execution
- */
-export interface ScriptJson extends PromptTemplateJsonCommon {
-    readonly executionType: 'SCRIPT';
-    /**
-     * Language of the script
-     * - This is required only for executionType SCRIPT
-     *
-     */
-    readonly contentLanguage?: ScriptLanguage;
-}
-/**
- * Template for prompt to user
- */
-export interface PromptDialogJson extends PromptTemplateJsonCommon {
-    readonly executionType: 'PROMPT_DIALOG';
-}
-/**
- * Common properties of all prompt templates
- */
-interface PromptTemplateJsonCommon {
-    /**
-     * Name of the template
-     * - It must be unique across the pipeline
-     * - It should start uppercase and contain letters and numbers
-     * - The pipelineUrl together with hash and name are used to identify the prompt template in the pipeline
-     */
-    readonly name: string_name;
-    /**
-     * Title of the prompt template
-     * It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
-     */
-    readonly title: string;
-    /**
-     * Description of the prompt template
-     * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
-     */
-    readonly description?: string_markdown_text;
-    /**
-     * List of parameter names that are used in the prompt template and must be defined before the prompt template is executed
-     *
-     * Note: Joker is one of the dependent parameters
-     */
-    readonly dependentParameterNames: Array<string_name>;
-    /**
-     * If theese parameters meet the expectations requirements, they are used instead of executing this prompt template
-     */
-    readonly jokers?: Array<string>;
-    /**
-     * Type of the execution
-     * This determines if the prompt template is send to LLM, user or some scripting evaluation
-     */
-    readonly executionType: ExecutionType;
-    /**
-     * Content of the template with {placeholders} for parameters
-     */
-    readonly content: (string_prompt | string_javascript | string_markdown) & string_template;
-    /**
-     * List of postprocessing steps that are executed after the prompt template
-     */
-    readonly postprocessing?: Array<string_javascript_name>;
-    /**
-     * Expect this amount of each unit in the answer
-     *
-     * For example 5 words, 3 sentences, 2 paragraphs, ...
-     *
-     * Note: Expectations are performed after all postprocessing steps
-     */
-    readonly expectations?: Expectations;
-    /**
-     * Expect this format of the answer
-     *
-     * Note: Expectations are performed after all postprocessing steps
-     * @deprecated [💝]
-     */
-    readonly expectFormat?: ExpectFormatCommand['format'];
-    /**
-     * Name of the parameter that is the result of the prompt template
-     */
-    readonly resultingParameterName: string_name;
-}
-export {};
-/**
- * TODO: [💝] Unite object for expecting amount and format - remove expectFormat
- * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
- * TODO: [👙][🧠] Just selecting gpt3 or gpt4 level of model
- */
+export type PromptTemplateJson = LlmTemplateJson | SimpleTemplateJson | ScriptJson | PromptDialogJson | ___ | ___ | ___ | ___;

package/esm/typings/src/types/PipelineJson/PromptTemplateJsonCommon.d.ts

@@ -0,0 +1,77 @@
+import type { BlockType } from '../../commands/BLOCK/BlockTypes';
+import type { ExpectFormatCommand } from '../../commands/EXPECT/ExpectFormatCommand';
+import type { string_javascript } from '../typeAliases';
+import type { string_javascript_name } from '../typeAliases';
+import type { string_markdown } from '../typeAliases';
+import type { string_markdown_text } from '../typeAliases';
+import type { string_name } from '../typeAliases';
+import type { string_prompt } from '../typeAliases';
+import type { string_template } from '../typeAliases';
+import type { Expectations } from './Expectations';
+/**
+ * Common properties of all prompt templates
+ */
+export interface PromptTemplateJsonCommon {
+    /**
+     * Name of the template
+     * - It must be unique across the pipeline
+     * - It should start uppercase and contain letters and numbers
+     * - The pipelineUrl together with hash and name are used to identify the prompt template in the pipeline
+     */
+    readonly name: string_name;
+    /**
+     * Title of the prompt template
+     * It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
+     */
+    readonly title: string;
+    /**
+     * Description of the prompt template
+     * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
+     */
+    readonly description?: string_markdown_text;
+    /**
+     * List of parameter names that are used in the prompt template and must be defined before the prompt template is executed
+     *
+     * Note: Joker is one of the dependent parameters
+     */
+    readonly dependentParameterNames: Array<string_name>;
+    /**
+     * If theese parameters meet the expectations requirements, they are used instead of executing this prompt template
+     */
+    readonly jokers?: Array<string>;
+    /**
+     * Type of the execution
+     * This determines if the prompt template is send to LLM, user or some scripting evaluation
+     */
+    readonly blockType: BlockType;
+    /**
+     * Content of the template with {placeholders} for parameters
+     */
+    readonly content: (string_prompt | string_javascript | string_markdown) & string_template;
+    /**
+     * List of postprocessing steps that are executed after the prompt template
+     */
+    readonly postprocessing?: Array<string_javascript_name>;
+    /**
+     * Expect this amount of each unit in the answer
+     *
+     * For example 5 words, 3 sentences, 2 paragraphs, ...
+     *
+     * Note: Expectations are performed after all postprocessing steps
+     */
+    readonly expectations?: Expectations;
+    /**
+     * Expect this format of the answer
+     *
+     * Note: Expectations are performed after all postprocessing steps
+     * @deprecated [💝]
+     */
+    readonly expectFormat?: ExpectFormatCommand['format'];
+    /**
+     * Name of the parameter that is the result of the prompt template
+     */
+    readonly resultingParameterName: string_name;
+}
+/**
+ * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
+ */

package/esm/typings/src/types/PipelineJson/ScriptJson.d.ts

@@ -0,0 +1,14 @@
+import type { ScriptLanguage } from '../ScriptLanguage';
+import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
+/**
+ * Template for script execution
+ */
+export interface ScriptJson extends PromptTemplateJsonCommon {
+    readonly blockType: 'SCRIPT';
+    /**
+     * Language of the script
+     * - This is required only for blockType SCRIPT
+     *
+     */
+    readonly contentLanguage?: ScriptLanguage;
+}

package/esm/typings/src/types/PipelineJson/SimpleTemplateJson.d.ts

@@ -0,0 +1,7 @@
+import type { PromptTemplateJsonCommon } from './PromptTemplateJsonCommon';
+/**
+ * Template for simple concatenation of strings
+ */
+export interface SimpleTemplateJson extends PromptTemplateJsonCommon {
+    readonly blockType: 'SIMPLE_TEMPLATE';
+}

package/esm/typings/src/types/Prompt.d.ts

@@ -1,7 +1,7 @@
+import type { ExpectFormatCommand } from '../commands/EXPECT/ExpectFormatCommand';
 import type { PostprocessingFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
-import type { ExpectFormatCommand } from './Command';
 import type { ModelRequirements } from './ModelRequirements';
-import type { Expectations } from './PipelineJson/PromptTemplateJson';
+import type { Expectations } from './PipelineJson/Expectations';
 import type { string_name } from './typeAliases';
 import type { string_pipeline_url_with_hashtemplate } from './typeAliases';
 import type { string_prompt } from './typeAliases';
@@ -52,7 +52,7 @@ export type Prompt = {
      *
      * @example https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md#keywords
      */
-    readonly pipelineUrl: string_pipeline_url_with_hashtemplate;
+    readonly pipelineUrl?: string_pipeline_url_with_hashtemplate;
     /**
      * Parameters used in the prompt
      *

package/esm/typings/src/types/TaskProgress.d.ts

@@ -1,4 +1,4 @@
-import type { ExecutionType } from './ExecutionTypes';
+import type { BlockType } from '../commands/BLOCK/BlockTypes';
 import type { string_markdown_text } from './typeAliases';
 import type { string_name } from './typeAliases';
 /**
@@ -31,7 +31,7 @@ export type TaskProgress = {
      * The type of the execution.
      * Note: The pipeline executor reports everything, in the app level you can filter out the execution types that you don't want to show to the user.
      */
-    readonly executionType: ExecutionType;
+    readonly blockType: BlockType;
     /**
      * The parameter name that is being processed.
      */

package/esm/typings/src/types/execution-report/ExecutionReportJson.d.ts

@@ -2,7 +2,7 @@ import type { PromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../Prompt';
 import type { string_markdown_text } from '../typeAliases';
 import type { string_pipeline_url } from '../typeAliases';
-import type { string_version } from '../typeAliases';
+import type { string_semantic_version } from '../typeAliases';
 /**
  * ExecutionReport is result of executing one promptbook
  * It is kind of a variant of the promptbook usefull for debugging, logging and transparency for users.
@@ -25,11 +25,11 @@ export type ExecutionReportJson = {
     /**
      * Version from promptbook which was executed
      */
-    readonly promptbookUsedVersion: string_version;
+    readonly promptbookUsedVersion: string_semantic_version;
     /**
      * Version from promptbook which was requested by promptbook
      */
-    readonly promptbookRequestedVersion?: string_version;
+    readonly promptbookRequestedVersion?: string_semantic_version;
     /**
      * Description of the promptbook which was executed
      */

package/esm/typings/src/types/typeAliases.d.ts

@@ -101,11 +101,24 @@ export type string_xml = string;
  * For example `"**Hello** World!"`
  */
 export type string_markdown = string;
+/**
+ * Semantic helper
+ *
+ * Markdown text with exactly ONE heading on first line NO less NO more
+ */
+export type string_markdown_section = string;
+/**
+ * Semantic helper
+ *
+ * Markdown without any headings like h1, h2
+ * BUT with formatting, lists, blockquotes, blocks, etc. is allowed
+ */
+export type string_markdown_section_content = string;
 /**
  * Semantic helper
  *
  * Markdown text without any structure like h1, h2, lists, blockquotes, blocks, etc.
- * BUT with bold, italic, etc.
+ * BUT with bold, italic, etc. is allowed
  *
  * For example `"**Hello** World!"`
  */
@@ -230,10 +243,6 @@ export type string_uri_part = string;
  * For example `"9SeSQTupmQHwuSrLi"` <- TODO: !! Update
  */
 export type string_uriid = string_uri_part;
-/**
- * Semantic helper
- */
-export type string_protocol = 'http:' | 'https:';
 /**
  * Semantic helper
  *
@@ -246,12 +255,35 @@ export type string_hostname = string;
  * For example `"localhost:9977"` or `"collboard.com"`
  */
 export type string_host = string;
+/**
+ * Semantic helper
+ */
+export type string_protocol = 'http:' | 'https:';
 /**
  * Semantic helper
  *
  * For example `"pavol@hejny.org"`
  */
 export type string_email = string;
+/**
+ * Semantic helper
+ *
+ * For example `"pavol@hejny.org, jirka@webgpt.cz"`
+ */
+export type string_emails = string;
+/**
+ * Branded type for UUIDs version 4
+ * This will not allow to pass some random string where should be only a valid UUID
+ *
+ * Use utils:
+ *   - `randomUuid` to generate
+ *   - `isValidUuid  to check validity
+ *
+ * For example `"5a0a153d-7be9-4018-9eda-e0e2e2b89bd9"`
+ */
+export type string_uuid = string & {
+    readonly _type: 'uuid';
+};
 /**
  * Branded type client id
  */
@@ -269,7 +301,7 @@ export type string_sha256 = string;
  *
  * For example `"4.2.4"`
  */
-export type string_version = string;
+export type string_semantic_version = string;
 /**
  * Semantic helper
  *
@@ -430,6 +462,18 @@ export type number_kilobytes = number_positive;
 export type number_megabytes = number_positive;
 export type number_gigabytes = number_positive;
 export type number_terabytes = number_positive;
+/**
+ * Formatting helper to put void to keep longer version of prettier
+ */
+export type ___ = never;
+/**
+ * Organizational helper to better mark the place where the type is missing
+ */
+export type TODO = any;
+/**
+ * Organizational helper to mark a place where to really use any
+ */
+export type really_any = any;
 /**
  * TODO: !! Cleanup
  * TODO: !! Change to branded types

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

@@ -0,0 +1,11 @@
+import type { Arrayable } from '../types/Arrayable';
+/**
+ * Takes an item or an array of items and returns an array of items
+ *
+ * 1) Any item except array and undefined returns array with that one item (also null)
+ * 2) Undefined returns empty array
+ * 3) Array returns itself
+ *
+ * @private Internal utility
+ */
+export declare function arrayableToArray<TItem>(input?: Arrayable<TItem>): Array<TItem>;

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

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

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

@@ -18,5 +18,6 @@ export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoj
  */
 export declare const EMOJIS: Set<string_char_emoji>;
 /**
+ * TODO: [💴] DRY - just one version of emojis.ts
  * TODO: Mirror from Collboard or some common package
  */

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

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
 /**
  * Counts number of characters in the text
  */

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

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
 /**
  * Counts number of lines in the text
  */

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

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
 /**
  * Counts number of pages in the text
  */

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

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
 /**
  * Counts number of paragraphs in the text
  */

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

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
 /**
  * Split text into sentences
  */

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

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
 /**
  * Counts number of words in the text
  */

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

@@ -1,5 +1,5 @@
-import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
-import type { ExpectationUnit } from '../../types/PipelineJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
+import type { ExpectationUnit } from '../../types/PipelineJson/Expectations';
 /**
  * Index of all counter functions
  */

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

@@ -0,0 +1,14 @@
+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
+ */

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,30 @@
+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
+     */
+    title: string_markdown_text;
+    /**
+     * Level of the section like h1, h2, h3, h4, h5, h6
+     */
+    level: 1 | 2 | 3 | 4 | 5 | 6;
+    /**
+     * Content of the section with markdown formatting, blocks, lists, etc.
+     */
+    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
+ */

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

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