@promptbook/legacy-documents 0.71.0-12

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

@@ -0,0 +1,12 @@
+/**
+ * Map of letters from diacritic variant to diacritless variant
+ * Contains lowercase and uppercase separatelly
+ *
+ * > "á" => "a"
+ * > "ě" => "e"
+ * > "Ă" => "A"
+ * > ...
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const DIACRITIC_VARIANTS_LETTERS: Record<string, string>;

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

@@ -0,0 +1,21 @@
+/**
+ * Semantic helper
+ *
+ * Keyword is string without diacritics in lowercase [a-z1-9]
+ * Words are splitted between multiple keywords @see IKeywords
+ *
+ * For example `"keyword"`
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export type string_keyword = string;
+/**
+ * Semantic helper
+ * Set of keywords @see string_keyword
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export type IKeywords = Set<string_keyword>;
+/**
+ * TODO: [🌮] Keywords with weight
+ */

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

@@ -0,0 +1,6 @@
+/**
+ * Makes first letter of a string uppercase
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function capitalize(word: string): string;

package/esm/typings/src/utils/normalization/capitalize.test.d.ts

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

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

@@ -0,0 +1,6 @@
+/**
+ * Makes first letter of a string uppercase
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function decapitalize(word: string): string;

package/esm/typings/src/utils/normalization/decapitalize.test.d.ts

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

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

@@ -0,0 +1,10 @@
+import type { string_keyword } from './IKeywords';
+/**
+ * Tests if keyword is valid
+ *
+ * @param keyword to test
+ * @returns if keyword is valid or not
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isValidKeyword(keyword: string): keyword is string_keyword;

package/esm/typings/src/utils/normalization/isValidKeyword.test.d.ts

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

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

@@ -0,0 +1,9 @@
+/**
+ * @@@
+ *
+ * @param name @@@
+ * @returns @@@
+ * @example @@@
+ * @public exported from `@promptbook/utils`
+ */
+export declare function nameToUriPart(name: string): string;

package/esm/typings/src/utils/normalization/nameToUriPart.test.d.ts

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

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

@@ -0,0 +1,9 @@
+/**
+ * @@@
+ *
+ * @param name @@@
+ * @returns @@@
+ * @example @@@
+ * @public exported from `@promptbook/utils`
+ */
+export declare function nameToUriParts(name: string): string[];

package/esm/typings/src/utils/normalization/nameToUriParts.test.d.ts

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

package/esm/typings/src/utils/normalization/normalize-to-kebab-case.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Semantic helper for kebab-case strings
+ *
+ * @example 'hello-world'
+ * @example 'i-love-promptbook'
+ * @public exported from `@promptbook/utils`
+ */
+export type string_kebab_case = string;
+/**
+ * @@@
+ *
+ * @param text @@@
+ * @returns @@@
+ * @example 'hello-world'
+ * @example 'i-love-promptbook'
+ * @public exported from `@promptbook/utils`
+ */
+export declare function normalizeToKebabCase(text: string): string_kebab_case;

package/esm/typings/src/utils/normalization/normalize-to-kebab-case.test.d.ts

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

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

@@ -0,0 +1,17 @@
+/**
+ * Semantic helper for PascalCase strings
+ *
+ * @example 'HelloWorld'
+ * @example 'ILovePromptbook'
+ * @public exported from `@promptbook/utils`
+ */
+export type string_PascalCase = string;
+/**
+ *
+ * @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/esm/typings/src/utils/normalization/normalizeTo_PascalCase.test.d.ts

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

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

@@ -0,0 +1,26 @@
+/**
+ * Semantic helper for SCREAMING_CASE strings
+ *
+ * @example 'HELLO_WORLD'
+ * @example 'I_LOVE_PROMPTBOOK'
+ * @public exported from `@promptbook/utils`
+ */
+export type string_SCREAMING_CASE = string;
+/**
+ * @@@
+ *
+ * @param text @@@
+ * @returns @@@
+ * @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/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.test.d.ts

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

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

@@ -0,0 +1,22 @@
+/**
+ * Semantic helper for camelCase strings
+ *
+ * @example 'helloWorld'
+ * @example 'iLovePromptbook'
+ * @public exported from `@promptbook/utils`
+ */
+export type string_camelCase = string;
+/**
+ * @@@
+ *
+ * @param text @@@
+ * @param _isFirstLetterCapital @@@
+ * @returns @@@
+ * @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/esm/typings/src/utils/normalization/normalizeTo_camelCase.test.d.ts

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

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

@@ -0,0 +1,17 @@
+/**
+ * Semantic helper for snake_case strings
+ *
+ * @example 'hello_world'
+ * @example 'i_love_promptbook'
+ */
+export type string_snake_case = string;
+/**
+ * @@@
+ *
+ * @param text @@@
+ * @returns @@@
+ * @example 'hello_world'
+ * @example 'i_love_promptbook'
+ * @public exported from `@promptbook/utils`
+ */
+export declare function normalizeTo_snake_case(text: string): string_snake_case;

package/esm/typings/src/utils/normalization/normalizeTo_snake_case.test.d.ts

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

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

@@ -0,0 +1,6 @@
+/**
+ * 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/normalization/normalizeWhitespaces.test.d.ts

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

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

@@ -0,0 +1,16 @@
+import type { really_unknown } from '../organization/really_unknown';
+import type { IKeywords } 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): IKeywords;
+/**
+ * Note: Not using spread in input param because of keeping second parameter for options
+ * TODO: [🌺] Use some intermediate util splitWords
+ */

package/esm/typings/src/utils/normalization/parseKeywords.test.d.ts

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

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

@@ -0,0 +1,9 @@
+import type { IKeywords } 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): IKeywords;

package/esm/typings/src/utils/normalization/parseKeywordsFromString.test.d.ts

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

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

@@ -0,0 +1,11 @@
+/**
+ * @@@
+ *
+ * @param input @@@
+ * @returns @@@
+ * @public exported from `@promptbook/utils`
+ */
+export declare function removeDiacritics(input: string): string;
+/**
+ * TODO: [Ж] Variant for cyrillic (and in general non-latin) letters
+ */

package/esm/typings/src/utils/normalization/removeDiacritics.test.d.ts

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

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

@@ -0,0 +1,10 @@
+import type { IKeywords } from './IKeywords';
+/**
+ * @@@
+ *
+ * @param haystack
+ * @param needle
+ * @returns
+ * @public exported from `@promptbook/utils`
+ */
+export declare function searchKeywords(haystack: IKeywords, needle: IKeywords): boolean;

package/esm/typings/src/utils/normalization/searchKeywords.test.d.ts

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

package/esm/typings/src/utils/organization/TODO_USE.d.ts

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

package/esm/typings/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/esm/typings/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/esm/typings/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/esm/typings/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/esm/typings/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/esm/typings/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/esm/typings/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` @@@
+ * - `just_empty_object` @@@
+ *
+ * @private within the repository
+ */
+export type empty_object = {};

package/esm/typings/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 usefull 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/esm/typings/src/utils/organization/just_empty_object.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Organizational helper to better @@@@
+ *
+ * Note: There are 2 similar types>
+ * - `empty_object` @@@
+ * - `just_empty_object` @@@
+ *
+ * Note: In most cases, you should use `empty_object`
+ *
+ * @private within the repository
+ */
+export type just_empty_object = Record<string, never>;

package/esm/typings/src/utils/organization/keepUnused.d.ts

@@ -0,0 +1,16 @@
+import type { really_any } from './really_any';
+/**
+ * Just says that the variable is not used but should be kept
+ * No side effects.
+ *
+ * Note: It can be usefull 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 = really_any, TTypeToKeep2 = really_any, TTypeToKeep3 = really_any>(...valuesToKeep: Array<really_any>): void;

package/esm/typings/src/utils/organization/really_any.d.ts

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

package/esm/typings/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/esm/typings/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 template and returns the list of all parameter names
+ *
+ * @param template the 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/esm/typings/src/utils/parameters/extractParameterNames.test.d.ts

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

package/esm/typings/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';
+/**
+ * @@@
+ */
+type MakeapAvailableToExpectedParametersOptions = {
+    /**
+     * @@@
+     */
+    readonly expectedParameters: Readonly<Record<string_parameter_name, null>>;
+    /**
+     * @@@
+     */
+    readonly availableParameters: Readonly<Record<string_parameter_name, string_parameter_value>>;
+};
+/**
+ * Maps available parameters to expected parameters
+ *
+ * The strategy is:
+ * 1) @@@
+ * 2) @@@
+ *
+ * @throws {PipelineExecutionError} @@@
+ * @private within the repository used in `createPipelineExecutor`
+ */
+export declare function mapAvailableToExpectedParameters(options: MakeapAvailableToExpectedParametersOptions): Readonly<Record<string_parameter_name, string_parameter_value>>;
+export {};

package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.test.d.ts

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

package/esm/typings/src/utils/parameters/replaceParameters.d.ts

@@ -0,0 +1,12 @@
+import type { Parameters } from '../../types/typeAliases';
+import type { string_template } from '../../types/typeAliases';
+/**
+ * Replaces parameters in template with values from parameters object
+ *
+ * @param template the template with parameters in {curly} braces
+ * @param parameters the object with parameters
+ * @returns the template with replaced parameters
+ * @throws {PipelineExecutionError} if parameter is not defined, not closed, or not opened
+ * @public exported from `@promptbook/utils`
+ */
+export declare function replaceParameters(template: string_template, parameters: Parameters): string;

package/esm/typings/src/utils/parameters/replaceParameters.test.d.ts

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

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

@@ -0,0 +1,16 @@
+/**
+ * Function parseNumber will parse number from string
+ *
+ * Unlike Number.parseInt, Number.parseFloat it will never ever result in NaN
+ * Note: it also works only with decimal numbers
+ *
+ * @returns parsed number
+ * @throws {ParseError} if the value is not a number
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function parseNumber(value: string | number): number;
+/**
+ * TODO: Maybe use sth. like safe-eval in fraction/calculation case @see https://www.npmjs.com/package/safe-eval
+ * TODO: [🧠][🌻] Maybe export through `@promptbook/markdown-utils` not `@promptbook/utils`
+ */

package/esm/typings/src/utils/parseNumber.test.d.ts

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

package/esm/typings/src/utils/random/$randomSeed.d.ts

@@ -0,0 +1,9 @@
+import type { number_seed } from '../../types/typeAliases';
+/**
+ * Generates random seed
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it is not deterministic
+ * Warning: This function is not cryptographically secure (it uses Math.random internally)
+ * @public exported from `@promptbook/utils`
+ */
+export declare function $randomSeed(): number_seed;

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

@@ -0,0 +1,8 @@
+/**
+ * Removes emojis from a string and fix whitespaces
+ *
+ * @param text with emojis
+ * @returns text without emojis
+ * @public exported from `@promptbook/utils`
+ */
+export declare function removeEmojis(text: string): string;

package/esm/typings/src/utils/removeEmojis.test.d.ts

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

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

@@ -0,0 +1,14 @@
+/**
+ * Removes quotes from a string
+ *
+ * Tip: This is very usefull 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 simmilar 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/esm/typings/src/utils/removeQuotes.test.d.ts

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

package/esm/typings/src/utils/serialization/$asDeeplyFrozenSerializableJson.d.ts

@@ -0,0 +1,17 @@
+import type { string_name } from '../../types/typeAliases';
+/**
+ * @@@
+ * @@@
+ *
+ * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ *
+ * @param name - Name of the object for debugging purposes
+ * @param objectValue - Object to be deeply frozen
+ * @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 $asDeeplyFrozenSerializableJson<TObject>(name: string_name, objectValue: TObject): TObject;
+/**
+ * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
+ */

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

@@ -0,0 +1,14 @@
+import type { ReadonlyDeep } from 'type-fest';
+/**
+ * @@@
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it mutates given object
+ * 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>;
+/**
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
+ */

package/esm/typings/src/utils/serialization/checkSerializableAsJson.d.ts

@@ -0,0 +1,27 @@
+import type { string_name } from '../../types/typeAliases';
+/**
+ * Checks if the value is [🚉] serializable as JSON
+ * If not, throws an UnexpectedError with a rich error message and tracking
+ *
+ * - Almost all primitives are serializable BUT:
+ * - `undefined` is not serializable
+ * - `NaN` is not serializable
+ * - Objects and arrays are serializable if all their properties are serializable
+ * - Functions are not serializable
+ * - Circular references are not serializable
+ * - `Date` objects are not serializable
+ * - `Map` and `Set` objects are not serializable
+ * - `RegExp` objects are not serializable
+ * - `Error` objects are not serializable
+ * - `Symbol` objects are not serializable
+ * - And much more...
+ *
+ * @throws UnexpectedError if the value is not serializable as JSON
+ * @public exported from `@promptbook/utils`
+ */
+export declare function checkSerializableAsJson(name: string_name, value: unknown): void;
+/**
+ * TODO: [🧠][🛣] More elegant way to tracking than passing `name`
+ * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
+ * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
+ */