@promptbook/remote-server 0.65.0 → 0.66.0-1

package/esm/index.es.js

@@ -11,7 +11,7 @@ import OpenAI from 'openai';
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.65.0-7';
+var PROMPTBOOK_VERSION = '0.66.0-0';
 // TODO: !!!! List here all the versions and annotate + put into script
 
 /*! *****************************************************************************
@@ -452,7 +452,9 @@ var RemoteLlmExecutionTools = /** @class */ (function () {
      */
     RemoteLlmExecutionTools.prototype.makeConnection = function () {
         var _this = this;
-        return new Promise(function (resolve, reject) {
+        return new Promise(
+        //            <- TODO: [🧱] Implement in a functional (not new Class) way
+        function (resolve, reject) {
             var socket = io(_this.options.remoteUrl, {
                 path: _this.options.path,
                 // path: `${this.remoteUrl.pathname}/socket.io`,
@@ -574,12 +576,21 @@ function computeUsage(value) {
 /**
  * List of available Anthropic Claude models with pricing
  *
- * Note: Done at 2024-05-25
+ * Note: Done at 2024-08-16
  *
  * @see https://docs.anthropic.com/en/docs/models-overview
  * @public exported from `@promptbook/anthropic-claude`
  */
 var ANTHROPIC_CLAUDE_MODELS = [
+    {
+        modelVariant: 'CHAT',
+        modelTitle: 'Claude 3.5 Sonnet',
+        modelName: 'claude-3-5-sonnet-20240620',
+        pricing: {
+            prompt: computeUsage("$3.00 / 1M tokens"),
+            output: computeUsage("$15.00 / 1M tokens"),
+        },
+    },
     {
         modelVariant: 'CHAT',
         modelTitle: 'Claude 3 Opus',
@@ -641,8 +652,190 @@ var ANTHROPIC_CLAUDE_MODELS = [
  * TODO: [🧠] !!! Add embedding models OR Anthropic has only chat+completion models?
  * TODO: [🧠] Some mechanism to propagate unsureness
  * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
- * TODO: [🕚] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
+ * TODO: [🎰] Some mechanism to auto-update available models
+ */
+
+/**
+ * Get current date in ISO 8601 format
+ *
+ * @private internal utility
+ */
+function getCurrentIsoDate() {
+    return new Date().toISOString();
+}
+
+/**
+ * @@@
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it mutates given object
+ * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ *
+ * @returns The same object as the input, but deeply frozen
+ * @public exported from `@promptbook/utils`
+ */
+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: [🧠] Is there a way how to meaningfully test this utility
+ */
+
+// <- 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;
+/**
+ * Nonce which is used for replacing things in strings
+ *
+ * @private within the repository
+ */
+var REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
+/**
+ * The names of the parameters that are reserved for special purposes
+ *
+ * @public exported from `@promptbook/core`
+ */
+$deepFreeze([
+    'content',
+    'context',
+    'knowledge',
+    'samples',
+    'modelName',
+    'currentDate',
+    // <- TODO: Add more like 'date', 'modelName',...
+    // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
+]);
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+var RESERVED_PARAMETER_MISSING_VALUE = 'MISSING-' + REPLACING_NONCE;
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+var RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
+/**
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
+ */
+
+/**
+ * This error type indicates that some limit was reached
+ *
+ * @public exported from `@promptbook/core`
  */
+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));
+
+/**
+ * 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
+ * @public exported from `@promptbook/utils`
+ */
+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;
+}
 
 /**
  * Counts number of characters in the text
@@ -1015,182 +1208,42 @@ function uncertainNumber(value) {
 }
 
 /**
- * Get current date in ISO 8601 format
+ * Computes the usage of the Anthropic Claude API based on the response from Anthropic Claude
  *
- * @private internal utility
- */
-function getCurrentIsoDate() {
-    return new Date().toISOString();
-}
-
-/**
- * @@@
- *
- * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
- *
- * @returns The same object as the input, but deeply frozen
- * @public exported from `@promptbook/utils`
+ * @param promptContent The content of the prompt
+ * @param resultContent The content of the result (for embedding prompts or failed prompts pass empty string)
+ * @param rawResponse The raw response from Anthropic Claude API
+ * @throws {PipelineExecutionError} If the usage is not defined in the response from Anthropic Claude
+ * @private internal utility of `AnthropicClaudeExecutionTools`
  */
-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);
-            }
-        }
+function computeAnthropicClaudeUsage(promptContent, // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer
+resultContent, rawResponse) {
+    var _a, _b;
+    if (rawResponse.usage === undefined) {
+        throw new PipelineExecutionError('The usage is not defined in the response from Anthropic Claude');
     }
-    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; }
+    if (((_a = rawResponse.usage) === null || _a === void 0 ? void 0 : _a.input_tokens) === undefined) {
+        throw new PipelineExecutionError('In Anthropic Claude response `usage.prompt_tokens` not defined');
     }
-    return Object.freeze(objectValue);
-}
-/**
- * TODO: [🧠] Is there a way how to meaningfully test this utility
- */
-
-// <- 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;
-/**
- * Nonce which is used for replacing things in strings
- *
- * @private within the repository
- */
-var REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
-/**
- * The names of the parameters that are reserved for special purposes
- *
- * @public exported from `@promptbook/core`
- */
-deepFreeze([
-    'content',
-    'context',
-    'knowledge',
-    'samples',
-    'modelName',
-    'currentDate',
-    // <- TODO: Add more like 'date', 'modelName',...
-    // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
-]);
-/**
- * @@@
- *
- * @private within the repository
- */
-var RESERVED_PARAMETER_MISSING_VALUE = 'MISSING-' + REPLACING_NONCE;
-/**
- * @@@
- *
- * @private within the repository
- */
-var RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
-
-/**
- * This error type indicates that some limit was reached
- *
- * @public exported from `@promptbook/core`
- */
-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));
-
-/**
- * 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
- * @public exported from `@promptbook/utils`
- */
-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"));
-            }
-        }
+    var inputTokens = rawResponse.usage.input_tokens;
+    var outputTokens = ((_b = rawResponse.usage) === null || _b === void 0 ? void 0 : _b.output_tokens) || 0;
+    var modelInfo = ANTHROPIC_CLAUDE_MODELS.find(function (model) { return model.modelName === rawResponse.model; });
+    var price;
+    if (modelInfo === undefined || modelInfo.pricing === undefined) {
+        price = uncertainNumber();
     }
-    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; }
+    else {
+        price = uncertainNumber(inputTokens * modelInfo.pricing.prompt + outputTokens * modelInfo.pricing.output);
     }
-    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);
+    return {
+        price: price,
+        input: __assign({ tokensCount: uncertainNumber(rawResponse.usage.input_tokens) }, computeUsageCounts(promptContent)),
+        output: __assign({ tokensCount: uncertainNumber(outputTokens) }, computeUsageCounts(resultContent)),
     };
-    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;
 }
+/**
+ * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenaiUsage` and `computeAnthropicClaudeUsage`
+ */
 
 /**
  * Execution Tools for calling Anthropic Claude API.
@@ -1212,6 +1265,7 @@ var AnthropicClaudeExecutionTools = /** @class */ (function () {
         delete anthropicOptions.isVerbose;
         delete anthropicOptions.isProxied;
         this.client = new Anthropic(anthropicOptions);
+        // <- TODO: !!!!!! Lazy-load client
     }
     Object.defineProperty(AnthropicClaudeExecutionTools.prototype, "title", {
         get: function () {
@@ -1232,7 +1286,7 @@ var AnthropicClaudeExecutionTools = /** @class */ (function () {
      */
     AnthropicClaudeExecutionTools.prototype.callChatModel = function (prompt) {
         return __awaiter(this, void 0, void 0, function () {
-            var content, parameters, modelRequirements, modelName, rawPromptContent, rawRequest, start, complete, rawResponse, resultContent, usage;
+            var content, parameters, modelRequirements, modelName, rawPromptContent, rawRequest, start, complete, rawResponse, contentBlock, resultContent, usage;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -1278,14 +1332,14 @@ var AnthropicClaudeExecutionTools = /** @class */ (function () {
                         if (rawResponse.content.length > 1) {
                             throw new PipelineExecutionError('More than one content blocks from Anthropic Claude');
                         }
-                        resultContent = rawResponse.content[0].text;
+                        contentBlock = rawResponse.content[0];
+                        if (contentBlock.type !== 'text') {
+                            throw new PipelineExecutionError("Returned content is not \"text\" type but \"".concat(contentBlock.type, "\""));
+                        }
+                        resultContent = contentBlock.text;
                         // eslint-disable-next-line prefer-const
                         complete = getCurrentIsoDate();
-                        usage = {
-                            price: { value: 0, isUncertain: true } /* <- TODO: [🐞] Compute usage */,
-                            input: __assign({ tokensCount: uncertainNumber(rawResponse.usage.input_tokens) }, computeUsageCounts(prompt.content)),
-                            output: __assign({ tokensCount: uncertainNumber(rawResponse.usage.output_tokens) }, computeUsageCounts(prompt.content)),
-                        };
+                        usage = computeAnthropicClaudeUsage(content, '', rawResponse);
                         return [2 /*return*/, {
                                 content: resultContent,
                                 modelName: rawResponse.model,
@@ -1433,7 +1487,9 @@ function createAnthropicClaudeExecutionTools(options) {
                 },
             ], models: ANTHROPIC_CLAUDE_MODELS }));
     }
-    return new AnthropicClaudeExecutionTools(options);
+    return new AnthropicClaudeExecutionTools(
+    //            <- TODO: [🧱] Implement in a functional (not new Class) way
+    options);
 }
 /**
  * TODO: [🧠] !!!! Make anonymous this with all LLM providers
@@ -1782,7 +1838,8 @@ var OPENAI_MODELS = [
 /**
  * Note: [🤖] Add models of new variant
  * TODO: [🧠] Some mechanism to propagate unsureness
- * TODO: [🕚][👮‍♀️] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
+ * TODO: [🎰] Some mechanism to auto-update available models
+ * TODO: [🎰][👮‍♀️] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
  * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
  * @see https://platform.openai.com/docs/models/gpt-4-turbo-and-gpt-4
  * @see https://openai.com/api/pricing/
@@ -1805,7 +1862,10 @@ var AzureOpenAiExecutionTools = /** @class */ (function () {
      */
     function AzureOpenAiExecutionTools(options) {
         this.options = options;
-        this.client = new OpenAIClient("https://".concat(options.resourceName, ".openai.azure.com/"), new AzureKeyCredential(options.apiKey));
+        this.client = new OpenAIClient(
+        //            <- TODO: [🧱] Implement in a functional (not new Class) way
+        "https://".concat(options.resourceName, ".openai.azure.com/"), new AzureKeyCredential(options.apiKey));
+        // <- TODO: !!!!!! Lazy-load client
     }
     Object.defineProperty(AzureOpenAiExecutionTools.prototype, "title", {
         get: function () {
@@ -2075,6 +2135,9 @@ resultContent, rawResponse) {
         output: __assign({ tokensCount: uncertainNumber(outputTokens) }, computeUsageCounts(resultContent)),
     };
 }
+/**
+ * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenaiUsage` and `computeAnthropicClaudeUsage`
+ */
 
 /**
  * Execution Tools for calling OpenAI API.
@@ -2095,6 +2158,7 @@ var OpenAiExecutionTools = /** @class */ (function () {
         delete openAiOptions.isVerbose;
         delete openAiOptions.user;
         this.client = new OpenAI(__assign({}, openAiOptions));
+        // <- TODO: !!!!!! Lazy-load client
     }
     Object.defineProperty(OpenAiExecutionTools.prototype, "title", {
         get: function () {
@@ -2388,11 +2452,15 @@ var EXECUTION_TOOLS_CLASSES = {
         return new OpenAiExecutionTools(__assign(__assign({}, options), { dangerouslyAllowBrowser: true /* <- TODO: [🧠] !!! Some mechanism for auto-detection of browser, maybe hide in `OpenAiExecutionTools` */ }));
     },
     createAnthropicClaudeExecutionTools: createAnthropicClaudeExecutionTools,
-    createAzureOpenAiExecutionTools: function (options) { return new AzureOpenAiExecutionTools(options); },
+    createAzureOpenAiExecutionTools: function (options) {
+        return new AzureOpenAiExecutionTools(
+        //            <- TODO: [🧱] Implement in a functional (not new Class) way
+        options);
+    },
     // <- Note: [🦑] Add here new LLM provider
 };
 /**
- * TODO: [🧠] Better file name than `config.ts` + maybe move to two separate files
+ * TODO: !!!!!!! Make global register for this
  * TODO: [🧠][🎌] Adding this should be responsibility of each provider package NOT this one central place
  */
 
@@ -2477,7 +2545,9 @@ function startRemoteServer(options) {
             }
         });
     }); });
-    var server = new Server(httpServer, {
+    var server = new Server(
+    //            <- TODO: [🧱] Implement in a functional (not new Class) way
+    httpServer, {
         path: path,
         transports: [/*'websocket', <- TODO: [🌬] Make websocket transport work */ 'polling'],
         cors: {