@promptbook/markdown-utils 0.61.0 → 0.62.0-1

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

@@ -26,7 +26,7 @@ declare const _default: ({
     preparations: {
         id: number;
         promptbookVersion: string;
-        modelUsage: {
+        usage: {
             price: {
                 value: number;
             };
@@ -113,7 +113,7 @@ declare const _default: ({
     preparations: {
         id: number;
         promptbookVersion: string;
-        modelUsage: {
+        usage: {
             price: {
                 value: number;
             };
@@ -195,7 +195,7 @@ declare const _default: ({
     preparations: {
         id: number;
         promptbookVersion: string;
-        modelUsage: {
+        usage: {
             price: {
                 value: number;
             };

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

@@ -26,6 +26,7 @@ import { embeddingVectorToString } from '../execution/embeddingVectorToString';
 import { addUsage } from '../execution/utils/addUsage';
 import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
 import { usageToWorktime } from '../execution/utils/usageToWorktime';
+import { usageToHuman } from '../execution/utils/usageToHuman';
 import { CallbackInterfaceTools } from '../knowledge/dialogs/callback/CallbackInterfaceTools';
 import type { CallbackInterfaceToolsOptions } from '../knowledge/dialogs/callback/CallbackInterfaceToolsOptions';
 import { SimplePromptInterfaceTools } from '../knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools';
@@ -39,7 +40,7 @@ import { executionReportJsonToString } from '../types/execution-report/execution
 import { PROMPTBOOK_VERSION } from '../version';
 export { PROMPTBOOK_VERSION };
 export { BlockTypes, RESERVED_PARAMETER_NAMES };
-export { addUsage, assertsExecutionSuccessful, checkExpectations, embeddingVectorToString, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prepareKnowledgeFromMarkdown, prettifyPipelineString, usageToWorktime, };
+export { addUsage, assertsExecutionSuccessful, checkExpectations, embeddingVectorToString, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prepareKnowledgeFromMarkdown, prettifyPipelineString, usageToWorktime, usageToHuman, };
 export { collectionToJson, createCollectionFromJson, createCollectionFromPromise, createCollectionFromUrl, createSubcollection, };
 export { SimplePromptInterfaceTools };
 export { pipelineJsonToString, pipelineStringToJson, pipelineStringToJsonSync, stringifyPipelineJson, validatePipeline, };

package/esm/typings/src/conversion/pipelineJsonToString.d.ts

@@ -10,5 +10,6 @@ export declare function pipelineJsonToString(pipelineJson: PipelineJson): Pipeli
 /**
  * TODO: !!!! Implement new features and commands into `promptTemplateParameterJsonToString`
  * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
- * TODO: Escape all
+ * TODO: [🏛] Maybe make some markdown builder
+ * TODO: [🏛] Escape all
  */

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

@@ -58,6 +58,7 @@ export declare function createPipelineExecutor(options: CreatePipelineExecutorOp
 export {};
 /**
  * TODO: Use isVerbose here (not only pass to `preparePipeline`)
+ * TODO: [🧠] Use here `countTotalUsage` and put preparation and prepared pipiline to report
  * TODO: [🪂] Use maxParallelCount here (not only pass to `preparePipeline`)
  * TODO: [♈] Probbably move expectations from templates to parameters
  * TODO: [🧠] When not meet expectations in PROMPT_DIALOG, make some way to tell the user

package/esm/typings/src/execution/utils/usageToHuman.d.ts

@@ -0,0 +1,15 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { PromptResultUsage } from '../PromptResultUsage';
+/**
+ * Function `usageToHuman` will take usage and convert it to human readable report
+ */
+export declare function usageToHuman(usage: PromptResultUsage): string_markdown;
+/**
+ * TODO: Use "$1" not "1 USD"
+ * TODO: Use markdown formatting like "Cost approximately **$1**"
+ * TODO: Report in minutes, seconds, days NOT 0.1 hours
+ * TODO: [🧠] Maybe make from `uncertainNumberToHuman` separate exported utility
+ * TODO: When negligible usage, report "Negligible" or just don't report it
+ * TODO: [🧠] Maybe use "~" instead of "approximately"
+ * TODO: [🏛] Maybe make some markdown builder
+ */

package/esm/typings/src/execution/utils/usageToHuman.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -12,6 +12,8 @@ export type CreateLlmToolsFromEnvOptions = {
  *
  * Note: This function is not cached, every call creates new instance of `LlmExecutionTools`
  *
+ * @@@ .env
+ *
  * It looks for environment variables:
  * - `process.env.OPENAI_API_KEY`
  * - `process.env.ANTHROPIC_CLAUDE_API_KEY`
@@ -20,6 +22,7 @@ export type CreateLlmToolsFromEnvOptions = {
  */
 export declare function createLlmToolsFromEnv(options?: CreateLlmToolsFromEnvOptions): LlmExecutionTools;
 /**
+ * TODO: [🍜] Use `createLlmToolsFromConfiguration`
  * TODO: [🔼] !!! Export via `@promptbook/node`
  * TODO: @@@ write discussion about this - wizzard
  * TODO: Add Azure
@@ -27,4 +30,5 @@ export declare function createLlmToolsFromEnv(options?: CreateLlmToolsFromEnvOpt
  * 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`
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  */

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

@@ -1,10 +1,20 @@
-import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { LlmExecutionToolsWithTotalUsage } from './utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
+type GetLlmToolsForCliOptions = {
+    /**
+     * @@@
+     *
+     * @default false
+     */
+    isCacheReloaded?: boolean;
+};
 /**
  * Returns LLM tools for CLI
  *
  * @private within the repository - for CLI utils
  */
-export declare function getLlmToolsForCli(): LlmExecutionTools;
+export declare function getLlmToolsForCli(options?: GetLlmToolsForCliOptions): LlmExecutionToolsWithTotalUsage;
+export {};
 /**
  * Note: [🟡] This code should never be published outside of `@promptbook/cli`
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  */

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

@@ -1,11 +1,21 @@
-import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { CreateLlmToolsFromEnvOptions } from './createLlmToolsFromEnv';
+import type { LlmExecutionToolsWithTotalUsage } from './utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
+type GetLlmToolsForTestingAndScriptsAndPlaygroundOptions = CreateLlmToolsFromEnvOptions & {
+    /**
+     * @@@
+     *
+     * @default false
+     */
+    isCacheReloaded?: boolean;
+};
 /**
  * Returns LLM tools for testing purposes
  *
  * @private within the repository - JUST FOR TESTS, SCRIPTS AND PLAYGROUND
  */
-export declare function getLlmToolsForTestingAndScriptsAndPlayground(options?: CreateLlmToolsFromEnvOptions): LlmExecutionTools;
+export declare function getLlmToolsForTestingAndScriptsAndPlayground(options?: GetLlmToolsForTestingAndScriptsAndPlaygroundOptions): LlmExecutionToolsWithTotalUsage;
+export {};
 /**
  * Note: [⚪] This should never be in any released package
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  */

package/esm/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts

@@ -2,9 +2,15 @@ import type { PromptbookStorage } from '../../../../storage/_common/PromptbookSt
 import type { CacheItem } from './CacheItem';
 export type CacheLlmToolsOptions = {
     /**
-     * Total cost of the execution
+     * @@@
      *
      * @default MemoryStorage
      */
     storage: PromptbookStorage<CacheItem>;
+    /**
+     * @@@
+     *
+     * @default false
+     */
+    isReloaded?: boolean;
 };

package/esm/typings/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts

@@ -3,14 +3,17 @@ import type { CacheLlmToolsOptions } from './CacheLlmToolsOptions';
 /**
  * Intercepts LLM tools and counts total usage of the tools
  *
- * @param llmTools LLM tools to be intercepted with usage counting
+ * Note: It can take extended `LlmExecutionTools` and cache the
+ *
+ * @param llmTools LLM tools to be intercepted with usage counting, it can contain extra methods like `totalUsage`
  * @returns LLM tools with same functionality with added total cost counting
  */
-export declare function cacheLlmTools(llmTools: LlmExecutionTools, options?: Partial<CacheLlmToolsOptions>): LlmExecutionTools;
+export declare function cacheLlmTools<TLlmTools extends LlmExecutionTools>(llmTools: TLlmTools, options?: Partial<CacheLlmToolsOptions>): TLlmTools;
 /**
  * TODO: [🔼] !!! Export via `@promptbook/core`
- * TODO: @@@ write discussion about this and storages
- *            write how to combine multiple interceptors
  * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
  * TODO: [🧠] Is there some meaningfull way how to test this util
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ *            @@@ write discussion about this and storages
+ *            @@@ write how to combine multiple interceptors
  */

package/esm/typings/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts

@@ -0,0 +1,15 @@
+import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
+import type { PromptResultUsage } from '../../../../execution/PromptResultUsage';
+/**
+ * LLM tools with option to get total usage of the execution
+ */
+export type LlmExecutionToolsWithTotalUsage = LlmExecutionTools & {
+    /**
+     * Get total cost of the execution up to this point
+     */
+    getTotalUsage(): PromptResultUsage;
+};
+/**
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ * Note: [🥫] Not using getter `get totalUsage` but `getTotalUsage` to allow this object to be proxied
+ */

package/{umd/typings/src/llm-providers/_common/utils/count-total-cost/countTotalCost.d.ts → esm/typings/src/llm-providers/_common/utils/count-total-usage/countTotalUsage.d.ts}

@@ -1,14 +1,17 @@
 import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
-import type { LlmExecutionToolsWithTotalCost } from './LlmExecutionToolsWithTotalCost';
+import type { LlmExecutionToolsWithTotalUsage } from './LlmExecutionToolsWithTotalUsage';
 /**
  * Intercepts LLM tools and counts total usage of the tools
  *
  * @param llmTools LLM tools to be intercepted with usage counting
  * @returns LLM tools with same functionality with added total cost counting
  */
-export declare function countTotalUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalCost;
+export declare function countTotalUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalUsage;
 /**
  * TODO: [🔼] !!! Export via `@promptbookcore/`
  * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
  * TODO: [🧠] Is there some meaningfull way how to test this util
+ * TODO: [🧠][🌯] Maybe a way how to hide ability to `get totalUsage`
+ *     > const [llmToolsWithUsage,getUsage] = countTotalUsage(llmTools);
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  */

package/esm/typings/src/llm-providers/_common/utils/{count-total-cost/limitTotalCost.d.ts → count-total-usage/limitTotalUsage.d.ts}

@@ -2,17 +2,17 @@ import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools'
 import type { PromptResultUsage } from '../../../../execution/PromptResultUsage';
 import type { PromptbookStorage } from '../../../../storage/_common/PromptbookStorage';
 import type { TODO_any } from '../../../../utils/organization/TODO_any';
-import type { LlmExecutionToolsWithTotalCost } from './LlmExecutionToolsWithTotalCost';
+import type { LlmExecutionToolsWithTotalUsage } from './LlmExecutionToolsWithTotalUsage';
 /**
- * Options for `limitTotalCost`
+ * Options for `limitTotalUsage`
  */
-type LimitTotalCostOptions = {
+type LimitTotalUsageOptions = {
     /**
      * @@@
      *
      * @default ZERO_USAGE
      */
-    maxTotalCost: PromptResultUsage;
+    maxTotalUsage: PromptResultUsage;
     /**
      * @@@
      *
@@ -23,10 +23,13 @@ type LimitTotalCostOptions = {
 /**
  * @@@
  */
-export declare function limitTotalCost(llmTools: LlmExecutionTools, options?: Partial<LimitTotalCostOptions>): LlmExecutionToolsWithTotalCost;
+export declare function limitTotalUsage(llmTools: LlmExecutionTools, options?: Partial<LimitTotalUsageOptions>): LlmExecutionToolsWithTotalUsage;
 export {};
 /**
  * TODO: [🔼] !!! Export via `@promptbookcore/`
+ * TODO: Maybe internally use `countTotalUsage`
  * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
  * TODO: [🧠] Is there some meaningfull way how to test this util
+ * TODO: [🧠][🌯] Maybe a way how to hide ability to `get totalUsage`
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  */

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

@@ -46,4 +46,5 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
  * TODO: Maybe Create some common util for callChatModel and callCompletionModel
  * TODO: Maybe make custom OpenaiError
  * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
+ * TODO: [🍜] Auto use anonymous server in browser
  */

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

@@ -6,3 +6,6 @@ import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutio
  * This extends Anthropic's `ClientOptions` with are directly passed to the Anthropic client.
  */
 export type AnthropicClaudeExecutionToolsOptions = CommonExecutionToolsOptions & ClientOptions;
+/**
+ * TODO: [🍜] Auto add WebGPT / Promptbook.studio anonymous server in browser
+ */ 

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

@@ -1,5 +1,6 @@
 #!/usr/bin/env ts-node
 export {};
 /**
+ * TODO: [🍜] Playground with WebGPT / Promptbook.studio anonymous server
  * TODO: !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
  */

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

@@ -14,3 +14,6 @@ import { MultipleLlmExecutionTools } from './MultipleLlmExecutionTools';
  * Tip: You don't have to use this function directly, just pass an array of LlmExecutionTools to the `ExecutionTools`
  */
 export declare function joinLlmExecutionTools(...llmExecutionTools: Array<LlmExecutionTools>): MultipleLlmExecutionTools;
+/**
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ */ 

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

@@ -0,0 +1 @@
+export {};

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

@@ -51,4 +51,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
+ */ 

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

@@ -26,3 +26,6 @@ export type RemoteServerOptions = CommonExecutionToolsOptions & {
      */
     createLlmExecutionTools(clientId: client_id): LlmExecutionTools;
 };
+/**
+ * TODO: [🍜] Add anonymous option
+ */ 

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

@@ -10,6 +10,7 @@ import type { RemoteServerOptions } from './interfaces/RemoteServerOptions';
  */
 export declare function startRemoteServer(options: RemoteServerOptions): IDestroyable;
 /**
+ * TODO: [🍜] Add anonymous option
  * TODO: [⚖] Expose the collection to be able to connect to same collection via createCollectionFromUrl
  * TODO: Handle progress - support streaming
  * TODO: [🗯] Do not hang up immediately but wait until client closes OR timeout

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

@@ -12,6 +12,5 @@ export declare function preparePipeline(pipeline: PipelineJson, options: Prepare
  * TODO: Write tests for `preparePipeline`
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
- * TODO: [🎐] !!!!! Use here countTotalUsage
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

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

@@ -13,7 +13,7 @@ export type PreparationJson = {
     /**
      * Usage of the prompt execution
      */
-    readonly modelUsage: PromptResultUsage;
+    readonly usage: PromptResultUsage;
 };
 /**
  * TODO: [🍙] Make some standart order of json properties

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/markdown-utils",
-    "version": "0.61.0",
+    "version": "0.62.0-1",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -34,7 +34,7 @@
     },
     "homepage": "https://www.npmjs.com/package/@promptbook/core",
     "dependencies": {
-        "spacetrim": "0.11.37"
+        "spacetrim": "0.11.39"
     },
     "funding": [
         {
@@ -47,7 +47,7 @@
         }
     ],
     "peerDependencies": {
-        "@promptbook/core": "0.61.0"
+        "@promptbook/core": "0.62.0-1"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

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

@@ -26,7 +26,7 @@ declare const _default: ({
     preparations: {
         id: number;
         promptbookVersion: string;
-        modelUsage: {
+        usage: {
             price: {
                 value: number;
             };
@@ -113,7 +113,7 @@ declare const _default: ({
     preparations: {
         id: number;
         promptbookVersion: string;
-        modelUsage: {
+        usage: {
             price: {
                 value: number;
             };
@@ -195,7 +195,7 @@ declare const _default: ({
     preparations: {
         id: number;
         promptbookVersion: string;
-        modelUsage: {
+        usage: {
             price: {
                 value: number;
             };

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

@@ -26,6 +26,7 @@ import { embeddingVectorToString } from '../execution/embeddingVectorToString';
 import { addUsage } from '../execution/utils/addUsage';
 import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
 import { usageToWorktime } from '../execution/utils/usageToWorktime';
+import { usageToHuman } from '../execution/utils/usageToHuman';
 import { CallbackInterfaceTools } from '../knowledge/dialogs/callback/CallbackInterfaceTools';
 import type { CallbackInterfaceToolsOptions } from '../knowledge/dialogs/callback/CallbackInterfaceToolsOptions';
 import { SimplePromptInterfaceTools } from '../knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools';
@@ -39,7 +40,7 @@ import { executionReportJsonToString } from '../types/execution-report/execution
 import { PROMPTBOOK_VERSION } from '../version';
 export { PROMPTBOOK_VERSION };
 export { BlockTypes, RESERVED_PARAMETER_NAMES };
-export { addUsage, assertsExecutionSuccessful, checkExpectations, embeddingVectorToString, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prepareKnowledgeFromMarkdown, prettifyPipelineString, usageToWorktime, };
+export { addUsage, assertsExecutionSuccessful, checkExpectations, embeddingVectorToString, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prepareKnowledgeFromMarkdown, prettifyPipelineString, usageToWorktime, usageToHuman, };
 export { collectionToJson, createCollectionFromJson, createCollectionFromPromise, createCollectionFromUrl, createSubcollection, };
 export { SimplePromptInterfaceTools };
 export { pipelineJsonToString, pipelineStringToJson, pipelineStringToJsonSync, stringifyPipelineJson, validatePipeline, };

package/umd/typings/src/conversion/pipelineJsonToString.d.ts

@@ -10,5 +10,6 @@ export declare function pipelineJsonToString(pipelineJson: PipelineJson): Pipeli
 /**
  * TODO: !!!! Implement new features and commands into `promptTemplateParameterJsonToString`
  * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
- * TODO: Escape all
+ * TODO: [🏛] Maybe make some markdown builder
+ * TODO: [🏛] Escape all
  */

package/umd/typings/src/execution/createPipelineExecutor.d.ts

@@ -58,6 +58,7 @@ export declare function createPipelineExecutor(options: CreatePipelineExecutorOp
 export {};
 /**
  * TODO: Use isVerbose here (not only pass to `preparePipeline`)
+ * TODO: [🧠] Use here `countTotalUsage` and put preparation and prepared pipiline to report
  * TODO: [🪂] Use maxParallelCount here (not only pass to `preparePipeline`)
  * TODO: [♈] Probbably move expectations from templates to parameters
  * TODO: [🧠] When not meet expectations in PROMPT_DIALOG, make some way to tell the user

package/umd/typings/src/execution/utils/usageToHuman.d.ts

@@ -0,0 +1,15 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { PromptResultUsage } from '../PromptResultUsage';
+/**
+ * Function `usageToHuman` will take usage and convert it to human readable report
+ */
+export declare function usageToHuman(usage: PromptResultUsage): string_markdown;
+/**
+ * TODO: Use "$1" not "1 USD"
+ * TODO: Use markdown formatting like "Cost approximately **$1**"
+ * TODO: Report in minutes, seconds, days NOT 0.1 hours
+ * TODO: [🧠] Maybe make from `uncertainNumberToHuman` separate exported utility
+ * TODO: When negligible usage, report "Negligible" or just don't report it
+ * TODO: [🧠] Maybe use "~" instead of "approximately"
+ * TODO: [🏛] Maybe make some markdown builder
+ */

package/umd/typings/src/execution/utils/usageToHuman.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -12,6 +12,8 @@ export type CreateLlmToolsFromEnvOptions = {
  *
  * Note: This function is not cached, every call creates new instance of `LlmExecutionTools`
  *
+ * @@@ .env
+ *
  * It looks for environment variables:
  * - `process.env.OPENAI_API_KEY`
  * - `process.env.ANTHROPIC_CLAUDE_API_KEY`
@@ -20,6 +22,7 @@ export type CreateLlmToolsFromEnvOptions = {
  */
 export declare function createLlmToolsFromEnv(options?: CreateLlmToolsFromEnvOptions): LlmExecutionTools;
 /**
+ * TODO: [🍜] Use `createLlmToolsFromConfiguration`
  * TODO: [🔼] !!! Export via `@promptbook/node`
  * TODO: @@@ write discussion about this - wizzard
  * TODO: Add Azure
@@ -27,4 +30,5 @@ export declare function createLlmToolsFromEnv(options?: CreateLlmToolsFromEnvOpt
  * 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`
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  */

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

@@ -1,10 +1,20 @@
-import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { LlmExecutionToolsWithTotalUsage } from './utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
+type GetLlmToolsForCliOptions = {
+    /**
+     * @@@
+     *
+     * @default false
+     */
+    isCacheReloaded?: boolean;
+};
 /**
  * Returns LLM tools for CLI
  *
  * @private within the repository - for CLI utils
  */
-export declare function getLlmToolsForCli(): LlmExecutionTools;
+export declare function getLlmToolsForCli(options?: GetLlmToolsForCliOptions): LlmExecutionToolsWithTotalUsage;
+export {};
 /**
  * Note: [🟡] This code should never be published outside of `@promptbook/cli`
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  */

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

@@ -1,11 +1,21 @@
-import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { CreateLlmToolsFromEnvOptions } from './createLlmToolsFromEnv';
+import type { LlmExecutionToolsWithTotalUsage } from './utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
+type GetLlmToolsForTestingAndScriptsAndPlaygroundOptions = CreateLlmToolsFromEnvOptions & {
+    /**
+     * @@@
+     *
+     * @default false
+     */
+    isCacheReloaded?: boolean;
+};
 /**
  * Returns LLM tools for testing purposes
  *
  * @private within the repository - JUST FOR TESTS, SCRIPTS AND PLAYGROUND
  */
-export declare function getLlmToolsForTestingAndScriptsAndPlayground(options?: CreateLlmToolsFromEnvOptions): LlmExecutionTools;
+export declare function getLlmToolsForTestingAndScriptsAndPlayground(options?: GetLlmToolsForTestingAndScriptsAndPlaygroundOptions): LlmExecutionToolsWithTotalUsage;
+export {};
 /**
  * Note: [⚪] This should never be in any released package
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  */

package/umd/typings/src/llm-providers/_common/utils/cache/CacheLlmToolsOptions.d.ts

@@ -2,9 +2,15 @@ import type { PromptbookStorage } from '../../../../storage/_common/PromptbookSt
 import type { CacheItem } from './CacheItem';
 export type CacheLlmToolsOptions = {
     /**
-     * Total cost of the execution
+     * @@@
      *
      * @default MemoryStorage
      */
     storage: PromptbookStorage<CacheItem>;
+    /**
+     * @@@
+     *
+     * @default false
+     */
+    isReloaded?: boolean;
 };

package/umd/typings/src/llm-providers/_common/utils/cache/cacheLlmTools.d.ts

@@ -3,14 +3,17 @@ import type { CacheLlmToolsOptions } from './CacheLlmToolsOptions';
 /**
  * Intercepts LLM tools and counts total usage of the tools
  *
- * @param llmTools LLM tools to be intercepted with usage counting
+ * Note: It can take extended `LlmExecutionTools` and cache the
+ *
+ * @param llmTools LLM tools to be intercepted with usage counting, it can contain extra methods like `totalUsage`
  * @returns LLM tools with same functionality with added total cost counting
  */
-export declare function cacheLlmTools(llmTools: LlmExecutionTools, options?: Partial<CacheLlmToolsOptions>): LlmExecutionTools;
+export declare function cacheLlmTools<TLlmTools extends LlmExecutionTools>(llmTools: TLlmTools, options?: Partial<CacheLlmToolsOptions>): TLlmTools;
 /**
  * TODO: [🔼] !!! Export via `@promptbook/core`
- * TODO: @@@ write discussion about this and storages
- *            write how to combine multiple interceptors
  * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
  * TODO: [🧠] Is there some meaningfull way how to test this util
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ *            @@@ write discussion about this and storages
+ *            @@@ write how to combine multiple interceptors
  */

package/umd/typings/src/llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage.d.ts

@@ -0,0 +1,15 @@
+import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
+import type { PromptResultUsage } from '../../../../execution/PromptResultUsage';
+/**
+ * LLM tools with option to get total usage of the execution
+ */
+export type LlmExecutionToolsWithTotalUsage = LlmExecutionTools & {
+    /**
+     * Get total cost of the execution up to this point
+     */
+    getTotalUsage(): PromptResultUsage;
+};
+/**
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ * Note: [🥫] Not using getter `get totalUsage` but `getTotalUsage` to allow this object to be proxied
+ */

package/{esm/typings/src/llm-providers/_common/utils/count-total-cost/countTotalCost.d.ts → umd/typings/src/llm-providers/_common/utils/count-total-usage/countTotalUsage.d.ts}

@@ -1,14 +1,17 @@
 import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
-import type { LlmExecutionToolsWithTotalCost } from './LlmExecutionToolsWithTotalCost';
+import type { LlmExecutionToolsWithTotalUsage } from './LlmExecutionToolsWithTotalUsage';
 /**
  * Intercepts LLM tools and counts total usage of the tools
  *
  * @param llmTools LLM tools to be intercepted with usage counting
  * @returns LLM tools with same functionality with added total cost counting
  */
-export declare function countTotalUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalCost;
+export declare function countTotalUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalUsage;
 /**
  * TODO: [🔼] !!! Export via `@promptbookcore/`
  * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
  * TODO: [🧠] Is there some meaningfull way how to test this util
+ * TODO: [🧠][🌯] Maybe a way how to hide ability to `get totalUsage`
+ *     > const [llmToolsWithUsage,getUsage] = countTotalUsage(llmTools);
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  */

package/umd/typings/src/llm-providers/_common/utils/{count-total-cost/limitTotalCost.d.ts → count-total-usage/limitTotalUsage.d.ts}

@@ -2,17 +2,17 @@ import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools'
 import type { PromptResultUsage } from '../../../../execution/PromptResultUsage';
 import type { PromptbookStorage } from '../../../../storage/_common/PromptbookStorage';
 import type { TODO_any } from '../../../../utils/organization/TODO_any';
-import type { LlmExecutionToolsWithTotalCost } from './LlmExecutionToolsWithTotalCost';
+import type { LlmExecutionToolsWithTotalUsage } from './LlmExecutionToolsWithTotalUsage';
 /**
- * Options for `limitTotalCost`
+ * Options for `limitTotalUsage`
  */
-type LimitTotalCostOptions = {
+type LimitTotalUsageOptions = {
     /**
      * @@@
      *
      * @default ZERO_USAGE
      */
-    maxTotalCost: PromptResultUsage;
+    maxTotalUsage: PromptResultUsage;
     /**
      * @@@
      *
@@ -23,10 +23,13 @@ type LimitTotalCostOptions = {
 /**
  * @@@
  */
-export declare function limitTotalCost(llmTools: LlmExecutionTools, options?: Partial<LimitTotalCostOptions>): LlmExecutionToolsWithTotalCost;
+export declare function limitTotalUsage(llmTools: LlmExecutionTools, options?: Partial<LimitTotalUsageOptions>): LlmExecutionToolsWithTotalUsage;
 export {};
 /**
  * TODO: [🔼] !!! Export via `@promptbookcore/`
+ * TODO: Maybe internally use `countTotalUsage`
  * TODO: [🧠][💸] Maybe make some common abstraction `interceptLlmTools` and use here (or use javascript Proxy?)
  * TODO: [🧠] Is there some meaningfull way how to test this util
+ * TODO: [🧠][🌯] Maybe a way how to hide ability to `get totalUsage`
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  */

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

@@ -46,4 +46,5 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
  * TODO: Maybe Create some common util for callChatModel and callCompletionModel
  * TODO: Maybe make custom OpenaiError
  * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
+ * TODO: [🍜] Auto use anonymous server in browser
  */

package/umd/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions.d.ts

@@ -6,3 +6,6 @@ import type { CommonExecutionToolsOptions } from '../../execution/CommonExecutio
  * This extends Anthropic's `ClientOptions` with are directly passed to the Anthropic client.
  */
 export type AnthropicClaudeExecutionToolsOptions = CommonExecutionToolsOptions & ClientOptions;
+/**
+ * TODO: [🍜] Auto add WebGPT / Promptbook.studio anonymous server in browser
+ */ 

package/umd/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts

@@ -1,5 +1,6 @@
 #!/usr/bin/env ts-node
 export {};
 /**
+ * TODO: [🍜] Playground with WebGPT / Promptbook.studio anonymous server
  * TODO: !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
  */

package/umd/typings/src/llm-providers/multiple/joinLlmExecutionTools.d.ts

@@ -14,3 +14,6 @@ import { MultipleLlmExecutionTools } from './MultipleLlmExecutionTools';
  * Tip: You don't have to use this function directly, just pass an array of LlmExecutionTools to the `ExecutionTools`
  */
 export declare function joinLlmExecutionTools(...llmExecutionTools: Array<LlmExecutionTools>): MultipleLlmExecutionTools;
+/**
+ * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
+ */ 

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

@@ -0,0 +1 @@
+export {};

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

@@ -51,4 +51,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
+ */ 

package/umd/typings/src/llm-providers/remote/interfaces/RemoteServerOptions.d.ts

@@ -26,3 +26,6 @@ export type RemoteServerOptions = CommonExecutionToolsOptions & {
      */
     createLlmExecutionTools(clientId: client_id): LlmExecutionTools;
 };
+/**
+ * TODO: [🍜] Add anonymous option
+ */ 

package/umd/typings/src/llm-providers/remote/startRemoteServer.d.ts

@@ -10,6 +10,7 @@ import type { RemoteServerOptions } from './interfaces/RemoteServerOptions';
  */
 export declare function startRemoteServer(options: RemoteServerOptions): IDestroyable;
 /**
+ * TODO: [🍜] Add anonymous option
  * TODO: [⚖] Expose the collection to be able to connect to same collection via createCollectionFromUrl
  * TODO: Handle progress - support streaming
  * TODO: [🗯] Do not hang up immediately but wait until client closes OR timeout

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

@@ -12,6 +12,5 @@ export declare function preparePipeline(pipeline: PipelineJson, options: Prepare
  * TODO: Write tests for `preparePipeline`
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
- * TODO: [🎐] !!!!! Use here countTotalUsage
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

package/umd/typings/src/types/PipelineJson/PreparationJson.d.ts

@@ -13,7 +13,7 @@ export type PreparationJson = {
     /**
      * Usage of the prompt execution
      */
-    readonly modelUsage: PromptResultUsage;
+    readonly usage: PromptResultUsage;
 };
 /**
  * TODO: [🍙] Make some standart order of json properties

package/esm/typings/src/llm-providers/_common/utils/count-total-cost/LlmExecutionToolsWithTotalCost.d.ts

@@ -1,11 +0,0 @@
-import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
-import type { PromptResultUsage } from '../../../../execution/PromptResultUsage';
-/**
- * LLM tools with option to get total cost of the execution
- */
-export type LlmExecutionToolsWithTotalCost = LlmExecutionTools & {
-    /**
-     * Total cost of the execution
-     */
-    totalUsage: PromptResultUsage;
-};

package/umd/typings/src/llm-providers/_common/utils/count-total-cost/LlmExecutionToolsWithTotalCost.d.ts

@@ -1,11 +0,0 @@
-import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
-import type { PromptResultUsage } from '../../../../execution/PromptResultUsage';
-/**
- * LLM tools with option to get total cost of the execution
- */
-export type LlmExecutionToolsWithTotalCost = LlmExecutionTools & {
-    /**
-     * Total cost of the execution
-     */
-    totalUsage: PromptResultUsage;
-};