@promptbook/openai 0.88.0 → 0.89.0-11

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

@@ -54,11 +54,11 @@ import type { PromptResult } from '../execution/PromptResult';
 import type { CompletionPromptResult } from '../execution/PromptResult';
 import type { ChatPromptResult } from '../execution/PromptResult';
 import type { EmbeddingPromptResult } from '../execution/PromptResult';
-import type { PromptResultUsage } from '../execution/PromptResultUsage';
-import type { PromptResultUsageCounts } from '../execution/PromptResultUsage';
 import type { ScriptExecutionTools } from '../execution/ScriptExecutionTools';
 import type { ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExecutionTools';
 import type { UncertainNumber } from '../execution/UncertainNumber';
+import type { Usage } from '../execution/Usage';
+import type { UsageCounts } from '../execution/Usage';
 import type { UserInterfaceTools } from '../execution/UserInterfaceTools';
 import type { UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
 import type { FormatSubvalueDefinition } from '../formats/_common/FormatSubvalueDefinition';
@@ -107,14 +107,17 @@ import type { SimpleTaskJson } from '../pipeline/PipelineJson/SimpleTaskJson';
 import type { TaskJson } from '../pipeline/PipelineJson/TaskJson';
 import type { PipelineString } from '../pipeline/PipelineString';
 import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
-import type { PromptbookServer_Identification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
-import type { PromptbookServer_ApplicationIdentification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
-import type { PromptbookServer_AnonymousIdentification } from '../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
+import type { RemoteServer } from '../remote-server/RemoteServer';
+import type { Identification } from '../remote-server/socket-types/_subtypes/Identification';
+import type { ApplicationModeIdentification } from '../remote-server/socket-types/_subtypes/Identification';
+import type { AnonymousModeIdentification } from '../remote-server/socket-types/_subtypes/Identification';
 import type { RemoteClientOptions } from '../remote-server/types/RemoteClientOptions';
 import type { RemoteServerOptions } from '../remote-server/types/RemoteServerOptions';
 import type { AnonymousRemoteServerOptions } from '../remote-server/types/RemoteServerOptions';
 import type { ApplicationRemoteServerOptions } from '../remote-server/types/RemoteServerOptions';
 import type { ApplicationRemoteServerClientOptions } from '../remote-server/types/RemoteServerOptions';
+import type { LoginRequest } from '../remote-server/types/RemoteServerOptions';
+import type { LoginResponse } from '../remote-server/types/RemoteServerOptions';
 import type { Converter } from '../scrapers/_common/Converter';
 import type { ScraperAndConverterMetadata } from '../scrapers/_common/register/ScraperAndConverterMetadata';
 import type { ScraperConstructor } from '../scrapers/_common/register/ScraperConstructor';
@@ -174,6 +177,7 @@ import type { string_markdown_text } from '../types/typeAliases';
 import type { string_markdown_codeblock_language } from '../types/typeAliases';
 import type { string_promptbook_documentation_url } from '../types/typeAliases';
 import type { string_domain } from '../types/typeAliases';
+import type { string_origin } from '../types/typeAliases';
 import type { string_tdl } from '../types/typeAliases';
 import type { string_css } from '../types/typeAliases';
 import type { string_svg } from '../types/typeAliases';
@@ -337,11 +341,11 @@ export type { PromptResult };
 export type { CompletionPromptResult };
 export type { ChatPromptResult };
 export type { EmbeddingPromptResult };
-export type { PromptResultUsage };
-export type { PromptResultUsageCounts };
 export type { ScriptExecutionTools };
 export type { ScriptExecutionToolsExecuteOptions };
 export type { UncertainNumber };
+export type { Usage };
+export type { UsageCounts };
 export type { UserInterfaceTools };
 export type { UserInterfaceToolsPromptDialogOptions };
 export type { FormatSubvalueDefinition };
@@ -390,14 +394,17 @@ export type { SimpleTaskJson };
 export type { TaskJson };
 export type { PipelineString };
 export type { PrepareAndScrapeOptions };
-export type { PromptbookServer_Identification };
-export type { PromptbookServer_ApplicationIdentification };
-export type { PromptbookServer_AnonymousIdentification };
+export type { RemoteServer };
+export type { Identification };
+export type { ApplicationModeIdentification };
+export type { AnonymousModeIdentification };
 export type { RemoteClientOptions };
 export type { RemoteServerOptions };
 export type { AnonymousRemoteServerOptions };
 export type { ApplicationRemoteServerOptions };
 export type { ApplicationRemoteServerClientOptions };
+export type { LoginRequest };
+export type { LoginResponse };
 export type { Converter };
 export type { ScraperAndConverterMetadata };
 export type { ScraperConstructor };
@@ -457,6 +464,7 @@ export type { string_markdown_text };
 export type { string_markdown_codeblock_language };
 export type { string_promptbook_documentation_url };
 export type { string_domain };
+export type { string_origin };
 export type { string_tdl };
 export type { string_css };
 export type { string_svg };

package/esm/typings/src/cli/cli-commands/login.d.ts

@@ -0,0 +1,15 @@
+import type { Command as Program } from 'commander';
+/**
+ * Initializes `login` command for Promptbook CLI utilities
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it registers a command in the CLI
+ *
+ * @private internal function of `promptbookCli`
+ */
+export declare function $initializeLoginCommand(program: Program): void;
+/**
+ * TODO: Pass remote server URL (and path)
+ * TODO: Implement non-interactive login
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`
+ */

package/esm/typings/src/cli/common/$addGlobalOptionsToCommand.d.ts

@@ -0,0 +1,7 @@
+import { Command } from 'commander';
+/**
+ * Note: `$` is used to indicate that this function is not a pure function - it registers an option in the CLI
+ *
+ * @private utility of CLI
+ */
+export declare function $addGlobalOptionsToCommand(command: Command): void;

package/esm/typings/src/cli/common/$provideLlmToolsForCli.d.ts

@@ -0,0 +1,15 @@
+import type { CacheLlmToolsOptions } from '../../llm-providers/_common/utils/cache/CacheLlmToolsOptions';
+import type { string_url } from '../../types/typeAliases';
+type ProvideLlmToolsForCliOptions = Pick<CacheLlmToolsOptions, 'isCacheReloaded'> & {
+    cliOptions: {
+        verbose: boolean;
+        interactive: boolean;
+        provider: 'BYOK' | 'BRING_YOUR_OWN_KEYS' | 'REMOTE_SERVER' | 'RS' | string;
+        remoteServerUrl: string_url;
+    };
+};
+/**
+ * @private utility of CLI
+ */
+export declare function $provideLlmToolsForCli(options: ProvideLlmToolsForCliOptions): Promise<import("../../_packages/types.index").LlmExecutionToolsWithTotalUsage>;
+export {};

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

@@ -1,5 +1,6 @@
 import type { CsvSettings } from './formats/csv/CsvSettings';
 import type { IntermediateFilesStrategy } from './types/IntermediateFilesStrategy';
+import type { string_app_id } from './types/typeAliases';
 import type { string_email } from './types/typeAliases';
 import type { string_name } from './types/typeAliases';
 import type { string_url_image } from './types/typeAliases';
@@ -208,6 +209,18 @@ export declare const DEFAULT_EXECUTION_CACHE_DIRNAME = "./.promptbook/execution-
  * @public exported from `@promptbook/core`
  */
 export declare const DEFAULT_SCRAPE_CACHE_DIRNAME = "./.promptbook/scrape-cache";
+/**
+ * Id of application for the CLI when using remote server
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const CLI_APP_ID: string_app_id;
+/**
+ * Id of application for the playground
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const PLAYGROUND_APP_ID: string_app_id;
 /**
  * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
  *
@@ -228,13 +241,7 @@ export declare const MOMENT_ARG_THRESHOLDS: {
  *
  * @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";
+export declare const DEFAULT_REMOTE_SERVER_URL = "https://api.pavolhejny.com/promptbook";
 /**
  * @@@
  *
@@ -281,5 +288,5 @@ export declare const IS_PIPELINE_LOGIC_VALIDATED: boolean;
 export declare const IS_COST_PREVENTED: boolean;
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
- * TODO: [🧠][🧜‍♂️] Maybe join remoteUrl and path into single value
+ * TODO: [🧠][🧜‍♂️] Maybe join remoteServerUrl and path into single value
  */

package/esm/typings/src/errors/0-index.d.ts

@@ -1,5 +1,6 @@
 import { CsvFormatError } from '../formats/csv/CsvFormatError';
 import { AbstractFormatError } from './AbstractFormatError';
+import { AuthenticationError } from './AuthenticationError';
 import { CollectionError } from './CollectionError';
 import { EnvironmentMismatchError } from './EnvironmentMismatchError';
 import { ExpectError } from './ExpectError';
@@ -12,6 +13,7 @@ import { ParseError } from './ParseError';
 import { PipelineExecutionError } from './PipelineExecutionError';
 import { PipelineLogicError } from './PipelineLogicError';
 import { PipelineUrlError } from './PipelineUrlError';
+import { PromptbookFetchError } from './PromptbookFetchError';
 import { UnexpectedError } from './UnexpectedError';
 /**
  * Index of all custom errors
@@ -49,6 +51,8 @@ export declare const COMMON_JAVASCRIPT_ERRORS: {
     readonly TypeError: TypeErrorConstructor;
     readonly URIError: URIErrorConstructor;
     readonly AggregateError: AggregateErrorConstructor;
+    readonly AuthenticationError: typeof AuthenticationError;
+    readonly PromptbookFetchError: typeof PromptbookFetchError;
 };
 /**
  * Index of all errors
@@ -64,6 +68,8 @@ export declare const ALL_ERRORS: {
     readonly TypeError: TypeErrorConstructor;
     readonly URIError: URIErrorConstructor;
     readonly AggregateError: AggregateErrorConstructor;
+    readonly AuthenticationError: typeof AuthenticationError;
+    readonly PromptbookFetchError: typeof PromptbookFetchError;
     readonly AbstractFormatError: typeof AbstractFormatError;
     readonly CsvFormatError: typeof CsvFormatError;
     readonly CollectionError: typeof CollectionError;

package/esm/typings/src/errors/AuthenticationError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * AuthenticationError is thrown from login function which is dependency of remote server
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class AuthenticationError extends Error {
+    readonly name = "AuthenticationError";
+    constructor(message: string);
+}

package/esm/typings/src/errors/PromptbookFetchError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Error thrown when a fetch request fails
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class PromptbookFetchError extends Error {
+    readonly name = "PromptbookFetchError";
+    constructor(message: string);
+}

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

@@ -3,7 +3,7 @@ import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 import type { Parameters } from '../types/typeAliases';
 import type { AbstractTaskResult } from './AbstractTaskResult';
 import type { ExecutionReportJson } from './execution-report/ExecutionReportJson';
-import type { PromptResultUsage } from './PromptResultUsage';
+import type { Usage } from './Usage';
 /**
  * @@@
  *
@@ -19,7 +19,7 @@ export type PipelineExecutorResult = AbstractTaskResult & {
     /**
      * Added usage of whole execution, detailed usage is available in `executionReport`
      */
-    readonly usage: ReadonlyDeep<PromptResultUsage>;
+    readonly usage: ReadonlyDeep<Usage>;
     /**
      * The report of the execution with all details
      */

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

@@ -3,7 +3,7 @@ import type { string_model_name } from '../types/typeAliases';
 import type { string_prompt } from '../types/typeAliases';
 import type { TODO_object } from '../utils/organization/TODO_object';
 import type { EmbeddingVector } from './EmbeddingVector';
-import type { PromptResultUsage } from './PromptResultUsage';
+import type { Usage } from './Usage';
 /**
  * Prompt result is the simplest concept of execution.
  * It is the result of executing one prompt _(NOT a template)_.
@@ -71,7 +71,7 @@ export type CommonPromptResult = {
     /**
      * Usage of the prompt execution
      */
-    readonly usage: PromptResultUsage;
+    readonly usage: Usage;
     /**
      * Exact text of the prompt (with all replacements)
      *

package/esm/typings/src/execution/{PromptResultUsage.d.ts → Usage.d.ts}

@@ -2,11 +2,11 @@ import type { KebabCase } from 'type-fest';
 import type { ExpectationUnit } from '../pipeline/PipelineJson/Expectations';
 import type { UncertainNumber } from './UncertainNumber';
 /**
- * Usage statistics for one or many prompt results
+ * Usage statistics for one or more prompt results
  *
  * Note: [🚉] This is fully serializable as JSON
  */
-export type PromptResultUsage = {
+export type Usage = {
     /**
      * Cost of the execution in USD
      *
@@ -16,18 +16,18 @@ export type PromptResultUsage = {
     /**
      * Number of whatever used in the input aka. `prompt_tokens`
      */
-    readonly input: PromptResultUsageCounts;
+    readonly input: UsageCounts;
     /**
      * Number of tokens used in the output aka. `completion_tokens`
      */
-    readonly output: PromptResultUsageCounts;
+    readonly output: UsageCounts;
 };
 /**
  * Record of all possible measurable units
  *
  * Note: [🚉] This is fully serializable as JSON
  */
-export type PromptResultUsageCounts = Record<`${KebabCase<'TOKENS' | ExpectationUnit>}Count`, UncertainNumber>;
+export type UsageCounts = Record<`${KebabCase<'TOKENS' | ExpectationUnit>}Count`, UncertainNumber>;
 /**
  * TODO: [🍙] Make some standard order of json properties
  */

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

@@ -1,4 +1,4 @@
-import type { PromptResultUsage } from '../PromptResultUsage';
+import type { Usage } from '../Usage';
 /**
  * Function `addUsage` will add multiple usages into one
  *
@@ -6,4 +6,4 @@ import type { PromptResultUsage } from '../PromptResultUsage';
  *
  * @public exported from `@promptbook/core`
  */
-export declare function addUsage(...usageItems: ReadonlyArray<PromptResultUsage>): PromptResultUsage;
+export declare function addUsage(...usageItems: ReadonlyArray<Usage>): Usage;

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

@@ -1,10 +1,10 @@
-import type { PromptResultUsageCounts } from '../PromptResultUsage';
+import type { UsageCounts } from '../Usage';
 /**
  * Helper of usage compute
  *
  * @param content the content of prompt or response
- * @returns part of PromptResultUsageCounts
+ * @returns part of UsageCounts
  *
  * @private internal utility of LlmExecutionTools
  */
-export declare function computeUsageCounts(content: string): Omit<PromptResultUsageCounts, 'tokensCount'>;
+export declare function computeUsageCounts(content: string): Omit<UsageCounts, 'tokensCount'>;

package/esm/typings/src/execution/utils/usage-constants.d.ts

@@ -1,57 +1,74 @@
+/**
+ * Represents the uncertain value
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const ZERO_VALUE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    readonly value: 0;
+}>;
+/**
+ * Represents the uncertain value
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const UNCERTAIN_ZERO_VALUE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
+    readonly value: 0;
+    readonly isUncertain: true;
+}>;
 /**
  * Represents the usage with no resources consumed
  *
  * @public exported from `@promptbook/core`
  */
 export declare const ZERO_USAGE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    readonly price: {
+    readonly price: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
         readonly value: 0;
-    };
+    }>;
     readonly input: {
-        readonly tokensCount: {
+        readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly charactersCount: {
+        }>;
+        readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly wordsCount: {
+        }>;
+        readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly sentencesCount: {
+        }>;
+        readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly linesCount: {
+        }>;
+        readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly paragraphsCount: {
+        }>;
+        readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly pagesCount: {
+        }>;
+        readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
+        }>;
     };
     readonly output: {
-        readonly tokensCount: {
+        readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly charactersCount: {
+        }>;
+        readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly wordsCount: {
+        }>;
+        readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly sentencesCount: {
+        }>;
+        readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly linesCount: {
+        }>;
+        readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly paragraphsCount: {
+        }>;
+        readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
-        readonly pagesCount: {
+        }>;
+        readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
-        };
+        }>;
     };
 }>;
 /**
@@ -60,69 +77,69 @@ export declare const ZERO_USAGE: import("type-fest/source/readonly-deep").Readon
  * @public exported from `@promptbook/core`
  */
 export declare const UNCERTAIN_USAGE: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
-    readonly price: {
+    readonly price: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
         readonly value: 0;
         readonly isUncertain: true;
-    };
+    }>;
     readonly input: {
-        readonly tokensCount: {
+        readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly charactersCount: {
+        }>;
+        readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly wordsCount: {
+        }>;
+        readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly sentencesCount: {
+        }>;
+        readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly linesCount: {
+        }>;
+        readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly paragraphsCount: {
+        }>;
+        readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly pagesCount: {
+        }>;
+        readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
+        }>;
     };
     readonly output: {
-        readonly tokensCount: {
+        readonly tokensCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly charactersCount: {
+        }>;
+        readonly charactersCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly wordsCount: {
+        }>;
+        readonly wordsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly sentencesCount: {
+        }>;
+        readonly sentencesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly linesCount: {
+        }>;
+        readonly linesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly paragraphsCount: {
+        }>;
+        readonly paragraphsCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
-        readonly pagesCount: {
+        }>;
+        readonly pagesCount: import("type-fest/source/readonly-deep").ReadonlyObjectDeep<{
             readonly value: 0;
             readonly isUncertain: true;
-        };
+        }>;
     };
 }>;
 /**

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

@@ -1,20 +1,20 @@
 import type { string_markdown } from '../../types/typeAliases';
-import type { PromptResultUsage } from '../PromptResultUsage';
 import type { UncertainNumber } from '../UncertainNumber';
+import type { Usage } from '../Usage';
 /**
  * Minimal usage information required to calculate worktime
  */
-type PartialPromptResultUsage = Partial<PromptResultUsage> & {
+type PartialUsage = Partial<Usage> & {
     price: UncertainNumber;
-    input: Pick<PromptResultUsage['input'], 'wordsCount'>;
-    output: Pick<PromptResultUsage['output'], 'wordsCount' | 'charactersCount'>;
+    input: Pick<Usage['input'], 'wordsCount'>;
+    output: Pick<Usage['output'], 'wordsCount' | 'charactersCount'>;
 };
 /**
  * Function `usageToHuman` will take usage and convert it to human readable report
  *
  * @public exported from `@promptbook/core`
  */
-export declare function usageToHuman(usage: PartialPromptResultUsage): string_markdown;
+export declare function usageToHuman(usage: PartialUsage): string_markdown;
 export {};
 /**
  * TODO: [🍓][🧞‍♂️] Use "$1" not "1 USD"

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

@@ -1,11 +1,11 @@
-import type { PromptResultUsage } from '../PromptResultUsage';
 import type { UncertainNumber } from '../UncertainNumber';
+import type { Usage } from '../Usage';
 /**
  * Minimal usage information required to calculate worktime
  */
-type PartialPromptResultUsage = Pick<PromptResultUsage, 'input' | 'output'> & {
-    input: Pick<PromptResultUsage['input'], 'wordsCount'>;
-    output: Pick<PromptResultUsage['output'], 'wordsCount'>;
+type PartialUsage = Pick<Usage, 'input' | 'output'> & {
+    input: Pick<Usage['input'], 'wordsCount'>;
+    output: Pick<Usage['output'], 'wordsCount'>;
 };
 /**
  * Function usageToWorktime will take usage and estimate saved worktime in hours of reading / writing
@@ -16,5 +16,5 @@ type PartialPromptResultUsage = Pick<PromptResultUsage, 'input' | 'output'> & {
  *
  * @public exported from `@promptbook/core`
  */
-export declare function usageToWorktime(usage: PartialPromptResultUsage): UncertainNumber;
+export declare function usageToWorktime(usage: PartialUsage): UncertainNumber;
 export {};

package/esm/typings/src/llm-providers/_common/register/$provideEnvFilename.d.ts

@@ -0,0 +1,12 @@
+import type { string_filename } from '../../../types/typeAliases';
+/**
+ * Provides the path to the `.env` file
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file
+ *
+ * @private within the repository - for CLI utils
+ */
+export declare function $provideEnvFilename(): Promise<string_filename | null>;
+/**
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts

@@ -3,6 +3,7 @@ import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
  * @@@
  *
  * @@@ .env
+ * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file
  *
  * It looks for environment variables:
  * - `process.env.OPENAI_API_KEY`
@@ -14,12 +15,5 @@ import type { LlmToolsConfiguration } from './LlmToolsConfiguration';
  */
 export declare function $provideLlmToolsConfigurationFromEnv(): Promise<LlmToolsConfiguration>;
 /**
- * TODO: [🧠][🪁] Maybe do allow to do auto-install if package not registered and not found
- * TODO: Add Azure OpenAI
- * TODO: [🧠][🍛]
- * TODO: [🧠] Is there some meaningfull way how to test this util
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
- * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
- * TODO: This should be maybe not under `_common` but under `utils`
- * TODO: [🧠][⚛] Maybe pass env as argument
- * TODO: [®] DRY Register logic */
+ */

package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts

@@ -12,6 +12,8 @@ type GetLlmToolsForTestingAndScriptsAndPlaygroundOptions = CreateLlmToolsFromCon
 /**
  * Returns LLM tools for testing purposes
  *
+ * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file
+ *
  * @private within the repository - JUST FOR TESTS, SCRIPTS AND PLAYGROUND
  */
 export declare function $provideLlmToolsForTestingAndScriptsAndPlayground(options?: GetLlmToolsForTestingAndScriptsAndPlaygroundOptions): Promise<LlmExecutionToolsWithTotalUsage>;