@promptbook/openai 0.89.0-1 → 0.89.0-13

package/esm/typings/src/_packages/remote-client.index.d.ts

@@ -2,17 +2,15 @@ import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { compilePipelineOnRemoteServer } from '../conversion/compilePipelineOnRemoteServer';
 import { RemoteLlmExecutionTools } from '../llm-providers/remote/RemoteLlmExecutionTools';
 import { preparePipelineOnRemoteServer } from '../prepare/preparePipelineOnRemoteServer';
-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 { 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';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { compilePipelineOnRemoteServer };
 export { RemoteLlmExecutionTools };
 export { preparePipelineOnRemoteServer };
-export type { PromptbookServer_Identification };
-export type { PromptbookServer_ApplicationIdentification };
-export type { PromptbookServer_AnonymousIdentification };
+export type { Identification };
+export type { ApplicationModeIdentification };
+export type { AnonymousModeIdentification };
 export type { RemoteClientOptions };
-export type { RemoteServerOptions };

package/esm/typings/src/_packages/remote-server.index.d.ts

@@ -1,12 +1,12 @@
 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
-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 { 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 { startRemoteServer } from '../remote-server/startRemoteServer';
 import type { RemoteServerOptions } from '../remote-server/types/RemoteServerOptions';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
-export type { PromptbookServer_Identification };
-export type { PromptbookServer_ApplicationIdentification };
-export type { PromptbookServer_AnonymousIdentification };
+export type { Identification };
+export type { ApplicationModeIdentification };
+export type { AnonymousModeIdentification };
 export { startRemoteServer };
 export type { RemoteServerOptions };

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';
@@ -106,20 +106,18 @@ import type { ScriptTaskJson } from '../pipeline/PipelineJson/ScriptTaskJson';
 import type { SimpleTaskJson } from '../pipeline/PipelineJson/SimpleTaskJson';
 import type { TaskJson } from '../pipeline/PipelineJson/TaskJson';
 import type { PipelineString } from '../pipeline/PipelineString';
-import type { paths } from '../playground/brjapp-api-schema';
-import type { webhooks } from '../playground/brjapp-api-schema';
-import type { components } from '../playground/brjapp-api-schema';
-import type { $defs } from '../playground/brjapp-api-schema';
-import type { operations } from '../playground/brjapp-api-schema';
 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';
@@ -179,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';
@@ -342,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 };
@@ -394,20 +393,18 @@ export type { ScriptTaskJson };
 export type { SimpleTaskJson };
 export type { TaskJson };
 export type { PipelineString };
-export type { paths };
-export type { webhooks };
-export type { components };
-export type { $defs };
-export type { operations };
 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 };
@@ -467,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/cli/test/ptbk.d.ts

@@ -2,4 +2,4 @@
 /**
  * Note: [🔺] Purpose of this file is to test and use the current CLI in development environment
  */
-import '../../_packages/cli.index.ts';
+import '../../_packages/cli.index';

package/esm/typings/src/commands/EXPECT/expectCommandParser.d.ts

@@ -1,6 +1,8 @@
 import type { PipelineTaskCommandParser } from '../_common/types/CommandParser';
 import type { ExpectCommand } from './ExpectCommand';
 /**
+import { WrappedError } from '../../errors/WrappedError';
+import { assertsError } from '../../errors/assertsError';
  * Parses the expect command
  *
  * @see `documentationUrl` for more details

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';
@@ -114,6 +115,7 @@ export declare const VALUE_STRINGS: {
     readonly infinity: "(infinity; ∞)";
     readonly negativeInfinity: "(negative infinity; -∞)";
     readonly unserializable: "(unserializable value)";
+    readonly circular: "(circular JSON)";
 };
 /**
  * Small number limit
@@ -208,6 +210,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 +242,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 +289,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,7 +13,9 @@ import { ParseError } from './ParseError';
 import { PipelineExecutionError } from './PipelineExecutionError';
 import { PipelineLogicError } from './PipelineLogicError';
 import { PipelineUrlError } from './PipelineUrlError';
+import { PromptbookFetchError } from './PromptbookFetchError';
 import { UnexpectedError } from './UnexpectedError';
+import { WrappedError } from './WrappedError';
 /**
  * Index of all custom errors
  *
@@ -33,7 +36,10 @@ export declare const PROMPTBOOK_ERRORS: {
     readonly PipelineExecutionError: typeof PipelineExecutionError;
     readonly PipelineLogicError: typeof PipelineLogicError;
     readonly PipelineUrlError: typeof PipelineUrlError;
+    readonly AuthenticationError: typeof AuthenticationError;
+    readonly PromptbookFetchError: typeof PromptbookFetchError;
     readonly UnexpectedError: typeof UnexpectedError;
+    readonly WrappedError: typeof WrappedError;
 };
 /**
  * Index of all javascript errors
@@ -78,7 +84,10 @@ export declare const ALL_ERRORS: {
     readonly PipelineExecutionError: typeof PipelineExecutionError;
     readonly PipelineLogicError: typeof PipelineLogicError;
     readonly PipelineUrlError: typeof PipelineUrlError;
+    readonly AuthenticationError: typeof AuthenticationError;
+    readonly PromptbookFetchError: typeof PromptbookFetchError;
     readonly UnexpectedError: typeof UnexpectedError;
+    readonly WrappedError: typeof WrappedError;
 };
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name

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/errors/WrappedError.d.ts

@@ -0,0 +1,10 @@
+import type { really_any } from '../utils/organization/really_any';
+/**
+ * This error type indicates that somewhere in the code non-Error object was thrown and it was wrapped into the `WrappedError`
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class WrappedError extends Error {
+    readonly name = "WrappedError";
+    constructor(whatWasThrown: really_any);
+}

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

@@ -0,0 +1,10 @@
+import type { really_unknown } from '../utils/organization/really_unknown';
+/**
+ * !!!@@@
+ *
+ * @param whatWasThrown !!!@@@
+ * @returns !!!@@@
+ *
+ * @private within the repository
+ */
+export declare function assertsError(whatWasThrown: really_unknown): asserts whatWasThrown is Error;

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/PromptbookFetch.d.ts

@@ -7,6 +7,6 @@ import type { string_url } from '../types/typeAliases';
  *
  * It is used in theese places:
  * - Fetching knowledge sources
- * - Callbacks from remote server ([👩🏾‍🤝‍🧑🏾] Not yet implemented)
+ * - Callbacks from remote server
  */
 export type PromptbookFetch = (url: string_url, init?: RequestInit) => Promise<Response>;

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