@promptbook/anthropic-claude 0.52.0-1

package/esm/index.es.js

@@ -0,0 +1,2 @@
+
+//# sourceMappingURL=index.es.js.map

package/esm/index.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.es.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/esm/typings/_packages/cli.index.d.ts

@@ -0,0 +1,8 @@
+import { prettifyPromptbookStringCli } from '../conversion/prettify/prettifyPromptbookStringCli';
+/**
+ * Hidden utilities which should not be used by external consumers.
+ */
+declare const __: {
+    prettifyPromptbookStringCli: typeof prettifyPromptbookStringCli;
+};
+export { __ };

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

@@ -0,0 +1,19 @@
+import { promptbookStringToJson } from '../conversion/promptbookStringToJson';
+import { promptbookJsonToString } from '../conversion/promptbookJsonToString';
+import { validatePromptbookJson } from '../conversion/validation/validatePromptbookJson';
+import { createPromptbookExecutor } from '../execution/createPromptbookExecutor';
+import { CallbackInterfaceTools } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceTools';
+import { CallbackInterfaceToolsOptions } from '../execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions';
+import { SimplePromptInterfaceTools } from '../execution/plugins/user-interface-execution-tools/simple-prompt/SimplePromptInterfaceTools';
+import { SimplePromptbookLibrary } from '../library/SimplePromptbookLibrary';
+import { createPromptbookLibraryFromPromise } from '../library/constructors/createPromptbookLibraryFromPromise';
+import { createPromptbookLibraryFromSources } from '../library/constructors/createPromptbookLibraryFromSources';
+import { createPromptbookSublibrary } from '../library/constructors/createPromptbookSublibrary';
+import { ExecutionTypes } from '../types/ExecutionTypes';
+import { PROMPTBOOK_VERSION } from '../version';
+export { ExecutionTypes, PROMPTBOOK_VERSION };
+export { createPromptbookLibraryFromPromise, createPromptbookLibraryFromSources, createPromptbookSublibrary, SimplePromptbookLibrary, };
+export { SimplePromptInterfaceTools };
+export { promptbookStringToJson, promptbookJsonToString, validatePromptbookJson };
+export { createPromptbookExecutor };
+export { CallbackInterfaceTools, CallbackInterfaceToolsOptions };

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

@@ -0,0 +1,46 @@
+import spaceTrim from 'spacetrim';
+import { JavascriptEvalExecutionTools } from '../execution/plugins/script-execution-tools/javascript/JavascriptEvalExecutionTools';
+import { JavascriptExecutionTools } from '../execution/plugins/script-execution-tools/javascript/JavascriptExecutionTools';
+import { prettifyMarkdown } from '../utils/markdown/prettifyMarkdown';
+import { capitalize } from '../utils/normalization/capitalize';
+import { decapitalize } from '../utils/normalization/decapitalize';
+import { nameToUriPart } from '../utils/normalization/nameToUriPart';
+import { nameToUriParts } from '../utils/normalization/nameToUriParts';
+import { normalizeToKebabCase } from '../utils/normalization/normalize-to-kebab-case';
+import { normalizeTo_PascalCase } from '../utils/normalization/normalizeTo_PascalCase';
+import { normalizeTo_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
+import { normalizeTo_camelCase } from '../utils/normalization/normalizeTo_camelCase';
+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';
+import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
+import { unwrapResult } from '../utils/unwrapResult';
+declare const POSTPROCESSING_FUNCTIONS: {
+    spaceTrim: typeof spaceTrim;
+    removeQuotes: typeof removeQuotes;
+    unwrapResult: typeof unwrapResult;
+    trimEndOfCodeBlock: typeof trimEndOfCodeBlock;
+    trimCodeBlock: typeof trimCodeBlock;
+    trim: (str: string) => string;
+    reverse: (str: string) => string;
+    removeEmojis: typeof removeEmojis;
+    prettifyMarkdown: typeof prettifyMarkdown;
+    capitalize: typeof capitalize;
+    decapitalize: typeof decapitalize;
+    nameToUriPart: typeof nameToUriPart;
+    nameToUriParts: typeof nameToUriParts;
+    removeDiacritics: typeof removeDiacritics;
+    normalizeWhitespaces: typeof normalizeWhitespaces;
+    normalizeToKebabCase: typeof normalizeToKebabCase;
+    normalizeTo_camelCase: typeof normalizeTo_camelCase;
+    normalizeTo_snake_case: typeof normalizeTo_snake_case;
+    normalizeTo_PascalCase: typeof normalizeTo_PascalCase;
+    parseKeywords: (input: string) => string;
+    normalizeTo_SCREAMING_CASE: typeof normalizeTo_SCREAMING_CASE;
+    extractBlock: typeof extractBlock;
+};
+export { JavascriptEvalExecutionTools, JavascriptExecutionTools, POSTPROCESSING_FUNCTIONS };

package/esm/typings/_packages/langtail.index.d.ts

@@ -0,0 +1,3 @@
+import { LangtailExecutionTools } from '../execution/plugins/llm-execution-tools/langtail/LangtailExecutionTools';
+import { LangtailExecutionToolsOptions } from '../execution/plugins/llm-execution-tools/langtail/LangtailExecutionToolsOptions';
+export { LangtailExecutionTools, LangtailExecutionToolsOptions };

package/esm/typings/_packages/mock.index.d.ts

@@ -0,0 +1,6 @@
+import { MockedEchoLlmExecutionTools } from '../execution/plugins/llm-execution-tools/mocked/MockedEchoLlmExecutionTools';
+import { MockedFackedLlmExecutionTools } from '../execution/plugins/llm-execution-tools/mocked/MockedFackedLlmExecutionTools';
+export { MockedEchoLlmExecutionTools, MockedFackedLlmExecutionTools };
+/**
+ * TODO: [🚏] FakeLLM
+ */

package/esm/typings/_packages/openai.index.d.ts

@@ -0,0 +1,4 @@
+import { OPENAI_MODELS } from '../execution/plugins/llm-execution-tools/openai/models';
+import { OpenAiExecutionTools } from '../execution/plugins/llm-execution-tools/openai/OpenAiExecutionTools';
+import { OpenAiExecutionToolsOptions } from '../execution/plugins/llm-execution-tools/openai/OpenAiExecutionToolsOptions';
+export { OPENAI_MODELS, OpenAiExecutionTools, OpenAiExecutionToolsOptions };

package/esm/typings/_packages/remote-client.index.d.ts

@@ -0,0 +1,4 @@
+import { RemoteServerOptions } from '../execution/plugins/llm-execution-tools/remote/interfaces/RemoteServerOptions';
+import { RemoteLlmExecutionTools } from '../execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionTools';
+import { RemoteLlmExecutionToolsOptions } from '../execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionToolsOptions';
+export { RemoteLlmExecutionTools, RemoteLlmExecutionToolsOptions, RemoteServerOptions };

package/esm/typings/_packages/remote-server.index.d.ts

@@ -0,0 +1,3 @@
+import { RemoteServerOptions } from '../execution/plugins/llm-execution-tools/remote/interfaces/RemoteServerOptions';
+import { startRemoteServer } from '../execution/plugins/llm-execution-tools/remote/startRemoteServer';
+export { RemoteServerOptions, startRemoteServer };

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

@@ -0,0 +1,28 @@
+import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionToolsOptions';
+import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { AvailableModel, LlmExecutionTools } from '../execution/LlmExecutionTools';
+import type { PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult } from '../execution/PromptResult';
+import type { PromptbookExecutor } from '../execution/PromptbookExecutor';
+import type { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExecutionTools';
+import type { UserInterfaceTools, UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
+import { PromptbookLibrary } from '../library/PromptbookLibrary';
+import type { ExecutionType } from '../types/ExecutionTypes';
+import type { ModelRequirements, ModelVariant } from '../types/ModelRequirements';
+import type { Parameters } from '../types/Parameters';
+import type { Prompt } from '../types/Prompt';
+import type { ExpectationAmount, Expectations, ExpectationUnit, LlmTemplateJson, PromptDialogJson, PromptTemplateJson, ScriptJson, SimpleTemplateJson } from '../types/PromptbookJson/PromptTemplateJson';
+import { EXPECTATION_UNITS } from '../types/PromptbookJson/PromptTemplateJson';
+import type { PromptTemplateParameterJson } from '../types/PromptbookJson/PromptTemplateParameterJson';
+import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
+import type { PromptbookString } from '../types/PromptbookString';
+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_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_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, 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_version } from '../types/typeAliases';
+import { FromtoItems } from '../utils/FromtoItems';
+export { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, EXPECTATION_UNITS, ExpectationAmount, Expectations, ExpectationUnit, FromtoItems, LlmExecutionTools, LlmTemplateJson, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptDialogJson, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptJson, ScriptLanguage, SimpleTemplateJson, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, 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_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, 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_version, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
+/**
+ * TODO: [🧠][🆔] Is this the best package to export custom errors from?
+ * TODO: Delete type aliases (from ../types/typeAliases) that are not exported here
+ */

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

@@ -0,0 +1,73 @@
+import { spaceTrim } from 'spacetrim';
+import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
+import { renderPromptbookMermaid } from '../conversion/prettify/renderPromptbookMermaid';
+import { extractParametersFromPromptTemplate } from '../conversion/utils/extractParametersFromPromptTemplate';
+import { extractVariables } from '../conversion/utils/extractVariables';
+import { parseNumber } from '../conversion/utils/parseNumber';
+import { renameParameter } from '../conversion/utils/renameParameter';
+import { titleToName } from '../conversion/utils/titleToName';
+import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
+import { checkExpectations, isPassingExpectations } from '../execution/utils/checkExpectations';
+import { replaceParameters } from '../execution/utils/replaceParameters';
+import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
+import { ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
+import { CountUtils } from '../utils/expectation-counters';
+import { countCharacters } from '../utils/expectation-counters/countCharacters';
+import { countLines } from '../utils/expectation-counters/countLines';
+import { countPages } from '../utils/expectation-counters/countPages';
+import { countParagraphs } from '../utils/expectation-counters/countParagraphs';
+import { countSentences, splitIntoSentences } from '../utils/expectation-counters/countSentences';
+import { countWords } from '../utils/expectation-counters/countWords';
+import { extractParameters } from '../utils/extractParameters';
+import { isValidJsonString } from '../utils/isValidJsonString';
+import { extractAllBlocksFromMarkdown } from '../utils/markdown/extractAllBlocksFromMarkdown';
+import { extractAllListItemsFromMarkdown } from '../utils/markdown/extractAllListItemsFromMarkdown';
+import { extractOneBlockFromMarkdown } from '../utils/markdown/extractOneBlockFromMarkdown';
+import { removeContentComments } from '../utils/markdown/removeContentComments';
+import { removeMarkdownFormatting } from '../utils/markdown/removeMarkdownFormatting';
+import { capitalize } from '../utils/normalization/capitalize';
+import { decapitalize } from '../utils/normalization/decapitalize';
+import { DIACRITIC_VARIANTS_LETTERS } from '../utils/normalization/DIACRITIC_VARIANTS_LETTERS';
+import { IKeywords, string_keyword } from '../utils/normalization/IKeywords';
+import { isValidKeyword } from '../utils/normalization/isValidKeyword';
+import { nameToUriPart } from '../utils/normalization/nameToUriPart';
+import { nameToUriParts } from '../utils/normalization/nameToUriParts';
+import { normalizeToKebabCase } from '../utils/normalization/normalize-to-kebab-case';
+import { normalizeTo_camelCase } from '../utils/normalization/normalizeTo_camelCase';
+import { normalizeTo_PascalCase } from '../utils/normalization/normalizeTo_PascalCase';
+import { normalizeTo_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
+import { normalizeTo_snake_case } from '../utils/normalization/normalizeTo_snake_case';
+import { normalizeWhitespaces } from '../utils/normalization/normalizeWhitespaces';
+import { parseKeywords } from '../utils/normalization/parseKeywords';
+import { parseKeywordsFromString } from '../utils/normalization/parseKeywordsFromString';
+import { removeDiacritics } from '../utils/normalization/removeDiacritics';
+import { searchKeywords } from '../utils/normalization/searchKeywords';
+import { extractBlock } from '../utils/postprocessing/extractBlock';
+import { removeEmojis } from '../utils/removeEmojis';
+import { removeQuotes } from '../utils/removeQuotes';
+import { difference } from '../utils/sets/difference';
+import { intersection } from '../utils/sets/intersection';
+import { union } from '../utils/sets/union';
+import { trimCodeBlock } from '../utils/trimCodeBlock';
+import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
+import { unwrapResult } from '../utils/unwrapResult';
+export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, extractAllBlocksFromMarkdown, // <- [🌻]
+extractAllListItemsFromMarkdown, extractBlock, // <- [🌻]
+extractOneBlockFromMarkdown, extractParameters, extractVariables, isPassingExpectations, isValidJsonString, parseNumber, // <- [🌻]
+prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, spaceTrim, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
+export { countCharacters, countLines, countPages, countParagraphs, countSentences, CountUtils, countWords };
+export { splitIntoSentences };
+export declare const normalizeTo: {
+    camelCase: typeof normalizeTo_camelCase;
+    PascalCase: typeof normalizeTo_PascalCase;
+    SCREAMING_CASE: typeof normalizeTo_SCREAMING_CASE;
+    snake_case: typeof normalizeTo_snake_case;
+    'kebab-case': typeof normalizeToKebabCase;
+};
+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 { extractParametersFromPromptTemplate, renameParameter, renderPromptbookMermaid };
+export { difference, intersection, union };
+/**
+ * TODO: [🧠] Maybe create some indipendent package like `markdown-tools` from both here exported and @private utilities
+ * Note: [🕙] It does not make sence to have simple lower / UPPER case normalization
+ */

package/esm/typings/_packages/wizzard.index.d.ts

@@ -0,0 +1,5 @@
+import { Wizzard } from '../wizzard/Wizzard';
+export { Wizzard };
+/**
+ * TODO: [🧙‍♂️]
+ */ 

package/esm/typings/config.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The maximum number of iterations for a loops
+ */
+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;

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

@@ -0,0 +1,13 @@
+/**
+ * Options for `prettifyPromptbookString` function
+ */
+export type PrettifyOptions = {
+    /***
+     * If true, adds Mermaid graph to the Promptbook string
+     */
+    isGraphAdded?: boolean;
+    /**
+     * If true, the string is prettifyed as markdown
+     */
+    isPrettifyed?: boolean;
+};

package/esm/typings/conversion/prettify/prettifyPromptbookString.d.ts

@@ -0,0 +1,10 @@
+import { PromptbookString } from '../../types/PromptbookString';
+import type { PrettifyOptions } from './PrettifyOptions';
+/**
+ * Prettyfies Promptbook string and adds Mermaid graph
+ */
+export declare function prettifyPromptbookString(promptbookString: PromptbookString, options: PrettifyOptions): PromptbookString;
+/**
+ * TODO: Maybe use some Mermaid library instead of string templating
+ * TODO: [🕌] When more than 2 functionalities, split into separate functions
+ */

package/esm/typings/conversion/prettify/prettifyPromptbookStringCli.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Runs CLI script for prettifying promptbooks
+ */
+export declare function prettifyPromptbookStringCli(): Promise<void>;
+/**
+ * TODO: [🥠] Do not export to utils directly, its just for CLI script
+ * TODO: [🕌] When more functionalities, rename
+ * Note: 11:11
+ */

package/esm/typings/conversion/prettify/renderPromptbookMermaid.d.ts

@@ -0,0 +1,24 @@
+import type { PromptbookJson, PromptTemplateJson } from '../../_packages/types.index';
+import type { string_href } from '../../types/typeAliases';
+/**
+ * Addtional options for rendering Mermaid graph
+ */
+export type renderPromptbookMermaidOptions = {
+    /**
+     * Callback for creating from prompt template graph node
+     */
+    linkPromptTemplate?(promptTemplate: PromptTemplateJson): {
+        href: string_href;
+        title: string;
+    } | null;
+};
+/**
+ * Creates a Mermaid graph based on the promptbook
+ *
+ * Note: The result is not wrapped in a Markdown code block
+ */
+export declare function renderPromptbookMermaid(promptbookJson: PromptbookJson, options?: renderPromptbookMermaidOptions): string;
+/**
+ * TODO: Maybe use some Mermaid library instead of string templating
+ * TODO: [🕌] When more than 2 functionalities, split into separate functions
+ */

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

@@ -0,0 +1,12 @@
+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/conversion/promptbookStringToJson.d.ts

@@ -0,0 +1,15 @@
+import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
+import type { PromptbookString } from '../types/PromptbookString';
+/**
+ * Parse promptbook from string format to JSON format
+ *
+ * @throws {PromptbookSyntaxError} if the promptbook string is not valid
+ *
+ * Note: This function does not validate logic of the pipeline only the syntax
+ */
+export declare function promptbookStringToJson(promptbookString: PromptbookString): PromptbookJson;
+/**
+ * TODO: Report here line/column of error
+ * TODO: Use spaceTrim more effectively
+ * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
+ */

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

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

package/esm/typings/conversion/utils/extractParametersFromPromptTemplate.d.ts

@@ -0,0 +1,13 @@
+import { PromptTemplateJson } from '../../types/PromptbookJson/PromptTemplateJson';
+import { string_name } from '../../types/typeAliases';
+/**
+ * Parses the prompt template and returns the set of all used parameters
+ *
+ * @param promptTemplate the template with used parameters
+ * @returns the set of parameter names
+ * @throws {PromptbookSyntaxError} if the script is invalid
+ */
+export declare function extractParametersFromPromptTemplate(promptTemplate: Pick<PromptTemplateJson, 'title' | 'description' | 'executionType' | 'content'>): Set<string_name>;
+/**
+ * TODO: [🔣] If script require contentLanguage
+ */ 

package/esm/typings/conversion/utils/extractParametersFromPromptTemplate.test.d.ts

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

package/esm/typings/conversion/utils/extractVariables.d.ts

@@ -0,0 +1,12 @@
+import { string_javascript, string_javascript_name } from '../../types/typeAliases';
+/**
+ * Parses the given script and returns the list of all used variables that are not defined in the script
+ *
+ * @param script from which to extract the variables
+ * @returns the list of variable names
+ * @throws {PromptbookSyntaxError} if the script is invalid
+ */
+export declare function extractVariables(script: string_javascript): Set<string_javascript_name>;
+/**
+ * TODO: [🔣] Support for multiple languages - python, java,...
+ */

package/esm/typings/conversion/utils/extractVariables.test.d.ts

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

package/esm/typings/conversion/utils/parseCommand.d.ts

@@ -0,0 +1,11 @@
+import type { Command } from '../../types/Command';
+import type { string_markdown_text } from '../../types/typeAliases';
+/**
+ * Parses one line of ul/ol to command
+ *
+ * @returns parsed command object
+ * @throws {PromptbookSyntaxError} if the command is invalid
+ *
+ * @private within the promptbookStringToJson
+ */
+export declare function parseCommand(listItem: string_markdown_text): Command;

package/esm/typings/conversion/utils/parseCommand.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🧠] Probbably change syntax MODEL VARIANT -> MODEL
+ */

package/esm/typings/conversion/utils/parseNumber.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Function parseNumber will parse number from string
+ *
+ * Unlike Number.parseInt, Number.parseFloat it will never ever result in NaN
+ * Note: it also works only with decimal numbers
+ *
+ * @returns parsed number
+ * @throws {PromptbookSyntaxError} if the value is not a number
+ *
+ * @private within the parseCommand
+ */
+export declare function parseNumber(value: string | number): number;
+/**
+ * TODO: Maybe use sth. like safe-eval in fraction/calculation case @see https://www.npmjs.com/package/safe-eval
+ */

package/esm/typings/conversion/utils/parseNumber.test.d.ts

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

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

@@ -0,0 +1,25 @@
+import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
+import type { string_name } from '../../types/typeAliases';
+type RenameParameterOptions = {
+    /**
+     * Promptbook to search and replace for parameters
+     * This promptbook is returned as copy with replaced parameters
+     */
+    promptbook: PromptbookJson;
+    /**
+     * Original parameter name that should be replaced
+     */
+    oldParameterName: string_name;
+    /**
+     * New parameter name that should replace the original parameter name
+     */
+    newParameterName: string_name;
+};
+/**
+ * Function renameParameter will find all usable parameters for given prompt template
+ * In other words, it will find all parameters that are not used in the prompt template itseld and all its dependencies
+ *
+ * @throws {PromptbookLogicError} If the new parameter name is already used in the promptbook
+ */
+export declare function renameParameter(options: RenameParameterOptions): PromptbookJson;
+export {};

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

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

package/esm/typings/conversion/utils/titleToName.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Function normalizes title to name which can be used as identifier
+ */
+export declare function titleToName(value: string): string;

package/esm/typings/conversion/utils/titleToName.test.d.ts

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

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

@@ -0,0 +1,13 @@
+import { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
+import { 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/conversion/validation/promptbookStringToJson-syntaxErrors.test.d.ts

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

package/esm/typings/conversion/validation/validatePromptbookJson-logicErrors.test.d.ts

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

package/esm/typings/conversion/validation/validatePromptbookJson.d.ts

@@ -0,0 +1,27 @@
+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 validatePromptbookJson(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 validatePromptbookJson(promptbook: unknown): asserts promptbook is PromptbookJson {
+ */

package/esm/typings/conversion/validation/validatePromptbookJson.test.d.ts

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

package/esm/typings/errors/PromptbookExecutionError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This error indicates errors during the execution of the promptbook
+ */
+export declare class PromptbookExecutionError extends Error {
+    readonly name = "PromptbookExecutionError";
+    constructor(message: string);
+}

package/esm/typings/errors/PromptbookLogicError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This error indicates that the promptbook object has valid syntax but contains logical errors (like circular dependencies)
+ */
+export declare class PromptbookLogicError extends Error {
+    readonly name = "PromptbookLogicError";
+    constructor(message: string);
+}

package/esm/typings/errors/PromptbookNotFoundError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This error indicates that promptbook not found in the library
+ */
+export declare class PromptbookNotFoundError extends Error {
+    readonly name = "PromptbookNotFoundError";
+    constructor(message: string);
+}

package/esm/typings/errors/PromptbookReferenceError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This error indicates errors in referencing promptbooks between each other
+ */
+export declare class PromptbookReferenceError extends Error {
+    readonly name = "PromptbookReferenceError";
+    constructor(message: string);
+}

package/esm/typings/errors/PromptbookSyntaxError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This error indicates that the promptbook in a markdown format cannot be parsed into a valid promptbook object
+ */
+export declare class PromptbookSyntaxError extends Error {
+    readonly name = "PromptbookSyntaxError";
+    constructor(message: string);
+}

package/esm/typings/errors/TemplateError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This error occurs during the parameter replacement in the template
+ *
+ * Note: This is a kindof subtype of PromptbookExecutionError because it occurs during the execution of the pipeline
+ */
+export declare class TemplateError extends Error {
+    readonly name = "TemplateError";
+    constructor(message: string);
+}

package/esm/typings/errors/UnexpectedError.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This error type indicates that the error should not happen and its last check before crashing with some other error
+ */
+export declare class UnexpectedError extends Error {
+    readonly name = "UnexpectedError";
+    constructor(message: string);
+}

package/esm/typings/errors/_ExpectError.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This error occurs when some expectation is not met in the execution of the pipeline
+ *
+ * @private Always catched and rethrown as `PromptbookExecutionError`
+ * Note: This is a kindof subtype of PromptbookExecutionError
+ */
+export declare class ExpectError extends Error {
+    readonly name = "ExpectError";
+    constructor(message: string);
+}

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

@@ -0,0 +1,9 @@
+export type CommonExecutionToolsOptions = {
+    /**
+     * If true, the internal executions will be logged
+     */
+    readonly isVerbose?: boolean;
+};
+/**
+ * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
+ */

package/esm/typings/execution/ExecutionTools.d.ts

@@ -0,0 +1,30 @@
+import type { LlmExecutionTools } from './LlmExecutionTools';
+import type { ScriptExecutionTools } from './ScriptExecutionTools';
+import type { UserInterfaceTools } from './UserInterfaceTools';
+/**
+ * All the tools needed to execute prompts (template pipelines).
+ *
+ * @see https://github.com/webgptorg/promptbook#execution-tools
+ */
+export type ExecutionTools = {
+    /**
+     * Tools for executing prompts to large language models like GPT-4
+     */
+    llm: LlmExecutionTools;
+    /**
+     * Tools for executing scripts
+     *
+     * Note: You can pass multiple ScriptExecutionTools, they will be tried one by one until one of them supports the script
+     *       If none of them supports the script, an error is thrown
+     */
+    script: Array<ScriptExecutionTools>;
+    /**
+     * Tools for interacting with the user
+     *
+     * Note: When undefined, the user interface is disabled and promptbook which requires user interaction will fail
+     */
+    userInterface?: UserInterfaceTools;
+};
+/**
+ * TODO: [🍓] !!!! Allow to have more LlmExecutionTools
+ */