@promptbook/core 0.84.0-13 → 0.84.0-15

package/esm/typings/src/_packages/core.index.d.ts

@@ -12,6 +12,8 @@ import { LOGO_LIGHT_SRC } from '../config';
 import { LOGO_DARK_SRC } from '../config';
 import { DEFAULT_BOOK_TITLE } from '../config';
 import { DEFAULT_TASK_TITLE } from '../config';
+import { DEFAULT_PROMPT_TASK_TITLE } from '../config';
+import { DEFAULT_BOOK_OUTPUT_PARAMETER_NAME } from '../config';
 import { MAX_FILENAME_LENGTH } from '../config';
 import { DEFAULT_INTERMEDIATE_FILES_STRATEGY } from '../config';
 import { DEFAULT_MAX_PARALLEL_COUNT } from '../config';
@@ -139,6 +141,8 @@ export { LOGO_LIGHT_SRC };
 export { LOGO_DARK_SRC };
 export { DEFAULT_BOOK_TITLE };
 export { DEFAULT_TASK_TITLE };
+export { DEFAULT_PROMPT_TASK_TITLE };
+export { DEFAULT_BOOK_OUTPUT_PARAMETER_NAME };
 export { MAX_FILENAME_LENGTH };
 export { DEFAULT_INTERMEDIATE_FILES_STRATEGY };
 export { DEFAULT_MAX_PARALLEL_COUNT };

package/esm/typings/src/config.d.ts

@@ -65,6 +65,18 @@ export declare const DEFAULT_BOOK_TITLE = "\u2728 Untitled Book";
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_TASK_TITLE = "Task";
+/**
+ * When the title of the prompt task is not provided, the default title is used
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_PROMPT_TASK_TITLE = "Prompt";
+/**
+ * When the pipeline is flat and no name of return parameter is provided, this name is used
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_BOOK_OUTPUT_PARAMETER_NAME = "result";
 /**
  * Warning message for the generated sections and files files
  *

package/esm/typings/src/utils/editable/edit-pipeline-string/deflatePipeline.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/utils/editable/utils/isFlatPipeline.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/utils/files/mimeTypeToExtension.d.ts

@@ -0,0 +1,10 @@
+import type { string_file_extension } from '../../types/typeAliases';
+import type { string_mime_type } from '../../types/typeAliases';
+/**
+ * Convert mime type to file extension
+ *
+ * Note: If the mime type is invalid, `null` is returned
+ *
+ * @private within the repository
+ */
+export declare function mimeTypeToExtension(value: string_mime_type): string_file_extension | null;

package/esm/typings/src/utils/files/mimeTypeToExtension.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,8 +1,7 @@
 {
     "name": "@promptbook/core",
-    "version": "0.84.0-13",
+    "version": "0.84.0-15",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
-    "--note-0": "    <- [🐊]",
     "private": false,
     "sideEffects": false,
     "repository": {
@@ -12,7 +11,6 @@
     "contributors": [
         "Pavol Hejný <pavol@ptbk.io> (https://www.pavolhejny.com/)"
     ],
-    "--todo-0": "TODO: [❇️] Make better list of keywords",
     "keywords": [
         "ai",
         "llm",
@@ -35,21 +33,11 @@
         "anthropic",
         "LLMOps"
     ],
-    "license": "CC-BY-4.0",
+    "license": "SEE LICENSE IN LICENSE.md",
     "bugs": {
         "url": "https://github.com/webgptorg/promptbook/issues"
     },
     "homepage": "https://www.npmjs.com/package/@promptbook/core",
-    "funding": [
-        {
-            "type": "individual",
-            "url": "https://buymeacoffee.com/hejny"
-        },
-        {
-            "type": "github",
-            "url": "https://github.com/webgptorg/promptbook/blob/main/README.md#%EF%B8%8F-contributing"
-        }
-    ],
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/core.index.d.ts",

package/umd/index.umd.js

@@ -27,7 +27,7 @@
      * @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
@@ -674,6 +674,18 @@
      * @public exported from `@promptbook/core`
      */
     var DEFAULT_TASK_TITLE = "Task";
+    /**
+     * When the title of the prompt task is not provided, the default title is used
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var DEFAULT_PROMPT_TASK_TITLE = "Prompt";
+    /**
+     * 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';
     // <- TODO: [🧠] Better system for generator warnings - not always "code" and "by `@promptbook/cli`"
     /**
      * The maximum number of iterations for a loops
@@ -5823,6 +5835,17 @@
      * TODO: [🖇] What about symlinks?
      */
 
+    /**
+     * Convert mime type to file extension
+     *
+     * Note: If the mime type is invalid, `null` is returned
+     *
+     * @private within the repository
+     */
+    function mimeTypeToExtension(value) {
+        return mimeTypes.extension(value) || null;
+    }
+
     /**
      * Removes emojis from a string and fix whitespaces
      *
@@ -5916,7 +5939,7 @@
                     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,
@@ -5961,7 +5984,7 @@
                         basename = url.split('/').pop() || titleToName(url);
                         hash = sha256__default["default"](hexEncoder__default["default"].parse(url)).toString( /* hex */);
                         rootDirname_1 = path.join(process.cwd(), DEFAULT_DOWNLOAD_CACHE_DIRNAME);
-                        filepath = path.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 = path.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(path.dirname(path.join(rootDirname_1, filepath)), { recursive: true })];
                     case 2:
                         _l.sent();
@@ -5972,9 +5995,9 @@
                     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];
@@ -9095,12 +9118,15 @@
         pipelineString = removeMarkdownComments(pipelineString);
         pipelineString = spaceTrim__default["default"](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;
     }
 
@@ -9114,9 +9140,26 @@
             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__default["default"](pipelineStringLines.join('\n'));
-        pipelineString = validatePipelineString(spaceTrim__default["default"](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__default["default"](function (block) { return "\n                ```\n                ".concat(block(prompt.split('`').join('\\`')), "\n                ```\n            "); });
+        }
+        pipelineString = validatePipelineString(spaceTrim__default["default"](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;
     }
@@ -11375,7 +11418,7 @@
         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',
         ],
@@ -11555,6 +11598,7 @@
     exports.CsvFormatDefinition = CsvFormatDefinition;
     exports.CsvFormatError = CsvFormatError;
     exports.DEFAULT_BOOKS_DIRNAME = DEFAULT_BOOKS_DIRNAME;
+    exports.DEFAULT_BOOK_OUTPUT_PARAMETER_NAME = DEFAULT_BOOK_OUTPUT_PARAMETER_NAME;
     exports.DEFAULT_BOOK_TITLE = DEFAULT_BOOK_TITLE;
     exports.DEFAULT_CSV_SETTINGS = DEFAULT_CSV_SETTINGS;
     exports.DEFAULT_DOWNLOAD_CACHE_DIRNAME = DEFAULT_DOWNLOAD_CACHE_DIRNAME;
@@ -11567,6 +11611,7 @@
     exports.DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL;
     exports.DEFAULT_MAX_PARALLEL_COUNT = DEFAULT_MAX_PARALLEL_COUNT;
     exports.DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME = DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME;
+    exports.DEFAULT_PROMPT_TASK_TITLE = DEFAULT_PROMPT_TASK_TITLE;
     exports.DEFAULT_REMOTE_URL = DEFAULT_REMOTE_URL;
     exports.DEFAULT_REMOTE_URL_PATH = DEFAULT_REMOTE_URL_PATH;
     exports.DEFAULT_SCRAPE_CACHE_DIRNAME = DEFAULT_SCRAPE_CACHE_DIRNAME;