@promptbook/javascript 0.111.0-4 → 0.111.0-7

package/umd/src/utils/normalization/normalizeMessageText.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Normalizes message text for comparison
+ *
+ * @param text The message text to normalize
+ * @returns The normalized message text
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function normalizeMessageText(text: string): string;

package/umd/src/utils/normalization/normalizeMessageText.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/utils/normalization/normalizeTo_PascalCase.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Semantic helper for PascalCase strings
+ *
+ * @example 'HelloWorld'
+ * @example 'ILovePromptbook'
+ * @public exported from `@promptbook/utils`
+ */
+export type string_PascalCase = string;
+/**
+ * Normalizes a given text to PascalCase format.
+ *
+ * Note: [🔂] This function is idempotent.
+ *
+ * @param text @public exported from `@promptbook/utils`
+ * @returns
+ * @example 'HelloWorld'
+ * @example 'ILovePromptbook'
+ * @public exported from `@promptbook/utils`
+ */
+export declare function normalizeTo_PascalCase(text: string): string_PascalCase;

package/umd/src/utils/normalization/normalizeTo_PascalCase.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Semantic helper for SCREAMING_CASE strings
+ *
+ * @example 'HELLO_WORLD'
+ * @example 'I_LOVE_PROMPTBOOK'
+ * @public exported from `@promptbook/utils`
+ */
+export type string_SCREAMING_CASE = string;
+/**
+ * Normalizes a text string to SCREAMING_CASE (all uppercase with underscores).
+ *
+ * Note: [🔂] This function is idempotent.
+ *
+ * @param text The text string to be converted to SCREAMING_CASE format.
+ * @returns The normalized text in SCREAMING_CASE format.
+ * @example 'HELLO_WORLD'
+ * @example 'I_LOVE_PROMPTBOOK'
+ * @public exported from `@promptbook/utils`
+ */
+export declare function normalizeTo_SCREAMING_CASE(text: string): string_SCREAMING_CASE;
+/**
+ * TODO: Tests
+ *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: 'Moje tabule' })).toEqual('/VtG7sR9rRJqwNEdM2/Moje tabule');
+ *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: 'ěščřžžýáíúů' })).toEqual('/VtG7sR9rRJqwNEdM2/escrzyaieuu');
+ *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: '  ahoj  ' })).toEqual('/VtG7sR9rRJqwNEdM2/ahoj');
+ *     > expect(encodeRoutePath({ uriId: 'VtG7sR9rRJqwNEdM2', name: '  ahoj_ahojAhoj    ahoj  ' })).toEqual('/VtG7sR9rRJqwNEdM2/ahoj-ahoj-ahoj-ahoj');
+ * TODO: [🌺] Use some intermediate util splitWords
+ */

package/umd/src/utils/normalization/normalizeTo_SCREAMING_CASE.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/utils/normalization/normalizeTo_camelCase.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Semantic helper for camelCase strings
+ *
+ * @example 'helloWorld'
+ * @example 'iLovePromptbook'
+ * @public exported from `@promptbook/utils`
+ */
+export type string_camelCase = string;
+/**
+ * Normalizes a given text to camelCase format.
+ *
+ * Note: [🔂] This function is idempotent.
+ *
+ * @param text The text to be normalized.
+ * @param _isFirstLetterCapital Whether the first letter should be capitalized.
+ * @returns The camelCase formatted string.
+ * @example 'helloWorld'
+ * @example 'iLovePromptbook'
+ * @public exported from `@promptbook/utils`
+ */
+export declare function normalizeTo_camelCase(text: string, _isFirstLetterCapital?: boolean): string_camelCase;
+/**
+ * TODO: [🌺] Use some intermediate util splitWords
+ */

package/umd/src/utils/normalization/normalizeTo_camelCase.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/utils/normalization/normalizeTo_snake_case.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Semantic helper for snake_case strings
+ *
+ * @example 'hello_world'
+ * @example 'i_love_promptbook'
+ */
+export type string_snake_case = string;
+/**
+ * Normalizes a text string to snake_case format.
+ *
+ * Note: [🔂] This function is idempotent.
+ *
+ * @param text The text string to be converted to snake_case format.
+ * @returns The normalized text in snake_case format.
+ * @example 'hello_world'
+ * @example 'i_love_promptbook'
+ * @public exported from `@promptbook/utils`
+ */
+export declare function normalizeTo_snake_case(text: string): string_snake_case;

package/umd/src/utils/normalization/normalizeTo_snake_case.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/utils/normalization/normalizeWhitespaces.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Take every whitespace (space, new line, tab) and replace it with a single space
+ *
+ * Note: [🔂] This function is idempotent.
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function normalizeWhitespaces(sentence: string): string;

package/umd/src/utils/normalization/normalizeWhitespaces.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/utils/normalization/orderJson.d.ts

@@ -0,0 +1,21 @@
+import type { JsonArray, JsonObject } from 'type-fest';
+/**
+ * Options for the `orderJson` function
+ */
+export type OrderJsonOptions<TObject extends JsonObject | JsonArray> = {
+    /**
+     * Value to checked, ordered and deeply frozen
+     */
+    value: TObject;
+    /**
+     * Order of the object properties
+     */
+    order: Array<keyof TObject>;
+};
+/**
+ * Orders JSON object by keys
+ *
+ * @returns The same type of object as the input re-ordered
+ * @public exported from `@promptbook/utils`
+ */
+export declare function orderJson<TObject extends JsonObject | JsonArray>(options: OrderJsonOptions<TObject>): TObject;

package/umd/src/utils/normalization/orderJson.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠] Is there a way how to test order of value better way than via `JSON.stringify`
+ */

package/umd/src/utils/normalization/parseKeywords.d.ts

@@ -0,0 +1,16 @@
+import type { really_unknown } from '../organization/really_unknown';
+import type { Keywords } from './IKeywords';
+/**
+ * Parses keywords from any object and recursively walks through
+ *
+ * Tip: If you want to parse multiple inputs, just wrap them in an array
+ *
+ * @param input of any kind
+ * @returns {Set} of keywords without diacritics in lowercase
+ * @public exported from `@promptbook/utils`
+ */
+export declare function parseKeywords(input: really_unknown): Keywords;
+/**
+ * Note: Not using spread in input param because of keeping second parameter for options
+ * TODO: [🌺] Use some intermediate util splitWords
+ */

package/umd/src/utils/normalization/parseKeywords.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/utils/normalization/parseKeywordsFromString.d.ts

@@ -0,0 +1,9 @@
+import type { Keywords } from './IKeywords';
+/**
+ * Parses keywords from a string
+ *
+ * @param {string} input
+ * @returns {Set} of keywords without diacritics in lowercase
+ * @public exported from `@promptbook/utils`
+ */
+export declare function parseKeywordsFromString(input: string): Keywords;

package/umd/src/utils/normalization/parseKeywordsFromString.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/utils/normalization/removeDiacritics.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Removes diacritic marks (accents) from characters in a string.
+ *
+ * Note: [🔂] This function is idempotent.
+ *
+ * @param input The string containing diacritics to be normalized.
+ * @returns The string with diacritics removed or normalized.
+ * @public exported from `@promptbook/utils`
+ */
+export declare function removeDiacritics(input: string): string;
+/**
+ * TODO: [Ж] Variant for cyrillic (and in general non-latin) letters
+ */

package/umd/src/utils/normalization/removeDiacritics.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/utils/normalization/removeEmojis.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Removes emojis from a string and fix whitespaces
+ *
+ * Note: [🔂] This function is idempotent.
+ *
+ * @param text with emojis
+ * @returns text without emojis
+ * @public exported from `@promptbook/utils`
+ */
+export declare function removeEmojis(text: string): string;

package/umd/src/utils/normalization/removeEmojis.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/utils/normalization/removeQuotes.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Removes quotes from a string
+ *
+ * Note: [🔂] This function is idempotent.
+ * Tip: This is very useful for post-processing of the result of the LLM model
+ * Note: This function removes only the same quotes from the beginning and the end of the string
+ * Note: There are two similar functions:
+ * - `removeQuotes` which removes only bounding quotes
+ * - `unwrapResult` which removes whole introduce sentence
+ *
+ * @param text optionally quoted text
+ * @returns text without quotes
+ * @public exported from `@promptbook/utils`
+ */
+export declare function removeQuotes(text: string): string;

package/umd/src/utils/normalization/removeQuotes.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/utils/normalization/searchKeywords.d.ts

@@ -0,0 +1,13 @@
+import type { Keywords } from './IKeywords';
+/**
+ * Searches set of keywords for a specific keyword
+ *
+ * @param haystack
+ * @param needle
+ * @returns
+ * @public exported from `@promptbook/utils`
+ */
+export declare function searchKeywords(haystack: Keywords, needle: Keywords): boolean;
+/**
+ * TODO: Rename to `isKeywordInKeywords`
+ */

package/umd/src/utils/normalization/searchKeywords.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/utils/normalization/suffixUrl.d.ts

@@ -0,0 +1,7 @@
+import type { string_url } from '../../types/typeAliases';
+/**
+ * Adds suffix to the URL
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function suffixUrl(value: URL, suffix: `/${string}`): string_url;

package/umd/src/utils/normalization/suffixUrl.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/utils/normalization/titleToName.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Converts a title string into a normalized name.
+ *
+ * Note: [🔂] This function is idempotent.
+ *
+ * @param value The title string to be converted to a name.
+ * @returns A normalized name derived from the input title.
+ * @example 'Hello World!' -> 'hello-world'
+ * @public exported from `@promptbook/utils`
+ */
+export declare function titleToName(value: string): string;

package/umd/src/utils/normalization/titleToName.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/utils/normalization/unwrapResult.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Additional options for `unwrapResult`
+ */
+type UnwrapResultOptions = {
+    /**
+     * If true, the text is trimmed before processing
+     */
+    readonly isTrimmed?: boolean;
+    /**
+     * If true, the introduce sentence is removed
+     *
+     * For example:
+     * - If `true`>  'Hello, "world"' -> 'world'
+     * - If `false`> 'Hello, "world"' -> 'Hello, "world"'
+     *
+     * @default true
+     */
+    readonly isIntroduceSentenceRemoved?: boolean;
+};
+/**
+ * Removes quotes and optional introduce text from a string
+ *
+ * Tip: This is very useful for post-processing of the result of the LLM model
+ * Note: This function trims the text and removes whole introduce sentence if it is present
+ * Note: There are two similar functions:
+ * - `removeQuotes` which removes only bounding quotes
+ * - `unwrapResult` which removes whole introduce sentence
+ *
+ * @param text optionally quoted text
+ * @returns text without quotes
+ * @public exported from `@promptbook/utils`
+ */
+export declare function unwrapResult(text: string, options?: UnwrapResultOptions): string;
+export {};
+/**
+ * TODO: [🧠] Should this also unwrap the (parenthesis)
+ */

package/umd/src/utils/normalization/unwrapResult.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/utils/organization/$sideEffect.d.ts

@@ -0,0 +1,9 @@
+import type { chococake } from './really_any';
+/**
+ * Just says that the variable is not used directlys but should be kept because the existence of the variable is important
+ *
+ * @param value any values
+ * @returns void
+ * @private within the repository
+ */
+export declare function $sideEffect(...sideEffectSubjects: ReadonlyArray<chococake>): void;

package/umd/src/utils/organization/$side_effect.d.ts

@@ -0,0 +1,7 @@
+import type { chococake } from './really_any';
+/**
+ * Organizational helper to mark a function that produces side effects
+ *
+ * @private within the repository
+ */
+export type $side_effect = void | chococake;

package/umd/src/utils/organization/TODO_USE.d.ts

@@ -0,0 +1,12 @@
+import type { chococake } from './really_any';
+/**
+ * Just marks a place of place where should be something implemented
+ * No side effects.
+ *
+ * Note: It can be useful suppressing eslint errors of unused variables
+ *
+ * @param value any values
+ * @returns void
+ * @private within the repository
+ */
+export declare function TODO_USE(...value: ReadonlyArray<chococake>): void;

package/umd/src/utils/organization/TODO_any.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to better mark the place where the type is missing
+ *
+ * @private within the repository
+ */
+export type TODO_any = any;

package/umd/src/utils/organization/TODO_narrow.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to better mark the place where the more specific type is missing
+ *
+ * @private within the repository
+ */
+export type TODO_narrow<T> = T;

package/umd/src/utils/organization/TODO_object.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to better mark the place where the type is missing
+ *
+ * @private within the repository
+ */
+export type TODO_object = object;

package/umd/src/utils/organization/TODO_remove_as.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to better mark the place is used as but should not be
+ *
+ * @private within the repository
+ */
+export type TODO_remove_as<T> = T;

package/umd/src/utils/organization/TODO_string.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to better mark the place where the more specific string type is missing
+ *
+ * @private within the repository
+ */
+export type TODO_string = string;

package/umd/src/utils/organization/TODO_unknown.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to better mark the place where the type is missing
+ *
+ * @private within the repository
+ */
+export type TODO_unknown = unknown;

package/umd/src/utils/organization/___and___.d.ts

@@ -0,0 +1,7 @@
+import type { really_unknown } from './really_unknown';
+/**
+ * Formatting helper to put void to keep longer version of prettier
+ *
+ * @private within the repository
+ */
+export type ___and___ = really_unknown;

package/umd/src/utils/organization/___or___.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Formatting helper to put void to keep longer version of prettier
+ *
+ * @private within the repository
+ */
+export type ___or___ = never;

package/umd/src/utils/organization/empty_object.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Organizational helper to better mark the place where to really use empty object `{}`
+ *
+ * Note: There are 2 similar types>
+ * - `empty_object` Type used for empty data objects allowing for potential future extensions
+ * - `just_empty_object` Type used when an object must remain permanently empty
+ *
+ * @private within the repository
+ */
+export type empty_object = {};

package/umd/src/utils/organization/just.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Returns the same value that is passed as argument.
+ * No side effects.
+ *
+ * Note: It can be useful for:
+ *
+ * 1) Leveling indentation
+ * 2) Putting always-true or always-false conditions without getting eslint errors
+ *
+ * @param value any values
+ * @returns the same values
+ * @private within the repository
+ */
+export declare function just<T>(value?: T): T;

package/umd/src/utils/organization/just_empty_object.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Organizational helper to better distinguish different empty object use cases.
+ *
+ * Note: There are 2 similar types:
+ * - `empty_object` Type used for empty data objects with potential extensions
+ * - `just_empty_object` Type used specifically for objects that must remain empty
+ *
+ * Note: In most cases, you should use `empty_object`
+ *
+ * @private within the repository
+ */
+export type just_empty_object = Record<string, never>;

package/umd/src/utils/organization/keepImported.d.ts

@@ -0,0 +1,9 @@
+import { chococake } from './really_any';
+/**
+ * Just says that the dependency is imported, not used but should be kept
+ *
+ * @param dependenciesToKeep any values
+ * @returns void
+ * @private within the repository
+ */
+export declare function keepImported(...dependenciesToKeep: ReadonlyArray<chococake>): void;

package/umd/src/utils/organization/keepTypeImported.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Just says that the type is used but `organize-imports-cli` does not recognize it.
+ * [🤛] This is a workaround for the issue.
+ *
+ * @returns void
+ * @private within the repository
+ */
+export declare function keepTypeImported<TTypeToKeep>(): void;

package/umd/src/utils/organization/keepUnused.d.ts

@@ -0,0 +1,16 @@
+import type { chococake } from './really_any';
+/**
+ * Just says that the variable is not used but should be kept
+ * No side effects.
+ *
+ * Note: It can be useful for:
+ *
+ * 1) Suppressing eager optimization of unused imports
+ * 2) Suppressing eslint errors of unused variables in the tests
+ * 3) Keeping the type of the variable for type testing
+ *
+ * @param value any values
+ * @returns void
+ * @private within the repository
+ */
+export declare function keepUnused<TTypeToKeep1 = chococake, TTypeToKeep2 = chococake, TTypeToKeep3 = chococake>(...valuesToKeep: ReadonlyArray<chococake>): void;

package/umd/src/utils/organization/preserve.d.ts

@@ -0,0 +1,21 @@
+import type { chococake } from './really_any';
+/**
+ * Does nothing, but preserves the function in the bundle
+ * Compiler is tricked into thinking the function is used
+ *
+ * @param value any function to preserve
+ * @returns nothing
+ * @private within the repository
+ */
+export declare function $preserve(...value: Array<chococake>): void;
+/**
+ * DO NOT USE THIS FUNCTION
+ * Only purpose of this function is to trick the compiler and javascript engine
+ * that `_preserved` array can be used in the future and should not be garbage collected
+ *
+ * @private internal for `preserve`
+ */
+export declare function __DO_NOT_USE_getPreserved(): Array<chococake>;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/umd/src/utils/organization/really_any.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Organizational helper to tell to use intentionally `any`
+ *
+ * @alias really_any
+ * @private within the repository
+ */
+export type chococake = really_any;
+/**
+ * Organizational helper to mark a place where to really use `any`
+ *
+ * @private within the repository
+ */
+export type really_any = any;

package/umd/src/utils/organization/really_unknown.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Organizational helper to mark a place where to really use `unknown`
+ *
+ * @private within the repository
+ */
+export type really_unknown = unknown;

package/umd/src/utils/organization/spaceTrim.d.ts

@@ -0,0 +1,11 @@
+import { spaceTrim as spaceTrimReexported } from 'spacetrim';
+/**
+ * Trims string from all 4 sides
+ *
+ * Note: This is a re-exported function from the `spacetrim` package which is
+ *       Developed by same author @hejny as this package
+ *
+ * @public exported from `@promptbook/utils`
+ * @see https://github.com/hejny/spacetrim#usage
+ */
+export declare const spaceTrim: typeof spaceTrimReexported;

package/umd/src/utils/parameters/extractParameterNames.d.ts

@@ -0,0 +1,10 @@
+import type { string_parameter_name } from '../../types/typeAliases';
+import type { string_template } from '../../types/typeAliases';
+/**
+ * Parses the task and returns the list of all parameter names
+ *
+ * @param template the string template with parameters in {curly} braces
+ * @returns the list of parameter names
+ * @public exported from `@promptbook/utils`
+ */
+export declare function extractParameterNames(template: string_template): Set<string_parameter_name>;

package/umd/src/utils/parameters/extractParameterNames.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/utils/parameters/mapAvailableToExpectedParameters.d.ts

@@ -0,0 +1,27 @@
+import type { string_parameter_name } from '../../types/typeAliases';
+import type { string_parameter_value } from '../../types/typeAliases';
+/**
+ * Options for mapping available parameters to expected parameters in a pipeline task.
+ */
+type MakeapAvailableToExpectedParametersOptions = {
+    /**
+     * The set of expected parameter names (keys) for the task, all values are null.
+     */
+    readonly expectedParameters: Readonly<Record<string_parameter_name, null>>;
+    /**
+     * The set of available parameters (name-value pairs) to map to the expected parameters.
+     */
+    readonly availableParameters: Readonly<Record<string_parameter_name, string_parameter_value>>;
+};
+/**
+ * Maps available parameters to expected parameters for a pipeline task.
+ *
+ * The strategy is:
+ * 1) First, match parameters by name where both available and expected.
+ * 2) Then, if there are unmatched expected and available parameters, map them by order.
+ *
+ * @throws {PipelineExecutionError} If the number of unmatched expected and available parameters does not match, or mapping is ambiguous.
+ * @private within the repository used in `createPipelineExecutor`
+ */
+export declare function mapAvailableToExpectedParameters(options: MakeapAvailableToExpectedParametersOptions): Readonly<Record<string_parameter_name, string_parameter_value>>;
+export {};

package/umd/src/utils/parameters/mapAvailableToExpectedParameters.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/src/utils/parameters/numberToString.d.ts

@@ -0,0 +1,7 @@
+import type { string_parameter_value } from '../../types/typeAliases';
+/**
+ * Format either small or big number
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function numberToString(value: number): string_parameter_value;

package/umd/src/utils/parameters/numberToString.test.d.ts

@@ -0,0 +1 @@
+export {};