@promptbook/openai 0.60.0-0 → 0.60.0-4

package/umd/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts

@@ -22,11 +22,11 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
     /**
      * Calls Anthropic Claude API to use a chat model.
      */
-    gptChat(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptChatResult>;
+    callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptChatResult>;
     /**
      * Calls Anthropic Claude API to use a complete model.
      */
-    gptComplete(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
     /**
      * Get the model that should be used as default
      */
@@ -43,6 +43,6 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
 /**
  * TODO: !!!! [🍆] JSON mode
  * TODO: [🧠] Maybe handle errors via transformAnthropicError (like transformAzureError)
- * TODO: Maybe Create some common util for gptChat and gptComplete
+ * TODO: Maybe Create some common util for callChatModel and callCompletionModel
  * TODO: Maybe make custom OpenaiError
  */

package/umd/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts

@@ -22,11 +22,11 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
     /**
      * Calls OpenAI API to use a chat model.
      */
-    gptChat(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptChatResult>;
+    callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptChatResult>;
     /**
      * Calls Azure OpenAI API to use a complete model.
      */
-    gptComplete(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
     /**
      * Changes Azure error (which is not propper Error but object) to propper Error
      */
@@ -37,6 +37,6 @@ export declare class AzureOpenAiExecutionTools implements LlmExecutionTools {
     listModels(): Promise<Array<AvailableModel>>;
 }
 /**
- * TODO: Maybe Create some common util for gptChat and gptComplete
+ * TODO: Maybe Create some common util for callChatModel and callCompletionModel
  * TODO: Maybe make custom AzureOpenaiError
  */

package/umd/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts

@@ -13,11 +13,11 @@ export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
     /**
      * Mocks chat model
      */
-    gptChat(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptChatResult>;
+    callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptChatResult>;
     /**
      * Mocks completion model
      */
-    gptComplete(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
     /**
      * List all available mocked-models that can be used
      */

package/umd/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts

@@ -13,11 +13,11 @@ export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools
     /**
      * Fakes chat model
      */
-    gptChat(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<PromptChatResult & PromptCompletionResult>;
+    callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<PromptChatResult & PromptCompletionResult>;
     /**
      * Fakes completion model
      */
-    gptComplete(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<PromptCompletionResult>;
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectations' | 'postprocessing'>): Promise<PromptCompletionResult>;
     /**
      * List all available fake-models that can be used
      */
@@ -25,4 +25,4 @@ export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools
 }
 /**
  * TODO: [🕵️‍♀️] Maybe just remove
- */ 
+ */

package/umd/typings/src/llm-providers/mocked/fakeTextToExpectations.d.ts

@@ -1,5 +1,5 @@
 import type { PostprocessingFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
-import type { Expectations } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { Expectations } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Gets the expectations and creates a fake text that meets the expectations
  *

package/umd/typings/src/llm-providers/multiple/MultipleLlmExecutionTools.d.ts

@@ -20,15 +20,15 @@ export declare class MultipleLlmExecutionTools implements LlmExecutionTools {
     /**
      * Calls the best available chat model
      */
-    gptChat(prompt: Prompt): Promise<PromptChatResult>;
+    callChatModel(prompt: Prompt): Promise<PromptChatResult>;
     /**
      * Calls the best available completion model
      */
-    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    callCompletionModel(prompt: Prompt): Promise<PromptCompletionResult>;
     /**
      * Calls the best available model
      */
-    private gptCommon;
+    private callModelCommon;
     /**
      * List all available models that can be used
      * This liost is a combination of all available models from all execution tools

package/umd/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts

@@ -23,11 +23,11 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     /**
      * Calls OpenAI API to use a chat model.
      */
-    gptChat(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectFormat'>): Promise<PromptChatResult>;
+    callChatModel(prompt: Pick<Prompt, 'content' | 'modelRequirements' | 'expectFormat'>): Promise<PromptChatResult>;
     /**
      * Calls OpenAI API to use a complete model.
      */
-    gptComplete(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
+    callCompletionModel(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
     /**
      * Calls OpenAI API to use a embedding model
      */
@@ -55,6 +55,6 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
 }
 /**
  * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
- * TODO: Maybe Create some common util for gptChat and gptComplete
+ * TODO: Maybe Create some common util for callChatModel and callCompletionModel
  * TODO: Maybe make custom OpenaiError
  */

package/umd/typings/src/llm-providers/openai/computeOpenaiUsage.d.ts

@@ -7,7 +7,7 @@ import type { Prompt } from '../../types/Prompt';
  * @param promptContent The content of the prompt
  * @param resultContent The content of the result (for embedding prompts or failed prompts pass empty string)
  * @param rawResponse The raw response from OpenAI API
- * @throws {PromptbookExecutionError} If the usage is not defined in the response from OpenAI
+ * @throws {ExecutionError} If the usage is not defined in the response from OpenAI
  * @private internal util of `OpenAiExecutionTools`
  */
 export declare function computeOpenaiUsage(promptContent: Prompt['content'], // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer

package/umd/typings/src/llm-providers/openai/computeUsage.d.ts

@@ -4,13 +4,13 @@
  * @see https://openai.com/api/pricing/
  * @see https://docs.anthropic.com/en/docs/models-overview
  *
- * @private within the library, used only as internal helper for `OPENAI_MODELS` and `computeUsage`
+ * @private within the package, used only as internal helper for `OPENAI_MODELS` and `computeUsage`
  */
 type string_model_price = `$${number}.${number} / ${number}M tokens`;
 /**
  * Function computeUsage will create price per one token based on the string value found on openai page
  *
- * @private within the library, used only as internal helper for `OPENAI_MODELS`
+ * @private within the package, used only as internal helper for `OPENAI_MODELS`
  */
 export declare function computeUsage(value: string_model_price): number;
 export {};

package/umd/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts

@@ -22,15 +22,15 @@ export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
     /**
      * Calls remote proxy server to use a chat model.
      */
-    gptChat(prompt: Prompt): Promise<PromptChatResult>;
+    callChatModel(prompt: Prompt): Promise<PromptChatResult>;
     /**
      * Calls remote proxy server to use a completion model.
      */
-    gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    callCompletionModel(prompt: Prompt): Promise<PromptCompletionResult>;
     /**
      * Calls remote proxy server to use both completion or chat model.
      */
-    private gptCommon;
+    private callModelCommon;
     /**
      * List all available models that can be used
      */

package/umd/typings/src/llm-providers/remote/interfaces/RemoteServerOptions.d.ts

@@ -1,6 +1,6 @@
 import type { CommonExecutionToolsOptions } from '../../../execution/CommonExecutionToolsOptions';
 import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
-import type { PromptbookLibrary } from '../../../library/PromptbookLibrary';
+import type { PipelineCollection } from '../../../library/PipelineCollection';
 import type { client_id } from '../../../types/typeAliases';
 import type { string_uri } from '../../../types/typeAliases';
 export type RemoteServerOptions = CommonExecutionToolsOptions & {
@@ -20,7 +20,7 @@ export type RemoteServerOptions = CommonExecutionToolsOptions & {
      *
      * This is used to checkl validity of the prompt to prevent DDoS
      */
-    readonly library: PromptbookLibrary;
+    readonly library: PipelineCollection;
     /**
      * Creates llm execution tools for each client
      */

package/umd/typings/src/llm-providers/remote/startRemoteServer.d.ts

@@ -10,7 +10,7 @@ import type { RemoteServerOptions } from './interfaces/RemoteServerOptions';
  */
 export declare function startRemoteServer(options: RemoteServerOptions): IDestroyable;
 /**
- * TODO: [⚖] Expose the library to be able to connect to same library via createLibraryFromUrl
+ * TODO: [⚖] Expose the library to be able to connect to same library via createCollectionFromUrl
  * TODO: Handle progress - support streaming
  * TODO: [🤹‍♂️] Do not hang up immediately but wait until client closes OR timeout
  * TODO: [🤹‍♂️] Timeout on chat to free up resources

package/umd/typings/src/types/Command.d.ts

@@ -1,10 +1,10 @@
+import type { ExecutionType } from './ExecutionTypes';
+import type { ModelRequirements } from './ModelRequirements';
+import type { ExpectationAmount } from './PipelineJson/PromptTemplateJson';
+import type { ExpectationUnit } from './PipelineJson/PromptTemplateJson';
 import type { string_markdown_text } from './typeAliases';
 import type { string_name } from './typeAliases';
 import type { string_version } from './typeAliases';
-import type { ExecutionType } from './ExecutionTypes';
-import type { ModelRequirements } from './ModelRequirements';
-import type { ExpectationAmount } from './PromptbookJson/PromptTemplateJson';
-import type { ExpectationUnit } from './PromptbookJson/PromptTemplateJson';
 /**
  * Command is one piece of the prompt template which adds some logic to the prompt template or the whole pipeline.
  * It is parsed from the markdown from ul/ol items - one command per one item.

package/umd/typings/src/types/Parameters.d.ts

@@ -1,5 +1,5 @@
 /**
- * Parameters of the prompt template (pipeline)
+ * Parameters of the pipeline
  *
  * There are three types of parameters:
  * - **INPUT PARAMETERs** are required to execute the pipeline.

package/umd/typings/src/types/{PromptbookJson/PromptbookJson.d.ts → PipelineJson/PipelineJson.d.ts}

@@ -1,5 +1,5 @@
 import type { string_markdown_text } from '../typeAliases';
-import type { string_promptbook_url } from '../typeAliases';
+import type { string_pipeline_url } from '../typeAliases';
 import type { string_version } from '../typeAliases';
 import type { KnowledgeJson } from './KnowledgeJson';
 import type { PromptTemplateJson } from './PromptTemplateJson';
@@ -8,19 +8,19 @@ import type { PromptTemplateParameterJson } from './PromptTemplateParameterJson'
  * Promptbook is the **core concept of this library**.
  * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.
  *
- * @see https://github.com/webgptorg/promptbook#promptbook
+ * @see !!! https://github.com/webgptorg/promptbook#promptbook
  */
-export type PromptbookJson = {
+export type PipelineJson = {
     /**
      * Unique identifier of the promptbook
      *
      * Note: It must be unique across all promptbooks libraries
      * Note: It must use HTTPs URL
      * Tip: You can do versioning in the URL
-     *      For example: https://promptbook.webgpt.com/cs/write-website-content.ptbk.md@1.0.0
+     *      For example: https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md@1.0.0
      * Warning: Do not hash part of the URL, hash part is used for identification of the prompt template in the pipeline
      */
-    readonly promptbookUrl?: string_promptbook_url;
+    readonly promptbookUrl?: string_pipeline_url;
     /**
      * Title of the promptbook
      * -It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure

package/{esm/typings/src/types/PromptbookString.d.ts → umd/typings/src/types/PipelineString.d.ts}

@@ -2,11 +2,11 @@
  * Promptbook is the **core concept of this library**.
  * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.
  *
- * @see https://github.com/webgptorg/promptbook#promptbook
+ * @see !!! https://github.com/webgptorg/promptbook#promptbook
  */
-export type PromptbookString = string & {
+export type PipelineString = string & {
     readonly _type: 'Promptbook';
 };
 /**
- * TODO: !! Better validation (validatePromptbookString) or remove branded type and make it just string
+ * TODO: !! Better validation (validatePipelineString) or remove branded type and make it just string
  */

package/umd/typings/src/types/Prompt.d.ts

@@ -1,10 +1,10 @@
 import type { PostprocessingFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
 import type { ExpectFormatCommand } from './Command';
 import type { ModelRequirements } from './ModelRequirements';
-import type { Expectations } from './PromptbookJson/PromptTemplateJson';
+import type { Expectations } from './PipelineJson/PromptTemplateJson';
 import type { string_name } from './typeAliases';
+import type { string_pipeline_url_with_hashtemplate } from './typeAliases';
 import type { string_prompt } from './typeAliases';
-import type { string_promptbook_url_with_hashtemplate } from './typeAliases';
 import type { string_title } from './typeAliases';
 /**
  * Prompt in a text along with model requirements, but without any execution or templating logic.
@@ -50,9 +50,9 @@ export type Prompt = {
     /**
      * Unique identifier of the promptbook with specific template name as hash
      *
-     * @example https://promptbook.webgpt.com/cs/write-website-content.ptbk.md#keywords
+     * @example https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md#keywords
      */
-    readonly promptbookUrl: string_promptbook_url_with_hashtemplate;
+    readonly promptbookUrl: string_pipeline_url_with_hashtemplate;
     /**
      * Parameters used in the prompt
      *

package/umd/typings/src/types/execution-report/ExecutionReportJson.d.ts

@@ -1,7 +1,7 @@
 import type { PromptResult } from '../../execution/PromptResult';
 import type { Prompt } from '../Prompt';
 import type { string_markdown_text } from '../typeAliases';
-import type { string_promptbook_url } from '../typeAliases';
+import type { string_pipeline_url } from '../typeAliases';
 import type { string_version } from '../typeAliases';
 /**
  * ExecutionReport is result of executing one promptbook
@@ -17,7 +17,7 @@ export type ExecutionReportJson = {
     /**
      * Unique identifier of the promptbook from promptbook which was executed
      */
-    readonly promptbookUrl?: string_promptbook_url;
+    readonly promptbookUrl?: string_pipeline_url;
     /**
      * Title of from promptbook which was executed
      */

package/umd/typings/src/types/execution-report/countWorkingDuration.d.ts

@@ -2,6 +2,6 @@ import type { FromtoItems } from '../../utils/FromtoItems';
 /**
  * Count the duration of working time
  *
- * @private within the library
+ * @private within the package
  */
 export declare function countWorkingDuration(items: FromtoItems): number;

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

@@ -179,15 +179,15 @@ export type string_url = string;
 /**
  * Semantic helper
  *
- * For example `"https://promptbook.webgpt.com/cs/write-website-content.ptbk.md"`
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md"`
  */
-export type string_promptbook_url = string;
+export type string_pipeline_url = string;
 /**
  * Semantic helper
  *
- * For example `"https://promptbook.webgpt.com/cs/write-website-content.ptbk.md#keywords"`
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md#keywords"`
  */
-export type string_promptbook_url_with_hashtemplate = string;
+export type string_pipeline_url_with_hashtemplate = string;
 /**
  * Semantic helper
  *

package/umd/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 library
+ * @private within the package
  * @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 library
+ * @private within the package
  * @deprecated Use /\p{Extended_Pictographic}/ instead
  */
 export declare const EMOJIS: Set<string_char_emoji>;

package/umd/typings/src/utils/expectation-counters/countCharacters.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Counts number of characters in the text
  */

package/umd/typings/src/utils/expectation-counters/countLines.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Counts number of lines in the text
  */

package/umd/typings/src/utils/expectation-counters/countPages.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Counts number of pages in the text
  */

package/umd/typings/src/utils/expectation-counters/countParagraphs.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Counts number of paragraphs in the text
  */

package/umd/typings/src/utils/expectation-counters/countSentences.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Split text into sentences
  */

package/umd/typings/src/utils/expectation-counters/countWords.d.ts

@@ -1,4 +1,4 @@
-import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Counts number of words in the text
  */

package/umd/typings/src/utils/expectation-counters/index.d.ts

@@ -1,5 +1,5 @@
-import type { ExpectationAmount } from '../../types/PromptbookJson/PromptTemplateJson';
-import type { ExpectationUnit } from '../../types/PromptbookJson/PromptTemplateJson';
+import type { ExpectationAmount } from '../../types/PipelineJson/PromptTemplateJson';
+import type { ExpectationUnit } from '../../types/PipelineJson/PromptTemplateJson';
 /**
  * Index of all counter functions
  */

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

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

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

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

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

@@ -31,7 +31,7 @@ type CreateMarkdownChartOptions = {
 /**
  * Function createMarkdownChart will draw a chart in markdown from ⬛+🟦 tiles
  *
- * @private within the library
+ * @private within the package
  */
 export declare function createMarkdownChart(options: CreateMarkdownChartOptions): string_markdown;
 export {};

package/umd/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 library
+ * @private within the package
  */
 export declare function createMarkdownTable(table: Array<Array<string_markdown_text>>): string_markdown;

package/umd/typings/src/utils/markdown-json/MarkdownStructure.d.ts

@@ -1,7 +1,7 @@
 /**
  * Represents the structure of a markdown file.
  *
- * @private within the library
+ * @private within the package
  */
 export type MarkdownStructure = {
     /**

package/umd/typings/src/utils/markdown-json/countMarkdownStructureDeepness.d.ts

@@ -2,6 +2,6 @@ import type { MarkdownStructure } from './MarkdownStructure';
 /**
  * Computes the deepness of the markdown structure.
  *
- * @private within the library
+ * @private within the package
  */
 export declare function countMarkdownStructureDeepness(markdownStructure: MarkdownStructure): number;

package/umd/typings/src/utils/markdown-json/markdownToMarkdownStructure.d.ts

@@ -8,6 +8,6 @@ import type { MarkdownStructure } from './MarkdownStructure';
  * @param markdown The markdown string to parse.
  * @returns The MarkdownStructure object.
  *
- * @private within the library
+ * @private within the package
  */
 export declare function markdownToMarkdownStructure(markdown: string): MarkdownStructure;

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

@@ -1,12 +0,0 @@
-import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../types/PromptbookString';
-/**
- * Converts promptbook in JSON format to string format
- *
- * @param promptbookJson Promptbook in JSON format (.ptbk.json)
- * @returns Promptbook in string format (.ptbk.md)
- */
-export declare function promptbookJsonToString(promptbookJson: PromptbookJson): PromptbookString;
-/**
- * TODO: Escape all
- */

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

@@ -1,32 +0,0 @@
-import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
-import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../types/PromptbookString';
-/**
- * Options for promptbookStringToJson
- */
-type PromptbookStringToJsonOptions = {
-    /**
-     * Tools for processing required for knowledge processing *(not for actual execution)*
-     */
-    llmTools?: LlmExecutionTools;
-};
-/**
- * Compile promptbook from string (markdown) format to JSON format
- *
- * Note: There are two similar functions:
- * - `promptbookStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
- * - `promptbookStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
- *
- * @param promptbookString {Promptbook} in string markdown format (.ptbk.md)
- * @param options - Options and tools for the compilation
- * @returns {Promptbook} compiled in JSON format (.ptbk.json)
- * @throws {PromptbookSyntaxError} if the promptbook string is not valid
- *
- * Note: This function does not validate logic of the pipeline only the syntax
- * Note: This function acts as compilation process
- */
-export declare function promptbookStringToJson(promptbookString: PromptbookString, options?: PromptbookStringToJsonOptions): Promise<PromptbookJson>;
-export {};
-/**
- * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
- */

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

@@ -1,23 +0,0 @@
-import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../types/PromptbookString';
-/**
- * Compile promptbook from string (markdown) format to JSON format synchronously
- *
- * Note: There are two similar functions:
- * - `promptbookStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
- * - `promptbookStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
- *
- * @param promptbookString {Promptbook} in string markdown format (.ptbk.md)
- * @param options - Options and tools for the compilation
- * @returns {Promptbook} compiled in JSON format (.ptbk.json)
- * @throws {PromptbookSyntaxError} if the promptbook string is not valid
- *
- * Note: This function does not validate logic of the pipeline only the syntax
- * Note: This function acts as compilation process
- */
-export declare function promptbookStringToJsonSync(promptbookString: PromptbookString): PromptbookJson;
-/**
- * TODO: Report here line/column of error
- * TODO: Use spaceTrim more effectively
- * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
- */

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

@@ -1,13 +0,0 @@
-import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../../types/PromptbookString';
-/**
- * Import the text 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
- *
- * @param path - The path to the file relative to samples/templates directory
- * @private
- */
-export declare function importPromptbook(path: `${string}.ptbk.md`): PromptbookString;
-export declare function importPromptbook(path: `${string}.ptbk.json`): PromptbookJson;

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

@@ -1,27 +0,0 @@
-import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-/**
- * Validates PromptbookJson if it is logically valid
- *
- * It checks:
- * -   if it has correct parameters dependency
- *
- * It does NOT check:
- * -   if it is valid json
- * -   if it is meaningful
- *
- * @param promptbook valid or invalid PromptbookJson
- * @returns the same promptbook if it is logically valid
- * @throws {PromptbookLogicError} on logical error in the promptbook
- */
-export declare function validatePromptbook(promptbook: PromptbookJson): PromptbookJson;
-/**
- * TODO: [🧠] Work with promptbookVersion
- * TODO: Use here some json-schema, Zod or something similar and change it to:
- *     > /**
- *     >  * Validates PromptbookJson if it is logically valid.
- *     >  *
- *     >  * It checks:
- *     >  * -   it has a valid structure
- *     >  * -   ...
- *     >  ex port function validatePromptbook(promptbook: unknown): asserts promptbook is PromptbookJson {
- */