@promptbook/openai 0.63.0-2 → 0.63.0-4

package/esm/typings/src/commands/index.d.ts

@@ -1,4 +1,6 @@
 /**
  * All available command parsers
+ *
+ * @private internal index of `parseCommand`
  */
 export declare const COMMANDS: readonly [import("./_common/types/CommandParser").CommandParser<import("./BLOCK/BlockCommand").BlockCommand>, import("./_common/types/CommandParser").CommandParser<import("./EXPECT/ExpectCommand").ExpectCommand>, import("./_common/types/CommandParser").CommandParser<import("./JOKER/JokerCommand").JokerCommand>, import("./_common/types/CommandParser").CommandParser<import("./MODEL/ModelCommand").ModelCommand>, import("./_common/types/CommandParser").CommandParser<import("./PARAMETER/ParameterCommand").ParameterCommand>, import("./_common/types/CommandParser").CommandParser<import("./POSTPROCESS/PostprocessCommand").PostprocessCommand>, import("./_common/types/CommandParser").CommandParser<import("./PROMPTBOOK_VERSION/PromptbookVersionCommand").PromptbookVersionCommand>, import("./_common/types/CommandParser").CommandParser<import("./URL/UrlCommand").UrlCommand>, import("./_common/types/CommandParser").CommandParser<import("./KNOWLEDGE/KnowledgeCommand").KnowledgeCommand>, import("./_common/types/CommandParser").CommandParser<import("./X_ACTION/ActionCommand").ActionCommand>, import("./_common/types/CommandParser").CommandParser<import("./X_INSTRUMENT/InstrumentCommand").InstrumentCommand>, import("./_common/types/CommandParser").CommandParser<import("./PERSONA/PersonaCommand").PersonaCommand>, import("./_common/types/CommandParser").CommandParser<import("./_BOILERPLATE/BoilerplateCommand").BoilerplateCommand>];

package/esm/typings/src/config.d.ts

@@ -1,13 +1,19 @@
+/**
+ * Warning message for the generated sections and files files
+ *
+ * @private within the repository
+ */
+export declare const GENERATOR_WARNING = "\u26A0\uFE0F WARNING: This section has been generated so that any manual changes will be overwritten";
 /**
  * The maximum number of iterations for a loops
  *
- * @private within the repository - too low-level in comparison to other `MAX_...`
+ * @private within the repository - too low-level in comparison with other `MAX_...`
  */
 export declare const LOOP_LIMIT = 1000;
 /**
  * The maximum number of iterations for a loops which adds characters one by one
  *
- * @private within the repository - too low-level in comparison to other `MAX_...`
+ * @private within the repository - too low-level in comparison with other `MAX_...`
  */
 export declare const CHARACTER_LOOP_LIMIT = 100000;
 /**
@@ -56,6 +62,8 @@ export declare const EXECUTIONS_CACHE_DIRNAME = "/.promptbook/executions-cache";
 export declare const PIPELINE_COLLECTION_BASE_FILENAME = "index";
 /**
  * Nonce which is used for replacing things in strings
+ *
+ * @private within the repository
  */
 export declare const REPLACING_NONCE = "u$k42k%!V2zo34w7Fu#@QUHYPW";
 /**
@@ -76,12 +84,18 @@ export declare const RESERVED_PARAMETER_MISSING_VALUE: string;
  * @private within the repository
  */
 export declare const RESERVED_PARAMETER_RESTRICTED: string;
+/**
+ * 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/
+ * @private within the repository - too low-level in comparison with other constants
+ */
+export declare const MOMENT_ARG_THRESHOLDS: {
+    readonly ss: 3;
+};
 /**
  * @@@
  *
  * @private within the repository
  */
 export declare const DEBUG_ALLOW_PAYED_TESTING: boolean;
-/**
- * TODO: !!!!!! Check that all @private contains some normalized explanation
- */

package/esm/typings/src/conversion/pipelineJsonToString.d.ts

@@ -13,4 +13,5 @@ export declare function pipelineJsonToString(pipelineJson: PipelineJson): Pipeli
  * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
  * TODO: [🏛] Maybe make some markdown builder
  * TODO: [🏛] Escape all
+ * TODO: [🧠] Should be in generated .ptbk.md file GENERATOR_WARNING
  */

package/esm/typings/src/conversion/pipelineStringToJson.d.ts

@@ -35,4 +35,5 @@ export declare function pipelineStringToJson(pipelineString: PipelineString, opt
 /**
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
+ * TODO: [🧠] Should be in generated JSON file GENERATOR_WARNING
  */

package/esm/typings/src/conversion/validation/_importPipeline.d.ts

@@ -8,15 +8,19 @@ import type { string_json } from '../../types/typeAliases';
  * Note: Using sync version is 💩 in the production code, but it's ok here in tests
  *
  * @param path - The path to the file relative to samples/templates directory
- * @private
+ * @private internal function of tests
  */
 export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.md`): PipelineString;
 export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.json`): PipelineJson;
 /**
  * Import the pipeline.ptbk.json file as parsed JSON
+ *
+ * @private internal function of tests
  */
 export declare function importPipelineJson(path: `${string}.ptbk.json`): PipelineJson;
 /**
  * Import the pipeline.ptbk.json file as string
+ *
+ * @private internal function of tests
  */
 export declare function importPipelineJsonAsString(path: `${string}.ptbk.json`): string_json<PipelineJson>;

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

@@ -1,7 +1,8 @@
 /**
  * This error occurs when some expectation is not met in the execution of the pipeline
  *
- * @private Always catched and rethrown as `PipelineExecutionError`
+ * @private error of `checkExpectations` and `createPipelineExecutor`
+ * Note: Always thrown in `checkExpectations` and catched in `createPipelineExecutor` and rethrown as `PipelineExecutionError`
  * Note: This is a kindof subtype of PipelineExecutionError
  */
 export declare class ExpectError extends Error {

package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts

@@ -1,4 +1,7 @@
 import type { Promisable } from 'type-fest';
+/**
+ * @private still in development [🏳]
+ */
 export type AutomaticTranslator = {
     translate(message: string): Promisable<string>;
 };

package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/DebugAutomaticTranslator.d.ts

@@ -1,6 +1,8 @@
 import type { AutomaticTranslator } from './AutomaticTranslator';
 /**
  * This will wrap an automatic translator and log each translation into the console
+ *
+ * @private still in development [🏳]
  */
 export declare class DebugAutomaticTranslator implements AutomaticTranslator {
     private readonly automaticTranslator;

package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/FakeAutomaticTranslator.d.ts

@@ -1,4 +1,7 @@
 import type { AutomaticTranslator } from './AutomaticTranslator';
+/**
+ * @private still in development [🏳]
+ */
 export declare class FakeAutomaticTranslator implements AutomaticTranslator {
     constructor();
     translate(message: string): string;

package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/LindatAutomaticTranslator.d.ts

@@ -3,6 +3,9 @@ import type { TranslatorOptions } from './TranslatorOptions';
 interface LindatAutomaticTranslatorOptions extends TranslatorOptions {
     apiUrl?: URL;
 }
+/**
+ * @private still in development [🏳]
+ */
 export declare class LindatAutomaticTranslator implements AutomaticTranslator {
     private readonly options;
     constructor(options: LindatAutomaticTranslatorOptions);

package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/TranslatorOptions.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @private still in development [🏳]
+ */
 export type TranslatorOptions = {
     readonly from?: string;
     readonly to: string;

package/esm/typings/src/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts

@@ -3,5 +3,6 @@
  * @param message
  * @returns
  * @throws {PipelineExecutionError}
+ * @private still in development [🏳]
  */
 export declare function extractMultiplicatedOccurrence(message: string): string;

package/esm/typings/src/execution/translation/automatic-translate/translateMessages.d.ts

@@ -1,5 +1,8 @@
 import type { AutomaticTranslator } from './automatic-translators/AutomaticTranslator';
 import type { TranslatorOptions } from './automatic-translators/TranslatorOptions';
+/**
+ * @private still in development [🏳]
+ */
 export declare function translateMessages({ automaticTranslator, from, to, }: {
     automaticTranslator: AutomaticTranslator;
 } & TranslatorOptions): Promise<void>;

package/esm/typings/src/execution/utils/checkExpectations.d.ts

@@ -8,7 +8,7 @@ import type { Expectations } from '../../types/PipelineJson/Expectations';
  *
  * @throws {ExpectError} if the expectations are not met
  * @returns {void} Nothing
- * @public exported from `@promptbook/core`
+ * @private internal function of `createPipelineExecutor`
  */
 export declare function checkExpectations(expectations: Expectations, value: string): void;
 /**

package/esm/typings/src/execution/utils/computeUsageCounts.d.ts

@@ -5,6 +5,6 @@ import type { PromptResultUsageCounts } from '../PromptResultUsage';
  * @param content the content of prompt or response
  * @returns part of PromptResultUsageCounts
  *
- * @private internal util of LlmExecutionTools
+ * @private internal utility of LlmExecutionTools
  */
 export declare function computeUsageCounts(content: string): Omit<PromptResultUsageCounts, 'tokensCount'>;

package/esm/typings/src/expectations/drafts/isDomainNameFree.d.ts

@@ -1,4 +1,7 @@
 import type { string_name } from '../../types/typeAliases';
+/**
+ * @private still in development
+ */
 export declare function isDomainNameFree(name: string_name): Promise<boolean>;
 /**
  * TODO: [🍓][🧠] Test and implement `isDomainNameFree`

package/esm/typings/src/expectations/drafts/isGithubNameFree.d.ts

@@ -1,4 +1,7 @@
 import type { string_name } from '../../types/typeAliases';
+/**
+ * @private still in development
+ */
 export declare function isGithubNameFree(name: string_name): Promise<boolean>;
 /**
  * TODO: [🍓][🧠] Test and implement `isGithubNameFree`

package/esm/typings/src/formats/_common/FormatDefinition.d.ts

@@ -4,7 +4,7 @@ import type { string_name } from '../../types/typeAliases';
  * A format definition is a set of functions that define how to validate, heal and convert response from LLM
  *
  * @see https://github.com/webgptorg/promptbook/discussions/36
- * @private still an internal experimental
+ * @private still in development [🏢]
  */
 export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSchema extends object> = {
     /**

package/esm/typings/src/formats/csv/ListFormatDefinition.d.ts

@@ -1,6 +1,8 @@
 import type { FormatDefinition } from '../_common/FormatDefinition';
 /**
  * Definition for CSV spreadsheet
+ *
+ * @private still in development [🏢]
  */
 export declare const CsvFormatDefinition: FormatDefinition<string, string, object>;
 /**

package/esm/typings/src/formats/index.d.ts

@@ -1,4 +1,6 @@
 /**
  * Definitions for all formats supported by Promptbook
+ *
+ * @private internal index of `...` <- TODO [🏢]
  */
 export declare const FORMAT_DEFINITIONS: import("./_common/FormatDefinition").FormatDefinition<string, string, object>[];

package/esm/typings/src/formats/json/JsonFormatDefinition.d.ts

@@ -1,6 +1,8 @@
 import type { FormatDefinition } from '../_common/FormatDefinition';
 /**
  * Definition for JSON format
+ *
+ * @private still in development [🏢]
  */
 export declare const JsonFormatDefinition: FormatDefinition<string, string, object>;
 /**

package/esm/typings/src/formats/list/ListFormatDefinition.d.ts

@@ -3,6 +3,8 @@ import type { FormatDefinition } from '../_common/FormatDefinition';
  * Definition for list of multiple items
  *
  * Note: list is just a string with multiple lines or multiple items separated by comma
+ *
+ * @private still in development [🏢]
  */
 export declare const ListFormatDefinition: FormatDefinition<string, string, object>;
 /**

package/esm/typings/src/formats/xml/XmlFormatDefinition.d.ts

@@ -1,6 +1,8 @@
 import type { FormatDefinition } from '../_common/FormatDefinition';
 /**
  * Definition for XML format
+ *
+ * @private still in development [🏢]
  */
 export declare const XmlFormatDefinition: FormatDefinition<string, string, object>;
 /**

package/esm/typings/src/knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts

@@ -7,7 +7,7 @@ import type { UserInterfaceToolsPromptDialogOptions } from '../../../execution/U
  * Warning: It is used for testing and mocking
  *          **NOT intended to use in the production** due to its synchronous nature.
  *
- * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/browser`
  */
 export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
     private readonly options;

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/openai",
-    "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/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.63.0-2"
+        "@promptbook/core": "0.63.0-4"
     },
     "dependencies": {
         "colors": "1.4.0",