@promptbook/utils 0.80.0 → 0.81.0-12

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/utils",
-    "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,

package/umd/index.umd.js

@@ -12,20 +12,86 @@
     /**
      * 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
      */
 
+    /**
+     * Name for the Promptbook
+     *
+     * TODO: [🗽] Unite branding and make single place for it
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var NAME = "Promptbook";
+    /**
+     * Email of the responsible person
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var ADMIN_EMAIL = 'me@pavolhejny.com';
+    /**
+     * Name of the responsible person for the Promptbook on GitHub
+     *
+     * @public exported from `@promptbook/core`
+     */
+    var ADMIN_GITHUB_NAME = 'hejny';
+    // <- TODO: [🧠] Better system for generator warnings - not always "code" and "by `@promptbook/cli`"
+    /**
+     * The maximum number of iterations for a loops
+     *
+     * @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: [🧜‍♂️]
+    /**
+     * @@@
+     *
+     * @public exported from `@promptbook/core`
+     */
+    Object.freeze({
+        delimiter: ',',
+        quoteChar: '"',
+        newline: '\n',
+        skipEmptyLines: true,
+    });
+    /**
+     * Note: [💞] Ignore a discrepancy between file name and entity name
+     * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
+     */
+
     /*! *****************************************************************************
     Copyright (c) Microsoft Corporation.
 
@@ -145,50 +211,6 @@
         return to.concat(ar || Array.prototype.slice.call(from));
     }
 
-    /**
-     * Name for the Promptbook
-     *
-     * TODO: [🗽] Unite branding and make single place for it
-     *
-     * @public exported from `@promptbook/core`
-     */
-    var NAME = "Promptbook";
-    /**
-     * Email of the responsible person
-     *
-     * @public exported from `@promptbook/core`
-     */
-    var ADMIN_EMAIL = 'me@pavolhejny.com';
-    /**
-     * Name of the responsible person for the Promptbook on GitHub
-     *
-     * @public exported from `@promptbook/core`
-     */
-    var ADMIN_GITHUB_NAME = 'hejny';
-    // <- TODO: [🧠] Better system for generator warnings - not always "code" and "by `@promptbook/cli`"
-    /**
-     * The maximum number of iterations for a loops
-     *
-     * @private within the repository - too low-level in comparison with other `MAX_...`
-     */
-    var LOOP_LIMIT = 1000;
-    // <- TODO: [🧜‍♂️]
-    /**
-     * @@@
-     *
-     * @public exported from `@promptbook/core`
-     */
-    Object.freeze({
-        delimiter: ',',
-        quoteChar: '"',
-        newline: '\n',
-        skipEmptyLines: true,
-    });
-    /**
-     * Note: [💞] Ignore a discrepancy between file name and entity name
-     * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
-     */
-
     /**
      * Make error report URL for the given error
      *
@@ -313,21 +335,44 @@
         if (typeof filename !== 'string') {
             return false;
         }
+        if (filename.split('\n').length > 1) {
+            return false;
+        }
+        if (filename.split(' ').length >
+            5 /* <- TODO: [🧠][🈷] Make some better non-arbitrary way how to distinct filenames from informational texts */) {
+            return false;
+        }
         var filenameSlashes = filename.split('\\').join('/');
         // Absolute Unix path: /hello.txt
         if (/^(\/)/i.test(filenameSlashes)) {
+            // console.log(filename, 'Absolute Unix path: /hello.txt');
             return true;
         }
         // Absolute Windows path: /hello.txt
         if (/^([A-Z]{1,2}:\/?)\//i.test(filenameSlashes)) {
+            // console.log(filename, 'Absolute Windows path: /hello.txt');
             return true;
         }
         // Relative path: ./hello.txt
         if (/^(\.\.?\/)+/i.test(filenameSlashes)) {
+            // console.log(filename, 'Relative path: ./hello.txt');
+            return true;
+        }
+        // Allow paths like foo/hello
+        if (/^[^/]+\/[^/]+/i.test(filenameSlashes)) {
+            // console.log(filename, 'Allow paths like foo/hello');
+            return true;
+        }
+        // Allow paths like hello.book
+        if (/^[^/]+\.[^/]+$/i.test(filenameSlashes)) {
+            // console.log(filename, 'Allow paths like hello.book');
             return true;
         }
         return false;
     }
+    /**
+     * TODO: [🍏] Implement for MacOs
+     */
 
     /**
      * Tests if given string is valid URL.
@@ -842,7 +887,7 @@
             if (!(error instanceof Error)) {
                 throw error;
             }
-            throw new ParseError(spaceTrim$1.spaceTrim(function (block) { return "\n                    Can not extract variables from the script\n\n                    ".concat(block(error.toString()), "}\n\n\n                    Found variables:\n\n                    ").concat(Array.from(variables)
+            throw new ParseError(spaceTrim$1.spaceTrim(function (block) { return "\n                    Can not extract variables from the script\n                    ".concat(block(error.stack || error.message), "\n\n                    Found variables:\n                    ").concat(Array.from(variables)
                 .map(function (variableName, i) { return "".concat(i + 1, ") ").concat(variableName); })
                 .join('\n'), "\n\n\n                    The script:\n\n                    ```javascript\n                    ").concat(block(originalScript), "\n                    ```\n                "); }));
         }
@@ -1710,6 +1755,34 @@
         return parameterNames;
     }
 
+    /**
+     * 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();
+    }
+
     /**
      * Freezes the given object and all its nested objects recursively
      *
@@ -1838,7 +1911,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?
@@ -1972,16 +2045,66 @@
      * Note: [💞] Ignore a discrepancy between file name and entity name
      */
 
+    /**
+     * 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()) {
@@ -2007,7 +2130,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;
@@ -2024,7 +2147,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')
@@ -2163,7 +2286,7 @@
      */
     function clonePipeline(pipeline) {
         // Note: Not using spread operator (...) because @@@
-        var pipelineUrl = pipeline.pipelineUrl, sourceFile = pipeline.sourceFile, title = pipeline.title, bookVersion = pipeline.bookVersion, description = pipeline.description, formfactorName = pipeline.formfactorName, parameters = pipeline.parameters, tasks = pipeline.tasks, knowledgeSources = pipeline.knowledgeSources, knowledgePieces = pipeline.knowledgePieces, personas = pipeline.personas, preparations = pipeline.preparations;
+        var pipelineUrl = pipeline.pipelineUrl, sourceFile = pipeline.sourceFile, title = pipeline.title, bookVersion = pipeline.bookVersion, description = pipeline.description, formfactorName = pipeline.formfactorName, parameters = pipeline.parameters, tasks = pipeline.tasks, knowledgeSources = pipeline.knowledgeSources, knowledgePieces = pipeline.knowledgePieces, personas = pipeline.personas, preparations = pipeline.preparations, sources = pipeline.sources;
         return {
             pipelineUrl: pipelineUrl,
             sourceFile: sourceFile,
@@ -2177,6 +2300,7 @@
             knowledgePieces: knowledgePieces,
             personas: personas,
             preparations: preparations,
+            sources: sources,
         };
     }
     /**
@@ -2450,6 +2574,25 @@
         return /^.+@.+\..+$/.test(email);
     }
 
+    /**
+     * 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`
+     */
+    function isPathRoot(value) {
+        if (value === '/') {
+            return true;
+        }
+        if (/^[A-Z]:\\$/i.test(value)) {
+            return true;
+        }
+        return false;
+    }
+    /**
+     * TODO: [🍏] Make for MacOS paths
+     */
+
     /**
      * @@@
      *
@@ -2573,9 +2716,6 @@
         if (!url.startsWith('https://')) {
             return false;
         }
-        if (!(url.endsWith('.book.md') || url.endsWith('.book') || url.endsWith('.book.md') || url.endsWith('.ptbk'))) {
-            return false;
-        }
         if (url.includes('#')) {
             // TODO: [🐠]
             return false;
@@ -2614,6 +2754,8 @@
     exports.DIACRITIC_VARIANTS_LETTERS = DIACRITIC_VARIANTS_LETTERS;
     exports.LINES_PER_STANDARD_PAGE = LINES_PER_STANDARD_PAGE;
     exports.PROMPTBOOK_ENGINE_VERSION = PROMPTBOOK_ENGINE_VERSION;
+    exports.SMALL_NUMBER = SMALL_NUMBER;
+    exports.VALUE_STRINGS = VALUE_STRINGS;
     exports.capitalize = capitalize;
     exports.checkSerializableAsJson = checkSerializableAsJson;
     exports.clonePipeline = clonePipeline;
@@ -2633,6 +2775,7 @@
     exports.forEachAsync = forEachAsync;
     exports.intersection = intersection;
     exports.isHostnameOnPrivateNetwork = isHostnameOnPrivateNetwork;
+    exports.isPathRoot = isPathRoot;
     exports.isSerializableAsJson = isSerializableAsJson;
     exports.isUrlOnPrivateNetwork = isUrlOnPrivateNetwork;
     exports.isValidEmail = isValidEmail;
@@ -2653,6 +2796,7 @@
     exports.normalizeTo_camelCase = normalizeTo_camelCase;
     exports.normalizeTo_snake_case = normalizeTo_snake_case;
     exports.normalizeWhitespaces = normalizeWhitespaces;
+    exports.numberToString = numberToString;
     exports.orderJson = orderJson;
     exports.parseKeywords = parseKeywords;
     exports.parseKeywordsFromString = parseKeywordsFromString;
@@ -2661,16 +2805,17 @@
     exports.removeEmojis = removeEmojis;
     exports.removeQuotes = removeQuotes;
     exports.renderPromptbookMermaid = renderPromptbookMermaid;
-    exports.replaceParameters = replaceParameters;
     exports.searchKeywords = searchKeywords;
     exports.serializeError = serializeError;
     exports.spaceTrim = spaceTrim;
     exports.splitIntoSentences = splitIntoSentences;
+    exports.templateParameters = templateParameters;
     exports.titleToName = titleToName;
     exports.trimCodeBlock = trimCodeBlock;
     exports.trimEndOfCodeBlock = trimEndOfCodeBlock;
     exports.union = union;
     exports.unwrapResult = unwrapResult;
+    exports.valueToString = valueToString;
 
     Object.defineProperty(exports, '__esModule', { value: true });