@promptbook/anthropic-claude 0.79.0 → 0.80.0-0

package/README.md

@@ -23,6 +23,10 @@
 
 
 
+<blockquote style="color: #ff8811">
+    <b>⚠ Warning:</b> This is a pre-release version of the library. It is not yet ready for production use. Please look at <a href="https://www.npmjs.com/package/@promptbook/core?activeTab=versions">latest stable release</a>.
+</blockquote>
+
 ## 📦 Package `@promptbook/anthropic-claude`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).

package/esm/index.es.js

@@ -15,7 +15,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  *
  * @see https://github.com/webgptorg/promptbook
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.78.4';
+var PROMPTBOOK_ENGINE_VERSION = '0.79.0';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -131,7 +131,19 @@ function __read(o, n) {
 }
 
 /**
- * @@@
+ * Orders JSON object by keys
+ *
+ * @returns The same type of object as the input re-ordered
+ * @public exported from `@promptbook/utils`
+ */
+function orderJson(options) {
+    var value = options.value, order = options.order;
+    var orderedValue = __assign(__assign({}, (order === undefined ? {} : Object.fromEntries(order.map(function (key) { return [key, undefined]; })))), value);
+    return orderedValue;
+}
+
+/**
+ * Freezes the given object and all its nested objects recursively
  *
  * 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
@@ -161,7 +173,8 @@ function $deepFreeze(objectValue) {
         }
         finally { if (e_1) throw e_1.error; }
     }
-    return Object.freeze(objectValue);
+    Object.freeze(objectValue);
+    return objectValue;
 }
 /**
  * TODO: [🧠] Is there a way how to meaningfully test this utility
@@ -207,24 +220,6 @@ var CONNECTION_TIMEOUT_MS = 7 * 1000;
  * @private within the repository - too low-level in comparison with other `MAX_...`
  */
 var CONNECTION_RETRIES_LIMIT = 5;
-/**
- * Nonce which is used for replacing things in strings
- *
- * @private within the repository
- */
-var REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
-/**
- * @@@
- *
- * @private within the repository
- */
-var RESERVED_PARAMETER_MISSING_VALUE = 'MISSING-' + REPLACING_NONCE;
-/**
- * @@@
- *
- * @private within the repository
- */
-var RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
 // <- TODO: [🧜‍♂️]
 /**
  * @@@
@@ -238,7 +233,6 @@ Object.freeze({
     skipEmptyLines: true,
 });
 /**
- * TODO: Extract `constants.ts` from `config.ts`
  * Note: [💞] Ignore a discrepancy between file name and entity name
  * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
  */
@@ -297,8 +291,9 @@ var UnexpectedError = /** @class */ (function (_super) {
  * @throws UnexpectedError if the value is not serializable as JSON
  * @public exported from `@promptbook/utils`
  */
-function checkSerializableAsJson(name, value) {
+function checkSerializableAsJson(options) {
     var e_1, _a;
+    var value = options.value, name = options.name, message = options.message;
     if (value === undefined) {
         throw new UnexpectedError("".concat(name, " is undefined"));
     }
@@ -322,12 +317,12 @@ function checkSerializableAsJson(name, value) {
     }
     else if (typeof value === 'object' && Array.isArray(value)) {
         for (var i = 0; i < value.length; i++) {
-            checkSerializableAsJson("".concat(name, "[").concat(i, "]"), value[i]);
+            checkSerializableAsJson({ name: "".concat(name, "[").concat(i, "]"), value: value[i], message: message });
         }
     }
     else if (typeof value === 'object') {
         if (value instanceof Date) {
-            throw new UnexpectedError(spaceTrim("\n                    ".concat(name, " is Date\n\n                    Use `string_date_iso8601` instead\n                ")));
+            throw new UnexpectedError(spaceTrim(function (block) { return "\n                        `".concat(name, "` is Date\n\n                        Use `string_date_iso8601` instead\n\n                        Additional message for `").concat(name, "`:\n                        ").concat(block(message || '(nothing)'), "\n                    "); }));
         }
         else if (value instanceof Map) {
             throw new UnexpectedError("".concat(name, " is Map"));
@@ -339,7 +334,7 @@ function checkSerializableAsJson(name, value) {
             throw new UnexpectedError("".concat(name, " is RegExp"));
         }
         else if (value instanceof Error) {
-            throw new UnexpectedError(spaceTrim("\n                    ".concat(name, " is unserialized Error\n\n                    Use function `serializeError`\n                ")));
+            throw new UnexpectedError(spaceTrim(function (block) { return "\n                        `".concat(name, "` is unserialized Error\n\n                        Use function `serializeError`\n\n                        Additional message for `").concat(name, "`:\n                        ").concat(block(message || '(nothing)'), "\n\n                    "); }));
         }
         else {
             try {
@@ -349,7 +344,7 @@ function checkSerializableAsJson(name, value) {
                         // Note: undefined in object is serializable - it is just omited
                         continue;
                     }
-                    checkSerializableAsJson("".concat(name, ".").concat(subName), subValue);
+                    checkSerializableAsJson({ name: "".concat(name, ".").concat(subName), value: subValue, message: message });
                 }
             }
             catch (e_1_1) { e_1 = { error: e_1_1 }; }
@@ -366,7 +361,7 @@ function checkSerializableAsJson(name, value) {
                 if (!(error instanceof Error)) {
                     throw error;
                 }
-                throw new UnexpectedError(spaceTrim(function (block) { return "\n                            ".concat(name, " is not serializable\n\n                            ").concat(block(error.toString()), "\n                        "); }));
+                throw new UnexpectedError(spaceTrim(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                        "); }));
             }
             /*
             TODO: [0] Is there some more elegant way to check circular references?
@@ -391,32 +386,70 @@ function checkSerializableAsJson(name, value) {
         }
     }
     else {
-        throw new UnexpectedError("".concat(name, " is unknown"));
+        throw new UnexpectedError(spaceTrim(function (block) { return "\n                    `".concat(name, "` is unknown type\n\n                    Additional message for `").concat(name, "`:\n                    ").concat(block(message || '(nothing)'), "\n                "); }));
     }
 }
 /**
- * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
+ * TODO: Can be return type more type-safe? like `asserts options.value is JsonValue`
  * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
  * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
  */
 
 /**
- * @@@
  * @@@
  *
- * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ * @public exported from `@promptbook/utils`
+ */
+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: [🧠] Is there a way how to meaningfully test this utility
+ */
+
+/**
+ * Utility to export a JSON object from a function
  *
- * @param name - Name of the object for debugging purposes
- * @param objectValue - Object to be deeply frozen
- * @returns The same object as the input, but deeply frozen
- * @private this is in comparison to `deepFreeze` a more specific utility and maybe not very good practice to use without specific reason and considerations
+ * 1) Checks if the value is serializable as JSON
+ * 2) Makes a deep clone of the object
+ * 2) Orders the object properties
+ * 2) Deeply freezes the cloned object
+ *
+ * Note: This function does not mutates the given object
+ *
+ * @returns The same type of object as the input but read-only and re-ordered
+ * @public exported from `@promptbook/utils`
  */
-function $asDeeplyFrozenSerializableJson(name, objectValue) {
-    checkSerializableAsJson(name, objectValue);
-    return $deepFreeze(objectValue);
+function exportJson(options) {
+    var name = options.name, value = options.value, order = options.order, message = options.message;
+    checkSerializableAsJson({ name: name, value: value, message: message });
+    var orderedValue = 
+    // TODO: Fix error "Type instantiation is excessively deep and possibly infinite."
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    order === undefined
+        ? deepClone(value)
+        : orderJson({
+            value: value,
+            // <- Note: checkSerializableAsJson asserts that the value is serializable as JSON
+            order: order,
+        });
+    $deepFreeze(orderedValue);
+    return orderedValue;
 }
 /**
- * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
  * TODO: [🧠] Is there a way how to meaningfully test this utility
  */
 
@@ -438,72 +471,75 @@ function computeUsage(value) {
  * @see https://docs.anthropic.com/en/docs/models-overview
  * @public exported from `@promptbook/anthropic-claude`
  */
-var ANTHROPIC_CLAUDE_MODELS = $asDeeplyFrozenSerializableJson('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"),
+var ANTHROPIC_CLAUDE_MODELS = exportJson({
+    name: 'ANTHROPIC_CLAUDE_MODELS',
+    value: [
+        {
+            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',
-        modelName: 'claude-3-opus-20240229',
-        pricing: {
-            prompt: computeUsage("$15.00 / 1M tokens"),
-            output: computeUsage("$75.00 / 1M tokens"),
+        {
+            modelVariant: 'CHAT',
+            modelTitle: 'Claude 3 Opus',
+            modelName: 'claude-3-opus-20240229',
+            pricing: {
+                prompt: computeUsage("$15.00 / 1M tokens"),
+                output: computeUsage("$75.00 / 1M tokens"),
+            },
         },
-    },
-    {
-        modelVariant: 'CHAT',
-        modelTitle: 'Claude 3 Sonnet',
-        modelName: 'claude-3-sonnet-20240229',
-        pricing: {
-            prompt: computeUsage("$3.00 / 1M tokens"),
-            output: computeUsage("$15.00 / 1M tokens"),
+        {
+            modelVariant: 'CHAT',
+            modelTitle: 'Claude 3 Sonnet',
+            modelName: 'claude-3-sonnet-20240229',
+            pricing: {
+                prompt: computeUsage("$3.00 / 1M tokens"),
+                output: computeUsage("$15.00 / 1M tokens"),
+            },
         },
-    },
-    {
-        modelVariant: 'CHAT',
-        modelTitle: 'Claude 3 Haiku',
-        modelName: '	claude-3-haiku-20240307',
-        pricing: {
-            prompt: computeUsage("$0.25 / 1M tokens"),
-            output: computeUsage("$1.25 / 1M tokens"),
+        {
+            modelVariant: 'CHAT',
+            modelTitle: 'Claude 3 Haiku',
+            modelName: '	claude-3-haiku-20240307',
+            pricing: {
+                prompt: computeUsage("$0.25 / 1M tokens"),
+                output: computeUsage("$1.25 / 1M tokens"),
+            },
         },
-    },
-    {
-        modelVariant: 'CHAT',
-        modelTitle: 'Claude 2.1',
-        modelName: 'claude-2.1',
-        pricing: {
-            prompt: computeUsage("$8.00 / 1M tokens"),
-            output: computeUsage("$24.00 / 1M tokens"),
+        {
+            modelVariant: 'CHAT',
+            modelTitle: 'Claude 2.1',
+            modelName: 'claude-2.1',
+            pricing: {
+                prompt: computeUsage("$8.00 / 1M tokens"),
+                output: computeUsage("$24.00 / 1M tokens"),
+            },
         },
-    },
-    {
-        modelVariant: 'CHAT',
-        modelTitle: 'Claude 2',
-        modelName: 'claude-2.0',
-        pricing: {
-            prompt: computeUsage("$8.00 / 1M tokens"),
-            output: computeUsage("$24.00 / 1M tokens"),
+        {
+            modelVariant: 'CHAT',
+            modelTitle: 'Claude 2',
+            modelName: 'claude-2.0',
+            pricing: {
+                prompt: computeUsage("$8.00 / 1M tokens"),
+                output: computeUsage("$24.00 / 1M tokens"),
+            },
         },
-    },
-    {
-        modelVariant: 'CHAT',
-        modelTitle: '	Claude Instant 1.2',
-        modelName: 'claude-instant-1.2',
-        pricing: {
-            prompt: computeUsage("$0.80 / 1M tokens"),
-            output: computeUsage("$2.40 / 1M tokens"),
+        {
+            modelVariant: 'CHAT',
+            modelTitle: '	Claude Instant 1.2',
+            modelName: 'claude-instant-1.2',
+            pricing: {
+                prompt: computeUsage("$0.80 / 1M tokens"),
+                output: computeUsage("$2.40 / 1M tokens"),
+            },
         },
-    },
-    // TODO: [main] !!! Claude 1 and 2 has also completion versions - ask Hoagy
-]);
+        // TODO: [main] !!! Claude 1 and 2 has also completion versions - ask Hoagy
+    ],
+});
 /**
  * Note: [🤖] Add models of new variant
  * TODO: [🧠][main] !!! Add embedding models OR Anthropic has only chat+completion models?
@@ -541,6 +577,48 @@ function $getCurrentDate() {
     return new Date().toISOString();
 }
 
+/**
+ * Nonce which is used for replacing things in strings
+ *
+ * @private within the repository
+ */
+var REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+var RESERVED_PARAMETER_MISSING_VALUE = 'MISSING-' + REPLACING_NONCE;
+/**
+ * @@@
+ *
+ * @private within the repository
+ */
+var RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
+/**
+ * The names of the parameters that are reserved for special purposes
+ *
+ * @public exported from `@promptbook/core`
+ */
+exportJson({
+    name: 'RESERVED_PARAMETER_NAMES',
+    message: "The names of the parameters that are reserved for special purposes",
+    value: [
+        'content',
+        'context',
+        'knowledge',
+        'examples',
+        'modelName',
+        'currentDate',
+        // <- TODO: list here all command names
+        // <- TODO: Add more like 'date', 'modelName',...
+        // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
+    ],
+});
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */
+
 /**
  * This error type indicates that some limit was reached
  *
@@ -1201,18 +1279,23 @@ var AnthropicClaudeExecutionTools = /** @class */ (function () {
                         // eslint-disable-next-line prefer-const
                         complete = $getCurrentDate();
                         usage = computeAnthropicClaudeUsage(rawPromptContent || '', resultContent || '', rawResponse);
-                        return [2 /*return*/, $asDeeplyFrozenSerializableJson('AnthropicClaudeExecutionTools ChatPromptResult', {
-                                content: resultContent,
-                                modelName: rawResponse.model,
-                                timing: {
-                                    start: start,
-                                    complete: complete,
+                        return [2 /*return*/, exportJson({
+                                name: 'promptResult',
+                                message: "Result of `AzureOpenAiExecutionTools.callChatModel`",
+                                order: [],
+                                value: {
+                                    content: resultContent,
+                                    modelName: rawResponse.model,
+                                    timing: {
+                                        start: start,
+                                        complete: complete,
+                                    },
+                                    usage: usage,
+                                    rawPromptContent: rawPromptContent,
+                                    rawRequest: rawRequest,
+                                    rawResponse: rawResponse,
+                                    // <- [🗯]
                                 },
-                                usage: usage,
-                                rawPromptContent: rawPromptContent,
-                                rawRequest: rawRequest,
-                                rawResponse: rawResponse,
-                                // <- [🗯]
                             })];
                 }
             });
@@ -1282,7 +1365,7 @@ var AnthropicClaudeExecutionTools = /** @class */ (function () {
 
 
 
-        return $asDeeplyFrozenSerializableJson('AnthropicClaudeExecutionTools CompletionPromptResult',{
+        return $exportJson({ name: 'promptResult',message: Result of \`AzureOpenAiExecutionTools callChatModel\`, order: [],value:{
             content: resultContent,
             modelName: rawResponse.model || model,
             timing: {
@@ -1665,7 +1748,7 @@ var RemoteLlmExecutionTools = /** @class */ (function () {
                                 isAnonymous: true,
                                 userId: this.options.userId,
                                 llmToolsConfiguration: this.options.llmToolsConfiguration,
-                            } /* <- TODO: [🤛] */);
+                            } /* <- Note: [🤛] */);
                         }
                         else {
                             socket.emit('listModels-request', {
@@ -1673,7 +1756,7 @@ var RemoteLlmExecutionTools = /** @class */ (function () {
                                 appId: this.options.appId,
                                 userId: this.options.userId,
                                 customOptions: this.options.customOptions,
-                            } /* <- TODO: [🤛] */);
+                            } /* <- Note: [🤛] */);
                         }
                         return [4 /*yield*/, new Promise(function (resolve, reject) {
                                 socket.on('listModels-response', function (response) {
@@ -1761,7 +1844,7 @@ var RemoteLlmExecutionTools = /** @class */ (function () {
                                 userId: this.options.userId,
                                 llmToolsConfiguration: this.options.llmToolsConfiguration,
                                 prompt: prompt,
-                            } /* <- TODO: [🤛] */);
+                            } /* <- Note: [🤛] */);
                         }
                         else {
                             socket.emit('prompt-request', {
@@ -1770,7 +1853,7 @@ var RemoteLlmExecutionTools = /** @class */ (function () {
                                 userId: this.options.userId,
                                 customOptions: this.options.customOptions,
                                 prompt: prompt,
-                            } /* <- TODO: [🤛] */);
+                            } /* <- Note: [🤛] */);
                         }
                         return [4 /*yield*/, new Promise(function (resolve, reject) {
                                 socket.on('prompt-response', function (response) {
@@ -1793,7 +1876,7 @@ var RemoteLlmExecutionTools = /** @class */ (function () {
     return RemoteLlmExecutionTools;
 }());
 /**
- * TODO: Maybe use `$asDeeplyFrozenSerializableJson`
+ * TODO: Maybe use `$exportJson`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
  * TODO: [🍓] Allow to list compatible models with each variant
  * TODO: [🗯] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable