@promptbook/openai 0.40.1-1 → 0.41.0

package/esm/typings/_packages/utils.index.d.ts

@@ -15,6 +15,7 @@ import { extractAllListItemsFromMarkdown } from '../utils/markdown/extractAllLis
 import { extractOneBlockFromMarkdown } from '../utils/markdown/extractOneBlockFromMarkdown';
 import { removeContentComments } from '../utils/markdown/removeContentComments';
 import { removeMarkdownFormatting } from '../utils/markdown/removeMarkdownFormatting';
+import { extractBlock } from '../utils/postprocessing/extractBlock';
 import { removeEmojis } from '../utils/removeEmojis';
 import { removeQuotes } from '../utils/removeQuotes';
 import { trimCodeBlock } from '../utils/trimCodeBlock';
@@ -23,7 +24,7 @@ import { unwrapResult } from '../utils/unwrapResult';
 export { CountUtils, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, assertsExecutionSuccessful, countCharacters, countLines, countPages, countParagraphs, countSentences, countWords, executionReportJsonToString, extractAllBlocksFromMarkdown, // <- [🌻]
 extractAllListItemsFromMarkdown, // <- [🌻]
 extractOneBlockFromMarkdown, // <- [🌻]
-isValidJsonString, parseNumber, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
+extractBlock, isValidJsonString, parseNumber, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 /**
  * TODO: [🧠] Maybe create some indipendent package like `markdown-tools` from both here exported and @private utilities
  */

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

@@ -2,7 +2,7 @@ import { string_markdown } from '../../types/typeAliases';
 /**
  * Single code block inside markdown.
  */
-type CodeBlock = {
+export type CodeBlock = {
     /**
      * Language of the code block OR null if the language is not specified in opening ```
      */
@@ -15,8 +15,13 @@ type CodeBlock = {
 /**
  * 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>;
-export {};

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

@@ -1,17 +1,19 @@
 import { string_markdown } from '../.././types/typeAliases';
+import { CodeBlock } from './extractAllBlocksFromMarkdown';
 /**
  * Extracts exactly ONE code block from markdown.
  *
- * Note: This function is similar to extractAllBlocksFromMarkdown but it validates that there is exactly one code block.
  * 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): {
-    language: string | null;
-    content: string;
-};
+export declare function extractOneBlockFromMarkdown(markdown: string_markdown): CodeBlock;
 /***
  * TODO: [🌻] !!! Decide of this is internal util, external util OR validator/postprocessor
  */

package/esm/typings/utils/postprocessing/extractBlock.d.ts

@@ -0,0 +1,12 @@
+import { string_markdown } from '../../types/typeAliases';
+/**
+ * Extracts 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
+ */
+export declare function extractBlock(markdown: string_markdown): string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.40.1-1",
+    "version": "0.41.0",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -38,7 +38,7 @@
         "openai": "4.2.0"
     },
     "peerDependencies": {
-        "@promptbook/core": "0.40.1-1"
+        "@promptbook/core": "0.41.0"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/typings/_packages/utils.index.d.ts

@@ -15,6 +15,7 @@ import { extractAllListItemsFromMarkdown } from '../utils/markdown/extractAllLis
 import { extractOneBlockFromMarkdown } from '../utils/markdown/extractOneBlockFromMarkdown';
 import { removeContentComments } from '../utils/markdown/removeContentComments';
 import { removeMarkdownFormatting } from '../utils/markdown/removeMarkdownFormatting';
+import { extractBlock } from '../utils/postprocessing/extractBlock';
 import { removeEmojis } from '../utils/removeEmojis';
 import { removeQuotes } from '../utils/removeQuotes';
 import { trimCodeBlock } from '../utils/trimCodeBlock';
@@ -23,7 +24,7 @@ import { unwrapResult } from '../utils/unwrapResult';
 export { CountUtils, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, assertsExecutionSuccessful, countCharacters, countLines, countPages, countParagraphs, countSentences, countWords, executionReportJsonToString, extractAllBlocksFromMarkdown, // <- [🌻]
 extractAllListItemsFromMarkdown, // <- [🌻]
 extractOneBlockFromMarkdown, // <- [🌻]
-isValidJsonString, parseNumber, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
+extractBlock, isValidJsonString, parseNumber, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 /**
  * TODO: [🧠] Maybe create some indipendent package like `markdown-tools` from both here exported and @private utilities
  */

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

@@ -2,7 +2,7 @@ import { string_markdown } from '../../types/typeAliases';
 /**
  * Single code block inside markdown.
  */
-type CodeBlock = {
+export type CodeBlock = {
     /**
      * Language of the code block OR null if the language is not specified in opening ```
      */
@@ -15,8 +15,13 @@ type CodeBlock = {
 /**
  * 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>;
-export {};

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

@@ -1,17 +1,19 @@
 import { string_markdown } from '../.././types/typeAliases';
+import { CodeBlock } from './extractAllBlocksFromMarkdown';
 /**
  * Extracts exactly ONE code block from markdown.
  *
- * Note: This function is similar to extractAllBlocksFromMarkdown but it validates that there is exactly one code block.
  * 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): {
-    language: string | null;
-    content: string;
-};
+export declare function extractOneBlockFromMarkdown(markdown: string_markdown): CodeBlock;
 /***
  * TODO: [🌻] !!! Decide of this is internal util, external util OR validator/postprocessor
  */

package/umd/typings/utils/postprocessing/extractBlock.d.ts

@@ -0,0 +1,12 @@
+import { string_markdown } from '../../types/typeAliases';
+/**
+ * Extracts 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
+ */
+export declare function extractBlock(markdown: string_markdown): string;