@promptbook/types 0.84.0-10 → 0.84.0-11

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

@@ -8,6 +8,7 @@ import { serializeError } from '../errors/utils/serializeError';
 import { forEachAsync } from '../execution/utils/forEachAsync';
 import { isValidJsonString } from '../formats/json/utils/isValidJsonString';
 import { prompt } from '../pipeline/prompt-notation';
+import { promptTemplate } from '../pipeline/prompt-notation';
 import { $getCurrentDate } from '../utils/$getCurrentDate';
 import { $isRunningInBrowser } from '../utils/environment/$isRunningInBrowser';
 import { $isRunningInJest } from '../utils/environment/$isRunningInJest';
@@ -89,6 +90,7 @@ export { serializeError };
 export { forEachAsync };
 export { isValidJsonString };
 export { prompt };
+export { promptTemplate };
 export { $getCurrentDate };
 export { $isRunningInBrowser };
 export { $isRunningInJest };

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

@@ -2,11 +2,13 @@ import type { PipelineExecutorResult } from './PipelineExecutorResult';
 /**
  * Asserts that the execution of a Promptbook is successful
  *
+ * Note: If there are only warnings, the execution is still successful but the warnings are logged in the console
+ *
  * @param executionResult - The partial result of the Promptbook execution
  * @throws {PipelineExecutionError} If the execution is not successful or if multiple errors occurred
  * @public exported from `@promptbook/core`
  */
-export declare function assertsExecutionSuccessful(executionResult: Pick<PipelineExecutorResult, 'isSuccessful' | 'errors'>): void;
+export declare function assertsExecutionSuccessful(executionResult: Pick<PipelineExecutorResult, 'isSuccessful' | 'errors' | 'warnings'>): void;
 /**
  * TODO: [🐚] This function should be removed OR changed OR be completely rewritten
  * TODO: [🧠] Can this return type be better typed than void

package/esm/typings/src/pipeline/book-notation.d.ts

@@ -2,9 +2,10 @@ import type { PipelineString } from './PipelineString';
 /**
  * Tag function for notating a pipeline with a book\`...\ notation as template literal
  *
- * Note: There are 2 similar functions:
+ * Note: There are 3 similar functions:
  * 1) `prompt` for notating single prompt exported from `@promptbook/utils`
- * 1) `book` for notating and validating entire books exported from `@promptbook/utils`
+ * 2) `promptTemplate` alias for `prompt`
+ * 3) `book` for notating and validating entire books exported from `@promptbook/utils`
  *
  * @param strings @@@
  * @param values @@@

package/esm/typings/src/pipeline/prompt-notation.d.ts

@@ -2,16 +2,29 @@ import type { string_prompt } from '../types/typeAliases';
 /**
  * Tag function for notating a prompt as template literal
  *
- * Note: There are 2 similar functions:
+ * Note: There are 3 similar functions:
  * 1) `prompt` for notating single prompt exported from `@promptbook/utils`
- * 1) `book` for notating and validating entire books exported from `@promptbook/utils`
+ * 2) `promptTemplate` alias for `prompt`
+ * 3) `book` for notating and validating entire books exported from `@promptbook/utils`
  *
- * @param strings @@@
- * @param values @@@
- * @returns the pipeline string
+ * @param strings
+ * @param values
+ * @returns the prompt string
  * @public exported from `@promptbook/utils`
  */
 export declare function prompt(strings: TemplateStringsArray, ...values: Array<string>): string_prompt;
+/**
+ * Tag function for notating a prompt as template literal
+ *
+ * Note: There are 3 similar functions:
+ * 1) `prompt` for notating single prompt exported from `@promptbook/utils`
+ * 2) `promptTemplate` alias for `prompt`
+ * 3) `book` for notating and validating entire books exported from `@promptbook/utils`
+ *
+ * @alias prompt
+ * @public exported from `@promptbook/utils`
+ */
+export declare const promptTemplate: typeof prompt;
 /**
  * TODO: [🧠][🈴] Where is the best location for this file
  * Note: [💞] Ignore a discrepancy between file name and entity name

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.84.0-10",
+    "version": "0.84.0-11",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,
@@ -52,6 +52,6 @@
     ],
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.84.0-10"
+        "@promptbook/core": "0.84.0-11"
     }
 }