@promptbook/openai 0.72.0-8 → 0.72.0

package/README.md

@@ -2,7 +2,7 @@
 
 # ![Promptbook logo - cube with letters P and B](./other/design/logo-h1.png) Promptbook
 
-Supercharge your use of large language models
+Build responsible, controlled and transparent applications on top of LLM models!
 
 
 
@@ -20,10 +20,6 @@ Supercharge your use of large language models
 
 -   ✨ **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/openai`
@@ -47,31 +43,37 @@ npm install @promptbook/openai
 
 ```typescript
 import { createPipelineExecutor, assertsExecutionSuccessful } from '@promptbook/core';
-import { createCollectionFromDirectory } from '@promptbook/node';
+import {
+    createCollectionFromDirectory,
+    $provideExecutionToolsForNode,
+    $provideFilesystemForNode,
+} from '@promptbook/node';
 import { JavascriptExecutionTools } from '@promptbook/execute-javascript';
 import { OpenAiExecutionTools } from '@promptbook/openai';
 
+// ▶ Prepare tools
+const fs = $provideFilesystemForNode();
+const llm = new OpenAiExecutionTools(
+    //            <- TODO: [🧱] Implement in a functional (not new Class) way
+    {
+        isVerbose: true,
+        apiKey: process.env.OPENAI_API_KEY,
+    },
+);
+const executables = await $provideExecutablesForNode();
+const tools = {
+    llm,
+    fs,
+    scrapers: await $provideScrapersForNode({ fs, llm, executables }),
+    script: [new JavascriptExecutionTools()],
+};
+
 // ▶ Create whole pipeline collection
-const collection = await createCollectionFromDirectory('./promptbook-collection');
+const collection = await createCollectionFromDirectory('./promptbook-collection', tools);
 
 // ▶ Get single Pipeline
 const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.ptbk.md`);
 
-// ▶ Prepare tools
-const tools = {
-    llm: new OpenAiExecutionTools(
-        //            <- TODO: [🧱] Implement in a functional (not new Class) way
-        {
-            isVerbose: true,
-            apiKey: process.env.OPENAI_API_KEY,
-        },
-    ),
-    script: [
-        new JavascriptExecutionTools(),
-        //            <- TODO: [🧱] Implement in a functional (not new Class) way
-    ],
-};
-
 // ▶ Create executor - the function that will execute the Pipeline
 const pipelineExecutor = createPipelineExecutor({ pipeline, tools });
 
@@ -91,34 +93,29 @@ console.info(outputParameters);
 
 ## 🤺 Usage with OpenAI`s Assistants (GPTs)
 
-!!!!!!
-OpenAiExecutionTools.createAssistantSubtools
+> TODO: Write a guide how to use OpenAI's Assistants with Promptbook
+
+
 
 ## 🧙‍♂️ Connect to LLM providers automatically
 
-You can just use `createLlmToolsFromEnv` function to create LLM tools from environment variables like `OPENAI_API_KEY` and `ANTHROPIC_CLAUDE_API_KEY` automatically.
+You can just use `$provideExecutionToolsForNode` function to create all required tools from environment variables like `OPENAI_API_KEY` and `ANTHROPIC_CLAUDE_API_KEY` automatically.
 
 ```typescript
 import { createPipelineExecutor, createCollectionFromDirectory, assertsExecutionSuccessful } from '@promptbook/core';
 import { JavascriptExecutionTools } from '@promptbook/execute-javascript';
-import { createLlmToolsFromEnv } from '@promptbook/node';
+import { $provideExecutionToolsForNode } from '@promptbook/node';
+import { $provideFilesystemForNode } from '@promptbook/node';
+
+// ▶ Prepare tools
+const tools = await $provideExecutionToolsForNode();
 
 // ▶ Create whole pipeline collection
-const collection = await createCollectionFromDirectory('./promptbook-collection');
+const collection = await createCollectionFromDirectory('./promptbook-collection', tools);
 
 // ▶ Get single Pipeline
 const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.ptbk.md`);
 
-// ▶ Prepare multiple tools
-const tools = {
-    // Note: 🧙‍♂️ Just call `createLlmToolsFromEnv` to automatically connect to all configured providers
-    llm: createLlmToolsFromEnv(),
-    script: [
-        new JavascriptExecutionTools(),
-        //            <- TODO: [🧱] Implement in a functional (not new Class) way
-    ],
-};
-
 // ▶ Create executor - the function that will execute the Pipeline
 const pipelineExecutor = createPipelineExecutor({ pipeline, tools });
 
@@ -142,50 +139,56 @@ You can use multiple LLM providers in one Promptbook execution. The best model w
 
 ```typescript
 import { createPipelineExecutor, assertsExecutionSuccessful } from '@promptbook/core';
-import { createCollectionFromDirectory } from '@promptbook/node';
+import {
+    createCollectionFromDirectory,
+    $provideExecutionToolsForNode,
+    $provideFilesystemForNode,
+} from '@promptbook/node';
 import { JavascriptExecutionTools } from '@promptbook/execute-javascript';
 import { OpenAiExecutionTools } from '@promptbook/openai';
 import { AnthropicClaudeExecutionTools } from '@promptbook/anthropic-claude';
 import { AzureOpenAiExecutionTools } from '@promptbook/azure-openai';
 
+// ▶ Prepare multiple tools
+const fs = $provideFilesystemForNode();
+const llm = [
+    // Note: You can use multiple LLM providers in one Promptbook execution.
+    //       The best model will be chosen automatically according to the prompt and the model's capabilities.
+    new OpenAiExecutionTools(
+        //            <- TODO: [🧱] Implement in a functional (not new Class) way
+        {
+            apiKey: process.env.OPENAI_API_KEY,
+        },
+    ),
+    new AnthropicClaudeExecutionTools(
+        //            <- TODO: [🧱] Implement in a functional (not new Class) way
+        {
+            apiKey: process.env.ANTHROPIC_CLAUDE_API_KEY,
+        },
+    ),
+    new AzureOpenAiExecutionTools(
+        //            <- TODO: [🧱] Implement in a functional (not new Class) way
+        {
+            resourceName: process.env.AZUREOPENAI_RESOURCE_NAME,
+            deploymentName: process.env.AZUREOPENAI_DEPLOYMENT_NAME,
+            apiKey: process.env.AZUREOPENAI_API_KEY,
+        },
+    ),
+];
+const executables = await $provideExecutablesForNode();
+const tools = {
+    llm,
+    fs,
+    scrapers: await $provideScrapersForNode({ fs, llm, executables }),
+    script: [new JavascriptExecutionTools()],
+};
+
 // ▶ Create whole pipeline collection
-const collection = await createCollectionFromDirectory('./promptbook-collection');
+const collection = await createCollectionFromDirectory('./promptbook-collection', tools);
 
 // ▶ Get single Pipeline
 const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.ptbk.md`);
 
-// ▶ Prepare multiple tools
-const tools = {
-    llm: [
-        // Note: You can use multiple LLM providers in one Promptbook execution.
-        //       The best model will be chosen automatically according to the prompt and the model's capabilities.
-        new OpenAiExecutionTools(
-            //            <- TODO: [🧱] Implement in a functional (not new Class) way
-            {
-                apiKey: process.env.OPENAI_API_KEY,
-            },
-        ),
-        new AnthropicClaudeExecutionTools(
-            //            <- TODO: [🧱] Implement in a functional (not new Class) way
-            {
-                apiKey: process.env.ANTHROPIC_CLAUDE_API_KEY,
-            },
-        ),
-        new AzureOpenAiExecutionTools(
-            //            <- TODO: [🧱] Implement in a functional (not new Class) way
-            {
-                resourceName: process.env.AZUREOPENAI_RESOURCE_NAME,
-                deploymentName: process.env.AZUREOPENAI_DEPLOYMENT_NAME,
-                apiKey: process.env.AZUREOPENAI_API_KEY,
-            },
-        ),
-    ],
-    script: [
-        new JavascriptExecutionTools(),
-        //            <- TODO: [🧱] Implement in a functional (not new Class) way
-    ],
-};
-
 // ▶ Create executor - the function that will execute the Pipeline
 const pipelineExecutor = createPipelineExecutor({ pipeline, tools });
 
@@ -221,15 +224,15 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
 
 
 
-If you have a simple, single prompt for ChatGPT, GPT-4, Anthropic Claude, Google Gemini, Llama 2, or whatever, it doesn't matter how you integrate it. Whether it's calling a REST API directly, using the SDK, hardcoding the prompt into the source code, or importing a text file, the process remains the same.
+If you have a simple, single prompt for ChatGPT, GPT-4, Anthropic Claude, Google Gemini, Llama 3, or whatever, it doesn't matter how you integrate it. Whether it's calling a REST API directly, using the SDK, hardcoding the prompt into the source code, or importing a text file, the process remains the same.
 
-But often you will struggle with the limitations of LLMs, such as hallucinations, off-topic responses, poor quality output, language drift, word repetition repetition repetition repetition or misuse, lack of context, or just plain w𝒆𝐢rd responses. When this happens, you generally have three options:
+But often you will struggle with the **limitations of LLMs**, such as **hallucinations, off-topic responses, poor quality output, language and prompt drift, word repetition repetition repetition repetition or misuse, lack of context, or just plain w𝒆𝐢rd responses**. When this happens, you generally have three options:
 
 1. **Fine-tune** the model to your specifications or even train your own.
 2. **Prompt-engineer** the prompt to the best shape you can achieve.
 3. Orchestrate **multiple prompts** in a [pipeline](https://github.com/webgptorg/promptbook/discussions/64) to get the best result.
 
-In all of these situations, but especially in 3., the Promptbook library can make your life easier.
+In all of these situations, but especially in 3., the **✨ Promptbook can make your life waaaaaaaaaay easier**.
 
 -   [**Separates concerns**](https://github.com/webgptorg/promptbook/discussions/32) between prompt-engineer and programmer, between code files and prompt files, and between prompts and their execution logic.
 -   Establishes a [**common format `.ptbk.md`**](https://github.com/webgptorg/promptbook/discussions/85) that can be used to describe your prompt business logic without having to write code or deal with the technicalities of LLMs.
@@ -501,6 +504,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

@@ -6,7 +6,7 @@ import OpenAI from 'openai';
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.72.0-7';
+var PROMPTBOOK_VERSION = '0.72.0-34';
 // TODO: [main] !!!! List here all the versions and annotate + put into script
 
 /*! *****************************************************************************
@@ -1413,7 +1413,6 @@ var OpenAiExecutionTools = /** @class */ (function () {
      * @param options which are relevant are directly passed to the OpenAI client
      */
     function OpenAiExecutionTools(options) {
-        if (options === void 0) { options = {}; }
         this.options = options;
         /**
          * OpenAI API client.
@@ -1441,8 +1440,8 @@ var OpenAiExecutionTools = /** @class */ (function () {
                 if (this.client === null) {
                     openAiOptions = __assign({}, this.options);
                     delete openAiOptions.isVerbose;
-                    delete openAiOptions.user;
-                    this.client = new OpenAI(__assign({}, openAiOptions));
+                    delete openAiOptions.userId;
+                    this.client = new OpenAI(openAiOptions);
                 }
                 return [2 /*return*/, this.client];
             });
@@ -1489,11 +1488,12 @@ var OpenAiExecutionTools = /** @class */ (function () {
      * Calls OpenAI API to use a chat model.
      */
     OpenAiExecutionTools.prototype.callChatModel = function (prompt) {
+        var _a;
         return __awaiter(this, void 0, void 0, function () {
             var content, parameters, modelRequirements, format, client, modelName, modelSettings, rawPromptContent, rawRequest, start, complete, rawResponse, resultContent, usage;
             var _this = this;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
                         if (this.options.isVerbose) {
                             console.info('💬 OpenAI callChatModel call', { prompt: prompt });
@@ -1501,7 +1501,7 @@ var OpenAiExecutionTools = /** @class */ (function () {
                         content = prompt.content, parameters = prompt.parameters, modelRequirements = prompt.modelRequirements, format = prompt.format;
                         return [4 /*yield*/, this.getClient()];
                     case 1:
-                        client = _a.sent();
+                        client = _b.sent();
                         // TODO: [☂] Use here more modelRequirements
                         if (modelRequirements.modelVariant !== 'CHAT') {
                             throw new PipelineExecutionError('Use callChatModel only for CHAT variant');
@@ -1533,7 +1533,7 @@ var OpenAiExecutionTools = /** @class */ (function () {
                                     role: 'user',
                                     content: rawPromptContent,
                                 },
-                            ], false), user: this.options.user });
+                            ], false), user: (_a = this.options.userId) === null || _a === void 0 ? void 0 : _a.toString() });
                         start = getCurrentIsoDate();
                         if (this.options.isVerbose) {
                             console.info(colors.bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
@@ -1545,7 +1545,7 @@ var OpenAiExecutionTools = /** @class */ (function () {
                                 throw error;
                             })];
                     case 2:
-                        rawResponse = _a.sent();
+                        rawResponse = _b.sent();
                         if (this.options.isVerbose) {
                             console.info(colors.bgWhite('rawResponse'), JSON.stringify(rawResponse, null, 4));
                         }
@@ -1584,11 +1584,12 @@ var OpenAiExecutionTools = /** @class */ (function () {
      * Calls OpenAI API to use a complete model.
      */
     OpenAiExecutionTools.prototype.callCompletionModel = function (prompt) {
+        var _a;
         return __awaiter(this, void 0, void 0, function () {
             var content, parameters, modelRequirements, client, modelName, modelSettings, rawPromptContent, rawRequest, start, complete, rawResponse, resultContent, usage;
             var _this = this;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
                         if (this.options.isVerbose) {
                             console.info('🖋 OpenAI callCompletionModel call', { prompt: prompt });
@@ -1596,7 +1597,7 @@ var OpenAiExecutionTools = /** @class */ (function () {
                         content = prompt.content, parameters = prompt.parameters, modelRequirements = prompt.modelRequirements;
                         return [4 /*yield*/, this.getClient()];
                     case 1:
-                        client = _a.sent();
+                        client = _b.sent();
                         // TODO: [☂] Use here more modelRequirements
                         if (modelRequirements.modelVariant !== 'COMPLETION') {
                             throw new PipelineExecutionError('Use callCompletionModel only for COMPLETION variant');
@@ -1611,7 +1612,7 @@ var OpenAiExecutionTools = /** @class */ (function () {
                             // <- Note: [🧆]
                         };
                         rawPromptContent = replaceParameters(content, __assign(__assign({}, parameters), { modelName: modelName }));
-                        rawRequest = __assign(__assign({}, modelSettings), { prompt: rawPromptContent, user: this.options.user });
+                        rawRequest = __assign(__assign({}, modelSettings), { prompt: rawPromptContent, user: (_a = this.options.userId) === null || _a === void 0 ? void 0 : _a.toString() });
                         start = getCurrentIsoDate();
                         if (this.options.isVerbose) {
                             console.info(colors.bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
@@ -1623,7 +1624,7 @@ var OpenAiExecutionTools = /** @class */ (function () {
                                 throw error;
                             })];
                     case 2:
-                        rawResponse = _a.sent();
+                        rawResponse = _b.sent();
                         if (this.options.isVerbose) {
                             console.info(colors.bgWhite('rawResponse'), JSON.stringify(rawResponse, null, 4));
                         }
@@ -1849,17 +1850,16 @@ var OpenAiAssistantExecutionTools = /** @class */ (function (_super) {
                             assistant_id: this.assistantId,
                             thread: {
                                 messages: [
-                                    // TODO: !!!!!! Allow threads to be passed
+                                    // TODO:  [🗯] !! Allow threads to be passed
                                     { role: 'user', content: rawPromptContent },
                                 ],
                             },
-                            // !!!!!! user: this.options.user,
+                            // <- TODO: Add user identification here> user: this.options.user,
                         };
                         start = getCurrentIsoDate();
                         if (this.options.isVerbose) {
                             console.info(colors.bgWhite('rawRequest'), JSON.stringify(rawRequest, null, 4));
                         }
-                        console.log('!!!!!! OpenAI client', client);
                         return [4 /*yield*/, client.beta.threads.createAndRunStream(rawRequest)];
                     case 2:
                         stream = _g.sent();
@@ -1877,7 +1877,7 @@ var OpenAiAssistantExecutionTools = /** @class */ (function (_super) {
                                 messageDelta.content[0].type === 'text') {
                                 console.info('messageDelta', (_a = messageDelta.content[0].text) === null || _a === void 0 ? void 0 : _a.value);
                             }
-                            // TODO: !!!!!! report progress
+                            // <- TODO: [🐚] Make streaming and running tasks working
                         });
                         stream.on('messageCreated', function (message) {
                             if (_this.options.isVerbose) {
@@ -1905,18 +1905,20 @@ var OpenAiAssistantExecutionTools = /** @class */ (function (_super) {
                             throw new PipelineExecutionError("There is NOT 'text' BUT ".concat((_b = rawResponse[0].content[0]) === null || _b === void 0 ? void 0 : _b.type, " finalMessages content type from OpenAI"));
                         }
                         resultContent = (_c = rawResponse[0].content[0]) === null || _c === void 0 ? void 0 : _c.text.value;
-                        //                                                     <- TODO: !!!!!! There are also annotations, maybe use them
+                        //                                                     <- TODO: [🧠] There are also annotations, maybe use them
                         // eslint-disable-next-line prefer-const
                         complete = getCurrentIsoDate();
                         usage = UNCERTAIN_USAGE;
-                        // TODO: !!!!!!> = computeOpenAiUsage(content, resultContent || '', rawResponse);
+                        // <- TODO: [🥘] Compute real usage for assistant
+                        //       ?> const usage = computeOpenAiUsage(content, resultContent || '', rawResponse);
                         if (resultContent === null) {
                             throw new PipelineExecutionError('No response message from OpenAI');
                         }
                         return [2 /*return*/, $asDeeplyFrozenSerializableJson('OpenAiAssistantExecutionTools ChatPromptResult', {
                                 content: resultContent,
                                 modelName: 'assistant',
-                                //          <- TODO: !!!!!! Can we detect really used model: rawResponse.model || modelName,
+                                // <- TODO: [🥘] Detect used model in assistant
+                                //       ?> model: rawResponse.model || modelName,
                                 timing: {
                                     start: start,
                                     complete: complete,
@@ -1934,7 +1936,6 @@ var OpenAiAssistantExecutionTools = /** @class */ (function (_super) {
     return OpenAiAssistantExecutionTools;
 }(OpenAiExecutionTools));
 /**
- * TODO: !!!!!! DO not use colors - can be used in browser
  * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
  * TODO: Maybe make custom OpenAiError
  * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
@@ -1992,6 +1993,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 @@@
  *
@@ -2000,9 +2080,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] = [];
@@ -2013,11 +2093,10 @@ var $Register = /** @class */ (function () {
         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];
@@ -2027,6 +2106,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;
 }());
@@ -2039,11 +2129,14 @@ var $Register = /** @class */ (function () {
  * @public exported from `@promptbook/core`
  */
 var $llmToolsRegister = new $Register('llm_execution_tools_constructors');
+/**
+ * TODO: [®] DRY Register logic
+ */
 
 /**
- * @@@ registration2
+ * Registration of LLM provider
  *
- * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
  *
  * @public exported from `@promptbook/openai`
  * @public exported from `@promptbook/cli`