@promptbook/openai 0.44.0-4 → 0.44.0-6

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 { 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';
@@ -40,9 +41,9 @@ import { removeQuotes } from '../utils/removeQuotes';
 import { trimCodeBlock } from '../utils/trimCodeBlock';
 import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
 import { unwrapResult } from '../utils/unwrapResult';
-export { assertsExecutionSuccessful, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, extractAllBlocksFromMarkdown, // <- [🌻]
+export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, extractAllBlocksFromMarkdown, // <- [🌻]
 extractAllListItemsFromMarkdown, extractBlock, // <- [🌻]
-extractOneBlockFromMarkdown, isValidJsonString, parseNumber, // <- [🌻]
+extractOneBlockFromMarkdown, isPassingExpectations, isValidJsonString, parseNumber, // <- [🌻]
 prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 export { countCharacters, countLines, countPages, countParagraphs, countSentences, CountUtils, countWords };
 export { splitIntoSentences };

package/esm/typings/execution/plugins/natural-execution-tools/mocked/fakeTextToExpectations.d.ts

@@ -5,3 +5,7 @@ import type { Expectations } from '../../../../types/PromptbookJson/PromptTempla
  * @private internal util for MockedFackedNaturalExecutionTools
  */
 export declare function $fakeTextToExpectations(expectations: Expectations): string;
+/**
+ * TODO: Implement better
+ * TODO: [💝] Unite object for expecting amount and format - use here also a format
+ */

package/esm/typings/execution/plugins/natural-execution-tools/mocked/fakeTextToExpectations.test.d.ts

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

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

@@ -0,0 +1,25 @@
+import type { Expectations } from '../../types/PromptbookJson/PromptTemplateJson';
+/**
+ * Function checkExpectations will check if the expectations on given value are met
+ *
+ * Note: There are two simmilar functions:
+ * - `checkExpectations` which throws an error if the expectations are not met
+ * - `isPassingExpectations` which returns a boolean
+ *
+ * @throws {ExpectError} if the expectations are not met
+ * @returns {void} Nothing
+ */
+export declare function checkExpectations(expectations: Expectations, value: string): void;
+/**
+ * Function checkExpectations will check if the expectations on given value are met
+ *
+ * Note: There are two simmilar functions:
+ * - `checkExpectations` which throws an error if the expectations are not met
+ * - `isPassingExpectations` which returns a boolean
+ *
+ * @returns {boolean} True if the expectations are met
+ */
+export declare function isPassingExpectations(expectations: Expectations, value: string): boolean;
+/**
+ * TODO: [💝] Unite object for expecting amount and format
+ */

package/esm/typings/execution/utils/checkExpectations.test.d.ts

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

package/esm/typings/types/PromptbookJson/PromptTemplateJson.d.ts

@@ -130,5 +130,6 @@ interface PromptTemplateJsonCommon {
 }
 export {};
 /**
+ * TODO: [💝] Unite object for expecting amount and format - remove expectFormat
  * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.44.0-4",
+    "version": "0.44.0-6",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -38,7 +38,7 @@
         "openai": "4.2.0"
     },
     "peerDependencies": {
-        "@promptbook/core": "0.44.0-4"
+        "@promptbook/core": "0.44.0-6"
     },
     "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 { 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';
@@ -40,9 +41,9 @@ import { removeQuotes } from '../utils/removeQuotes';
 import { trimCodeBlock } from '../utils/trimCodeBlock';
 import { trimEndOfCodeBlock } from '../utils/trimEndOfCodeBlock';
 import { unwrapResult } from '../utils/unwrapResult';
-export { assertsExecutionSuccessful, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, extractAllBlocksFromMarkdown, // <- [🌻]
+export { assertsExecutionSuccessful, checkExpectations, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, extractAllBlocksFromMarkdown, // <- [🌻]
 extractAllListItemsFromMarkdown, extractBlock, // <- [🌻]
-extractOneBlockFromMarkdown, isValidJsonString, parseNumber, // <- [🌻]
+extractOneBlockFromMarkdown, isPassingExpectations, isValidJsonString, parseNumber, // <- [🌻]
 prettifyPromptbookString, removeContentComments, removeEmojis, removeMarkdownFormatting, removeQuotes, replaceParameters, trimCodeBlock, trimEndOfCodeBlock, unwrapResult, };
 export { countCharacters, countLines, countPages, countParagraphs, countSentences, CountUtils, countWords };
 export { splitIntoSentences };

package/umd/typings/execution/plugins/natural-execution-tools/mocked/fakeTextToExpectations.d.ts

@@ -5,3 +5,7 @@ import type { Expectations } from '../../../../types/PromptbookJson/PromptTempla
  * @private internal util for MockedFackedNaturalExecutionTools
  */
 export declare function $fakeTextToExpectations(expectations: Expectations): string;
+/**
+ * TODO: Implement better
+ * TODO: [💝] Unite object for expecting amount and format - use here also a format
+ */

package/umd/typings/execution/plugins/natural-execution-tools/mocked/fakeTextToExpectations.test.d.ts

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

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

@@ -0,0 +1,25 @@
+import type { Expectations } from '../../types/PromptbookJson/PromptTemplateJson';
+/**
+ * Function checkExpectations will check if the expectations on given value are met
+ *
+ * Note: There are two simmilar functions:
+ * - `checkExpectations` which throws an error if the expectations are not met
+ * - `isPassingExpectations` which returns a boolean
+ *
+ * @throws {ExpectError} if the expectations are not met
+ * @returns {void} Nothing
+ */
+export declare function checkExpectations(expectations: Expectations, value: string): void;
+/**
+ * Function checkExpectations will check if the expectations on given value are met
+ *
+ * Note: There are two simmilar functions:
+ * - `checkExpectations` which throws an error if the expectations are not met
+ * - `isPassingExpectations` which returns a boolean
+ *
+ * @returns {boolean} True if the expectations are met
+ */
+export declare function isPassingExpectations(expectations: Expectations, value: string): boolean;
+/**
+ * TODO: [💝] Unite object for expecting amount and format
+ */

package/umd/typings/execution/utils/checkExpectations.test.d.ts

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

package/umd/typings/types/PromptbookJson/PromptTemplateJson.d.ts

@@ -130,5 +130,6 @@ interface PromptTemplateJsonCommon {
 }
 export {};
 /**
+ * TODO: [💝] Unite object for expecting amount and format - remove expectFormat
  * TODO: use one helper type> (string_prompt | string_javascript | string_markdown) & string_template
  */