@promptbook/core 0.40.0-3 → 0.40.0-6

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

@@ -6,9 +6,13 @@ import { CallbackInterfaceTools } from '../execution/plugins/user-interface-exec
 import { CallbackInterfaceToolsOptions } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions';
 import { SimplePromptInterfaceTools } from '../execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools';
 import { SimplePromptbookLibrary } from '../library/SimplePromptbookLibrary';
+import { createPromptbookLibraryFromPromise } from '../library/constructors/createPromptbookLibraryFromPromise';
+import { createPromptbookLibraryFromSources } from '../library/constructors/createPromptbookLibraryFromSources';
+import { createPromptbookSublibrary } from '../library/constructors/createPromptbookSublibrary';
 import { ExecutionTypes } from '../types/ExecutionTypes';
 import { PROMPTBOOK_VERSION } from '../version';
-export { ExecutionTypes, PROMPTBOOK_VERSION, SimplePromptbookLibrary };
+export { ExecutionTypes, PROMPTBOOK_VERSION };
+export { SimplePromptbookLibrary, createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookSublibrary, };
 export { SimplePromptInterfaceTools };
 export { promptbookStringToJson, validatePromptbookJson };
 export { MockedEchoNaturalExecutionTools };

package/esm/typings/errors/PromptbookReferenceError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This error indicates errors in referencing promptbooks between each other
+ */
+export declare class PromptbookReferenceError extends Error {
+    readonly name = "PromptbookReferenceError";
+    constructor(message: string);
+}

package/esm/typings/library/PromptbookLibrary.d.ts

@@ -21,5 +21,5 @@ export type PromptbookLibrary = {
     /**
      * Checks whether given prompt was defined in any promptbook in the library
      */
-    isResponsibleForPrompt(prompt: Prompt): boolean;
+    isResponsibleForPrompt(prompt: Prompt): Promisable<boolean>;
 };

package/esm/typings/library/SimplePromptbookLibrary.d.ts

@@ -1,28 +1,23 @@
 import type { Prompt } from '../types/Prompt';
 import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../types/PromptbookString';
 import type { string_promptbook_url } from '../types/typeAliases';
 import { PromptbookLibrary } from './PromptbookLibrary';
 /**
  * Library of promptbooks that groups together promptbooks for an application.
- * This implementation is a very thin wrapper around the Array / Set of promptbooks.
+ * This implementation is a very thin wrapper around the Array / Map of promptbooks.
  *
  * @see https://github.com/webgptorg/promptbook#promptbook-library
  */
 export declare class SimplePromptbookLibrary implements PromptbookLibrary {
-    private readonly library;
-    /**
-     * Constructs Promptbook from any sources
+    private library;
+    /**!!!
      *
-     * Note: During the construction syntax and logic of all sources are validated
-     * Note: You can combine .ptbk.md and .ptbk.json files BUT it is not recommended
+     * @param promptbooks !!!
      *
-     * @param promptbookSources contents of .ptbk.md or .ptbk.json files
-     * @param settings settings for creating executor functions
-     * @returns PromptbookLibrary
+     * Note: During the construction logic of all promptbooks are validated
+     * Note: It is not recommended to use this constructor directly, use `createPromptbookLibraryFromSources` *(or other variant)* instead
      */
-    static fromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): SimplePromptbookLibrary;
-    private constructor();
+    constructor(...promptbooks: Array<PromptbookJson>);
     /**
      * Gets all promptbooks in the library
      */

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

@@ -0,0 +1,7 @@
+import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
+import { PromptbookString } from '../../types/PromptbookString';
+import { PromptbookLibrary } from '../PromptbookLibrary';
+export declare function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson | PromptbookString>> | (() => Promise<Array<PromptbookJson | PromptbookString>>)): PromptbookLibrary;
+/***
+ * TODO: !!! Annotate all + all to README and samples
+ */

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

@@ -0,0 +1,16 @@
+import { PromptbookJson, PromptbookString } from '../../_packages/types.index';
+import { SimplePromptbookLibrary } from '../SimplePromptbookLibrary';
+export declare function createPromptbookLibraryFromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): SimplePromptbookLibrary;
+/**
+ * Constructs Promptbook from any sources
+ *
+ * Note: During the construction syntax and logic of all sources are validated
+ * Note: You can combine .ptbk.md and .ptbk.json files BUT it is not recommended
+ *
+ * @param promptbookSources contents of .ptbk.md or .ptbk.json files
+ * @param settings settings for creating executor functions
+ * @returns PromptbookLibrary
+ */
+/***
+ * TODO: !!! Annotate all + all to README and samples
+ */

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

@@ -0,0 +1,6 @@
+import type { string_promptbook_url } from '../../types/typeAliases';
+import { PromptbookLibrary } from '../PromptbookLibrary';
+export declare function createPromptbookSublibrary(library: PromptbookLibrary, predicate: (url: string_promptbook_url) => boolean): PromptbookLibrary;
+/***
+ * TODO: !!! Annotate all + all to README and samples
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/core",
-    "version": "0.40.0-3",
+    "version": "0.40.0-6",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,

package/umd/index.umd.js

@@ -427,7 +427,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.40.0-2';
+    var PROMPTBOOK_VERSION = '0.40.0-5';
 
     /**
      * Parses the given script and returns the list of all used variables that are not defined in the script
@@ -2085,61 +2085,59 @@
         return NotFoundError;
     }(Error));
 
+    /**
+     * This error indicates errors in referencing promptbooks between each other
+     */
+    var PromptbookReferenceError = /** @class */ (function (_super) {
+        __extends(PromptbookReferenceError, _super);
+        function PromptbookReferenceError(message) {
+            var _this = _super.call(this, message) || this;
+            _this.name = 'PromptbookReferenceError';
+            Object.setPrototypeOf(_this, PromptbookReferenceError.prototype);
+            return _this;
+        }
+        return PromptbookReferenceError;
+    }(Error));
+
     /**
      * Library of promptbooks that groups together promptbooks for an application.
-     * This implementation is a very thin wrapper around the Array / Set of promptbooks.
+     * This implementation is a very thin wrapper around the Array / Map of promptbooks.
      *
      * @see https://github.com/webgptorg/promptbook#promptbook-library
      */
     var SimplePromptbookLibrary = /** @class */ (function () {
-        function SimplePromptbookLibrary(library) {
-            this.library = library;
-        }
-        /**
-         * Constructs Promptbook from any sources
+        /**!!!
          *
-         * Note: During the construction syntax and logic of all sources are validated
-         * Note: You can combine .ptbk.md and .ptbk.json files BUT it is not recommended
+         * @param promptbooks !!!
          *
-         * @param promptbookSources contents of .ptbk.md or .ptbk.json files
-         * @param settings settings for creating executor functions
-         * @returns PromptbookLibrary
+         * Note: During the construction logic of all promptbooks are validated
+         * Note: It is not recommended to use this constructor directly, use `createPromptbookLibraryFromSources` *(or other variant)* instead
          */
-        SimplePromptbookLibrary.fromSources = function () {
+        function SimplePromptbookLibrary() {
             var e_1, _a;
-            var promptbookSources = [];
+            var promptbooks = [];
             for (var _i = 0; _i < arguments.length; _i++) {
-                promptbookSources[_i] = arguments[_i];
+                promptbooks[_i] = arguments[_i];
             }
-            var library = new Map();
+            this.library = new Map();
             try {
-                for (var promptbookSources_1 = __values(promptbookSources), promptbookSources_1_1 = promptbookSources_1.next(); !promptbookSources_1_1.done; promptbookSources_1_1 = promptbookSources_1.next()) {
-                    var source = promptbookSources_1_1.value;
-                    var promptbook = void 0;
-                    if (typeof source === 'string') {
-                        // Note: When directly creating from string, no need to validate the source
-                        //       The validation is performed always before execution
-                        promptbook = promptbookStringToJson(source);
-                    }
-                    else {
-                        promptbook = source;
-                    }
-                    validatePromptbookJson(promptbook);
+                for (var promptbooks_1 = __values(promptbooks), promptbooks_1_1 = promptbooks_1.next(); !promptbooks_1_1.done; promptbooks_1_1 = promptbooks_1.next()) {
+                    var promptbook = promptbooks_1_1.value;
                     if (promptbook.promptbookUrl === undefined) {
-                        throw new Error(spaceTrim__default["default"]("\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                  ")));
+                        throw new PromptbookReferenceError(spaceTrim__default["default"]("\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                    ")));
                     }
-                    library.set(promptbook.promptbookUrl, promptbook);
+                    validatePromptbookJson(promptbook);
+                    this.library.set(promptbook.promptbookUrl, promptbook);
                 }
             }
             catch (e_1_1) { e_1 = { error: e_1_1 }; }
             finally {
                 try {
-                    if (promptbookSources_1_1 && !promptbookSources_1_1.done && (_a = promptbookSources_1.return)) _a.call(promptbookSources_1);
+                    if (promptbooks_1_1 && !promptbooks_1_1.done && (_a = promptbooks_1.return)) _a.call(promptbooks_1);
                 }
                 finally { if (e_1) throw e_1.error; }
             }
-            return new SimplePromptbookLibrary(library);
-        };
+        }
         /**
          * Gets all promptbooks in the library
          */
@@ -2170,6 +2168,191 @@
         return SimplePromptbookLibrary;
     }());
 
+    function createPromptbookLibraryFromSources() {
+        var e_1, _a;
+        var promptbookSources = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            promptbookSources[_i] = arguments[_i];
+        }
+        var promptbooks = new Array();
+        try {
+            for (var promptbookSources_1 = __values(promptbookSources), promptbookSources_1_1 = promptbookSources_1.next(); !promptbookSources_1_1.done; promptbookSources_1_1 = promptbookSources_1.next()) {
+                var source = promptbookSources_1_1.value;
+                var promptbook = void 0;
+                if (typeof source === 'string') {
+                    // Note: When directly creating from string, no need to validate the source
+                    //       The validation is performed always before execution
+                    promptbook = promptbookStringToJson(source);
+                }
+                else {
+                    promptbook = source;
+                }
+                promptbooks.push(promptbook);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (promptbookSources_1_1 && !promptbookSources_1_1.done && (_a = promptbookSources_1.return)) _a.call(promptbookSources_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        return new (SimplePromptbookLibrary.bind.apply(SimplePromptbookLibrary, __spreadArray([void 0], __read(promptbooks), false)))();
+    }
+    /**
+     * Constructs Promptbook from any sources
+     *
+     * Note: During the construction syntax and logic of all sources are validated
+     * Note: You can combine .ptbk.md and .ptbk.json files BUT it is not recommended
+     *
+     * @param promptbookSources contents of .ptbk.md or .ptbk.json files
+     * @param settings settings for creating executor functions
+     * @returns PromptbookLibrary
+     */
+    /***
+     * TODO: !!! Annotate all + all to README and samples
+     */
+
+    function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory) {
+        var library;
+        function forSources() {
+            return __awaiter(this, void 0, void 0, function () {
+                var promptbookSources;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            if (typeof promptbookSourcesPromiseOrFactory === 'function') {
+                                // Note: Calling factory function only once despite multiple calls to resolveSources
+                                promptbookSourcesPromiseOrFactory = promptbookSourcesPromiseOrFactory();
+                            }
+                            return [4 /*yield*/, promptbookSourcesPromiseOrFactory];
+                        case 1:
+                            promptbookSources = _a.sent();
+                            library = createPromptbookLibraryFromSources.apply(void 0, __spreadArray([], __read(promptbookSources), false));
+                            return [2 /*return*/];
+                    }
+                });
+            });
+        }
+        function listPromptbooks() {
+            return __awaiter(this, void 0, void 0, function () {
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0: return [4 /*yield*/, forSources()];
+                        case 1:
+                            _a.sent();
+                            return [2 /*return*/, /* not await */ library.listPromptbooks()];
+                    }
+                });
+            });
+        }
+        function getPromptbookByUrl(url) {
+            return __awaiter(this, void 0, void 0, function () {
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0: return [4 /*yield*/, forSources()];
+                        case 1:
+                            _a.sent();
+                            return [2 /*return*/, /* not await */ library.getPromptbookByUrl(url)];
+                    }
+                });
+            });
+        }
+        function isResponsibleForPrompt(prompt) {
+            return __awaiter(this, void 0, void 0, function () {
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0: return [4 /*yield*/, forSources()];
+                        case 1:
+                            _a.sent();
+                            return [2 /*return*/, /* not await */ library.isResponsibleForPrompt(prompt)];
+                    }
+                });
+            });
+        }
+        return {
+            listPromptbooks: listPromptbooks,
+            getPromptbookByUrl: getPromptbookByUrl,
+            isResponsibleForPrompt: isResponsibleForPrompt,
+        };
+    }
+    /***
+     * TODO: !!! Annotate all + all to README and samples
+     */
+
+    function createPromptbookSublibrary(library, predicate) {
+        function listPromptbooks() {
+            return __awaiter(this, void 0, void 0, function () {
+                var promptbooks;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0: return [4 /*yield*/, library.listPromptbooks()];
+                        case 1:
+                            promptbooks = _a.sent();
+                            promptbooks = promptbooks.filter(predicate);
+                            return [2 /*return*/, promptbooks];
+                    }
+                });
+            });
+        }
+        function getPromptbookByUrl(url) {
+            return __awaiter(this, void 0, void 0, function () {
+                var _a, promptbook;
+                var _this = this;
+                return __generator(this, function (_b) {
+                    switch (_b.label) {
+                        case 0:
+                            if (!!predicate(url)) return [3 /*break*/, 2];
+                            _a = NotFoundError.bind;
+                            return [4 /*yield*/, spaceTrim__default["default"](function (block) { return __awaiter(_this, void 0, void 0, function () {
+                                    var _a, _b, _c, _d, _e, _f;
+                                    return __generator(this, function (_g) {
+                                        switch (_g.label) {
+                                            case 0:
+                                                _c = (_b = "\n                        Promptbook with url \"".concat(url, "\" not found or not accessible\n\n                        Available promptbooks:\n                        ")).concat;
+                                                _d = block;
+                                                return [4 /*yield*/, listPromptbooks()];
+                                            case 1:
+                                                _e = (_a = _c.apply(_b, [_d.apply(void 0, [(_g.sent()).map(function (promptbookUrl) { return "- ".concat(promptbookUrl); }).join('\n')]), "\n\n                        All available promptbooks in parent library:\n                        "])).concat;
+                                                _f = block;
+                                                return [4 /*yield*/, library.listPromptbooks()];
+                                            case 2: return [2 /*return*/, _e.apply(_a, [_f.apply(void 0, [(_g.sent()).map(function (promptbookUrl) { return "- ".concat(promptbookUrl); }).join('\n')]), "\n\n                    "])];
+                                        }
+                                    });
+                                }); })];
+                        case 1: throw new (_a.apply(NotFoundError, [void 0, _b.sent()]))();
+                        case 2: return [4 /*yield*/, library.getPromptbookByUrl(url)];
+                        case 3:
+                            promptbook = _b.sent();
+                            return [2 /*return*/, promptbook];
+                    }
+                });
+            });
+        }
+        function isResponsibleForPrompt(prompt) {
+            return __awaiter(this, void 0, void 0, function () {
+                var isResponsible;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0: return [4 /*yield*/, library.isResponsibleForPrompt(prompt)];
+                        case 1:
+                            isResponsible = _a.sent();
+                            // TODO: !! Only if responsible, check if predicate is true
+                            return [2 /*return*/, isResponsible];
+                    }
+                });
+            });
+        }
+        return {
+            listPromptbooks: listPromptbooks,
+            getPromptbookByUrl: getPromptbookByUrl,
+            isResponsibleForPrompt: isResponsibleForPrompt,
+        };
+    }
+    /***
+     * TODO: !!! Annotate all + all to README and samples
+     */
+
     exports.CallbackInterfaceTools = CallbackInterfaceTools;
     exports.ExecutionTypes = ExecutionTypes;
     exports.MockedEchoNaturalExecutionTools = MockedEchoNaturalExecutionTools;
@@ -2177,6 +2360,9 @@
     exports.SimplePromptInterfaceTools = SimplePromptInterfaceTools;
     exports.SimplePromptbookLibrary = SimplePromptbookLibrary;
     exports.createPromptbookExecutor = createPromptbookExecutor;
+    exports.createPromptbookLibraryFromPromise = createPromptbookLibraryFromPromise;
+    exports.createPromptbookLibraryFromSources = createPromptbookLibraryFromSources;
+    exports.createPromptbookSublibrary = createPromptbookSublibrary;
     exports.promptbookStringToJson = promptbookStringToJson;
     exports.validatePromptbookJson = validatePromptbookJson;