@promptbook/remote-client 0.63.0-2 → 0.63.0-4

package/esm/typings/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts

@@ -3,6 +3,8 @@ import type { KnowledgePiecePreparedJson } from '../../../types/PipelineJson/Kno
 import type { string_base64 } from '../../../types/typeAliases';
 /**
  * @@@
+ *
+ * @private still in development [🐝]
  */
 export declare function prepareKnowledgeFromPdf(content: string_base64, options: PrepareOptions): Promise<Array<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>>>;
 /**

package/esm/typings/src/llm-providers/_common/createLlmToolsFromEnv.d.ts

@@ -1,6 +1,8 @@
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 /**
- * @privxxate <- TODO: !!!!!! Warn that not private or exported
+ * Options for `createLlmToolsFromEnv`
+ *
+ * @private internal type for `createLlmToolsFromEnv` and `getLlmToolsForTestingAndScriptsAndPlayground`
  */
 export type CreateLlmToolsFromEnvOptions = {
     /**
@@ -32,6 +34,6 @@ export declare function createLlmToolsFromEnv(options?: CreateLlmToolsFromEnvOpt
  * TODO: [🧠] Which name is better `createLlmToolsFromEnv` or `createLlmToolsFromEnvironment`?
  * TODO: [🧠] Is there some meaningfull way how to test this util
  * TODO: [🧠] Maybe pass env as argument
- * Note: [🟢] This code should never be published outside of `@promptbook/node`
+ * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
  * TODO: [👷‍♂️] @@@ Manual about construction of llmTools
  */

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

@@ -6,6 +6,7 @@ import type { number_usd } from '../../types/typeAliases';
  * Note: Done at 2024-05-25
  *
  * @see https://docs.anthropic.com/en/docs/models-overview
+ * @public exported from `@promptbook/anthropic-claude`
  */
 export declare const ANTHROPIC_CLAUDE_MODELS: Array<AvailableModel & {
     pricing?: {

package/esm/typings/src/llm-providers/mocked/fakeTextToExpectations.d.ts

@@ -6,7 +6,7 @@ import type { Expectations } from '../../types/PipelineJson/Expectations';
  * Note: You can provide postprocessing functions to modify the text before checking the expectations
  *       The result will be the text BEFORE the postprocessing
  *
- * @private internal util for MockedFackedLlmExecutionTools
+ * @private internal utility for MockedFackedLlmExecutionTools
  */
 export declare function $fakeTextToExpectations(expectations: Expectations, postprocessing?: Array<PostprocessingFunction>): Promise<string>;
 /**

package/esm/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts

@@ -12,7 +12,7 @@ import type { string_title } from '../../types/typeAliases';
 /**
  * Multiple LLM Execution Tools is a proxy server that uses multiple execution tools internally and exposes the executor interface externally.
  *
- * @private Internal utility of `joinLlmExecutionTools`
+ * @private internal utility of `joinLlmExecutionTools`
  */
 export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
     /**

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

@@ -8,7 +8,7 @@ import type { Prompt } from '../../types/Prompt';
  * @param resultContent The content of the result (for embedding prompts or failed prompts pass empty string)
  * @param rawResponse The raw response from OpenAI API
  * @throws {PipelineExecutionError} If the usage is not defined in the response from OpenAI
- * @private internal util of `OpenAiExecutionTools`
+ * @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: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion | OpenAI.Embeddings.CreateEmbeddingResponse, 'model' | 'usage'>): PromptResultUsage;

package/esm/typings/src/scripting/javascript/utils/preserve.d.ts

@@ -5,6 +5,7 @@ import type { really_any } from '../../../utils/organization/really_any';
  *
  * @param value any function to preserve
  * @returns nothing
+ * @private internal function of `JavascriptExecutionTools` and `JavascriptEvalExecutionTools`
  */
 export declare function preserve(func: (...params: Array<really_any>) => unknown): void;
 /**

package/esm/typings/src/scripting/javascript/utils/unknownToString.d.ts

@@ -3,6 +3,6 @@ import type { really_unknown } from '../../../utils/organization/really_unknown'
  * Converts anything to string that can be used for debugging and logging
  *
  * @param value String value for logging
- * @private Internal util
+ * @private internal util
  */
 export declare function unknownToString(value: really_unknown): string;

package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts

@@ -5,6 +5,8 @@ import type { ScriptExecutionToolsExecuteOptions } from '../../execution/ScriptE
  * ScriptExecutionTools for Python
  *
  * Warning: This is not implemented yet
+ *
+ * @private still in development
  */
 export declare class PythonExecutionTools implements ScriptExecutionTools {
     private readonly options;

package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts

@@ -5,6 +5,8 @@ import type { ScriptExecutionToolsExecuteOptions } from '../../execution/ScriptE
  * ScriptExecutionTools for TypeScript
  *
  * Warning: This is not implemented yet
+ *
+ * @private still in development
  */
 export declare class TypescriptExecutionTools implements ScriptExecutionTools {
     private readonly options;

package/esm/typings/src/storage/files-storage/FilesStorage.d.ts

@@ -27,5 +27,5 @@ export declare class FilesStorage<TItem> implements PromptbookStorage<TItem> {
 }
 /**
  * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
- * Note: [🟢] This code should never be published outside of `@promptbook/node`
+ * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
  */

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

@@ -5,6 +5,6 @@
  * 2) Undefined represents empty array
  * 3) Array represents itself
  *
- * @private Internal utility type
+ * @private internal type
  */
 export type Arrayable<TItem> = TItem | Array<TItem> | undefined;

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

@@ -1,9 +1,4 @@
-/**
- * @@@
- *
- * @private for `ModelVariant` and `modelCommandParser`
- */
-export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT", "EMBEDDING"];
+import type { TupleToUnion } from 'type-fest';
 /**
  * Model variant describes the very general type of the model
  *
@@ -11,4 +6,10 @@ export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT", "EMBEDDING"
  * - **COMPLETION** - model that takes prompt and writes the rest of the text
  * - **CHAT** - model that takes prompt and previous messages and returns response
  */
-export type ModelVariant = typeof MODEL_VARIANTS[number];
+export type ModelVariant = TupleToUnion<typeof MODEL_VARIANTS>;
+/**
+ * @@@
+ *
+ * @private internal base for `ModelVariant` and `modelCommandParser`
+ */
+export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT", "EMBEDDING"];

package/esm/typings/src/types/PipelineJson/Expectations.d.ts

@@ -1,3 +1,4 @@
+import type { TupleToUnion } from 'type-fest';
 import type { number_integer } from '../typeAliases';
 import type { number_positive } from '../typeAliases';
 /**
@@ -6,6 +7,7 @@ import type { number_positive } from '../typeAliases';
  * For example 5 words, 3 sentences, 2 paragraphs, ...
  *
  * Note: Expectations are performed after all postprocessing steps
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/30
  */
 export type Expectations = Partial<Record<Lowercase<ExpectationUnit>, {
@@ -13,17 +15,21 @@ export type Expectations = Partial<Record<Lowercase<ExpectationUnit>, {
     readonly max?: ExpectationAmount;
 }>>;
 /**
- * Units of text measurement
+ * Unit of text measurement
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/30
  */
-export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "LINES", "PARAGRAPHS", "PAGES"];
+export type ExpectationUnit = TupleToUnion<typeof EXPECTATION_UNITS>;
 /**
- * Unit of text measurement
+ * Units of text measurement
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/30
+ * @private internal base for `ExpectationUnit`
  */
-export type ExpectationUnit = typeof EXPECTATION_UNITS[number];
+export declare const EXPECTATION_UNITS: readonly ["CHARACTERS", "WORDS", "SENTENCES", "LINES", "PARAGRAPHS", "PAGES"];
 /**
  * Amount of text measurement
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/30
  */
 export type ExpectationAmount = number_integer & (number_positive | 0);

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

@@ -1,9 +1,11 @@
 import type { TupleToUnion } from 'type-fest';
-/**
- * Supported script languages
- */
-export declare const SUPPORTED_SCRIPT_LANGUAGES: readonly ["javascript", "typescript", "python"];
 /**
  * Script language
  */
 export type ScriptLanguage = TupleToUnion<typeof SUPPORTED_SCRIPT_LANGUAGES>;
+/**
+ * Supported script languages
+ *
+ * @private internal base for `ScriptLanguage`
+ */
+export declare const SUPPORTED_SCRIPT_LANGUAGES: readonly ["javascript", "typescript", "python"];

package/esm/typings/src/types/execution-report/executionReportJsonToString.d.ts

@@ -10,4 +10,5 @@ export declare function executionReportJsonToString(executionReportJson: Executi
 /**
  * TODO: Add mermaid chart for every report
  * TODO: [🧠] Allow to filter out some parts of the report by options
+ * TODO: [🧠] Should be in generated file GENERATOR_WARNING
  */

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

@@ -1,3 +1,4 @@
+import type { TupleToUnion } from 'type-fest';
 import { RESERVED_PARAMETER_NAMES } from '../config';
 /**
  * Semantic helper
@@ -111,7 +112,7 @@ export type Parameters = Exclude<Record<string_parameter_name, string_parameter_
  *
  * For example `"context"`
  */
-export type string_reserved_parameter_name = typeof RESERVED_PARAMETER_NAMES[number];
+export type string_reserved_parameter_name = TupleToUnion<typeof RESERVED_PARAMETER_NAMES>;
 /**
  * @@@
  */

package/esm/typings/src/utils/arrayableToArray.d.ts

@@ -6,6 +6,6 @@ import type { Arrayable } from '../types/Arrayable';
  * 2) Undefined returns empty array
  * 3) Array returns itself
  *
- * @private Internal utility
+ * @private internal utility
  */
 export declare function arrayableToArray<TItem>(input?: Arrayable<TItem>): Array<TItem>;

package/esm/typings/src/utils/deepFreeze.d.ts

@@ -2,19 +2,20 @@ import type { ReadonlyDeep } from 'type-fest';
 /**
  * @@@
  *
- * @returns The same object as the input, but deeply frozen
- *
  * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ *
+ * @returns The same object as the input, but deeply frozen
+ * @public exported from `@promptbook/utils`
  */
 export declare function deepFreeze<TObject>(objectValue: TObject): ReadonlyDeep<TObject>;
 /**
  * @@@
  * @@@
  *
- * @returns The same object as the input, but deeply frozen
- * @public exported from `@promptbook/utils`
- *
  * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ *
+ * @returns The same object as the input, but deeply frozen
+ * @private this is in comparison to `deepFreeze` a more specific utility and maybe not very good practice to use without specific reason and considerations
  */
 export declare function deepFreezeWithSameType<TObject>(objectValue: TObject): TObject;
 /**

package/esm/typings/src/utils/files/listAllFiles.d.ts

@@ -0,0 +1,14 @@
+import type { string_file_path } from '../../types/typeAliases';
+import type { string_folder_path } from '../../types/typeAliases';
+/**
+ * Reads all files in the directory
+ *
+ * @param path
+ * @param isRecursive
+ * @returns List of all files in the directory
+ * @private internal function of `createCollectionFromDirectory`
+ */
+export declare function listAllFiles(path: string_folder_path, isRecursive: boolean): Promise<Array<string_file_path>>;
+/**
+ * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
+ */

package/esm/typings/src/utils/getCurrentIsoDate.d.ts

@@ -2,6 +2,6 @@ import type { string_date_iso8601 } from '../types/typeAliases';
 /**
  * Get current date in ISO 8601 format
  *
- * @private This is internal util of the promptbook
+ * @private internal utility
  */
 export declare function getCurrentIsoDate(): string_date_iso8601;

package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts

@@ -16,5 +16,5 @@ import type { CodeBlock } from './extractAllBlocksFromMarkdown';
  */
 export declare function extractOneBlockFromMarkdown(markdown: string_markdown): CodeBlock;
 /***
- * TODO: [🍓][🌻] Decide of this is internal util, external util OR validator/postprocessor
+ * TODO: [🍓][🌻] Decide of this is internal utility, external util OR validator/postprocessor
  */

package/esm/typings/src/utils/normalization/normalizeWhitespaces.d.ts

@@ -1,4 +1,6 @@
 /**
- * Take every whitespace (space, new line, tab) and replace it with a single space.
+ * Take every whitespace (space, new line, tab) and replace it with a single space
+ *
+ * @public exported from `@promptbook/utils`
  */
 export declare function normalizeWhitespaces(sentence: string): string;

package/esm/typings/src/utils/validators/email/isValidEmail.d.ts

@@ -2,5 +2,7 @@ import type { string_email } from '../../../types/typeAliases';
 import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Checks if value is valid email
+ *
+ * @public exported from `@promptbook/utils`
  */
 export declare function isValidEmail(email: really_unknown): email is string_email;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/remote-client",
-    "version": "0.63.0-2",
+    "version": "0.63.0-4",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -47,7 +47,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/remote-client.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.63.0-2"
+        "@promptbook/core": "0.63.0-4"
     },
     "dependencies": {
         "socket.io-client": "4.7.2"

package/umd/index.umd.js

@@ -7,7 +7,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.63.0-1';
+    var PROMPTBOOK_VERSION = '0.63.0-3';
     // TODO: !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************

package/esm/typings/src/types/execution-report/config.d.ts

@@ -1,8 +0,0 @@
-/**
- * The thresholds for the relative time in the `moment` NPM package.
- *
- * @see https://momentjscom.readthedocs.io/en/latest/moment/07-customization/13-relative-time-threshold/
- */
-export declare const MOMENT_ARG_THRESHOLDS: {
-    readonly ss: 3;
-};

package/umd/typings/promptbook-collection/index.d.ts

@@ -1,252 +0,0 @@
-declare const _default: ({
-    title: string;
-    pipelineUrl: string;
-    promptbookVersion: string;
-    parameters: {
-        name: string;
-        description: string;
-        isInput: boolean;
-        isOutput: boolean;
-    }[];
-    promptTemplates: {
-        blockType: string;
-        name: string;
-        title: string;
-        modelRequirements: {
-            modelVariant: string;
-            modelName: string;
-        };
-        content: string;
-        dependentParameterNames: string[];
-        resultingParameterName: string;
-    }[];
-    knowledgeSources: never[];
-    knowledgePieces: never[];
-    personas: never[];
-    preparations: {
-        id: number;
-        promptbookVersion: string;
-        usage: {
-            price: {
-                value: number;
-            };
-            input: {
-                tokensCount: {
-                    value: number;
-                };
-                charactersCount: {
-                    value: number;
-                };
-                wordsCount: {
-                    value: number;
-                };
-                sentencesCount: {
-                    value: number;
-                };
-                linesCount: {
-                    value: number;
-                };
-                paragraphsCount: {
-                    value: number;
-                };
-                pagesCount: {
-                    value: number;
-                };
-            };
-            output: {
-                tokensCount: {
-                    value: number;
-                };
-                charactersCount: {
-                    value: number;
-                };
-                wordsCount: {
-                    value: number;
-                };
-                sentencesCount: {
-                    value: number;
-                };
-                linesCount: {
-                    value: number;
-                };
-                paragraphsCount: {
-                    value: number;
-                };
-                pagesCount: {
-                    value: number;
-                };
-            };
-        };
-    }[];
-    sourceFile: string;
-} | {
-    title: string;
-    pipelineUrl: string;
-    promptbookVersion: string;
-    parameters: {
-        name: string;
-        description: string;
-        isInput: boolean;
-        isOutput: boolean;
-    }[];
-    promptTemplates: {
-        blockType: string;
-        name: string;
-        title: string;
-        modelRequirements: {
-            modelVariant: string;
-            modelName: string;
-        };
-        content: string;
-        expectations: {
-            words: {
-                min: number;
-                max: number;
-            };
-        };
-        dependentParameterNames: string[];
-        resultingParameterName: string;
-    }[];
-    knowledgeSources: never[];
-    knowledgePieces: never[];
-    personas: never[];
-    preparations: {
-        id: number;
-        promptbookVersion: string;
-        usage: {
-            price: {
-                value: number;
-            };
-            input: {
-                tokensCount: {
-                    value: number;
-                };
-                charactersCount: {
-                    value: number;
-                };
-                wordsCount: {
-                    value: number;
-                };
-                sentencesCount: {
-                    value: number;
-                };
-                linesCount: {
-                    value: number;
-                };
-                paragraphsCount: {
-                    value: number;
-                };
-                pagesCount: {
-                    value: number;
-                };
-            };
-            output: {
-                tokensCount: {
-                    value: number;
-                };
-                charactersCount: {
-                    value: number;
-                };
-                wordsCount: {
-                    value: number;
-                };
-                sentencesCount: {
-                    value: number;
-                };
-                linesCount: {
-                    value: number;
-                };
-                paragraphsCount: {
-                    value: number;
-                };
-                pagesCount: {
-                    value: number;
-                };
-            };
-        };
-    }[];
-    sourceFile: string;
-} | {
-    title: string;
-    pipelineUrl: string;
-    promptbookVersion: string;
-    parameters: {
-        name: string;
-        description: string;
-        isInput: boolean;
-        isOutput: boolean;
-    }[];
-    promptTemplates: {
-        blockType: string;
-        name: string;
-        title: string;
-        modelRequirements: {
-            modelVariant: string;
-            modelName: string;
-        };
-        content: string;
-        expectFormat: string;
-        dependentParameterNames: string[];
-        resultingParameterName: string;
-    }[];
-    knowledgeSources: never[];
-    knowledgePieces: never[];
-    personas: never[];
-    preparations: {
-        id: number;
-        promptbookVersion: string;
-        usage: {
-            price: {
-                value: number;
-            };
-            input: {
-                tokensCount: {
-                    value: number;
-                };
-                charactersCount: {
-                    value: number;
-                };
-                wordsCount: {
-                    value: number;
-                };
-                sentencesCount: {
-                    value: number;
-                };
-                linesCount: {
-                    value: number;
-                };
-                paragraphsCount: {
-                    value: number;
-                };
-                pagesCount: {
-                    value: number;
-                };
-            };
-            output: {
-                tokensCount: {
-                    value: number;
-                };
-                charactersCount: {
-                    value: number;
-                };
-                wordsCount: {
-                    value: number;
-                };
-                sentencesCount: {
-                    value: number;
-                };
-                linesCount: {
-                    value: number;
-                };
-                paragraphsCount: {
-                    value: number;
-                };
-                pagesCount: {
-                    value: number;
-                };
-            };
-        };
-    }[];
-    sourceFile: string;
-})[];
-export default _default;

package/umd/typings/src/_packages/anthropic-claude.index.d.ts

@@ -1,6 +0,0 @@
-import { PROMPTBOOK_VERSION } from '../version';
-import { AnthropicClaudeExecutionTools } from '../llm-providers/anthropic-claude/AnthropicClaudeExecutionTools';
-import type { AnthropicClaudeExecutionToolsOptions } from '../llm-providers/anthropic-claude/AnthropicClaudeExecutionToolsOptions';
-export { PROMPTBOOK_VERSION };
-export { AnthropicClaudeExecutionTools };
-export type { AnthropicClaudeExecutionToolsOptions };

package/umd/typings/src/_packages/azure-openai.index.d.ts

@@ -1,6 +0,0 @@
-import { PROMPTBOOK_VERSION } from '../version';
-import { AzureOpenAiExecutionTools } from '../llm-providers/azure-openai/AzureOpenAiExecutionTools';
-import type { AzureOpenAiExecutionToolsOptions } from '../llm-providers/azure-openai/AzureOpenAiExecutionToolsOptions';
-export { PROMPTBOOK_VERSION };
-export { AzureOpenAiExecutionTools };
-export type { AzureOpenAiExecutionToolsOptions };

package/umd/typings/src/_packages/browser.index.d.ts

@@ -1,6 +0,0 @@
-import { PROMPTBOOK_VERSION } from '../version';
-import { getLocalStorage } from '../storage/local-storage/getLocalStorage';
-import { getSessionStorage } from '../storage/local-storage/getSessionStorage';
-export { PROMPTBOOK_VERSION };
-export { getLocalStorage };
-export { getSessionStorage };

package/umd/typings/src/_packages/cli.index.d.ts

@@ -1,4 +0,0 @@
-import { PROMPTBOOK_VERSION } from '../version';
-import { __CLI } from '../cli/main';
-export { PROMPTBOOK_VERSION };
-export { __CLI };