@promptbook/markdown-utils 0.89.0-3 → 0.89.0-30

package/esm/typings/servers.d.ts

@@ -0,0 +1,40 @@
+import type { string_legal_entity } from './src/types/typeAliases';
+import type { string_promptbook_server_url } from './src/types/typeAliases';
+import type { string_title } from './src/types/typeAliases';
+/**
+ * Open Promptbook server usable for public
+ */
+type ServerConfiguration = {
+    /**
+     * Basic name of the server
+     */
+    title: string_title;
+    /**
+     * Who is the owner of the server
+     */
+    owner: string_legal_entity;
+    /**
+     * Is the server open for public and anonymous usage
+     */
+    isAnonymousModeAllowed: boolean;
+    /**
+     * Description of the server, link to registration, user agreement, privacy policy, etc.
+     */
+    description: string;
+    /**
+     * URL of the server
+     *
+     Note: lising more for loadbalancing
+     */
+    urls: Array<string_promptbook_server_url>;
+};
+/**
+ * Available remote servers for the Promptbook
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const REMOTE_SERVER_URLS: Array<ServerConfiguration>;
+export {};
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -8,8 +8,6 @@ import { NAME } from '../config';
 import { ADMIN_EMAIL } from '../config';
 import { ADMIN_GITHUB_NAME } from '../config';
 import { CLAIM } from '../config';
-import { LOGO_LIGHT_SRC } from '../config';
-import { LOGO_DARK_SRC } from '../config';
 import { DEFAULT_BOOK_TITLE } from '../config';
 import { DEFAULT_TASK_TITLE } from '../config';
 import { DEFAULT_PROMPT_TASK_TITLE } from '../config';
@@ -25,9 +23,10 @@ import { DEFAULT_BOOKS_DIRNAME } from '../config';
 import { DEFAULT_DOWNLOAD_CACHE_DIRNAME } from '../config';
 import { DEFAULT_EXECUTION_CACHE_DIRNAME } from '../config';
 import { DEFAULT_SCRAPE_CACHE_DIRNAME } from '../config';
+import { CLI_APP_ID } from '../config';
+import { PLAYGROUND_APP_ID } from '../config';
 import { DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME } from '../config';
-import { DEFAULT_REMOTE_URL } from '../config';
-import { DEFAULT_REMOTE_URL_PATH } from '../config';
+import { DEFAULT_REMOTE_SERVER_URL } from '../config';
 import { DEFAULT_CSV_SETTINGS } from '../config';
 import { DEFAULT_IS_VERBOSE } from '../config';
 import { SET_IS_VERBOSE } from '../config';
@@ -46,6 +45,7 @@ import type { CallbackInterfaceToolsOptions } from '../dialogs/callback/Callback
 import { BoilerplateError } from '../errors/0-BoilerplateError';
 import { PROMPTBOOK_ERRORS } from '../errors/0-index';
 import { AbstractFormatError } from '../errors/AbstractFormatError';
+import { AuthenticationError } from '../errors/AuthenticationError';
 import { CollectionError } from '../errors/CollectionError';
 import { EnvironmentMismatchError } from '../errors/EnvironmentMismatchError';
 import { ExpectError } from '../errors/ExpectError';
@@ -58,7 +58,9 @@ import { ParseError } from '../errors/ParseError';
 import { PipelineExecutionError } from '../errors/PipelineExecutionError';
 import { PipelineLogicError } from '../errors/PipelineLogicError';
 import { PipelineUrlError } from '../errors/PipelineUrlError';
+import { PromptbookFetchError } from '../errors/PromptbookFetchError';
 import { UnexpectedError } from '../errors/UnexpectedError';
+import { WrappedError } from '../errors/WrappedError';
 import { createPipelineExecutor } from '../execution/createPipelineExecutor/00-createPipelineExecutor';
 import { embeddingVectorToString } from '../execution/embeddingVectorToString';
 import { executionReportJsonToString } from '../execution/execution-report/executionReportJsonToString';
@@ -112,11 +114,14 @@ import { isPipelinePrepared } from '../prepare/isPipelinePrepared';
 import { preparePipeline } from '../prepare/preparePipeline';
 import { prepareTasks } from '../prepare/prepareTasks';
 import { unpreparePipeline } from '../prepare/unpreparePipeline';
+import { identificationToPromptbookToken } from '../remote-server/socket-types/_subtypes/identificationToPromptbookToken';
+import { promptbookTokenToIdentification } from '../remote-server/socket-types/_subtypes/promptbookTokenToIdentification';
 import { _BoilerplateScraperMetadataRegistration } from '../scrapers/_boilerplate/register-metadata';
 import { prepareKnowledgePieces } from '../scrapers/_common/prepareKnowledgePieces';
 import { $scrapersMetadataRegister } from '../scrapers/_common/register/$scrapersMetadataRegister';
 import { $scrapersRegister } from '../scrapers/_common/register/$scrapersRegister';
 import { makeKnowledgeSourceHandler } from '../scrapers/_common/utils/makeKnowledgeSourceHandler';
+import { promptbookFetch } from '../scrapers/_common/utils/promptbookFetch';
 import { _LegacyDocumentScraperMetadataRegistration } from '../scrapers/document-legacy/register-metadata';
 import { _DocumentScraperMetadataRegistration } from '../scrapers/document/register-metadata';
 import { _MarkdownScraperMetadataRegistration } from '../scrapers/markdown/register-metadata';
@@ -130,6 +135,7 @@ import { MODEL_VARIANTS } from '../types/ModelVariant';
 import { NonTaskSectionTypes } from '../types/SectionType';
 import { SectionTypes } from '../types/SectionType';
 import { TaskTypes } from '../types/TaskType';
+import { REMOTE_SERVER_URLS } from '../../servers';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { collectionToJson };
 export { createCollectionFromJson };
@@ -140,8 +146,6 @@ export { NAME };
 export { ADMIN_EMAIL };
 export { ADMIN_GITHUB_NAME };
 export { CLAIM };
-export { LOGO_LIGHT_SRC };
-export { LOGO_DARK_SRC };
 export { DEFAULT_BOOK_TITLE };
 export { DEFAULT_TASK_TITLE };
 export { DEFAULT_PROMPT_TASK_TITLE };
@@ -157,9 +161,10 @@ export { DEFAULT_BOOKS_DIRNAME };
 export { DEFAULT_DOWNLOAD_CACHE_DIRNAME };
 export { DEFAULT_EXECUTION_CACHE_DIRNAME };
 export { DEFAULT_SCRAPE_CACHE_DIRNAME };
+export { CLI_APP_ID };
+export { PLAYGROUND_APP_ID };
 export { DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME };
-export { DEFAULT_REMOTE_URL };
-export { DEFAULT_REMOTE_URL_PATH };
+export { DEFAULT_REMOTE_SERVER_URL };
 export { DEFAULT_CSV_SETTINGS };
 export { DEFAULT_IS_VERBOSE };
 export { SET_IS_VERBOSE };
@@ -178,6 +183,7 @@ export type { CallbackInterfaceToolsOptions };
 export { BoilerplateError };
 export { PROMPTBOOK_ERRORS };
 export { AbstractFormatError };
+export { AuthenticationError };
 export { CollectionError };
 export { EnvironmentMismatchError };
 export { ExpectError };
@@ -190,7 +196,9 @@ export { ParseError };
 export { PipelineExecutionError };
 export { PipelineLogicError };
 export { PipelineUrlError };
+export { PromptbookFetchError };
 export { UnexpectedError };
+export { WrappedError };
 export { createPipelineExecutor };
 export { embeddingVectorToString };
 export { executionReportJsonToString };
@@ -244,11 +252,14 @@ export { isPipelinePrepared };
 export { preparePipeline };
 export { prepareTasks };
 export { unpreparePipeline };
+export { identificationToPromptbookToken };
+export { promptbookTokenToIdentification };
 export { _BoilerplateScraperMetadataRegistration };
 export { prepareKnowledgePieces };
 export { $scrapersMetadataRegister };
 export { $scrapersRegister };
 export { makeKnowledgeSourceHandler };
+export { promptbookFetch };
 export { _LegacyDocumentScraperMetadataRegistration };
 export { _DocumentScraperMetadataRegistration };
 export { _MarkdownScraperMetadataRegistration };
@@ -262,3 +273,4 @@ export { MODEL_VARIANTS };
 export { NonTaskSectionTypes };
 export { SectionTypes };
 export { TaskTypes };
+export { REMOTE_SERVER_URLS };

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

@@ -106,20 +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 { 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 { 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 { 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';
@@ -192,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';
@@ -224,6 +228,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';
@@ -235,6 +240,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';
@@ -395,20 +401,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 { 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 };
@@ -481,6 +490,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 };
@@ -513,6 +523,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 };
@@ -524,6 +535,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/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/$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,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_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_promptbook_server_url;
+    };
+};
+/**
+ * @private utility of CLI
+ */
+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

@@ -1,8 +1,9 @@
 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';
+import type { string_promptbook_server_url } from './types/typeAliases';
 /**
  * Warning message for the generated sections and files files
  *
@@ -37,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
  *
@@ -89,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
  *
@@ -114,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
@@ -208,6 +200,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`
  *
@@ -224,17 +228,11 @@ export declare const MOMENT_ARG_THRESHOLDS: {
     readonly ss: 3;
 };
 /**
- * @@@
- *
- * @public exported from `@promptbook/core`
- */
-export declare const DEFAULT_REMOTE_URL = "https://api.pavolhejny.com/";
-/**
- * @@@
+ * Default remote server URL for the Promptbook
  *
  * @public exported from `@promptbook/core`
  */
-export declare const DEFAULT_REMOTE_URL_PATH = "/promptbook/socket.io";
+export declare const DEFAULT_REMOTE_SERVER_URL: string_promptbook_server_url;
 /**
  * @@@
  *
@@ -281,5 +279,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/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/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>;