@promptbook/utils 0.84.0-21 → 0.84.0-9

package/README.md

@@ -1,6 +1,6 @@
 <!-- ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten -->
 
-# ✨ Promptbook
+# ❄ Promptbook
 
 
 
@@ -14,13 +14,12 @@
 
 
 
-## 🌟 New Features
+## ❄ New Features
 
--   💫 Support of [`o3-mini` model by OpenAI](https://openai.com/index/openai-o3-mini/)
--   🐋 **Support of [DeepSeek models](https://www.npmjs.com/package/@promptbook/deepseek)**
 -   💙 Working [the **Book** language v1.0.0](https://github.com/webgptorg/book)
 -   🖤 Run books from CLI - `npx ptbk run path/to/your/book`
--   📚 Support of `.docx`, `.doc` and `.pdf` documents as knowledge
+-   📚 Support of `.docx`, `.doc` and `.pdf` documents
+-   ✨ **Support of [OpenAI o1 model](https://openai.com/o1/)**
 
 
 
@@ -43,37 +42,37 @@ npm i ptbk
 npm install @promptbook/utils
 ```
 
-Utility functions used in the library, but also useful for individual use in pre and post-processing of LLM inputs and outputs.
+Utility functions used in the library but also useful for individual use in preprocessing and postprocessing LLM inputs and outputs
 
-Here is an overview of the functions that can be exported from the `@promptbook/utils` package and used in your own projects:
+Here is a overview of the functions which are exported from the `@promptbook/utils` package and can be used in your own projects:
 
-## Simple templating
-
-The `prompt` template tag function helps format prompt strings for LLM interactions. It handles string interpolation and maintains consistent formatting for multiline strings and lists and also handles a security to avoid **prompt injection**.
-
-```typescript
-import { prompt } from '@promptbook/utils';
+## Postprocessing
 
-const promptString = prompt`
-    Correct the following sentence:
+Sometimes you need to postprocess the output of the LLM model, every postprocessing function that is available through `POSTPROCESS` command in promptbook is exported from `@promptbook/utils`. You can use:
 
-    > ${unsecureUserInput}
-`;
-```
+-   `spaceTrim`
+-   `extractAllBlocksFromMarkdown`, _<- Note: Exported from [`@promptbook/markdown-utils`](https://www.npmjs.com/package/@promptbook/markdown-utils)_
+-   `extractAllListItemsFromMarkdown` _<- Note: Exported from [`@promptbook/markdown-utils`](https://www.npmjs.com/package/@promptbook/markdown-utils)_
+-   `extractBlock`
+-   `extractOneBlockFromMarkdown `_<- Note: Exported from [`@promptbook/markdown-utils`](https://www.npmjs.com/package/@promptbook/markdown-utils)_
+-   `prettifyPipelineString`
+-   `removeMarkdownComments`
+-   `removeEmojis`
+-   `removeMarkdownFormatting` _<- Note: Exported from [`@promptbook/markdown-utils`](https://www.npmjs.com/package/@promptbook/markdown-utils)_
+-   `removeQuotes`
+-   `trimCodeBlock`
+-   `trimEndOfCodeBlock`
+-   `unwrapResult`
 
-The `prompt` name could be overloaded by multiple things in your code. If you want to use the `promptTemplate` which is alias for `prompt`:
+Very often you will use `unwrapResult`, which is used to extract the result you need from output with some additional information:
 
 ```typescript
-import { promptTemplate } from '@promptbook/utils';
-
-const promptString = promptTemplate`
-    Correct the following sentence:
+import { unwrapResult } from '@promptbook/utils';
 
-    > ${unsecureUserInput}
-`;
+unwrapResult('Best greeting for the user is "Hi Pavol!"'); // 'Hi Pavol!'
 ```
 
-## Advanced templating
+## Templating
 
 There is a function `templateParameters` which is used to replace the parameters in given template optimized to LLM prompt templates.
 
@@ -153,32 +152,6 @@ console.log(normalizeTo['kebab-case']('Hello, world!')); // 'hello-world'
 -   There are more normalization functions like `capitalize`, `decapitalize`, `removeDiacritics`,...
 -   Theese can be also used as postprocessing functions in the `POSTPROCESS` command in promptbook
 
-## Postprocessing
-
-Sometimes you need to postprocess the output of the LLM model, every postprocessing function that is available through `POSTPROCESS` command in promptbook is exported from `@promptbook/utils`. You can use:
-
--   `spaceTrim`
--   `extractAllBlocksFromMarkdown`, _<- Note: Exported from [`@promptbook/markdown-utils`](https://www.npmjs.com/package/@promptbook/markdown-utils)_
--   `extractAllListItemsFromMarkdown` _<- Note: Exported from [`@promptbook/markdown-utils`](https://www.npmjs.com/package/@promptbook/markdown-utils)_
--   `extractBlock`
--   `extractOneBlockFromMarkdown `_<- Note: Exported from [`@promptbook/markdown-utils`](https://www.npmjs.com/package/@promptbook/markdown-utils)_
--   `prettifyPipelineString`
--   `removeMarkdownComments`
--   `removeEmojis`
--   `removeMarkdownFormatting` _<- Note: Exported from [`@promptbook/markdown-utils`](https://www.npmjs.com/package/@promptbook/markdown-utils)_
--   `removeQuotes`
--   `trimCodeBlock`
--   `trimEndOfCodeBlock`
--   `unwrapResult`
-
-Very often you will use `unwrapResult`, which is used to extract the result you need from output with some additional information:
-
-```typescript
-import { unwrapResult } from '@promptbook/utils';
-
-unwrapResult('Best greeting for the user is "Hi Pavol!"'); // 'Hi Pavol!'
-```
-
 ## Misc
 
 See also the documentation for all the functions in the `@promptbook/utils` package, every function is documented by jsdoc, typed by typescript and tested by jest.
@@ -411,9 +384,8 @@ Or you can install them separately:
 -   **[@promptbook/anthropic-claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)** - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK 
 -   **[@promptbook/vercel](https://www.npmjs.com/package/@promptbook/vercel)** - Adapter for Vercel functionalities
 -   **[@promptbook/google](https://www.npmjs.com/package/@promptbook/google)** - Integration with Google's Gemini API
--   **[@promptbook/deepseek](https://www.npmjs.com/package/@promptbook/deepseek)** - Integration with [DeepSeek API](https://www.deepseek.com/)
 -   **[@promptbook/azure-openai](https://www.npmjs.com/package/@promptbook/azure-openai)** - Execution tools for Azure OpenAI API
-
+-   **[@promptbook/langtail](https://www.npmjs.com/package/@promptbook/langtail)** - Execution tools for Langtail API, wrapper around Langtail SDK
 -   **[@promptbook/fake-llm](https://www.npmjs.com/package/@promptbook/fake-llm)** - Mocked execution tools for testing the library and saving the tokens
 -   **[@promptbook/remote-client](https://www.npmjs.com/package/@promptbook/remote-client)** - Remote client for remote execution of promptbooks
 -   **[@promptbook/remote-server](https://www.npmjs.com/package/@promptbook/remote-server)** - Remote server for remote execution of promptbooks
@@ -583,20 +555,6 @@ See [TODO.md](./TODO.md)
 
 
 
-## 🤝 Partners
-
-<div style="display: flex; align-items: center; gap: 20px;">
-
-  <a href="https://promptbook.studio/">
-    <img src="./other/design/promptbook-studio-logo.png" alt="Partner 3" height="100">
-  </a>
-
-  <a href="https://technologickainkubace.org/en/about-technology-incubation/about-the-project/">
-    <img src="./other/partners/CI-Technology-Incubation.png" alt="Technology Incubation" height="100">
-  </a>
-
-</div>
-
 ## 🖋️ Contributing
 
 I am open to pull requests, feedback, and suggestions. Or if you like this utility, you can [☕ buy me a coffee](https://www.buymeacoffee.com/hejny) or [donate via cryptocurrencies](https://github.com/hejny/hejny/blob/main/documents/crypto.md).

package/esm/index.es.js

@@ -15,7 +15,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.84.0-20';
+var PROMPTBOOK_ENGINE_VERSION = '0.84.0-8';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -1729,14 +1729,13 @@ function templateParameters(template, parameters) {
 /**
  * Tag function for notating a prompt as template literal
  *
- * Note: There are 3 similar functions:
+ * Note: There are 2 similar functions:
  * 1) `prompt` for notating single prompt exported from `@promptbook/utils`
- * 2) `promptTemplate` alias for `prompt`
- * 3) `book` for notating and validating entire books exported from `@promptbook/utils`
+ * 1) `book` for notating and validating entire books exported from `@promptbook/utils`
  *
- * @param strings
- * @param values
- * @returns the prompt string
+ * @param strings @@@
+ * @param values @@@
+ * @returns the pipeline string
  * @public exported from `@promptbook/utils`
  */
 function prompt(strings) {
@@ -1747,14 +1746,10 @@ function prompt(strings) {
     if (values.length === 0) {
         return spaceTrim$1(strings.join(''));
     }
-    var stringsWithHiddenParameters = strings.map(function (stringsItem) {
-        // TODO: [0] DRY
-        return stringsItem.split('{').join("".concat(REPLACING_NONCE, "beginbracket")).split('}').join("".concat(REPLACING_NONCE, "endbracket"));
-    });
     var placeholderParameterNames = values.map(function (value, i) { return "".concat(REPLACING_NONCE).concat(i); });
     var parameters = Object.fromEntries(values.map(function (value, i) { return [placeholderParameterNames[i], value]; }));
     // Combine strings and values
-    var pipelineString = stringsWithHiddenParameters.reduce(function (result, stringsItem, i) {
+    var pipelineString = strings.reduce(function (result, stringsItem, i) {
         return placeholderParameterNames[i] === undefined
             ? "".concat(result).concat(stringsItem)
             : "".concat(result).concat(stringsItem, "{").concat(placeholderParameterNames[i], "}");
@@ -1770,26 +1765,8 @@ function prompt(strings) {
         console.error({ pipelineString: pipelineString, parameters: parameters, placeholderParameterNames: placeholderParameterNames, error: error });
         throw new UnexpectedError(spaceTrim$1(function (block) { return "\n                    Internal error in prompt template literal\n                  \n                    ".concat(block(JSON.stringify({ strings: strings, values: values }, null, 4)), "}\n                  \n                "); }));
     }
-    // TODO: [0] DRY
-    pipelineString = pipelineString
-        .split("".concat(REPLACING_NONCE, "beginbracket"))
-        .join('{')
-        .split("".concat(REPLACING_NONCE, "endbracket"))
-        .join('}');
     return pipelineString;
 }
-/**
- * Tag function for notating a prompt as template literal
- *
- * Note: There are 3 similar functions:
- * 1) `prompt` for notating single prompt exported from `@promptbook/utils`
- * 2) `promptTemplate` alias for `prompt`
- * 3) `book` for notating and validating entire books exported from `@promptbook/utils`
- *
- * @alias prompt
- * @public exported from `@promptbook/utils`
- */
-var promptTemplate = prompt;
 /**
  * TODO: [🧠][🈴] Where is the best location for this file
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -2640,9 +2617,6 @@ function isValidEmail(email) {
     if (typeof email !== 'string') {
         return false;
     }
-    if (email.split('\n').length > 1) {
-        return false;
-    }
     return /^.+@.+\..+$/.test(email);
 }
 
@@ -2813,5 +2787,5 @@ function isValidUuid(value) {
     return /^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$/i.test(value);
 }
 
-export { $deepFreeze, $getCurrentDate, $isRunningInBrowser, $isRunningInJest, $isRunningInNode, $isRunningInWebWorker, $randomSeed, BOOK_LANGUAGE_VERSION, CHARACTERS_PER_STANDARD_LINE, CountUtils, DIACRITIC_VARIANTS_LETTERS, LINES_PER_STANDARD_PAGE, PROMPTBOOK_ENGINE_VERSION, SMALL_NUMBER, VALUE_STRINGS, capitalize, checkSerializableAsJson, clonePipeline, countCharacters, countLines, countPages, countParagraphs, countSentences, countWords, decapitalize, deepClone, deserializeError, difference, exportJson, extractParameterNames, extractVariablesFromScript, forEachAsync, intersection, isHostnameOnPrivateNetwork, isRootPath, isSerializableAsJson, isUrlOnPrivateNetwork, isValidEmail, isValidFilePath, isValidJavascriptName, isValidJsonString, isValidKeyword, isValidPipelineUrl, isValidPromptbookVersion, isValidSemanticVersion, isValidUrl, isValidUuid, nameToUriPart, nameToUriParts, normalizeToKebabCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_camelCase, normalizeTo_snake_case, normalizeWhitespaces, numberToString, orderJson, parseKeywords, parseKeywordsFromString, parseNumber, prompt, promptTemplate, removeDiacritics, removeEmojis, removeQuotes, renderPromptbookMermaid, searchKeywords, serializeError, spaceTrim, splitIntoSentences, templateParameters, titleToName, trimCodeBlock, trimEndOfCodeBlock, union, unwrapResult, valueToString };
+export { $deepFreeze, $getCurrentDate, $isRunningInBrowser, $isRunningInJest, $isRunningInNode, $isRunningInWebWorker, $randomSeed, BOOK_LANGUAGE_VERSION, CHARACTERS_PER_STANDARD_LINE, CountUtils, DIACRITIC_VARIANTS_LETTERS, LINES_PER_STANDARD_PAGE, PROMPTBOOK_ENGINE_VERSION, SMALL_NUMBER, VALUE_STRINGS, capitalize, checkSerializableAsJson, clonePipeline, countCharacters, countLines, countPages, countParagraphs, countSentences, countWords, decapitalize, deepClone, deserializeError, difference, exportJson, extractParameterNames, extractVariablesFromScript, forEachAsync, intersection, isHostnameOnPrivateNetwork, isRootPath, isSerializableAsJson, isUrlOnPrivateNetwork, isValidEmail, isValidFilePath, isValidJavascriptName, isValidJsonString, isValidKeyword, isValidPipelineUrl, isValidPromptbookVersion, isValidSemanticVersion, isValidUrl, isValidUuid, nameToUriPart, nameToUriParts, normalizeToKebabCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_camelCase, normalizeTo_snake_case, normalizeWhitespaces, numberToString, orderJson, parseKeywords, parseKeywordsFromString, parseNumber, prompt, removeDiacritics, removeEmojis, removeQuotes, renderPromptbookMermaid, searchKeywords, serializeError, spaceTrim, splitIntoSentences, templateParameters, titleToName, trimCodeBlock, trimEndOfCodeBlock, union, unwrapResult, valueToString };
 //# sourceMappingURL=index.es.js.map