@promptbook/core 0.59.0-21 → 0.59.0-24

package/esm/typings/src/cli/actions/hello.d.ts

@@ -0,0 +1,7 @@
+import type { Command } from 'commander';
+/**
+ * Initializes testing `hello` command for Promptbook CLI utilities
+ *
+ * @private part of `promptbookCli`
+ */
+export declare function initializeHello(program: Command): void;

package/esm/typings/src/cli/actions/make.d.ts

@@ -0,0 +1,7 @@
+import type { Command } from 'commander';
+/**
+ * Initializes `make` command for Promptbook CLI utilities
+ *
+ * @private part of `promptbookCli`
+ */
+export declare function initializeMake(program: Command): void;

package/esm/typings/src/cli/actions/prettify.d.ts

@@ -0,0 +1,7 @@
+import type { Command } from 'commander';
+/**
+ * Initializes `prettify` command for Promptbook CLI utilities
+ *
+ * @private part of `promptbookCli`
+ */
+export declare function initializePrettify(program: Command): void;

package/esm/typings/src/{conversion/prettify/prettifyPromptbookStringCli.d.ts → cli/promptbookCli.d.ts}

@@ -1,7 +1,7 @@
 /**
- * Runs CLI script for prettifying promptbooks
+ * Runs CLI utilities of Promptbook package
  */
-export declare function prettifyPromptbookStringCli(): Promise<void>;
+export declare function promptbookCli(): Promise<void>;
 /**
  * TODO: [🥠] Do not export to utils directly, its just for CLI script
  * TODO: [🕌] When more functionalities, rename

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

@@ -6,6 +6,7 @@ import type { PromptbookLibrary } from './PromptbookLibrary';
  * Library of promptbooks that groups together promptbooks for an application.
  * This implementation is a very thin wrapper around the Array / Map of promptbooks.
  *
+ * @private use `createLibraryFromJson` instead
  * @see https://github.com/webgptorg/promptbook#promptbook-library
  */
 export declare class SimplePromptbookLibrary implements PromptbookLibrary {
@@ -15,8 +16,9 @@ export declare class SimplePromptbookLibrary implements PromptbookLibrary {
      *
      * @param promptbooks !!!
      *
+     * @private Use instead `createLibraryFromJson`
      * 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
+     * Note: It is not recommended to use this constructor directly, use `createLibraryFromJson` *(or other variant)* instead
      */
     constructor(...promptbooks: Array<PromptbookJson>);
     /**

package/{umd/typings/src/library/constructors/createPromptbookLibraryFromDirectory.d.ts → esm/typings/src/library/constructors/createLibraryFromDirectory.d.ts}

@@ -1,7 +1,7 @@
 import type { string_folder_path } from '../../types/typeAliases';
 import type { PromptbookLibrary } from '../PromptbookLibrary';
 /**
- * Options for `createPromptbookLibraryFromDirectory` function
+ * Options for `createLibraryFromDirectory` function
  */
 type CreatePromptbookLibraryFromDirectoryOptions = {
     /**
@@ -39,7 +39,7 @@ type CreatePromptbookLibraryFromDirectoryOptions = {
  * @param options - Misc options for the library
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookLibraryFromDirectory(path: string_folder_path, options?: CreatePromptbookLibraryFromDirectoryOptions): Promise<PromptbookLibrary>;
+export declare function createLibraryFromDirectory(path: string_folder_path, options?: CreatePromptbookLibraryFromDirectoryOptions): Promise<PromptbookLibrary>;
 export {};
 /**
  * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks

package/esm/typings/src/library/constructors/createLibraryFromJson.d.ts

@@ -0,0 +1,12 @@
+import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
+import { SimplePromptbookLibrary } from '../SimplePromptbookLibrary';
+/**
+ * Creates PromptbookLibrary from array of PromptbookJson or PromptbookString
+ *
+ * Note: Functions `libraryToJson` and `createLibraryFromJson` are complementary
+ * Note: During the construction syntax and logic of all sources are validated
+ *
+ * @param promptbookSources
+ * @returns PromptbookLibrary
+ */
+export declare function createLibraryFromJson(...promptbooks: Array<PromptbookJson>): Promise<SimplePromptbookLibrary>;

package/{umd/typings/src/library/constructors/createPromptbookLibraryFromPromise.d.ts → esm/typings/src/library/constructors/createLibraryFromPromise.d.ts}

@@ -1,5 +1,4 @@
 import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../../types/PromptbookString';
 import type { PromptbookLibrary } from '../PromptbookLibrary';
 /**
  * Constructs Promptbook from async sources
@@ -8,19 +7,16 @@ import type { PromptbookLibrary } from '../PromptbookLibrary';
  * - Factory function that returns Promise of array of PromptbookJson or PromptbookString
  *
  * Note: This is useful as internal tool for other constructor functions like
- *       `createPromptbookLibraryFromUrl` or `createPromptbookLibraryFromDirectory`
+ *       `createLibraryFromUrl` or `createLibraryFromDirectory`
  *       Consider using those functions instead of this one
  *
  * Note: The function does NOT return promise it returns the library directly which waits for the sources to be resolved
  *       when error occurs in given promise or factory function, it is thrown during `listPromptbooks` or `getPromptbookByUrl` call
  *
- * Note: Consider using  `createPromptbookLibraryFromDirectory` or `createPromptbookLibraryFromUrl`
+ * Note: Consider using  `createLibraryFromDirectory` or `createLibraryFromUrl`
  *
  * @param promptbookSourcesPromiseOrFactory
  * @returns PromptbookLibrary
  * @deprecated Do not use, it will became internal tool for other constructor functions
  */
-export declare function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson | PromptbookString>> | (() => Promise<Array<PromptbookJson | PromptbookString>>)): PromptbookLibrary;
-/**
- * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
- */ 
+export declare function createLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson>> | (() => Promise<Array<PromptbookJson>>)): PromptbookLibrary;

package/{umd/typings/src/library/constructors/createPromptbookLibraryFromUrl.d.ts → esm/typings/src/library/constructors/createLibraryFromUrl.d.ts}

@@ -1,7 +1,7 @@
 import type { string_url } from '../../types/typeAliases';
 import type { PromptbookLibrary } from '../PromptbookLibrary';
 /**
- * Options for `createPromptbookLibraryFromDirectory` function
+ * Options for `createLibraryFromDirectory` function
  */
 type CreatePromptbookLibraryFromUrlyOptions = {
     /**
@@ -22,7 +22,7 @@ type CreatePromptbookLibraryFromUrlyOptions = {
 
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookLibraryFromUrl(url: string_url | URL, options: CreatePromptbookLibraryFromUrlyOptions): Promise<PromptbookLibrary>;
+export declare function createLibraryFromUrl(url: string_url | URL, options: CreatePromptbookLibraryFromUrlyOptions): Promise<PromptbookLibrary>;
 export {};
 /**
  * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks

package/esm/typings/src/library/constructors/{createPromptbookSublibrary.d.ts → createSublibrary.d.ts}

@@ -9,4 +9,4 @@ import type { PromptbookLibrary } from '../PromptbookLibrary';
  * @param promptbookSources
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookSublibrary(library: PromptbookLibrary, predicate: (url: string_promptbook_url) => boolean): PromptbookLibrary;
+export declare function createSublibrary(library: PromptbookLibrary, predicate: (url: string_promptbook_url) => boolean): PromptbookLibrary;

package/esm/typings/src/library/libraryToJson.d.ts

@@ -0,0 +1,8 @@
+import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
+import type { PromptbookLibrary } from './PromptbookLibrary';
+/**
+ * Converts PromptbookLibrary to serialized JSON
+ *
+ * Note: Functions `libraryToJson` and `createLibraryFromJson` are complementary
+ */
+export declare function libraryToJson(library: PromptbookLibrary): Promise<Array<PromptbookJson>>;

package/esm/typings/src/llm-providers/remote/startRemoteServer.d.ts

@@ -10,7 +10,7 @@ import type { RemoteServerOptions } from './interfaces/RemoteServerOptions';
  */
 export declare function startRemoteServer(options: RemoteServerOptions): IDestroyable;
 /**
- * TODO: [⚖] Expose the library to be able to connect to same library via createPromptbookLibraryFromUrl
+ * TODO: [⚖] Expose the library to be able to connect to same library via createLibraryFromUrl
  * TODO: Handle progress - support streaming
  * TODO: [🤹‍♂️] Do not hang up immediately but wait until client closes OR timeout
  * TODO: [🤹‍♂️] Timeout on chat to free up resources

package/package.json

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

package/umd/index.umd.js

@@ -206,7 +206,7 @@
         return PromptbookSyntaxError;
     }(Error));
 
-    var promptbookLibrary = [{title:"Prepare Knowledge from Markdown",promptbookUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.59.0-20",parameters:[{name:"content",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledge",description:"The knowledge JSON object",isInput:false,isOutput:true}],promptTemplates:[{name:"knowledge",title:"Knowledge",dependentParameterNames:["content"],executionType:"PROMPT_TEMPLATE",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n-   Make pieces of information concise, clear, and easy to understand\n-   One piece of information should be approximately 1 paragraph\n-   Divide the paragraphs by markdown horizontal lines ---\n-   Omit irrelevant information\n-   Group redundant information\n-   Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {content}",resultingParameterName:"knowledge"}],knowledge:[]}];
+    var promptbookLibrary = [{title:"Prepare Knowledge from Markdown",promptbookUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.59.0-23",parameters:[{name:"content",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledge",description:"The knowledge JSON object",isInput:false,isOutput:true}],promptTemplates:[{name:"knowledge",title:"Knowledge",dependentParameterNames:["content"],executionType:"PROMPT_TEMPLATE",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n-   Make pieces of information concise, clear, and easy to understand\n-   One piece of information should be approximately 1 paragraph\n-   Divide the paragraphs by markdown horizontal lines ---\n-   Omit irrelevant information\n-   Group redundant information\n-   Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {content}",resultingParameterName:"knowledge"}],knowledge:[]}];
 
     /**
      * This error indicates errors during the execution of the promptbook
@@ -531,7 +531,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.59.0-20';
+    var PROMPTBOOK_VERSION = '0.59.0-23';
 
     /**
      * Function `addUsage` will add multiple usages into one
@@ -1853,6 +1853,7 @@
      * Library of promptbooks that groups together promptbooks for an application.
      * This implementation is a very thin wrapper around the Array / Map of promptbooks.
      *
+     * @private use `createLibraryFromJson` instead
      * @see https://github.com/webgptorg/promptbook#promptbook-library
      */
     var SimplePromptbookLibrary = /** @class */ (function () {
@@ -1861,8 +1862,9 @@
          *
          * @param promptbooks !!!
          *
+         * @private Use instead `createLibraryFromJson`
          * 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
+         * Note: It is not recommended to use this constructor directly, use `createLibraryFromJson` *(or other variant)* instead
          */
         function SimplePromptbookLibrary() {
             var e_1, _a;
@@ -1931,68 +1933,23 @@
     /**
      * Creates PromptbookLibrary from array of PromptbookJson or PromptbookString
      *
-     * Note: You can combine `PromptbookString` (`.ptbk.md`) with `PromptbookJson` BUT it is not recommended
+     * Note: Functions `libraryToJson` and `createLibraryFromJson` are complementary
      * Note: During the construction syntax and logic of all sources are validated
      *
      * @param promptbookSources
      * @returns PromptbookLibrary
      */
-    function createPromptbookLibraryFromSources() {
-        var promptbookSources = [];
+    function createLibraryFromJson() {
+        var promptbooks = [];
         for (var _i = 0; _i < arguments.length; _i++) {
-            promptbookSources[_i] = arguments[_i];
+            promptbooks[_i] = arguments[_i];
         }
         return __awaiter(this, void 0, void 0, function () {
-            var promptbooks, promptbookSources_1, promptbookSources_1_1, source, promptbook, e_1_1;
-            var e_1, _a;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        promptbooks = new Array();
-                        _b.label = 1;
-                    case 1:
-                        _b.trys.push([1, 8, 9, 10]);
-                        promptbookSources_1 = __values(promptbookSources), promptbookSources_1_1 = promptbookSources_1.next();
-                        _b.label = 2;
-                    case 2:
-                        if (!!promptbookSources_1_1.done) return [3 /*break*/, 7];
-                        source = promptbookSources_1_1.value;
-                        promptbook = void 0;
-                        if (!(typeof source === 'string')) return [3 /*break*/, 4];
-                        return [4 /*yield*/, promptbookStringToJson(source)];
-                    case 3:
-                        // Note: When directly creating from string, no need to validate the source
-                        //       The validation is performed always before execution
-                        promptbook = _b.sent();
-                        return [3 /*break*/, 5];
-                    case 4:
-                        promptbook = source;
-                        _b.label = 5;
-                    case 5:
-                        promptbooks.push(promptbook);
-                        _b.label = 6;
-                    case 6:
-                        promptbookSources_1_1 = promptbookSources_1.next();
-                        return [3 /*break*/, 2];
-                    case 7: return [3 /*break*/, 10];
-                    case 8:
-                        e_1_1 = _b.sent();
-                        e_1 = { error: e_1_1 };
-                        return [3 /*break*/, 10];
-                    case 9:
-                        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 [7 /*endfinally*/];
-                    case 10: return [2 /*return*/, new (SimplePromptbookLibrary.bind.apply(SimplePromptbookLibrary, __spreadArray([void 0], __read(promptbooks), false)))()];
-                }
+            return __generator(this, function (_a) {
+                return [2 /*return*/, new (SimplePromptbookLibrary.bind.apply(SimplePromptbookLibrary, __spreadArray([void 0], __read(promptbooks), false)))()];
             });
         });
     }
-    /**
-     * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
-     */
 
     /* tslint:disable */
     function normalizeToKebabCase(sentence) {
@@ -2057,7 +2014,7 @@
                 switch (_b.label) {
                     case 0:
                         content = options.content, llmTools = options.llmTools, _a = options.isVerbose, isVerbose = _a === void 0 ? false : _a;
-                        return [4 /*yield*/, createPromptbookLibraryFromSources.apply(void 0, __spreadArray([], __read(promptbookLibrary), false))];
+                        return [4 /*yield*/, createLibraryFromJson.apply(void 0, __spreadArray([], __read(promptbookLibrary), false))];
                     case 1:
                         library = _b.sent();
                         promptbook = library.getPromptbookByUrl('https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md');
@@ -3492,19 +3449,19 @@
      * - Factory function that returns Promise of array of PromptbookJson or PromptbookString
      *
      * Note: This is useful as internal tool for other constructor functions like
-     *       `createPromptbookLibraryFromUrl` or `createPromptbookLibraryFromDirectory`
+     *       `createLibraryFromUrl` or `createLibraryFromDirectory`
      *       Consider using those functions instead of this one
      *
      * Note: The function does NOT return promise it returns the library directly which waits for the sources to be resolved
      *       when error occurs in given promise or factory function, it is thrown during `listPromptbooks` or `getPromptbookByUrl` call
      *
-     * Note: Consider using  `createPromptbookLibraryFromDirectory` or `createPromptbookLibraryFromUrl`
+     * Note: Consider using  `createLibraryFromDirectory` or `createLibraryFromUrl`
      *
      * @param promptbookSourcesPromiseOrFactory
      * @returns PromptbookLibrary
      * @deprecated Do not use, it will became internal tool for other constructor functions
      */
-    function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory) {
+    function createLibraryFromPromise(promptbookSourcesPromiseOrFactory) {
         var library;
         function forSources() {
             return __awaiter(this, void 0, void 0, function () {
@@ -3519,7 +3476,7 @@
                             return [4 /*yield*/, promptbookSourcesPromiseOrFactory];
                         case 1:
                             promptbookSources = _a.sent();
-                            return [4 /*yield*/, createPromptbookLibraryFromSources.apply(void 0, __spreadArray([], __read(promptbookSources), false))];
+                            return [4 /*yield*/, createLibraryFromJson.apply(void 0, __spreadArray([], __read(promptbookSources), false))];
                         case 2:
                             library = _a.sent();
                             return [2 /*return*/];
@@ -3569,16 +3526,13 @@
             isResponsibleForPrompt: isResponsibleForPrompt,
         };
     }
-    /**
-     * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
-     */
 
     /**
      * Constructs Promptbook from remote Promptbase URL
 
      * @returns PromptbookLibrary
      */
-    function createPromptbookLibraryFromUrl(url, options) {
+    function createLibraryFromUrl(url, options) {
         return __awaiter(this, void 0, void 0, function () {
             var _a, _b, isVerbose, _c, isLazyLoaded, library;
             var _this = this;
@@ -3586,7 +3540,7 @@
                 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 () {
+                        library = createLibraryFromPromise(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()));
@@ -3617,7 +3571,7 @@
      * @param promptbookSources
      * @returns PromptbookLibrary
      */
-    function createPromptbookSublibrary(library, predicate) {
+    function createSublibrary(library, predicate) {
         function listPromptbooks() {
             return __awaiter(this, void 0, void 0, function () {
                 var promptbooks;
@@ -3687,6 +3641,28 @@
         };
     }
 
+    /**
+     * Converts PromptbookLibrary to serialized JSON
+     *
+     * Note: Functions `libraryToJson` and `createLibraryFromJson` are complementary
+     */
+    function libraryToJson(library) {
+        return __awaiter(this, void 0, void 0, function () {
+            var promptbookUrls, promptbooks;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, library.listPromptbooks()];
+                    case 1:
+                        promptbookUrls = _a.sent();
+                        return [4 /*yield*/, Promise.all(promptbookUrls.map(function (url) { return library.getPromptbookByUrl(url); }))];
+                    case 2:
+                        promptbooks = _a.sent();
+                        return [2 /*return*/, promptbooks];
+                }
+            });
+        });
+    }
+
     /**
      * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
      *
@@ -4134,19 +4110,19 @@
     exports.PromptbookReferenceError = PromptbookReferenceError;
     exports.PromptbookSyntaxError = PromptbookSyntaxError;
     exports.SimplePromptInterfaceTools = SimplePromptInterfaceTools;
-    exports.SimplePromptbookLibrary = SimplePromptbookLibrary;
     exports.TemplateError = TemplateError;
     exports.UnexpectedError = UnexpectedError;
     exports.addUsage = addUsage;
     exports.assertsExecutionSuccessful = assertsExecutionSuccessful;
     exports.checkExpectations = checkExpectations;
+    exports.createLibraryFromJson = createLibraryFromJson;
+    exports.createLibraryFromPromise = createLibraryFromPromise;
+    exports.createLibraryFromUrl = createLibraryFromUrl;
     exports.createPromptbookExecutor = createPromptbookExecutor;
-    exports.createPromptbookLibraryFromPromise = createPromptbookLibraryFromPromise;
-    exports.createPromptbookLibraryFromSources = createPromptbookLibraryFromSources;
-    exports.createPromptbookLibraryFromUrl = createPromptbookLibraryFromUrl;
-    exports.createPromptbookSublibrary = createPromptbookSublibrary;
+    exports.createSublibrary = createSublibrary;
     exports.executionReportJsonToString = executionReportJsonToString;
     exports.isPassingExpectations = isPassingExpectations;
+    exports.libraryToJson = libraryToJson;
     exports.prepareKnowledgeFromMarkdown = prepareKnowledgeFromMarkdown;
     exports.prettifyPromptbookString = prettifyPromptbookString;
     exports.promptbookJsonToString = promptbookJsonToString;