@promptbook/types 0.59.0-32 → 0.59.0-34

package/esm/index.es.js

@@ -11,7 +11,7 @@ var EXPECTATION_UNITS = ['CHARACTERS', 'WORDS', 'SENTENCES', 'LINES', 'PARAGRAPH
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.59.0-31';
+var PROMPTBOOK_VERSION = '0.59.0-33';
 
 export { EXPECTATION_UNITS, PROMPTBOOK_VERSION };
 //# sourceMappingURL=index.es.js.map

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

@@ -1,6 +1,7 @@
 import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
 import { promptbookJsonToString } from '../conversion/promptbookJsonToString';
 import { promptbookStringToJson } from '../conversion/promptbookStringToJson';
+import { promptbookStringToJsonSync } from '../conversion/promptbookStringToJsonSync';
 import { validatePromptbook } from '../conversion/validation/validatePromptbook';
 import { ExpectError } from '../errors/_ExpectError';
 import { PromptbookExecutionError } from '../errors/PromptbookExecutionError';
@@ -37,7 +38,7 @@ export { ExecutionTypes };
 export { addUsage, assertsExecutionSuccessful, checkExpectations, embeddingVectorToString, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prepareKnowledgeFromMarkdown, prettifyPromptbookString, usageToWorktime, };
 export { createLibraryFromJson, createLibraryFromPromise, createLibraryFromUrl, createSublibrary, libraryToJson };
 export { SimplePromptInterfaceTools };
-export { promptbookJsonToString, promptbookStringToJson, validatePromptbook };
+export { promptbookJsonToString, promptbookStringToJson, promptbookStringToJsonSync, validatePromptbook };
 export { createPromptbookExecutor, MultipleLlmExecutionTools };
 export { CallbackInterfaceTools, CallbackInterfaceToolsOptions };
 export { ExpectError, PromptbookExecutionError, PromptbookLibraryError, PromptbookLogicError, PromptbookNotFoundError, PromptbookReferenceError, PromptbookSyntaxError, TemplateError, UnexpectedError, };

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

@@ -13,6 +13,10 @@ type PromptbookStringToJsonOptions = {
 /**
  * Compile promptbook from string (markdown) format to JSON format
  *
+ * Note: There are two similar functions:
+ * - `promptbookStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
+ * - `promptbookStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ *
  * @param promptbookString {Promptbook} in string markdown format (.ptbk.md)
  * @param options - Options and tools for the compilation
  * @returns {Promptbook} compiled in JSON format (.ptbk.json)
@@ -24,8 +28,5 @@ type PromptbookStringToJsonOptions = {
 export declare function promptbookStringToJson(promptbookString: PromptbookString, options?: PromptbookStringToJsonOptions): Promise<PromptbookJson>;
 export {};
 /**
- * TODO: Report here line/column of error
- * TODO: Use spaceTrim more effectively
- * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  */

package/esm/typings/src/conversion/promptbookStringToJsonSync.d.ts

@@ -0,0 +1,23 @@
+import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
+import type { PromptbookString } from '../types/PromptbookString';
+/**
+ * Compile promptbook from string (markdown) format to JSON format synchronously
+ *
+ * Note: There are two similar functions:
+ * - `promptbookStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
+ * - `promptbookStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ *
+ * @param promptbookString {Promptbook} in string markdown format (.ptbk.md)
+ * @param options - Options and tools for the compilation
+ * @returns {Promptbook} compiled in JSON format (.ptbk.json)
+ * @throws {PromptbookSyntaxError} if the promptbook string is not valid
+ *
+ * Note: This function does not validate logic of the pipeline only the syntax
+ * Note: This function acts as compilation process
+ */
+export declare function promptbookStringToJsonSync(promptbookString: PromptbookString): PromptbookJson;
+/**
+ * TODO: Report here line/column of error
+ * TODO: Use spaceTrim more effectively
+ * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
+ */

package/esm/typings/src/conversion/promptbookStringToJsonSync.test.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.59.0-32",
+    "version": "0.59.0-34",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -45,7 +45,7 @@
         }
     ],
     "peerDependencies": {
-        "@promptbook/core": "0.59.0-32"
+        "@promptbook/core": "0.59.0-34"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

package/umd/index.umd.js

@@ -17,7 +17,7 @@
 	/**
 	 * The version of the Promptbook library
 	 */
-	var PROMPTBOOK_VERSION = '0.59.0-31';
+	var PROMPTBOOK_VERSION = '0.59.0-33';
 
 	exports.EXPECTATION_UNITS = EXPECTATION_UNITS;
 	exports.PROMPTBOOK_VERSION = PROMPTBOOK_VERSION;

package/umd/typings/src/_packages/core.index.d.ts

@@ -1,6 +1,7 @@
 import { prettifyPromptbookString } from '../conversion/prettify/prettifyPromptbookString';
 import { promptbookJsonToString } from '../conversion/promptbookJsonToString';
 import { promptbookStringToJson } from '../conversion/promptbookStringToJson';
+import { promptbookStringToJsonSync } from '../conversion/promptbookStringToJsonSync';
 import { validatePromptbook } from '../conversion/validation/validatePromptbook';
 import { ExpectError } from '../errors/_ExpectError';
 import { PromptbookExecutionError } from '../errors/PromptbookExecutionError';
@@ -37,7 +38,7 @@ export { ExecutionTypes };
 export { addUsage, assertsExecutionSuccessful, checkExpectations, embeddingVectorToString, executionReportJsonToString, ExecutionReportStringOptions, ExecutionReportStringOptionsDefaults, isPassingExpectations, prepareKnowledgeFromMarkdown, prettifyPromptbookString, usageToWorktime, };
 export { createLibraryFromJson, createLibraryFromPromise, createLibraryFromUrl, createSublibrary, libraryToJson };
 export { SimplePromptInterfaceTools };
-export { promptbookJsonToString, promptbookStringToJson, validatePromptbook };
+export { promptbookJsonToString, promptbookStringToJson, promptbookStringToJsonSync, validatePromptbook };
 export { createPromptbookExecutor, MultipleLlmExecutionTools };
 export { CallbackInterfaceTools, CallbackInterfaceToolsOptions };
 export { ExpectError, PromptbookExecutionError, PromptbookLibraryError, PromptbookLogicError, PromptbookNotFoundError, PromptbookReferenceError, PromptbookSyntaxError, TemplateError, UnexpectedError, };

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

@@ -13,6 +13,10 @@ type PromptbookStringToJsonOptions = {
 /**
  * Compile promptbook from string (markdown) format to JSON format
  *
+ * Note: There are two similar functions:
+ * - `promptbookStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
+ * - `promptbookStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ *
  * @param promptbookString {Promptbook} in string markdown format (.ptbk.md)
  * @param options - Options and tools for the compilation
  * @returns {Promptbook} compiled in JSON format (.ptbk.json)
@@ -24,8 +28,5 @@ type PromptbookStringToJsonOptions = {
 export declare function promptbookStringToJson(promptbookString: PromptbookString, options?: PromptbookStringToJsonOptions): Promise<PromptbookJson>;
 export {};
 /**
- * TODO: Report here line/column of error
- * TODO: Use spaceTrim more effectively
- * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
  * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
  */

package/umd/typings/src/conversion/promptbookStringToJsonSync.d.ts

@@ -0,0 +1,23 @@
+import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
+import type { PromptbookString } from '../types/PromptbookString';
+/**
+ * Compile promptbook from string (markdown) format to JSON format synchronously
+ *
+ * Note: There are two similar functions:
+ * - `promptbookStringToJson` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
+ * - `promptbookStringToJsonSync` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ *
+ * @param promptbookString {Promptbook} in string markdown format (.ptbk.md)
+ * @param options - Options and tools for the compilation
+ * @returns {Promptbook} compiled in JSON format (.ptbk.json)
+ * @throws {PromptbookSyntaxError} if the promptbook string is not valid
+ *
+ * Note: This function does not validate logic of the pipeline only the syntax
+ * Note: This function acts as compilation process
+ */
+export declare function promptbookStringToJsonSync(promptbookString: PromptbookString): PromptbookJson;
+/**
+ * TODO: Report here line/column of error
+ * TODO: Use spaceTrim more effectively
+ * TODO: [🧠] Parameter flags - isInput, isOutput, isInternal
+ */

package/umd/typings/src/conversion/promptbookStringToJsonSync.test.d.ts

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