@promptbook/pdf 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/pdf",
-    "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,26 +33,16 @@
         "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/pdf.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.84.0-13"
+        "@promptbook/core": "0.84.0-15"
     },
     "dependencies": {
         "crypto-js": "4.2.0",

package/umd/index.umd.js

@@ -25,7 +25,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
@@ -3581,6 +3581,17 @@
         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 mimeTypes.extension(value) || null;
+    }
+
     /**
      * The built-in `fetch' function with a lightweight error handling wrapper as default fetch function used in Promptbook scrapers
      *
@@ -3634,7 +3645,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,
@@ -3679,7 +3690,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();
@@ -3690,9 +3701,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];
@@ -6311,7 +6322,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',
         ],
@@ -6347,10 +6358,10 @@
             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", {
@@ -6395,12 +6406,12 @@
                         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',
                                 })];
@@ -6410,9 +6421,10 @@
                                 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];