@promptbook/openai 0.59.0-0 → 0.59.0-14

package/{esm/typings → umd/typings/src}/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/src/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts

@@ -0,0 +1,19 @@
+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;
+    /**
+     * The LLM tools to use for the conversion and extraction of knowledge
+     */
+    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/{llm-providers → src/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 → umd/typings/src}/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts

@@ -24,5 +24,6 @@ export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
     listModels(): Array<AvailableModel>;
 }
 /**
+ * TODO: [🕵️‍♀️] Maybe just remove
  * TODO: Allow in spaceTrim: nesting with > ${block(prompt.request)}, same as replace params
  */

package/{esm/typings → umd/typings/src}/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts

@@ -23,3 +23,6 @@ export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools
      */
     listModels(): Array<AvailableModel>;
 }
+/**
+ * TODO: [🕵️‍♀️] Maybe just remove
+ */ 

package/umd/typings/src/llm-providers/multiple/playground/playground.d.ts

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

package/umd/typings/src/llm-providers/openai/playground/playground.d.ts

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

package/umd/typings/{types → src/types}/PromptbookJson/MaterialKnowledgePieceJson.d.ts

@@ -1,4 +1,4 @@
-import { IVectorData } from 'xyzt';
+import type { IVectorData } from 'xyzt';
 import type { string_keyword } from '../../utils/normalization/IKeywords';
 import type { string_href } from '../typeAliases';
 import type { string_markdown } from '../typeAliases';

package/umd/typings/{types → src/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/umd/typings/src/utils/unwrapResult.test.d.ts

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

package/umd/typings/src/utils/validators/url/isValidUrl.test.d.ts

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

package/{umd/typings → esm/typings/src}/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;