@promptbook/cli 0.67.4 → 0.67.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/esm/index.es.js CHANGED
@@ -20,7 +20,7 @@ import OpenAI from 'openai';
20
20
  /**
21
21
  * The version of the Promptbook library
22
22
  */
23
- var PROMPTBOOK_VERSION = '0.67.3';
23
+ var PROMPTBOOK_VERSION = '0.67.4';
24
24
  // TODO: !!!! List here all the versions and annotate + put into script
25
25
 
26
26
  /*! *****************************************************************************
@@ -1034,7 +1034,7 @@ function forEachAsync(array, options, callbackfunction) {
1034
1034
  });
1035
1035
  }
1036
1036
 
1037
- var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.67.3",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",modelRequirements:{modelVariant:"CHAT"},content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n- Make pieces of information concise, clear, and easy to understand\n- One piece of information should be approximately 1 paragraph\n- Divide the paragraphs by markdown horizontal lines ---\n- Omit irrelevant information\n- Group redundant information\n- Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {knowledgeContent}",dependentParameterNames:["knowledgeContent"],resultingParameterName:"knowledgePieces"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-knowledge-from-markdown.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.ptbk.md",promptbookVersion:"0.67.3",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",modelRequirements:{modelVariant:"CHAT"},content:"You are experienced data researcher, detect the important keywords in the document.\n\n# Rules\n\n- Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {knowledgePieceContent}",dependentParameterNames:["knowledgePieceContent"],resultingParameterName:"keywords"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-knowledge-keywords.ptbk.md"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.ptbk.md",promptbookVersion:"0.67.3",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",modelRequirements:{modelVariant:"CHAT"},content:"You are experienced content creator, write best title for the document.\n\n# Rules\n\n- Write just title, nothing else\n- Title should be concise and clear\n- Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}",expectations:{words:{min:1,max:8}},dependentParameterNames:["knowledgePieceContent"],resultingParameterName:"title"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-knowledge-title.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.ptbk.md",promptbookVersion:"0.67.3",parameters:[{name:"availableModelNames",description:"List of available model names separated by comma (,)",isInput:true,isOutput:false},{name:"personaDescription",description:"Description of the persona",isInput:true,isOutput:false},{name:"modelRequirements",description:"Specific requirements for the model",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"make-model-requirements",title:"Make modelRequirements",modelRequirements:{modelVariant:"CHAT"},content:"You are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Sample\n\n```json\n{\n\"modelName\": \"gpt-4o\",\n\"systemMessage\": \"You are experienced AI engineer and helpfull assistant.\",\n\"temperature\": 0.7\n}\n```\n\n## Instructions\n\n- Your output format is JSON object\n- Write just the JSON object, no other text should be present\n- It contains the following keys:\n - `modelName`: The name of the model to use\n - `systemMessage`: The system message to provide context to the model\n - `temperature`: The sampling temperature to use\n\n### Key `modelName`\n\nPick from the following models:\n\n- {availableModelNames}\n\n### Key `systemMessage`\n\nThe system message is used to communicate instructions or provide context to the model at the beginning of a conversation. It is displayed in a different format compared to user messages, helping the model understand its role in the conversation. The system message typically guides the model's behavior, sets the tone, or specifies desired output from the model. By utilizing the system message effectively, users can steer the model towards generating more accurate and relevant responses.\n\nFor example:\n\n> You are an experienced AI engineer and helpful assistant.\n\n> You are a friendly and knowledgeable chatbot.\n\n### Key `temperature`\n\nThe sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.\n\nYou can pick a value between 0 and 2. For example:\n\n- `0.1`: Low temperature, extremely conservative and deterministic\n- `0.5`: Medium temperature, balanced between conservative and creative\n- `1.0`: High temperature, creative and bit random\n- `1.5`: Very high temperature, extremely creative and often chaotic and unpredictable\n- `2.0`: Maximum temperature, completely random and unpredictable, for some extreme creative use cases\n\n# The assistant\n\nTake this description of the persona:\n\n> {personaDescription}",expectFormat:"JSON",dependentParameterNames:["availableModelNames","personaDescription"],resultingParameterName:"modelRequirements"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-persona.ptbk.md"}];
1037
+ var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.67.4",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",modelRequirements:{modelVariant:"CHAT"},content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n- Make pieces of information concise, clear, and easy to understand\n- One piece of information should be approximately 1 paragraph\n- Divide the paragraphs by markdown horizontal lines ---\n- Omit irrelevant information\n- Group redundant information\n- Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {knowledgeContent}",dependentParameterNames:["knowledgeContent"],resultingParameterName:"knowledgePieces"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-knowledge-from-markdown.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.ptbk.md",promptbookVersion:"0.67.4",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",modelRequirements:{modelVariant:"CHAT"},content:"You are experienced data researcher, detect the important keywords in the document.\n\n# Rules\n\n- Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {knowledgePieceContent}",dependentParameterNames:["knowledgePieceContent"],resultingParameterName:"keywords"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-knowledge-keywords.ptbk.md"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.ptbk.md",promptbookVersion:"0.67.4",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",modelRequirements:{modelVariant:"CHAT"},content:"You are experienced content creator, write best title for the document.\n\n# Rules\n\n- Write just title, nothing else\n- Title should be concise and clear\n- Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}",expectations:{words:{min:1,max:8}},dependentParameterNames:["knowledgePieceContent"],resultingParameterName:"title"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-knowledge-title.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.ptbk.md",promptbookVersion:"0.67.4",parameters:[{name:"availableModelNames",description:"List of available model names separated by comma (,)",isInput:true,isOutput:false},{name:"personaDescription",description:"Description of the persona",isInput:true,isOutput:false},{name:"modelRequirements",description:"Specific requirements for the model",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"make-model-requirements",title:"Make modelRequirements",modelRequirements:{modelVariant:"CHAT"},content:"You are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Sample\n\n```json\n{\n\"modelName\": \"gpt-4o\",\n\"systemMessage\": \"You are experienced AI engineer and helpfull assistant.\",\n\"temperature\": 0.7\n}\n```\n\n## Instructions\n\n- Your output format is JSON object\n- Write just the JSON object, no other text should be present\n- It contains the following keys:\n - `modelName`: The name of the model to use\n - `systemMessage`: The system message to provide context to the model\n - `temperature`: The sampling temperature to use\n\n### Key `modelName`\n\nPick from the following models:\n\n- {availableModelNames}\n\n### Key `systemMessage`\n\nThe system message is used to communicate instructions or provide context to the model at the beginning of a conversation. It is displayed in a different format compared to user messages, helping the model understand its role in the conversation. The system message typically guides the model's behavior, sets the tone, or specifies desired output from the model. By utilizing the system message effectively, users can steer the model towards generating more accurate and relevant responses.\n\nFor example:\n\n> You are an experienced AI engineer and helpful assistant.\n\n> You are a friendly and knowledgeable chatbot.\n\n### Key `temperature`\n\nThe sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.\n\nYou can pick a value between 0 and 2. For example:\n\n- `0.1`: Low temperature, extremely conservative and deterministic\n- `0.5`: Medium temperature, balanced between conservative and creative\n- `1.0`: High temperature, creative and bit random\n- `1.5`: Very high temperature, extremely creative and often chaotic and unpredictable\n- `2.0`: Maximum temperature, completely random and unpredictable, for some extreme creative use cases\n\n# The assistant\n\nTake this description of the persona:\n\n> {personaDescription}",expectFormat:"JSON",dependentParameterNames:["availableModelNames","personaDescription"],resultingParameterName:"modelRequirements"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-persona.ptbk.md"}];
1038
1038
 
1039
1039
  /**
1040
1040
  * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
@@ -2601,6 +2601,122 @@ function joinLlmExecutionTools() {
2601
2601
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
2602
2602
  */
2603
2603
 
2604
+ /**
2605
+ * Extracts all code blocks from markdown.
2606
+ *
2607
+ * Note: There are multiple simmilar function:
2608
+ * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
2609
+ * - `extractJsonBlock` extracts exactly one valid JSON code block
2610
+ * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
2611
+ * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
2612
+ *
2613
+ * @param markdown any valid markdown
2614
+ * @returns code blocks with language and content
2615
+ * @throws {ParsingError} if block is not closed properly
2616
+ * @public exported from `@promptbook/markdown-utils`
2617
+ */
2618
+ function extractAllBlocksFromMarkdown(markdown) {
2619
+ var e_1, _a;
2620
+ var codeBlocks = [];
2621
+ var lines = markdown.split('\n');
2622
+ // Note: [0] Ensure that the last block notated by gt > will be closed
2623
+ lines.push('');
2624
+ var currentCodeBlock = null;
2625
+ try {
2626
+ for (var lines_1 = __values(lines), lines_1_1 = lines_1.next(); !lines_1_1.done; lines_1_1 = lines_1.next()) {
2627
+ var line = lines_1_1.value;
2628
+ if (line.startsWith('> ') || line === '>') {
2629
+ if (currentCodeBlock === null) {
2630
+ currentCodeBlock = { blockNotation: '>', language: null, content: '' };
2631
+ } /* not else */
2632
+ if (currentCodeBlock.blockNotation === '>') {
2633
+ if (currentCodeBlock.content !== '') {
2634
+ currentCodeBlock.content += '\n';
2635
+ }
2636
+ currentCodeBlock.content += line.slice(2);
2637
+ }
2638
+ }
2639
+ else if (currentCodeBlock !== null && currentCodeBlock.blockNotation === '>' /* <- Note: [0] */) {
2640
+ codeBlocks.push(currentCodeBlock);
2641
+ currentCodeBlock = null;
2642
+ }
2643
+ /* not else */
2644
+ if (line.startsWith('```')) {
2645
+ var language = line.slice(3).trim() || null;
2646
+ if (currentCodeBlock === null) {
2647
+ currentCodeBlock = { blockNotation: '```', language: language, content: '' };
2648
+ }
2649
+ else {
2650
+ if (language !== null) {
2651
+ throw new ParsingError("".concat(capitalize(currentCodeBlock.language || 'the'), " code block was not closed and already opening new ").concat(language, " code block"));
2652
+ }
2653
+ codeBlocks.push(currentCodeBlock);
2654
+ currentCodeBlock = null;
2655
+ }
2656
+ }
2657
+ else if (currentCodeBlock !== null && currentCodeBlock.blockNotation === '```') {
2658
+ if (currentCodeBlock.content !== '') {
2659
+ currentCodeBlock.content += '\n';
2660
+ }
2661
+ currentCodeBlock.content += line.split('\\`\\`\\`').join('```') /* <- TODO: Maybe make propper unescape */;
2662
+ }
2663
+ }
2664
+ }
2665
+ catch (e_1_1) { e_1 = { error: e_1_1 }; }
2666
+ finally {
2667
+ try {
2668
+ if (lines_1_1 && !lines_1_1.done && (_a = lines_1.return)) _a.call(lines_1);
2669
+ }
2670
+ finally { if (e_1) throw e_1.error; }
2671
+ }
2672
+ if (currentCodeBlock !== null) {
2673
+ throw new ParsingError("".concat(capitalize(currentCodeBlock.language || 'the'), " code block was not closed at the end of the markdown"));
2674
+ }
2675
+ return codeBlocks;
2676
+ }
2677
+ /**
2678
+ * TODO: Maybe name for `blockNotation` instead of '```' and '>'
2679
+ */
2680
+
2681
+ /**
2682
+ * Extracts extracts exactly one valid JSON code block
2683
+ *
2684
+ * - When given string is a valid JSON as it is, it just returns it
2685
+ * - When there is no JSON code block the function throws a `ParsingError`
2686
+ * - When there are multiple JSON code blocks the function throws a `ParsingError`
2687
+ *
2688
+ * Note: It is not important if marked as ```json BUT if it is VALID JSON
2689
+ * Note: There are multiple simmilar function:
2690
+ * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
2691
+ * - `extractJsonBlock` extracts exactly one valid JSON code block
2692
+ * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
2693
+ * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
2694
+ *
2695
+ * @public exported from `@promptbook/markdown-utils`
2696
+ * @throws {ParsingError} if there is no valid JSON block in the markdown
2697
+ */
2698
+ function extractJsonBlock(markdown) {
2699
+ if (isValidJsonString(markdown)) {
2700
+ return markdown;
2701
+ }
2702
+ var codeBlocks = extractAllBlocksFromMarkdown(markdown);
2703
+ var jsonBlocks = codeBlocks.filter(function (_a) {
2704
+ var content = _a.content;
2705
+ return isValidJsonString(content);
2706
+ });
2707
+ if (jsonBlocks.length === 0) {
2708
+ throw new Error('There is no valid JSON block in the markdown');
2709
+ }
2710
+ if (jsonBlocks.length > 1) {
2711
+ throw new Error('There are multiple JSON code blocks in the markdown');
2712
+ }
2713
+ return jsonBlocks[0].content;
2714
+ }
2715
+ /**
2716
+ * TODO: Add some auto-healing logic + extract YAML, JSON5, TOML, etc.
2717
+ * TODO: [🏢] Make this logic part of `JsonFormatDefinition` or `isValidJsonString`
2718
+ */
2719
+
2604
2720
  /**
2605
2721
  * Determine if the pipeline is fully prepared
2606
2722
  *
@@ -2652,6 +2768,27 @@ function arrayableToArray(input) {
2652
2768
  return [input];
2653
2769
  }
2654
2770
 
2771
+ /**
2772
+ * Just says that the variable is not used but should be kept
2773
+ * No side effects.
2774
+ *
2775
+ * Note: It can be usefull for:
2776
+ *
2777
+ * 1) Suppressing eager optimization of unused imports
2778
+ * 2) Suppressing eslint errors of unused variables in the tests
2779
+ * 3) Keeping the type of the variable for type testing
2780
+ *
2781
+ * @param value any values
2782
+ * @returns void
2783
+ * @private within the repository
2784
+ */
2785
+ function keepUnused() {
2786
+ var valuesToKeep = [];
2787
+ for (var _i = 0; _i < arguments.length; _i++) {
2788
+ valuesToKeep[_i] = arguments[_i];
2789
+ }
2790
+ }
2791
+
2655
2792
  /**
2656
2793
  * Just marks a place of place where should be something implemented
2657
2794
  * No side effects.
@@ -3092,7 +3229,11 @@ function createPipelineExecutor(options) {
3092
3229
  usedParameterNames = extractParameterNamesFromPromptTemplate(currentTemplate);
3093
3230
  dependentParameterNames = new Set(currentTemplate.dependentParameterNames);
3094
3231
  if (union(difference(usedParameterNames, dependentParameterNames), difference(dependentParameterNames, usedParameterNames)).size !== 0) {
3095
- throw new UnexpectedError(spaceTrim(function (block) { return "\n Dependent parameters are not consistent used parameters:\n\n ".concat(block(pipelineIdentification), "\n\n Dependent parameters:\n ").concat(Array.from(dependentParameterNames).join(', '), "\n\n Used parameters:\n ").concat(Array.from(usedParameterNames).join(', '), "\n\n "); }));
3232
+ throw new UnexpectedError(spaceTrim(function (block) { return "\n Dependent parameters are not consistent with used parameters:\n\n ".concat(block(pipelineIdentification), "\n\n Dependent parameters:\n ").concat(Array.from(dependentParameterNames)
3233
+ .map(function (name) { return "{".concat(name, "}"); })
3234
+ .join(', '), "\n\n Used parameters:\n ").concat(Array.from(usedParameterNames)
3235
+ .map(function (name) { return "{".concat(name, "}"); })
3236
+ .join(', '), "\n\n "); }));
3096
3237
  }
3097
3238
  _b = (_a = Object).freeze;
3098
3239
  _c = [{}];
@@ -3387,10 +3528,20 @@ function createPipelineExecutor(options) {
3387
3528
  if (currentTemplate.expectFormat) {
3388
3529
  if (currentTemplate.expectFormat === 'JSON') {
3389
3530
  if (!isValidJsonString(resultString || '')) {
3390
- throw new ExpectError(spaceTrim(function (block) { return "\n Expected valid JSON string\n\n ".concat(block(
3391
- /*<- Note: No need for `pipelineIdentification`, it will be catched and added later */ ''), "\n "); }));
3531
+ // TODO: [🏢] Do more universally via `FormatDefinition`
3532
+ try {
3533
+ resultString = extractJsonBlock(resultString || '');
3534
+ }
3535
+ catch (error) {
3536
+ keepUnused(error);
3537
+ throw new ExpectError(spaceTrim(function (block) { return "\n Expected valid JSON string\n\n ".concat(block(
3538
+ /*<- Note: No need for `pipelineIdentification`, it will be catched and added later */ ''), "\n "); }));
3539
+ }
3392
3540
  }
3393
3541
  }
3542
+ else {
3543
+ throw new UnexpectedError(spaceTrim(function (block) { return "\n Unknown expectFormat \"".concat(currentTemplate.expectFormat, "\"\n\n ").concat(block(pipelineIdentification), "\n "); }));
3544
+ }
3394
3545
  }
3395
3546
  // TODO: [💝] Unite object for expecting amount and format
3396
3547
  if (currentTemplate.expectations) {
@@ -3421,7 +3572,18 @@ function createPipelineExecutor(options) {
3421
3572
  return [7 /*endfinally*/];
3422
3573
  case 46:
3423
3574
  if (expectError !== null && attempt === maxAttempts - 1) {
3424
- throw new PipelineExecutionError(spaceTrim(function (block) { return "\n LLM execution failed ".concat(maxExecutionAttempts, "x\n\n ").concat(block(pipelineIdentification), "\n\n ---\n The Prompt:\n ").concat(block(prompt.content), "\n\n Last error ").concat((expectError === null || expectError === void 0 ? void 0 : expectError.name) || '', ":\n ").concat(block((expectError === null || expectError === void 0 ? void 0 : expectError.message) || ''), "\n\n Last result:\n ").concat(block(resultString || 'null'), "\n ---\n "); }));
3575
+ throw new PipelineExecutionError(spaceTrim(function (block) { return "\n LLM execution failed ".concat(maxExecutionAttempts, "x\n\n ").concat(block(pipelineIdentification), "\n\n ---\n The Prompt:\n ").concat(block(prompt.content
3576
+ .split('\n')
3577
+ .map(function (line) { return "> ".concat(line); })
3578
+ .join('\n')), "\n\n Last error ").concat((expectError === null || expectError === void 0 ? void 0 : expectError.name) || '', ":\n ").concat(block(((expectError === null || expectError === void 0 ? void 0 : expectError.message) || '')
3579
+ .split('\n')
3580
+ .map(function (line) { return "> ".concat(line); })
3581
+ .join('\n')), "\n\n Last result:\n ").concat(block(resultString === null
3582
+ ? 'null'
3583
+ : resultString
3584
+ .split('\n')
3585
+ .map(function (line) { return "> ".concat(line); })
3586
+ .join('\n')), "\n ---\n "); }));
3425
3587
  }
3426
3588
  return [2 /*return*/];
3427
3589
  }
@@ -5533,94 +5695,21 @@ function extractAllListItemsFromMarkdown(markdown) {
5533
5695
  return listItems;
5534
5696
  }
5535
5697
 
5536
- /**
5537
- * Extracts all code blocks from markdown.
5538
- *
5539
- * Note: There are 3 simmilar function:
5540
- * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
5541
- * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
5542
- * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
5543
- *
5544
- * @param markdown any valid markdown
5545
- * @returns code blocks with language and content
5546
- * @public exported from `@promptbook/markdown-utils`
5547
- */
5548
- function extractAllBlocksFromMarkdown(markdown) {
5549
- var e_1, _a;
5550
- var codeBlocks = [];
5551
- var lines = markdown.split('\n');
5552
- // Note: [0] Ensure that the last block notated by gt > will be closed
5553
- lines.push('');
5554
- var currentCodeBlock = null;
5555
- try {
5556
- for (var lines_1 = __values(lines), lines_1_1 = lines_1.next(); !lines_1_1.done; lines_1_1 = lines_1.next()) {
5557
- var line = lines_1_1.value;
5558
- if (line.startsWith('> ') || line === '>') {
5559
- if (currentCodeBlock === null) {
5560
- currentCodeBlock = { blockNotation: '>', language: null, content: '' };
5561
- } /* not else */
5562
- if (currentCodeBlock.blockNotation === '>') {
5563
- if (currentCodeBlock.content !== '') {
5564
- currentCodeBlock.content += '\n';
5565
- }
5566
- currentCodeBlock.content += line.slice(2);
5567
- }
5568
- }
5569
- else if (currentCodeBlock !== null && currentCodeBlock.blockNotation === '>' /* <- Note: [0] */) {
5570
- codeBlocks.push(currentCodeBlock);
5571
- currentCodeBlock = null;
5572
- }
5573
- /* not else */
5574
- if (line.startsWith('```')) {
5575
- var language = line.slice(3).trim() || null;
5576
- if (currentCodeBlock === null) {
5577
- currentCodeBlock = { blockNotation: '```', language: language, content: '' };
5578
- }
5579
- else {
5580
- if (language !== null) {
5581
- throw new ParsingError("".concat(capitalize(currentCodeBlock.language || 'the'), " code block was not closed and already opening new ").concat(language, " code block"));
5582
- }
5583
- codeBlocks.push(currentCodeBlock);
5584
- currentCodeBlock = null;
5585
- }
5586
- }
5587
- else if (currentCodeBlock !== null && currentCodeBlock.blockNotation === '```') {
5588
- if (currentCodeBlock.content !== '') {
5589
- currentCodeBlock.content += '\n';
5590
- }
5591
- currentCodeBlock.content += line.split('\\`\\`\\`').join('```') /* <- TODO: Maybe make propper unescape */;
5592
- }
5593
- }
5594
- }
5595
- catch (e_1_1) { e_1 = { error: e_1_1 }; }
5596
- finally {
5597
- try {
5598
- if (lines_1_1 && !lines_1_1.done && (_a = lines_1.return)) _a.call(lines_1);
5599
- }
5600
- finally { if (e_1) throw e_1.error; }
5601
- }
5602
- if (currentCodeBlock !== null) {
5603
- throw new ParsingError("".concat(capitalize(currentCodeBlock.language || 'the'), " code block was not closed at the end of the markdown"));
5604
- }
5605
- return codeBlocks;
5606
- }
5607
- /**
5608
- * TODO: Maybe name for `blockNotation` instead of '```' and '>'
5609
- */
5610
-
5611
5698
  /**
5612
5699
  * Extracts exactly ONE code block from markdown.
5613
5700
  *
5614
- * Note: If there are multiple or no code blocks the function throws an error
5701
+ * - When there are multiple or no code blocks the function throws a `ParsingError`
5615
5702
  *
5616
- * Note: There are 3 simmilar function:
5703
+ * Note: There are multiple simmilar function:
5617
5704
  * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
5705
+ * - `extractJsonBlock` extracts exactly one valid JSON code block
5618
5706
  * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
5619
5707
  * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
5620
5708
  *
5621
5709
  * @param markdown any valid markdown
5622
5710
  * @returns code block with language and content
5623
5711
  * @public exported from `@promptbook/markdown-utils`
5712
+ * @throws {ParsingError} if there is not exactly one code block in the markdown
5624
5713
  */
5625
5714
  function extractOneBlockFromMarkdown(markdown) {
5626
5715
  var codeBlocks = extractAllBlocksFromMarkdown(markdown);
@@ -7549,7 +7638,7 @@ function addAutoGeneratedSection(content, options) {
7549
7638
  var placeForSection = removeContentComments(content).match(/^##.*$/im);
7550
7639
  if (!placeForSection) {
7551
7640
  throw new ParsingError(
7552
- // <- [🧠] Maybe something better than `ParsingError`
7641
+ // <- [🧠] Maybe something better tha `ParsingError`
7553
7642
  "No place where to put the section <!--".concat(sectionName, "-->"));
7554
7643
  // <- [🚞]
7555
7644
  }