@promptbook/openai 0.80.0 → 0.81.0-12

package/esm/typings/src/scrapers/pdf/register-constructor.d.ts

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
  *
  * @public exported from `@promptbook/pdf`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _PdfScraperRegistration: Registration;

package/esm/typings/src/scrapers/pdf/register-metadata.d.ts

@@ -19,6 +19,7 @@ export declare const pdfScraperMetadata: import("type-fest/source/readonly-deep"
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
  *
  * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _PdfScraperMetadataRegistration: Registration;

package/esm/typings/src/scrapers/website/register-constructor.d.ts

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
  *
  * @public exported from `@promptbook/website-crawler`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _WebsiteScraperRegistration: Registration;

package/esm/typings/src/scrapers/website/register-metadata.d.ts

@@ -19,6 +19,7 @@ export declare const websiteScraperMetadata: import("type-fest/source/readonly-d
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
  *
  * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _WebsiteScraperMetadataRegistration: Registration;

package/esm/typings/src/scripting/javascript/utils/preserve.d.ts

@@ -9,5 +9,6 @@ import type { really_any } from '../../../utils/organization/really_any';
  */
 export declare function preserve(func: (...params: ReadonlyArray<really_any>) => unknown): void;
 /**
+ * TODO: Probbably remove in favour of `keepImported`
  * TODO: !! [1] This maybe does memory leak
  */

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

@@ -1,5 +1,6 @@
 import type { TupleToUnion } from 'type-fest';
 import { RESERVED_PARAMETER_NAMES } from '../constants';
+import type { really_unknown } from '../utils/organization/really_unknown';
 /**
  * Semantic helper
  */
@@ -107,6 +108,13 @@ export type string_parameter_value = string;
  * @see https://ptbk.io/parameters
  */
 export type Parameters = Exclude<Record<string_parameter_name, string_parameter_value>, ReservedParameters>;
+/**
+ * Parameters to pass to execution of the pipeline
+ *
+ * Note: [🚉] This should be fully serializable as JSON
+ * @see https://ptbk.io/parameters
+ */
+export type InputParameters = Exclude<Record<string_parameter_name, really_unknown>, ReservedParameters>;
 /**
  * Semantic helper
  * Unique identifier of reserved parameter

package/esm/typings/src/utils/editable/types/PipelineEditableSerialized.d.ts

@@ -0,0 +1,27 @@
+import type { ErrorJson } from '../../../errors/utils/ErrorJson';
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
+import type { string_date_iso8601 } from '../../../types/typeAliases';
+/**
+ * Represents a single pipeline in PromptbookStudio
+ *
+ * This is simple extension of PipelineJson with additional metadata
+ * Note: There are two similar entities:
+ *       1) Type (interface) `PipelineEditableSerialized` which represents just data in database
+ *       2) Class `PipelineEditable` which implements `PipelineEditableSerialized` and adds error handling and editing capabilities
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export type PipelineEditableSerialized = PipelineJson & {
+    /**
+     * When was the pipeline created
+     */
+    readonly createdAt: string_date_iso8601;
+    /**
+     * When was the pipeline last modified
+     */
+    readonly updatedAt: string_date_iso8601 | null;
+    /**
+     * Known errors to transfer to new PipelineEditable
+     */
+    readonly knownErrors: Array<ErrorJson>;
+};

package/esm/typings/src/{conversion → utils/editable}/utils/removePipelineCommand.d.ts

@@ -1,5 +1,5 @@
-import type { CommandType } from '../../commands/_common/types/CommandType';
-import type { PipelineString } from '../../pipeline/PipelineString';
+import type { CommandType } from '../../../commands/_common/types/CommandType';
+import type { PipelineString } from '../../../pipeline/PipelineString';
 /**
  * Options for `removePipelineCommand`
  */
@@ -16,7 +16,7 @@ type RemovePipelineCommandOptions = {
 /**
  * Function `removePipelineCommand` will remove one command from pipeline string
  *
- * @public exported from `@promptbook/core` <- Note: [👖] This utility is so tightly interconnected with the Promptbook that it is not exported as util but in core
+ * @public exported from `@promptbook/editable`
  */
 export declare function removePipelineCommand(options: RemovePipelineCommandOptions): PipelineString;
 export {};

package/esm/typings/src/{conversion → utils/editable}/utils/renamePipelineParameter.d.ts

@@ -1,5 +1,5 @@
-import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
-import type { string_name } from '../../types/typeAliases';
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
+import type { string_name } from '../../../types/typeAliases';
 type RenameParameterOptions = {
     /**
      * Pipeline to search and replace for parameters
@@ -20,7 +20,7 @@ type RenameParameterOptions = {
  * In other words, it will find all parameters that are not used in the task itseld and all its dependencies
  *
  * @throws {PipelineLogicError} If the new parameter name is already used in the pipeline
- * @public exported from `@promptbook/core` <- Note: [👖] This utility is so tightly interconnected with the Promptbook that it is not exported as util but in core
+ * @public exported from `@promptbook/editable`
  */
 export declare function renamePipelineParameter(options: RenameParameterOptions): PipelineJson;
 export {};

package/esm/typings/src/{conversion → utils/editable}/utils/stringifyPipelineJson.d.ts

@@ -1,11 +1,11 @@
-import type { string_json } from '../../types/typeAliases';
+import type { string_json } from '../../../types/typeAliases';
 /**
  * Stringify the PipelineJson with proper formatting
  *
  * Note: [0] It can be used for more JSON types like whole collection of pipelines, single knowledge piece, etc.
  * Note: In contrast to JSON.stringify, this function ensures that **embedding index** is on single line
  *
- * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/editable`
  */
 export declare function stringifyPipelineJson<TType>(pipeline: TType): string_json<TType>;
 /**

package/esm/typings/src/utils/parameters/numberToString.d.ts

@@ -0,0 +1,7 @@
+import type { string_parameter_value } from '../../types/typeAliases';
+/**
+ * Format either small or big number
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function numberToString(value: number): string_parameter_value;

package/esm/typings/src/utils/parameters/{replaceParameters.d.ts → templateParameters.d.ts}

@@ -1,12 +1,16 @@
-import type { Parameters } from '../../types/typeAliases';
+import type { string_parameter_name } from '../../types/typeAliases';
 import type { string_template } from '../../types/typeAliases';
+import type { really_unknown } from '../organization/really_unknown';
 /**
  * Replaces parameters in template with values from parameters object
  *
+ * Note: This function is not places strings into string,
+ *       It's more complex and can handle this operation specifically for LLM models
+ *
  * @param template the template with parameters in {curly} braces
  * @param parameters the object with parameters
  * @returns the template with replaced parameters
  * @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
  * @public exported from `@promptbook/utils`
  */
-export declare function replaceParameters(template: string_template, parameters: Parameters): string;
+export declare function templateParameters(template: string_template, parameters: Record<string_parameter_name, really_unknown>): string;

package/esm/typings/src/utils/parameters/valueToString.d.ts

@@ -0,0 +1,17 @@
+import type { string_parameter_value } from '../../types/typeAliases';
+import type { really_unknown } from '../organization/really_unknown';
+/**
+ * Function `valueToString` will convert the given value to string
+ * This is useful and used in the `templateParameters` function
+ *
+ * Note: This function is not just calling `toString` method
+ *       It's more complex and can handle this conversion specifically for LLM models
+ *       See `VALUE_STRINGS`
+ *
+ * Note: There are 2 similar functions
+ * - `valueToString` converts value to string for LLM models as human-readable string
+ * - `asSerializable` converts value to string to preserve full information to be able to convert it back
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function valueToString(value: really_unknown): string_parameter_value;

package/esm/typings/src/utils/parameters/valueToString.test.d.ts

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

package/esm/typings/src/utils/serialization/asSerializable.d.ts

@@ -6,6 +6,10 @@ import type { really_any } from '../organization/really_any';
  * For example:
  * - `Date` objects will be converted to string
  *
+ * Note: There are 2 similar functions
+ * - `valueToString` converts value to string for LLM models as human-readable string
+ * - `asSerializable` converts value to string to preserve full information to be able to convert it back
+ *
  * @private Internal helper function
  */
 export declare function asSerializable(value: really_any): really_any;

package/esm/typings/src/utils/validators/filePath/isPathRoot.d.ts

@@ -0,0 +1,12 @@
+import type { string_dirname } from '../../../types/typeAliases';
+import type { string_filename } from '../../../types/typeAliases';
+/**
+ * Determines if the given path is a root path.
+ *
+ * Note: This does not check if the file exists only if the path is valid
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isPathRoot(value: string_dirname | string_filename): boolean;
+/**
+ * TODO: [🍏] Make for MacOS paths
+ */

package/esm/typings/src/utils/validators/filePath/isPathRoot.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🍏] Make for MacOS paths
+ */

package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts

@@ -7,3 +7,6 @@ import type { really_unknown } from '../../organization/really_unknown';
  * @public exported from `@promptbook/utils`
  */
 export declare function isValidFilePath(filename: really_unknown): filename is string_filename;
+/**
+ * TODO: [🍏] Implement for MacOs
+ */

package/esm/typings/src/version.d.ts

@@ -2,15 +2,22 @@ import type { string_semantic_version } from './types/typeAliases';
 /**
  * The version of the Book language
  *
+ * @generated
  * @see https://github.com/webgptorg/book
  */
 export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 /**
  * The version of the Promptbook engine
  *
+ * @generated
  * @see https://github.com/webgptorg/promptbook
  */
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
+/**
+ * @@@
+ *
+ * @generated
+ */
 export type string_promptbook_version = string_semantic_version;
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine

package/esm/typings/src/wizzard/$getCompiledBook.d.ts

@@ -0,0 +1,16 @@
+import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../pipeline/PipelineString';
+import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
+import type { string_filename } from '../types/typeAliases';
+import type { string_pipeline_url } from '../types/typeAliases';
+/**
+ * @see ./wizzard.ts `getPipeline` method
+ *
+ * @private usable through `ptbk run` and `@prompbook/wizzard`
+ */
+export declare function $getCompiledBook(tools: Required<Pick<ExecutionTools, 'fs' | 'fetch'>>, pipelineSource: string_filename | string_pipeline_url | PipelineString, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
+/**
+ * TODO: Write unit test
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/wizzard/wizzard.d.ts

@@ -0,0 +1,51 @@
+import { Promisable } from 'type-fest';
+import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PipelineExecutorResult } from '../execution/PipelineExecutorResult';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../pipeline/PipelineString';
+import type { TaskProgress } from '../types/TaskProgress';
+import type { InputParameters } from '../types/typeAliases';
+import type { string_filename } from '../types/typeAliases';
+import type { string_pipeline_url } from '../types/typeAliases';
+/**
+ * Look at `wizzard` for more details
+ *
+ * @private just for single instance
+ */
+declare class Wizzard {
+    /**
+     * @@@!!!!!!
+     */
+    execute(book: string_pipeline_url, inputParameters: InputParameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
+    private executionTools;
+    /**
+     * @@@!!!
+     *
+     * @param pipelineSource
+     */
+    getExecutionTools(): Promise<Required<Pick<ExecutionTools, 'fs' | 'fetch'>>>;
+    /**
+     * TODO: Make standalone function from this exported from node and used here and in `ptbk run`
+     * @@@!!!
+     *
+     * Strategies:
+     * 1) @@@!!!
+     * 2) @@@!!!
+     *
+     * @param pipelineSource
+     */
+    getCompiledBook(pipelineSource: string_filename | string_pipeline_url | PipelineString): Promise<PipelineJson>;
+}
+/**
+ * 🧙‍♂️ @@@
+ *
+ * @singleton
+ * @public exported from `@promptbook/wizzard`
+ */
+export declare const wizzard: Wizzard;
+export {};
+/**
+ * TODO: !!!!!! Mark in jsdoc as non-pure
+ * TODO: !!!!!! Add to readmes - one markdown here imported in all packages
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.80.0",
+    "version": "0.81.0-12",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,
@@ -54,7 +54,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.80.0"
+        "@promptbook/core": "0.81.0-12"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -14,15 +14,17 @@
     /**
      * The version of the Book language
      *
+     * @generated
      * @see https://github.com/webgptorg/book
      */
     var BOOK_LANGUAGE_VERSION = '1.0.0';
     /**
      * The version of the Promptbook engine
      *
+     * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.80.0-1';
+    var PROMPTBOOK_ENGINE_VERSION = '0.81.0-11';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -330,6 +332,26 @@
      * @private within the repository - too low-level in comparison with other `MAX_...`
      */
     var LOOP_LIMIT = 1000;
+    /**
+     * Strings to represent various values in the context of parameter values
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    var VALUE_STRINGS = {
+        empty: '(nothing; empty string)',
+        null: '(no value; null)',
+        undefined: '(unknown value; undefined)',
+        nan: '(not a number; NaN)',
+        infinity: '(infinity; ∞)',
+        negativeInfinity: '(negative infinity; -∞)',
+        unserializable: '(unserializable value)',
+    };
+    /**
+     * Small number limit
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    var SMALL_NUMBER = 0.001;
     // <- TODO: [🧜‍♂️]
     /**
      * @@@
@@ -483,7 +505,7 @@
                     if (!(error instanceof Error)) {
                         throw error;
                     }
-                    throw new UnexpectedError(spaceTrim__default["default"](function (block) { return "\n                            `".concat(name, "` is not serializable\n\n                            ").concat(block(error.toString()), "\n\n                            Additional message for `").concat(name, "`:\n                            ").concat(block(message || '(nothing)'), "\n                        "); }));
+                    throw new UnexpectedError(spaceTrim__default["default"](function (block) { return "\n                            `".concat(name, "` is not serializable\n\n                            ").concat(block(error.stack || error.message), "\n\n                            Additional message for `").concat(name, "`:\n                            ").concat(block(message || '(nothing)'), "\n                        "); }));
                 }
                 /*
                 TODO: [0] Is there some more elegant way to check circular references?
@@ -633,16 +655,94 @@
         return LimitReachedError;
     }(Error));
 
+    /**
+     * Format either small or big number
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    function numberToString(value) {
+        if (value === 0) {
+            return '0';
+        }
+        else if (Number.isNaN(value)) {
+            return VALUE_STRINGS.nan;
+        }
+        else if (value === Infinity) {
+            return VALUE_STRINGS.infinity;
+        }
+        else if (value === -Infinity) {
+            return VALUE_STRINGS.negativeInfinity;
+        }
+        for (var exponent = 0; exponent < 15; exponent++) {
+            var factor = Math.pow(10, exponent);
+            var valueRounded = Math.round(value * factor) / factor;
+            if (Math.abs(value - valueRounded) / value < SMALL_NUMBER) {
+                return valueRounded.toFixed(exponent);
+            }
+        }
+        return value.toString();
+    }
+
+    /**
+     * Function `valueToString` will convert the given value to string
+     * This is useful and used in the `templateParameters` function
+     *
+     * Note: This function is not just calling `toString` method
+     *       It's more complex and can handle this conversion specifically for LLM models
+     *       See `VALUE_STRINGS`
+     *
+     * Note: There are 2 similar functions
+     * - `valueToString` converts value to string for LLM models as human-readable string
+     * - `asSerializable` converts value to string to preserve full information to be able to convert it back
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    function valueToString(value) {
+        try {
+            if (value === '') {
+                return VALUE_STRINGS.empty;
+            }
+            else if (value === null) {
+                return VALUE_STRINGS.null;
+            }
+            else if (value === undefined) {
+                return VALUE_STRINGS.undefined;
+            }
+            else if (typeof value === 'string') {
+                return value;
+            }
+            else if (typeof value === 'number') {
+                return numberToString(value);
+            }
+            else if (value instanceof Date) {
+                return value.toISOString();
+            }
+            else {
+                return JSON.stringify(value);
+            }
+        }
+        catch (error) {
+            if (!(error instanceof Error)) {
+                throw error;
+            }
+            console.error(error);
+            return VALUE_STRINGS.unserializable;
+        }
+    }
+
     /**
      * Replaces parameters in template with values from parameters object
      *
+     * Note: This function is not places strings into string,
+     *       It's more complex and can handle this operation specifically for LLM models
+     *
      * @param template the template with parameters in {curly} braces
      * @param parameters the object with parameters
      * @returns the template with replaced parameters
      * @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
      * @public exported from `@promptbook/utils`
      */
-    function replaceParameters(template, parameters) {
+    function templateParameters(template, parameters) {
         var e_1, _a;
         try {
             for (var _b = __values(Object.entries(parameters)), _c = _b.next(); !_c.done; _c = _b.next()) {
@@ -668,7 +768,7 @@
         var loopLimit = LOOP_LIMIT;
         var _loop_1 = function () {
             if (loopLimit-- < 0) {
-                throw new LimitReachedError('Loop limit reached during parameters replacement in `replaceParameters`');
+                throw new LimitReachedError('Loop limit reached during parameters replacement in `templateParameters`');
             }
             var precol = match.groups.precol;
             var parameterName = match.groups.parameterName;
@@ -685,7 +785,7 @@
             if (parameterValue === undefined) {
                 throw new PipelineExecutionError("Parameter `{".concat(parameterName, "}` is not defined"));
             }
-            parameterValue = parameterValue.toString();
+            parameterValue = valueToString(parameterValue);
             if (parameterValue.includes('\n') && /^\s*\W{0,3}\s*$/.test(precol)) {
                 parameterValue = parameterValue
                     .split('\n')
@@ -1669,7 +1769,7 @@
                                     type: 'json_object',
                                 };
                             }
-                            rawPromptContent = replaceParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
+                            rawPromptContent = templateParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
                             rawRequest = __assign(__assign({}, modelSettings), { messages: __spreadArray(__spreadArray([], __read((modelRequirements.systemMessage === undefined
                                     ? []
                                     : [
@@ -1765,7 +1865,7 @@
                                 // <- TODO: [🈁] Use `seed` here AND/OR use is `isDeterministic` for entire execution tools
                                 // <- Note: [🧆]
                             };
-                            rawPromptContent = replaceParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
+                            rawPromptContent = templateParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
                             rawRequest = __assign(__assign({}, modelSettings), { prompt: rawPromptContent, user: (_a = this.options.userId) === null || _a === void 0 ? void 0 : _a.toString() });
                             start = $getCurrentDate();
                             if (this.options.isVerbose) {
@@ -1837,7 +1937,7 @@
                                 throw new PipelineExecutionError('Use embed only for EMBEDDING variant');
                             }
                             modelName = modelRequirements.modelName || this.getDefaultEmbeddingModel().modelName;
-                            rawPromptContent = replaceParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
+                            rawPromptContent = templateParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
                             rawRequest = {
                                 input: rawPromptContent,
                                 model: modelName,
@@ -2007,7 +2107,7 @@
                                 }
                                 finally { if (e_1) throw e_1.error; }
                             }
-                            rawPromptContent = replaceParameters(content, __assign(__assign({}, parameters), { modelName: 'assistant' }));
+                            rawPromptContent = templateParameters(content, __assign(__assign({}, parameters), { modelName: 'assistant' }));
                             rawRequest = {
                                 // TODO: [👨‍👨‍👧‍👧] ...modelSettings,
                                 // TODO: [👨‍👨‍👧‍👧][🧠] What about system message for assistants, does it make sence - combination of OpenAI assistants with Promptbook Personas
@@ -2308,6 +2408,7 @@
      * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
      *
      * @public exported from `@promptbook/openai`
+     * @public exported from `@promptbook/wizzard`
      * @public exported from `@promptbook/cli`
      */
     var _OpenAiRegistration = $llmToolsRegister.register(createOpenAiExecutionTools);
@@ -2317,6 +2418,7 @@
      * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
      *
      * @public exported from `@promptbook/openai`
+     * @public exported from `@promptbook/wizzard`
      * @public exported from `@promptbook/cli`
      */
     var _OpenAiAssistantRegistration = $llmToolsRegister.register(createOpenAiAssistantExecutionTools);