@promptbook/core 0.81.0-16 → 0.81.0-18

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.81.0-15';
+var PROMPTBOOK_ENGINE_VERSION = '0.81.0-17';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -148,6 +148,11 @@ function __spreadArray(to, from, pack) {
         }
     }
     return to.concat(ar || Array.prototype.slice.call(from));
+}
+
+function __makeTemplateObject(cooked, raw) {
+    if (Object.defineProperty) { Object.defineProperty(cooked, "raw", { value: raw }); } else { cooked.raw = raw; }
+    return cooked;
 }
 
 /**
@@ -897,7 +902,6 @@ function checkSerializableAsJson(options) {
 function deepClone(objectValue) {
     return JSON.parse(JSON.stringify(objectValue));
     /*
-    !!!!!!!!
     TODO: [🧠] Is there a better implementation?
     > const propertyNames = Object.getOwnPropertyNames(objectValue);
     > for (const propertyName of propertyNames) {
@@ -3546,6 +3550,23 @@ function arrayableToArray(input) {
     return [input];
 }
 
+/**
+ * Just says that the variable is not used but should be kept
+ * No side effects.
+ *
+ * Note: It can be usefull for:
+ *
+ * 1) Suppressing eager optimization of unused imports
+ * 2) Suppressing eslint errors of unused variables in the tests
+ * 3) Keeping the type of the variable for type testing
+ *
+ * @param value any values
+ * @returns void
+ * @private within the repository
+ */
+function keepUnused() {
+}
+
 /**
  * Replaces parameters in template with values from parameters object
  *
@@ -7344,20 +7365,24 @@ var ChatbotFormfactorDefinition = {
  */
 var GeneratorFormfactorDefinition = {
     name: 'GENERATOR',
-    description: "@@@",
+    description: "Generates any kind (in HTML with possible scripts and css format) of content from input message",
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/184",
     pipelineInterface: {
         inputParameters: [
-            /* @@@ */
             {
-                name: 'nonce',
-                description: 'Just to prevent GENERATOR to be set as implicit formfactor',
+                name: 'inputMessage',
+                description: "Input message to be image made from",
                 isInput: true,
                 isOutput: false,
             },
         ],
         outputParameters: [
-        /* @@@ */
+            {
+                name: 'result',
+                description: "Result in HTML to be shown to user",
+                isInput: false,
+                isOutput: true,
+            },
         ],
     },
 };
@@ -7396,7 +7421,7 @@ var GenericFormfactorDefinition = {
  */
 var ImageGeneratorFormfactorDefinition = {
     name: 'IMAGE_GENERATOR',
-    description: "@@@",
+    description: "Generates prompt for image generation from input message",
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/184",
     pipelineInterface: {
         inputParameters: [
@@ -8830,7 +8855,7 @@ var QuickChatbotHla = {
             isOutput: true,
             exampleValues: ['Hello, I am a Pavol`s virtual avatar. How can I help you?'],
         });
-        // TODO: !!!!!! spaceTrim
+        // TODO: Use spaceTrim in multiline strings
         $pipelineJson.tasks.push({
             taskType: 'PROMPT_TASK',
             name: 'create-an-answer',
@@ -8838,8 +8863,11 @@ var QuickChatbotHla = {
             content: 'Write a response to the user message:\n\n**Question from user**\n\n> {userMessage}\n\n**Previous conversation**\n\n> {previousConversationSummary}',
             resultingParameterName: 'chatbotResponse',
             personaName: personaName,
-            dependentParameterNames: ['userMessage', 'previousConversationSummary' /* !!!!!!, 'knowledge'*/],
-            // !!!!!! preparedContent: '{content}\n\n## Knowledge\n\n{knowledge}',
+            dependentParameterNames: [
+                'userMessage',
+                'previousConversationSummary' /* TODO: [🧠][📛], 'knowledge'*/,
+            ],
+            // TODO: [🧠][📛] preparedContent: '{content}\n\n## Knowledge\n\n{knowledge}',
         }, {
             taskType: 'PROMPT_TASK',
             name: 'summarize-the-conversation',
@@ -8853,19 +8881,22 @@ var QuickChatbotHla = {
                     max: 10,
                 },
             },
-            dependentParameterNames: ['userMessage', 'chatbotResponse' /* !!!!!!, 'knowledge'*/],
-            // !!!!!! preparedContent: '{content}\n\n## Knowledge\n\n{knowledge}',
+            dependentParameterNames: ['userMessage', 'chatbotResponse' /* TODO: [🧠][📛], 'knowledge'*/],
+            // TODO: [🧠][📛]  preparedContent: '{content}\n\n## Knowledge\n\n{knowledge}',
         }, {
             taskType: 'SIMPLE_TASK',
             name: 'title',
             title: 'Title',
             content: '{conversationSummary}',
             resultingParameterName: 'title',
-            dependentParameterNames: ['conversationSummary' /* !!!!!!, 'knowledge'*/],
-            // !!!!!! preparedContent: '{content}\n\n## Knowledge\n\n{knowledge}',
+            dependentParameterNames: ['conversationSummary' /* TODO: [🧠][📛], 'knowledge'*/],
+            // TODO: [🧠][📛] preparedContent: '{content}\n\n## Knowledge\n\n{knowledge}',
         });
     },
 };
+/**
+ * TODO: [🧠][📛] Should this be here?
+ */
 
 /**
  * All high-level abstractions
@@ -9106,13 +9137,13 @@ function flattenMarkdown(markdown) {
  */
 
 /**
- * Removes HTML or Markdown comments from a string.
+ * Removes Markdown (or HTML) comments
  *
  * @param {string} content - The string to remove comments from.
  * @returns {string} The input string with all comments removed.
  * @public exported from `@promptbook/markdown-utils`
  */
-function removeContentComments(content) {
+function removeMarkdownComments(content) {
     return spaceTrim$1(content.replace(/<!--(.*?)-->/gs, ''));
 }
 
@@ -9197,7 +9228,7 @@ function precompilePipeline(pipelineString) {
         }
         pipelineString = restLines.join('\n');
     }
-    pipelineString = removeContentComments(pipelineString);
+    pipelineString = removeMarkdownComments(pipelineString);
     pipelineString = spaceTrim$1(pipelineString);
     // ==============
     // Note: 1️⃣◽2️⃣ Process flat pipeline
@@ -9214,7 +9245,7 @@ function precompilePipeline(pipelineString) {
         var returnStatement_1 = pipelineStringLines.pop();
         var prompt_1 = spaceTrim$1(pipelineStringLines.join('\n'));
         pipelineString = spaceTrim$1(function (block) { return "\n                # ".concat(DEFAULT_TITLE /* <- TODO: !!!!!! Title for flat pipelines */, "\n\n                ## Prompt\n\n                ```\n                ").concat(block(prompt_1), "\n                ```\n\n                ").concat(returnStatement_1, "\n            "); });
-        // <- TODO: !!!!!! Use `book notation
+        // <- TODO: !!!!!! Use book` notation
         // console.log(pipelineString);
     }
     // ==============
@@ -9685,7 +9716,7 @@ function addAutoGeneratedSection(content, options) {
         return content.replace(sectionRegex, contentToInsert);
     }
     // Note: Following is the case when the section is not found in the file so we add it there
-    var placeForSection = removeContentComments(content).match(/^##.*$/im);
+    var placeForSection = removeMarkdownComments(content).match(/^##.*$/im);
     if (placeForSection !== null) {
         var _a = __read(placeForSection, 1), heading_1 = _a[0];
         return content.replace(heading_1, spaceTrim$1(function (block) { return "\n                    ".concat(block(contentToInsert), "\n\n                    ").concat(block(heading_1), "\n                "); }));
@@ -10947,6 +10978,48 @@ var _OpenAiAssistantMetadataRegistration = $llmToolsMetadataRegister.register({
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */
 
+/**
+ * Function `isValidPipelineString` 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.
+ *
+ * @public exported from `@promptbook/core`
+ */
+function isValidPipelineString(value) {
+    // TODO: !!!!!! Implement the validation + add false tests
+    return true;
+}
+/**
+ * TODO: [🧠][🈴] Where is the best location for this file
+ */
+
+/**
+ * Function for notating a pipeline with a book\`...\ notation as template literal
+ *
+ * @param strings @@@
+ * @param values @@@
+ * @returns the pipeline string
+ * @public exported from `@promptbook/core`
+ */
+function book(strings) {
+    var values = [];
+    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(pipelineString);
+    return pipelineString;
+}
+keepUnused(book(templateObject_1 || (templateObject_1 = __makeTemplateObject(["\n      !!!!!! Remove\n"], ["\n      !!!!!! Remove\n"]))));
+var templateObject_1;
+/**
+ * TODO: !!!!!! Use book\`...\ notation instead of as PipelineString
+ * TODO: [🧠][🈴] Where is the best location for this file
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */
+
 /**
  * Metadata of the scraper
  *
@@ -11074,7 +11147,10 @@ var websiteScraperMetadata = $deepFreeze({
     className: 'WebsiteScraper',
     mimeTypes: ['text/html'],
     documentationUrl: 'https://github.com/webgptorg/promptbook/discussions/@@',
-    isAvilableInBrowser: false,
+    isAvilableInBrowser: true,
+    // <- TODO: !!!!!!! Is it available in browser?
+    // <- TODO: !!!!!!! Is toggling this to true enough to make it available in browser?
+    // <- TODO: Maybe make it available in browser
     requiredExecutables: [],
 }); /* <- Note: [🤛] */
 /**
@@ -11172,5 +11248,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_GET_PIPELINE_COLLECTION_FUNCTION_NAME, 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, ImageGeneratorFormfactorDefinition, 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 };
+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_GET_PIPELINE_COLLECTION_FUNCTION_NAME, 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, ImageGeneratorFormfactorDefinition, 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, book, cacheLlmTools, collectionToJson, compilePipeline, countTotalUsage, createCollectionFromJson, createCollectionFromPromise, createCollectionFromUrl, createLlmToolsFromConfiguration, createPipelineExecutor, createSubcollection, embeddingVectorToString, executionReportJsonToString, extractParameterNamesFromTask, getPipelineInterface, isPassingExpectations, isPipelineImplementingInterface, isPipelineInterfacesEqual, isPipelinePrepared, isValidPipelineString, joinLlmExecutionTools, limitTotalUsage, makeKnowledgeSourceHandler, pipelineJsonToString, precompilePipeline, prepareKnowledgePieces, preparePersona, preparePipeline, prepareTasks, prettifyPipelineString, unpreparePipeline, usageToHuman, usageToWorktime, validatePipeline };
 //# sourceMappingURL=index.es.js.map