@promptbook/utils 0.40.0-0 → 0.40.0-1

package/umd/typings/errors/ExpectError.d.ts

@@ -1,5 +1,7 @@
 /**
  * This error occurs when some expectation is not met in the execution of the pipeline
+ *
+ * Note: This is a kindof subtype of PromptbookExecutionError
  */
 export declare class ExpectError extends Error {
     readonly name = "ExpectError";

package/umd/typings/errors/NotFoundError.d.ts

@@ -1,5 +1,5 @@
 /**
- * This error !!!
+ * This error indicates that the requested resource (for example promptbook in the library ) was not found
  */
 export declare class NotFoundError extends Error {
     readonly name = "NotFoundError";

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

@@ -6,7 +6,7 @@ import { number_integer, number_positive } from '../types/typeAliases';
  */
 export type UserInterfaceTools = {
     /**
-     * Asks the user to answer a free-text (multiline) question
+     * Asks the user to answer a free-text (multi-line) question
      *
      * @param options the question to ask
      * @returns the answer from the user

package/{esm/typings → umd/typings/execution}/utils/replaceParameters.d.ts

@@ -1,5 +1,5 @@
-import { string_template } from '.././types/typeAliases';
-import { Parameters } from '../types/Parameters';
+import { Parameters } from '../../types/Parameters';
+import { string_template } from '../../types/typeAliases';
 /**
  * Replaces parameters in template with values from parameters object
  *
@@ -7,6 +7,6 @@ import { Parameters } from '../types/Parameters';
  * @param parameters the object with parameters
  * @returns the template with replaced parameters
  *
- * @private within the library
+ * @private within the createPromptbookExecutor
  */
 export declare function replaceParameters(template: string_template, parameters: Parameters): string;

package/umd/typings/utils/markdown/extractOneBlockFromMarkdown.d.ts

@@ -12,3 +12,6 @@ export declare function extractOneBlockFromMarkdown(markdown: string_markdown):
     language: string | null;
     content: string;
 };
+/***
+ * TODO: [🌻] !!! Decide of this is internal util, external util OR validator/postprocessor
+ */

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

@@ -1,6 +0,0 @@
-import type { string_markdown_text } from '.././types/typeAliases';
-import type { Command } from '../types/Command';
-/**
- * Parses one line of ul/ol to command
- */
-export declare function parseCommand(listItem: string_markdown_text): Command;

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

@@ -1,6 +0,0 @@
-import type { string_markdown_text } from '.././types/typeAliases';
-import type { Command } from '../types/Command';
-/**
- * Parses one line of ul/ol to command
- */
-export declare function parseCommand(listItem: string_markdown_text): Command;