@promptbook/utils 0.80.0 → 0.81.0-12

package/README.md

@@ -23,6 +23,10 @@
 
 
 
+<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).
@@ -70,20 +74,20 @@ unwrapResult('Best greeting for the user is "Hi Pavol!"'); // 'Hi Pavol!'
 
 ## Templating
 
-There is a function `replaceParameters` which is used to replace the parameters in given template optimized to LLM prompt templates.
+There is a function `templateParameters` which is used to replace the parameters in given template optimized to LLM prompt templates.
 
 ```typescript
-import { replaceParameters } from '@promptbook/utils';
+import { templateParameters } from '@promptbook/utils';
 
-replaceParameters('Hello, {name}!', { name: 'world' }); // 'Hello, world!'
+templateParameters('Hello, {name}!', { name: 'world' }); // 'Hello, world!'
 ```
 
 And also multiline templates with blockquotes
 
 ```typescript
-import { replaceParameters, spaceTrim } from '@promptbook/utils';
+import { templateParameters, spaceTrim } from '@promptbook/utils';
 
-replaceParameters(
+templateParameters(
     spaceTrim(`
         Hello, {name}!
 
@@ -348,6 +352,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
@@ -368,8 +373,10 @@ Or you can install them separately:
 -   **[@promptbook/documents](https://www.npmjs.com/package/@promptbook/documents)** - Read knowledge from documents like `.docx`, `.odt`,…
 -   **[@promptbook/legacy-documents](https://www.npmjs.com/package/@promptbook/legacy-documents)** - Read knowledge from legacy documents like `.doc`, `.rtf`,…
 -   **[@promptbook/website-crawler](https://www.npmjs.com/package/@promptbook/website-crawler)** - Crawl knowledge from the web
+-   **[@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

@@ -5,20 +5,86 @@ import { basename } from 'path';
 /**
  * The version of the Book language
  *
+ * @generated
  * @see https://github.com/webgptorg/book
  */
 var BOOK_LANGUAGE_VERSION = '1.0.0';
 /**
  * The version of the Promptbook engine
  *
+ * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.80.0-1';
+var PROMPTBOOK_ENGINE_VERSION = '0.81.0-11';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */
 
+/**
+ * Name for the Promptbook
+ *
+ * TODO: [🗽] Unite branding and make single place for it
+ *
+ * @public exported from `@promptbook/core`
+ */
+var NAME = "Promptbook";
+/**
+ * Email of the responsible person
+ *
+ * @public exported from `@promptbook/core`
+ */
+var ADMIN_EMAIL = 'me@pavolhejny.com';
+/**
+ * Name of the responsible person for the Promptbook on GitHub
+ *
+ * @public exported from `@promptbook/core`
+ */
+var ADMIN_GITHUB_NAME = 'hejny';
+// <- TODO: [🧠] Better system for generator warnings - not always "code" and "by `@promptbook/cli`"
+/**
+ * The maximum number of iterations for a loops
+ *
+ * @private within the repository - too low-level in comparison with other `MAX_...`
+ */
+var LOOP_LIMIT = 1000;
+/**
+ * Strings to represent various values in the context of parameter values
+ *
+ * @public exported from `@promptbook/utils`
+ */
+var VALUE_STRINGS = {
+    empty: '(nothing; empty string)',
+    null: '(no value; null)',
+    undefined: '(unknown value; undefined)',
+    nan: '(not a number; NaN)',
+    infinity: '(infinity; ∞)',
+    negativeInfinity: '(negative infinity; -∞)',
+    unserializable: '(unserializable value)',
+};
+/**
+ * Small number limit
+ *
+ * @public exported from `@promptbook/utils`
+ */
+var SMALL_NUMBER = 0.001;
+// <- TODO: [🧜‍♂️]
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+Object.freeze({
+    delimiter: ',',
+    quoteChar: '"',
+    newline: '\n',
+    skipEmptyLines: true,
+});
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
+ */
+
 /*! *****************************************************************************
 Copyright (c) Microsoft Corporation.
 
@@ -138,50 +204,6 @@ function __spreadArray(to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 }
 
-/**
- * Name for the Promptbook
- *
- * TODO: [🗽] Unite branding and make single place for it
- *
- * @public exported from `@promptbook/core`
- */
-var NAME = "Promptbook";
-/**
- * Email of the responsible person
- *
- * @public exported from `@promptbook/core`
- */
-var ADMIN_EMAIL = 'me@pavolhejny.com';
-/**
- * Name of the responsible person for the Promptbook on GitHub
- *
- * @public exported from `@promptbook/core`
- */
-var ADMIN_GITHUB_NAME = 'hejny';
-// <- TODO: [🧠] Better system for generator warnings - not always "code" and "by `@promptbook/cli`"
-/**
- * The maximum number of iterations for a loops
- *
- * @private within the repository - too low-level in comparison with other `MAX_...`
- */
-var LOOP_LIMIT = 1000;
-// <- TODO: [🧜‍♂️]
-/**
- * @@@
- *
- * @public exported from `@promptbook/core`
- */
-Object.freeze({
-    delimiter: ',',
-    quoteChar: '"',
-    newline: '\n',
-    skipEmptyLines: true,
-});
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
- */
-
 /**
  * Make error report URL for the given error
  *
@@ -306,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.
@@ -835,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                "); }));
     }
@@ -1703,6 +1748,34 @@ function extractParameterNames(template) {
     return parameterNames;
 }
 
+/**
+ * Format either small or big number
+ *
+ * @public exported from `@promptbook/utils`
+ */
+function numberToString(value) {
+    if (value === 0) {
+        return '0';
+    }
+    else if (Number.isNaN(value)) {
+        return VALUE_STRINGS.nan;
+    }
+    else if (value === Infinity) {
+        return VALUE_STRINGS.infinity;
+    }
+    else if (value === -Infinity) {
+        return VALUE_STRINGS.negativeInfinity;
+    }
+    for (var exponent = 0; exponent < 15; exponent++) {
+        var factor = Math.pow(10, exponent);
+        var valueRounded = Math.round(value * factor) / factor;
+        if (Math.abs(value - valueRounded) / value < SMALL_NUMBER) {
+            return valueRounded.toFixed(exponent);
+        }
+    }
+    return value.toString();
+}
+
 /**
  * Freezes the given object and all its nested objects recursively
  *
@@ -1831,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?
@@ -1965,16 +2038,66 @@ exportJson({
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */
 
+/**
+ * Function `valueToString` will convert the given value to string
+ * This is useful and used in the `templateParameters` function
+ *
+ * Note: This function is not just calling `toString` method
+ *       It's more complex and can handle this conversion specifically for LLM models
+ *       See `VALUE_STRINGS`
+ *
+ * Note: There are 2 similar functions
+ * - `valueToString` converts value to string for LLM models as human-readable string
+ * - `asSerializable` converts value to string to preserve full information to be able to convert it back
+ *
+ * @public exported from `@promptbook/utils`
+ */
+function valueToString(value) {
+    try {
+        if (value === '') {
+            return VALUE_STRINGS.empty;
+        }
+        else if (value === null) {
+            return VALUE_STRINGS.null;
+        }
+        else if (value === undefined) {
+            return VALUE_STRINGS.undefined;
+        }
+        else if (typeof value === 'string') {
+            return value;
+        }
+        else if (typeof value === 'number') {
+            return numberToString(value);
+        }
+        else if (value instanceof Date) {
+            return value.toISOString();
+        }
+        else {
+            return JSON.stringify(value);
+        }
+    }
+    catch (error) {
+        if (!(error instanceof Error)) {
+            throw error;
+        }
+        console.error(error);
+        return VALUE_STRINGS.unserializable;
+    }
+}
+
 /**
  * Replaces parameters in template with values from parameters object
  *
+ * Note: This function is not places strings into string,
+ *       It's more complex and can handle this operation specifically for LLM models
+ *
  * @param template the template with parameters in {curly} braces
  * @param parameters the object with parameters
  * @returns the template with replaced parameters
  * @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
  * @public exported from `@promptbook/utils`
  */
-function replaceParameters(template, parameters) {
+function templateParameters(template, parameters) {
     var e_1, _a;
     try {
         for (var _b = __values(Object.entries(parameters)), _c = _b.next(); !_c.done; _c = _b.next()) {
@@ -2000,7 +2123,7 @@ function replaceParameters(template, parameters) {
     var loopLimit = LOOP_LIMIT;
     var _loop_1 = function () {
         if (loopLimit-- < 0) {
-            throw new LimitReachedError('Loop limit reached during parameters replacement in `replaceParameters`');
+            throw new LimitReachedError('Loop limit reached during parameters replacement in `templateParameters`');
         }
         var precol = match.groups.precol;
         var parameterName = match.groups.parameterName;
@@ -2017,7 +2140,7 @@ function replaceParameters(template, parameters) {
         if (parameterValue === undefined) {
             throw new PipelineExecutionError("Parameter `{".concat(parameterName, "}` is not defined"));
         }
-        parameterValue = parameterValue.toString();
+        parameterValue = valueToString(parameterValue);
         if (parameterValue.includes('\n') && /^\s*\W{0,3}\s*$/.test(precol)) {
             parameterValue = parameterValue
                 .split('\n')
@@ -2156,7 +2279,7 @@ function removeQuotes(text) {
  */
 function clonePipeline(pipeline) {
     // Note: Not using spread operator (...) because @@@
-    var pipelineUrl = pipeline.pipelineUrl, sourceFile = pipeline.sourceFile, title = pipeline.title, bookVersion = pipeline.bookVersion, description = pipeline.description, formfactorName = pipeline.formfactorName, parameters = pipeline.parameters, tasks = pipeline.tasks, knowledgeSources = pipeline.knowledgeSources, knowledgePieces = pipeline.knowledgePieces, personas = pipeline.personas, preparations = pipeline.preparations;
+    var pipelineUrl = pipeline.pipelineUrl, sourceFile = pipeline.sourceFile, title = pipeline.title, bookVersion = pipeline.bookVersion, description = pipeline.description, formfactorName = pipeline.formfactorName, parameters = pipeline.parameters, tasks = pipeline.tasks, knowledgeSources = pipeline.knowledgeSources, knowledgePieces = pipeline.knowledgePieces, personas = pipeline.personas, preparations = pipeline.preparations, sources = pipeline.sources;
     return {
         pipelineUrl: pipelineUrl,
         sourceFile: sourceFile,
@@ -2170,6 +2293,7 @@ function clonePipeline(pipeline) {
         knowledgePieces: knowledgePieces,
         personas: personas,
         preparations: preparations,
+        sources: sources,
     };
 }
 /**
@@ -2443,6 +2567,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 isPathRoot(value) {
+    if (value === '/') {
+        return true;
+    }
+    if (/^[A-Z]:\\$/i.test(value)) {
+        return true;
+    }
+    return false;
+}
+/**
+ * TODO: [🍏] Make for MacOS paths
+ */
+
 /**
  * @@@
  *
@@ -2566,9 +2709,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;
@@ -2594,5 +2734,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, 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, orderJson, parseKeywords, parseKeywordsFromString, parseNumber, removeDiacritics, removeEmojis, removeQuotes, renderPromptbookMermaid, replaceParameters, searchKeywords, serializeError, spaceTrim, splitIntoSentences, titleToName, trimCodeBlock, trimEndOfCodeBlock, union, unwrapResult };
+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, isPathRoot, 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