@promptbook/fake-llm 0.61.0-9 → 0.61.0

package/README.md

@@ -87,7 +87,7 @@ File `write-website-content.ptbk.md`:
 > -   PROMPTBOOK VERSION 0.0.1
 > -   INPUT  PARAM `{rawTitle}` Automatically suggested a site name or empty text
 > -   INPUT  PARAM `{rawAssigment}` Automatically generated site entry from image recognition
-> -   OUTPUT PARAM `{content}` Web content
+> -   OUTPUT PARAM `{websiteContent}` Web content
 > -   OUTPUT PARAM `{keywords}` Keywords
 >
 > ## 👤 Specifying the assigment
@@ -246,7 +246,7 @@ File `write-website-content.ptbk.md`:
 > {contentBody}
 > ```
 >
-> `-> {content}`
+> `-> {websiteContent}`
 
 
 
@@ -286,7 +286,7 @@ flowchart LR
       templateCombineTheBeginning--"{contentBeginning}"-->templateCombineTheContent
       templateWriteTheContent--"{contentBody}"-->templateCombineTheContent
 
-      templateCombineTheContent--"{content}"-->output
+      templateCombineTheContent--"{websiteContent}"-->output
       output((Output)):::output
 
       classDef input color: grey;

package/esm/index.es.js

@@ -32,6 +32,17 @@ function __extends(d, b) {
     d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
 }
 
+var __assign = function() {
+    __assign = Object.assign || function __assign(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+
 function __awaiter(thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -99,37 +110,97 @@ function __read(o, n) {
     return ar;
 }
 
+/**
+ * @@@
+ */
+function deepClone(objectValue) {
+    return JSON.parse(JSON.stringify(objectValue));
+    /*
+    TODO: [🧠] Is there a better implementation?
+    > const propertyNames = Object.getOwnPropertyNames(objectValue);
+    > for (const propertyName of propertyNames) {
+    >     const value = (objectValue as really_any)[propertyName];
+    >     if (value && typeof value === 'object') {
+    >         deepClone(value);
+    >     }
+    > }
+    > return Object.assign({}, objectValue);
+    */
+}
+/**
+ * TODO: [🔼] Export from `@promptbook/utils`
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
+ */
+
+/**
+ * @@@
+ *
+ * @returns The same object as the input, but deeply frozen
+ *
+ * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ */
+function deepFreeze(objectValue) {
+    var e_1, _a;
+    var propertyNames = Object.getOwnPropertyNames(objectValue);
+    try {
+        for (var propertyNames_1 = __values(propertyNames), propertyNames_1_1 = propertyNames_1.next(); !propertyNames_1_1.done; propertyNames_1_1 = propertyNames_1.next()) {
+            var propertyName = propertyNames_1_1.value;
+            var value = objectValue[propertyName];
+            if (value && typeof value === 'object') {
+                deepFreeze(value);
+            }
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (propertyNames_1_1 && !propertyNames_1_1.done && (_a = propertyNames_1.return)) _a.call(propertyNames_1);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    return Object.freeze(objectValue);
+}
+/**
+ * TODO: [🔼] Export from `@promptbook/utils`
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
+ */
+
+/**
+ * @@@
+ *
+ * TODO: [🔼] Export with addUsage
+ */
+var ZERO_USAGE = deepFreeze({
+    price: { value: 0 },
+    input: {
+        tokensCount: { value: 0 },
+        charactersCount: { value: 0 },
+        wordsCount: { value: 0 },
+        sentencesCount: { value: 0 },
+        linesCount: { value: 0 },
+        paragraphsCount: { value: 0 },
+        pagesCount: { value: 0 },
+    },
+    output: {
+        tokensCount: { value: 0 },
+        charactersCount: { value: 0 },
+        wordsCount: { value: 0 },
+        sentencesCount: { value: 0 },
+        linesCount: { value: 0 },
+        paragraphsCount: { value: 0 },
+        pagesCount: { value: 0 },
+    },
+});
 /**
  * Function `addUsage` will add multiple usages into one
  *
- * Note: If you provide 0 values, it returns void usage
+ * Note: If you provide 0 values, it returns ZERO_USAGE
  */
 function addUsage() {
     var usageItems = [];
     for (var _i = 0; _i < arguments.length; _i++) {
         usageItems[_i] = arguments[_i];
     }
-    var initialStructure = {
-        price: { value: 0 },
-        input: {
-            tokensCount: { value: 0 },
-            charactersCount: { value: 0 },
-            wordsCount: { value: 0 },
-            sentencesCount: { value: 0 },
-            linesCount: { value: 0 },
-            paragraphsCount: { value: 0 },
-            pagesCount: { value: 0 },
-        },
-        output: {
-            tokensCount: { value: 0 },
-            charactersCount: { value: 0 },
-            wordsCount: { value: 0 },
-            sentencesCount: { value: 0 },
-            linesCount: { value: 0 },
-            paragraphsCount: { value: 0 },
-            pagesCount: { value: 0 },
-        },
-    };
     return usageItems.reduce(function (acc, item) {
         var e_1, _a, e_2, _b;
         var _c;
@@ -187,7 +258,7 @@ function addUsage() {
             finally { if (e_2) throw e_2.error; }
         }
         return acc;
-    }, initialStructure);
+    }, deepClone(ZERO_USAGE));
 }
 
 /**
@@ -199,6 +270,167 @@ function getCurrentIsoDate() {
     return new Date().toISOString();
 }
 
+/**
+ * The maximum number of iterations for a loops
+ */
+var LOOP_LIMIT = 1000;
+/**
+ * The maximum number of iterations for a loops which adds characters one by one
+ */
+var CHARACTER_LOOP_LIMIT = 100000;
+/**
+ * Nonce which is used for replacing things in strings
+ */
+var REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
+/**
+ * The names of the parameters that are reserved for special purposes
+ */
+deepFreeze([
+    'content',
+    'context',
+    'knowledge',
+    'samples',
+    'modelName',
+    'currentDate',
+    // <- TODO: Add more like 'date', 'modelName',...
+    // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
+]);
+/**
+ * @@@
+ */
+var RESERVED_PARAMETER_MISSING_VALUE = 'MISSING-' + REPLACING_NONCE;
+/**
+ * @@@
+ */
+var RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
+/*
+TODO: !!! Just testing false-negative detection of [🟡][🟢][🔵][⚪] leak
+*/
+// [🟡][🟢][🔵][⚪]
+/**
+ * TODO: [🔼] Export all to core
+ */
+
+/**
+ * This error type indicates that some limit was reached
+ */
+var LimitReachedError = /** @class */ (function (_super) {
+    __extends(LimitReachedError, _super);
+    function LimitReachedError(message) {
+        var _this = _super.call(this, message) || this;
+        _this.name = 'LimitReachedError';
+        Object.setPrototypeOf(_this, LimitReachedError.prototype);
+        return _this;
+    }
+    return LimitReachedError;
+}(Error));
+
+/**
+ * This error indicates errors during the execution of the pipeline
+ */
+var PipelineExecutionError = /** @class */ (function (_super) {
+    __extends(PipelineExecutionError, _super);
+    function PipelineExecutionError(message) {
+        var _this = _super.call(this, message) || this;
+        _this.name = 'PipelineExecutionError';
+        Object.setPrototypeOf(_this, PipelineExecutionError.prototype);
+        return _this;
+    }
+    return PipelineExecutionError;
+}(Error));
+
+/**
+ * This error type indicates that the error should not happen and its last check before crashing with some other error
+ */
+var UnexpectedError = /** @class */ (function (_super) {
+    __extends(UnexpectedError, _super);
+    function UnexpectedError(message) {
+        var _this = _super.call(this, spaceTrim(function (block) { return "\n                    ".concat(block(message), "\n\n                    Note: This error should not happen.\n                    It's probbably a bug in the pipeline collection\n\n                    Please report issue:\n                    https://github.com/webgptorg/promptbook/issues\n\n                    Or contact us on me@pavolhejny.com\n\n                "); })) || this;
+        _this.name = 'UnexpectedError';
+        Object.setPrototypeOf(_this, UnexpectedError.prototype);
+        return _this;
+    }
+    return UnexpectedError;
+}(Error));
+
+/**
+ * Replaces parameters in template with values from parameters object
+ *
+ * @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
+ */
+function replaceParameters(template, parameters) {
+    var e_1, _a;
+    try {
+        for (var _b = __values(Object.entries(parameters)), _c = _b.next(); !_c.done; _c = _b.next()) {
+            var _d = __read(_c.value, 2), parameterName = _d[0], parameterValue = _d[1];
+            if (parameterValue === RESERVED_PARAMETER_MISSING_VALUE) {
+                throw new UnexpectedError("Parameter {".concat(parameterName, "} has missing value"));
+            }
+            else if (parameterValue === RESERVED_PARAMETER_RESTRICTED) {
+                // TODO: [🍵]
+                throw new UnexpectedError("Parameter {".concat(parameterName, "} is restricted to use"));
+            }
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    var replacedTemplate = template;
+    var match;
+    var loopLimit = LOOP_LIMIT;
+    var _loop_1 = function () {
+        if (loopLimit-- < 0) {
+            throw new LimitReachedError('Loop limit reached during parameters replacement in `replaceParameters`');
+        }
+        var precol = match.groups.precol;
+        var parameterName = match.groups.parameterName;
+        if (parameterName === '') {
+            return "continue";
+        }
+        if (parameterName.indexOf('{') !== -1 || parameterName.indexOf('}') !== -1) {
+            throw new PipelineExecutionError('Parameter is already opened or not closed');
+        }
+        if (parameters[parameterName] === undefined) {
+            throw new PipelineExecutionError("Parameter {".concat(parameterName, "} is not defined"));
+        }
+        var parameterValue = parameters[parameterName];
+        if (parameterValue === undefined) {
+            throw new PipelineExecutionError("Parameter {".concat(parameterName, "} is not defined"));
+        }
+        parameterValue = parameterValue.toString();
+        if (parameterValue.includes('\n') && /^\s*\W{0,3}\s*$/.test(precol)) {
+            parameterValue = parameterValue
+                .split('\n')
+                .map(function (line, index) { return (index === 0 ? line : "".concat(precol).concat(line)); })
+                .join('\n');
+        }
+        replacedTemplate =
+            replacedTemplate.substring(0, match.index + precol.length) +
+                parameterValue +
+                replacedTemplate.substring(match.index + precol.length + parameterName.length + 2);
+    };
+    while ((match = /^(?<precol>.*){(?<parameterName>\w+)}(.*)/m /* <- Not global */
+        .exec(replacedTemplate))) {
+        _loop_1();
+    }
+    // [💫] Check if there are parameters that are not closed properly
+    if (/{\w+$/.test(replacedTemplate)) {
+        throw new PipelineExecutionError('Parameter is not closed');
+    }
+    // [💫] Check if there are parameters that are not opened properly
+    if (/^\w+}/.test(replacedTemplate)) {
+        throw new PipelineExecutionError('Parameter is not opened');
+    }
+    return replacedTemplate;
+}
+
 /**
  * Mocked execution Tools for just echoing the requests for testing purposes.
  */
@@ -226,22 +458,27 @@ var MockedEchoLlmExecutionTools = /** @class */ (function () {
      */
     MockedEchoLlmExecutionTools.prototype.callChatModel = function (prompt) {
         return __awaiter(this, void 0, void 0, function () {
+            var modelName, rawPromptContent;
             return __generator(this, function (_a) {
                 if (this.options.isVerbose) {
                     console.info('💬 Mocked callChatModel call');
                 }
+                modelName = 'mocked-echo';
+                rawPromptContent = replaceParameters(prompt.content, __assign(__assign({}, prompt.parameters), { modelName: modelName }));
                 return [2 /*return*/, {
-                        content: spaceTrim(function (block) { return "\n                    You said:\n                    ".concat(block(prompt.content), "\n                "); }),
-                        modelName: 'mocked-echo',
+                        content: spaceTrim(function (block) { return "\n                    You said:\n                    ".concat(block(rawPromptContent), "\n                "); }),
+                        modelName: modelName,
                         timing: {
                             start: getCurrentIsoDate(),
                             complete: getCurrentIsoDate(),
                         },
                         usage: addUsage( /* <- TODO: [🧠] Compute here at least words, characters,... etc */),
+                        rawPromptContent: rawPromptContent,
+                        rawRequest: null,
                         rawResponse: {
                             note: 'This is mocked echo',
                         },
-                        // <- [🤹‍♂️]
+                        // <- [🗯]
                     }];
             });
         });
@@ -251,22 +488,27 @@ var MockedEchoLlmExecutionTools = /** @class */ (function () {
      */
     MockedEchoLlmExecutionTools.prototype.callCompletionModel = function (prompt) {
         return __awaiter(this, void 0, void 0, function () {
+            var modelName, rawPromptContent;
             return __generator(this, function (_a) {
                 if (this.options.isVerbose) {
                     console.info('🖋 Mocked callCompletionModel call');
                 }
+                modelName = 'mocked-echo';
+                rawPromptContent = replaceParameters(prompt.content, __assign(__assign({}, prompt.parameters), { modelName: modelName }));
                 return [2 /*return*/, {
-                        content: spaceTrim(function (block) { return "\n                    ".concat(block(prompt.content), "\n                    And so on...\n                "); }),
-                        modelName: 'mocked-echo',
+                        content: spaceTrim(function (block) { return "\n                    ".concat(block(rawPromptContent), "\n                    And so on...\n                "); }),
+                        modelName: modelName,
                         timing: {
                             start: getCurrentIsoDate(),
                             complete: getCurrentIsoDate(),
                         },
                         usage: addUsage( /* <- TODO: [🧠] Compute here at least words, characters,... etc */),
+                        rawPromptContent: rawPromptContent,
+                        rawRequest: null,
                         rawResponse: {
                             note: 'This is mocked echo',
                         },
-                        // <- [🤹‍♂️]
+                        // <- [🗯]
                     }];
             });
         });
@@ -293,18 +535,10 @@ var MockedEchoLlmExecutionTools = /** @class */ (function () {
     return MockedEchoLlmExecutionTools;
 }());
 /**
- * TODO: [🕵️‍♀️] Maybe just remove
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
  * TODO: Allow in spaceTrim: nesting with > ${block(prompt.request)}, same as replace params
  */
 
-/**
- * The maximum number of iterations for a loops
- */
-/**
- * The maximum number of iterations for a loops which adds characters one by one
- */
-var CHARACTER_LOOP_LIMIT = 100000;
-
 /**
  * This error occurs when some expectation is not met in the execution of the pipeline
  *
@@ -768,7 +1002,7 @@ function $fakeTextToExpectations(expectations, postprocessing) {
                     loremText = loremText.substring(1);
                     _d.label = 10;
                 case 10: return [3 /*break*/, 1];
-                case 11: throw new Error(spaceTrim(function (block) { return "\n                Can not generate fake text to met the expectations\n\n                Loop limit reached\n                The expectations:\n                ".concat(block(JSON.stringify(expectations, null, 4)), "\n\n                The draft text:\n                ").concat(block(text), "\n\n            "); }));
+                case 11: throw new LimitReachedError(spaceTrim(function (block) { return "\n                Can not generate fake text to met the expectations\n\n                Loop limit reached\n                The expectations:\n                ".concat(block(JSON.stringify(expectations, null, 4)), "\n\n                The draft text:\n                ").concat(block(text), "\n\n            "); }));
             }
         });
     });
@@ -804,13 +1038,15 @@ var MockedFackedLlmExecutionTools = /** @class */ (function () {
      */
     MockedFackedLlmExecutionTools.prototype.callChatModel = function (prompt) {
         return __awaiter(this, void 0, void 0, function () {
-            var content, result;
+            var modelName, rawPromptContent, content, result;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         if (this.options.isVerbose) {
                             console.info('💬 Mocked faked prompt', prompt);
                         }
+                        modelName = 'mocked-facked';
+                        rawPromptContent = replaceParameters(prompt.content, __assign(__assign({}, prompt.parameters), { modelName: modelName }));
                         return [4 /*yield*/, $fakeTextToExpectations(prompt.expectations || {
                                 sentences: { min: 1, max: 1 },
                             }, prompt.postprocessing)];
@@ -818,16 +1054,18 @@ var MockedFackedLlmExecutionTools = /** @class */ (function () {
                         content = _a.sent();
                         result = {
                             content: content,
-                            modelName: 'mocked-facked',
+                            modelName: modelName,
                             timing: {
                                 start: getCurrentIsoDate(),
                                 complete: getCurrentIsoDate(),
                             },
                             usage: addUsage( /* <- TODO: [🧠] Compute here at least words, characters,... etc */),
+                            rawPromptContent: rawPromptContent,
+                            rawRequest: null,
                             rawResponse: {
                                 note: 'This is mocked echo',
                             },
-                            // <- [🤹‍♂️]
+                            // <- [🗯]
                         };
                         if (this.options.isVerbose) {
                             console.info('💬 Mocked faked result', result);
@@ -852,21 +1090,25 @@ var MockedFackedLlmExecutionTools = /** @class */ (function () {
      */
     MockedFackedLlmExecutionTools.prototype.callEmbeddingModel = function (prompt) {
         return __awaiter(this, void 0, void 0, function () {
-            var content, result;
+            var modelName, rawPromptContent, content, result;
             return __generator(this, function (_a) {
-                content = new Array(25).fill(0).map(function () { return Math.random() * 2 - 1; });
+                modelName = 'mocked-facked';
+                rawPromptContent = replaceParameters(prompt.content, __assign(__assign({}, prompt.parameters), { modelName: modelName }));
+                content = new Array(1024).fill(0).map(function () { return Math.random() * 2 - 1; });
                 result = {
                     content: content,
-                    modelName: 'mocked-facked',
+                    modelName: modelName,
                     timing: {
                         start: getCurrentIsoDate(),
                         complete: getCurrentIsoDate(),
                     },
                     usage: addUsage( /* <- TODO: [🧠] Compute here at least words, characters,... etc */),
+                    rawPromptContent: rawPromptContent,
+                    rawRequest: null,
                     rawResponse: {
                         note: 'This is mocked embedding',
                     },
-                    // <- [🤹‍♂️]
+                    // <- [🗯]
                 };
                 if (this.options.isVerbose) {
                     console.info('💬 Mocked faked result', result);
@@ -897,13 +1139,13 @@ var MockedFackedLlmExecutionTools = /** @class */ (function () {
     return MockedFackedLlmExecutionTools;
 }());
 /**
- * TODO: [🕵️‍♀️] Maybe just remove
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
  */
 
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.61.0-8';
+var PROMPTBOOK_VERSION = '0.61.0-30';
 // TODO: !!!! List here all the versions and annotate + put into script
 
 export { MockedEchoLlmExecutionTools, MockedFackedLlmExecutionTools, PROMPTBOOK_VERSION };