@promptbook/core 0.80.0 → 0.81.0-5

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/core`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -251,6 +255,8 @@ 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
 

package/esm/index.es.js

@@ -23,7 +23,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  *
  * @see https://github.com/webgptorg/promptbook
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.80.0-1';
+var PROMPTBOOK_ENGINE_VERSION = '0.81.0-4';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -3452,7 +3452,7 @@ function arrayableToArray(input) {
  * @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()) {
@@ -3478,7 +3478,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;
@@ -4013,7 +4013,7 @@ function executeAttempts(options) {
                                     }
                                     return [3 /*break*/, 24];
                                 case 2:
-                                    $ongoingTaskResult.$resultString = replaceParameters(preparedContent, parameters);
+                                    $ongoingTaskResult.$resultString = templateParameters(preparedContent, parameters);
                                     return [3 /*break*/, 25];
                                 case 3:
                                     modelRequirements = __assign(__assign({ modelVariant: 'CHAT' }, (preparedPipeline.defaultModelRequirements || {})), (task.modelRequirements || {}));
@@ -4136,8 +4136,8 @@ function executeAttempts(options) {
                                     _j = $ongoingTaskResult;
                                     return [4 /*yield*/, tools.userInterface.promptDialog($deepFreeze({
                                             promptTitle: task.title,
-                                            promptMessage: replaceParameters(task.description || '', parameters),
-                                            defaultValue: replaceParameters(preparedContent, parameters),
+                                            promptMessage: templateParameters(task.description || '', parameters),
+                                            defaultValue: templateParameters(preparedContent, parameters),
                                             // TODO: [🧠] !! Figure out how to define placeholder in .book.md file
                                             placeholder: undefined,
                                             priority: priority,
@@ -4261,7 +4261,7 @@ function executeAttempts(options) {
                                     if (!isJokerAttempt &&
                                         task.taskType === 'PROMPT_TASK' &&
                                         $ongoingTaskResult.$prompt
-                                    //    <- Note:  [2] When some expected parameter is not defined, error will occur in replaceParameters
+                                    //    <- Note:  [2] When some expected parameter is not defined, error will occur in templateParameters
                                     //              In that case we don’t want to make a report about it because it’s not a llm execution error
                                     ) {
                                         // TODO: [🧠] Maybe put other taskTypes into report
@@ -5594,6 +5594,30 @@ function isValidFilePath(filename) {
     return false;
 }
 
+/**
+ * The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
+ *
+ * @private as default `fetch` function used in Promptbook scrapers
+ */
+var scraperFetch = function (url, init) { return __awaiter(void 0, void 0, void 0, function () {
+    var error_1;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                _a.trys.push([0, 2, , 3]);
+                return [4 /*yield*/, fetch(url, init)];
+            case 1: return [2 /*return*/, _a.sent()];
+            case 2:
+                error_1 = _a.sent();
+                if (!(error_1 instanceof Error)) {
+                    throw error_1;
+                }
+                throw new KnowledgeScrapeError(spaceTrim(function (block) { return "\n                    Can not fetch \"".concat(url, "\"\n\n                    Fetch error:\n                    ").concat(block(error_1.message), "\n\n                "); }));
+            case 3: return [2 /*return*/];
+        }
+    });
+}); };
+
 /**
  * @@@
  *
@@ -5602,13 +5626,14 @@ function isValidFilePath(filename) {
 function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
     var _a;
     return __awaiter(this, void 0, void 0, function () {
-        var sourceContent, name, _b, _c, rootDirname, url, response_1, mimeType, filename_1, fileExtension, mimeType;
-        return __generator(this, function (_e) {
-            switch (_e.label) {
+        var _b, fetch, sourceContent, name, _c, _d, rootDirname, url, response_1, mimeType, filename_1, fileExtension, mimeType;
+        return __generator(this, function (_f) {
+            switch (_f.label) {
                 case 0:
+                    _b = tools.fetch, fetch = _b === void 0 ? scraperFetch : _b;
                     sourceContent = knowledgeSource.sourceContent;
                     name = knowledgeSource.name;
-                    _b = options || {}, _c = _b.rootDirname, rootDirname = _c === void 0 ? null : _c, _b.isVerbose;
+                    _c = options || {}, _d = _c.rootDirname, rootDirname = _d === void 0 ? null : _d, _c.isVerbose;
                     if (!name) {
                         name = sourceContentToName(sourceContent);
                     }
@@ -5616,7 +5641,7 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
                     url = sourceContent;
                     return [4 /*yield*/, fetch(url)];
                 case 1:
-                    response_1 = _e.sent();
+                    response_1 = _f.sent();
                     mimeType = ((_a = response_1.headers.get('content-type')) === null || _a === void 0 ? void 0 : _a.split(';')[0]) || 'text/html';
                     return [2 /*return*/, {
                             source: name,
@@ -5673,7 +5698,7 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
                     mimeType = extensionToMimeType(fileExtension || '');
                     return [4 /*yield*/, isFileExisting(filename_1, tools.fs)];
                 case 3:
-                    if (!(_e.sent())) {
+                    if (!(_f.sent())) {
                         throw new NotFoundError(spaceTrim(function (block) { return "\n                          Can not make source handler for file which does not exist:\n\n                          File:\n                          ".concat(block(filename_1), "\n                      "); }));
                     }
                     // TODO: [🧠][😿] Test security file - file is scoped to the project (BUT maybe do this in `filesystemTools`)
@@ -9581,176 +9606,6 @@ function prettifyPipelineString(pipelineString, options) {
  * TODO: [🕌] When more than 2 functionalities, split into separate functions
  */
 
-/**
- * Function `removePipelineCommand` will remove one command from pipeline string
- *
- * @public exported from `@promptbook/core` <- Note: [👖] This utility is so tightly interconnected with the Promptbook that it is not exported as util but in core
- */
-function removePipelineCommand(options) {
-    var e_1, _a;
-    var command = options.command, pipeline = options.pipeline;
-    var lines = pipeline.split('\n');
-    // TODO: [🧽] DRY
-    var currentType = 'MARKDOWN';
-    var newLines = [];
-    try {
-        for (var lines_1 = __values(lines), lines_1_1 = lines_1.next(); !lines_1_1.done; lines_1_1 = lines_1.next()) {
-            var line = lines_1_1.value;
-            if (currentType === 'MARKDOWN') {
-                if (line.startsWith('```')) {
-                    currentType = 'CODE_BLOCK';
-                }
-                else if (line.includes('<!--')) {
-                    currentType = 'COMMENT';
-                }
-            }
-            else if (currentType === 'CODE_BLOCK') {
-                if (line.startsWith('```')) {
-                    currentType = 'MARKDOWN';
-                }
-            }
-            else if (currentType === 'COMMENT') {
-                if (line.includes('-->')) {
-                    currentType = 'MARKDOWN';
-                }
-            }
-            if (currentType === 'MARKDOWN' && /^(-|\d\))/m.test(line) && line.toUpperCase().includes(command)) {
-                continue;
-            }
-            newLines.push(line);
-        }
-    }
-    catch (e_1_1) { e_1 = { error: e_1_1 }; }
-    finally {
-        try {
-            if (lines_1_1 && !lines_1_1.done && (_a = lines_1.return)) _a.call(lines_1);
-        }
-        finally { if (e_1) throw e_1.error; }
-    }
-    var newPipeline = spaceTrim(newLines.join('\n'));
-    return newPipeline;
-}
-
-/**
- * Function `renamePipelineParameter` will find all usable parameters for given task
- * In other words, it will find all parameters that are not used in the task itseld and all its dependencies
- *
- * @throws {PipelineLogicError} If the new parameter name is already used in the pipeline
- * @public exported from `@promptbook/core` <- Note: [👖] This utility is so tightly interconnected with the Promptbook that it is not exported as util but in core
- */
-function renamePipelineParameter(options) {
-    var e_1, _a, e_2, _b;
-    var pipeline = options.pipeline, oldParameterName = options.oldParameterName, newParameterName = options.newParameterName;
-    if (pipeline.parameters.some(function (parameter) { return parameter.name === newParameterName; })) {
-        throw new PipelineLogicError("Can not replace {".concat(oldParameterName, "} to {").concat(newParameterName, "} because {").concat(newParameterName, "} is already used in the pipeline"));
-    }
-    var renamedPipeline = __assign(__assign({}, pipeline), { 
-        // <- TODO: [🪓] This should be without `as $PipelineJson`
-        parameters: __spreadArray([], __read(pipeline.parameters), false), tasks: __spreadArray([], __read(pipeline.tasks), false) });
-    try {
-        for (var _c = __values(renamedPipeline.parameters), _d = _c.next(); !_d.done; _d = _c.next()) {
-            var parameter = _d.value;
-            if (parameter.name !== oldParameterName) {
-                continue;
-            }
-            parameter.name = newParameterName;
-        }
-    }
-    catch (e_1_1) { e_1 = { error: e_1_1 }; }
-    finally {
-        try {
-            if (_d && !_d.done && (_a = _c.return)) _a.call(_c);
-        }
-        finally { if (e_1) throw e_1.error; }
-    }
-    try {
-        for (var _e = __values(renamedPipeline.tasks), _f = _e.next(); !_f.done; _f = _e.next()) {
-            var task = _f.value;
-            if (task.resultingParameterName === oldParameterName) {
-                task.resultingParameterName = newParameterName;
-            }
-            task.dependentParameterNames = task.dependentParameterNames.map(function (dependentParameterName) {
-                return dependentParameterName === oldParameterName ? newParameterName : dependentParameterName;
-            });
-            task.content = task.content.replace(new RegExp("{".concat(oldParameterName, "}"), 'g'), "{".concat(newParameterName, "}"));
-            task.title = task.title.replace(new RegExp("{".concat(oldParameterName, "}"), 'g'), "{".concat(newParameterName, "}"));
-            task.description =
-                task.description === undefined
-                    ? undefined
-                    : task.description.replace(new RegExp("{".concat(oldParameterName, "}"), 'g'), "{".concat(newParameterName, "}"));
-        }
-    }
-    catch (e_2_1) { e_2 = { error: e_2_1 }; }
-    finally {
-        try {
-            if (_f && !_f.done && (_b = _e.return)) _b.call(_e);
-        }
-        finally { if (e_2) throw e_2.error; }
-    }
-    return renamedPipeline;
-}
-
-// <- TODO: !!!!!!! Auto convert to type `import { ... } from 'type-fest';`
-/**
- * Tests if the value is [🚉] serializable as JSON
- *
- * - Almost all primitives are serializable BUT:
- * - `undefined` is not serializable
- * - `NaN` is not serializable
- * - Objects and arrays are serializable if all their properties are serializable
- * - Functions are not serializable
- * - Circular references are not serializable
- * - `Date` objects are not serializable
- * - `Map` and `Set` objects are not serializable
- * - `RegExp` objects are not serializable
- * - `Error` objects are not serializable
- * - `Symbol` objects are not serializable
- * - And much more...
- *
- *
- * @public exported from `@promptbook/utils`
- */
-function isSerializableAsJson(value) {
-    try {
-        checkSerializableAsJson({ value: value });
-        return true;
-    }
-    catch (error) {
-        return false;
-    }
-}
-/**
- * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
- * TODO: [🧠][💺] Can be done this on type-level?
- */
-
-/**
- * Stringify the PipelineJson with proper formatting
- *
- * Note: [0] It can be used for more JSON types like whole collection of pipelines, single knowledge piece, etc.
- * Note: In contrast to JSON.stringify, this function ensures that **embedding index** is on single line
- *
- * @public exported from `@promptbook/core`
- */
-function stringifyPipelineJson(pipeline) {
-    if (!isSerializableAsJson(pipeline)) {
-        throw new UnexpectedError(spaceTrim("\n                Cannot stringify the pipeline, because it is not serializable as JSON\n\n                There can be multiple reasons:\n                1) The pipeline contains circular references\n                2) It is not a valid PipelineJson\n            "));
-    }
-    var pipelineJsonStringified = JSON.stringify(pipeline, null, 4);
-    for (var i = 0; i < LOOP_LIMIT; i++) {
-        pipelineJsonStringified = pipelineJsonStringified.replace(/(-?0\.\d+),[\n\s]+(-?0\.\d+)/gms, "$1".concat(REPLACING_NONCE, "$2"));
-    }
-    pipelineJsonStringified = pipelineJsonStringified.split(REPLACING_NONCE).join(', ');
-    pipelineJsonStringified += '\n';
-    return pipelineJsonStringified;
-}
-/**
- * TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.book.md
- * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
- * TODO: [🧠] Maybe more elegant solution than replacing via regex
- * TODO: [🍙] Make some standard order of json properties
- */
-
 /**
  * Delagates the user interaction to a async callback function
  * You need to provide your own implementation of this callback function and its bind to UI.
@@ -11130,5 +10985,5 @@ var PrefixStorage = /** @class */ (function () {
     return PrefixStorage;
 }());
 
-export { $llmToolsMetadataRegister, $llmToolsRegister, $scrapersMetadataRegister, $scrapersRegister, ADMIN_EMAIL, ADMIN_GITHUB_NAME, AbstractFormatError, BOOK_LANGUAGE_VERSION, BlackholeStorage, BoilerplateError, BoilerplateFormfactorDefinition, CLAIM, CallbackInterfaceTools, ChatbotFormfactorDefinition, CollectionError, CsvFormatDefinition, CsvFormatError, DEFAULT_BOOKS_DIRNAME, DEFAULT_CSV_SETTINGS, DEFAULT_EXECUTIONS_CACHE_DIRNAME, DEFAULT_INTERMEDIATE_FILES_STRATEGY, DEFAULT_IS_AUTO_INSTALLED, DEFAULT_IS_VERBOSE, DEFAULT_MAX_EXECUTION_ATTEMPTS, DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH, DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL, DEFAULT_MAX_PARALLEL_COUNT, DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME, DEFAULT_REMOTE_URL, DEFAULT_REMOTE_URL_PATH, DEFAULT_SCRAPE_CACHE_DIRNAME, DEFAULT_TITLE, EXPECTATION_UNITS, EnvironmentMismatchError, ExecutionReportStringOptionsDefaults, ExpectError, FORMFACTOR_DEFINITIONS, GENERIC_PIPELINE_INTERFACE, GeneratorFormfactorDefinition, GenericFormfactorDefinition, KnowledgeScrapeError, LOGO_DARK_SRC, LOGO_LIGHT_SRC, LimitReachedError, MANDATORY_CSV_SETTINGS, MAX_FILENAME_LENGTH, MODEL_VARIANTS, MatcherFormfactorDefinition, MemoryStorage, MissingToolsError, MultipleLlmExecutionTools, NAME, NonTaskSectionTypes, NotFoundError, NotYetImplementedError, ORDER_OF_PIPELINE_JSON, PROMPTBOOK_ENGINE_VERSION, PROMPTBOOK_ERRORS, ParseError, PipelineExecutionError, PipelineLogicError, PipelineUrlError, PrefixStorage, RESERVED_PARAMETER_NAMES, SET_IS_VERBOSE, SectionTypes, SheetsFormfactorDefinition, TaskTypes, TextFormatDefinition, TranslatorFormfactorDefinition, UNCERTAIN_USAGE, UnexpectedError, ZERO_USAGE, _AnthropicClaudeMetadataRegistration, _AzureOpenAiMetadataRegistration, _DocumentScraperMetadataRegistration, _GoogleMetadataRegistration, _LegacyDocumentScraperMetadataRegistration, _MarkdownScraperMetadataRegistration, _OpenAiAssistantMetadataRegistration, _OpenAiMetadataRegistration, _PdfScraperMetadataRegistration, _WebsiteScraperMetadataRegistration, addUsage, assertsExecutionSuccessful, cacheLlmTools, collectionToJson, compilePipeline, countTotalUsage, createCollectionFromJson, createCollectionFromPromise, createCollectionFromUrl, createLlmToolsFromConfiguration, createPipelineExecutor, createSubcollection, embeddingVectorToString, executionReportJsonToString, extractParameterNamesFromTask, getPipelineInterface, isPassingExpectations, isPipelineImplementingInterface, isPipelineInterfacesEqual, isPipelinePrepared, joinLlmExecutionTools, limitTotalUsage, makeKnowledgeSourceHandler, pipelineJsonToString, precompilePipeline, prepareKnowledgePieces, preparePersona, preparePipeline, prepareTasks, prettifyPipelineString, removePipelineCommand, renamePipelineParameter, stringifyPipelineJson, unpreparePipeline, usageToHuman, usageToWorktime, validatePipeline };
+export { $llmToolsMetadataRegister, $llmToolsRegister, $scrapersMetadataRegister, $scrapersRegister, ADMIN_EMAIL, ADMIN_GITHUB_NAME, AbstractFormatError, BOOK_LANGUAGE_VERSION, BlackholeStorage, BoilerplateError, BoilerplateFormfactorDefinition, CLAIM, CallbackInterfaceTools, ChatbotFormfactorDefinition, CollectionError, CsvFormatDefinition, CsvFormatError, DEFAULT_BOOKS_DIRNAME, DEFAULT_CSV_SETTINGS, DEFAULT_EXECUTIONS_CACHE_DIRNAME, DEFAULT_INTERMEDIATE_FILES_STRATEGY, DEFAULT_IS_AUTO_INSTALLED, DEFAULT_IS_VERBOSE, DEFAULT_MAX_EXECUTION_ATTEMPTS, DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH, DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL, DEFAULT_MAX_PARALLEL_COUNT, DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME, DEFAULT_REMOTE_URL, DEFAULT_REMOTE_URL_PATH, DEFAULT_SCRAPE_CACHE_DIRNAME, DEFAULT_TITLE, EXPECTATION_UNITS, EnvironmentMismatchError, ExecutionReportStringOptionsDefaults, ExpectError, FORMFACTOR_DEFINITIONS, GENERIC_PIPELINE_INTERFACE, GeneratorFormfactorDefinition, GenericFormfactorDefinition, KnowledgeScrapeError, LOGO_DARK_SRC, LOGO_LIGHT_SRC, LimitReachedError, MANDATORY_CSV_SETTINGS, MAX_FILENAME_LENGTH, MODEL_VARIANTS, MatcherFormfactorDefinition, MemoryStorage, MissingToolsError, MultipleLlmExecutionTools, NAME, NonTaskSectionTypes, NotFoundError, NotYetImplementedError, ORDER_OF_PIPELINE_JSON, PROMPTBOOK_ENGINE_VERSION, PROMPTBOOK_ERRORS, ParseError, PipelineExecutionError, PipelineLogicError, PipelineUrlError, PrefixStorage, RESERVED_PARAMETER_NAMES, SET_IS_VERBOSE, SectionTypes, SheetsFormfactorDefinition, TaskTypes, TextFormatDefinition, TranslatorFormfactorDefinition, UNCERTAIN_USAGE, UnexpectedError, ZERO_USAGE, _AnthropicClaudeMetadataRegistration, _AzureOpenAiMetadataRegistration, _DocumentScraperMetadataRegistration, _GoogleMetadataRegistration, _LegacyDocumentScraperMetadataRegistration, _MarkdownScraperMetadataRegistration, _OpenAiAssistantMetadataRegistration, _OpenAiMetadataRegistration, _PdfScraperMetadataRegistration, _WebsiteScraperMetadataRegistration, addUsage, assertsExecutionSuccessful, cacheLlmTools, collectionToJson, compilePipeline, countTotalUsage, createCollectionFromJson, createCollectionFromPromise, createCollectionFromUrl, createLlmToolsFromConfiguration, createPipelineExecutor, createSubcollection, embeddingVectorToString, executionReportJsonToString, extractParameterNamesFromTask, getPipelineInterface, isPassingExpectations, isPipelineImplementingInterface, isPipelineInterfacesEqual, isPipelinePrepared, joinLlmExecutionTools, limitTotalUsage, makeKnowledgeSourceHandler, pipelineJsonToString, precompilePipeline, prepareKnowledgePieces, preparePersona, preparePipeline, prepareTasks, prettifyPipelineString, unpreparePipeline, usageToHuman, usageToWorktime, validatePipeline };
 //# sourceMappingURL=index.es.js.map