@promptbook/openai 0.61.0-9 → 0.62.0-0

package/esm/typings/src/types/typeAliases.d.ts

@@ -1,3 +1,4 @@
+import { RESERVED_PARAMETER_NAMES } from '../config';
 /**
  * Semantic helper
  */
@@ -17,7 +18,7 @@ export type string_prompt = string;
 /**
  * Semantic helper
  *
- * For example `"A cat wearing a {ITEM}"`
+ * For example `"A cat wearing a {item}"`
  */
 export type string_template = string;
 /**
@@ -32,6 +33,12 @@ export type string_text_prompt = string_prompt;
  * For example `"How many hats does the cat wear?"`
  */
 export type string_chat_prompt = string_text_prompt;
+/**
+ * Semantic helper
+ *
+ * For example `"You are an AI assistant. You are here to help me with my work."`
+ */
+export type string_system_message = string_text_prompt;
 /**
  * Semantic helper
  *
@@ -73,6 +80,42 @@ export type string_char = string;
  * For example `"ainautes"`
  */
 export type string_name = string;
+/**
+ * Semantic helper
+ * Unique identifier of anything
+ *
+ * For example `"eventName"`
+ */
+export type string_parameter_name = string_name;
+/**
+ * Semantic helper
+ * Unique identifier of parameter
+ *
+ * For example `"DevConf 2024"`
+ */
+export type string_parameter_value = string;
+/**
+ * Parameters of the pipeline
+ *
+ * There are three types of parameters:
+ * - **INPUT PARAMETERs** are required to execute the pipeline.
+ * - **Intermediate parameters** are used internally in the pipeline.
+ * - **OUTPUT PARAMETERs** are not used internally in the pipeline, but are returned as the result of the pipeline execution.
+ *
+ * @see https://ptbk.io/parameters
+ */
+export type Parameters = Exclude<Record<string_parameter_name, string_parameter_value>, ReservedParameters>;
+/**
+ * Semantic helper
+ * Unique identifier of reserved parameter
+ *
+ * For example `"context"`
+ */
+export type string_reserved_parameter_name = typeof RESERVED_PARAMETER_NAMES[number];
+/**
+ * @@@
+ */
+export type ReservedParameters = Record<string_reserved_parameter_name, string_parameter_value>;
 /**
  * Semantic helper
  * Title of anything
@@ -80,6 +123,36 @@ export type string_name = string;
  * For example `"Ai*nautes"`
  */
 export type string_title = string;
+/**
+ * Description of persona
+ *
+ * For example `"Skilled copywriter"`
+ */
+export type string_persona_description = string;
+/**
+ * Source of one knowledge
+ *
+ * It can be a link, a relative path to file or direct text
+ *
+ * For example `"https://pavolhejny.com/"`
+ * For example `"./pavol-hejny-cv.pdf"`
+ * For example `"Pavol Hejný has web https://pavolhejny.com/"`
+ * For example `"Pavol Hejný is web developer and creator of Promptbook and Collboard"`
+ *
+ * @@@ string_knowledge_source vs string_knowledge_source_link
+ */
+export type string_knowledge_source = string_knowledge_source_link | string_markdown;
+/**
+ * One link to knowledge source
+ *
+ * It can be a link or relative path
+ *
+ * For example `"https://pavolhejny.com/"`
+ * For example `"./pavol-hejny-cv.pdf"`
+ *
+ * @@@ string_knowledge_source vs string_knowledge_source_link
+ */
+export type string_knowledge_source_link = string_url | string_file_path;
 /**
  * Semantic helper
  *
@@ -123,6 +196,10 @@ export type string_markdown_section_content = string;
  * For example `"**Hello** World!"`
  */
 export type string_markdown_text = string;
+/**
+ * @@@
+ */
+export type string_promptbook_documentation_url = `https://github.com/webgptorg/promptbook/discussions/${number | '@@'}`;
 /**
  * Semantic helper
  *
@@ -159,6 +236,17 @@ export type string_script = string;
  * For example `console.info("Hello World!")`
  */
 export type string_javascript = string;
+/**
+ * Semantic helper for JSON strings
+ *
+ * Note: TType is a type of the JSON object inside the string
+ *
+ * For example `{"foo": "bar"}`
+ */
+export type string_json<TType> = string & {
+    _type: 'string_json';
+    scheme: TType;
+};
 /**
  * Semantic helper
  *
@@ -428,6 +516,14 @@ export type string_date_iso8601 = `${number}-${number}-${number}${string}${numbe
  * Semantic helper for US Dollars
  */
 export type number_usd = number;
+/**
+ * Semantic helper for incremental IDs
+ */
+export type number_id = number_integer & (number_positive | 0);
+/**
+ * Semantic helper for number of rows and columns
+ */
+export type number_linecol_number = number_integer & number_positive;
 /**
  * Semantic helper for number of tokens
  */
@@ -437,9 +533,22 @@ export type number_negative = number;
 export type number_integer = number;
 /**
  * Semantic helper;
- * Percentage from 0 to 1 (100%)
+ * Percentage from 0 to 1 (100%) (and bellow and above)
  */
 export type number_percent = number;
+/**
+ * Semantic helper;
+ * Model temperature
+ */
+export type number_model_temperature = number_percent;
+/**
+ * Semantic helper;
+ * Seed for random generator
+ *
+ * Percentage from 0 to 1 (100%)
+ * TODO: Is seed (in OpenAI) number from 0 to 1?
+ */
+export type number_seed = number_percent;
 /**
  * Likeness of the wallpaper
  *
@@ -462,19 +571,9 @@ export type number_kilobytes = number_positive;
 export type number_megabytes = number_positive;
 export type number_gigabytes = number_positive;
 export type number_terabytes = number_positive;
-/**
- * Formatting helper to put void to keep longer version of prettier
- */
-export type ___ = never;
-/**
- * Organizational helper to better mark the place where the type is missing
- */
-export type TODO = any;
-/**
- * Organizational helper to mark a place where to really use any
- */
-export type really_any = any;
-/**
+/**.
+ * TODO: !!! Change "For example" to @example
  * TODO: !! Cleanup
  * TODO: !! Change to branded types
+ * TODO: [📂] Export all this file through `@promptbook/types`
  */

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

@@ -5,15 +5,15 @@ export type FromtoItems = Array<{
     /**
      * The title of the item
      */
-    title: string;
+    readonly title: string;
     /**
      * The start of the item
      *
      * This can mean anything, like seconds, milliseconds, dollars, etc.
      */
-    from: number;
+    readonly from: number;
     /**
      * The end of the item
      */
-    to: number;
+    readonly to: number;
 }>;

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

@@ -0,0 +1,7 @@
+import type { string_date_iso8601 } from '../types/typeAliases';
+/**
+ * Simple wrapper `new Date().toISOString()`
+ *
+ * @returns string_date branded type
+ */
+export declare function $currentDate(): string_date_iso8601;

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

@@ -0,0 +1,9 @@
+import type { WritableDeep } from 'type-fest';
+/**
+ * @@@
+ */
+export declare function deepClone<TObject>(objectValue: TObject): WritableDeep<TObject>;
+/**
+ * TODO: [🔼] Export from `@promptbook/utils`
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
+ */

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

@@ -0,0 +1,22 @@
+import type { ReadonlyDeep } from 'type-fest';
+/**
+ * @@@
+ *
+ * @returns The same object as the input, but deeply frozen
+ *
+ * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ */
+export declare function deepFreeze<TObject>(objectValue: TObject): ReadonlyDeep<TObject>;
+/**
+ * @@@
+ * @@@
+ *
+ * @returns The same object as the input, but deeply frozen
+ *
+ * Note: This function mutates the object and returns the original (but mutated-deep-freezed) object
+ */
+export declare function deepFreezeWithSameType<TObject>(objectValue: TObject): TObject;
+/**
+ * TODO: [🔼] Export from `@promptbook/utils`
+ * TODO: [🧠] Is there a way how to meaningfully test this utility
+ */

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

@@ -5,7 +5,7 @@ import type { string_char_emoji } from '../types/typeAliasEmoji';
  *
  * @see https://getemoji.com/
  *
- * @private within the package
+ * @private within the repository
  * @deprecated Use /\p{Extended_Pictographic}/ instead
  */
 export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoji>>;
@@ -13,7 +13,7 @@ export declare const EMOJIS_IN_CATEGORIES: Record<string, Array<string_char_emoj
  *
  * All possible emoji chars like "🍆", "🍡", "🍤"...
  *
- * @private within the package
+ * @private within the repository
  * @deprecated Use /\p{Extended_Pictographic}/ instead
  */
 export declare const EMOJIS: Set<string_char_emoji>;

package/esm/typings/src/utils/{extractParameters.d.ts → extractParameterNames.d.ts}

@@ -1,4 +1,4 @@
-import type { string_name } from '../types/typeAliases';
+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
@@ -6,4 +6,4 @@ import type { string_template } from '../types/typeAliases';
  * @param template the template with parameters in {curly} braces
  * @returns the list of parameter names
  */
-export declare function extractParameters(template: string_template): Set<string_name>;
+export declare function extractParameterNames(template: string_template): Set<string_parameter_name>;

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

@@ -1,6 +1,6 @@
 /**
  * Format either small or big number
  *
- * @private within the package
+ * @private within the repository
  */
 export declare function formatNumber(value: number): string;

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

@@ -10,3 +10,6 @@ export declare const isRunningInNode: Function;
  * Detects if the code is running in a web worker
  */
 export declare const isRunningInWebWorker: Function;
+/**
+ * TODO: [🔼] !!! Export via `@promptbook/utils`
+ */

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

@@ -3,9 +3,9 @@ import type { string_name } from '../../types/typeAliases';
 /**
  * Add or modify an auto-generated section in a markdown file
  *
- * @private within the package
+ * @private within the repository
  */
 export declare function addAutoGeneratedSection(content: string_markdown, options: {
-    sectionName: string_name;
-    sectionContent: string_markdown;
+    readonly sectionName: string_name;
+    readonly sectionContent: string_markdown;
 }): string_markdown;

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

@@ -1,37 +1,34 @@
 import type { string_markdown } from '../../types/typeAliases';
 import type { FromtoItems } from '../FromtoItems';
 /**
- * Options for creating a markdown chart
- */
-/**
- * Options for creating a markdown chart.
+ * Options for `CreateMarkdownChartOptions`
  */
 type CreateMarkdownChartOptions = {
     /**
      * The header for the first column - the name of the item
      */
-    nameHeader: string;
+    readonly nameHeader: string;
     /**
      * The header for the second column - the value of the item
      */
-    valueHeader: string;
+    readonly valueHeader: string;
     /**
      * The items to be charted
      */
-    items: FromtoItems;
+    readonly items: FromtoItems;
     /**
      * The width of the chart in squares
      */
-    width: number;
+    readonly width: number;
     /**
      * The name of the unit shown in the chart
      */
-    unitName: string;
+    readonly unitName: string;
 };
 /**
  * Function createMarkdownChart will draw a chart in markdown from ⬛+🟦 tiles
  *
- * @private within the package
+ * @private within the repository
  */
 export declare function createMarkdownChart(options: CreateMarkdownChartOptions): string_markdown;
 export {};

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

@@ -3,6 +3,6 @@ import type { string_markdown_text } from '../../types/typeAliases';
 /**
  * Create a markdown table from a 2D array of strings
  *
- * @private within the package
+ * @private within the repository
  */
 export declare function createMarkdownTable(table: Array<Array<string_markdown_text>>): string_markdown;

package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown-real.test.d.ts

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

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

@@ -3,14 +3,18 @@ import type { string_markdown } from '../../types/typeAliases';
  * Single code block inside markdown.
  */
 export type CodeBlock = {
+    /**
+     * Which notation was used to open the code block
+     */
+    readonly blockNotation: '```' | '>';
     /**
      * Language of the code block OR null if the language is not specified in opening ```
      */
-    language: string | null;
+    readonly language: string | null;
     /**
      * Content of the code block (unescaped)
      */
-    content: string;
+    readonly content: string;
 };
 /**
  * Extracts all code blocks from markdown.
@@ -25,3 +29,6 @@ export type CodeBlock = {
  *
  */
 export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): Array<CodeBlock>;
+/**
+ * TODO: Maybe name for `blockNotation` instead of  '```' and '>'
+ */

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

@@ -15,5 +15,5 @@ import type { CodeBlock } from './extractAllBlocksFromMarkdown';
  */
 export declare function extractOneBlockFromMarkdown(markdown: string_markdown): CodeBlock;
 /***
- * TODO: [🍓][🌻] !!! Decide of this is internal util, external util OR validator/postprocessor
+ * TODO: [🍓][🌻] Decide of this is internal util, external util OR validator/postprocessor
  */

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

@@ -8,15 +8,15 @@ export type MarkdownSection = {
     /**
      * Title of the section
      */
-    title: string_markdown_text;
+    readonly title: string_markdown_text;
     /**
      * Level of the section like h1, h2, h3, h4, h5, h6
      */
-    level: 1 | 2 | 3 | 4 | 5 | 6;
+    readonly level: 1 | 2 | 3 | 4 | 5 | 6;
     /**
      * Content of the section with markdown formatting, blocks, lists, etc.
      */
-    content: string_markdown_section_content;
+    readonly content: string_markdown_section_content;
 };
 /**
  * Parses markdown section to title its level and content

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

@@ -1,3 +1,4 @@
+import type { really_unknown } from '../organization/really_unknown';
 import type { IKeywords } from './IKeywords';
 /**
  * Parses keywords from any object and recursively walks through
@@ -7,7 +8,7 @@ import type { IKeywords } from './IKeywords';
  * @param input of any kind
  * @returns {Set} of keywords without diacritics in lowercase
  */
-export declare function parseKeywords(input: unknown): IKeywords;
+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/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_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/___.d.ts

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

package/{umd/typings/src/utils → esm/typings/src/utils/organization}/just.d.ts

@@ -2,9 +2,13 @@
  * Returns the same value that is passed as argument.
  * No side effects.
  *
- * Note: It can be usefull for leveling indentation
+ * 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

@@ -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/random/randomSeed.d.ts

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

package/esm/typings/src/{execution/utils → utils}/replaceParameters.d.ts

@@ -1,5 +1,5 @@
-import type { Parameters } from '../../types/Parameters';
-import type { string_template } from '../../types/typeAliases';
+import type { Parameters } from '../types/typeAliases';
+import type { string_template } from '../types/typeAliases';
 /**
  * Replaces parameters in template with values from parameters object
  *
@@ -7,7 +7,5 @@ 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
- *
- * @private within the createPipelineExecutor
  */
 export declare function replaceParameters(template: string_template, parameters: Parameters): string;

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

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

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

@@ -4,3 +4,6 @@
  * @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
+ */

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

@@ -1,5 +1,6 @@
 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: unknown): email is string_email;
+export declare function isValidEmail(email: really_unknown): email is string_email;

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

@@ -1,7 +1,8 @@
 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
  */
-export declare function isValidFilePath(filePath: unknown): filePath is string_file_path;
+export declare function isValidFilePath(filePath: really_unknown): filePath is string_file_path;

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

@@ -1,2 +1,3 @@
 import type { string_javascript_name } from '../../../types/typeAliases';
-export declare function isValidJavascriptName(javascriptName: unknown): javascriptName is string_javascript_name;
+import type { really_unknown } from '../../organization/really_unknown';
+export declare function isValidJavascriptName(javascriptName: really_unknown): javascriptName is string_javascript_name;

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

@@ -1,4 +1,5 @@
 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.
@@ -9,4 +10,4 @@ import type { string_promptbook_version } from '../../../version';
  * - `isValidSemanticVersion` which tests any semantic version
  * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
  */
-export declare function isValidPromptbookVersion(version: unknown): version is string_promptbook_version;
+export declare function isValidPromptbookVersion(version: really_unknown): version is string_promptbook_version;

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

@@ -1,4 +1,5 @@
 import type { string_semantic_version } from '../../../types/typeAliases';
+import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid semantic version
  *
@@ -6,4 +7,4 @@ import type { string_semantic_version } from '../../../types/typeAliases';
  * - `isValidSemanticVersion` which tests any semantic version
  * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
  */
-export declare function isValidSemanticVersion(version: unknown): version is string_semantic_version;
+export declare function isValidSemanticVersion(version: really_unknown): version is string_semantic_version;

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

@@ -1,4 +1,5 @@
 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.
  *
@@ -6,7 +7,7 @@ import type { string_pipeline_url } from '../../../types/typeAliases';
  * - `isValidUrl` which tests any URL
  * - `isValidPipelineUrl` *(this one)* which tests just pipeline URL
  */
-export declare function isValidPipelineUrl(url: unknown): url is string_pipeline_url;
+export declare function isValidPipelineUrl(url: really_unknown): url is string_pipeline_url;
 /**
  * TODO: [🐠] Maybe more info why the URL is invalid
  */