@promptbook/utils 0.81.0-9 → 0.81.0

package/README.md

@@ -23,10 +23,6 @@
 
 
 
-<blockquote style="color: #ff8811">
-    <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
-</blockquote>
-
 ## 📦 Package `@promptbook/utils`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -56,7 +52,7 @@ Sometimes you need to postprocess the output of the LLM model, every postprocess
 -   `extractBlock`
 -   `extractOneBlockFromMarkdown `_<- Note: Exported from [`@promptbook/markdown-utils`](https://www.npmjs.com/package/@promptbook/markdown-utils)_
 -   `prettifyPipelineString`
--   `removeContentComments`
+-   `removeMarkdownComments`
 -   `removeEmojis`
 -   `removeMarkdownFormatting` _<- Note: Exported from [`@promptbook/markdown-utils`](https://www.npmjs.com/package/@promptbook/markdown-utils)_
 -   `removeQuotes`
@@ -247,11 +243,31 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
   </tbody>
 </table>
 
-Also we have a community of developers and users:
+We also have a community of developers and users of **Promptbook**:
 
--   [Discord](https://discord.gg/x3QWNaa89N)
--   [Landing page](https://ptbk.io)
+-   [Discord community](https://discord.gg/x3QWNaa89N)
+-   [Landing page `ptbk.io`](https://ptbk.io)
 -   [Github discussions](https://github.com/webgptorg/promptbook/discussions)
+-   [LinkedIn `Promptbook`](https://linkedin.com/company/promptbook)
+-   [Facebook `Promptbook`](https://www.facebook.com/61560776453536)
+
+And **Promptbook.studio** branded socials:
+
+-   [Instagram `@promptbook.studio`](https://www.instagram.com/promptbook.studio/)
+
+And **Promptujeme** sub-brand:
+
+_/Subbrand for Czech clients/_
+
+-   [Promptujeme.cz](https://www.promptujeme.cz/)
+-   [Facebook `Promptujeme`](https://www.facebook.com/promptujeme/)
+
+And **Promptbook.city** branded socials:
+
+_/Sub-brand for images and graphics generated via Promptbook prompting/_
+
+-   [Instagram `@promptbook.city`](https://www.instagram.com/promptbook.city/)
+-   [Facebook `Promptbook City`](https://www.facebook.com/61565718625569)
 
 
 
@@ -352,6 +368,7 @@ Or you can install them separately:
 
 -   ⭐ **[ptbk](https://www.npmjs.com/package/ptbk)** - Bundle of all packages, when you want to install everything and you don't care about the size
 -   **[promptbook](https://www.npmjs.com/package/promptbook)** - Same as `ptbk`
+-   ⭐🧙‍♂️ **[@promptbook/wizzard](https://www.npmjs.com/package/@promptbook/wizzard)** - Wizzard to just run the books in node without any struggle
 -   **[@promptbook/core](https://www.npmjs.com/package/@promptbook/core)** - Core of the library, it contains the main logic for promptbooks
 -   **[@promptbook/node](https://www.npmjs.com/package/@promptbook/node)** - Core of the library for Node.js environment
 -   **[@promptbook/browser](https://www.npmjs.com/package/@promptbook/browser)** - Core of the library for browser environment
@@ -375,7 +392,7 @@ Or you can install them separately:
 -   **[@promptbook/editable](https://www.npmjs.com/package/@promptbook/editable)** - Editable book as native javascript object with imperative object API
 -   **[@promptbook/templates](https://www.npmjs.com/package/@promptbook/templates)** - Usefull templates and examples of books which can be used as a starting point
 -   **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
--   **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
+-   ⭐ **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
 
 
 

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.81.0-8';
+var PROMPTBOOK_ENGINE_VERSION = '0.81.0-24';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -207,7 +207,7 @@ function __spreadArray(to, from, pack) {
 /**
  * Make error report URL for the given error
  *
- * @private !!!!!!
+ * @private private within the repository
  */
 function getErrorReportUrl(error) {
     var report = {
@@ -328,21 +328,44 @@ function isValidFilePath(filename) {
     if (typeof filename !== 'string') {
         return false;
     }
+    if (filename.split('\n').length > 1) {
+        return false;
+    }
+    if (filename.split(' ').length >
+        5 /* <- TODO: [🧠][🈷] Make some better non-arbitrary way how to distinct filenames from informational texts */) {
+        return false;
+    }
     var filenameSlashes = filename.split('\\').join('/');
     // Absolute Unix path: /hello.txt
     if (/^(\/)/i.test(filenameSlashes)) {
+        // console.log(filename, 'Absolute Unix path: /hello.txt');
         return true;
     }
     // Absolute Windows path: /hello.txt
     if (/^([A-Z]{1,2}:\/?)\//i.test(filenameSlashes)) {
+        // console.log(filename, 'Absolute Windows path: /hello.txt');
         return true;
     }
     // Relative path: ./hello.txt
     if (/^(\.\.?\/)+/i.test(filenameSlashes)) {
+        // console.log(filename, 'Relative path: ./hello.txt');
+        return true;
+    }
+    // Allow paths like foo/hello
+    if (/^[^/]+\/[^/]+/i.test(filenameSlashes)) {
+        // console.log(filename, 'Allow paths like foo/hello');
+        return true;
+    }
+    // Allow paths like hello.book
+    if (/^[^/]+\.[^/]+$/i.test(filenameSlashes)) {
+        // console.log(filename, 'Allow paths like hello.book');
         return true;
     }
     return false;
 }
+/**
+ * TODO: [🍏] Implement for MacOs
+ */
 
 /**
  * Tests if given string is valid URL.
@@ -733,7 +756,7 @@ function renderPromptbookMermaid(pipelineJson, options) {
         var parameter = pipelineJson.parameters.find(function (parameter) { return parameter.name === parameterName; });
         if (!parameter) {
             throw new UnexpectedError("Could not find {".concat(parameterName, "}"));
-            // <- TODO: !!!!!! This causes problems when {knowledge} and other reserved parameters are used
+            // <- TODO: !!6 This causes problems when {knowledge} and other reserved parameters are used
         }
         if (parameter.isInput) {
             return 'input';
@@ -777,9 +800,9 @@ function renderPromptbookMermaid(pipelineJson, options) {
     return promptbookMermaid;
 }
 /**
- * TODO: [🧠] !! FOREACH in mermaid graph
- * TODO: [🧠] !! Knowledge in mermaid graph
- * TODO: [🧠] !! Personas in mermaid graph
+ * TODO: [🧠] FOREACH in mermaid graph
+ * TODO: [🧠] Knowledge in mermaid graph
+ * TODO: [🧠] Personas in mermaid graph
  * TODO: Maybe use some Mermaid package instead of string templating
  * TODO: [🕌] When more than 2 functionalities, split into separate functions
  */
@@ -857,7 +880,7 @@ function extractVariablesFromScript(script) {
         if (!(error instanceof Error)) {
             throw error;
         }
-        throw new ParseError(spaceTrim$2(function (block) { return "\n                    Can not extract variables from the script\n\n                    ".concat(block(error.toString()), "}\n\n\n                    Found variables:\n\n                    ").concat(Array.from(variables)
+        throw new ParseError(spaceTrim$2(function (block) { return "\n                    Can not extract variables from the script\n                    ".concat(block(error.stack || error.message), "\n\n                    Found variables:\n                    ").concat(Array.from(variables)
             .map(function (variableName, i) { return "".concat(i + 1, ") ").concat(variableName); })
             .join('\n'), "\n\n\n                    The script:\n\n                    ```javascript\n                    ").concat(block(originalScript), "\n                    ```\n                "); }));
     }
@@ -1881,7 +1904,7 @@ function checkSerializableAsJson(options) {
                 if (!(error instanceof Error)) {
                     throw error;
                 }
-                throw new UnexpectedError(spaceTrim$1(function (block) { return "\n                            `".concat(name, "` is not serializable\n\n                            ").concat(block(error.toString()), "\n\n                            Additional message for `").concat(name, "`:\n                            ").concat(block(message || '(nothing)'), "\n                        "); }));
+                throw new UnexpectedError(spaceTrim$1(function (block) { return "\n                            `".concat(name, "` is not serializable\n\n                            ").concat(block(error.stack || error.message), "\n\n                            Additional message for `").concat(name, "`:\n                            ").concat(block(message || '(nothing)'), "\n                        "); }));
             }
             /*
             TODO: [0] Is there some more elegant way to check circular references?
@@ -1911,7 +1934,7 @@ function checkSerializableAsJson(options) {
 }
 /**
  * TODO: Can be return type more type-safe? like `asserts options.value is JsonValue`
- * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
+ * TODO: [🧠][main] !!3 In-memory cache of same values to prevent multiple checks
  * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
  */
 
@@ -1923,7 +1946,6 @@ function checkSerializableAsJson(options) {
 function deepClone(objectValue) {
     return JSON.parse(JSON.stringify(objectValue));
     /*
-    !!!!!!!!
     TODO: [🧠] Is there a better implementation?
     > const propertyNames = Object.getOwnPropertyNames(objectValue);
     > for (const propertyName of propertyNames) {
@@ -2118,6 +2140,8 @@ function templateParameters(template, parameters) {
             throw new PipelineExecutionError("Parameter `{".concat(parameterName, "}` is not defined"));
         }
         parameterValue = valueToString(parameterValue);
+        // Escape curly braces in parameter values to prevent prompt-injection
+        parameterValue = parameterValue.replace(/[{}]/g, '\\$&');
         if (parameterValue.includes('\n') && /^\s*\W{0,3}\s*$/.test(precol)) {
             parameterValue = parameterValue
                 .split('\n')
@@ -2277,7 +2301,7 @@ function clonePipeline(pipeline) {
  * TODO: [🍙] Make some standard order of json properties
  */
 
-// <- TODO: !!!!!!! Auto convert to type `import { ... } from 'type-fest';`
+// <- TODO: Auto convert to type `import { ... } from 'type-fest';`
 /**
  * Tests if the value is [🚉] serializable as JSON
  *
@@ -2307,7 +2331,7 @@ function isSerializableAsJson(value) {
     }
 }
 /**
- * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
+ * TODO: [🧠][main] !!3 In-memory cache of same values to prevent multiple checks
  * TODO: [🧠][💺] Can be done this on type-level?
  */
 
@@ -2544,6 +2568,25 @@ function isValidEmail(email) {
     return /^.+@.+\..+$/.test(email);
 }
 
+/**
+ * Determines if the given path is a root path.
+ *
+ * Note: This does not check if the file exists only if the path is valid
+ * @public exported from `@promptbook/utils`
+ */
+function isRootPath(value) {
+    if (value === '/') {
+        return true;
+    }
+    if (/^[A-Z]:\\$/i.test(value)) {
+        return true;
+    }
+    return false;
+}
+/**
+ * TODO: [🍏] Make for MacOS paths
+ */
+
 /**
  * @@@
  *
@@ -2596,7 +2639,7 @@ function isValidPromptbookVersion(version) {
     if ( /* version === '1.0.0' || */version === '2.0.0' || version === '3.0.0') {
         return false;
     }
-    // <- TODO: [main] !!! Check isValidPromptbookVersion against PROMPTBOOK_ENGINE_VERSIONS
+    // <- TODO: [main] !!3 Check isValidPromptbookVersion against PROMPTBOOK_ENGINE_VERSIONS
     return true;
 }
 
@@ -2667,9 +2710,6 @@ function isValidPipelineUrl(url) {
     if (!url.startsWith('https://')) {
         return false;
     }
-    if (!(url.endsWith('.book.md') || url.endsWith('.book') || url.endsWith('.book.md') || url.endsWith('.ptbk'))) {
-        return false;
-    }
     if (url.includes('#')) {
         // TODO: [🐠]
         return false;
@@ -2695,5 +2735,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, 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, 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, removeDiacritics, removeEmojis, removeQuotes, renderPromptbookMermaid, searchKeywords, serializeError, spaceTrim, splitIntoSentences, templateParameters, titleToName, trimCodeBlock, trimEndOfCodeBlock, union, unwrapResult, valueToString };
 //# sourceMappingURL=index.es.js.map