@promptbook/remote-server 0.72.0-0 → 0.72.0-10

package/README.md

@@ -16,6 +16,16 @@ Supercharge your use of large language models
 
 
 
+## ✨ New Features
+
+-   ✨ **Support of [OpenAI o1 model](https://openai.com/o1/)**
+
+<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/remote-server`
 
 - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
@@ -28,7 +38,7 @@ To install this package, run:
 npm i ptbk
 
 # Install just this package to save space
-npm i @promptbook/remote-server
+npm install @promptbook/remote-server
 ```
 
 
@@ -38,10 +48,6 @@ npm i @promptbook/remote-server
 
 Rest of the documentation is common for **entire promptbook ecosystem**:
 
-# ✨ New Features
-
--   ✨ **Support [OpenAI o1 model](https://openai.com/o1/)**
-
 ## 🤍 The Promptbook Whitepaper
 
 
@@ -88,7 +94,6 @@ File `write-website-content.ptbk.md`:
 > Instructions for creating web page content.
 >
 > -   PIPELINE URL https://promptbook.studio/webgpt/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 `{websiteContent}` Web content
@@ -327,6 +332,10 @@ Or you can install them separately:
 -   **[@promptbook/fake-llm](https://www.npmjs.com/package/@promptbook/fake-llm)** - Mocked execution tools for testing the library and saving the tokens
 -   **[@promptbook/remote-client](https://www.npmjs.com/package/@promptbook/remote-client)** - Remote client for remote execution of promptbooks
 -   **[@promptbook/remote-server](https://www.npmjs.com/package/@promptbook/remote-server)** - Remote server for remote execution of promptbooks
+-   **[@promptbook/pdf](https://www.npmjs.com/package/@promptbook/pdf)** - Read knowledge from `.pdf` documents
+-   **[@promptbook/documents](https://www.npmjs.com/package/@promptbook/documents)** - Read knowledge from documents like `.docx`, `.odt`,…
+-   **[@promptbook/legacy-documents](https://www.npmjs.com/package/@promptbook/legacy-documents)** - Read knowledge from legacy documents like `.doc`, `.rtf`,…
+-   **[@promptbook/website-crawler](https://www.npmjs.com/package/@promptbook/website-crawler)** - Crawl knowledge from the web
 -   **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
 -   **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
 

package/esm/index.es.js

@@ -7,8 +7,8 @@ import spaceTrim$1, { spaceTrim } from 'spacetrim';
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.68.5';
-// TODO:[main] !!!! List here all the versions and annotate + put into script
+var PROMPTBOOK_VERSION = '0.72.0-9';
+// TODO: [main] !!!! List here all the versions and annotate + put into script
 
 /*! *****************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -354,10 +354,22 @@ $asDeeplyFrozenSerializableJson('RESERVED_PARAMETER_NAMES', [
     'samples',
     'modelName',
     'currentDate',
+    // <- TODO: !!!!! list here all command names
     // <- TODO: Add more like 'date', 'modelName',...
     // <- TODO: Add [emoji] + instructions ACRY when adding new reserved parameter
 ]);
 // <- TODO: [🧜‍♂️]
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+Object.freeze({
+    delimiter: ',',
+    quoteChar: '"',
+    newline: '\n',
+    skipEmptyLines: true,
+});
 /**
  * @@@
  *
@@ -576,6 +588,7 @@ function serializeError(error) {
  *
  * Note: Internal utility of `joinLlmExecutionTools` but exposed type
  * @public exported from `@promptbook/types`
+ * TODO: !!!!!! Export as runtime class not just type
  */
 var MultipleLlmExecutionTools = /** @class */ (function () {
     /**
@@ -597,9 +610,10 @@ var MultipleLlmExecutionTools = /** @class */ (function () {
     });
     Object.defineProperty(MultipleLlmExecutionTools.prototype, "description", {
         get: function () {
-            return this.llmExecutionTools
-                .map(function (tools, index) { return "".concat(index + 1, ") ").concat(tools.title, " ").concat(tools.description || ''); })
-                .join('\n');
+            return this.llmExecutionTools.map(function (_a, index) {
+                var title = _a.title;
+                return "".concat(index + 1, ") `").concat(title, "`");
+            }).join('\n');
         },
         enumerable: false,
         configurable: true
@@ -797,9 +811,7 @@ var MultipleLlmExecutionTools = /** @class */ (function () {
                             throw new PipelineExecutionError("You have not provided any `LlmExecutionTools`");
                         }
                         else {
-                            throw new PipelineExecutionError(spaceTrim$1(function (block) { return "\n                          You have not provided any `LlmExecutionTools` that support model variant \"".concat(prompt.modelRequirements.modelVariant, "\n\n                          Available `LlmExecutionTools`:\n                          ").concat(block(_this.llmExecutionTools
-                                .map(function (tools) { return "- ".concat(tools.title, " ").concat(tools.description || ''); })
-                                .join('\n')), "\n\n                    "); }));
+                            throw new PipelineExecutionError(spaceTrim$1(function (block) { return "\n                          You have not provided any `LlmExecutionTools` that support model variant \"".concat(prompt.modelRequirements.modelVariant, "\"\n\n                          Available `LlmExecutionTools`:\n                          ").concat(block(_this.description), "\n\n                    "); }));
                         }
                 }
             });
@@ -875,6 +887,85 @@ function $getGlobalScope() {
     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 @@@
  *
@@ -883,9 +974,9 @@ function $getGlobalScope() {
  * @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] = [];
@@ -900,7 +991,6 @@ var $Register = /** @class */ (function () {
         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];
@@ -910,6 +1000,17 @@ var $Register = /** @class */ (function () {
         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;
 }());
@@ -922,6 +1023,9 @@ var $Register = /** @class */ (function () {
  * @public exported from `@promptbook/core`
  */
 var $llmToolsRegister = new $Register('llm_execution_tools_constructors');
+/**
+ * TODO: [®] DRY Register logic
+ */
 
 /**
  * @@@
@@ -931,13 +1035,16 @@ var $llmToolsRegister = new $Register('llm_execution_tools_constructors');
  * @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;
@@ -1029,6 +1136,9 @@ function $registeredLlmToolsMessage() {
     })
         .join('\n')), "\n        "); });
 }
+/**
+ * TODO: [®] DRY Register logic
+ */
 
 /**
  * @@@
@@ -1056,12 +1166,13 @@ function createLlmToolsFromConfiguration(configuration, 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
  */
 
 /**
@@ -1075,9 +1186,7 @@ function createLlmToolsFromConfiguration(configuration, options) {
  */
 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 ? IS_VERBOSE : _b;
     // <- TODO: [🦪] Some helper type to be able to use discriminant union types with destructuring
     var httpServer = http.createServer({}, function (request, response) { return __awaiter(_this, void 0, void 0, function () {
         var _a, _b;
@@ -1095,9 +1204,9 @@ function startRemoteServer(options) {
                             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:
@@ -1120,9 +1229,7 @@ function startRemoteServer(options) {
             }
         });
     }); });
-    var server = new Server(
-    //            <- TODO: [🧱] Implement in a functional (not new Class) way
-    httpServer, {
+    var server = new Server(httpServer, {
         path: path,
         transports: [/*'websocket', <- TODO: [🌬] Make websocket transport work */ 'polling'],
         cors: {
@@ -1135,11 +1242,11 @@ function startRemoteServer(options) {
             console.info(colors.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.bgWhite("Prompt:"), colors.gray(JSON.stringify(request, null, 4)));
@@ -1148,10 +1255,10 @@ function startRemoteServer(options) {
                     case 1:
                         _c.trys.push([1, 14, 15, 16]);
                         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];
@@ -1161,8 +1268,12 @@ function startRemoteServer(options) {
                         return [3 /*break*/, 5];
                     case 2:
                         if (!(isAnonymous === false && createLlmExecutionTools !== null)) return [3 /*break*/, 4];
-                        // Note: Collection mode
-                        llmExecutionTools = createLlmExecutionTools(userId);
+                        // Note: Application mode
+                        llmExecutionTools = createLlmExecutionTools({
+                            appId: appId,
+                            userId: userId,
+                            customOptions: customOptions,
+                        });
                         return [4 /*yield*/, collection.isResponsibleForPrompt(prompt)];
                     case 3:
                         if (!(_c.sent())) {
@@ -1211,14 +1322,14 @@ function startRemoteServer(options) {
                         if (isVerbose) {
                             console.info(colors.bgGreen("PromptResult:"), colors.green(JSON.stringify(promptResult, null, 4)));
                         }
-                        socket.emit('prompt-response', { promptResult: promptResult });
+                        socket.emit('prompt-response', { promptResult: promptResult } /* <- TODO: [🤛] */);
                         return [3 /*break*/, 16];
                     case 14:
                         error_1 = _c.sent();
                         if (!(error_1 instanceof Error)) {
                             throw error_1;
                         }
-                        socket.emit('error', serializeError(error_1));
+                        socket.emit('error', serializeError(error_1) /* <- TODO: [🤛] */);
                         return [3 /*break*/, 16];
                     case 15:
                         socket.disconnect();
@@ -1229,11 +1340,11 @@ function startRemoteServer(options) {
         }); });
         // 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.bgWhite("Listing models"));
@@ -1242,10 +1353,10 @@ function startRemoteServer(options) {
                     case 1:
                         _b.trys.push([1, 3, 4, 5]);
                         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) {
@@ -1254,14 +1365,17 @@ function startRemoteServer(options) {
                             llmExecutionTools = createLlmToolsFromConfiguration(llmToolsConfiguration, { isVerbose: isVerbose });
                         }
                         else {
-                            // Note: Collection mode
-                            llmExecutionTools = createLlmExecutionTools(
-                            /* userId: */ undefined);
+                            // Note: Application mode
+                            llmExecutionTools = createLlmExecutionTools({
+                                appId: appId,
+                                userId: userId,
+                                customOptions: customOptions,
+                            });
                         }
                         return [4 /*yield*/, llmExecutionTools.listModels()];
                     case 2:
                         models = _b.sent();
-                        socket.emit('listModels-response', { models: models });
+                        socket.emit('listModels-response', { models: models } /* <- TODO: [🤛] */);
                         return [3 /*break*/, 5];
                     case 3:
                         error_2 = _b.sent();