@promptbook/types 0.89.0-15 → 0.89.0-17

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';
@@ -28,6 +26,7 @@ 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 { REMOTE_SERVER_URLS } from '../config';
 import { DEFAULT_REMOTE_SERVER_URL } from '../config';
 import { DEFAULT_CSV_SETTINGS } from '../config';
 import { DEFAULT_IS_VERBOSE } from '../config';
@@ -116,6 +115,8 @@ 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';
@@ -145,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 };
@@ -165,6 +164,7 @@ export { DEFAULT_SCRAPE_CACHE_DIRNAME };
 export { CLI_APP_ID };
 export { PLAYGROUND_APP_ID };
 export { DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME };
+export { REMOTE_SERVER_URLS };
 export { DEFAULT_REMOTE_SERVER_URL };
 export { DEFAULT_CSV_SETTINGS };
 export { DEFAULT_IS_VERBOSE };
@@ -253,6 +253,8 @@ export { isPipelinePrepared };
 export { preparePipeline };
 export { prepareTasks };
 export { unpreparePipeline };
+export { identificationToPromptbookToken };
+export { promptbookTokenToIdentification };
 export { _BoilerplateScraperMetadataRegistration };
 export { prepareKnowledgePieces };
 export { $scrapersMetadataRegister };

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

@@ -190,6 +190,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';
@@ -233,6 +234,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';
@@ -477,6 +479,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 };
@@ -520,6 +523,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/$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/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
  *
@@ -238,11 +228,17 @@ export declare const MOMENT_ARG_THRESHOLDS: {
     readonly ss: 3;
 };
 /**
- * @@@
+ * Available remote servers for the Promptbook
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const REMOTE_SERVER_URLS: Array<string_promptbook_server_url>;
+/**
+ * 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/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/assertsError.d.ts

@@ -1,9 +1,10 @@
 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 !!!@@@
- * @returns !!!@@@
+ * @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
  */

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

@@ -5,7 +5,14 @@ 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,6 +36,8 @@ type ProvideLlmToolsForWizzardOrCliOptions = Pick<CacheLlmToolsOptions, 'isCache
     readonly appId: string_app_id;
     /**
      *
+     *
+     * Note: When login prompt fails, `process.exit(1)` is called
      */
     loginPrompt(): Promisable<Identification<really_any>>;
 });

package/esm/typings/src/remote-server/socket-types/_subtypes/identificationToPromptbookToken.d.ts

@@ -0,0 +1,11 @@
+import type { string_promptbook_token } from '../../../types/typeAliases';
+import type { really_unknown } from '../../../utils/organization/really_unknown';
+import type { ApplicationModeIdentification } from './Identification';
+/**
+ * Convert identification to Promptbook token
+ *
+ * @param identification
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function identificationToPromptbookToken(identification: ApplicationModeIdentification<really_unknown>): string_promptbook_token;

package/esm/typings/src/remote-server/socket-types/_subtypes/promptbookTokenToIdentification.d.ts

@@ -0,0 +1,10 @@
+import type { string_promptbook_token } from '../../../types/typeAliases';
+import type { ApplicationModeIdentification } from './Identification';
+/**
+ * Convert Promptbook token to identification
+ *
+ * @param promptbookToken
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function promptbookTokenToIdentification(promptbookToken: string_promptbook_token): ApplicationModeIdentification<undefined>;

package/esm/typings/src/storage/env-storage/$EnvStorage.d.ts

@@ -1,6 +1,6 @@
 import type { PromptbookStorage } from '../_common/PromptbookStorage';
 /**
- * Stores data in .env variables (Remove !!! nonce 1)
+ * Stores data in .env variables
  *
  * Note: `$` is used to indicate that this function is not a pure function - it uses filesystem to access `.env` file and also writes to `process.env`
  *
@@ -35,3 +35,6 @@ export declare class $EnvStorage<TItem> implements PromptbookStorage<TItem> {
      */
     removeItem(key: string): void;
 }
+/**
+ * TODO: Write file more securely - ensure that there can be no accidental overwriting of existing variables and other content
+ */

package/esm/typings/src/types/typeAliases.d.ts

@@ -325,6 +325,12 @@ export type string_css_selector = string;
  * For example `"https://collboard.com/9SeSQTupmQHwuSrLi"`
  */
 export type string_url = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://s1.ptbk.io/promptbook"`
+ */
+export type string_promptbook_server_url = string;
 /**
  * Semantic helper
  *
@@ -570,6 +576,12 @@ export type string_postprocessing_function_name = string;
 export type id = string | number;
 export type task_id = string;
 export type string_token = string;
+/**
+ * Semantic helper
+ *
+ * Made by `identificationToPromptbookToken` exported from `@promptbook/core`
+ */
+export type string_promptbook_token = string_token;
 export type string_license_token = string_token;
 export type string_password = string;
 export type string_ssh_key = string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.89.0-15",
+    "version": "0.89.0-17",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -49,6 +49,6 @@
     },
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.89.0-15"
+        "@promptbook/core": "0.89.0-17"
     }
 }