@promptbook/core 0.84.0-10 → 0.84.0-11

package/esm/index.es.js

@@ -25,7 +25,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.84.0-9';
+var PROMPTBOOK_ENGINE_VERSION = '0.84.0-10';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -178,22 +178,94 @@ function collectionToJson(collection) {
  */
 
 /**
- * Function isValidJsonString will tell you if the string is valid JSON or not
+ * Checks if value is valid email
  *
  * @public exported from `@promptbook/utils`
  */
-function isValidJsonString(value /* <- [👨‍⚖️] */) {
-    try {
-        JSON.parse(value);
+function isValidEmail(email) {
+    if (typeof email !== 'string') {
+        return false;
+    }
+    if (email.split('\n').length > 1) {
+        return false;
+    }
+    return /^.+@.+\..+$/.test(email);
+}
+
+/**
+ * Tests if given string is valid URL.
+ *
+ * Note: This does not check if the file exists only if the path is valid
+ * @public exported from `@promptbook/utils`
+ */
+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;
     }
-    catch (error) {
-        if (!(error instanceof Error)) {
-            throw error;
+    // 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.
+ *
+ * Note: Dataurl are considered perfectly valid.
+ * Note: There are two simmilar functions:
+ * - `isValidUrl` which tests any URL
+ * - `isValidPipelineUrl` *(this one)* which tests just promptbook URL
+ *
+ * @public exported from `@promptbook/utils`
+ */
+function isValidUrl(url) {
+    if (typeof url !== 'string') {
+        return false;
+    }
+    try {
+        if (url.startsWith('blob:')) {
+            url = url.replace(/^blob:/, '');
         }
-        if (error.message.includes('Unexpected token')) {
+        var urlObject = new URL(url /* because fail is handled */);
+        if (!['http:', 'https:', 'data:'].includes(urlObject.protocol)) {
             return false;
         }
+        return true;
+    }
+    catch (error) {
         return false;
     }
 }
@@ -217,6 +289,27 @@ var ParseError = /** @class */ (function (_super) {
  * TODO: Maybe split `ParseError` and `ApplyError`
  */
 
+/**
+ * Function isValidJsonString will tell you if the string is valid JSON or not
+ *
+ * @public exported from `@promptbook/utils`
+ */
+function isValidJsonString(value /* <- [👨‍⚖️] */) {
+    try {
+        JSON.parse(value);
+        return true;
+    }
+    catch (error) {
+        if (!(error instanceof Error)) {
+            throw error;
+        }
+        if (error.message.includes('Unexpected token')) {
+            return false;
+        }
+        return false;
+    }
+}
+
 /**
  * Function `validatePipelineString` will validate the if the string is a valid pipeline string
  * It does not check if the string is fully logically correct, but if it is a string that can be a pipeline string or the string looks completely different.
@@ -230,6 +323,15 @@ function validatePipelineString(pipelineString) {
     if (isValidJsonString(pipelineString)) {
         throw new ParseError('Expected a book, but got a JSON string');
     }
+    else if (isValidUrl(pipelineString)) {
+        throw new ParseError("Expected a book, but got just the URL \"".concat(pipelineString, "\""));
+    }
+    else if (isValidFilePath(pipelineString)) {
+        throw new ParseError("Expected a book, but got just the file path \"".concat(pipelineString, "\""));
+    }
+    else if (isValidEmail(pipelineString)) {
+        throw new ParseError("Expected a book, but got just the email \"".concat(pipelineString, "\""));
+    }
     // <- TODO: Implement the validation + add tests when the pipeline logic considered as invalid
     return pipelineString;
 }
@@ -1183,35 +1285,6 @@ function isUrlOnPrivateNetwork(url) {
     return isHostnameOnPrivateNetwork(url.hostname);
 }
 
-/**
- * Tests if given string is valid URL.
- *
- * Note: Dataurl are considered perfectly valid.
- * Note: There are two simmilar functions:
- * - `isValidUrl` which tests any URL
- * - `isValidPipelineUrl` *(this one)* which tests just promptbook URL
- *
- * @public exported from `@promptbook/utils`
- */
-function isValidUrl(url) {
-    if (typeof url !== 'string') {
-        return false;
-    }
-    try {
-        if (url.startsWith('blob:')) {
-            url = url.replace(/^blob:/, '');
-        }
-        var urlObject = new URL(url /* because fail is handled */);
-        if (!['http:', 'https:', 'data:'].includes(urlObject.protocol)) {
-            return false;
-        }
-        return true;
-    }
-    catch (error) {
-        return false;
-    }
-}
-
 /**
  * Tests if given string is valid pipeline URL URL.
  *
@@ -2170,12 +2243,28 @@ function deserializeError(error) {
 /**
  * Asserts that the execution of a Promptbook is successful
  *
+ * Note: If there are only warnings, the execution is still successful but the warnings are logged in the console
+ *
  * @param executionResult - The partial result of the Promptbook execution
  * @throws {PipelineExecutionError} If the execution is not successful or if multiple errors occurred
  * @public exported from `@promptbook/core`
  */
 function assertsExecutionSuccessful(executionResult) {
-    var isSuccessful = executionResult.isSuccessful, errors = executionResult.errors;
+    var e_1, _a;
+    var isSuccessful = executionResult.isSuccessful, errors = executionResult.errors, warnings = executionResult.warnings;
+    try {
+        for (var warnings_1 = __values(warnings), warnings_1_1 = warnings_1.next(); !warnings_1_1.done; warnings_1_1 = warnings_1.next()) {
+            var warning = warnings_1_1.value;
+            console.warn(warning.message);
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (warnings_1_1 && !warnings_1_1.done && (_a = warnings_1.return)) _a.call(warnings_1);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
     if (isSuccessful === true) {
         return;
     }
@@ -5715,55 +5804,6 @@ function isFileExisting(filename, fs) {
  * TODO: [🖇] What about symlinks?
  */
 
-/**
- * Tests if given string is valid URL.
- *
- * Note: This does not check if the file exists only if the path is valid
- * @public exported from `@promptbook/utils`
- */
-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
- */
-
 /**
  * The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
  *
@@ -11075,13 +11115,14 @@ function isValidPipelineString(pipelineString) {
 /**
  * Tag function for notating a prompt as template literal
  *
- * Note: There are 2 similar functions:
+ * Note: There are 3 similar functions:
  * 1) `prompt` for notating single prompt exported from `@promptbook/utils`
- * 1) `book` for notating and validating entire books exported from `@promptbook/utils`
+ * 2) `promptTemplate` alias for `prompt`
+ * 3) `book` for notating and validating entire books exported from `@promptbook/utils`
  *
- * @param strings @@@
- * @param values @@@
- * @returns the pipeline string
+ * @param strings
+ * @param values
+ * @returns the prompt string
  * @public exported from `@promptbook/utils`
  */
 function prompt(strings) {
@@ -11092,10 +11133,14 @@ function prompt(strings) {
     if (values.length === 0) {
         return spaceTrim(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 = strings.reduce(function (result, stringsItem, i) {
+    var pipelineString = stringsWithHiddenParameters.reduce(function (result, stringsItem, i) {
         return placeholderParameterNames[i] === undefined
             ? "".concat(result).concat(stringsItem)
             : "".concat(result).concat(stringsItem, "{").concat(placeholderParameterNames[i], "}");
@@ -11111,6 +11156,12 @@ function prompt(strings) {
         console.error({ pipelineString: pipelineString, parameters: parameters, placeholderParameterNames: placeholderParameterNames, error: error });
         throw new UnexpectedError(spaceTrim(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;
 }
 /**
@@ -11121,9 +11172,10 @@ function prompt(strings) {
 /**
  * Tag function for notating a pipeline with a book\`...\ notation as template literal
  *
- * Note: There are 2 similar functions:
+ * Note: There are 3 similar functions:
  * 1) `prompt` for notating single prompt exported from `@promptbook/utils`
- * 1) `book` for notating and validating entire books exported from `@promptbook/utils`
+ * 2) `promptTemplate` alias for `prompt`
+ * 3) `book` for notating and validating entire books exported from `@promptbook/utils`
  *
  * @param strings @@@
  * @param values @@@