@promptbook/remote-server 0.72.0-2 → 0.72.0-23

package/umd/index.umd.js

@@ -14,8 +14,8 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.72.0-1';
-    // TODO:[main] !!!! List here all the versions and annotate + put into script
+    var PROMPTBOOK_VERSION = '0.72.0-22';
+    // TODO: [main] !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************
     Copyright (c) Microsoft Corporation.
@@ -382,7 +382,7 @@
      *
      * @public exported from `@promptbook/core`
      */
-    var IS_VERBOSE = false;
+    var DEFAULT_IS_VERBOSE = false;
     /**
      * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
      */
@@ -594,7 +594,7 @@
      * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
      *
      * Note: Internal utility of `joinLlmExecutionTools` but exposed type
-     * @public exported from `@promptbook/types`
+     * @public exported from `@promptbook/core`
      */
     var MultipleLlmExecutionTools = /** @class */ (function () {
         /**
@@ -893,6 +893,85 @@
         return Function('return this')();
     }
 
+    /**
+     * @@@
+     *
+     * @param text @@@
+     * @returns @@@
+     * @example 'HELLO_WORLD'
+     * @example 'I_LOVE_PROMPTBOOK'
+     * @public exported from `@promptbook/utils`
+     */
+    function normalizeTo_SCREAMING_CASE(text) {
+        var e_1, _a;
+        var charType;
+        var lastCharType = 'OTHER';
+        var normalizedName = '';
+        try {
+            for (var text_1 = __values(text), text_1_1 = text_1.next(); !text_1_1.done; text_1_1 = text_1.next()) {
+                var char = text_1_1.value;
+                var normalizedChar = void 0;
+                if (/^[a-z]$/.test(char)) {
+                    charType = 'LOWERCASE';
+                    normalizedChar = char.toUpperCase();
+                }
+                else if (/^[A-Z]$/.test(char)) {
+                    charType = 'UPPERCASE';
+                    normalizedChar = char;
+                }
+                else if (/^[0-9]$/.test(char)) {
+                    charType = 'NUMBER';
+                    normalizedChar = char;
+                }
+                else {
+                    charType = 'OTHER';
+                    normalizedChar = '_';
+                }
+                if (charType !== lastCharType &&
+                    !(lastCharType === 'UPPERCASE' && charType === 'LOWERCASE') &&
+                    !(lastCharType === 'NUMBER') &&
+                    !(charType === 'NUMBER')) {
+                    normalizedName += '_';
+                }
+                normalizedName += normalizedChar;
+                lastCharType = charType;
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (text_1_1 && !text_1_1.done && (_a = text_1.return)) _a.call(text_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        normalizedName = normalizedName.replace(/_+/g, '_');
+        normalizedName = normalizedName.replace(/_?\/_?/g, '/');
+        normalizedName = normalizedName.replace(/^_/, '');
+        normalizedName = normalizedName.replace(/_$/, '');
+        return normalizedName;
+    }
+    /**
+     * TODO: Tests
+     *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: 'Moje tabule' })).toEqual('/VtG7sR9rRJqwNEdM2/Moje tabule');
+     *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: 'ěščřžžýáíúů' })).toEqual('/VtG7sR9rRJqwNEdM2/escrzyaieuu');
+     *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: '  ahoj  ' })).toEqual('/VtG7sR9rRJqwNEdM2/ahoj');
+     *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: '  ahoj_ahojAhoj    ahoj  ' })).toEqual('/VtG7sR9rRJqwNEdM2/ahoj-ahoj-ahoj-ahoj');
+     * TODO: [🌺] Use some intermediate util splitWords
+     */
+
+    /**
+     * @@@
+     *
+     * @param text @@@
+     * @returns @@@
+     * @example 'hello_world'
+     * @example 'i_love_promptbook'
+     * @public exported from `@promptbook/utils`
+     */
+    function normalizeTo_snake_case(text) {
+        return normalizeTo_SCREAMING_CASE(text).toLowerCase();
+    }
+
     /**
      * Register is @@@
      *
@@ -901,9 +980,9 @@
      * @private internal utility, exported are only signleton instances of this class
      */
     var $Register = /** @class */ (function () {
-        function $Register(storageName) {
-            this.storageName = storageName;
-            storageName = "_promptbook_".concat(storageName);
+        function $Register(registerName) {
+            this.registerName = registerName;
+            var storageName = "_promptbook_".concat(normalizeTo_snake_case(registerName));
             var globalScope = $getGlobalScope();
             if (globalScope[storageName] === undefined) {
                 globalScope[storageName] = [];
@@ -914,11 +993,10 @@
             this.storage = globalScope[storageName];
         }
         $Register.prototype.list = function () {
-            // <- TODO: ReadonlyDeep<Array<TRegistered>>
+            // <- TODO: ReadonlyDeep<ReadonlyArray<TRegistered>>
             return this.storage;
         };
         $Register.prototype.register = function (registered) {
-            //                                    <- TODO: What to return here
             var packageName = registered.packageName, className = registered.className;
             var existingRegistrationIndex = this.storage.findIndex(function (item) { return item.packageName === packageName && item.className === className; });
             var existingRegistration = this.storage[existingRegistrationIndex];
@@ -928,6 +1006,17 @@
             else {
                 this.storage[existingRegistrationIndex] = registered;
             }
+            return {
+                registerName: this.registerName,
+                packageName: packageName,
+                className: className,
+                get isDestroyed() {
+                    return false;
+                },
+                destroy: function () {
+                    throw new NotYetImplementedError("Registration to ".concat(this.registerName, " is permanent in this version of Promptbook"));
+                },
+            };
         };
         return $Register;
     }());
@@ -940,6 +1029,9 @@
      * @public exported from `@promptbook/core`
      */
     var $llmToolsRegister = new $Register('llm_execution_tools_constructors');
+    /**
+     * TODO: [®] DRY Register logic
+     */
 
     /**
      * @@@
@@ -949,13 +1041,16 @@
      * @public exported from `@promptbook/core`
      */
     var $llmToolsMetadataRegister = new $Register('llm_tools_metadata');
+    /**
+     * TODO: [®] DRY Register logic
+     */
 
     /**
      * Creates a message with all registered LLM tools
      *
      * Note: This function is used to create a (error) message when there is no constructor for some LLM provider
      *
-     * @private internal function of `createLlmToolsFromConfiguration` and `createLlmToolsFromEnv`
+     * @private internal function of `createLlmToolsFromConfiguration` and `$provideLlmToolsFromEnv`
      */
     function $registeredLlmToolsMessage() {
         var e_1, _a, e_2, _b;
@@ -1047,6 +1142,9 @@
         })
             .join('\n')), "\n        "); });
     }
+    /**
+     * TODO: [®] DRY Register logic
+     */
 
     /**
      * @@@
@@ -1058,7 +1156,7 @@
      */
     function createLlmToolsFromConfiguration(configuration, options) {
         if (options === void 0) { options = {}; }
-        var _a = options.isVerbose, isVerbose = _a === void 0 ? IS_VERBOSE : _a;
+        var _a = options.isVerbose, isVerbose = _a === void 0 ? DEFAULT_IS_VERBOSE : _a, userId = options.userId;
         var llmTools = configuration.map(function (llmConfiguration) {
             var registeredItem = $llmToolsRegister
                 .list()
@@ -1069,17 +1167,18 @@
             if (registeredItem === undefined) {
                 throw new Error(spaceTrim__default["default"](function (block) { return "\n                        There is no constructor for LLM provider `".concat(llmConfiguration.className, "` from `").concat(llmConfiguration.packageName, "`\n\n                        You have probably forgotten install and import the provider package.\n                        To fix this issue, you can:\n\n                        Install:\n\n                        > npm install ").concat(llmConfiguration.packageName, "\n\n                        And import:\n\n                        > import '").concat(llmConfiguration.packageName, "';\n\n\n                        ").concat(block($registeredLlmToolsMessage()), "\n                    "); }));
             }
-            return registeredItem(__assign({ isVerbose: isVerbose }, llmConfiguration.options));
+            return registeredItem(__assign({ isVerbose: isVerbose, userId: userId }, llmConfiguration.options));
         });
         return joinLlmExecutionTools.apply(void 0, __spreadArray([], __read(llmTools), false));
     }
     /**
-     * TODO: [🎌] Togethere with `createLlmToolsFromConfiguration` + 'EXECUTION_TOOLS_CLASSES' gets to `@promptbook/core` ALL model providers, make this more efficient
+     * TODO: [🎌] Together with `createLlmToolsFromConfiguration` + 'EXECUTION_TOOLS_CLASSES' gets to `@promptbook/core` ALL model providers, make this more efficient
      * TODO: [🧠][🎌] Dynamically install required providers
      * TODO: @@@ write discussion about this - wizzard
      * TODO: [🧠][🍛] Which name is better `createLlmToolsFromConfig` or `createLlmToolsFromConfiguration`?
      * TODO: [🧠] Is there some meaningfull way how to test this util
      * TODO: This should be maybe not under `_common` but under `utils`
+     * TODO: [®] DRY Register logic
      */
 
     /**
@@ -1093,9 +1192,7 @@
      */
     function startRemoteServer(options) {
         var _this = this;
-        var _a = __assign({ isAnonymousModeAllowed: false, isCollectionModeAllowed: false, collection: null, createLlmExecutionTools: null }, options), port = _a.port, path = _a.path, collection = _a.collection, createLlmExecutionTools = _a.createLlmExecutionTools, 
-        //    <- TODO: [🧠][🤺] Remove `createLlmExecutionTools`, pass just `llmExecutionTools`
-        isAnonymousModeAllowed = _a.isAnonymousModeAllowed, isCollectionModeAllowed = _a.isCollectionModeAllowed, _b = _a.isVerbose, isVerbose = _b === void 0 ? IS_VERBOSE : _b;
+        var _a = __assign({ isAnonymousModeAllowed: false, isApplicationModeAllowed: false, collection: null, createLlmExecutionTools: null }, options), port = _a.port, path = _a.path, collection = _a.collection, createLlmExecutionTools = _a.createLlmExecutionTools, isAnonymousModeAllowed = _a.isAnonymousModeAllowed, isApplicationModeAllowed = _a.isApplicationModeAllowed, _b = _a.isVerbose, isVerbose = _b === void 0 ? DEFAULT_IS_VERBOSE : _b;
         // <- TODO: [🦪] Some helper type to be able to use discriminant union types with destructuring
         var httpServer = http__default["default"].createServer({}, function (request, response) { return __awaiter(_this, void 0, void 0, function () {
             var _a, _b;
@@ -1113,9 +1210,9 @@
                                 return __generator(this, function (_f) {
                                     switch (_f.label) {
                                         case 0:
-                                            _b = (_a = "\n                    Server for processing promptbook remote requests is running.\n\n                    Version: ".concat(PROMPTBOOK_VERSION, "\n                    Socket.io path: ").concat(path, "/socket.io\n                    Anonymouse mode: ").concat(isAnonymousModeAllowed ? 'enabled' : 'disabled', "\n                    Collection mode: ").concat(isCollectionModeAllowed ? 'enabled' : 'disabled', "\n                    ")).concat;
+                                            _b = (_a = "\n                    Server for processing promptbook remote requests is running.\n\n                    Version: ".concat(PROMPTBOOK_VERSION, "\n                    Socket.io path: ").concat(path, "/socket.io\n                    Anonymouse mode: ").concat(isAnonymousModeAllowed ? 'enabled' : 'disabled', "\n                    Application mode: ").concat(isApplicationModeAllowed ? 'enabled' : 'disabled', "\n                    ")).concat;
                                             _c = block;
-                                            if (!!isCollectionModeAllowed) return [3 /*break*/, 1];
+                                            if (!!isApplicationModeAllowed) return [3 /*break*/, 1];
                                             _d = '';
                                             return [3 /*break*/, 3];
                                         case 1:
@@ -1138,9 +1235,7 @@
                 }
             });
         }); });
-        var server = new socket_io.Server(
-        //            <- TODO: [🧱] Implement in a functional (not new Class) way
-        httpServer, {
+        var server = new socket_io.Server(httpServer, {
             path: path,
             transports: [/*'websocket', <- TODO: [🌬] Make websocket transport work */ 'polling'],
             cors: {
@@ -1153,145 +1248,155 @@
                 console.info(colors__default["default"].gray("Client connected"), socket.id);
             }
             socket.on('prompt-request', function (request) { return __awaiter(_this, void 0, void 0, function () {
-                var _a, isAnonymous, prompt, userId, llmToolsConfiguration, llmExecutionTools, promptResult, _b, error_1;
+                var _a, isAnonymous, prompt, appId, userId, customOptions, llmToolsConfiguration, llmExecutionTools, promptResult, _b, error_1;
                 return __generator(this, function (_c) {
                     switch (_c.label) {
                         case 0:
-                            _a = __assign({ userId: null, llmToolsConfiguration: null }, request), isAnonymous = _a.isAnonymous, prompt = _a.prompt, userId = _a.userId, llmToolsConfiguration = _a.llmToolsConfiguration;
+                            _a = __assign({ appId: null, customOptions: undefined, llmToolsConfiguration: null }, request), isAnonymous = _a.isAnonymous, prompt = _a.prompt, appId = _a.appId, userId = _a.userId, customOptions = _a.customOptions, llmToolsConfiguration = _a.llmToolsConfiguration;
                             // <- TODO: [🦪] Some helper type to be able to use discriminant union types with destructuring
                             if (isVerbose) {
                                 console.info(colors__default["default"].bgWhite("Prompt:"), colors__default["default"].gray(JSON.stringify(request, null, 4)));
                             }
                             _c.label = 1;
                         case 1:
-                            _c.trys.push([1, 14, 15, 16]);
+                            _c.trys.push([1, 15, 16, 17]);
                             if (isAnonymous === true && !isAnonymousModeAllowed) {
-                                throw new PipelineExecutionError("Anonymous mode is not allowed"); // <- TODO:[main] !!! Test
+                                throw new PipelineExecutionError("Anonymous mode is not allowed"); // <- TODO: [main] !!! Test
                             }
-                            if (isAnonymous === false && !isCollectionModeAllowed) {
-                                throw new PipelineExecutionError("Collection mode is not allowed"); // <- TODO:[main] !!! Test
+                            if (isAnonymous === false && !isApplicationModeAllowed) {
+                                throw new PipelineExecutionError("Application mode is not allowed"); // <- TODO: [main] !!! Test
                             }
                             llmExecutionTools = void 0;
                             if (!(isAnonymous === true && llmToolsConfiguration !== null)) return [3 /*break*/, 2];
                             // Note: Anonymouse mode
                             // TODO: Maybe check that configuration is not empty
                             llmExecutionTools = createLlmToolsFromConfiguration(llmToolsConfiguration, { isVerbose: isVerbose });
-                            return [3 /*break*/, 5];
+                            return [3 /*break*/, 6];
                         case 2:
-                            if (!(isAnonymous === false && createLlmExecutionTools !== null)) return [3 /*break*/, 4];
-                            // Note: Collection mode
-                            llmExecutionTools = createLlmExecutionTools(userId);
-                            return [4 /*yield*/, collection.isResponsibleForPrompt(prompt)];
+                            if (!(isAnonymous === false && createLlmExecutionTools !== null)) return [3 /*break*/, 5];
+                            return [4 /*yield*/, createLlmExecutionTools({
+                                    appId: appId,
+                                    userId: userId,
+                                    customOptions: customOptions,
+                                })];
                         case 3:
+                            // Note: Application mode
+                            llmExecutionTools = _c.sent();
+                            return [4 /*yield*/, collection.isResponsibleForPrompt(prompt)];
+                        case 4:
                             if (!(_c.sent())) {
                                 throw new PipelineExecutionError("Pipeline is not in the collection of this server");
                             }
-                            return [3 /*break*/, 5];
-                        case 4: throw new PipelineExecutionError("You must provide either llmToolsConfiguration or non-anonymous mode must be propperly configured");
-                        case 5:
+                            return [3 /*break*/, 6];
+                        case 5: throw new PipelineExecutionError("You must provide either llmToolsConfiguration or non-anonymous mode must be propperly configured");
+                        case 6:
                             promptResult = void 0;
                             _b = prompt.modelRequirements.modelVariant;
                             switch (_b) {
-                                case 'CHAT': return [3 /*break*/, 6];
-                                case 'COMPLETION': return [3 /*break*/, 8];
-                                case 'EMBEDDING': return [3 /*break*/, 10];
+                                case 'CHAT': return [3 /*break*/, 7];
+                                case 'COMPLETION': return [3 /*break*/, 9];
+                                case 'EMBEDDING': return [3 /*break*/, 11];
                             }
-                            return [3 /*break*/, 12];
-                        case 6:
+                            return [3 /*break*/, 13];
+                        case 7:
                             if (llmExecutionTools.callChatModel === undefined) {
                                 // Note: [0] This check should not be a thing
                                 throw new PipelineExecutionError("Chat model is not available");
                             }
                             return [4 /*yield*/, llmExecutionTools.callChatModel(prompt)];
-                        case 7:
-                            promptResult = _c.sent();
-                            return [3 /*break*/, 13];
                         case 8:
+                            promptResult = _c.sent();
+                            return [3 /*break*/, 14];
+                        case 9:
                             if (llmExecutionTools.callCompletionModel === undefined) {
                                 // Note: [0] This check should not be a thing
                                 throw new PipelineExecutionError("Completion model is not available");
                             }
                             return [4 /*yield*/, llmExecutionTools.callCompletionModel(prompt)];
-                        case 9:
-                            promptResult = _c.sent();
-                            return [3 /*break*/, 13];
                         case 10:
+                            promptResult = _c.sent();
+                            return [3 /*break*/, 14];
+                        case 11:
                             if (llmExecutionTools.callEmbeddingModel === undefined) {
                                 // Note: [0] This check should not be a thing
                                 throw new PipelineExecutionError("Embedding model is not available");
                             }
                             return [4 /*yield*/, llmExecutionTools.callEmbeddingModel(prompt)];
-                        case 11:
+                        case 12:
                             promptResult = _c.sent();
-                            return [3 /*break*/, 13];
-                        case 12: throw new PipelineExecutionError("Unknown model variant \"".concat(prompt.modelRequirements.modelVariant, "\""));
-                        case 13:
+                            return [3 /*break*/, 14];
+                        case 13: throw new PipelineExecutionError("Unknown model variant \"".concat(prompt.modelRequirements.modelVariant, "\""));
+                        case 14:
                             if (isVerbose) {
                                 console.info(colors__default["default"].bgGreen("PromptResult:"), colors__default["default"].green(JSON.stringify(promptResult, null, 4)));
                             }
-                            socket.emit('prompt-response', { promptResult: promptResult });
-                            return [3 /*break*/, 16];
-                        case 14:
+                            socket.emit('prompt-response', { promptResult: promptResult } /* <- TODO: [🤛] */);
+                            return [3 /*break*/, 17];
+                        case 15:
                             error_1 = _c.sent();
                             if (!(error_1 instanceof Error)) {
                                 throw error_1;
                             }
-                            socket.emit('error', serializeError(error_1));
-                            return [3 /*break*/, 16];
-                        case 15:
+                            socket.emit('error', serializeError(error_1) /* <- TODO: [🤛] */);
+                            return [3 /*break*/, 17];
+                        case 16:
                             socket.disconnect();
                             return [7 /*endfinally*/];
-                        case 16: return [2 /*return*/];
+                        case 17: return [2 /*return*/];
                     }
                 });
             }); });
             // TODO: [👒] Listing models (and checking configuration) probbably should go through REST API not Socket.io
             socket.on('listModels-request', function (request) { return __awaiter(_this, void 0, void 0, function () {
-                var _a, isAnonymous, llmToolsConfiguration, llmExecutionTools, models, error_2;
+                var _a, isAnonymous, appId, userId, customOptions, llmToolsConfiguration, llmExecutionTools, models, error_2;
                 return __generator(this, function (_b) {
                     switch (_b.label) {
                         case 0:
-                            _a = __assign({ llmToolsConfiguration: null }, request), isAnonymous = _a.isAnonymous, llmToolsConfiguration = _a.llmToolsConfiguration;
+                            _a = __assign({ appId: null, customOptions: undefined, llmToolsConfiguration: null }, request), isAnonymous = _a.isAnonymous, appId = _a.appId, userId = _a.userId, customOptions = _a.customOptions, llmToolsConfiguration = _a.llmToolsConfiguration;
                             // <- TODO: [🦪] Some helper type to be able to use discriminant union types with destructuring
                             if (isVerbose) {
                                 console.info(colors__default["default"].bgWhite("Listing models"));
                             }
                             _b.label = 1;
                         case 1:
-                            _b.trys.push([1, 3, 4, 5]);
+                            _b.trys.push([1, 6, 7, 8]);
                             if (isAnonymous === true && !isAnonymousModeAllowed) {
-                                throw new PipelineExecutionError("Anonymous mode is not allowed"); // <- TODO:[main] !!! Test
+                                throw new PipelineExecutionError("Anonymous mode is not allowed"); // <- TODO: [main] !!! Test
                             }
-                            if (isAnonymous === false && !isCollectionModeAllowed) {
-                                throw new PipelineExecutionError("Collection mode is not allowed"); // <- TODO:[main] !!! Test
+                            if (isAnonymous === false && !isApplicationModeAllowed) {
+                                throw new PipelineExecutionError("Application mode is not allowed"); // <- TODO: [main] !!! Test
                             }
                             llmExecutionTools = void 0;
-                            if (isAnonymous === true) {
-                                // Note: Anonymouse mode
-                                // TODO: Maybe check that configuration is not empty
-                                llmExecutionTools = createLlmToolsFromConfiguration(llmToolsConfiguration, { isVerbose: isVerbose });
-                            }
-                            else {
-                                // Note: Collection mode
-                                llmExecutionTools = createLlmExecutionTools(
-                                /* userId: */ undefined);
-                            }
-                            return [4 /*yield*/, llmExecutionTools.listModels()];
-                        case 2:
-                            models = _b.sent();
-                            socket.emit('listModels-response', { models: models });
-                            return [3 /*break*/, 5];
+                            if (!(isAnonymous === true)) return [3 /*break*/, 2];
+                            // Note: Anonymouse mode
+                            // TODO: Maybe check that configuration is not empty
+                            llmExecutionTools = createLlmToolsFromConfiguration(llmToolsConfiguration, { isVerbose: isVerbose });
+                            return [3 /*break*/, 4];
+                        case 2: return [4 /*yield*/, createLlmExecutionTools({
+                                appId: appId,
+                                userId: userId,
+                                customOptions: customOptions,
+                            })];
                         case 3:
+                            // Note: Application mode
+                            llmExecutionTools = _b.sent();
+                            _b.label = 4;
+                        case 4: return [4 /*yield*/, llmExecutionTools.listModels()];
+                        case 5:
+                            models = _b.sent();
+                            socket.emit('listModels-response', { models: models } /* <- TODO: [🤛] */);
+                            return [3 /*break*/, 8];
+                        case 6:
                             error_2 = _b.sent();
                             if (!(error_2 instanceof Error)) {
                                 throw error_2;
                             }
                             socket.emit('error', serializeError(error_2));
-                            return [3 /*break*/, 5];
-                        case 4:
+                            return [3 /*break*/, 8];
+                        case 7:
                             socket.disconnect();
                             return [7 /*endfinally*/];
-                        case 5: return [2 /*return*/];
+                        case 8: return [2 /*return*/];
                     }
                 });
             }); });