@promptbook/core 0.84.0-0 → 0.84.0-11

package/umd/index.umd.js

@@ -27,7 +27,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.83.0';
+    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
@@ -180,22 +180,94 @@
      */
 
     /**
-     * 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;
         }
     }
@@ -219,6 +291,27 @@
      * 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.
@@ -232,6 +325,15 @@
         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;
     }
@@ -528,7 +630,7 @@
      *
      * @public exported from `@promptbook/core`
      */
-    var ADMIN_EMAIL = 'me@pavolhejny.com';
+    var ADMIN_EMAIL = 'pavol@ptbk.io';
     /**
      * Name of the responsible person for the Promptbook on GitHub
      *
@@ -1039,7 +1141,7 @@
      *
      * @private within the repository
      */
-    var REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
+    var REPLACING_NONCE = 'ptbkauk42kV2dzao34faw7FudQUHYPtW';
     /**
      * @@@
      *
@@ -1185,35 +1287,6 @@
         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.
      *
@@ -2086,7 +2159,7 @@
     var NotYetImplementedError = /** @class */ (function (_super) {
         __extends(NotYetImplementedError, _super);
         function NotYetImplementedError(message) {
-            var _this = _super.call(this, spaceTrim.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.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 pavol@ptbk.io\n\n                "); })) || this;
             _this.name = 'NotYetImplementedError';
             Object.setPrototypeOf(_this, NotYetImplementedError.prototype);
             return _this;
@@ -2172,12 +2245,28 @@
     /**
      * 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;
         }
@@ -5717,55 +5806,6 @@
      * 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
      *
@@ -11074,9 +11114,71 @@
      * TODO: [🧠][🈴] Where is the best location for this file
      */
 
+    /**
+     * 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`
+     *
+     * @param strings
+     * @param values
+     * @returns the prompt string
+     * @public exported from `@promptbook/utils`
+     */
+    function prompt(strings) {
+        var values = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            values[_i - 1] = arguments[_i];
+        }
+        if (values.length === 0) {
+            return spaceTrim__default["default"](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) {
+            return placeholderParameterNames[i] === undefined
+                ? "".concat(result).concat(stringsItem)
+                : "".concat(result).concat(stringsItem, "{").concat(placeholderParameterNames[i], "}");
+        }, '');
+        pipelineString = spaceTrim__default["default"](pipelineString);
+        try {
+            pipelineString = templateParameters(pipelineString, parameters);
+        }
+        catch (error) {
+            if (!(error instanceof PipelineExecutionError)) {
+                throw error;
+            }
+            console.error({ pipelineString: pipelineString, parameters: parameters, placeholderParameterNames: placeholderParameterNames, error: error });
+            throw new UnexpectedError(spaceTrim__default["default"](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;
+    }
+    /**
+     * TODO: [🧠][🈴] Where is the best location for this file
+     * Note: [💞] Ignore a discrepancy between file name and entity name
+     */
+
     /**
      * Tag function for notating a pipeline with a book\`...\ notation 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`
+     *
      * @param strings @@@
      * @param values @@@
      * @returns the pipeline string
@@ -11087,11 +11189,7 @@
         for (var _i = 1; _i < arguments.length; _i++) {
             values[_i - 1] = arguments[_i];
         }
-        if (strings.length !== 1 && values.length !== 0) {
-            throw new NotYetImplementedError("Only one string without interpolated value is supported for now in book`...` notation");
-        }
-        var pipelineString = strings[0];
-        pipelineString = spaceTrim__default["default"](pipelineString);
+        var pipelineString = prompt.apply(void 0, __spreadArray([strings], __read(values), false));
         if (!isValidPipelineString(pipelineString)) {
             // TODO: Make the CustomError for this
             throw new Error(spaceTrim__default["default"]("\n                The string is not a valid pipeline string\n\n                book`\n                    ".concat(pipelineString, "\n                `\n            ")));
@@ -11103,6 +11201,40 @@
      * Note: [💞] Ignore a discrepancy between file name and entity name
      */
 
+    /**
+     * Metadata of the scraper
+     *
+     * @private within the scraper directory
+     */
+    var boilerplateScraperMetadata = $deepFreeze({
+        title: 'Boilerplate scraper',
+        packageName: '@promptbook/boilerplate',
+        className: 'BoilerplateScraper',
+        mimeTypes: [
+            '@@@/@@@',
+            // <- TODO: @@@ Add compatible mime types with Boilerplate scraper
+        ],
+        documentationUrl: 'https://github.com/webgptorg/promptbook/discussions/@@@',
+        isAvilableInBrowser: false,
+        // <- Note: [🌏] Only `MarkdownScraper` makes sense to be available in the browser, for scraping non-markdown sources in the browser use a remote server
+        requiredExecutables: [
+        /* @@@ 'Pandoc' */
+        ],
+    }); /* <- Note: [🤛] */
+    /**
+     * Registration of known scraper metadata
+     *
+     * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
+     *
+     * @public exported from `@promptbook/core`
+     * @public exported from `@promptbook/wizzard`
+     * @public exported from `@promptbook/cli`
+     */
+    var _BoilerplateScraperMetadataRegistration = $scrapersMetadataRegister.register(boilerplateScraperMetadata);
+    /**
+     * Note: [💞] Ignore a discrepancy between file name and entity name
+     */
+
     /**
      * Metadata of the scraper
      *
@@ -11194,6 +11326,40 @@
      * Note: [💞] Ignore a discrepancy between file name and entity name
      */
 
+    /**
+     * Metadata of the scraper
+     *
+     * @private within the scraper directory
+     */
+    var markitdownScraperMetadata = $deepFreeze({
+        title: 'Markitdown scraper',
+        packageName: '@promptbook/markitdown',
+        className: 'MarkitdownScraper',
+        mimeTypes: [
+            'application/pdf',
+            // TODO: Make priority for scrapers and than allow all mime types here:
+            // 'text/html',
+            // 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+        ],
+        documentationUrl: 'https://github.com/webgptorg/promptbook/discussions/@@',
+        isAvilableInBrowser: false,
+        // <- Note: [🌏] Only `MarkdownScraper` makes sense to be available in the browser, for scraping non-markdown sources in the browser use a remote server
+        requiredExecutables: [],
+    }); /* <- Note: [🤛] */
+    /**
+     * Registration of known scraper metadata
+     *
+     * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
+     *
+     * @public exported from `@promptbook/core`
+     * @public exported from `@promptbook/wizzard`
+     * @public exported from `@promptbook/cli`
+     */
+    var _MarkitdownScraperMetadataRegistration = $scrapersMetadataRegister.register(markitdownScraperMetadata);
+    /**
+     * Note: [💞] Ignore a discrepancy between file name and entity name
+     */
+
     /**
      * Metadata of the scraper
      *
@@ -11203,7 +11369,7 @@
         title: 'Pdf scraper',
         packageName: '@promptbook/pdf',
         className: 'PdfScraper',
-        mimeTypes: ['application/pdf'],
+        mimeTypes: ['application/pdf-DISABLED'],
         documentationUrl: 'https://github.com/webgptorg/promptbook/discussions/@@',
         isAvilableInBrowser: false,
         // <- Note: [🌏] Only `MarkdownScraper` makes sense to be available in the browser, for scraping non-markdown sources in the browser use a remote server
@@ -11410,10 +11576,12 @@
     exports.ZERO_USAGE = ZERO_USAGE;
     exports._AnthropicClaudeMetadataRegistration = _AnthropicClaudeMetadataRegistration;
     exports._AzureOpenAiMetadataRegistration = _AzureOpenAiMetadataRegistration;
+    exports._BoilerplateScraperMetadataRegistration = _BoilerplateScraperMetadataRegistration;
     exports._DocumentScraperMetadataRegistration = _DocumentScraperMetadataRegistration;
     exports._GoogleMetadataRegistration = _GoogleMetadataRegistration;
     exports._LegacyDocumentScraperMetadataRegistration = _LegacyDocumentScraperMetadataRegistration;
     exports._MarkdownScraperMetadataRegistration = _MarkdownScraperMetadataRegistration;
+    exports._MarkitdownScraperMetadataRegistration = _MarkitdownScraperMetadataRegistration;
     exports._OpenAiAssistantMetadataRegistration = _OpenAiAssistantMetadataRegistration;
     exports._OpenAiMetadataRegistration = _OpenAiMetadataRegistration;
     exports._PdfScraperMetadataRegistration = _PdfScraperMetadataRegistration;