@promptbook/utils 0.63.0-1 → 0.63.0-10

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>;
+/**
+ * @@@
+ *
+ * @public exported from `@promptbook/core`
+ */
+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
+ * @public exported from `@promptbook/core`
  */
-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/PipelineJson/LlmTemplateJson.d.ts

@@ -14,7 +14,7 @@ export type LlmTemplateJson = PromptTemplateJsonCommon & {
      * Requirements for the model
      * - This is required only for blockType PROMPT_TEMPLATE
      */
-    readonly modelRequirements: ModelRequirements;
+    readonly modelRequirements?: Partial<ModelRequirements>;
 };
 /**
  * TODO: [🧠][🥜]

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/isDirectoryExisting.d.ts

@@ -0,0 +1,13 @@
+import type { string_folder_path } from '../../types/typeAliases';
+/**
+ * Checks if the directory exists
+ *
+ * @private within the repository
+ */
+export declare function isDirectoryExisting(directoryPath: string_folder_path): Promise<boolean>;
+/**
+ * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
+ * TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
+ * TODO: [🧠][📂] "directory" vs "folder"
+ * TODO: [🖇] What about symlinks?
+ */

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

@@ -0,0 +1,12 @@
+import type { string_file_path } from '../../types/typeAliases';
+/**
+ * Checks if the file exists
+ *
+ * @private within the repository
+ */
+export declare function isFileExisting(filePath: string_file_path): Promise<boolean>;
+/**
+ * Note: [🟢] This code should never be published outside of `@promptbook/node` and `@promptbook/cli` and `@promptbook/cli`
+ * TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
+ * TODO: [🖇] What about symlinks?
+ */

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

@@ -0,0 +1,15 @@
+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`
+ * TODO: [🖇] What about symlinks?
+ */

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/utils",
-    "version": "0.63.0-1",
+    "version": "0.63.0-10",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -33,9 +33,6 @@
         "url": "https://github.com/webgptorg/promptbook/issues"
     },
     "homepage": "https://www.npmjs.com/package/@promptbook/core",
-    "dependencies": {
-        "spacetrim": "0.11.39"
-    },
     "funding": [
         {
             "type": "individual",
@@ -48,5 +45,8 @@
     ],
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",
-    "typings": "./esm/typings/src/_packages/utils.index.d.ts"
+    "typings": "./esm/typings/src/_packages/utils.index.d.ts",
+    "dependencies": {
+        "spacetrim": "0.11.39"
+    }
 }

package/umd/index.umd.js

@@ -8,10 +8,11 @@
 
     var spaceTrim__default = /*#__PURE__*/_interopDefaultLegacy(spaceTrim);
 
+    // ⚠️ WARNING: This code has been generated so that any manual changes will be overwritten
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.63.0-0';
+    var PROMPTBOOK_VERSION = '0.63.0-9';
     // TODO: !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************
@@ -1065,7 +1066,7 @@
         return codeBlocks[0];
     }
     /***
-     * TODO: [🍓][🌻] Decide of this is internal util, external util OR validator/postprocessor
+     * TODO: [🍓][🌻] Decide of this is internal utility, external util OR validator/postprocessor
      */
 
     /**
@@ -1124,9 +1125,10 @@
     /**
      * @@@
      *
-     * @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`
      */
     function deepFreeze(objectValue) {
         var e_1, _a;
@@ -1149,18 +1151,6 @@
         }
         return Object.freeze(objectValue);
     }
-    /**
-     * @@@
-     * @@@
-     *
-     * @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
-     */
-    function deepFreezeWithSameType(objectValue) {
-        return deepFreeze(objectValue);
-    }
     /**
      * TODO: [🧠] Is there a way how to meaningfully test this utility
      */
@@ -1443,6 +1433,15 @@
         return normalizeTo_SCREAMING_CASE(text).toLowerCase();
     }
 
+    /**
+     * Take every whitespace (space, new line, tab) and replace it with a single space
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    function normalizeWhitespaces(sentence) {
+        return sentence.replace(/\s+/gs, ' ').trim();
+    }
+
     /**
      * Parses keywords from any object and recursively walks through
      *
@@ -1610,14 +1609,17 @@
         return text;
     }
 
+    // <- TODO: [🧠] Better system for generator warnings - not always "code" and "by `@promptbook/cli`"
     /**
      * 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_...`
      */
     var LOOP_LIMIT = 1000;
     /**
      * Nonce which is used for replacing things in strings
+     *
+     * @private within the repository
      */
     var REPLACING_NONCE = 'u$k42k%!V2zo34w7Fu#@QUHYPW';
     /**
@@ -1647,13 +1649,6 @@
      * @private within the repository
      */
     var RESERVED_PARAMETER_RESTRICTED = 'RESTRICTED-' + REPLACING_NONCE;
-    /*
-    TODO: !!! Just testing false-negative detection of [🟡][🟢][🔵][⚪] leak
-    */
-    // [🟡][🟢][🔵][⚪]
-    /**
-     * TODO: !!!!!! Check that all @private contains some normalized explanation
-     */
 
     /**
      * This error type indicates that some limit was reached
@@ -1987,6 +1982,18 @@
      * TODO: [🧠] Should this also unwrap the (parenthesis)
      */
 
+    /**
+     * Checks if value is valid email
+     *
+     * @public exported from `@promptbook/utils`
+     */
+    function isValidEmail(email) {
+        if (typeof email !== 'string') {
+            return false;
+        }
+        return /^.+@.+\..+$/.test(email);
+    }
+
     /**
      * Tests if given string is valid URL.
      *
@@ -2207,7 +2214,7 @@
     exports.countWords = countWords;
     exports.decapitalize = decapitalize;
     exports.deepClone = deepClone;
-    exports.deepFreezeWithSameType = deepFreezeWithSameType;
+    exports.deepFreeze = deepFreeze;
     exports.difference = difference;
     exports.extractBlock = extractBlock;
     exports.extractParameterNames = extractParameterNames;
@@ -2220,6 +2227,7 @@
     exports.isRunningInNode = isRunningInNode;
     exports.isRunningInWebWorker = isRunningInWebWorker;
     exports.isUrlOnPrivateNetwork = isUrlOnPrivateNetwork;
+    exports.isValidEmail = isValidEmail;
     exports.isValidFilePath = isValidFilePath;
     exports.isValidJavascriptName = isValidJavascriptName;
     exports.isValidJsonString = isValidJsonString;
@@ -2236,6 +2244,7 @@
     exports.normalizeTo_SCREAMING_CASE = normalizeTo_SCREAMING_CASE;
     exports.normalizeTo_camelCase = normalizeTo_camelCase;
     exports.normalizeTo_snake_case = normalizeTo_snake_case;
+    exports.normalizeWhitespaces = normalizeWhitespaces;
     exports.parseKeywords = parseKeywords;
     exports.parseKeywordsFromString = parseKeywordsFromString;
     exports.parseNumber = parseNumber;