@promptbook/cli 0.52.0-2 → 0.52.0-25

package/esm/typings/execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionTools.d.ts

@@ -0,0 +1,35 @@
+import type { Prompt } from '../../../../types/Prompt';
+import type { AvailableModel, LlmExecutionTools } from '../../../LlmExecutionTools';
+import type { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
+/**
+ * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
+ *
+ * @see https://github.com/webgptorg/promptbook#multiple-server
+ */
+export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
+    /**
+     * Array of execution tools in order of priority
+     */
+    private llmExecutionTools;
+    /**
+     * Gets array of execution tools in order of priority
+     */
+    constructor(...llmExecutionTools: Array<LlmExecutionTools>);
+    /**
+     * Calls the best available chat model
+     */
+    gptChat(prompt: Prompt): Promise<PromptChatResult>;
+    /**
+     * Calls the best available completion model
+     */
+    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    /**
+     * Calls the best available model
+     */
+    private gptCommon;
+    /**
+     * List all available models that can be used
+     * This liost is a combination of all available models from all execution tools
+     */
+    listModels(): Promise<Array<AvailableModel>>;
+}

package/esm/typings/execution/plugins/llm-execution-tools/multiple/MultipleLlmExecutionToolsOptions.d.ts

@@ -0,0 +1,23 @@
+import type { client_id, string_uri } from '../../../../types/typeAliases';
+import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+/**
+ * Options for MultipleLlmExecutionTools
+ */
+export type MultipleLlmExecutionToolsOptions = CommonExecutionToolsOptions & {
+    /**
+     * URL of the multiple PROMPTBOOK server
+     * On this server will be connected to the socket.io server
+     */
+    readonly multipleUrl: URL;
+    /**
+     * Path for the Socket.io server to listen
+     *
+     * @default '/socket.io'
+     * @example '/promptbook/socket.io'
+     */
+    readonly path: string_uri;
+    /**
+     * Your client ID
+     */
+    readonly clientId: client_id;
+};

package/esm/typings/execution/plugins/llm-execution-tools/multiple/playground/playground.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env ts-node
+export {};

package/esm/typings/execution/plugins/script-execution-tools/javascript/JavascriptEvalExecutionTools.d.ts

@@ -8,7 +8,7 @@ import { JavascriptExecutionToolsOptions } from './JavascriptExecutionToolsOptio
  */
 export declare class JavascriptEvalExecutionTools implements ScriptExecutionTools {
     private readonly options;
-    constructor(options: JavascriptExecutionToolsOptions);
+    constructor(options?: JavascriptExecutionToolsOptions);
     /**
      * Executes a JavaScript
      */

package/esm/typings/execution/plugins/script-execution-tools/javascript/JavascriptExecutionTools.d.ts

@@ -1,20 +1,7 @@
-import { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../../../ScriptExecutionTools';
-import { JavascriptExecutionToolsOptions } from './JavascriptExecutionToolsOptions';
+import { JavascriptEvalExecutionTools } from './JavascriptEvalExecutionTools';
 /**
- * ScriptExecutionTools for JavaScript implemented via vm2
+ * Placeholder for better implementation of JavascriptExecutionTools - some propper sandboxing
  *
- * Warning: This is not implemented yet
- */
-export declare class JavascriptExecutionTools implements ScriptExecutionTools {
-    private readonly options;
-    constructor(options: JavascriptExecutionToolsOptions);
-    /**
-     * Executes a JavaScript
-     */
-    execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
-}
-/**
- * TODO: !! Pass isVerbose to constructor and use it
- * TODO: !! Probbably make some common util createStatementToEvaluate
- * TODO: !! Implement via vm2
+ * @alias JavascriptExecutionTools
  */
+export declare const JavascriptExecutionTools: typeof JavascriptEvalExecutionTools;

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

@@ -1,14 +1,46 @@
+import { string_folder_path } from '../../types/typeAliases';
 import { PromptbookLibrary } from '../PromptbookLibrary';
+/**
+ * Options for `createPromptbookLibraryFromDirectory` function
+ */
+type CreatePromptbookLibraryFromDirectoryOptions = {
+    /**
+     * If true, the directory is searched recursively for promptbooks
+     *
+     * @default true
+     */
+    isRecursive?: boolean;
+    /**
+     * 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 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
  */
-export declare function createPromptbookLibraryFromDirectory(): PromptbookLibrary;
+export declare function createPromptbookLibraryFromDirectory(path: string_folder_path, options?: CreatePromptbookLibraryFromDirectoryOptions): Promise<PromptbookLibrary>;
+export {};
 /***
- * TODO: [🍓][🚯] !!! Add to README and samples + maybe make `@promptbook/library` package
+ * 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: [1] Using require(just('fs/promises')) to allow
+ *     the `@promptbook/core` work for both Node.js and browser environments
  */

package/esm/typings/library/constructors/createPromptbookLibraryFromDirectory.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -14,11 +14,11 @@ import { PromptbookLibrary } from '../PromptbookLibrary';
  * 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`
  *
  * @param promptbookSourcesPromiseOrFactory
  * @returns PromptbookLibrary
- *
- * @deprecated Consider using `createPromptbookLibraryFromUrl` or `createPromptbookLibraryFromDirectory`
+ * @private Just internal tool for other constructor functions
  */
 export declare function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson | PromptbookString>> | (() => Promise<Array<PromptbookJson | PromptbookString>>)): PromptbookLibrary;
 /***

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,7 @@
+/**
+ * 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/cli",
-    "version": "0.52.0-2",
+    "version": "0.52.0-25",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -38,8 +38,8 @@
         "commander": "12.0.0",
         "glob-promise": "6.0.5",
         "prettier": "2.8.1",
-        "spacetrim": "0.11.25",
-        "waitasecond": "1.11.69"
+        "spacetrim": "0.11.27",
+        "waitasecond": "1.11.71"
     },
     "funding": [
         {
@@ -52,7 +52,7 @@
         }
     ],
     "peerDependencies": {
-        "@promptbook/core": "0.52.0-2"
+        "@promptbook/core": "0.52.0-25"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/index.umd.js

@@ -1,6 +1,6 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('colors'), require('commander'), require('fs/promises'), require('glob-promise'), require('spacetrim'), require('waitasecond'), require('prettier'), require('prettier/parser-html'), require('moment')) :
-    typeof define === 'function' && define.amd ? define(['exports', 'colors', 'commander', 'fs/promises', 'glob-promise', 'spacetrim', 'waitasecond', 'prettier', 'prettier/parser-html', 'moment'], factory) :
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('colors'), require('commander'), require('fs/promises'), require('glob-promise'), require('spacetrim'), require('waitasecond'), require('prettier'), require('prettier/parser-html')) :
+    typeof define === 'function' && define.amd ? define(['exports', 'colors', 'commander', 'fs/promises', 'glob-promise', 'spacetrim', 'waitasecond', 'prettier', 'prettier/parser-html'], factory) :
     (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["promptbook-cli"] = {}, global.colors, global.commander, global.promises, global.glob, global.spacetrim, global.waitasecond, global.prettier, global.parserHtml));
 })(this, (function (exports, colors, commander, promises, glob, spacetrim, waitasecond, prettier, parserHtml) { 'use strict';
 
@@ -146,7 +146,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.52.0-1';
+    var PROMPTBOOK_VERSION = '0.52.0-24';
 
     /**
      * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
@@ -755,34 +755,19 @@
     })(Error));
 
     /**
-     * This error indicates errors during the execution of the promptbook
-     */
-    /** @class */ ((function (_super) {
-        __extends(PromptbookExecutionError, _super);
-        function PromptbookExecutionError(message) {
-            var _this = _super.call(this, message) || this;
-            _this.name = 'PromptbookExecutionError';
-            Object.setPrototypeOf(_this, PromptbookExecutionError.prototype);
-            return _this;
-        }
-        return PromptbookExecutionError;
-    })(Error));
-
-    /**
-     * This error occurs when some expectation is not met in the execution of the pipeline
+     * This error occurs during the parameter replacement in the template
      *
-     * @private Always catched and rethrown as `PromptbookExecutionError`
-     * Note: This is a kindof subtype of PromptbookExecutionError
+     * Note: This is a kindof subtype of PromptbookExecutionError because it occurs during the execution of the pipeline
      */
     /** @class */ ((function (_super) {
-        __extends(ExpectError, _super);
-        function ExpectError(message) {
+        __extends(TemplateError, _super);
+        function TemplateError(message) {
             var _this = _super.call(this, message) || this;
-            _this.name = 'ExpectError';
-            Object.setPrototypeOf(_this, ExpectError.prototype);
+            _this.name = 'TemplateError';
+            Object.setPrototypeOf(_this, TemplateError.prototype);
             return _this;
         }
-        return ExpectError;
+        return TemplateError;
     })(Error));
 
     var defaultDiacriticsRemovalMap = [
@@ -1037,54 +1022,6 @@
         });
     }
 
-    /**
-     * This error occurs during the parameter replacement in the template
-     *
-     * Note: This is a kindof subtype of PromptbookExecutionError because it occurs during the execution of the pipeline
-     */
-    /** @class */ ((function (_super) {
-        __extends(TemplateError, _super);
-        function TemplateError(message) {
-            var _this = _super.call(this, message) || this;
-            _this.name = 'TemplateError';
-            Object.setPrototypeOf(_this, TemplateError.prototype);
-            return _this;
-        }
-        return TemplateError;
-    })(Error));
-
-    /**
-     * Prettify the html code
-     *
-     * @param content raw html code
-     * @returns formatted html code
-     */
-    function prettifyMarkdown(content) {
-        try {
-            return prettier.format(content, {
-                parser: 'markdown',
-                plugins: [parserHtml__default["default"]],
-                // TODO: DRY - make some import or auto-copy of .prettierrc
-                endOfLine: 'lf',
-                tabWidth: 4,
-                singleQuote: true,
-                trailingComma: 'all',
-                arrowParens: 'always',
-                printWidth: 120,
-                htmlWhitespaceSensitivity: 'ignore',
-                jsxBracketSameLine: false,
-                bracketSpacing: true,
-            });
-        }
-        catch (error) {
-            console.error('There was an error with prettifying the markdown, using the original as the fallback', {
-                error: error,
-                html: content,
-            });
-            return content;
-        }
-    }
-
     /**
      * Removes Markdown formatting tags from a string.
      *
@@ -1814,6 +1751,38 @@
         return content.replace(heading, "<!--".concat(sectionName, "-->\n").concat(warningLine, "\n").concat(sectionContent, "\n<!--/").concat(sectionName, "-->\n\n").concat(heading));
     }
 
+    /**
+     * Prettify the html code
+     *
+     * @param content raw html code
+     * @returns formatted html code
+     */
+    function prettifyMarkdown(content) {
+        try {
+            return prettier.format(content, {
+                parser: 'markdown',
+                plugins: [parserHtml__default["default"]],
+                // TODO: DRY - make some import or auto-copy of .prettierrc
+                endOfLine: 'lf',
+                tabWidth: 4,
+                singleQuote: true,
+                trailingComma: 'all',
+                arrowParens: 'always',
+                printWidth: 120,
+                htmlWhitespaceSensitivity: 'ignore',
+                jsxBracketSameLine: false,
+                bracketSpacing: true,
+            });
+        }
+        catch (error) {
+            console.error('There was an error with prettifying the markdown, using the original as the fallback', {
+                error: error,
+                html: content,
+            });
+            return content;
+        }
+    }
+
     /**
      * Prettyfies Promptbook string and adds Mermaid graph
      */