@promptbook/openai 0.63.0-2 → 0.63.0-3

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

@@ -1,17 +0,0 @@
-/**
- * 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/umd/typings/src/utils/normalization/normalizeTo_snake_case.test.d.ts

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

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

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

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

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

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

@@ -1,16 +0,0 @@
-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/umd/typings/src/utils/normalization/parseKeywords.test.d.ts

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

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

@@ -1,9 +0,0 @@
-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/umd/typings/src/utils/normalization/parseKeywordsFromString.test.d.ts

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

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

@@ -1,11 +0,0 @@
-/**
- * @@@
- *
- * @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/umd/typings/src/utils/normalization/removeDiacritics.test.d.ts

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

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

@@ -1,10 +0,0 @@
-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/umd/typings/src/utils/normalization/searchKeywords.test.d.ts

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

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

@@ -1,12 +0,0 @@
-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/umd/typings/src/utils/organization/TODO_any.d.ts

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

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

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

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

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

package/umd/typings/src/utils/organization/___.d.ts

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

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

@@ -1,14 +0,0 @@
-/**
- * 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/umd/typings/src/utils/organization/keepUnused.d.ts

@@ -1,16 +0,0 @@
-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/umd/typings/src/utils/organization/really_any.d.ts

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

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

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

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

@@ -1,16 +0,0 @@
-/**
- * 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/umd/typings/src/utils/parseNumber.test.d.ts

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

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

@@ -1,8 +0,0 @@
-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/umd/typings/src/utils/removeEmojis.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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/umd/typings/src/utils/removeEmojis.test.d.ts

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

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

@@ -1,14 +0,0 @@
-/**
- * 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/umd/typings/src/utils/removeQuotes.test.d.ts

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

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

@@ -1,12 +0,0 @@
-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/umd/typings/src/utils/replaceParameters.test.d.ts

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

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

@@ -1,10 +0,0 @@
-/**
- * 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/umd/typings/src/utils/sets/difference.test.d.ts

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

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

@@ -1,7 +0,0 @@
-/**
- * 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/umd/typings/src/utils/sets/intersection.test.d.ts

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

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

@@ -1,7 +0,0 @@
-/**
- * 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/umd/typings/src/utils/sets/union.test.d.ts

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

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

@@ -1,9 +0,0 @@
-/**
- * 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/umd/typings/src/utils/trimCodeBlock.test.d.ts

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

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

@@ -1,9 +0,0 @@
-/**
- * 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/umd/typings/src/utils/trimEndOfCodeBlock.test.d.ts

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

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

@@ -1,37 +0,0 @@
-/**
- * Additional options for `unwrapResult`
- */
-interface UnwrapResultOptions {
-    /**
-     * If true, the text is trimmed before processing
-     */
-    isTrimmed?: boolean;
-    /**
-     * If true, the introduce sentence is removed
-     *
-     * For example:
-     * - If `true`>  'Hello, "world"' -> 'world'
-     * - If `false`> 'Hello, "world"' -> 'Hello, "world"'
-     *
-     * @default true
-     */
-    isIntroduceSentenceRemoved?: boolean;
-}
-/**
- * Removes quotes and optional introduce text from a string
- *
- * Tip: This is very usefull 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 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 unwrapResult(text: string, options?: UnwrapResultOptions): string;
-export {};
-/**
- * TODO: [🧠] Should this also unwrap the (parenthesis)
- */

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

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

package/umd/typings/src/utils/validators/email/isValidEmail.d.ts

@@ -1,6 +0,0 @@
-import type { string_email } from '../../../types/typeAliases';
-import type { really_unknown } from '../../organization/really_unknown';
-/**
- * Checks if value is valid email
- */
-export declare function isValidEmail(email: really_unknown): email is string_email;

package/umd/typings/src/utils/validators/email/isValidEmail.test.d.ts

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

package/umd/typings/src/utils/validators/filePath/isValidFilePath.d.ts

@@ -1,9 +0,0 @@
-import type { string_file_path } from '../../../types/typeAliases';
-import type { really_unknown } from '../../organization/really_unknown';
-/**
- * Tests if given string is valid URL.
- *
- * Note: This does not check if the file exists only if the path is valid
- * @public exported from `@promptbook/utils`
- */
-export declare function isValidFilePath(filePath: really_unknown): filePath is string_file_path;

package/umd/typings/src/utils/validators/filePath/isValidFilePath.test.d.ts

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

package/umd/typings/src/utils/validators/javascriptName/isValidJavascriptName.d.ts

@@ -1,10 +0,0 @@
-import type { string_javascript_name } from '../../../types/typeAliases';
-import type { really_unknown } from '../../organization/really_unknown';
-/**
- * @@@
- *
- * @param javascriptName @@@
- * @returns @@@
- * @public exported from `@promptbook/utils`
- */
-export declare function isValidJavascriptName(javascriptName: really_unknown): javascriptName is string_javascript_name;

package/umd/typings/src/utils/validators/javascriptName/isValidJavascriptName.test.d.ts

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

package/umd/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts

@@ -1,15 +0,0 @@
-import type { string_promptbook_version } from '../../../version';
-import type { really_unknown } from '../../organization/really_unknown';
-/**
- * Tests if given string is valid promptbook version
- * It looks into list of known promptbook versions.
- *
- * @see https://www.npmjs.com/package/promptbook?activeTab=versions
- * Note: When you are using for example promptbook 2.0.0 and there already is promptbook 3.0.0 it don`t know about it.
- * Note: There are two simmilar functions:
- * - `isValidSemanticVersion` which tests any semantic version
- * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
- *
- * @public exported from `@promptbook/utils`
- */
-export declare function isValidPromptbookVersion(version: really_unknown): version is string_promptbook_version;

package/umd/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.test.d.ts

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

package/umd/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts

@@ -1,12 +0,0 @@
-import type { string_semantic_version } from '../../../types/typeAliases';
-import type { really_unknown } from '../../organization/really_unknown';
-/**
- * Tests if given string is valid semantic version
- *
- * Note: There are two simmilar functions:
- * - `isValidSemanticVersion` which tests any semantic version
- * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
- *
- * @public exported from `@promptbook/utils`
- */
-export declare function isValidSemanticVersion(version: really_unknown): version is string_semantic_version;

package/umd/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.test.d.ts

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

package/umd/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.d.ts

@@ -1,11 +0,0 @@
-import type { string_hostname } from '../../../types/typeAliases';
-/**
- * Checks if an URL is reserved for private networks or localhost.
- *
- * Note: There are two simmilar functions:
- * - `isUrlOnPrivateNetwork` which tests full URL
- * - `isHostnameOnPrivateNetwork` *(this one)* which tests just hostname
- *
- * @public exported from `@promptbook/utils`
- */
-export declare function isHostnameOnPrivateNetwork(hostname: string_hostname): boolean;

package/umd/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.test.d.ts

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

package/umd/typings/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts

@@ -1,13 +0,0 @@
-import type { string_url } from '../../../types/typeAliases';
-/**
- * Checks if an IP address or hostname is reserved for private networks or localhost.
- *
- * Note: There are two simmilar functions:
- * - `isUrlOnPrivateNetwork` *(this one)* which tests full URL
- * - `isHostnameOnPrivateNetwork` which tests just hostname
- *
- * @param {string} ipAddress - The IP address to check.
- * @returns {boolean} Returns true if the IP address is reserved for private networks or localhost, otherwise false.
- * @public exported from `@promptbook/utils`
- */
-export declare function isUrlOnPrivateNetwork(url: URL | string_url): boolean;

package/umd/typings/src/utils/validators/url/isUrlOnPrivateNetwork.test.d.ts

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

package/umd/typings/src/utils/validators/url/isValidPipelineUrl.d.ts

@@ -1,15 +0,0 @@
-import type { string_pipeline_url } from '../../../types/typeAliases';
-import type { really_unknown } from '../../organization/really_unknown';
-/**
- * Tests if given string is valid pipeline URL URL.
- *
- * Note: There are two simmilar functions:
- * - `isValidUrl` which tests any URL
- * - `isValidPipelineUrl` *(this one)* which tests just pipeline URL
- *
- * @public exported from `@promptbook/utils`
- */
-export declare function isValidPipelineUrl(url: really_unknown): url is string_pipeline_url;
-/**
- * TODO: [🐠] Maybe more info why the URL is invalid
- */

package/umd/typings/src/utils/validators/url/isValidPipelineUrl.test.d.ts

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

package/umd/typings/src/utils/validators/url/isValidUrl.d.ts

@@ -1,13 +0,0 @@
-import type { string_url } from '../../../types/typeAliases';
-import type { really_unknown } from '../../organization/really_unknown';
-/**
- * Tests if given string is valid URL.
- *
- * Note: Dataurl are considered perfectly valid.
- * Note: There are two simmilar functions:
- * - `isValidUrl` which tests any URL
- * - `isValidPipelineUrl` *(this one)* which tests just promptbook URL
- *
- * @public exported from `@promptbook/utils`
- */
-export declare function isValidUrl(url: really_unknown): url is string_url;

package/umd/typings/src/utils/validators/url/isValidUrl.test.d.ts

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

package/umd/typings/src/utils/validators/uuid/isValidUuid.d.ts

@@ -1,8 +0,0 @@
-import type { string_uuid } from '../../../types/typeAliases';
-import type { really_unknown } from '../../organization/really_unknown';
-/**
- * Checks if value is valid uuid
- *
- * @public exported from `@promptbook/utils`
- */
-export declare function isValidUuid(value: really_unknown): value is string_uuid;

package/umd/typings/src/utils/validators/uuid/isValidUuid.test.d.ts

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

package/umd/typings/src/version.d.ts

@@ -1,6 +0,0 @@
-import type { string_semantic_version } from './types/typeAliases';
-/**
- * The version of the Promptbook library
- */
-export declare const PROMPTBOOK_VERSION: string_promptbook_version;
-export type string_promptbook_version = string_semantic_version;