@promptbook/core 0.52.0-17 → 0.52.0-19

package/README.md

@@ -555,8 +555,6 @@ _Note: LLMs work with tokens, not characters, but in Promptbooks we want to use
 ```markdown
 # ✨ Sample: Expectations
 
--   PROMPTBOOK URL https://promptbook.example.com/samples/postprocessing-2.ptbk.md@v1
--   PROMPTBOOK VERSION 1.0.0
 -   INPUT  PARAMETER {yourName} Name of the hero
 
 ## 💬 Question

package/esm/index.es.js

@@ -1,6 +1,7 @@
 import spaceTrim$1, { spaceTrim } from 'spacetrim';
 import { format } from 'prettier';
 import parserHtml from 'prettier/parser-html';
+import { join } from 'path';
 import moment from 'moment';
 
 /*! *****************************************************************************
@@ -447,7 +448,7 @@ function union() {
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.52.0-16';
+var PROMPTBOOK_VERSION = '0.52.0-18';
 
 /**
  * Parses the template and returns the list of all parameter names
@@ -2525,7 +2526,7 @@ function createPromptbookExecutor(options) {
                                 title: currentTemplate.title,
                                 promptbookUrl: "".concat(promptbook.promptbookUrl
                                     ? promptbook.promptbookUrl
-                                    : 'anonymous' /* <- [🧠][🈴] How to deal with anonymous PROMPTBOOKs, do here some auto-url like SHA-256 based ad-hoc identifier? */, "#").concat(currentTemplate.name),
+                                    : 'anonymous' /* <- TODO: [🧠] How to deal with anonymous PROMPTBOOKs, do here some auto-url like SHA-256 based ad-hoc identifier? */, "#").concat(currentTemplate.name),
                                 parameters: parametersToPass,
                                 content: replaceParameters(currentTemplate.content, parametersToPass) /* <- [2] */,
                                 modelRequirements: currentTemplate.modelRequirements,
@@ -3168,6 +3169,23 @@ var isRunningInNode = new Function("\n    try {\n        return this === global;
  */
 new Function("\n    try {\n        if (typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope) {\n            return true;\n        } else {\n            return false;\n        }\n    } catch (e) {\n        return false;\n    }\n");
 
+/**
+ * Returns the same value that is passed as argument.
+ * No side effects.
+ *
+ * Note: It can be usefull for leveling indentation
+ *
+ * @param value any values
+ * @returns the same values
+ */
+function just(value) {
+    if (value === undefined) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        return undefined;
+    }
+    return value;
+}
+
 /**
  * This error indicates that promptbook not found in the library
  */
@@ -3225,6 +3243,12 @@ var SimplePromptbookLibrary = /** @class */ (function () {
                     throw new PromptbookReferenceError(spaceTrim("\n                        Promptbook with name \"".concat(promptbook.title, "\" does not have defined URL\n\n                        Note: Promptbooks without URLs are called anonymous promptbooks\n                              They can be used as standalone promptbooks, but they cannot be referenced by other promptbooks\n                              And also they cannot be used in the promptbook library\n\n                    ")));
                 }
                 validatePromptbookJson(promptbook);
+                // Note: [🦄]
+                if (this.library.has(promptbook.promptbookUrl) &&
+                    promptbookJsonToString(promptbook) !==
+                        promptbookJsonToString(this.library.get(promptbook.promptbookUrl))) {
+                    throw new PromptbookReferenceError(spaceTrim("\n                        Promptbook with URL \"".concat(promptbook.promptbookUrl, "\" is already in the library\n\n                        Note: Promptbooks with the same URL are not allowed\n                        Note: Automatically check whether the promptbooks are the same BUT they are DIFFERENT\n\n                    ")));
+                }
                 this.library.set(promptbook.promptbookUrl, promptbook);
             }
         }
@@ -3251,6 +3275,9 @@ var SimplePromptbookLibrary = /** @class */ (function () {
         var _this = this;
         var promptbook = this.library.get(url);
         if (!promptbook) {
+            if (this.listPromptbooks().length === 0) {
+                throw new PromptbookNotFoundError(spaceTrim("\n                            Promptbook with url \"".concat(url, "\" not found\n\n                            No promptbooks available\n                        ")));
+            }
             throw new PromptbookNotFoundError(spaceTrim(function (block) { return "\n                        Promptbook with url \"".concat(url, "\" not found\n\n                        Available promptbooks:\n                        ").concat(block(_this.listPromptbooks()
                 .map(function (promptbookUrl) { return "- ".concat(promptbookUrl); })
                 .join('\n')), "\n\n                    "); }));
@@ -3411,40 +3438,160 @@ function createPromptbookLibraryFromDirectory(path, options) {
     if (!isRunningInNode()) {
         throw new Error('Function `createPromptbookLibraryFromDirectory` can only be run in Node.js environment because it reads the file system.');
     }
-    var _a = (options || {}).isRecursive, isRecursive = _a === void 0 ? true : _a;
+    var _a = options || {}, _b = _a.isRecursive, isRecursive = _b === void 0 ? true : _b, _c = _a.isVerbose, isVerbose = _c === void 0 ? false : _c;
     return createPromptbookLibraryFromPromise(function () { return __awaiter(_this, void 0, void 0, function () {
-        return __generator(this, function (_a) {
-            /*
-            const justR_equire = require; /* <- Note: [1] * /
-            const readdir = justR_equire(just('fs/promises') /* <- Note: [2] * /).readdir as typeof readdirType;
-    
-            // TODO: !!!! Implement recursive reading
-            // TODO: !!!!! readAllFiles util
-    
-            const dirents = await readdir(path, {
-                withFileTypes: true /* Note: This is not working: recursive: isRecursive * /,
-            });
-            const fileNames = dirents.filter((dirent) => dirent.isFile()).map(({ name }) => join(name, path));
-    
-            // TODO: !!! Implement
-    
-            console.info('createPromptbookLibraryFromDirectory', { path, isRecursive, fileNames });
-            throw new Error('Not implemented yet');
-    
-            */
-            console.info('createPromptbookLibraryFromDirectory', { path: path, isRecursive: isRecursive });
-            return [2 /*return*/, []];
+        var fsPromises, readFile, fileNames, promptbooks, fileNames_1, fileNames_1_1, fileName, promptbook, promptbookString, _a, _b, e_1_1;
+        var e_1, _c;
+        return __generator(this, function (_d) {
+            switch (_d.label) {
+                case 0:
+                    fsPromises = require(just('fs/promises') /* <- Note: [1] */);
+                    readFile = fsPromises.readFile;
+                    return [4 /*yield*/, listAllFiles(path, isRecursive)];
+                case 1:
+                    fileNames = _d.sent();
+                    if (isVerbose) {
+                        console.info('createPromptbookLibraryFromDirectory', { path: path, isRecursive: isRecursive, fileNames: fileNames });
+                    }
+                    promptbooks = [];
+                    _d.label = 2;
+                case 2:
+                    _d.trys.push([2, 11, 12, 13]);
+                    fileNames_1 = __values(fileNames), fileNames_1_1 = fileNames_1.next();
+                    _d.label = 3;
+                case 3:
+                    if (!!fileNames_1_1.done) return [3 /*break*/, 10];
+                    fileName = fileNames_1_1.value;
+                    promptbook = null;
+                    if (!fileName.endsWith('.ptbk.md')) return [3 /*break*/, 5];
+                    return [4 /*yield*/, readFile(fileName, 'utf8')];
+                case 4:
+                    promptbookString = (_d.sent());
+                    promptbook = promptbookStringToJson(promptbookString);
+                    return [3 /*break*/, 8];
+                case 5:
+                    if (!fileName.endsWith('.ptbk.json')) return [3 /*break*/, 7];
+                    if (isVerbose) {
+                        console.info("Loading ".concat(fileName));
+                    }
+                    _b = (_a = JSON).parse;
+                    return [4 /*yield*/, readFile(fileName, 'utf8')];
+                case 6:
+                    // TODO: Handle non-valid JSON files
+                    promptbook = _b.apply(_a, [_d.sent()]);
+                    return [3 /*break*/, 8];
+                case 7:
+                    if (isVerbose) {
+                        console.info("Skipping file ".concat(fileName));
+                    }
+                    _d.label = 8;
+                case 8:
+                    // ---
+                    if (promptbook !== null) {
+                        if (!promptbook.promptbookUrl) {
+                            if (isVerbose) {
+                                console.info("Not loading ".concat(fileName, " - missing URL"));
+                            }
+                        }
+                        else {
+                            if (isVerbose) {
+                                console.info("Loading ".concat(fileName));
+                            }
+                            // Note: [🦄] Promptbook with same url uniqueness will be checked automatically in SimplePromptbookLibrary
+                            promptbooks.push(promptbook);
+                        }
+                    }
+                    _d.label = 9;
+                case 9:
+                    fileNames_1_1 = fileNames_1.next();
+                    return [3 /*break*/, 3];
+                case 10: return [3 /*break*/, 13];
+                case 11:
+                    e_1_1 = _d.sent();
+                    e_1 = { error: e_1_1 };
+                    return [3 /*break*/, 13];
+                case 12:
+                    try {
+                        if (fileNames_1_1 && !fileNames_1_1.done && (_c = fileNames_1.return)) _c.call(fileNames_1);
+                    }
+                    finally { if (e_1) throw e_1.error; }
+                    return [7 /*endfinally*/];
+                case 13: return [2 /*return*/, promptbooks];
+            }
         });
     }); });
 }
+/**
+ * Reads all files in the directory
+ *
+ * @param path
+ * @param isRecursive
+ * @returns List of all files in the directory
+ * @private internal function for `createPromptbookLibraryFromDirectory`
+ */
+function listAllFiles(path, isRecursive) {
+    return __awaiter(this, void 0, void 0, function () {
+        var fsPromises, readdir, dirents, fileNames, _a, _b, dirent, subPath, _c, _d, _e, _f, e_2_1;
+        var e_2, _g;
+        return __generator(this, function (_h) {
+            switch (_h.label) {
+                case 0:
+                    fsPromises = require(just('fs/promises') /* <- Note: [1] */);
+                    readdir = fsPromises.readdir;
+                    return [4 /*yield*/, readdir(path, {
+                            withFileTypes: true /* Note: This is not working: recursive: isRecursive */,
+                        })];
+                case 1:
+                    dirents = _h.sent();
+                    fileNames = dirents.filter(function (dirent) { return dirent.isFile(); }).map(function (_a) {
+                        var name = _a.name;
+                        return join(path, name);
+                    });
+                    if (!isRecursive) return [3 /*break*/, 9];
+                    _h.label = 2;
+                case 2:
+                    _h.trys.push([2, 7, 8, 9]);
+                    _a = __values(dirents.filter(function (dirent) { return dirent.isDirectory(); })), _b = _a.next();
+                    _h.label = 3;
+                case 3:
+                    if (!!_b.done) return [3 /*break*/, 6];
+                    dirent = _b.value;
+                    subPath = join(path, dirent.name);
+                    _d = (_c = fileNames.push).apply;
+                    _e = [fileNames];
+                    _f = [[]];
+                    return [4 /*yield*/, listAllFiles(subPath, isRecursive)];
+                case 4:
+                    _d.apply(_c, _e.concat([__spreadArray.apply(void 0, _f.concat([__read.apply(void 0, [(_h.sent())]), false]))]));
+                    _h.label = 5;
+                case 5:
+                    _b = _a.next();
+                    return [3 /*break*/, 3];
+                case 6: return [3 /*break*/, 9];
+                case 7:
+                    e_2_1 = _h.sent();
+                    e_2 = { error: e_2_1 };
+                    return [3 /*break*/, 9];
+                case 8:
+                    try {
+                        if (_b && !_b.done && (_g = _a.return)) _g.call(_a);
+                    }
+                    finally { if (e_2) throw e_2.error; }
+                    return [7 /*endfinally*/];
+                case 9: return [2 /*return*/, fileNames];
+            }
+        });
+    });
+}
 /***
- * Note: [1] Fixing the dynamic import issue in Webpack
+ * TODO: [🧠] Maybe do not do hacks like [1] and just create package @promptbook/node
+ *       [🍓][🚯] maybe make `@promptbook/library` package
+ * TODO: Fix the dynamic import issue in Webpack (! Not working !)
  *     > ./node_modules/@promptbook/core/esm/index.es.js
  *     > Critical dependency: the request of a dependency is an expression
  *
- * Note: [2] Using require(just('fs/promises')) to allow
+ * Note: [1] Using require(just('fs/promises')) to allow
  *     the `@promptbook/core` work for both Node.js and browser environments
- * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */
 
 /**
@@ -3545,23 +3692,6 @@ function createPromptbookSublibrary(library, predicate) {
  * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */
 
-/**
- * Returns the same value that is passed as argument.
- * No side effects.
- *
- * Note: It can be usefull for leveling indentation
- *
- * @param value any values
- * @returns the same values
- */
-function just(value) {
-    if (value === undefined) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        return undefined;
-    }
-    return value;
-}
-
 /**
  * Just testing imports and compatibility
  */