@promptbook/remote-server 0.63.3 → 0.64.0-0

package/esm/index.es.js

@@ -7,7 +7,7 @@ import { spaceTrim } from 'spacetrim';
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.63.2';
+var PROMPTBOOK_VERSION = '0.63.4';
 // TODO: !!!! List here all the versions and annotate + put into script
 
 /*! *****************************************************************************

package/esm/typings/promptbook-collection/index.d.ts

@@ -1,7 +1,6 @@
 declare const _default: ({
-    pipelineUrl: string;
-    sourceFile: string;
     title: string;
+    pipelineUrl: string;
     promptbookVersion: string;
     parameters: {
         name: string;
@@ -24,65 +23,11 @@ declare const _default: ({
     knowledgeSources: never[];
     knowledgePieces: never[];
     personas: never[];
-    preparations: {
-        id: number;
-        promptbookVersion: string;
-        usage: {
-            price: {
-                value: number;
-            };
-            input: {
-                tokensCount: {
-                    value: number;
-                };
-                charactersCount: {
-                    value: number;
-                };
-                wordsCount: {
-                    value: number;
-                };
-                sentencesCount: {
-                    value: number;
-                };
-                linesCount: {
-                    value: number;
-                };
-                paragraphsCount: {
-                    value: number;
-                };
-                pagesCount: {
-                    value: number;
-                };
-            };
-            output: {
-                tokensCount: {
-                    value: number;
-                };
-                charactersCount: {
-                    value: number;
-                };
-                wordsCount: {
-                    value: number;
-                };
-                sentencesCount: {
-                    value: number;
-                };
-                linesCount: {
-                    value: number;
-                };
-                paragraphsCount: {
-                    value: number;
-                };
-                pagesCount: {
-                    value: number;
-                };
-            };
-        };
-    }[];
-} | {
-    pipelineUrl: string;
+    preparations: never[];
     sourceFile: string;
+} | {
     title: string;
+    pipelineUrl: string;
     promptbookVersion: string;
     parameters: {
         name: string;
@@ -111,65 +56,11 @@ declare const _default: ({
     knowledgeSources: never[];
     knowledgePieces: never[];
     personas: never[];
-    preparations: {
-        id: number;
-        promptbookVersion: string;
-        usage: {
-            price: {
-                value: number;
-            };
-            input: {
-                tokensCount: {
-                    value: number;
-                };
-                charactersCount: {
-                    value: number;
-                };
-                wordsCount: {
-                    value: number;
-                };
-                sentencesCount: {
-                    value: number;
-                };
-                linesCount: {
-                    value: number;
-                };
-                paragraphsCount: {
-                    value: number;
-                };
-                pagesCount: {
-                    value: number;
-                };
-            };
-            output: {
-                tokensCount: {
-                    value: number;
-                };
-                charactersCount: {
-                    value: number;
-                };
-                wordsCount: {
-                    value: number;
-                };
-                sentencesCount: {
-                    value: number;
-                };
-                linesCount: {
-                    value: number;
-                };
-                paragraphsCount: {
-                    value: number;
-                };
-                pagesCount: {
-                    value: number;
-                };
-            };
-        };
-    }[];
-} | {
-    pipelineUrl: string;
+    preparations: never[];
     sourceFile: string;
+} | {
     title: string;
+    pipelineUrl: string;
     promptbookVersion: string;
     parameters: {
         name: string;
@@ -193,60 +84,7 @@ declare const _default: ({
     knowledgeSources: never[];
     knowledgePieces: never[];
     personas: never[];
-    preparations: {
-        id: number;
-        promptbookVersion: string;
-        usage: {
-            price: {
-                value: number;
-            };
-            input: {
-                tokensCount: {
-                    value: number;
-                };
-                charactersCount: {
-                    value: number;
-                };
-                wordsCount: {
-                    value: number;
-                };
-                sentencesCount: {
-                    value: number;
-                };
-                linesCount: {
-                    value: number;
-                };
-                paragraphsCount: {
-                    value: number;
-                };
-                pagesCount: {
-                    value: number;
-                };
-            };
-            output: {
-                tokensCount: {
-                    value: number;
-                };
-                charactersCount: {
-                    value: number;
-                };
-                wordsCount: {
-                    value: number;
-                };
-                sentencesCount: {
-                    value: number;
-                };
-                linesCount: {
-                    value: number;
-                };
-                paragraphsCount: {
-                    value: number;
-                };
-                pagesCount: {
-                    value: number;
-                };
-            };
-        };
-    }[];
+    preparations: never[];
+    sourceFile: string;
 })[];
 export default _default;

package/esm/typings/src/_packages/node.index.d.ts

@@ -1,8 +1,14 @@
 import { PROMPTBOOK_VERSION } from '../version';
 import { createCollectionFromDirectory } from '../collection/constructors/createCollectionFromDirectory';
+import { LLM_CONFIGURATION_BOILERPLATES } from '../llm-providers/_common/config';
+import { createLlmToolsFromConfiguration } from '../llm-providers/_common/createLlmToolsFromConfiguration';
+import { createLlmToolsFromConfigurationFromEnv } from '../llm-providers/_common/createLlmToolsFromConfigurationFromEnv';
 import { createLlmToolsFromEnv } from '../llm-providers/_common/createLlmToolsFromEnv';
 import { FilesStorage } from '../storage/files-storage/FilesStorage';
 export { PROMPTBOOK_VERSION };
 export { createCollectionFromDirectory };
+export { LLM_CONFIGURATION_BOILERPLATES };
+export { createLlmToolsFromConfiguration };
+export { createLlmToolsFromConfigurationFromEnv };
 export { createLlmToolsFromEnv };
 export { FilesStorage };

package/esm/typings/src/_packages/types.index.d.ts

@@ -30,6 +30,7 @@ import type { UncertainNumber } from '../execution/UncertainNumber';
 import type { UserInterfaceTools } from '../execution/UserInterfaceTools';
 import type { UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
 import type { CallbackInterfaceToolsOptions } from '../knowledge/dialogs/callback/CallbackInterfaceToolsOptions';
+import type { LlmToolsConfiguration } from '../llm-providers/_common/LlmConfiguration';
 import type { CacheItem } from '../llm-providers/_common/utils/cache/CacheItem';
 import type { CacheLlmToolsOptions } from '../llm-providers/_common/utils/cache/CacheLlmToolsOptions';
 import type { LlmExecutionToolsWithTotalUsage } from '../llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
@@ -104,7 +105,7 @@ import type { string_reserved_parameter_name } from '../types/typeAliases';
 import type { ReservedParameters } from '../types/typeAliases';
 import type { string_title } from '../types/typeAliases';
 import type { string_persona_description } from '../types/typeAliases';
-import type { string_knowledge_source } from '../types/typeAliases';
+import type { string_knowledge_source_content } from '../types/typeAliases';
 import type { string_knowledge_source_link } from '../types/typeAliases';
 import type { string_html } from '../types/typeAliases';
 import type { string_xml } from '../types/typeAliases';
@@ -237,6 +238,8 @@ export type { UncertainNumber };
 export type { UserInterfaceTools };
 export type { UserInterfaceToolsPromptDialogOptions };
 export type { CallbackInterfaceToolsOptions };
+export type { LlmToolsConfiguration };
+export type { LlmToolsConfiguration };
 export type { CacheItem };
 export type { CacheLlmToolsOptions };
 export type { LlmExecutionToolsWithTotalUsage };
@@ -311,7 +314,7 @@ export type { string_reserved_parameter_name };
 export type { ReservedParameters };
 export type { string_title };
 export type { string_persona_description };
-export type { string_knowledge_source };
+export type { string_knowledge_source_content };
 export type { string_knowledge_source_link };
 export type { string_html };
 export type { string_xml };

package/esm/typings/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts

@@ -1,4 +1,4 @@
-import type { string_knowledge_source } from '../../types/typeAliases';
+import type { string_knowledge_source_content } from '../../types/typeAliases';
 /**
  * Parsed KNOWLEDGE command
  *
@@ -7,5 +7,5 @@ import type { string_knowledge_source } from '../../types/typeAliases';
  */
 export type KnowledgeCommand = {
     readonly type: 'KNOWLEDGE';
-    readonly source: string_knowledge_source;
+    readonly sourceContent: string_knowledge_source_content;
 };

package/esm/typings/src/llm-providers/_common/LlmConfiguration.d.ts

@@ -0,0 +1,28 @@
+import type { string_title } from '../../types/typeAliases';
+import type { TODO_object } from '../../utils/organization/TODO_object';
+import type { TODO_string } from '../../utils/organization/TODO_string';
+/**
+ * @@@
+ */
+export type LlmToolsConfiguration = Array<{
+    /**
+     * @@@
+     */
+    title: string_title;
+    /**
+     * @@@
+     */
+    packageName: TODO_string;
+    /**
+     * @@@
+     */
+    className: TODO_string;
+    /**
+     * @@@
+     */
+    options: TODO_object;
+}>;
+/**
+ * TODO: [🧠][🌰] `title` is redundant BUT maybe allow each provider pass it's own title for tracking purposes
+ * TODO: [🧠] Maybe add option for `constructorName` instead of `className`
+ */

package/esm/typings/src/llm-providers/_common/LlmToolsConfiguration.d.ts

@@ -0,0 +1,22 @@
+import type { TODO_object } from '../../utils/organization/TODO_object';
+import type { TODO_string } from '../../utils/organization/TODO_string';
+/**
+ * @@@
+ */
+export type LlmToolsConfiguration = Array<{
+    /**
+     * @@@
+     */
+    packageName: TODO_string;
+    /**
+     * @@@
+     */
+    className: TODO_string;
+    /**
+     * @@@
+     */
+    options: TODO_object;
+}>;
+/**
+ * TODO: [🧠] Maybe add option for `constructorName` instead of `className`
+ */

package/esm/typings/src/llm-providers/_common/config.d.ts

@@ -0,0 +1,15 @@
+import type { TODO_any } from '../../utils/organization/TODO_any';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { LlmToolsConfiguration } from './LlmConfiguration';
+/**
+ * @public exported from `@promptbook/node`
+ */
+export declare const LLM_CONFIGURATION_BOILERPLATES: LlmToolsConfiguration;
+/**
+ * @private internal type for `createLlmToolsFromConfiguration`
+ */
+export declare const EXECUTION_TOOLS_CLASSES: Record<`get${string}`, (options: TODO_any) => LlmExecutionTools>;
+/**
+ * TODO: [🧠] Better file name than `config.ts` + maybe move to two separate files
+ * TODO: [🧠][🎌] Adding this should be responsibility of each provider package NOT this one central place
+ */

package/esm/typings/src/llm-providers/_common/createLlmToolsFromConfiguration.d.ts

@@ -0,0 +1,32 @@
+import { MultipleLlmExecutionTools } from '../multiple/MultipleLlmExecutionTools';
+import type { LlmToolsConfiguration } from './LlmConfiguration';
+/**
+ * Options for `createLlmToolsFromEnv`
+ *
+ * @private internal type for `createLlmToolsFromEnv` and `getLlmToolsForTestingAndScriptsAndPlayground`
+ */
+export type CreateLlmToolsFromConfigurationOptions = {
+    /**
+     * This will will be passed to the created `LlmExecutionTools`
+     *
+     * @default false
+     */
+    isVerbose?: boolean;
+};
+/**
+ * @@@
+ *
+ * Note: This function is not cached, every call creates new instance of `MultipleLlmExecutionTools`
+ *
+ * @returns @@@
+ * @public exported from `@promptbook/node`
+ */
+export declare function createLlmToolsFromConfiguration(configuration: LlmToolsConfiguration, options?: CreateLlmToolsFromConfigurationOptions): MultipleLlmExecutionTools;
+/**
+ * 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
+ * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
+ * TODO: This should be maybe not under `_common` but under `utils`
+ */

package/esm/typings/src/llm-providers/_common/createLlmToolsFromConfigurationFromEnv.d.ts

@@ -0,0 +1,23 @@
+import type { LlmToolsConfiguration } from './LlmConfiguration';
+/**
+ * @@@
+ *
+ * @@@ .env
+ *
+ * It looks for environment variables:
+ * - `process.env.OPENAI_API_KEY`
+ * - `process.env.ANTHROPIC_CLAUDE_API_KEY`
+ *
+ * @returns @@@
+ * @public exported from `@promptbook/node`
+ */
+export declare function createLlmToolsFromConfigurationFromEnv(): LlmToolsConfiguration;
+/**
+ * TODO: Add Azure OpenAI
+ * TODO: [🧠][🍛]
+ * TODO: [🧠] Is there some meaningfull way how to test this util
+ * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ * TODO: This should be maybe not under `_common` but under `utils`
+ * TODO: [🧠] Maybe pass env as argument
+ */

package/esm/typings/src/llm-providers/_common/createLlmToolsFromEnv.d.ts

@@ -1,21 +1,9 @@
-import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
-/**
- * Options for `createLlmToolsFromEnv`
- *
- * @private internal type for `createLlmToolsFromEnv` and `getLlmToolsForTestingAndScriptsAndPlayground`
- */
-export type CreateLlmToolsFromEnvOptions = {
-    /**
-     * This will will be passed to the created `LlmExecutionTools`
-     *
-     * @default false
-     */
-    isVerbose?: boolean;
-};
+import { MultipleLlmExecutionTools } from '../multiple/MultipleLlmExecutionTools';
+import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFromConfiguration';
 /**
  * @@@
  *
- * Note: This function is not cached, every call creates new instance of `LlmExecutionTools`
+ * Note: This function is not cached, every call creates new instance of `MultipleLlmExecutionTools`
  *
  * @@@ .env
  *
@@ -26,15 +14,12 @@ export type CreateLlmToolsFromEnvOptions = {
  * @returns @@@
  * @public exported from `@promptbook/node`
  */
-export declare function createLlmToolsFromEnv(options?: CreateLlmToolsFromEnvOptions): LlmExecutionTools;
+export declare function createLlmToolsFromEnv(options?: CreateLlmToolsFromConfigurationOptions): MultipleLlmExecutionTools;
 /**
- * TODO: [🍜] Use `createLlmToolsFromConfiguration`
- * TODO: @@@ write discussion about this - wizzard
- * TODO: Add Azure
- * TODO: [🧠] Which name is better `createLlmToolsFromEnv` or `createLlmToolsFromEnvironment`?
+ * TODO: @@@ write `createLlmToolsFromEnv` vs `createLlmToolsFromConfigurationFromEnv` vs `createLlmToolsFromConfiguration`
+ * TODO: [🧠][🍛] Which name is better `createLlmToolsFromEnv` or `createLlmToolsFromEnvironment`?
  * TODO: [🧠] Is there some meaningfull way how to test this util
- * TODO: [🧠] Maybe pass env as argument
  * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
- * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  * TODO: [🥃] Allow `ptbk make` without llm tools
+ * TODO: This should be maybe not under `_common` but under `utils`
  */

package/esm/typings/src/llm-providers/_common/getLlmToolsForCli.d.ts

@@ -18,4 +18,5 @@ export {};
  * Note: [🟡] This code should never be published outside of `@promptbook/cli`
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  * TODO: [🥃] Allow `ptbk make` without llm tools
+ * TODO: This should be maybe not under `_common` but under `utils-internal` / `utils/internal`
  */

package/esm/typings/src/llm-providers/_common/getLlmToolsForTestingAndScriptsAndPlayground.d.ts

@@ -1,6 +1,6 @@
-import type { CreateLlmToolsFromEnvOptions } from './createLlmToolsFromEnv';
+import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFromConfiguration';
 import type { LlmExecutionToolsWithTotalUsage } from './utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
-type GetLlmToolsForTestingAndScriptsAndPlaygroundOptions = CreateLlmToolsFromEnvOptions & {
+type GetLlmToolsForTestingAndScriptsAndPlaygroundOptions = CreateLlmToolsFromConfigurationOptions & {
     /**
      * @@@
      *
@@ -18,4 +18,5 @@ export {};
 /**
  * Note: [⚪] This should never be in any released package
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ * TODO: This should be maybe not under `_common` but under `utils-internal` / `utils/internal`
  */

package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts

@@ -49,4 +49,5 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
  * TODO: Maybe make custom OpenaiError
  * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
  * TODO: [🍜] Auto use anonymous server in browser
+ * TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
  */

package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts

@@ -47,4 +47,5 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
  * TODO: Maybe Create some common util for callChatModel and callCompletionModel
  * TODO: Maybe make custom AzureOpenaiError
  * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
+ * TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
  */

package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts

@@ -42,8 +42,10 @@ export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
     callEmbeddingModel(prompt: EmbeddingPrompt): Promise<EmbeddingPromptResult>;
     /**
      * Calls the best available model
+     *
+     * Note: This should be private or protected but is public to be usable with duck typing
      */
-    protected callCommonModel(prompt: Prompt): Promise<PromptResult>;
+    callCommonModel(prompt: Prompt): Promise<PromptResult>;
     /**
      * List all available models that can be used
      * This lists is a combination of all available models from all execution tools

package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts

@@ -65,4 +65,5 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
  * TODO: Maybe Create some common util for callChatModel and callCompletionModel
  * TODO: Maybe make custom OpenaiError
  * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
+ * TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
  */

package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts

@@ -53,4 +53,5 @@ export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
  * TODO: [🍓] Allow to list compatible models with each variant
  * TODO: [🗯] RemoteLlmExecutionTools should extend Destroyable and implement IDestroyable
  * TODO: [🍜] Add anonymous option
+ * TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
  */

package/esm/typings/src/prepare/preparePipeline.d.ts

@@ -5,6 +5,7 @@ import type { PrepareOptions } from './PrepareOptions';
  *
  * Note: This function does not validate logic of the pipeline
  * Note: This function acts as part of compilation process
+ * Note: When the pipeline is already prepared, it returns the same pipeline
  * @public exported from `@promptbook/core`
  */
 export declare function preparePipeline(pipeline: PipelineJson, options: PrepareOptions): Promise<PipelineJson>;

package/esm/typings/src/types/PipelineJson/KnowledgeSourceJson.d.ts

@@ -1,5 +1,5 @@
 import type { number_id } from '../typeAliases';
-import type { string_knowledge_source } from '../typeAliases';
+import type { string_knowledge_source_content } from '../typeAliases';
 import type { string_name } from '../typeAliases';
 /**
  * Defines one source of knowledge in the pipeline
@@ -8,8 +8,14 @@ import type { string_name } from '../typeAliases';
  * @see https://github.com/webgptorg/promptbook/discussions/41
  */
 export type KnowledgeSourceJson = {
+    /**
+     * @@@
+     */
     readonly name: string_name;
-    readonly source: string_knowledge_source;
+    /**
+     * @@@
+     */
+    readonly sourceContent: string_knowledge_source_content;
 };
 /**
  * Defines one source of knowledge in the pipeline after it has been prepared

package/esm/typings/src/types/typeAliases.d.ts

@@ -85,7 +85,7 @@ export type string_name = string;
  * Semantic helper
  * Unique identifier of anything
  *
- * For example `"eventName"`
+ * For example `"eventTitle"`
  */
 export type string_parameter_name = string_name;
 /**
@@ -142,7 +142,7 @@ export type string_persona_description = string;
  *
  * @@@ string_knowledge_source vs string_knowledge_source_link
  */
-export type string_knowledge_source = string_knowledge_source_link | string_markdown;
+export type string_knowledge_source_content = string_knowledge_source_link | string_markdown;
 /**
  * One link to knowledge source
  *

package/esm/typings/src/utils/organization/TODO_string.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to better mark the place where the more specific string type is missing
+ *
+ * @private within the repository
+ */
+export type TODO_string = string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/remote-server",
-    "version": "0.63.3",
+    "version": "0.64.0-0",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -47,7 +47,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/remote-server.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.63.3"
+        "@promptbook/core": "0.64.0-0"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -13,7 +13,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.63.2';
+    var PROMPTBOOK_VERSION = '0.63.4';
     // TODO: !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************