@promptbook/openai 0.61.0-2 → 0.61.0-20

package/esm/typings/promptbook-collection/index.d.ts

@@ -9,30 +9,74 @@ declare const _default: ({
         isOutput: boolean;
     }[];
     promptTemplates: {
+        blockType: string;
         name: string;
         title: string;
-        dependentParameterNames: string[];
-        blockType: string;
         modelRequirements: {
             modelVariant: string;
             modelName: string;
         };
         content: string;
+        dependentParameterNames: string[];
         resultingParameterName: string;
     }[];
-    knowledge: {
-        name: string;
-        title: string;
-        content: string;
-        keywords: string[];
-        index: {
-            modelName: string;
-            position: number[];
-        }[];
-        sources: {
-            title: string;
-            href: string;
-        }[];
+    knowledgeSources: never[];
+    knowledgePieces: never[];
+    personas: never[];
+    preparations: {
+        id: number;
+        promptbookVersion: string;
+        modelUsage: {
+            price: {
+                value: number;
+            };
+            input: {
+                tokensCount: {
+                    value: number;
+                };
+                charactersCount: {
+                    value: number;
+                };
+                wordsCount: {
+                    value: number;
+                };
+                sentencesCount: {
+                    value: number;
+                };
+                linesCount: {
+                    value: number;
+                };
+                paragraphsCount: {
+                    value: number;
+                };
+                pagesCount: {
+                    value: number;
+                };
+            };
+            output: {
+                tokensCount: {
+                    value: number;
+                };
+                charactersCount: {
+                    value: number;
+                };
+                wordsCount: {
+                    value: number;
+                };
+                sentencesCount: {
+                    value: number;
+                };
+                linesCount: {
+                    value: number;
+                };
+                paragraphsCount: {
+                    value: number;
+                };
+                pagesCount: {
+                    value: number;
+                };
+            };
+        };
     }[];
     sourceFile: string;
 } | {
@@ -46,36 +90,162 @@ declare const _default: ({
         isOutput: boolean;
     }[];
     promptTemplates: {
+        blockType: string;
         name: string;
         title: string;
-        dependentParameterNames: string[];
-        blockType: string;
+        modelRequirements: {
+            modelVariant: string;
+            modelName: string;
+        };
+        content: string;
         expectations: {
             words: {
                 min: number;
                 max: number;
             };
         };
+        dependentParameterNames: string[];
+        resultingParameterName: string;
+    }[];
+    knowledgeSources: never[];
+    knowledgePieces: never[];
+    personas: never[];
+    preparations: {
+        id: number;
+        promptbookVersion: string;
+        modelUsage: {
+            price: {
+                value: number;
+            };
+            input: {
+                tokensCount: {
+                    value: number;
+                };
+                charactersCount: {
+                    value: number;
+                };
+                wordsCount: {
+                    value: number;
+                };
+                sentencesCount: {
+                    value: number;
+                };
+                linesCount: {
+                    value: number;
+                };
+                paragraphsCount: {
+                    value: number;
+                };
+                pagesCount: {
+                    value: number;
+                };
+            };
+            output: {
+                tokensCount: {
+                    value: number;
+                };
+                charactersCount: {
+                    value: number;
+                };
+                wordsCount: {
+                    value: number;
+                };
+                sentencesCount: {
+                    value: number;
+                };
+                linesCount: {
+                    value: number;
+                };
+                paragraphsCount: {
+                    value: number;
+                };
+                pagesCount: {
+                    value: number;
+                };
+            };
+        };
+    }[];
+    sourceFile: string;
+} | {
+    title: string;
+    pipelineUrl: string;
+    promptbookVersion: string;
+    parameters: {
+        name: string;
+        description: string;
+        isInput: boolean;
+        isOutput: boolean;
+    }[];
+    promptTemplates: {
+        blockType: string;
+        name: string;
+        title: string;
         modelRequirements: {
             modelVariant: string;
             modelName: string;
         };
         content: string;
+        expectFormat: string;
+        dependentParameterNames: string[];
         resultingParameterName: string;
     }[];
-    knowledge: {
-        name: string;
-        title: string;
-        content: string;
-        keywords: string[];
-        index: {
-            modelName: string;
-            position: number[];
-        }[];
-        sources: {
-            title: string;
-            href: string;
-        }[];
+    knowledgeSources: never[];
+    knowledgePieces: never[];
+    personas: never[];
+    preparations: {
+        id: number;
+        promptbookVersion: string;
+        modelUsage: {
+            price: {
+                value: number;
+            };
+            input: {
+                tokensCount: {
+                    value: number;
+                };
+                charactersCount: {
+                    value: number;
+                };
+                wordsCount: {
+                    value: number;
+                };
+                sentencesCount: {
+                    value: number;
+                };
+                linesCount: {
+                    value: number;
+                };
+                paragraphsCount: {
+                    value: number;
+                };
+                pagesCount: {
+                    value: number;
+                };
+            };
+            output: {
+                tokensCount: {
+                    value: number;
+                };
+                charactersCount: {
+                    value: number;
+                };
+                wordsCount: {
+                    value: number;
+                };
+                sentencesCount: {
+                    value: number;
+                };
+                linesCount: {
+                    value: number;
+                };
+                paragraphsCount: {
+                    value: number;
+                };
+                pagesCount: {
+                    value: number;
+                };
+            };
+        };
     }[];
     sourceFile: string;
 })[];

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

@@ -9,6 +9,7 @@ import { pipelineJsonToString } from '../conversion/pipelineJsonToString';
 import { pipelineStringToJson } from '../conversion/pipelineStringToJson';
 import { pipelineStringToJsonSync } from '../conversion/pipelineStringToJsonSync';
 import { prettifyPipelineString } from '../conversion/prettify/prettifyPipelineString';
+import { stringifyPipelineJson } from '../conversion/utils/stringifyPipelineJson';
 import { validatePipeline } from '../conversion/validation/validatePipeline';
 import { CollectionError } from '../errors/CollectionError';
 import { NotFoundError } from '../errors/NotFoundError';
@@ -17,6 +18,7 @@ import { PipelineExecutionError } from '../errors/PipelineExecutionError';
 import { PipelineLogicError } from '../errors/PipelineLogicError';
 import { ReferenceError } from '../errors/ReferenceError';
 import { UnexpectedError } from '../errors/UnexpectedError';
+import { VersionMismatchError } from '../errors/VersionMismatchError';
 import { ExpectError } from '../errors/_ExpectError';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
 import { createPipelineExecutor } from '../execution/createPipelineExecutor';
@@ -29,6 +31,8 @@ import type { CallbackInterfaceToolsOptions } from '../knowledge/dialogs/callbac
 import { SimplePromptInterfaceTools } from '../knowledge/dialogs/simple-prompt/SimplePromptInterfaceTools';
 import { prepareKnowledgeFromMarkdown } from '../knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown';
 import { joinLlmExecutionTools } from '../llm-providers/multiple/joinLlmExecutionTools';
+import { preparePipeline } from '../prepare/preparePipeline';
+import { unpreparePipeline } from '../prepare/unpreparePipeline';
 import type { ExecutionReportStringOptions } from '../types/execution-report/ExecutionReportStringOptions';
 import { ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
 import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
@@ -38,7 +42,8 @@ export { BlockTypes, RESERVED_PARAMETER_NAMES };
 export { addUsage, assertsExecutionSuccessful, checkExpectations, embeddingVectorToString, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prepareKnowledgeFromMarkdown, prettifyPipelineString, usageToWorktime, };
 export { collectionToJson, createCollectionFromJson, createCollectionFromPromise, createCollectionFromUrl, createSubcollection, };
 export { SimplePromptInterfaceTools };
-export { pipelineJsonToString, pipelineStringToJson, pipelineStringToJsonSync, validatePipeline };
+export { pipelineJsonToString, pipelineStringToJson, pipelineStringToJsonSync, stringifyPipelineJson, validatePipeline, };
+export { preparePipeline, unpreparePipeline };
 export { createPipelineExecutor, joinLlmExecutionTools };
 export { CallbackInterfaceTools, CallbackInterfaceToolsOptions };
-export { CollectionError, ExpectError, NotFoundError, ParsingError, PipelineExecutionError, PipelineLogicError, ReferenceError, UnexpectedError, };
+export { CollectionError, ExpectError, NotFoundError, ParsingError, PipelineExecutionError, PipelineLogicError, ReferenceError, UnexpectedError, VersionMismatchError, };

package/esm/typings/src/_packages/execute-javascript.index.d.ts

@@ -1,4 +1,5 @@
 import spaceTrim from 'spacetrim';
+import { extractBlock } from '../postprocessing/utils/extractBlock';
 import { JavascriptEvalExecutionTools } from '../scripting/javascript/JavascriptEvalExecutionTools';
 import { JavascriptExecutionTools } from '../scripting/javascript/JavascriptExecutionTools';
 import { prettifyMarkdown } from '../utils/markdown/prettifyMarkdown';
@@ -13,7 +14,6 @@ import { normalizeTo_camelCase } from '../utils/normalization/normalizeTo_camelC
 import { normalizeTo_snake_case } from '../utils/normalization/normalizeTo_snake_case';
 import { normalizeWhitespaces } from '../utils/normalization/normalizeWhitespaces';
 import { removeDiacritics } from '../utils/normalization/removeDiacritics';
-import { extractBlock } from '../utils/postprocessing/extractBlock';
 import { removeEmojis } from '../utils/removeEmojis';
 import { removeQuotes } from '../utils/removeQuotes';
 import { trimCodeBlock } from '../utils/trimCodeBlock';

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

@@ -1,4 +1,5 @@
 import { createCollectionFromDirectory } from '../collection/constructors/createCollectionFromDirectory';
+import { createLlmToolsFromEnv } from '../llm-providers/_common/createLlmToolsFromEnv';
 import { PROMPTBOOK_VERSION } from '../version';
 export { PROMPTBOOK_VERSION };
-export { createCollectionFromDirectory };
+export { createCollectionFromDirectory, createLlmToolsFromEnv };

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

@@ -5,17 +5,21 @@ import { EmbeddingVector } from '../execution/EmbeddingVector';
 import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { AvailableModel, LlmExecutionTools } from '../execution/LlmExecutionTools';
 import type { PipelineExecutor } from '../execution/PipelineExecutor';
-import type { PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptEmbeddingResult, PromptResult, PromptResultUsage, PromptResultUsageCounts, UncertainNumber } from '../execution/PromptResult';
+import type { ChatPromptResult, CommonPromptResult, CompletionPromptResult, EmbeddingPromptResult, PromptResult } from '../execution/PromptResult';
+import type { PromptResultUsage, PromptResultUsageCounts } from '../execution/PromptResultUsage';
 import type { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExecutionTools';
+import type { UncertainNumber } from '../execution/UncertainNumber';
 import type { UserInterfaceTools, UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
-import type { ModelRequirements, ModelVariant } from '../types/ModelRequirements';
-import type { Parameters } from '../types/Parameters';
+import type { ModelRequirements } from '../types/ModelRequirements';
+import type { ModelVariant } from '../types/ModelVariant';
 import type { ExpectationAmount, ExpectationUnit, Expectations } from '../types/PipelineJson/Expectations';
 import { EXPECTATION_UNITS } from '../types/PipelineJson/Expectations';
-import { KnowledgeJson } from '../types/PipelineJson/KnowledgeJson';
+import { KnowledgePiecePreparedJson } from '../types/PipelineJson/KnowledgePieceJson';
+import { KnowledgeSourceJson, KnowledgeSourcePreparedJson } from '../types/PipelineJson/KnowledgeSourceJson';
 import type { LlmTemplateJson } from '../types/PipelineJson/LlmTemplateJson';
-import { MaterialKnowledgePieceJson } from '../types/PipelineJson/MaterialKnowledgePieceJson';
+import { PersonaJson, PersonaPreparedJson } from '../types/PipelineJson/PersonaJson';
 import type { PipelineJson } from '../types/PipelineJson/PipelineJson';
+import { PreparationJson } from '../types/PipelineJson/PreparationJson';
 import type { PromptDialogJson } from '../types/PipelineJson/PromptDialogJson';
 import type { PromptTemplateJson } from '../types/PipelineJson/PromptTemplateJson';
 import type { PromptTemplateParameterJson } from '../types/PipelineJson/PromptTemplateParameterJson';
@@ -27,12 +31,12 @@ import type { ScriptLanguage } from '../types/ScriptLanguage';
 import type { TaskProgress } from '../types/TaskProgress';
 import type { ExecutionReportJson } from '../types/execution-report/ExecutionReportJson';
 import type { string_char_emoji } from '../types/typeAliasEmoji';
-import type { client_id, string_char, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_emails, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_pipeline_url, string_pipeline_url_with_hashtemplate, string_prompt, string_script, string_semantic_version, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_uuid } from '../types/typeAliases';
+import type { Parameters, ReservedParameters, client_id, number_model_temperature, number_seed, string_char, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_emails, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_parameter_name, string_parameter_value, string_person_fullname, string_pipeline_url, string_pipeline_url_with_hashtemplate, string_prompt, string_promptbook_documentation_url, string_reserved_parameter_name, string_script, string_semantic_version, string_sha256, string_system_message, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_uuid } from '../types/typeAliases';
 import type { FromtoItems } from '../utils/FromtoItems';
 import { PROMPTBOOK_VERSION, string_promptbook_version } from '../version';
 export { PROMPTBOOK_VERSION };
 export { EXPECTATION_UNITS };
-export type { AvailableModel, BlockType, CommonExecutionToolsOptions, EmbeddingVector, ExecutionReportJson, ExecutionTools, ExpectationAmount, ExpectationUnit, Expectations, FromtoItems, KnowledgeJson, LlmExecutionTools, LlmTemplateJson, MaterialKnowledgePieceJson, ModelRequirements, ModelVariant, Parameters, PipelineCollection, PipelineExecutor, PipelineJson, PipelineString, Prompt, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptEmbeddingResult, PromptResult, PromptResultUsage, PromptResultUsageCounts, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, TaskProgress, UncertainNumber, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, client_id, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_emails, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_pipeline_url, string_pipeline_url_with_hashtemplate, string_prompt, string_promptbook_version, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_uuid, string_semantic_version as string_version, };
+export type { AvailableModel, BlockType, CommonExecutionToolsOptions, EmbeddingVector, ExecutionReportJson, ExecutionTools, ExpectationAmount, ExpectationUnit, Expectations, FromtoItems, KnowledgePiecePreparedJson, KnowledgeSourceJson, KnowledgeSourcePreparedJson, LlmExecutionTools, LlmTemplateJson, ModelRequirements, ModelVariant, Parameters, PersonaJson, PersonaPreparedJson, PipelineCollection, PipelineExecutor, PipelineJson, PipelineString, PreparationJson, Prompt, ChatPromptResult as PromptChatResult, CommonPromptResult as PromptCommonResult, CompletionPromptResult as PromptCompletionResult, PromptDialogJson, EmbeddingPromptResult as PromptEmbeddingResult, PromptResult, PromptResultUsage, PromptResultUsageCounts, PromptTemplateJson, PromptTemplateParameterJson, ReservedParameters, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, TaskProgress, UncertainNumber, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, client_id, number_model_temperature, number_seed, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_emails, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_parameter_name, string_parameter_value, string_person_fullname, string_pipeline_url, string_pipeline_url_with_hashtemplate, string_prompt, string_promptbook_documentation_url, string_promptbook_version, string_reserved_parameter_name, string_script, string_semantic_version, string_sha256, string_system_message, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_uuid, };
 /**
  * TODO: Delete type aliases (from ../types/typeAliases) that are not exported here
  */

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

@@ -5,8 +5,9 @@ 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';
@@ -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 { extractParameters, 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: {
@@ -70,6 +73,5 @@ export type { string_camelCase, string_kebab_case, string_PascalCase, string_SCR
 export { extractParametersFromPromptTemplate, renameParameter, renderPromptbookMermaid };
 export { difference, intersection, union };
 /**
- * TODO: [🧠] Maybe create some indipendent package like `@promptbook/markdown-utils`
  * 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,25 @@ 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
+ * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json pipelines
+ * 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
  */