@promptbook/cli 0.66.0-4 → 0.66.0-6

package/esm/index.es.js

@@ -20,7 +20,7 @@ import glob from 'glob-promise';
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.66.0-3';
+var PROMPTBOOK_VERSION = '0.66.0-5';
 // TODO: !!!! List here all the versions and annotate + put into script
 
 /*! *****************************************************************************
@@ -303,6 +303,18 @@ var RESERVED_PARAMETER_MISSING_VALUE = 'MISSING-' + REPLACING_NONCE;
  * @private within the repository
  */
 var RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+var DEFAULT_REMOTE_URL = 'https://api.pavolhejny.com/';
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+var DEFAULT_REMOTE_URL_PATH = '/promptbook/socket.io';
 /**
  * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
  */
@@ -835,7 +847,7 @@ function forEachAsync(array, options, callbackfunction) {
     });
 }
 
-var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.66.0-3",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n-   Make pieces of information concise, clear, and easy to understand\n-   One piece of information should be approximately 1 paragraph\n-   Divide the paragraphs by markdown horizontal lines ---\n-   Omit irrelevant information\n-   Group redundant information\n-   Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {knowledgeContent}",dependentParameterNames:["knowledgeContent"],resultingParameterName:"knowledgePieces"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-knowledge-from-markdown.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.ptbk.md",promptbookVersion:"0.66.0-3",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},content:"You are experienced data researcher, detect the important keywords in the document.\n\n# Rules\n\n-   Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {knowledgePieceContent}",dependentParameterNames:["knowledgePieceContent"],resultingParameterName:"keywords"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-knowledge-keywords.ptbk.md"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.ptbk.md",promptbookVersion:"0.66.0-3",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},content:"You are experienced content creator, write best title for the document.\n\n# Rules\n\n-   Write just title, nothing else\n-   Title should be concise and clear\n-   Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}",expectations:{words:{min:1,max:8}},dependentParameterNames:["knowledgePieceContent"],resultingParameterName:"title"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-knowledge-title.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.ptbk.md",promptbookVersion:"0.66.0-3",parameters:[{name:"availableModelNames",description:"List of available model names separated by comma (,)",isInput:true,isOutput:false},{name:"personaDescription",description:"Description of the persona",isInput:true,isOutput:false},{name:"modelRequirements",description:"Specific requirements for the model",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"make-model-requirements",title:"Make modelRequirements",modelRequirements:{modelVariant:"CHAT",modelName:"gpt-4-turbo"},content:"You are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Sample\n\n```json\n{\n\"modelName\": \"gpt-4o\",\n\"systemMessage\": \"You are experienced AI engineer and helpfull assistant.\",\n\"temperature\": 0.7\n}\n```\n\n## Instructions\n\n### Option `modelName`\n\nPick from the following models:\n\n-   {availableModelNames}\n\n### Option `systemMessage`\n\nThe system message is used to communicate instructions or provide context to the model at the beginning of a conversation. It is displayed in a different format compared to user messages, helping the model understand its role in the conversation. The system message typically guides the model's behavior, sets the tone, or specifies desired output from the model. By utilizing the system message effectively, users can steer the model towards generating more accurate and relevant responses.\n\nFor example:\n\n> You are an experienced AI engineer and helpful assistant.\n\n> You are a friendly and knowledgeable chatbot.\n\n### Option `temperature`\n\nThe sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.\n\nYou can pick a value between 0 and 2. For example:\n\n-   `0.1`: Low temperature, extremely conservative and deterministic\n-   `0.5`: Medium temperature, balanced between conservative and creative\n-   `1.0`: High temperature, creative and bit random\n-   `1.5`: Very high temperature, extremely creative and often chaotic and unpredictable\n-   `2.0`: Maximum temperature, completely random and unpredictable, for some extreme creative use cases\n\n# The assistant\n\nTake this description of the persona:\n\n> {personaDescription}",expectFormat:"JSON",dependentParameterNames:["availableModelNames","personaDescription"],resultingParameterName:"modelRequirements"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-persona.ptbk.md"}];
+var PipelineCollection = [{title:"Prepare Knowledge from Markdown",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-from-markdown.ptbk.md",promptbookVersion:"0.66.0-5",parameters:[{name:"knowledgeContent",description:"Markdown document content",isInput:true,isOutput:false},{name:"knowledgePieces",description:"The knowledge JSON object",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},content:"You are experienced data researcher, extract the important knowledge from the document.\n\n# Rules\n\n-   Make pieces of information concise, clear, and easy to understand\n-   One piece of information should be approximately 1 paragraph\n-   Divide the paragraphs by markdown horizontal lines ---\n-   Omit irrelevant information\n-   Group redundant information\n-   Write just extracted information, nothing else\n\n# The document\n\nTake information from this document:\n\n> {knowledgeContent}",dependentParameterNames:["knowledgeContent"],resultingParameterName:"knowledgePieces"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-knowledge-from-markdown.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-keywords.ptbk.md",promptbookVersion:"0.66.0-5",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"keywords",description:"Keywords separated by comma",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},content:"You are experienced data researcher, detect the important keywords in the document.\n\n# Rules\n\n-   Write just keywords separated by comma\n\n# The document\n\nTake information from this document:\n\n> {knowledgePieceContent}",dependentParameterNames:["knowledgePieceContent"],resultingParameterName:"keywords"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-knowledge-keywords.ptbk.md"},{title:"Prepare Title",pipelineUrl:"https://promptbook.studio/promptbook/prepare-knowledge-title.ptbk.md",promptbookVersion:"0.66.0-5",parameters:[{name:"knowledgePieceContent",description:"The content",isInput:true,isOutput:false},{name:"title",description:"The title of the document",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"knowledge",title:"Knowledge",modelRequirements:{modelVariant:"CHAT",modelName:"claude-3-opus-20240229"},content:"You are experienced content creator, write best title for the document.\n\n# Rules\n\n-   Write just title, nothing else\n-   Title should be concise and clear\n-   Write maximum 5 words for the title\n\n# The document\n\n> {knowledgePieceContent}",expectations:{words:{min:1,max:8}},dependentParameterNames:["knowledgePieceContent"],resultingParameterName:"title"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-knowledge-title.ptbk.md"},{title:"Prepare Keywords",pipelineUrl:"https://promptbook.studio/promptbook/prepare-persona.ptbk.md",promptbookVersion:"0.66.0-5",parameters:[{name:"availableModelNames",description:"List of available model names separated by comma (,)",isInput:true,isOutput:false},{name:"personaDescription",description:"Description of the persona",isInput:true,isOutput:false},{name:"modelRequirements",description:"Specific requirements for the model",isInput:false,isOutput:true}],promptTemplates:[{blockType:"PROMPT_TEMPLATE",name:"make-model-requirements",title:"Make modelRequirements",modelRequirements:{modelVariant:"CHAT",modelName:"gpt-4-turbo"},content:"You are experienced AI engineer, you need to create virtual assistant.\nWrite\n\n## Sample\n\n```json\n{\n\"modelName\": \"gpt-4o\",\n\"systemMessage\": \"You are experienced AI engineer and helpfull assistant.\",\n\"temperature\": 0.7\n}\n```\n\n## Instructions\n\n### Option `modelName`\n\nPick from the following models:\n\n-   {availableModelNames}\n\n### Option `systemMessage`\n\nThe system message is used to communicate instructions or provide context to the model at the beginning of a conversation. It is displayed in a different format compared to user messages, helping the model understand its role in the conversation. The system message typically guides the model's behavior, sets the tone, or specifies desired output from the model. By utilizing the system message effectively, users can steer the model towards generating more accurate and relevant responses.\n\nFor example:\n\n> You are an experienced AI engineer and helpful assistant.\n\n> You are a friendly and knowledgeable chatbot.\n\n### Option `temperature`\n\nThe sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.\n\nYou can pick a value between 0 and 2. For example:\n\n-   `0.1`: Low temperature, extremely conservative and deterministic\n-   `0.5`: Medium temperature, balanced between conservative and creative\n-   `1.0`: High temperature, creative and bit random\n-   `1.5`: Very high temperature, extremely creative and often chaotic and unpredictable\n-   `2.0`: Maximum temperature, completely random and unpredictable, for some extreme creative use cases\n\n# The assistant\n\nTake this description of the persona:\n\n> {personaDescription}",expectFormat:"JSON",dependentParameterNames:["availableModelNames","personaDescription"],resultingParameterName:"modelRequirements"}],knowledgeSources:[],knowledgePieces:[],personas:[],preparations:[],sourceFile:"./promptbook-collection/prepare-persona.ptbk.md"}];
 
 /**
  * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
@@ -8111,7 +8123,7 @@ var createOpenAiExecutionTools = Object.assign(function (options) {
 /**
  * @@@
  *
- * TODO: !!!!!! Not centralized - register each provider to each package
+ * TODO: !!!!!! Remove EXECUTION_TOOLS_CLASSES and use $llmToolsRegister  instead
  *
  * @private internal type for `createLlmToolsFromConfiguration`
  */
@@ -8159,6 +8171,38 @@ function createLlmToolsFromConfiguration(configuration, options) {
  * TODO: This should be maybe not under `_common` but under `utils`
  */
 
+/**
+ * Register is @@@
+ *
+ * @private internal utility, exported are only signleton instances of this class
+ */
+var Register = /** @class */ (function () {
+    function Register(storage) {
+        this.storage = storage;
+    }
+    Register.prototype.list = function () {
+        // <- TODO: ReadonlyDeep<Array<TRegistered>>
+        return this.storage;
+    };
+    Register.prototype.register = function (registered) {
+        // !!!!!!                             <- TODO: What to return here
+        // TODO: !!!!!! Compare if same is not already registered
+        this.storage.push(registered);
+    };
+    return Register;
+}());
+
+/**
+ * @@@
+ *
+ * Note: `$` is used to indicate that this interacts with the global scope
+ * @singleton Only one instance of each register is created per build, but thare can be more @@@
+ * @public exported from `@promptbook/core`
+ */
+var $llmToolsMetadataRegister = new Register([
+// TODO: !!!!!! Take from global scope
+]);
+
 /**
  * @@@
  *
@@ -8176,28 +8220,10 @@ function createLlmToolsFromConfigurationFromEnv() {
         throw new EnvironmentMismatchError('Function `createLlmToolsFromEnv` works only in Node.js environment');
     }
     dotenv.config();
-    var llmToolsConfiguration = [];
-    if (typeof process.env.OPENAI_API_KEY === 'string') {
-        llmToolsConfiguration.push({
-            title: 'OpenAI (from env)',
-            packageName: '@promptbook/openai',
-            className: 'OpenAiExecutionTools',
-            options: {
-                apiKey: process.env.OPENAI_API_KEY,
-            },
-        });
-    }
-    if (typeof process.env.ANTHROPIC_CLAUDE_API_KEY === 'string') {
-        llmToolsConfiguration.push({
-            title: 'Claude (from env)',
-            packageName: '@promptbook/antrhopic-claude',
-            className: 'AnthropicClaudeExecutionTools',
-            options: {
-                apiKey: process.env.ANTHROPIC_CLAUDE_API_KEY,
-            },
-        });
-    }
-    // <- Note: [🦑] Add here new LLM provider
+    var llmToolsConfiguration = $llmToolsMetadataRegister
+        .list()
+        .map(function (metadata) { return metadata.createConfigurationFromEnv(process.env); })
+        .filter(function (configuration) { return configuration !== null; });
     return llmToolsConfiguration;
 }
 /**
@@ -8232,7 +8258,7 @@ function createLlmToolsFromEnv(options) {
     var configuration = createLlmToolsFromConfigurationFromEnv();
     if (configuration.length === 0) {
         // TODO: [🥃]
-        throw new Error(spaceTrim("\n                No LLM tools found in the environment\n\n                Please set one of environment variables:\n                - OPENAI_API_KEY\n                - ANTHROPIC_CLAUDE_API_KEY\n          "));
+        throw new Error(spaceTrim("\n                No LLM tools found in the environment\n\n                !!!!!!!@@@@You have maybe forgotten to two things:\n\n                Please set one of environment variables:\n                - OPENAI_API_KEY\n                - ANTHROPIC_CLAUDE_API_KEY\n          "));
     }
     return createLlmToolsFromConfiguration(configuration, options);
 }
@@ -8450,6 +8476,7 @@ function getLlmToolsForCli(options) {
  * TODO: This should be maybe not under `_common` but under `utils-internal` / `utils/internal`
  */
 
+// TODO: !!!!!! Probbably all LLM tools should be registered in `@promptbook/cli`
 /**
  * Initializes `make` command for Promptbook CLI utilities
  *
@@ -8634,7 +8661,7 @@ function initializeMakeCommand(program) {
     });
 }
 /**
- * TODO: [🥃] !!! Allow `ptbk make` without llm tools
+ * TODO: [🥃] !!! Allow `ptbk make` without configuring any llm tools
  * TODO: Maybe remove this command - "about" command should be enough?
  * TODO: [0] DRY Javascript and typescript - Maybe make ONLY typescript and for javascript just remove types
  * Note: [🟡] This code should never be published outside of `@promptbook/cli`
@@ -8969,5 +8996,82 @@ var __CLI = {
  * Note: [🟡] This code should never be published outside of `@promptbook/cli`
  */
 
-export { PROMPTBOOK_VERSION, __CLI };
+/**
+ * @@@ registration1 of default configuration for Anthropic Claude
+ *
+ * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/cli`
+ */
+var _AnthropicClaudeMetadataRegistration = $llmToolsMetadataRegister.register({
+    title: 'Anthropic Claude',
+    packageName: '@promptbook/anthropic-claude',
+    className: 'AnthropicClaudeExecutionTools',
+    getBoilerplateConfiguration: function () {
+        return {
+            title: 'Anthropic Claude (boilerplate)',
+            packageName: '@promptbook/anthropic-claude',
+            className: 'AnthropicClaudeExecutionTools',
+            options: {
+                apiKey: 'sk-ant-api03-',
+                isProxied: true,
+                remoteUrl: DEFAULT_REMOTE_URL,
+                path: DEFAULT_REMOTE_URL_PATH,
+            },
+        };
+    },
+    createConfigurationFromEnv: function (env) {
+        if (typeof env.ANTHROPIC_CLAUDE_API_KEY === 'string') {
+            return {
+                title: 'Claude (from env)',
+                packageName: '@promptbook/antrhopic-claude',
+                className: 'AnthropicClaudeExecutionTools',
+                options: {
+                    apiKey: process.env.ANTHROPIC_CLAUDE_API_KEY,
+                },
+            };
+        }
+        return null;
+    },
+});
+
+/**
+ * @@@ registration1 of default configuration for Open AI
+ *
+ * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/cli`
+ */
+var _OpenAiMetadataRegistration = $llmToolsMetadataRegister.register({
+    title: 'Anthropic Claude',
+    packageName: '@promptbook/anthropic-claude',
+    className: 'AnthropicClaudeExecutionTools',
+    getBoilerplateConfiguration: function () {
+        return {
+            title: 'Open AI (boilerplate)',
+            packageName: '@promptbook/openai',
+            className: 'OpenAiExecutionTools',
+            options: {
+                apiKey: 'sk-',
+            },
+        };
+    },
+    createConfigurationFromEnv: function (env) {
+        if (typeof env.OPENAI_API_KEY === 'string') {
+            return {
+                title: 'Open AI (from env)',
+                packageName: '@promptbook/openai',
+                className: 'OpenAiExecutionTools',
+                options: {
+                    apiKey: process.env.OPENAI_API_KEY,
+                },
+            };
+        }
+        return null;
+    },
+});
+
+export { PROMPTBOOK_VERSION, _AnthropicClaudeMetadataRegistration, _OpenAiMetadataRegistration, __CLI };
 //# sourceMappingURL=index.es.js.map