@promptbook/markdown-utils 0.88.0 → 0.89.0-11

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>;

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

@@ -1,11 +1,46 @@
+import { Promisable } from 'type-fest';
+import type { Identification } from '../../../remote-server/socket-types/_subtypes/Identification';
+import type { string_app_id } from '../../../types/typeAliases';
+import type { string_url } from '../../../types/typeAliases';
+import type { really_any } from '../../../utils/organization/really_any';
 import type { CacheLlmToolsOptions } from '../utils/cache/CacheLlmToolsOptions';
 import type { LlmExecutionToolsWithTotalUsage } from '../utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
+type ProvideLlmToolsForWizzardOrCliOptions = Pick<CacheLlmToolsOptions, 'isCacheReloaded'> & ({
+    /**
+     * Use local keys and execute LLMs directly
+     */
+    readonly strategy: 'BRING_YOUR_OWN_KEYS';
+} | {
+    /**
+     * Do not use local keys but login to Promptbook server and execute LLMs there
+     */
+    readonly strategy: 'REMOTE_SERVER';
+    /**
+     * URL of the remote server
+     *
+     * @default `DEFAULT_REMOTE_SERVER_URL`
+     */
+    readonly remoteServerUrl?: string_url;
+    /**
+     * Identifier of the application which will be passed to the remote server identification
+     *
+     * Note: This can be some id or some semantic name like "email-agent"
+     */
+    readonly appId: string_app_id;
+    /**
+     *
+     */
+    loginPrompt(): Promisable<Identification<really_any>>;
+});
 /**
  * Returns LLM tools for CLI
  *
+ * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file and also writes this .env file
+ *
  * @private within the repository - for CLI utils
  */
-export declare function $provideLlmToolsForWizzardOrCli(options?: Pick<CacheLlmToolsOptions, 'isCacheReloaded'>): Promise<LlmExecutionToolsWithTotalUsage>;
+export declare function $provideLlmToolsForWizzardOrCli(options?: ProvideLlmToolsForWizzardOrCliOptions): Promise<LlmExecutionToolsWithTotalUsage>;
+export {};
 /**
  * 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

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

@@ -6,6 +6,7 @@ import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFro
  * Note: This function is not cached, every call creates new instance of `MultipleLlmExecutionTools`
  *
  * @@@ .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`

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

@@ -1,5 +1,6 @@
+import type { Observable } from 'rxjs';
 import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
-import type { PromptResultUsage } from '../../../../execution/PromptResultUsage';
+import type { Usage } from '../../../../execution/Usage';
 /**
  * LLM tools with option to get total usage of the execution
  */
@@ -7,7 +8,13 @@ export type LlmExecutionToolsWithTotalUsage = LlmExecutionTools & {
     /**
      * Get total cost of the execution up to this point
      */
-    getTotalUsage(): PromptResultUsage;
+    getTotalUsage(): Usage;
+    /**
+     * Observable of total cost of the execution up to this point
+     *
+     * Note: This does report the cost of the last prompt, not the total cost of the execution up to this point
+     */
+    spending(): Observable<Usage>;
 };
 /**
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools

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

@@ -7,7 +7,7 @@ import type { LlmExecutionToolsWithTotalUsage } from './LlmExecutionToolsWithTot
  * @returns LLM tools with same functionality with added total cost counting
  * @public exported from `@promptbook/core`
  */
-export declare function countTotalUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalUsage;
+export declare function countUsage(llmTools: LlmExecutionTools): LlmExecutionToolsWithTotalUsage;
 /**
  * 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

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

@@ -1,5 +1,5 @@
 import type { LlmExecutionTools } from '../../../../execution/LlmExecutionTools';
-import type { PromptResultUsage } from '../../../../execution/PromptResultUsage';
+import type { Usage } from '../../../../execution/Usage';
 import type { PromptbookStorage } from '../../../../storage/_common/PromptbookStorage';
 import type { TODO_any } from '../../../../utils/organization/TODO_any';
 import type { LlmExecutionToolsWithTotalUsage } from './LlmExecutionToolsWithTotalUsage';
@@ -12,7 +12,7 @@ type LimitTotalUsageOptions = {
      *
      * @default ZERO_USAGE
      */
-    maxTotalUsage: PromptResultUsage;
+    maxTotalUsage: Usage;
     /**
      * @@@
      *

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

@@ -25,7 +25,7 @@ export type AnthropicClaudeExecutionToolsDirectOptions = CommonToolsOptions & Cl
  */
 export type AnthropicClaudeExecutionToolsProxiedOptions = CommonToolsOptions & ClientOptions & {
     isProxied: true;
-} & Pick<RemoteClientOptions<undefined>, 'remoteUrl' | 'path'>;
+} & Pick<RemoteClientOptions<undefined>, 'remoteServerUrl'>;
 /**
  * TODO: [🧠][🤺] Pass `userId`
  */

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

@@ -1,6 +1,6 @@
 import type Anthropic from '@anthropic-ai/sdk';
 import type { PartialDeep } from 'type-fest';
-import type { PromptResultUsage } from '../../execution/PromptResultUsage';
+import type { Usage } from '../../execution/Usage';
 import type { Prompt } from '../../types/Prompt';
 /**
  * Computes the usage of the Anthropic Claude API based on the response from Anthropic Claude
@@ -12,7 +12,7 @@ import type { Prompt } from '../../types/Prompt';
  * @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;
+resultContent: string, rawResponse: PartialDeep<Pick<Anthropic.Messages.Message, 'model' | 'usage'>>): Usage;
 /**
  * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenAiUsage` and `computeAnthropicClaudeUsage`
  */

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

@@ -11,4 +11,4 @@ import type { Registration } from '../../utils/$Register';
 export declare const _AnthropicClaudeMetadataRegistration: Registration;
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
- */ 
+ */

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

@@ -8,8 +8,6 @@ import type { Prompt } from '../../types/Prompt';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_markdown_text } from '../../types/typeAliases';
 import type { string_title } from '../../types/typeAliases';
-import type { string_token } from '../../types/typeAliases';
-import { OpenAiAssistantExecutionTools } from './OpenAiAssistantExecutionTools';
 import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
 /**
  * Execution Tools for calling OpenAI API
@@ -31,13 +29,6 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
     getClient(): Promise<OpenAI>;
-    /**
-     * Create (sub)tools for calling OpenAI API Assistants
-     *
-     * @param assistantId Which assistant to use
-     * @returns Tools for calling OpenAI API Assistants with same token
-     */
-    createAssistantSubtools(assistantId: string_token): OpenAiAssistantExecutionTools;
     /**
      * Check the `options` passed to `constructor`
      */

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

@@ -1,6 +1,6 @@
 import type OpenAI from 'openai';
 import type { PartialDeep } from 'type-fest';
-import type { PromptResultUsage } from '../../execution/PromptResultUsage';
+import type { Usage } from '../../execution/Usage';
 import type { Prompt } from '../../types/Prompt';
 /**
  * Computes the usage of the OpenAI API based on the response from OpenAI
@@ -12,7 +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: PartialDeep<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'>>): Usage;
 /**
  * TODO: [🤝] DRY Maybe some common abstraction between `computeOpenAiUsage` and `computeAnthropicClaudeUsage`
  */

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

@@ -1,4 +1,4 @@
-import type { PromptResultUsage } from '../../execution/PromptResultUsage';
+import type { Usage } from '../../execution/Usage';
 import type { number_id } from '../../types/typeAliases';
 import type { string_promptbook_version } from '../../version';
 export type PreparationJson = {
@@ -13,7 +13,7 @@ export type PreparationJson = {
     /**
      * Usage of the prompt execution
      */
-    readonly usage: PromptResultUsage;
+    readonly usage: Usage;
 };
 /**
  * TODO: [🍙] Make some standard order of json properties

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

@@ -0,0 +1,5 @@
+#!/usr/bin/env ts-node
+export {};
+/**
+ * Note: [⚫] Code in this file should never be published in any package
+ */

package/esm/typings/src/remote-server/RemoteServer.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="node" />
+import type { IDestroyable } from 'destroyable';
+import express from 'express';
+import http from 'http';
+import { DefaultEventsMap, Server } from 'socket.io';
+import type { TODO_any } from '../utils/organization/TODO_any';
+import type { TODO_narrow } from '../utils/organization/TODO_narrow';
+export type RemoteServer = IDestroyable & {
+    /**
+     * HTTP server instance
+     */
+    readonly httpServer: http.Server<TODO_any>;
+    /**
+     * Express application instance
+     *
+     * Note: This is useful for adding custom routes
+     */
+    readonly expressApp: express.Express;
+    /**
+     * Socket.io server instance
+     */
+    readonly socketIoServer: Server<TODO_narrow<DefaultEventsMap>, TODO_narrow<DefaultEventsMap>, TODO_narrow<DefaultEventsMap>, TODO_any>;
+};

package/esm/typings/src/remote-server/socket-types/_subtypes/{PromptbookServer_Identification.d.ts → Identification.d.ts}

@@ -7,14 +7,14 @@ import type { ApplicationRemoteServerClientOptions } from '../../types/RemoteSer
  * @public exported from `@promptbook/remote-server`
  * @public exported from `@promptbook/remote-client`
  */
-export type PromptbookServer_Identification<TCustomOptions> = PromptbookServer_ApplicationIdentification<TCustomOptions> | PromptbookServer_AnonymousIdentification;
+export type Identification<TCustomOptions> = ApplicationModeIdentification<TCustomOptions> | AnonymousModeIdentification;
 /**
  * Application mode is situation when you run known and well-defined books with your own api keys
  *
  * @public exported from `@promptbook/remote-server`
  * @public exported from `@promptbook/remote-client`
  */
-export type PromptbookServer_ApplicationIdentification<TCustomOptions> = ApplicationRemoteServerClientOptions<TCustomOptions> & {
+export type ApplicationModeIdentification<TCustomOptions> = ApplicationRemoteServerClientOptions<TCustomOptions> & {
     /**
      * Application mode
      */
@@ -29,7 +29,7 @@ export type PromptbookServer_ApplicationIdentification<TCustomOptions> = Applica
  * @public exported from `@promptbook/remote-server`
  * @public exported from `@promptbook/remote-client`
  */
-export type PromptbookServer_AnonymousIdentification = {
+export type AnonymousModeIdentification = {
     /**
      * Anonymous mode
      */
@@ -37,7 +37,8 @@ export type PromptbookServer_AnonymousIdentification = {
     /**
      * Identifier of the end user
      *
-     * Note: this is passed to the certain model providers to identify misuse
+     * Note: This can be either some id or email or any other identifier
+     * Note: In anonymous mode, this is passed to the certain model providers to identify misuse
      * Note: In anonymous mode, there is no need to identify yourself, nor does it change the actual configuration of LLM Tools (unlike in application mode)
      */
     readonly userId?: string_user_id;

package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Request.d.ts

@@ -1,4 +1,4 @@
-import type { PromptbookServer_Identification } from '../_subtypes/PromptbookServer_Identification';
+import type { Identification } from '../_subtypes/Identification';
 /**
  * List models available in the server
  *
@@ -10,7 +10,7 @@ export type PromptbookServer_ListModels_Request<TCustomOptions> = {
     /**
      * Identifier of the end user or application
      */
-    readonly identification: PromptbookServer_Identification<TCustomOptions>;
+    readonly identification: Identification<TCustomOptions>;
 };
 /**
  * TODO: [🧠] Listing models inanonymous mode does not make sence - keeping only to preserve consistency

package/esm/typings/src/remote-server/socket-types/prepare/PromptbookServer_PreparePipeline_Request.d.ts

@@ -1,5 +1,5 @@
 import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
-import type { PromptbookServer_Identification } from '../_subtypes/PromptbookServer_Identification';
+import type { Identification } from '../_subtypes/Identification';
 /**
  * This is a request from client to server to prepare a pipeline
  *
@@ -9,7 +9,7 @@ export type PromptbookServer_PreparePipeline_Request<TCustomOptions> = {
     /**
      * Identifier of the end user or application
      */
-    readonly identification: PromptbookServer_Identification<TCustomOptions>;
+    readonly identification: Identification<TCustomOptions>;
     /**
      * The Pipeline to prepare
      */

package/esm/typings/src/remote-server/socket-types/prompt/PromptbookServer_Prompt_Request.d.ts

@@ -1,5 +1,5 @@
 import type { Prompt } from '../../../types/Prompt';
-import type { PromptbookServer_Identification } from '../_subtypes/PromptbookServer_Identification';
+import type { Identification } from '../_subtypes/Identification';
 /**
  * This is a request from client to server to execute a prompt
  *
@@ -9,7 +9,7 @@ export type PromptbookServer_Prompt_Request<TCustomOptions> = {
     /**
      * Identifier of the end user or application
      */
-    readonly identification: PromptbookServer_Identification<TCustomOptions>;
+    readonly identification: Identification<TCustomOptions>;
     /**
      * The Prompt to execute
      */

package/esm/typings/src/remote-server/startRemoteServer.d.ts

@@ -1,4 +1,4 @@
-import type { IDestroyable } from 'destroyable';
+import type { RemoteServer } from './RemoteServer';
 import type { RemoteServerOptions } from './types/RemoteServerOptions';
 /**
  * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
@@ -9,7 +9,7 @@ import type { RemoteServerOptions } from './types/RemoteServerOptions';
  * @see https://github.com/webgptorg/promptbook#remote-server
  * @public exported from `@promptbook/remote-server`
  */
-export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): IDestroyable;
+export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): RemoteServer;
 /**
  * TODO: !! Add CORS and security - probbably via `helmet`
  * TODO: [👩🏾‍🤝‍🧑🏾] Allow to pass custom fetch function here - PromptbookFetch