@promptbook/types 0.41.110 → 0.41.111-1

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

@@ -1,6 +1,7 @@
 import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
 import { parseNumber } from '../conversion/utils/parseNumber';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
+import { replaceParameters } from '../execution/utils/replaceParameters';
 import { ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
 import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
 import { CountUtils } from '../utils/expectation-counters';
@@ -25,7 +26,7 @@ import { unwrapResult } from '../utils/unwrapResult';
 export { assertsExecutionSuccessful, countCharacters, countLines, countPages, countParagraphs, countSentences, CountUtils, countWords, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, extractAllBlocksFromMarkdown, // <- [🌻]
 extractAllListItemsFromMarkdown, extractBlock, // <- [🌻]
 extractOneBlockFromMarkdown, isValidJsonString, parseNumber, // <- [🌻]
-prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
+prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 /**
  * TODO: [🧠] Maybe create some indipendent package like `markdown-tools` from both here exported and @private utilities
  */

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

@@ -3,6 +3,8 @@ import { 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;

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

@@ -4,6 +4,7 @@ import { string_javascript, string_javascript_name } from '../../types/typeAlias
  *
  * @param script from which to extract the variables
  * @returns the list of variable names
+ * @throws {PromptbookSyntaxError} if the script is invalid
  *
  * @private within the promptbookStringToJson
  */

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

@@ -3,6 +3,9 @@ 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/parseNumber.d.ts

@@ -4,6 +4,9 @@
  * 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;

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

@@ -10,7 +10,7 @@ import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
  * -   if it is meaningful
  *
  * @param promptbook valid or invalid PromptbookJson
- * @throws {Error} if invalid
+ * @throws {PromptbookLogicError} on logical error in the promptbook
  */
 export declare function validatePromptbookJson(promptbook: PromptbookJson): void;
 /**

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/execution/PromptbookExecutor.d.ts

@@ -6,9 +6,7 @@ import type { string_name } from '../types/typeAliases';
  * Executor is a simple async function that takes INPUT  PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT  PARAMETERs = it extends input object)_.
  * Executor is made by combining execution tools and promptbook library.
  *
- * It can be done in two ways:
- * -   From `PromptbookLibrary.getExecutor` method
- * -   `createPromptbookExecutor` utility function
+ * It can be created with `createPromptbookExecutor` function.
  *
  * @see https://github.com/webgptorg/promptbook#executor
  */

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

@@ -3,7 +3,7 @@ import type { PromptbookExecutor } from './PromptbookExecutor';
  * Asserts that the execution of a promptnook is successful
  *
  * @param executionResult - The partial result of the promptnook execution
- * @throws Error - If the execution is not successful or if multiple errors occurred
+ * @throws {PromptbookExecutionError} If the execution is not successful or if multiple errors occurred
  */
 export declare function assertsExecutionSuccessful(executionResult: Pick<Awaited<ReturnType<PromptbookExecutor>>, 'isSuccessful' | 'errors'>): void;
 /**

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

@@ -29,7 +29,8 @@ interface CreatePromptbookExecutorOptions {
 /**
  * Creates executor function from promptbook and execution tools.
  *
- * Note: Consider using getExecutor method of the library instead of using this function
+ * @returns The executor function
+ * @throws {PromptbookLogicError} on logical error in the promptbook
  */
 export declare function createPromptbookExecutor(options: CreatePromptbookExecutorOptions): PromptbookExecutor;
 export {};

package/esm/typings/execution/plugins/natural-execution-tools/openai/computeOpenaiUsage.d.ts

@@ -1,3 +1,8 @@
 import type OpenAI from 'openai';
 import type { PromptResult } from '../../../PromptResult';
+/**
+ * !!!
+ *
+ * @throws {PromptbookExecutionError} If the usage is not defined in the response from OpenAI
+ */
 export declare function computeOpenaiUsage(rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion, 'model' | 'usage'>): PromptResult['usage'];

package/esm/typings/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts

@@ -1 +1,7 @@
+/**
+ *
+ * @param message
+ * @returns
+ * @throws {PromptbookExecutionError}
+ */
 export declare function extractMultiplicatedOccurrence(message: string): string;

package/esm/typings/execution/utils/replaceParameters.d.ts

@@ -6,6 +6,7 @@ import { string_template } from '../../types/typeAliases';
  * @param template the template with parameters in {curly} braces
  * @param parameters the object with parameters
  * @returns the template with replaced parameters
+ * @throws {TemplateError} if parameter is not defined, not closed, or not opened
  *
  * @private within the createPromptbookExecutor
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.41.110",
+    "version": "0.41.111-1",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -35,7 +35,7 @@
     "homepage": "https://www.npmjs.com/package/@promptbook/core",
     "dependencies": {},
     "peerDependencies": {
-        "@promptbook/core": "0.41.110"
+        "@promptbook/core": "0.41.111-1"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

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

@@ -1,6 +1,7 @@
 import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
 import { parseNumber } from '../conversion/utils/parseNumber';
 import { assertsExecutionSuccessful } from '../execution/assertsExecutionSuccessful';
+import { replaceParameters } from '../execution/utils/replaceParameters';
 import { ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
 import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
 import { CountUtils } from '../utils/expectation-counters';
@@ -25,7 +26,7 @@ import { unwrapResult } from '../utils/unwrapResult';
 export { assertsExecutionSuccessful, countCharacters, countLines, countPages, countParagraphs, countSentences, CountUtils, countWords, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, extractAllBlocksFromMarkdown, // <- [🌻]
 extractAllListItemsFromMarkdown, extractBlock, // <- [🌻]
 extractOneBlockFromMarkdown, isValidJsonString, parseNumber, // <- [🌻]
-prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
+prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 /**
  * TODO: [🧠] Maybe create some indipendent package like `markdown-tools` from both here exported and @private utilities
  */

package/umd/typings/conversion/promptbookStringToJson.d.ts

@@ -3,6 +3,8 @@ import { 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;

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

@@ -4,6 +4,7 @@ import { string_javascript, string_javascript_name } from '../../types/typeAlias
  *
  * @param script from which to extract the variables
  * @returns the list of variable names
+ * @throws {PromptbookSyntaxError} if the script is invalid
  *
  * @private within the promptbookStringToJson
  */

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

@@ -3,6 +3,9 @@ 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/umd/typings/conversion/utils/parseNumber.d.ts

@@ -4,6 +4,9 @@
  * 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;

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

@@ -10,7 +10,7 @@ import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
  * -   if it is meaningful
  *
  * @param promptbook valid or invalid PromptbookJson
- * @throws {Error} if invalid
+ * @throws {PromptbookLogicError} on logical error in the promptbook
  */
 export declare function validatePromptbookJson(promptbook: PromptbookJson): void;
 /**

package/umd/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/umd/typings/execution/PromptbookExecutor.d.ts

@@ -6,9 +6,7 @@ import type { string_name } from '../types/typeAliases';
  * Executor is a simple async function that takes INPUT  PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT  PARAMETERs = it extends input object)_.
  * Executor is made by combining execution tools and promptbook library.
  *
- * It can be done in two ways:
- * -   From `PromptbookLibrary.getExecutor` method
- * -   `createPromptbookExecutor` utility function
+ * It can be created with `createPromptbookExecutor` function.
  *
  * @see https://github.com/webgptorg/promptbook#executor
  */

package/umd/typings/execution/assertsExecutionSuccessful.d.ts

@@ -3,7 +3,7 @@ import type { PromptbookExecutor } from './PromptbookExecutor';
  * Asserts that the execution of a promptnook is successful
  *
  * @param executionResult - The partial result of the promptnook execution
- * @throws Error - If the execution is not successful or if multiple errors occurred
+ * @throws {PromptbookExecutionError} If the execution is not successful or if multiple errors occurred
  */
 export declare function assertsExecutionSuccessful(executionResult: Pick<Awaited<ReturnType<PromptbookExecutor>>, 'isSuccessful' | 'errors'>): void;
 /**

package/umd/typings/execution/createPromptbookExecutor.d.ts

@@ -29,7 +29,8 @@ interface CreatePromptbookExecutorOptions {
 /**
  * Creates executor function from promptbook and execution tools.
  *
- * Note: Consider using getExecutor method of the library instead of using this function
+ * @returns The executor function
+ * @throws {PromptbookLogicError} on logical error in the promptbook
  */
 export declare function createPromptbookExecutor(options: CreatePromptbookExecutorOptions): PromptbookExecutor;
 export {};

package/umd/typings/execution/plugins/natural-execution-tools/openai/computeOpenaiUsage.d.ts

@@ -1,3 +1,8 @@
 import type OpenAI from 'openai';
 import type { PromptResult } from '../../../PromptResult';
+/**
+ * !!!
+ *
+ * @throws {PromptbookExecutionError} If the usage is not defined in the response from OpenAI
+ */
 export declare function computeOpenaiUsage(rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion, 'model' | 'usage'>): PromptResult['usage'];

package/umd/typings/execution/translation/automatic-translate/automatic-translators/utils/extractMultiplicatedOccurrence.d.ts

@@ -1 +1,7 @@
+/**
+ *
+ * @param message
+ * @returns
+ * @throws {PromptbookExecutionError}
+ */
 export declare function extractMultiplicatedOccurrence(message: string): string;

package/umd/typings/execution/utils/replaceParameters.d.ts

@@ -6,6 +6,7 @@ import { string_template } from '../../types/typeAliases';
  * @param template the template with parameters in {curly} braces
  * @param parameters the object with parameters
  * @returns the template with replaced parameters
+ * @throws {TemplateError} if parameter is not defined, not closed, or not opened
  *
  * @private within the createPromptbookExecutor
  */