@promptbook/openai 0.61.0-9 → 0.61.0

package/esm/typings/src/_packages/utils.index.d.ts

@@ -1,12 +1,13 @@
 import { spaceTrim } from 'spacetrim';
 import { renderPromptbookMermaid } from '../conversion/prettify/renderPipelineMermaidOptions';
-import { extractParametersFromPromptTemplate } from '../conversion/utils/extractParametersFromPromptTemplate';
+import { extractParameterNamesFromPromptTemplate } from '../conversion/utils/extractParameterNamesFromPromptTemplate';
 import { extractVariables } from '../conversion/utils/extractVariables';
 import { renameParameter } from '../conversion/utils/renameParameter';
 import { titleToName } from '../conversion/utils/titleToName';
 import { forEachAsync } from '../execution/utils/forEachAsync';
-import { replaceParameters } from '../execution/utils/replaceParameters';
 import { isValidJsonString } from '../formats/json/utils/isValidJsonString';
+import { extractBlock } from '../postprocessing/utils/extractBlock';
+import { $currentDate } from '../utils/currentDate';
 import { countCharacters } from '../utils/expectation-counters/countCharacters';
 import { countLines } from '../utils/expectation-counters/countLines';
 import { countPages } from '../utils/expectation-counters/countPages';
@@ -14,7 +15,7 @@ import { countParagraphs } from '../utils/expectation-counters/countParagraphs';
 import { countSentences, splitIntoSentences } from '../utils/expectation-counters/countSentences';
 import { countWords } from '../utils/expectation-counters/countWords';
 import { CountUtils } from '../utils/expectation-counters/index';
-import { extractParameters } from '../utils/extractParameters';
+import { extractParameterNames } from '../utils/extractParameterNames';
 import { DIACRITIC_VARIANTS_LETTERS } from '../utils/normalization/DIACRITIC_VARIANTS_LETTERS';
 import type { IKeywords, string_keyword } from '../utils/normalization/IKeywords';
 import { capitalize } from '../utils/normalization/capitalize';
@@ -33,9 +34,10 @@ import { parseKeywordsFromString } from '../utils/normalization/parseKeywordsFro
 import { removeDiacritics } from '../utils/normalization/removeDiacritics';
 import { searchKeywords } from '../utils/normalization/searchKeywords';
 import { parseNumber } from '../utils/parseNumber';
-import { extractBlock } from '../utils/postprocessing/extractBlock';
+import { $randomSeed } from '../utils/random/randomSeed';
 import { removeEmojis } from '../utils/removeEmojis';
 import { removeQuotes } from '../utils/removeQuotes';
+import { replaceParameters } from '../utils/replaceParameters';
 import { difference } from '../utils/sets/difference';
 import { intersection } from '../utils/sets/intersection';
 import { union } from '../utils/sets/union';
@@ -53,9 +55,10 @@ import { isValidUrl } from '../utils/validators/url/isValidUrl';
 import { isValidUuid } from '../utils/validators/uuid/isValidUuid';
 import { PROMPTBOOK_VERSION } from '../version';
 export { forEachAsync, PROMPTBOOK_VERSION };
-export { extractBlock, // <- [🌻] + maybe export through `@promptbook/markdown-utils`
-extractParameters, extractVariables, isHostnameOnPrivateNetwork, isUrlOnPrivateNetwork, isValidFilePath, isValidJavascriptName, isValidJsonString, isValidPipelineUrl as isValidPipelineUrl, isValidPromptbookVersion, isValidSemanticVersion, isValidUrl, isValidUuid, parseNumber, // <- [🌻]
-removeEmojis, removeQuotes, replaceParameters, spaceTrim, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
+export { extractParameterNames, extractVariables, replaceParameters, spaceTrim };
+export { $currentDate, $randomSeed, extractBlock, // <- [🌻] + maybe export through `@promptbook/markdown-utils`
+isHostnameOnPrivateNetwork, isUrlOnPrivateNetwork, isValidFilePath, isValidJavascriptName, isValidJsonString, isValidPipelineUrl, isValidPromptbookVersion, isValidSemanticVersion, isValidUrl, isValidUuid, parseNumber, // <- [🌻]
+removeEmojis, removeQuotes, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 export { countCharacters, countLines, countPages, countParagraphs, countSentences, CountUtils, countWords };
 export { splitIntoSentences };
 export declare const normalizeTo: {
@@ -67,7 +70,7 @@ export declare const normalizeTo: {
 };
 export { capitalize, decapitalize, DIACRITIC_VARIANTS_LETTERS, IKeywords, isValidKeyword, nameToUriPart, nameToUriParts, normalizeTo_camelCase, normalizeTo_PascalCase, normalizeTo_SCREAMING_CASE, normalizeTo_snake_case, normalizeToKebabCase, normalizeWhitespaces, parseKeywords, parseKeywordsFromString, removeDiacritics, searchKeywords, string_keyword, titleToName, };
 export type { string_camelCase, string_kebab_case, string_PascalCase, string_SCREAMING_CASE, string_snake_case };
-export { extractParametersFromPromptTemplate, renameParameter, renderPromptbookMermaid };
+export { extractParameterNamesFromPromptTemplate, renameParameter, renderPromptbookMermaid };
 export { difference, intersection, union };
 /**
  * Note: [🕙] It does not make sence to have simple lower / UPPER case normalization

package/esm/typings/src/cli/cli-commands/hello.d.ts

@@ -5,3 +5,6 @@ import type { Command as Program } from 'commander';
  * @private part of `promptbookCli`
  */
 export declare function initializeHelloCommand(program: Program): void;
+/**
+ * Note: [🟡] This code should never be published outside of `@promptbook/cli`
+ */ 

package/esm/typings/src/cli/cli-commands/make.d.ts

@@ -5,3 +5,6 @@ import type { Command as Program } from 'commander';
  * @private part of `promptbookCli`
  */
 export declare function initializeMakeCommand(program: Program): void;
+/**
+ * Note: [🟡] This code should never be published outside of `@promptbook/cli`
+ */

package/esm/typings/src/cli/cli-commands/prettify.d.ts

@@ -5,3 +5,6 @@ import type { Command as Program } from 'commander';
  * @private part of `promptbookCli`
  */
 export declare function initializePrettifyCommand(program: Program): void;
+/**
+ * Note: [🟡] This code should never be published outside of `@promptbook/cli`
+ */

package/esm/typings/src/cli/promptbookCli.d.ts

@@ -6,4 +6,5 @@ export declare function promptbookCli(): Promise<void>;
  * TODO: [🥠] Do not export to utils directly, its just for CLI script
  * TODO: [🕌] When more functionalities, rename
  * Note: 11:11
+ * Note: [🟡] This code should never be published outside of `@promptbook/cli`
  */

package/esm/typings/src/collection/PipelineCollection.d.ts

@@ -5,7 +5,7 @@ import type { string_pipeline_url } from '../types/typeAliases';
 /**
  * Collection that groups together pipelines, knowledge, personas, tools and actions
  *
- * @see !!! https://github.com/webgptorg/pipeline#pipeline-collection
+ * @see @@@ https://github.com/webgptorg/pipeline#pipeline-collection
  */
 export type PipelineCollection = {
     /**

package/esm/typings/src/collection/SimplePipelineCollection.d.ts

@@ -3,36 +3,36 @@ import type { Prompt } from '../types/Prompt';
 import type { string_pipeline_url } from '../types/typeAliases';
 import type { PipelineCollection } from './PipelineCollection';
 /**
- * Library of promptbooks that groups together promptbooks for an application.
- * This implementation is a very thin wrapper around the Array / Map of promptbooks.
+ * Library of pipelines that groups together pipelines for an application.
+ * This implementation is a very thin wrapper around the Array / Map of pipelines.
  *
  * @private use `createCollectionFromJson` instead
- * @see https://github.com/webgptorg/promptbook#promptbook-collection
+ * @see https://github.com/webgptorg/pipeline#pipeline-collection
  */
 export declare class SimplePipelineCollection implements PipelineCollection {
     private collection;
     /**
-     * Constructs a pipeline collection from promptbooks
+     * Constructs a pipeline collection from pipelines
      *
-     * @param promptbooks !!!
+     * @param pipelines @@@
      *
      * @private Use instead `createCollectionFromJson`
-     * Note: During the construction logic of all promptbooks are validated
+     * Note: During the construction logic of all pipelines are validated
      * Note: It is not recommended to use this constructor directly, use `createCollectionFromJson` *(or other variant)* instead
      */
-    constructor(...promptbooks: Array<PipelineJson>);
+    constructor(...pipelines: Array<PipelineJson>);
     /**
-     * Gets all promptbooks in the collection
+     * Gets all pipelines in the collection
      */
     listPipelines(): Array<string_pipeline_url>;
     /**
-     * Gets promptbook by its URL
+     * Gets pipeline by its URL
      *
      * Note: This is not a direct fetching from the URL, but a lookup in the collection
      */
     getPipelineByUrl(url: string_pipeline_url): PipelineJson;
     /**
-     * Checks whether given prompt was defined in any promptbook in the collection
+     * Checks whether given prompt was defined in any pipeline in the collection
      */
     isResponsibleForPrompt(prompt: Prompt): boolean;
 }

package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts

@@ -6,7 +6,7 @@ import type { PipelineCollection } from '../PipelineCollection';
  */
 type CreatePipelineCollectionFromDirectoryOptions = PipelineStringToJsonOptions & {
     /**
-     * If true, the directory is searched recursively for promptbooks
+     * If true, the directory is searched recursively for pipelines
      *
      * @default true
      */
@@ -24,24 +24,24 @@ type CreatePipelineCollectionFromDirectoryOptions = PipelineStringToJsonOptions
      */
     isLazyLoaded?: boolean;
     /**
-     * If true, whole collection creation crashes on error in any promptbook
-     * If true and isLazyLoaded is true, the error is thrown on first access to the promptbook
+     * If true, whole collection creation crashes on error in any pipeline
+     * If true and isLazyLoaded is true, the error is thrown on first access to the pipeline
      *
      * @default true
      */
-    isCrashOnError?: boolean;
+    isCrashedOnError?: boolean;
 };
 /**
- * Constructs Promptbook from given directory
+ * Constructs Pipeline from given directory
  *
  * Note: Works only in Node.js environment because it reads the file system
  *
- * @param path - path to the directory with promptbooks
+ * @param path - path to the directory with pipelines
  * @param options - Misc options for the collection
  * @returns PipelineCollection
  */
 export declare function createCollectionFromDirectory(path: string_folder_path, options?: CreatePipelineCollectionFromDirectoryOptions): Promise<PipelineCollection>;
 export {};
 /**
- * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
+ * Note: [🟢] This code should never be published outside of `@pipeline/node`
  */

package/esm/typings/src/collection/constructors/createCollectionFromUrl.d.ts

@@ -9,13 +9,13 @@ type CreatePipelineCollectionFromUrlyOptions = {
      *
      * @default false
      */
-    isVerbose?: boolean;
+    readonly isVerbose?: boolean;
     /**
      * If true, directory will be scanned only when needed not during the construction
      *
      * @default false
      */
-    isLazyLoaded?: boolean;
+    readonly isLazyLoaded?: boolean;
 };
 /**
  * Constructs Promptbook from remote Promptbase URL

package/esm/typings/src/commands/KNOWLEDGE/KnowledgeCommand.d.ts

@@ -1,5 +1,4 @@
-import type { string_file_relative_path } from '../../types/typeAliases';
-import type { string_url } from '../../types/typeAliases';
+import type { string_knowledge_source } from '../../types/typeAliases';
 /**
  * Parsed KNOWLEDGE command
  *
@@ -8,5 +7,5 @@ import type { string_url } from '../../types/typeAliases';
  */
 export type KnowledgeCommand = {
     readonly type: 'KNOWLEDGE';
-    readonly source: string_url | string_file_relative_path;
+    readonly source: string_knowledge_source;
 };

package/esm/typings/src/commands/MODEL/ModelCommand.d.ts

@@ -1,5 +1,5 @@
 import type { ModelRequirements } from '../../types/ModelRequirements';
-import type { TODO } from '../../types/typeAliases';
+import type { TODO_any } from '../../utils/organization/TODO_any';
 /**
  * Parsed MODEL command
  *
@@ -9,5 +9,5 @@ import type { TODO } from '../../types/typeAliases';
 export type ModelCommand = {
     readonly type: 'MODEL';
     readonly key: keyof ModelRequirements;
-    readonly value: TODO;
+    readonly value: TODO_any;
 };

package/esm/typings/src/commands/PERSONA/PersonaCommand.d.ts

@@ -1,3 +1,5 @@
+import type { string_name } from '../../types/typeAliases';
+import type { string_persona_description } from '../../types/typeAliases';
 /**
  * Parsed PERSONA command
  *
@@ -6,6 +8,6 @@
  */
 export type PersonaCommand = {
     readonly type: 'PERSONA';
-    personaName: string;
-    personaDescription: string | null;
+    readonly personaName: string_name;
+    readonly personaDescription: string_persona_description | null;
 };

package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts

@@ -9,4 +9,5 @@ import type { BoilerplateCommand } from './BoilerplateCommand';
 export declare const boilerplateCommandParser: CommandParser<BoilerplateCommand>;
 /**
  * TODO: [💐] Implement BOILERPLATE command into `pipelineStringToJsonSync` function
+ * Note: [⚪] This should never be in any released package
  */

package/esm/typings/src/commands/_common/types/CommandParser.d.ts

@@ -1,33 +1,61 @@
+import type { WritableDeep } from 'type-fest';
+import type { PromptTemplateJson } from '../../../types/PipelineJson/PromptTemplateJson';
+import type { PipelineJson } from '../../../types/PipelineJson/PipelineJson';
 import type { string_markdown_text } from '../../../types/typeAliases';
 import type { string_name } from '../../../types/typeAliases';
+import type { string_promptbook_documentation_url } from '../../../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../../../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { CommandUsagePlace } from './CommandUsagePlaces';
 export type CommandParser<TCommand extends {
     type: string_name & string_SCREAMING_CASE;
 }> = {
-    name: string_name & string_SCREAMING_CASE;
-    aliasNames?: Array<string_name & string_SCREAMING_CASE>;
-    deprecatedNames?: Array<string_name & string_SCREAMING_CASE>;
-    usagePlaces: Array<CommandUsagePlace>;
-    description: string_markdown_text;
-    discussionUrl: `https://github.com/webgptorg/promptbook/discussions/${number | '@@'}`;
-    examples: Array<string_markdown_text>;
+    readonly name: string_name & string_SCREAMING_CASE;
+    readonly aliasNames?: Array<string_name & string_SCREAMING_CASE>;
+    readonly deprecatedNames?: Array<string_name & string_SCREAMING_CASE>;
+    readonly usagePlaces: Array<CommandUsagePlace>;
+    readonly description: string_markdown_text;
+    readonly documentationUrl: string_promptbook_documentation_url;
+    readonly examples: Array<string_markdown_text>;
     /**
      * @throws {ParsingError} if the parsing fails
      */
     parse(input: CommandParserInput): TCommand;
+    /**
+     * @@@ Mutated by the command
+     */
+    applyToPipelineJson?(command: TCommand, subjects: ApplyToPipelineJsonSubjects): void;
 };
 export type CommandParserInput = {
-    usagePlace: CommandUsagePlace;
-    raw: string_markdown_text;
-    rawArgs: string_markdown_text;
-    normalized: string_name & string_SCREAMING_CASE;
-    args: Array<string_name & string_SCREAMING_CASE>;
+    readonly usagePlace: CommandUsagePlace;
+    readonly raw: string_markdown_text;
+    readonly rawArgs: string_markdown_text;
+    readonly normalized: string_name & string_SCREAMING_CASE;
+    readonly args: Array<string_name & string_SCREAMING_CASE>;
+};
+/**
+ * @@@ Mutated by the command
+ */
+export type ApplyToPipelineJsonSubjects = {
+    /**
+     * @@@ Mutated by the command
+     */
+    readonly pipelineJson: WritableDeep<PipelineJson>;
+    /**
+     * @@@
+     *
+     * @@@ Mutated by the command
+     *
+     * When used in
+     * - `PIPELINE_HEAD` it is `null`
+     * - `PIPELINE_TEMPLATE` it is the prompt template
+     */
+    readonly templateJson: null | Partial<WritableDeep<PromptTemplateJson>>;
 };
 /**
- * TODO: !!!! Annotate
+ * TODO: @@@ Annotate all
+ * TODO: [🍧][♓️] Add order here
  * TODO: [🧠] Maybe put flag if it is for whole `.ptbk.md` file of just one section
- * TODO: [🍧] CommandParser should have applyToPipelineJson method
+ * TODO: [🍧] All commands must implement `applyToPipelineJson` method
  *       which will apply parsed command to the pipeline JSON
  *       it will be called from `pipelineStringToJsonSync`
  *       and replace hardcoded switch statement and [💐]

package/esm/typings/src/config.d.ts

@@ -6,11 +6,56 @@ export declare const LOOP_LIMIT = 1000;
  * The maximum number of iterations for a loops which adds characters one by one
  */
 export declare const CHARACTER_LOOP_LIMIT = 100000;
+/**
+ * The maximum number of (LLM) tasks running in parallel
+ */
+export declare const MAX_PARALLEL_COUNT = 5;
+/**
+ * The maximum number of attempts to execute LLM task before giving up
+ */
+export declare const MAX_EXECUTION_ATTEMPTS = 3;
+/**
+ * The maximum length of the (generated) filename
+ */
+export declare const MAX_FILENAME_LENGTH = 30;
+/**
+ * @@@
+ * TODO: [🐝] !!! Use
+ */
+export declare const MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH = 3;
+/**
+ * @@@
+ * TODO: [🐝] !!! Use
+ */
+export declare const MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL = 200;
+/**
+ * Where to store the cache of executions for promptbook CLI
+ */
+export declare const EXECUTIONS_CACHE_DIRNAME = "/.promptbook/executions-cache";
 /**
  * The name of the builded pipeline collection made by CLI `ptbk make` and for lookup in `createCollectionFromDirectory`
  */
 export declare const PIPELINE_COLLECTION_BASE_FILENAME = "index";
+/**
+ * Nonce which is used for replacing things in strings
+ */
+export declare const REPLACING_NONCE = "u$k42k%!V2zo34w7Fu#@QUHYPW";
 /**
  * The names of the parameters that are reserved for special purposes
  */
-export declare const RESERVED_PARAMETER_NAMES: string[];
+export declare const RESERVED_PARAMETER_NAMES: readonly ["content", "context", "knowledge", "samples", "modelName", "currentDate"];
+/**
+ * @@@
+ */
+export declare const RESERVED_PARAMETER_MISSING_VALUE: string;
+/**
+ * @@@
+ */
+export declare const RESERVED_PARAMETER_RESTRICTED: string;
+/**
+ * @@@
+ */
+export declare const DEBUG_ALLOW_PAYED_TESTING: boolean;
+/**
+ * TODO: [🔼] Export all to core
+ */

package/esm/typings/src/config.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠] Maybe more elegant how to prevent accidental costs
+ */

package/esm/typings/src/conversion/pipelineJsonToString.d.ts

@@ -8,7 +8,7 @@ import type { PipelineString } from '../types/PipelineString';
  */
 export declare function pipelineJsonToString(pipelineJson: PipelineJson): PipelineString;
 /**
- * TODO: !!!!! Implement new features and commands into `promptTemplateParameterJsonToString`
+ * TODO: !!!! Implement new features and commands into `promptTemplateParameterJsonToString`
  * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
  * TODO: Escape all
  */

package/esm/typings/src/conversion/pipelineStringToJson.d.ts

@@ -2,20 +2,23 @@ import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
 import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
 import type { PipelineString } from '../types/PipelineString';
 /**
- * Options for pipelineStringToJson
+ * Options for `pipelineStringToJson`
  */
 export type PipelineStringToJsonOptions = {
     /**
-     * Tools for processing required for knowledge processing *(not for actual execution)*
+     * Tools for processing required for preparation of knowledge *(not for actual execution)*
+     *
+     * Note: If you provide `null`, the knowledge will not be prepared
      */
-    llmTools?: LlmExecutionTools;
+    readonly llmTools: LlmExecutionTools | null;
 };
 /**
- * Compile promptbook from string (markdown) format to JSON format
+ * Compile pipeline from string (markdown) format to JSON format
  *
- * Note: There are two similar functions:
+ * Note: There are 3 similar functions:
  * - `pipelineStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
  * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ * - `preparePipeline` - just one step in the compilation process
  *
  * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
  * @param options - Options and tools for the compilation
@@ -28,4 +31,5 @@ export type PipelineStringToJsonOptions = {
 export declare function pipelineStringToJson(pipelineString: PipelineString, options?: PipelineStringToJsonOptions): Promise<PipelineJson>;
 /**
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts

@@ -1,14 +1,14 @@
 import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
 import type { PipelineString } from '../types/PipelineString';
 /**
- * Compile promptbook from string (markdown) format to JSON format synchronously
+ * Compile pipeline from string (markdown) format to JSON format synchronously
  *
- * Note: There are two similar functions:
+ * Note: There are 3 similar functions:
  * - `pipelineStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
  * - `pipelineStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ * - `preparePipeline` - just one step in the compilation process
  *
  * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
- * @param options - Options and tools for the compilation
  * @returns {Promptbook} compiled in JSON format (.ptbk.json)
  * @throws {ParsingError} if the promptbook string is not valid
  *
@@ -22,4 +22,7 @@ export declare function pipelineStringToJsonSync(pipelineString: PipelineString)
  * TODO: Use spaceTrim more effectively
  * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
  * TODO: [🥞] Not optimal parsing because `splitMarkdownIntoSections` is executed twice with same string, once through `flattenMarkdown` and second directly here
+ * TODO: [♈] Probbably move expectations from templates to parameters
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
+ * TODO: [🍙] Make some standart order of json properties
  */

package/esm/typings/src/conversion/prettify/PrettifyOptions.d.ts

@@ -5,9 +5,9 @@ export type PrettifyOptions = {
     /***
      * If true, adds Mermaid graph to the Promptbook string
      */
-    isGraphAdded?: boolean;
+    readonly isGraphAdded?: boolean;
     /**
      * If true, the string is prettifyed as markdown
      */
-    isPrettifyed?: boolean;
+    readonly isPrettifyed?: boolean;
 };

package/{umd/typings/src/conversion/utils/extractParametersFromPromptTemplate.d.ts → esm/typings/src/conversion/utils/extractParameterNamesFromPromptTemplate.d.ts}

@@ -1,5 +1,5 @@
 import type { PromptTemplateJson } from '../../types/PipelineJson/PromptTemplateJson';
-import type { string_name } from '../../types/typeAliases';
+import type { string_parameter_name } from '../../types/typeAliases';
 /**
  * Parses the prompt template and returns the set of all used parameters
  *
@@ -7,7 +7,7 @@ import type { string_name } from '../../types/typeAliases';
  * @returns the set of parameter names
  * @throws {ParsingError} if the script is invalid
  */
-export declare function extractParametersFromPromptTemplate(promptTemplate: Pick<PromptTemplateJson, 'title' | 'description' | 'blockType' | 'content'>): Set<string_name>;
+export declare function extractParameterNamesFromPromptTemplate(promptTemplate: Pick<PromptTemplateJson, 'title' | 'description' | 'blockType' | 'content' | 'preparedContent' | 'jokerParameterNames'>): Set<string_parameter_name>;
 /**
  * TODO: [🔣] If script require contentLanguage
  */

package/esm/typings/src/conversion/utils/renameParameter.d.ts

@@ -5,15 +5,15 @@ type RenameParameterOptions = {
      * Pipeline to search and replace for parameters
      * This pipeline is returned as copy with replaced parameters
      */
-    pipeline: PipelineJson;
+    readonly pipeline: PipelineJson;
     /**
      * Original parameter name that should be replaced
      */
-    oldParameterName: string_name;
+    readonly oldParameterName: string_name;
     /**
      * New parameter name that should replace the original parameter name
      */
-    newParameterName: string_name;
+    readonly newParameterName: string_name;
 };
 /**
  * Function renameParameter will find all usable parameters for given prompt template

package/esm/typings/src/conversion/utils/stringifyPipelineJson.d.ts

@@ -0,0 +1,14 @@
+import type { string_json } from '../../types/typeAliases';
+/**
+ * Stringify the PipelineJson with proper formatting
+ *
+ * Note: [0] It can be used for more JSON types like whole collection of pipelines, single knowledge piece, etc.
+ * Note: In contrast to JSON.stringify, this function ensures that **embedding index** is on single line
+ */
+export declare function stringifyPipelineJson<TType>(pipeline: TType): string_json<TType>;
+/**
+ * TODO: [🐝] Not Working propperly @see https://promptbook.studio/samples/mixed-knowledge.ptbk.md
+ * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
+ * TODO: [🧠] Maybe more elegant solution than replacing via regex
+ * TODO: [🍙] Make some standart order of json properties
+ */

package/esm/typings/src/conversion/validation/_importPipeline.d.ts

@@ -1,7 +1,8 @@
 import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
 import type { PipelineString } from '../../types/PipelineString';
+import type { string_json } from '../../types/typeAliases';
 /**
- * Import the text file
+ * Import the pipeline.ptbk.md or pipeline.ptbk.json file
  *
  * Note: Using here custom import to work in jest tests
  * Note: Using sync version is 💩 in the production code, but it's ok here in tests
@@ -9,5 +10,13 @@ import type { PipelineString } from '../../types/PipelineString';
  * @param path - The path to the file relative to samples/templates directory
  * @private
  */
-export declare function importPipeline(path: `${string}.ptbk.md`): PipelineString;
-export declare function importPipeline(path: `${string}.ptbk.json`): PipelineJson;
+export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.md`): PipelineString;
+export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.json`): PipelineJson;
+/**
+ * Import the pipeline.ptbk.json file as parsed JSON
+ */
+export declare function importPipelineJson(path: `${string}.ptbk.json`): PipelineJson;
+/**
+ * Import the pipeline.ptbk.json file as string
+ */
+export declare function importPipelineJsonAsString(path: `${string}.ptbk.json`): string_json<PipelineJson>;

package/esm/typings/src/conversion/validation/validatePipeline.d.ts

@@ -23,5 +23,14 @@ export declare function validatePipeline(pipeline: PipelineJson): PipelineJson;
  *     >  * It checks:
  *     >  * -   it has a valid structure
  *     >  * -   ...
- *     >  ex port function validatePipeline(promptbook: unknown): asserts promptbook is PipelineJson {
+ *     >  ex port function validatePipeline(promptbook: really_unknown): asserts promptbook is PipelineJson {
+ */
+/**
+ * TODO: [🐣] !!!! Validate that all samples match expectations
+ * TODO: [🐣][🐝] !!!! Validate that knowledge is valid (non-void)
+ * TODO: [🐣] !!!! Validate that persona can be used only with CHAT variant
+ * TODO: [🐣] !!!! Validate that parameter with reserved name not used RESERVED_PARAMETER_NAMES
+ * TODO: [🐣] !!!! Validate that reserved parameter is not used as joker
+ * TODO: [🧠] Validation not only logic itself but imports around - files and websites and rerefenced pipelines exists
+ * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
  */

package/esm/typings/src/errors/EnvironmentMismatchError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This error type indicates that you try to use a feature that is not available in the current environment
+ */
+export declare class EnvironmentMismatchError extends Error {
+    readonly name = "EnvironmentMismatchError";
+    constructor(message: string);
+}

package/esm/typings/src/errors/LimitReachedError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This error type indicates that some limit was reached
+ */
+export declare class LimitReachedError extends Error {
+    readonly name = "LimitReachedError";
+    constructor(message: string);
+}

package/esm/typings/src/errors/VersionMismatchError.d.ts

@@ -0,0 +1,8 @@
+import type { string_semantic_version } from '../types/typeAliases';
+/**
+ * This error type indicates that the version of the pipeline is not matching the expected version
+ */
+export declare class VersionMismatchError extends Error {
+    readonly name = "UnexpectedError";
+    constructor(message: string, expectedVersion: string_semantic_version);
+}

package/esm/typings/src/execution/CommonExecutionToolsOptions.d.ts

@@ -5,5 +5,6 @@ export type CommonExecutionToolsOptions = {
     readonly isVerbose?: boolean;
 };
 /**
+ * TODO: [🈁] Maybe add here `isDeterministic`
  * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
  */