@promptbook/core 0.52.0-19 → 0.52.0-24

package/esm/typings/library/constructors/createPromptbookLibraryFromUrl.d.ts

@@ -1,13 +1,29 @@
+import { string_url } from '../../types/typeAliases';
 import { PromptbookLibrary } from '../PromptbookLibrary';
+/**
+ * Options for `createPromptbookLibraryFromDirectory` function
+ */
+type CreatePromptbookLibraryFromUrlyOptions = {
+    /**
+     * If true, the library creation outputs information about each file it reads
+     *
+     * @default false
+     */
+    isVerbose?: boolean;
+    /**
+     * If true, directory will be scanned only when needed not during the construction
+     *
+     * @default false
+     */
+    isLazyLoaded?: boolean;
+};
 /**
  * Constructs Promptbook from remote Promptbase URL
- *
- * Note: The function does NOT return promise it returns the library directly which dynamically loads promptbooks when needed
- *       SO during the construction syntax and logic sources IS NOT validated
- *
+
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookLibraryFromUrl(): PromptbookLibrary;
+export declare function createPromptbookLibraryFromUrl(url: string_url | URL, options: CreatePromptbookLibraryFromUrlyOptions): Promise<PromptbookLibrary>;
+export {};
 /***
  * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
  */

package/esm/typings/library/constructors/justTestFsImport.d.ts

@@ -2,3 +2,6 @@
  * Just testing imports and compatibility
  */
 export declare function justTestFsImport(): Promise<void>;
+/**
+ * TODO: !!! Remove this file
+ */ 

package/esm/typings/types/Prompt.d.ts

@@ -39,7 +39,7 @@ export type Prompt = {
     /**
      * Unique identifier of the promptbook with specific template name as hash
      *
-     * @example https://promptbook.webgpt.com/cs/write-website-content.ptbk.md@v2.4.15#keywords
+     * @example https://promptbook.webgpt.com/cs/write-website-content.ptbk.md#keywords
      */
     readonly promptbookUrl: string_promptbook_url_with_hashtemplate;
     /**

package/esm/typings/types/typeAliases.d.ts

@@ -179,13 +179,13 @@ export type string_url = string;
 /**
  * Semantic helper
  *
- * For example `"https://promptbook.webgpt.com/cs/write-website-content.ptbk.md@v2.4.15"`
+ * For example `"https://promptbook.webgpt.com/cs/write-website-content.ptbk.md"`
  */
 export type string_promptbook_url = string;
 /**
  * Semantic helper
  *
- * For example `"https://promptbook.webgpt.com/cs/write-website-content.ptbk.md@v2.4.15#keywords"`
+ * For example `"https://promptbook.webgpt.com/cs/write-website-content.ptbk.md#keywords"`
  */
 export type string_promptbook_url_with_hashtemplate = string;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/core",
-    "version": "0.52.0-19",
+    "version": "0.52.0-24",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -36,7 +36,7 @@
     "dependencies": {
         "moment": "2.30.1",
         "prettier": "2.8.1",
-        "spacetrim": "0.11.25"
+        "spacetrim": "0.11.27"
     },
     "funding": [
         {

package/umd/index.umd.js

@@ -454,7 +454,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.52.0-18';
+    var PROMPTBOOK_VERSION = '0.52.0-23';
 
     /**
      * Parses the template and returns the list of all parameter names
@@ -3360,6 +3360,7 @@
      *
      * @param promptbookSourcesPromiseOrFactory
      * @returns PromptbookLibrary
+     * @private Just internal tool for other constructor functions
      */
     function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory) {
         var library;
@@ -3432,100 +3433,115 @@
      * Constructs Promptbook from given directory
      *
      * Note: Works only in Node.js environment because it reads the file system
-     * Note: The function does NOT return promise it returns the library directly which dynamically loads promptbooks when needed
-     *       SO during the construction syntax and logic sources IS NOT validated
      *
      * @param path - path to the directory with promptbooks
      * @param options - Misc options for the library
      * @returns PromptbookLibrary
      */
     function createPromptbookLibraryFromDirectory(path, options) {
-        var _this = this;
-        if (!isRunningInNode()) {
-            throw new Error('Function `createPromptbookLibraryFromDirectory` can only be run in Node.js environment because it reads the file system.');
-        }
-        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 () {
-            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) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, _b, isRecursive, _c, isVerbose, _d, isLazyLoaded, library;
+            var _this = this;
+            return __generator(this, function (_e) {
+                switch (_e.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));
+                        if (!isRunningInNode()) {
+                            throw new Error('Function `createPromptbookLibraryFromDirectory` can only be run in Node.js environment because it reads the file system.');
                         }
-                        _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));
+                        _a = options || {}, _b = _a.isRecursive, isRecursive = _b === void 0 ? true : _b, _c = _a.isVerbose, isVerbose = _c === void 0 ? false : _c, _d = _a.isLazyLoaded, isLazyLoaded = _d === void 0 ? false : _d;
+                        library = createPromptbookLibraryFromPromise(function () { return __awaiter(_this, void 0, void 0, function () {
+                            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:
+                                        if (isVerbose) {
+                                            console.info("Creating promptbook library from path ".concat(path));
+                                        }
+                                        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];
                                 }
-                                // 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];
+                            });
+                        }); });
+                        if (!(isLazyLoaded === false)) return [3 /*break*/, 2];
+                        return [4 /*yield*/, library.listPromptbooks()];
+                    case 1:
+                        _e.sent();
+                        _e.label = 2;
+                    case 2: return [2 /*return*/, library];
                 }
             });
-        }); });
+        });
     }
     /**
      * Reads all files in the directory
@@ -3602,15 +3618,34 @@
 
     /**
      * Constructs Promptbook from remote Promptbase URL
-     *
-     * Note: The function does NOT return promise it returns the library directly which dynamically loads promptbooks when needed
-     *       SO during the construction syntax and logic sources IS NOT validated
-     *
+
      * @returns PromptbookLibrary
      */
-    function createPromptbookLibraryFromUrl() {
-        throw new Error('Not implemented yet');
-        // TODO: !! Load dynamically DO NOT use createPromptbookLibraryFromPromise
+    function createPromptbookLibraryFromUrl(url, options) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, _b, isVerbose, _c, isLazyLoaded, library;
+            var _this = this;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        _a = options || {}, _b = _a.isVerbose, isVerbose = _b === void 0 ? false : _b, _c = _a.isLazyLoaded, isLazyLoaded = _c === void 0 ? false : _c;
+                        library = createPromptbookLibraryFromPromise(function () { return __awaiter(_this, void 0, void 0, function () {
+                            return __generator(this, function (_a) {
+                                if (isVerbose) {
+                                    console.info("Creating promptbook library from url ".concat(url.toString()));
+                                }
+                                throw new Error('Not implemented yet');
+                            });
+                        }); });
+                        if (!(isLazyLoaded === false)) return [3 /*break*/, 2];
+                        return [4 /*yield*/, library.listPromptbooks()];
+                    case 1:
+                        _d.sent();
+                        _d.label = 2;
+                    case 2: return [2 /*return*/, library];
+                }
+            });
+        });
     }
     /***
      * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
@@ -3719,6 +3754,9 @@
             });
         });
     }
+    /**
+     * TODO: !!! Remove this file
+     */
 
     /**
      * Format either small or big number
@@ -4031,7 +4069,6 @@
     exports.checkExpectations = checkExpectations;
     exports.createPromptbookExecutor = createPromptbookExecutor;
     exports.createPromptbookLibraryFromDirectory = createPromptbookLibraryFromDirectory;
-    exports.createPromptbookLibraryFromPromise = createPromptbookLibraryFromPromise;
     exports.createPromptbookLibraryFromSources = createPromptbookLibraryFromSources;
     exports.createPromptbookLibraryFromUrl = createPromptbookLibraryFromUrl;
     exports.createPromptbookSublibrary = createPromptbookSublibrary;