@promptbook/openai 0.89.0-8 → 0.89.0

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

@@ -106,22 +106,23 @@ 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 { paths } from '../remote-server/openapi-types';
+import type { webhooks } from '../remote-server/openapi-types';
+import type { components } from '../remote-server/openapi-types';
+import type { $defs } from '../remote-server/openapi-types';
+import type { operations } from '../remote-server/openapi-types';
 import type { RemoteServer } from '../remote-server/RemoteServer';
-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';
 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 { ApplicationRemoteServerOptionsLoginResponse } 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';
@@ -194,6 +195,7 @@ import type { string_css_property } from '../types/typeAliases';
 import type { string_css_value } from '../types/typeAliases';
 import type { string_css_selector } from '../types/typeAliases';
 import type { string_url } from '../types/typeAliases';
+import type { string_promptbook_server_url } from '../types/typeAliases';
 import type { string_base_url } from '../types/typeAliases';
 import type { string_pipeline_root_url } from '../types/typeAliases';
 import type { string_pipeline_url } from '../types/typeAliases';
@@ -208,6 +210,7 @@ import type { string_uri_part } from '../types/typeAliases';
 import type { string_hostname } from '../types/typeAliases';
 import type { string_host } from '../types/typeAliases';
 import type { string_protocol } from '../types/typeAliases';
+import type { string_ip_address } from '../types/typeAliases';
 import type { string_email } from '../types/typeAliases';
 import type { string_emails } from '../types/typeAliases';
 import type { string_uuid } from '../types/typeAliases';
@@ -226,6 +229,7 @@ import type { string_dirname } from '../types/typeAliases';
 import type { string_person_fullname } from '../types/typeAliases';
 import type { string_person_profile } from '../types/typeAliases';
 import type { string_license } from '../types/typeAliases';
+import type { string_legal_entity } from '../types/typeAliases';
 import type { string_attribute } from '../types/typeAliases';
 import type { string_attribute_value_scope } from '../types/typeAliases';
 import type { string_color } from '../types/typeAliases';
@@ -237,6 +241,7 @@ import type { string_postprocessing_function_name } from '../types/typeAliases';
 import type { id } from '../types/typeAliases';
 import type { task_id } from '../types/typeAliases';
 import type { string_token } from '../types/typeAliases';
+import type { string_promptbook_token } from '../types/typeAliases';
 import type { string_license_token } from '../types/typeAliases';
 import type { string_password } from '../types/typeAliases';
 import type { string_ssh_key } from '../types/typeAliases';
@@ -397,22 +402,23 @@ export type { ScriptTaskJson };
 export type { SimpleTaskJson };
 export type { TaskJson };
 export type { PipelineString };
+export type { PrepareAndScrapeOptions };
 export type { paths };
 export type { webhooks };
 export type { components };
 export type { $defs };
 export type { operations };
-export type { PrepareAndScrapeOptions };
 export type { RemoteServer };
-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 };
 export type { AnonymousRemoteServerOptions };
 export type { ApplicationRemoteServerOptions };
 export type { ApplicationRemoteServerClientOptions };
-export type { ApplicationRemoteServerOptionsLoginResponse };
+export type { LoginRequest };
+export type { LoginResponse };
 export type { Converter };
 export type { ScraperAndConverterMetadata };
 export type { ScraperConstructor };
@@ -485,6 +491,7 @@ export type { string_css_property };
 export type { string_css_value };
 export type { string_css_selector };
 export type { string_url };
+export type { string_promptbook_server_url };
 export type { string_base_url };
 export type { string_pipeline_root_url };
 export type { string_pipeline_url };
@@ -499,6 +506,7 @@ export type { string_uri_part };
 export type { string_hostname };
 export type { string_host };
 export type { string_protocol };
+export type { string_ip_address };
 export type { string_email };
 export type { string_emails };
 export type { string_uuid };
@@ -517,6 +525,7 @@ export type { string_dirname };
 export type { string_person_fullname };
 export type { string_person_profile };
 export type { string_license };
+export type { string_legal_entity };
 export type { string_attribute };
 export type { string_attribute_value_scope };
 export type { string_color };
@@ -528,6 +537,7 @@ export type { string_postprocessing_function_name };
 export type { id };
 export type { task_id };
 export type { string_token };
+export type { string_promptbook_token };
 export type { string_license_token };
 export type { string_password };
 export type { string_ssh_key };

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

@@ -5,7 +5,9 @@ import { renderPromptbookMermaid } from '../conversion/prettify/renderPipelineMe
 import { deserializeError } from '../errors/utils/deserializeError';
 import { serializeError } from '../errors/utils/serializeError';
 import { forEachAsync } from '../execution/utils/forEachAsync';
+import { isValidCsvString } from '../formats/csv/utils/isValidCsvString';
 import { isValidJsonString } from '../formats/json/utils/isValidJsonString';
+import { isValidXmlString } from '../formats/xml/utils/isValidXmlString';
 import { prompt } from '../pipeline/prompt-notation';
 import { promptTemplate } from '../pipeline/prompt-notation';
 import { $getCurrentDate } from '../utils/$getCurrentDate';
@@ -87,7 +89,9 @@ export { renderPromptbookMermaid };
 export { deserializeError };
 export { serializeError };
 export { forEachAsync };
+export { isValidCsvString };
 export { isValidJsonString };
+export { isValidXmlString };
 export { prompt };
 export { promptTemplate };
 export { $getCurrentDate };

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

@@ -8,7 +8,6 @@ import type { Command as Program } from 'commander';
  */
 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/$provideLlmToolsForCli.d.ts

@@ -1,15 +1,28 @@
+import type { LlmExecutionToolsWithTotalUsage } from '../../llm-providers/_common/utils/count-total-usage/LlmExecutionToolsWithTotalUsage';
 import type { CacheLlmToolsOptions } from '../../llm-providers/_common/utils/cache/CacheLlmToolsOptions';
-import type { string_url } from '../../types/typeAliases';
+import type { string_promptbook_server_url } from '../../types/typeAliases';
 type ProvideLlmToolsForCliOptions = Pick<CacheLlmToolsOptions, 'isCacheReloaded'> & {
+    /**
+     * If true, user will be always prompted for login
+     *
+     * Note: This is used in `ptbk login` command
+     */
+    isLoginloaded?: true;
+    /**
+     * CLI options
+     */
     cliOptions: {
         verbose: boolean;
         interactive: boolean;
         provider: 'BYOK' | 'BRING_YOUR_OWN_KEYS' | 'REMOTE_SERVER' | 'RS' | string;
-        remoteServerUrl: string_url;
+        remoteServerUrl: string_promptbook_server_url;
     };
 };
 /**
  * @private utility of CLI
  */
-export declare function $provideLlmToolsForCli(options: ProvideLlmToolsForCliOptions): Promise<import("../../_packages/types.index").LlmExecutionToolsWithTotalUsage>;
+export declare function $provideLlmToolsForCli(options: ProvideLlmToolsForCliOptions): Promise<{
+    strategy: 'BRING_YOUR_OWN_KEYS' | 'REMOTE_SERVER';
+    llm: 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

@@ -3,7 +3,7 @@ import type { IntermediateFilesStrategy } from './types/IntermediateFilesStrateg
 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';
+import type { string_promptbook_server_url } from './types/typeAliases';
 /**
  * Warning message for the generated sections and files files
  *
@@ -38,22 +38,6 @@ export declare const ADMIN_GITHUB_NAME: string_name;
  * @public exported from `@promptbook/core`
  */
 export declare const CLAIM = "It's time for a paradigm shift. The future of software in plain English, French or Latin";
-/**
- * Logo for the light theme
- *
- * TODO: [🗽] Unite branding and make single place for it
- *
- * @public exported from `@promptbook/core`
- */
-export declare const LOGO_LIGHT_SRC: string_url_image;
-/**
- * Logo for the dark theme
- *
- * TODO: [🗽] Unite branding and make single place for it
- *
- * @public exported from `@promptbook/core`
- */
-export declare const LOGO_DARK_SRC: string_url_image;
 /**
  * When the title is not provided, the default title is used
  *
@@ -90,6 +74,12 @@ export declare const DEFAULT_MAX_FILE_SIZE: number;
  * @private within the repository
  */
 export declare const GENERATOR_WARNING_BY_PROMPTBOOK_CLI = "\u26A0\uFE0F WARNING: This code has been generated by `@promptbook/cli` so that any manual changes will be overwritten";
+/**
+ * Warning message for the automatically generated sections of `.env` files
+ *
+ * @private within the repository
+ */
+export declare const GENERATOR_WARNING_IN_ENV = "Note: Added by Promptbook";
 /**
  * The maximum number of iterations for a loops
  *
@@ -115,6 +105,7 @@ export declare const VALUE_STRINGS: {
     readonly infinity: "(infinity; ∞)";
     readonly negativeInfinity: "(negative infinity; -∞)";
     readonly unserializable: "(unserializable value)";
+    readonly circular: "(circular JSON)";
 };
 /**
  * Small number limit
@@ -237,11 +228,11 @@ export declare const MOMENT_ARG_THRESHOLDS: {
     readonly ss: 3;
 };
 /**
- * @@@
+ * Default remote server URL for the Promptbook
  *
  * @public exported from `@promptbook/core`
  */
-export declare const DEFAULT_REMOTE_SERVER_URL = "https://api.pavolhejny.com/promptbook";
+export declare const DEFAULT_REMOTE_SERVER_URL: string_promptbook_server_url;
 /**
  * @@@
  *

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

@@ -13,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
  *
@@ -34,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
@@ -50,7 +55,6 @@ export declare const COMMON_JAVASCRIPT_ERRORS: {
     readonly TypeError: TypeErrorConstructor;
     readonly URIError: URIErrorConstructor;
     readonly AggregateError: AggregateErrorConstructor;
-    readonly AuthenticationError: typeof AuthenticationError;
 };
 /**
  * Index of all errors
@@ -66,7 +70,6 @@ export declare const ALL_ERRORS: {
     readonly TypeError: TypeErrorConstructor;
     readonly URIError: URIErrorConstructor;
     readonly AggregateError: AggregateErrorConstructor;
-    readonly AuthenticationError: typeof AuthenticationError;
     readonly AbstractFormatError: typeof AbstractFormatError;
     readonly CsvFormatError: typeof CsvFormatError;
     readonly CollectionError: typeof CollectionError;
@@ -81,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/PipelineExecutionError.d.ts

@@ -10,5 +10,5 @@ export declare class PipelineExecutionError extends Error {
     constructor(message: string);
 }
 /**
- * TODO: !!!!!! Add id to all errors
+ * TODO: [🧠][🌂] Add id to all errors
  */

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,11 @@
+import type { really_unknown } from '../utils/organization/really_unknown';
+/**
+ * Helper used in catch blocks to assert that the error is an instance of `Error`
+ *
+ * @param whatWasThrown Any object that was thrown
+ * @returns Nothing if the error is an instance of `Error`
+ * @throws `WrappedError` or `UnexpectedError` if the error is not standard
+ *
+ * @private within the repository
+ */
+export declare function assertsError(whatWasThrown: really_unknown): asserts whatWasThrown is Error;

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/formats/csv/utils/isValidCsvString.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Function to check if a string is valid CSV
+ *
+ * @param value The string to check
+ * @returns True if the string is a valid CSV string, false otherwise
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isValidCsvString(value: string): boolean;

package/esm/typings/src/formats/csv/utils/isValidCsvString.test.d.ts

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

package/esm/typings/src/formats/json/utils/isValidJsonString.d.ts

@@ -1,6 +1,9 @@
 /**
  * Function isValidJsonString will tell you if the string is valid JSON or not
  *
+ * @param value The string to check
+ * @returns True if the string is a valid JSON string, false otherwise
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function isValidJsonString(value: string): boolean;

package/esm/typings/src/formats/xml/utils/isValidXmlString.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Function to check if a string is valid XML
+ *
+ * @param value
+ * @returns True if the string is a valid XML string, false otherwise
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isValidXmlString(value: string): boolean;

package/esm/typings/src/formats/xml/utils/isValidXmlString.test.d.ts

@@ -0,0 +1 @@
+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,18 @@
 import { Promisable } from 'type-fest';
-import type { PromptbookServer_Identification } from '../../../remote-server/socket-types/_subtypes/PromptbookServer_Identification';
-import type { really_any } from '../../../utils/organization/really_any';
+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'> & ({
+type ProvideLlmToolsForWizzardOrCliOptions = {
+    /**
+     * If true, user will be always prompted for login
+     *
+     * Note: This is used in `ptbk login` command
+     */
+    isLoginloaded?: true;
+} & Pick<CacheLlmToolsOptions, 'isCacheReloaded'> & ({
     /**
      * Use local keys and execute LLMs directly
      */
@@ -29,12 +36,16 @@ type ProvideLlmToolsForWizzardOrCliOptions = Pick<CacheLlmToolsOptions, 'isCache
     readonly appId: string_app_id;
     /**
      *
+     *
+     * Note: When login prompt fails, `process.exit(1)` is called
      */
-    loginPrompt(): Promisable<PromptbookServer_Identification<really_any>>;
+    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?: ProvideLlmToolsForWizzardOrCliOptions): Promise<LlmExecutionToolsWithTotalUsage>;

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`