@promptbook/cli 0.84.0-13 → 0.84.0-15

package/LICENSE.md

@@ -0,0 +1 @@
+[Functional Source License, Version 1.1, ALv2 Future License](https://github.com/getsentry/fsl.software/blob/main/FSL-1.1-ALv2.template.md)

package/README.md

@@ -1,6 +1,6 @@
 <!-- ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten -->
 
-# ❄ Promptbook
+# ✨ Promptbook
 
 
 
@@ -16,10 +16,10 @@
 
 ## ❄ New Features
 
+-   🐋 **Support of [DeepSeek models](https://www.deepseek.com/)**
 -   💙 Working [the **Book** language v1.0.0](https://github.com/webgptorg/book)
 -   🖤 Run books from CLI - `npx ptbk run path/to/your/book`
--   📚 Support of `.docx`, `.doc` and `.pdf` documents
--   ✨ **Support of [OpenAI o1 model](https://openai.com/o1/)**
+-   📚 Support of `.docx`, `.doc` and `.pdf` documents as knowledge
 
 
 

package/esm/index.es.js

@@ -11,7 +11,7 @@ import { format } from 'prettier';
 import parserHtml from 'prettier/parser-html';
 import { unparse, parse } from 'papaparse';
 import { SHA256 } from 'crypto-js';
-import { lookup } from 'mime-types';
+import { lookup, extension } from 'mime-types';
 import { spawn } from 'child_process';
 import glob from 'glob-promise';
 import prompts from 'prompts';
@@ -38,7 +38,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.84.0-12';
+var PROMPTBOOK_ENGINE_VERSION = '0.84.0-14';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -229,6 +229,12 @@ var DEFAULT_BOOK_TITLE = "\u2728 Untitled Book";
  * @public exported from `@promptbook/core`
  */
 var DEFAULT_TASK_TITLE = "Task";
+/**
+ * When the pipeline is flat and no name of return parameter is provided, this name is used
+ *
+ * @public exported from `@promptbook/core`
+ */
+var DEFAULT_BOOK_OUTPUT_PARAMETER_NAME = 'result';
 /**
  * Warning message for the generated sections and files files
  *
@@ -6475,6 +6481,17 @@ function getFileExtension(value) {
     return match ? match[1].toLowerCase() : null;
 }
 
+/**
+ * Convert mime type to file extension
+ *
+ * Note: If the mime type is invalid, `null` is returned
+ *
+ * @private within the repository
+ */
+function mimeTypeToExtension(value) {
+    return extension(value) || null;
+}
+
 /**
  * The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
  *
@@ -6528,7 +6545,7 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
                 case 1:
                     response_1 = _l.sent();
                     mimeType = ((_a = response_1.headers.get('content-type')) === null || _a === void 0 ? void 0 : _a.split(';')[0]) || 'text/html';
-                    if (tools.fs === undefined || !url.endsWith('.pdf')) {
+                    if (tools.fs === undefined || !url.endsWith('.pdf' /* <- TODO: [💵] */)) {
                         return [2 /*return*/, {
                                 source: name,
                                 filename: null,
@@ -6573,7 +6590,7 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
                     basename = url.split('/').pop() || titleToName(url);
                     hash = sha256(hexEncoder.parse(url)).toString( /* hex */);
                     rootDirname_1 = join(process.cwd(), DEFAULT_DOWNLOAD_CACHE_DIRNAME);
-                    filepath = join.apply(void 0, __spreadArray(__spreadArray([], __read(nameToSubfolderPath(hash /* <- TODO: [🎎] Maybe add some SHA256 prefix */)), false), ["".concat(basename.substring(0, MAX_FILENAME_LENGTH), ".pdf")], false));
+                    filepath = join.apply(void 0, __spreadArray(__spreadArray([], __read(nameToSubfolderPath(hash /* <- TODO: [🎎] Maybe add some SHA256 prefix */)), false), ["".concat(basename.substring(0, MAX_FILENAME_LENGTH), ".").concat(mimeTypeToExtension(mimeType))], false));
                     return [4 /*yield*/, tools.fs.mkdir(dirname(join(rootDirname_1, filepath)), { recursive: true })];
                 case 2:
                     _l.sent();
@@ -6584,9 +6601,9 @@ function makeKnowledgeSourceHandler(knowledgeSource, tools, options) {
                 case 3: return [4 /*yield*/, _g.apply(_f, _h.concat([_k.apply(_j, [_l.sent()])]))];
                 case 4:
                     _l.sent();
-                    // TODO: !!!!!!!! Check the file security
+                    // TODO: [💵] Check the file security
                     // TODO: !!!!!!!! Check the file size (if it is not too big)
-                    // TODO: !!!!!!!! Delete the file
+                    // TODO: !!!!!!!! Delete the file after the scraping is done
                     return [2 /*return*/, makeKnowledgeSourceHandler({ name: name, knowledgeSourceContent: filepath }, tools, __assign(__assign({}, options), { rootDirname: rootDirname_1 }))];
                 case 5:
                     if (!isValidFilePath(knowledgeSourceContent)) return [3 /*break*/, 7];
@@ -9707,12 +9724,15 @@ function isFlatPipeline(pipelineString) {
     pipelineString = removeMarkdownComments(pipelineString);
     pipelineString = spaceTrim(pipelineString);
     var isMarkdownBeginningWithHeadline = pipelineString.startsWith('# ');
-    var isLastLineReturnStatement = pipelineString.split('\n').pop().split('`').join('').startsWith('->');
-    // TODO: Also (double)check
+    //const isLastLineReturnStatement = pipelineString.split('\n').pop()!.split('`').join('').startsWith('->');
+    var isBacktickBlockUsed = pipelineString.includes('```');
+    var isQuoteBlocksUsed = /^>\s+/m.test(pipelineString);
+    var isBlocksUsed = isBacktickBlockUsed || isQuoteBlocksUsed;
+    // TODO: [🧉] Also (double)check
     // > const usedCommands
     // > const isBlocksUsed
     // > const returnStatementCount
-    var isFlat = !isMarkdownBeginningWithHeadline && isLastLineReturnStatement;
+    var isFlat = !isMarkdownBeginningWithHeadline && !isBlocksUsed; /* && isLastLineReturnStatement */
     return isFlat;
 }
 
@@ -9726,9 +9746,26 @@ function deflatePipeline(pipelineString) {
         return pipelineString;
     }
     var pipelineStringLines = pipelineString.split('\n');
-    var returnStatement = pipelineStringLines.pop();
+    var potentialReturnStatement = pipelineStringLines.pop();
+    var returnStatement;
+    if (/(-|=)>\s*\{.*\}/.test(potentialReturnStatement)) {
+        // Note: Last line is return statement
+        returnStatement = potentialReturnStatement;
+    }
+    else {
+        // Note: Last line is not a return statement
+        returnStatement = "-> {".concat(DEFAULT_BOOK_OUTPUT_PARAMETER_NAME, "}");
+        pipelineStringLines.push(potentialReturnStatement);
+    }
     var prompt = spaceTrim(pipelineStringLines.join('\n'));
-    pipelineString = validatePipelineString(spaceTrim(function (block) { return "\n                # ".concat(DEFAULT_BOOK_TITLE, "\n\n                ## Prompt\n\n                ```\n                ").concat(block(prompt), "\n                ```\n\n                ").concat(returnStatement, "\n            "); }));
+    var quotedPrompt;
+    if (prompt.split('\n').length <= 1) {
+        quotedPrompt = "> ".concat(prompt);
+    }
+    else {
+        quotedPrompt = spaceTrim(function (block) { return "\n                ```\n                ".concat(block(prompt.split('`').join('\\`')), "\n                ```\n            "); });
+    }
+    pipelineString = validatePipelineString(spaceTrim(function (block) { return "\n                # ".concat(DEFAULT_BOOK_TITLE, "\n\n                ## Prompt\n\n                ").concat(block(quotedPrompt), "\n\n                ").concat(returnStatement, "\n            "); }));
     // <- TODO: Maybe use book` notation
     return pipelineString;
 }
@@ -16944,7 +16981,7 @@ var markitdownScraperMetadata = $deepFreeze({
     className: 'MarkitdownScraper',
     mimeTypes: [
         'application/pdf',
-        // TODO: Make priority for scrapers and than allow all mime types here:
+        // TODO: [💵] Make priority for scrapers and than analyze which mime-types can Markitdown scrape and allow all mime types here:
         // 'text/html',
         // 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
     ],
@@ -16980,10 +17017,10 @@ var MarkitdownScraper = /** @class */ (function () {
         this.tools = tools;
         this.options = options;
         this.markdownScraper = new MarkdownScraper(tools, options);
+        // Note: Module `markitdown-ts` has no types available, so it is imported using `require`
         // eslint-disable-next-line @typescript-eslint/no-var-requires
         var MarkItDown = require('markitdown-ts').MarkItDown;
-        // <- TODO: !!! Use Markitdown directly not through this package
-        // <- Note: !!!!!!!
+        // <- TODO: 'Use Markitdown directly not through this package
         this.markitdown = new MarkItDown();
     }
     Object.defineProperty(MarkitdownScraper.prototype, "metadata", {
@@ -17028,12 +17065,12 @@ var MarkitdownScraper = /** @class */ (function () {
                     case 2:
                         if (!!(_f.sent())) return [3 /*break*/, 5];
                         src = source.filename || source.url || null;
-                        console.log('!!!', { src: src, source: source, cacheFilehandler: cacheFilehandler });
+                        // console.log('!!!', { src, source, cacheFilehandler });
                         if (src === null) {
                             throw new UnexpectedError('Source has no filename or url');
                         }
                         return [4 /*yield*/, this.markitdown.convert(src, {
-                            // TODO: !!!!!! Pass when sacraping Youtube
+                            // TODO: Pass when sacraping Youtube
                             // enableYoutubeTranscript: true,
                             // youtubeTranscriptLanguage: 'en',
                             })];
@@ -17043,9 +17080,10 @@ var MarkitdownScraper = /** @class */ (function () {
                             throw new Error("Markitdown could not convert the \"".concat(source.source, "\""));
                             // <- TODO: !!! Make MarkitdownError
                         }
-                        console.log('!!!', { result: result, cacheFilehandler: cacheFilehandler });
+                        // console.log('!!!', { result, cacheFilehandler });
                         return [4 /*yield*/, this.tools.fs.writeFile(cacheFilehandler.filename, result.text_content)];
                     case 4:
+                        // console.log('!!!', { result, cacheFilehandler });
                         _f.sent();
                         _f.label = 5;
                     case 5: return [2 /*return*/, cacheFilehandler];