@promptbook/types 0.59.0-0 → 0.59.0-1

package/README.md

@@ -555,7 +555,7 @@ You can define postprocessing functions when creating `JavascriptEvalExecutionTo
 
 ```
 
-Additionally there are some usefull string-manipulation build-in functions, which are [listed here](src/execution/plugins/script-execution-tools/javascript/JavascriptEvalExecutionTools.ts).
+Additionally there are some usefull string-manipulation build-in functions, which are [listed here](src/scripting/javascript/JavascriptEvalExecutionTools.ts).
 
 ### Expectations
 

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.58.0';
+var PROMPTBOOK_VERSION = '0.59.0-0';
 
 export { EXPECTATION_UNITS, PROMPTBOOK_VERSION };
 //# sourceMappingURL=index.es.js.map

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

@@ -1,18 +1,28 @@
 import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
 import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
 import type { PromptbookString } from '../types/PromptbookString';
+/**
+ * Options for promptbookStringToJson
+ */
+type PromptbookStringToJsonOptions = {
+    /**
+     * Tools for processing required for knowledge processing *(not for actual execution)*
+     */
+    llmTools?: LlmExecutionTools;
+};
 /**
  * Compile promptbook from string (markdown) format to JSON format
  *
  * @param promptbookString {Promptbook} in string markdown format (.ptbk.md)
- * @param llmTools {LlmExecutionTools} - tools for processing required for knowledge processing *(not for actual execution)*
+ * @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 promptbookStringToJson(promptbookString: PromptbookString, llmTools?: LlmExecutionTools): Promise<PromptbookJson>;
+export declare function promptbookStringToJson(promptbookString: PromptbookString, options?: PromptbookStringToJsonOptions): Promise<PromptbookJson>;
+export {};
 /**
  * TODO: Report here line/column of error
  * TODO: Use spaceTrim more effectively

package/esm/typings/knowledge/prepare-knowledge/markdown/playground/markdown-knowledge-playground.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env ts-node
+export {};

package/esm/typings/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts

@@ -1,5 +1,5 @@
-import type { KnowledgeJson } from '../../../types/PromptbookJson/KnowledgeJson';
 import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
+import type { KnowledgeJson } from '../../../types/PromptbookJson/KnowledgeJson';
 import type { string_markdown } from '../../../types/typeAliases';
 export declare function prepareKnowledgeFromMarkdown(options: {
     content: string_markdown;

package/esm/typings/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts

@@ -0,0 +1,16 @@
+import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
+import type { KnowledgeJson } from '../../../types/PromptbookJson/KnowledgeJson';
+import type { string_base64 } from '../../../types/typeAliases';
+type PrepareKnowledgeFromPdfOptions = {
+    /**
+     * The source of the knowledge in PDF format
+     */
+    content: string_base64;
+    llmTools: LlmExecutionTools;
+};
+export declare function prepareKnowledgeFromPdf(options: PrepareKnowledgeFromPdfOptions): Promise<KnowledgeJson>;
+export {};
+/**
+ * TODO: [🧺] In future, content can be alse File or Blob BUT for now for wider compatibility its only base64
+ *       @see https://stackoverflow.com/questions/14653349/node-js-cant-create-blobs
+ */

package/esm/typings/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.test.d.ts

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

package/esm/typings/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts

@@ -37,6 +37,7 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
     listModels(): Array<AvailableModel>;
 }
 /**
+ * TODO: !!!! [🍆] JSON mode
  * TODO: [🧠] Maybe handle errors via transformAnthropicError (like transformAzureError)
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom OpenaiError

package/esm/typings/types/typeAliases.d.ts

@@ -193,7 +193,13 @@ export type string_promptbook_url_with_hashtemplate = string;
  *
  * For example `"data:text/plain;base64,SGVsbG8sIFdvcmxkIQ=="`
  */
-export type string_data_url = string;
+export type string_data_url = `data:${string_mime_type};base64,${string_base64}`;
+/**
+ * Semantic helper
+ *
+ * For example `"SGVsbG8sIFdvcmxkIQ=="`
+ */
+export type string_base64 = string;
 /**
  * Semantic helper
  *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.59.0-0",
+    "version": "0.59.0-1",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -45,7 +45,7 @@
         }
     ],
     "peerDependencies": {
-        "@promptbook/core": "0.59.0-0"
+        "@promptbook/core": "0.59.0-1"
     },
     "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.58.0';
+	var PROMPTBOOK_VERSION = '0.59.0-0';
 
 	exports.EXPECTATION_UNITS = EXPECTATION_UNITS;
 	exports.PROMPTBOOK_VERSION = PROMPTBOOK_VERSION;

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

@@ -1,18 +1,28 @@
 import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
 import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
 import type { PromptbookString } from '../types/PromptbookString';
+/**
+ * Options for promptbookStringToJson
+ */
+type PromptbookStringToJsonOptions = {
+    /**
+     * Tools for processing required for knowledge processing *(not for actual execution)*
+     */
+    llmTools?: LlmExecutionTools;
+};
 /**
  * Compile promptbook from string (markdown) format to JSON format
  *
  * @param promptbookString {Promptbook} in string markdown format (.ptbk.md)
- * @param llmTools {LlmExecutionTools} - tools for processing required for knowledge processing *(not for actual execution)*
+ * @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 promptbookStringToJson(promptbookString: PromptbookString, llmTools?: LlmExecutionTools): Promise<PromptbookJson>;
+export declare function promptbookStringToJson(promptbookString: PromptbookString, options?: PromptbookStringToJsonOptions): Promise<PromptbookJson>;
+export {};
 /**
  * TODO: Report here line/column of error
  * TODO: Use spaceTrim more effectively

package/umd/typings/knowledge/prepare-knowledge/markdown/playground/markdown-knowledge-playground.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env ts-node
+export {};

package/umd/typings/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts

@@ -1,5 +1,5 @@
-import type { KnowledgeJson } from '../../../types/PromptbookJson/KnowledgeJson';
 import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
+import type { KnowledgeJson } from '../../../types/PromptbookJson/KnowledgeJson';
 import type { string_markdown } from '../../../types/typeAliases';
 export declare function prepareKnowledgeFromMarkdown(options: {
     content: string_markdown;

package/umd/typings/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts

@@ -0,0 +1,16 @@
+import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
+import type { KnowledgeJson } from '../../../types/PromptbookJson/KnowledgeJson';
+import type { string_base64 } from '../../../types/typeAliases';
+type PrepareKnowledgeFromPdfOptions = {
+    /**
+     * The source of the knowledge in PDF format
+     */
+    content: string_base64;
+    llmTools: LlmExecutionTools;
+};
+export declare function prepareKnowledgeFromPdf(options: PrepareKnowledgeFromPdfOptions): Promise<KnowledgeJson>;
+export {};
+/**
+ * TODO: [🧺] In future, content can be alse File or Blob BUT for now for wider compatibility its only base64
+ *       @see https://stackoverflow.com/questions/14653349/node-js-cant-create-blobs
+ */

package/umd/typings/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.test.d.ts

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

package/umd/typings/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts

@@ -37,6 +37,7 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
     listModels(): Array<AvailableModel>;
 }
 /**
+ * TODO: !!!! [🍆] JSON mode
  * TODO: [🧠] Maybe handle errors via transformAnthropicError (like transformAzureError)
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom OpenaiError

package/umd/typings/types/typeAliases.d.ts

@@ -193,7 +193,13 @@ export type string_promptbook_url_with_hashtemplate = string;
  *
  * For example `"data:text/plain;base64,SGVsbG8sIFdvcmxkIQ=="`
  */
-export type string_data_url = string;
+export type string_data_url = `data:${string_mime_type};base64,${string_base64}`;
+/**
+ * Semantic helper
+ *
+ * For example `"SGVsbG8sIFdvcmxkIQ=="`
+ */
+export type string_base64 = string;
 /**
  * Semantic helper
  *