@promptbook/cli 0.62.2 → 0.63.0-0

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

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

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

@@ -1,11 +1,22 @@
-/**
- * Semantic helper for camelCase strings
- *
- * @example 'helloWorld'
- * @example 'iLovePromptbook'
- */
-export type string_camelCase = string;
-export declare function normalizeTo_camelCase(text: string, _isFirstLetterCapital?: boolean): string_camelCase;
-/**
- * TODO: [🌺] Use some intermediate util splitWords
- */
+/**
+ * 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

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

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

@@ -1,8 +1,17 @@
-/**
- * Semantic helper for snake_case strings
- *
- * @example 'hello_world'
- * @example 'i_love_promptbook'
- */
-export type string_snake_case = string;
-export declare function normalizeTo_snake_case(text: string): string_snake_case;
+/**
+ * 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

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

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

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

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

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

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

@@ -1,15 +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
- */
-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
- */
+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

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

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

@@ -1,8 +1,9 @@
-import type { IKeywords } from './IKeywords';
-/**
- * Parses keywords from a string
- *
- * @param {string} input
- * @returns {Set} of keywords without diacritics in lowercase
- */
-export declare function parseKeywordsFromString(input: string): IKeywords;
+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

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

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

@@ -1,4 +1,11 @@
-/**
- *
- */
-export declare function removeDiacritics(input: string): string;
+/**
+ * @@@
+ *
+ * @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

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

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

@@ -1,5 +1,10 @@
-import type { IKeywords } from './IKeywords';
-/**
- *
- */
-export declare function searchKeywords(haystack: IKeywords, needle: IKeywords): boolean;
+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

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

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

@@ -1,12 +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;
+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

@@ -1,6 +1,6 @@
-/**
- * Organizational helper to better mark the place where the type is missing
- *
- * @private within the repository
- */
-export type TODO_any = any;
+/**
+ * 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

@@ -1,6 +1,6 @@
-/**
- * Organizational helper to better mark the place where the type is missing
- *
- * @private within the repository
- */
-export type TODO_object = object;
+/**
+ * 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_unknown.d.ts

@@ -1,6 +1,6 @@
-/**
- * Organizational helper to better mark the place where the type is missing
- *
- * @private within the repository
- */
-export type TODO_unknown = unknown;
+/**
+ * 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/___.d.ts

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

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

@@ -1,14 +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;
+/**
+ * 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/keepUnused.d.ts

@@ -1,16 +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;
+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

@@ -1,6 +1,6 @@
-/**
- * Organizational helper to mark a place where to really use `any`
- *
- * @private within the repository
- */
-export type really_any = any;
+/**
+ * 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

@@ -1,6 +1,6 @@
-/**
- * Organizational helper to mark a place where to really use `unknown`
- *
- * @private within the repository
- */
-export type really_unknown = unknown;
+/**
+ * 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/parseNumber.d.ts

@@ -1,15 +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 {ParsingError} if the value is not a number
- *
- * @private within the parseCommand
- */
-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
- */
+/**
+ * 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 {ParsingError} 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

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

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

@@ -1,7 +1,8 @@
-import type { number_seed } from '../../types/typeAliases';
-/**
- * Generates random seed
- *
- * Warning: This function is not cryptographically secure (it uses Math.random internally)
- */
-export declare function $randomSeed(): number_seed;
+import type { number_seed } from '../../types/typeAliases';
+/**
+ * Generates random seed
+ *
+ * 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

@@ -1,7 +1,8 @@
-/**
- * Removes emojis from a string and fix whitespaces
- *
- * @param text with emojis
- * @returns text without emojis
- */
-export declare function removeEmojis(text: string): string;
+/**
+ * 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

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

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

@@ -1,13 +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
- */
-export declare function removeQuotes(text: string): string;
+/**
+ * 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

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

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

@@ -1,11 +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
- */
-export declare function replaceParameters(template: string_template, parameters: Parameters): string;
+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/replaceParameters.test.d.ts

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

package/esm/typings/src/utils/sets/difference.d.ts

@@ -1,9 +1,10 @@
-/**
- * Create difference set of two sets.
- *
- * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
- */
-export declare function difference<TItem>(a: Set<TItem>, b: Set<TItem>, isEqual?: (a: TItem, b: TItem) => boolean): Set<TItem>;
-/**
- * TODO: [🧠][💯] Maybe also implement symmetricDifference
- */
+/**
+ * Create difference set of two sets.
+ *
+ * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
+ * @public exported from `@promptbook/utils`
+ */
+export declare function difference<TItem>(a: Set<TItem>, b: Set<TItem>, isEqual?: (a: TItem, b: TItem) => boolean): Set<TItem>;
+/**
+ * TODO: [🧠][💯] Maybe also implement symmetricDifference
+ */

package/esm/typings/src/utils/sets/difference.test.d.ts

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

package/esm/typings/src/utils/sets/intersection.d.ts

@@ -1,6 +1,7 @@
-/**
- * Creates a new set with all elements that are present in all sets
- *
- * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
- */
-export declare function intersection<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;
+/**
+ * Creates a new set with all elements that are present in all sets
+ *
+ * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
+ * @public exported from `@promptbook/utils`
+ */
+export declare function intersection<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;

package/esm/typings/src/utils/sets/intersection.test.d.ts

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

package/esm/typings/src/utils/sets/union.d.ts

@@ -1,6 +1,7 @@
-/**
- * Creates a new set with all elements that are present in either set
- *
- * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
- */
-export declare function union<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;
+/**
+ * Creates a new set with all elements that are present in either set
+ *
+ * @deprecated use new javascript set methods instead @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set
+ * @public exported from `@promptbook/utils`
+ */
+export declare function union<TItem>(...sets: Array<Set<TItem>>): Set<TItem>;

package/esm/typings/src/utils/sets/union.test.d.ts

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

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

@@ -1,8 +1,9 @@
-/**
- * Function trimCodeBlock will trim starting and ending code block from the string if it is present.
- *
- * Note: This is usefull for post-processing of the result of the chat LLM model
- *       when the model wraps the result in the (markdown) code block.
- *
- */
-export declare function trimCodeBlock(value: string): string;
+/**
+ * Function trimCodeBlock will trim starting and ending code block from the string if it is present.
+ *
+ * Note: This is usefull for post-processing of the result of the chat LLM model
+ *       when the model wraps the result in the (markdown) code block.
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function trimCodeBlock(value: string): string;

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

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

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

@@ -1,7 +1,9 @@
-/**
- * Function trimEndOfCodeBlock will remove ending code block from the string if it is present.
- *
- * Note: This is usefull for post-processing of the result of the completion LLM model
- *       if you want to start code block in the prompt but you don't want to end it in the result.
- */
-export declare function trimEndOfCodeBlock(value: string): string;
+/**
+ * Function trimEndOfCodeBlock will remove ending code block from the string if it is present.
+ *
+ * Note: This is usefull for post-processing of the result of the completion LLM model
+ *       if you want to start code block in the prompt but you don't want to end it in the result.
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function trimEndOfCodeBlock(value: string): string;

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

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