@promptbook/types 0.66.0-0 → 0.66.0-1

package/esm/typings/src/_packages/anthropic-claude.index.d.ts

@@ -5,6 +5,7 @@ import type { AnthropicClaudeExecutionToolsOptions } from '../llm-providers/anth
 import type { AnthropicClaudeExecutionToolsDirectOptions } from '../llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions';
 import type { AnthropicClaudeExecutionToolsProxiedOptions } from '../llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions';
 import { createAnthropicClaudeExecutionTools } from '../llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools';
+import { _ } from '../llm-providers/anthropic-claude/register1';
 export { PROMPTBOOK_VERSION };
 export { ANTHROPIC_CLAUDE_MODELS };
 export { AnthropicClaudeExecutionTools };
@@ -12,3 +13,4 @@ export type { AnthropicClaudeExecutionToolsOptions };
 export type { AnthropicClaudeExecutionToolsDirectOptions };
 export type { AnthropicClaudeExecutionToolsProxiedOptions };
 export { createAnthropicClaudeExecutionTools };
+export { _ };

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

@@ -15,6 +15,9 @@ import { MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL } from '../config';
 import { EXECUTIONS_CACHE_DIRNAME } from '../config';
 import { PIPELINE_COLLECTION_BASE_FILENAME } from '../config';
 import { RESERVED_PARAMETER_NAMES } from '../config';
+import { DEFAULT_REMOTE_URL } from '../config';
+import { DEFAULT_REMOTE_URL_PATH } from '../config';
+import { BOILERPLATE_LLM_TOOLS_CONFIGURATION_ } from '../config';
 import { pipelineJsonToString } from '../conversion/pipelineJsonToString';
 import type { PipelineStringToJsonOptions } from '../conversion/pipelineStringToJson';
 import { pipelineStringToJson } from '../conversion/pipelineStringToJson';
@@ -45,7 +48,6 @@ import { CallbackInterfaceTools } from '../knowledge/dialogs/callback/CallbackIn
 import type { CallbackInterfaceToolsOptions } from '../knowledge/dialogs/callback/CallbackInterfaceToolsOptions';
 import { prepareKnowledgePieces } from '../knowledge/prepare-knowledge/_common/prepareKnowledgePieces';
 import { prepareKnowledgeFromMarkdown } from '../knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown';
-import { LLM_CONFIGURATION_BOILERPLATES } from '../llm-providers/_common/config';
 import { createLlmToolsFromConfiguration } from '../llm-providers/_common/createLlmToolsFromConfiguration';
 import { cacheLlmTools } from '../llm-providers/_common/utils/cache/cacheLlmTools';
 import { countTotalUsage } from '../llm-providers/_common/utils/count-total-usage/countTotalUsage';
@@ -80,6 +82,9 @@ export { MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL };
 export { EXECUTIONS_CACHE_DIRNAME };
 export { PIPELINE_COLLECTION_BASE_FILENAME };
 export { RESERVED_PARAMETER_NAMES };
+export { DEFAULT_REMOTE_URL };
+export { DEFAULT_REMOTE_URL_PATH };
+export { BOILERPLATE_LLM_TOOLS_CONFIGURATION_ };
 export { pipelineJsonToString };
 export type { PipelineStringToJsonOptions };
 export { pipelineStringToJson };
@@ -110,7 +115,6 @@ export { CallbackInterfaceTools };
 export type { CallbackInterfaceToolsOptions };
 export { prepareKnowledgePieces };
 export { prepareKnowledgeFromMarkdown };
-export { LLM_CONFIGURATION_BOILERPLATES };
 export { createLlmToolsFromConfiguration };
 export { cacheLlmTools };
 export { countTotalUsage };

package/esm/typings/src/config.d.ts

@@ -1,3 +1,4 @@
+import type { LlmToolsConfiguration } from './llm-providers/_common/LlmToolsConfiguration';
 /**
  * Warning message for the generated sections and files files
  *
@@ -107,9 +108,30 @@ export declare const RESERVED_PARAMETER_RESTRICTED: string;
 export declare const MOMENT_ARG_THRESHOLDS: {
     readonly ss: 3;
 };
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_REMOTE_URL = "https://api.pavolhejny.com/";
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_REMOTE_URL_PATH = "/promptbook/socket.io";
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const BOILERPLATE_LLM_TOOLS_CONFIGURATION_: LlmToolsConfiguration;
 /**
  * @@@
  *
  * @private within the repository
  */
 export declare const DEBUG_ALLOW_PAYED_TESTING: boolean;
+/**
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
+ */

package/esm/typings/src/execution/LlmExecutionTools.d.ts

@@ -28,6 +28,16 @@ export type LlmExecutionTools = {
      * @example "Use all models from OpenAI"
      */
     readonly description: string_markdown;
+    /**
+     * Check comfiguration
+     *
+     * @returns nothing if configuration is correct
+     * @throws {Error} if configuration is incorrect
+     */
+    /**
+     * List all available models that can be used
+     */
+    listModels(): Promisable<Array<AvailableModel>>;
     /**
      * Calls a chat model
      */
@@ -40,10 +50,6 @@ export type LlmExecutionTools = {
      * Calls an embedding model
      */
     callEmbeddingModel?(prompt: Prompt): Promise<EmbeddingPromptResult>;
-    /**
-     * List all available models that can be used
-     */
-    listModels(): Promisable<Array<AvailableModel>>;
 };
 /**
  * Represents a model that can be used for prompt execution
@@ -63,8 +69,8 @@ export type AvailableModel = {
     readonly modelVariant: ModelVariant;
 };
 /**
+ * TODO: Implement destroyable pattern to free resources
  * TODO: [🏳] Add `callTranslationModel`
- * TODO: Maybe reorder `listModels` and put it befor `callChatModel`, `callCompletionModel`, `callEmbeddingModel`
  * TODO: [🧠] Emulation of one type of model with another one - emuate chat with completion; emulate translation with chat
  * TODO: [🍓][♐] Some heuristic to pick the best model in listed models
  * TODO: [🧠] Should or should not there be a word "GPT" in both callCompletionModel and callChatModel

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

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

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

@@ -0,0 +1,18 @@
+import type Anthropic from '@anthropic-ai/sdk';
+import type { PartialDeep } from 'type-fest';
+import type { PromptResultUsage } from '../../execution/PromptResultUsage';
+import type { Prompt } from '../../types/Prompt';
+/**
+ * Computes the usage of the Anthropic Claude API based on the response from Anthropic Claude
+ *
+ * @param promptContent The content of the prompt
+ * @param resultContent The content of the result (for embedding prompts or failed prompts pass empty string)
+ * @param rawResponse The raw response from Anthropic Claude API
+ * @throws {PipelineExecutionError} If the usage is not defined in the response from Anthropic Claude
+ * @private internal utility of `AnthropicClaudeExecutionTools`
+ */
+export declare function computeAnthropicClaudeUsage(promptContent: Prompt['content'], // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer
+resultContent: string, rawResponse: PartialDeep<Pick<Anthropic.Messages.Message, 'model' | 'usage'>>): PromptResultUsage;
+/**
+ * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenaiUsage` and `computeAnthropicClaudeUsage`
+ */

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

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenaiUsage` and `computeAnthropicClaudeUsage`
+ */

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

@@ -0,0 +1,4 @@
+/**
+ * @public exported from `@promptbook/anthropic-claude`
+ */
+export declare const _: undefined;

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

@@ -1,4 +1,5 @@
 import type OpenAI from 'openai';
+import type { PartialDeep } from 'type-fest';
 import type { PromptResultUsage } from '../../execution/PromptResultUsage';
 import type { Prompt } from '../../types/Prompt';
 /**
@@ -11,4 +12,7 @@ import type { Prompt } from '../../types/Prompt';
  * @private internal utility of `OpenAiExecutionTools`
  */
 export declare function computeOpenaiUsage(promptContent: Prompt['content'], // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer
-resultContent: string, rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion | OpenAI.Embeddings.CreateEmbeddingResponse, 'model' | 'usage'>): PromptResultUsage;
+resultContent: string, rawResponse: PartialDeep<Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion | OpenAI.Embeddings.CreateEmbeddingResponse, 'model' | 'usage'>>): PromptResultUsage;
+/**
+ * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenaiUsage` and `computeAnthropicClaudeUsage`
+ */

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

@@ -1 +1,4 @@
 export {};
+/**
+ * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenaiUsage` and `computeAnthropicClaudeUsage`
+ */

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

@@ -25,7 +25,7 @@ export type RemoteLlmExecutionToolsOptions = CommonExecutionToolsOptions & {
     /**
      * If set, only these models will be listed as available
      *
-     * TODO: [🧠] !!!! Figure out better solution
+     * TODO: [🧠] !!!!!! Figure out better solution
      */
     readonly models?: Array<AvailableModel>;
     /**
@@ -51,3 +51,6 @@ export type RemoteLlmExecutionToolsOptions = CommonExecutionToolsOptions & {
      */
     readonly clientId: client_id;
 });
+/**
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
+ */ 

package/esm/typings/src/utils/environment/getGlobalScope.d.ts

@@ -7,3 +7,6 @@ import type { really_any } from '../organization/really_any';
  * @public exported from `@promptbook/utils`
  */
 export declare function $getGlobalScope(): really_any;
+/***
+ * TODO: !!!!! Make private and promptbook registry from this
+ */ 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.66.0-0",
+    "version": "0.66.0-1",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -45,6 +45,6 @@
     ],
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.66.0-0"
+        "@promptbook/core": "0.66.0-1"
     }
 }