@promptbook/utils 0.75.0-4 → 0.75.1

package/README.md

@@ -2,8 +2,6 @@
 
 # ![Promptbook logo - cube with letters P and B](./other/design/logo-h1.png) Promptbook
 
-It's time for a paradigm shift! The future of software is in plain English, French or Latin.
-
 
 
 
@@ -25,10 +23,6 @@ It's time for a paradigm shift! The future of software is in plain English, Fren
 
 
 
-<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).
@@ -177,7 +171,7 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
 
 ## 🤍 The Book Abstract
 
-> It's time for a paradigm shift! **The future of software is in plain English**, French or Latin.
+**It's time for a paradigm shift! The future of software is in plain English, French or Latin.**
 
 During the computer revolution, we have seen [multiple generations of computer languages](https://github.com/webgptorg/promptbook/discussions/180), from the physical rewiring of the vacuum tubes through low-level machine code to the high-level languages like Python or JavaScript. And now, we're on the edge of the **next revolution**!
 
@@ -187,11 +181,17 @@ The incredible growth in power of microprocessors and the Moore's Law have been
 
 This shift is going to happen, whether we are ready for it or not. Our mission is to make it excellently, not just good.
 
-> **Join us in this journey!**
+**Join us in this journey!**
+
 
 
+## 🚀 Get started
 
+Take a look at the simple starter kit with books integrated into the **Hello World** sample applications:
 
+-   [Hello Book](https://github.com/webgptorg/hello-world)
+-   [Hello Book in Node.js](https://github.com/webgptorg/hello-world-node-js)
+-   [Hello Book in Next.js](https://github.com/webgptorg/hello-world-next-js)
 
 
 
@@ -211,7 +211,7 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
   <tbody>
     <tr>
       <td>Core</td>
-      <td>Promptbook core is a description and documentation of basic innerworkings how should be Promptbook implemented and defines which fetures must be descriable by book language</td>
+      <td>Promptbook Core is a description and documentation of the basic concepts, ideas and inner workings of how Promptbook should be implemented, and defines what features must be describable by book language.</td>
       <td rowspan=2>https://ptbk.io<br/>https://github.com/webgptorg/book</td>
     </tr>
     <tr>
@@ -222,17 +222,23 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
     </tr>
     <tr>
       <td>Promptbook typescript project</td>
-      <td>Implementation of Promptbook in TypeScript published into multiple packages to NPM</td>
+      <td>Promptbook implementation in TypeScript released as multiple NPM packages</td>
       <td>https://github.com/webgptorg/promptbook + Multiple packages on NPM</td>
     </tr>
     <tr>
       <td>Promptbook studio</td>
-      <td>No-code studio to write book without need to write even the markdown</td>
-      <td rowspan=2>https://promptbook.studio<br/>https://github.com/hejny/promptbook-studio</td>
-    </tr>
-    <tr>
-      <td>Promptbook miniapps</td>
-      <td>Builder of LLM miniapps from book notation</td>
+      <td>Studio to write Books and instantly publish them as miniapps</td>
+      <td>
+        https://promptbook.studio<br/>
+        https://github.com/hejny/promptbook-studio</td>
+      </tr><tr>
+      <td>Hello World</td>
+      <td>Simple starter kit with Books integrated into the sample applications</td>
+       <td>
+          https://github.com/webgptorg/hello-world<br/>
+          https://github.com/webgptorg/hello-world-node-js<br/>
+          https://github.com/webgptorg/hello-world-next-js
+       </td>
     </tr>
   </tbody>
 </table>

package/esm/index.es.js

@@ -1,4 +1,4 @@
-import spaceTrim$1, { spaceTrim } from 'spacetrim';
+import spaceTrim$2, { spaceTrim as spaceTrim$1 } from 'spacetrim';
 import { basename } from 'path';
 
 // ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten
@@ -13,7 +13,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  *
  * @see https://github.com/webgptorg/promptbook
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.75.0-3';
+var PROMPTBOOK_ENGINE_VERSION = '0.75.0';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -146,7 +146,7 @@ function __spreadArray(to, from, pack) {
 var UnexpectedError = /** @class */ (function (_super) {
     __extends(UnexpectedError, _super);
     function UnexpectedError(message) {
-        var _this = _super.call(this, spaceTrim(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This error should not happen.\n                    It's probbably a bug in the pipeline collection\n\n                    Please report issue:\n                    https://github.com/webgptorg/promptbook/issues\n\n                    Or contact us on me@pavolhejny.com\n\n                "); })) || this;
+        var _this = _super.call(this, spaceTrim$1(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This error should not happen.\n                    It's probbably a bug in the pipeline collection\n\n                    Please report issue:\n                    https://github.com/webgptorg/promptbook/issues\n\n                    Or contact us on me@pavolhejny.com\n\n                "); })) || this;
         _this.name = 'UnexpectedError';
         Object.setPrototypeOf(_this, UnexpectedError.prototype);
         return _this;
@@ -659,7 +659,7 @@ function renderPromptbookMermaid(pipelineJson, options) {
         }
         return normalizeTo_camelCase('task-' + titleToName(task.title));
     };
-    var promptbookMermaid = spaceTrim(function (block) { return "\n\n            %% \uD83D\uDD2E Tip: Open this on GitHub or in the VSCode website to see the Mermaid graph visually\n\n            flowchart LR\n              subgraph \"".concat(pipelineJson.title, "\"\n\n                  direction TB\n\n                  input((Input)):::input\n                  ").concat(block(pipelineJson.tasks
+    var promptbookMermaid = spaceTrim$1(function (block) { return "\n\n            %% \uD83D\uDD2E Tip: Open this on GitHub or in the VSCode website to see the Mermaid graph visually\n\n            flowchart LR\n              subgraph \"".concat(pipelineJson.title, "\"\n\n                  direction TB\n\n                  input((Input)):::input\n                  ").concat(block(pipelineJson.tasks
         .flatMap(function (_a) {
         var title = _a.title, dependentParameterNames = _a.dependentParameterNames, resultingParameterName = _a.resultingParameterName;
         return __spreadArray([
@@ -787,7 +787,7 @@ function extractVariables(script) {
         if (!(error instanceof Error)) {
             throw error;
         }
-        throw new ParseError(spaceTrim(function (block) { return "\n                    Can not extract variables from the script\n\n                    ".concat(block(error.toString()), "}\n                "); }));
+        throw new ParseError(spaceTrim$1(function (block) { return "\n                    Can not extract variables from the script\n\n                    ".concat(block(error.toString()), "}\n                "); }));
     }
     return variables;
 }
@@ -1042,7 +1042,7 @@ var NotFoundError = /** @class */ (function (_super) {
 var NotYetImplementedError = /** @class */ (function (_super) {
     __extends(NotYetImplementedError, _super);
     function NotYetImplementedError(message) {
-        var _this = _super.call(this, spaceTrim(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This feature is not implemented yet but it will be soon.\n\n                    If you want speed up the implementation or just read more, look here:\n                    https://github.com/webgptorg/promptbook\n\n                    Or contact us on me@pavolhejny.com\n\n                "); })) || this;
+        var _this = _super.call(this, spaceTrim$1(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This feature is not implemented yet but it will be soon.\n\n                    If you want speed up the implementation or just read more, look here:\n                    https://github.com/webgptorg/promptbook\n\n                    Or contact us on me@pavolhejny.com\n\n                "); })) || this;
         _this.name = 'NotYetImplementedError';
         Object.setPrototypeOf(_this, NotYetImplementedError.prototype);
         return _this;
@@ -1126,7 +1126,7 @@ function deserializeError(error) {
 function serializeError(error) {
     var name = error.name, message = error.message, stack = error.stack;
     if (!__spreadArray(['Error'], __read(Object.keys(ERRORS)), false).includes(name)) {
-        throw new UnexpectedError(spaceTrim$1(function (block) { return "\n          \n                    Cannot serialize error with name \"".concat(name, "\"\n\n                    ").concat(block(stack || message), "\n                \n                "); }));
+        throw new UnexpectedError(spaceTrim$2(function (block) { return "\n          \n                    Cannot serialize error with name \"".concat(name, "\"\n\n                    ").concat(block(stack || message), "\n                \n                "); }));
     }
     return {
         name: name,
@@ -1632,6 +1632,17 @@ function searchKeywords(haystack, needle) {
     return true;
 }
 
+/**
+ * Trims string from all 4 sides
+ *
+ * Note: This is a re-exported function from the `spacetrim` package which is
+ *       Developed by same author @hejny as this package
+ *
+ * @public exported from `@promptbook/utils`
+ * @see https://github.com/hejny/spacetrim#usage
+ */
+var spaceTrim = spaceTrim$1;
+
 /**
  * @@@
  *
@@ -1716,7 +1727,7 @@ function checkSerializableAsJson(name, value) {
     }
     else if (typeof value === 'object') {
         if (value instanceof Date) {
-            throw new UnexpectedError(spaceTrim$1("\n                    ".concat(name, " is Date\n\n                    Use `string_date_iso8601` instead\n                ")));
+            throw new UnexpectedError(spaceTrim$2("\n                    ".concat(name, " is Date\n\n                    Use `string_date_iso8601` instead\n                ")));
         }
         else if (value instanceof Map) {
             throw new UnexpectedError("".concat(name, " is Map"));
@@ -1728,7 +1739,7 @@ function checkSerializableAsJson(name, value) {
             throw new UnexpectedError("".concat(name, " is RegExp"));
         }
         else if (value instanceof Error) {
-            throw new UnexpectedError(spaceTrim$1("\n                    ".concat(name, " is unserialized Error\n\n                    Use function `serializeError`\n                ")));
+            throw new UnexpectedError(spaceTrim$2("\n                    ".concat(name, " is unserialized Error\n\n                    Use function `serializeError`\n                ")));
         }
         else {
             try {
@@ -1755,7 +1766,7 @@ function checkSerializableAsJson(name, value) {
                 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                        "); }));
+                throw new UnexpectedError(spaceTrim$2(function (block) { return "\n                            ".concat(name, " is not serializable\n\n                            ").concat(block(error.toString()), "\n                        "); }));
             }
             /*
             TODO: [0] Is there some more elegant way to check circular references?
@@ -2259,13 +2270,13 @@ function union() {
  * @public exported from `@promptbook/utils`
  */
 function trimCodeBlock(value) {
-    value = spaceTrim(value);
+    value = spaceTrim$1(value);
     if (!/^```[a-z]*(.*)```$/is.test(value)) {
         return value;
     }
     value = value.replace(/^```[a-z]*/i, '');
     value = value.replace(/```$/i, '');
-    value = spaceTrim(value);
+    value = spaceTrim$1(value);
     return value;
 }
 
@@ -2278,9 +2289,9 @@ function trimCodeBlock(value) {
  * @public exported from `@promptbook/utils`
  */
 function trimEndOfCodeBlock(value) {
-    value = spaceTrim(value);
+    value = spaceTrim$1(value);
     value = value.replace(/```$/g, '');
-    value = spaceTrim(value);
+    value = spaceTrim$1(value);
     return value;
 }
 
@@ -2302,7 +2313,7 @@ function unwrapResult(text, options) {
     var trimmedText = text;
     // Remove leading and trailing spaces and newlines
     if (isTrimmed) {
-        trimmedText = spaceTrim(trimmedText);
+        trimmedText = spaceTrim$1(trimmedText);
     }
     var processedText = trimmedText;
     if (isIntroduceSentenceRemoved) {
@@ -2311,7 +2322,7 @@ function unwrapResult(text, options) {
             // Remove the introduce sentence and quotes by replacing it with an empty string
             processedText = processedText.replace(introduceSentenceRegex, '');
         }
-        processedText = spaceTrim(processedText);
+        processedText = spaceTrim$1(processedText);
     }
     if (processedText.length < 3) {
         return trimmedText;
@@ -2519,5 +2530,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 { $currentDate, $deepFreeze, $isRunningInBrowser, $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, extractParameterNames, extractParameterNamesFromTask, extractVariables, 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, parseKeywords, parseKeywordsFromString, parseNumber, removeDiacritics, removeEmojis, removeQuotes, renameParameter, renderPromptbookMermaid, replaceParameters, searchKeywords, serializeError, splitIntoSentences, titleToName, trimCodeBlock, trimEndOfCodeBlock, union, unwrapResult };
+export { $currentDate, $deepFreeze, $isRunningInBrowser, $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, extractParameterNames, extractParameterNamesFromTask, extractVariables, 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, parseKeywords, parseKeywordsFromString, parseNumber, removeDiacritics, removeEmojis, removeQuotes, renameParameter, renderPromptbookMermaid, replaceParameters, searchKeywords, serializeError, spaceTrim, splitIntoSentences, titleToName, trimCodeBlock, trimEndOfCodeBlock, union, unwrapResult };
 //# sourceMappingURL=index.es.js.map