@promptbook/openai 0.62.0 → 0.63.0-0

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

@@ -5,5 +5,6 @@ import type { string_template } from '../types/typeAliases';
  *
  * @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/umd/typings/src/utils/isRunningInWhatever.d.ts

@@ -1,15 +1,18 @@
 /**
  * Detects if the code is running in a browser environment in main thread (Not in a web worker)
+ *
+ * @public exported from `@promptbook/utils`
  */
 export declare const isRunningInBrowser: Function;
 /**
  * Detects if the code is running in a Node.js environment
+ *
+ * @public exported from `@promptbook/utils`
  */
 export declare const isRunningInNode: Function;
 /**
  * Detects if the code is running in a web worker
+ *
+ * @public exported from `@promptbook/utils`
  */
 export declare const isRunningInWebWorker: Function;
-/**
- * TODO: [🔼] !!! Export via `@promptbook/utils`
- */

package/umd/typings/src/utils/markdown/addAutoGeneratedSection.d.ts

@@ -3,9 +3,12 @@ import type { string_name } from '../../types/typeAliases';
 /**
  * Add or modify an auto-generated section in a markdown file
  *
- * @private within the repository
+ * @public exported from `@promptbook/markdown-utils`
  */
 export declare function addAutoGeneratedSection(content: string_markdown, options: {
     readonly sectionName: string_name;
     readonly sectionContent: string_markdown;
 }): string_markdown;
+/**
+ * TODO: [🏛] This can be part of markdown builder
+ */

package/umd/typings/src/utils/markdown/createMarkdownChart.d.ts

@@ -28,7 +28,7 @@ type CreateMarkdownChartOptions = {
 /**
  * Function createMarkdownChart will draw a chart in markdown from ⬛+🟦 tiles
  *
- * @private within the repository
+ * @public exported from `@promptbook/markdown-utils`
  */
 export declare function createMarkdownChart(options: CreateMarkdownChartOptions): string_markdown;
 export {};

package/umd/typings/src/utils/markdown/createMarkdownTable.d.ts

@@ -3,6 +3,9 @@ import type { string_markdown_text } from '../../types/typeAliases';
 /**
  * Create a markdown table from a 2D array of strings
  *
- * @private within the repository
+ * @public exported from `@promptbook/markdown-utils`
  */
 export declare function createMarkdownTable(table: Array<Array<string_markdown_text>>): string_markdown;
+/**
+ * TODO: [🏛] This can be part of markdown builder
+ */

package/umd/typings/src/utils/markdown/escapeMarkdownBlock.d.ts

@@ -2,5 +2,10 @@ import type { string_markdown_text } from '../../types/typeAliases';
 /**
  * Function escapeMarkdownBlock will escape markdown block if needed
  * It is useful when you want have block in block
+ *
+ * @public exported from `@promptbook/markdown-utils`
  */
 export declare function escapeMarkdownBlock(value: string_markdown_text): string_markdown_text;
+/**
+ * TODO: [🏛] This can be part of markdown builder
+ */

package/umd/typings/src/utils/markdown/extractAllBlocksFromMarkdown.d.ts

@@ -26,7 +26,7 @@ export type CodeBlock = {
  *
  * @param markdown any valid markdown
  * @returns code blocks with language and content
- *
+ * @public exported from `@promptbook/markdown-utils`
  */
 export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): Array<CodeBlock>;
 /**

package/umd/typings/src/utils/markdown/extractAllListItemsFromMarkdown.d.ts

@@ -9,6 +9,7 @@ import type { string_markdown_text } from '../../types/typeAliases';
  * Note: It can not work with html syntax and comments
  *
  * @param markdown any valid markdown
- * @returns
+ * @returns @@@
+ * @public exported from `@promptbook/markdown-utils`
  */
 export declare function extractAllListItemsFromMarkdown(markdown: string_markdown): string_markdown_text[];

package/umd/typings/src/utils/markdown/extractOneBlockFromMarkdown.d.ts

@@ -12,6 +12,7 @@ import type { CodeBlock } from './extractAllBlocksFromMarkdown';
  *
  * @param markdown any valid markdown
  * @returns code block with language and content
+ * @public exported from `@promptbook/markdown-utils`
  */
 export declare function extractOneBlockFromMarkdown(markdown: string_markdown): CodeBlock;
 /***

package/umd/typings/src/utils/markdown/flattenMarkdown.d.ts

@@ -4,9 +4,12 @@ import type { string_markdown } from '../../types/typeAliases';
  *
  * - It always have h1 - if there is no h1 in the markdown, it will be added "# Untitled"
  * - All other headings are normalized to h2
+ *
+ * @public exported from `@promptbook/markdown-utils`
  */
 export declare function flattenMarkdown<TContent extends string_markdown>(markdown: TContent): TContent;
 /**
+ * TODO: [🏛] This can be part of markdown builder
  * Note: [🕞] In past (commit 42086e1603cbed506482997c00a8ee979af0a247) there was much more
  *       sophisticated implementation of this function through parsing markdown into JSON structure
  *       and flattening the actual structure

package/umd/typings/src/utils/markdown/parseMarkdownSection.d.ts

@@ -3,6 +3,8 @@ import type { string_markdown_section_content } from '../../types/typeAliases';
 import type { string_markdown_text } from '../../types/typeAliases';
 /**
  * Parsed markdown section
+ *
+ * @public exported from `@promptbook/markdown-utils`
  */
 export type MarkdownSection = {
     /**
@@ -20,6 +22,8 @@ export type MarkdownSection = {
 };
 /**
  * Parses markdown section to title its level and content
+ *
+ * @public exported from `@promptbook/markdown-utils`
  */
 export declare function parseMarkdownSection(value: string_markdown_section): MarkdownSection;
 /**

package/umd/typings/src/utils/markdown/removeContentComments.d.ts

@@ -5,5 +5,6 @@ import type { string_markdown } from '../../types/typeAliases';
  *
  * @param {string} content - The string to remove comments from.
  * @returns {string} The input string with all comments removed.
+ * @public exported from `@promptbook/markdown-utils`
  */
 export declare function removeContentComments<TContent extends string_html | string_markdown>(content: TContent): TContent;

package/umd/typings/src/utils/markdown/removeMarkdownFormatting.d.ts

@@ -4,5 +4,6 @@ import type { string_markdown_text } from '../../types/typeAliases';
  *
  * @param {string} str - The string to remove Markdown tags from.
  * @returns {string} The input string with all Markdown tags removed.
+ * @public exported from `@promptbook/markdown-utils`
  */
 export declare function removeMarkdownFormatting(str: string_markdown_text): string;

package/umd/typings/src/utils/markdown/splitMarkdownIntoSections.d.ts

@@ -2,9 +2,12 @@ import type { string_markdown } from '../../types/typeAliases';
 import type { string_markdown_section } from '../../types/typeAliases';
 /**
  * Splits the markdown into sections by headings
+ *
+ * @public exported from `@promptbook/markdown-utils`
  */
 export declare function splitMarkdownIntoSections(markdown: string_markdown): Array<string_markdown_section>;
 /**
+ * TODO: [🏛] This can be part of markdown builder
  * Note: [🕞] In past (commit 42086e1603cbed506482997c00a8ee979af0a247) there was much more
  *       sophisticated implementation of this function through parsing markdown into JSON structure
  *       and flattening the actual structure

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

@@ -6,5 +6,7 @@
  * > "ě" => "e"
  * > "Ă" => "A"
  * > ...
+ *
+ * @public exported from `@promptbook/utils`
  */
 export declare const DIACRITIC_VARIANTS_LETTERS: Record<string, string>;

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

@@ -5,12 +5,15 @@
  * 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>;
 /**

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

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

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

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

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

@@ -4,5 +4,7 @@ import type { string_keyword } from './IKeywords';
  *
  * @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/umd/typings/src/utils/normalization/nameToUriPart.d.ts

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

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

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

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

@@ -3,6 +3,16 @@
  *
  * @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/umd/typings/src/utils/normalization/normalizeTo_PascalCase.d.ts

@@ -3,6 +3,15 @@
  *
  * @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/umd/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts

@@ -3,8 +3,18 @@
  *
  * @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

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

@@ -3,8 +3,19 @@
  *
  * @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/umd/typings/src/utils/normalization/normalizeTo_snake_case.d.ts

@@ -5,4 +5,13 @@
  * @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/parseKeywords.d.ts

@@ -7,6 +7,7 @@ import type { IKeywords } from './IKeywords';
  *
  * @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;
 /**

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

@@ -4,5 +4,6 @@ import type { IKeywords } from './IKeywords';
  *
  * @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/removeDiacritics.d.ts

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

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

@@ -7,9 +7,10 @@
  * @returns parsed number
  * @throws {ParsingError} if the value is not a number
  *
- * @private within the parseCommand
+ * @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/random/randomSeed.d.ts

@@ -3,5 +3,6 @@ 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

@@ -3,5 +3,6 @@
  *
  * @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/removeQuotes.d.ts

@@ -9,5 +9,6 @@
  *
  * @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/replaceParameters.d.ts

@@ -7,5 +7,6 @@ import type { string_template } from '../types/typeAliases';
  * @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/sets/difference.d.ts

@@ -2,6 +2,7 @@
  * 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>;
 /**

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

@@ -2,5 +2,6 @@
  * 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/union.d.ts

@@ -2,5 +2,6 @@
  * 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/trimCodeBlock.d.ts

@@ -4,5 +4,6 @@
  * 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/trimEndOfCodeBlock.d.ts

@@ -3,5 +3,7 @@
  *
  * 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/unwrapResult.d.ts

@@ -28,6 +28,7 @@ interface UnwrapResultOptions {
  *
  * @param text optionally quoted text
  * @returns text without quotes
+ * @public exported from `@promptbook/utils`
  */
 export declare function unwrapResult(text: string, options?: UnwrapResultOptions): string;
 export {};

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

@@ -4,5 +4,6 @@ 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/javascriptName/isValidJavascriptName.d.ts

@@ -1,3 +1,10 @@
 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/semanticVersion/isValidPromptbookVersion.d.ts

@@ -9,5 +9,7 @@ import type { really_unknown } from '../../organization/really_unknown';
  * 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/isValidSemanticVersion.d.ts

@@ -6,5 +6,7 @@ import type { really_unknown } from '../../organization/really_unknown';
  * 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/url/isHostnameOnPrivateNetwork.d.ts

@@ -5,5 +5,7 @@ import type { string_hostname } from '../../../types/typeAliases';
  * 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/isUrlOnPrivateNetwork.d.ts

@@ -8,5 +8,6 @@ import type { string_url } from '../../../types/typeAliases';
  *
  * @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/isValidPipelineUrl.d.ts

@@ -6,6 +6,8 @@ import type { really_unknown } from '../../organization/really_unknown';
  * 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;
 /**

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

@@ -7,5 +7,7 @@ import type { really_unknown } from '../../organization/really_unknown';
  * 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/uuid/isValidUuid.d.ts

@@ -2,5 +2,7 @@ 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/version.d.ts

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