@promptbook/markdown-utils 0.92.0-11 → 0.92.0-13

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

@@ -1,10 +1,12 @@
 import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
 import { SimplePromptInterfaceTools } from '../dialogs/simple-prompt/SimplePromptInterfaceTools';
 import { $provideScrapersForBrowser } from '../scrapers/_common/register/$provideScrapersForBrowser';
+import { getIndexedDbStorage } from '../storage/local-storage/getIndexedDbStorage';
 import { getLocalStorage } from '../storage/local-storage/getLocalStorage';
 import { getSessionStorage } from '../storage/local-storage/getSessionStorage';
 export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
 export { SimplePromptInterfaceTools };
 export { $provideScrapersForBrowser };
+export { getIndexedDbStorage };
 export { getLocalStorage };
 export { getSessionStorage };

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

@@ -62,6 +62,7 @@ import { PromptbookFetchError } from '../errors/PromptbookFetchError';
 import { UnexpectedError } from '../errors/UnexpectedError';
 import { WrappedError } from '../errors/WrappedError';
 import { createPipelineExecutor } from '../execution/createPipelineExecutor/00-createPipelineExecutor';
+import { computeCosineSimilarity } from '../execution/createPipelineExecutor/computeCosineSimilarity';
 import { embeddingVectorToString } from '../execution/embeddingVectorToString';
 import { executionReportJsonToString } from '../execution/execution-report/executionReportJsonToString';
 import type { ExecutionReportStringOptions } from '../execution/execution-report/ExecutionReportStringOptions';
@@ -74,10 +75,10 @@ import { ZERO_USAGE } from '../execution/utils/usage-constants';
 import { UNCERTAIN_USAGE } from '../execution/utils/usage-constants';
 import { usageToHuman } from '../execution/utils/usageToHuman';
 import { usageToWorktime } from '../execution/utils/usageToWorktime';
-import { CsvFormatDefinition } from '../formats/csv/CsvFormatDefinition';
 import { CsvFormatError } from '../formats/csv/CsvFormatError';
+import { CsvFormatParser } from '../formats/csv/CsvFormatParser';
 import { MANDATORY_CSV_SETTINGS } from '../formats/csv/CsvSettings';
-import { TextFormatDefinition } from '../formats/text/TextFormatDefinition';
+import { TextFormatParser } from '../formats/text/TextFormatParser';
 import { BoilerplateFormfactorDefinition } from '../formfactors/_boilerplate/BoilerplateFormfactorDefinition';
 import { ChatbotFormfactorDefinition } from '../formfactors/chatbot/ChatbotFormfactorDefinition';
 import { GeneratorFormfactorDefinition } from '../formfactors/generator/GeneratorFormfactorDefinition';
@@ -203,6 +204,7 @@ export { PromptbookFetchError };
 export { UnexpectedError };
 export { WrappedError };
 export { createPipelineExecutor };
+export { computeCosineSimilarity };
 export { embeddingVectorToString };
 export { executionReportJsonToString };
 export type { ExecutionReportStringOptions };
@@ -215,10 +217,10 @@ export { ZERO_USAGE };
 export { UNCERTAIN_USAGE };
 export { usageToHuman };
 export { usageToWorktime };
-export { CsvFormatDefinition };
 export { CsvFormatError };
+export { CsvFormatParser };
 export { MANDATORY_CSV_SETTINGS };
-export { TextFormatDefinition };
+export { TextFormatParser };
 export { BoilerplateFormfactorDefinition };
 export { ChatbotFormfactorDefinition };
 export { GeneratorFormfactorDefinition };

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

@@ -61,7 +61,7 @@ import type { Usage } from '../execution/Usage';
 import type { UsageCounts } from '../execution/Usage';
 import type { UserInterfaceTools } from '../execution/UserInterfaceTools';
 import type { UserInterfaceToolsPromptDialogOptions } from '../execution/UserInterfaceTools';
-import type { FormatSubvalueDefinition } from '../formats/_common/FormatSubvalueDefinition';
+import type { FormatSubvalueParser } from '../formats/_common/FormatSubvalueParser';
 import type { CsvSettings } from '../formats/csv/CsvSettings';
 import type { AbstractFormfactorDefinition } from '../formfactors/_common/AbstractFormfactorDefinition';
 import type { FormfactorDefinition } from '../formfactors/_common/FormfactorDefinition';
@@ -357,7 +357,7 @@ export type { Usage };
 export type { UsageCounts };
 export type { UserInterfaceTools };
 export type { UserInterfaceToolsPromptDialogOptions };
-export type { FormatSubvalueDefinition };
+export type { FormatSubvalueParser };
 export type { CsvSettings };
 export type { AbstractFormfactorDefinition };
 export type { FormfactorDefinition };

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

@@ -22,8 +22,10 @@ export type PipelineExecutorResult = AbstractTaskResult & {
     readonly usage: ReadonlyDeep<Usage>;
     /**
      * The report of the execution with all details
+     *
+     * Note: If the execution fails unexpectedly, this will be `null`
      */
-    readonly executionReport: ReadonlyDeep<ExecutionReportJson>;
+    readonly executionReport: ReadonlyDeep<ExecutionReportJson> | null;
     /**
      * The prepared pipeline that was used for the execution
      *

package/esm/typings/src/execution/createPipelineExecutor/computeCosineSimilarity.d.ts

@@ -0,0 +1,13 @@
+import type { EmbeddingVector } from '../EmbeddingVector';
+/**
+ * Computes the cosine similarity between two embedding vectors
+ *
+ * Note: This is helping function for RAG (retrieval-augmented generation)
+ *
+ * @param embeddingVector1
+ * @param embeddingVector2
+ * @returns Cosine similarity between the two vectors
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare function computeCosineSimilarity(embeddingVector1: EmbeddingVector, embeddingVector2: EmbeddingVector): number;

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

@@ -24,6 +24,6 @@ export declare function checkExpectations(expectations: Expectations, value: str
 export declare function isPassingExpectations(expectations: Expectations, value: string): boolean;
 /**
  * TODO: [💝] Unite object for expecting amount and format
- * TODO: [🧠][🤠] This should be part of `TextFormatDefinition`
+ * TODO: [🧠][🤠] This should be part of `TextFormatParser`
  * Note: [💝] and [🤠] are interconnected together
  */

package/esm/typings/src/formats/_common/{FormatDefinition.d.ts → FormatParser.d.ts}

@@ -2,7 +2,7 @@ import type { string_mime_type } from '../../types/typeAliases';
 import type { string_name } from '../../types/typeAliases';
 import type { string_SCREAMING_CASE } from '../../utils/normalization/normalizeTo_SCREAMING_CASE';
 import type { empty_object } from '../../utils/organization/empty_object';
-import type { FormatSubvalueDefinition } from './FormatSubvalueDefinition';
+import type { FormatSubvalueParser } from './FormatSubvalueParser';
 /**
  * A format definition is a set of functions that define how to validate, heal and convert response from LLM
  *
@@ -11,7 +11,7 @@ import type { FormatSubvalueDefinition } from './FormatSubvalueDefinition';
  * @see https://github.com/webgptorg/promptbook/discussions/36
  * @private still in development [🏢]
  */
-export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSettings extends empty_object, TSchema extends empty_object> = {
+export type FormatParser<TValue extends TPartialValue, TPartialValue extends string, TSettings extends empty_object, TSchema extends empty_object> = {
     /**
      * The name of the format used in .book.md files
      *
@@ -58,7 +58,7 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
     /**
      * @@@
      */
-    readonly subvalueDefinitions: ReadonlyArray<FormatSubvalueDefinition<TValue, TSettings>>;
+    readonly subvalueParsers: ReadonlyArray<FormatSubvalueParser<TValue, TSettings>>;
 };
 /**
  * TODO: [♏] Add some prepare hook to modify prompt according to the format

package/esm/typings/src/formats/_common/{FormatSubvalueDefinition.d.ts → FormatSubvalueParser.d.ts}

@@ -7,7 +7,7 @@ import type { empty_object } from '../../utils/organization/empty_object';
 /**
  * @@@
  */
-export type FormatSubvalueDefinition<TValue extends string, TSettings extends empty_object> = {
+export type FormatSubvalueParser<TValue extends string, TSettings extends empty_object> = {
     /**
      * The name of the format used in .book.md files
      *

package/esm/typings/src/formats/csv/CsvFormatParser.d.ts

@@ -0,0 +1,17 @@
+import type { TODO_any } from '../../utils/organization/TODO_any';
+import type { FormatParser } from '../_common/FormatParser';
+import type { CsvSettings } from './CsvSettings';
+/**
+ * Definition for CSV spreadsheet
+ *
+ * @public exported from `@promptbook/core`
+ *                          <- TODO: [🏢] Export from package `@promptbook/csv`
+ */
+export declare const CsvFormatParser: FormatParser<string, string, CsvSettings, TODO_any>;
+/**
+ * TODO: [🍓] In `CsvFormatParser` implement simple `isValid`
+ * TODO: [🍓] In `CsvFormatParser` implement partial `canBeValid`
+ * TODO: [🍓] In `CsvFormatParser` implement `heal
+ * TODO: [🍓] In `CsvFormatParser` implement `subvalueParsers`
+ * TODO: [🏢] Allow to expect something inside CSV objects and other formats
+ */

package/esm/typings/src/formats/index.d.ts

@@ -3,7 +3,7 @@
  *
  * @private internal index of `...` <- TODO [🏢]
  */
-export declare const FORMAT_DEFINITIONS: readonly [import("./_common/FormatDefinition").FormatDefinition<string, string, any, any>, import("./_common/FormatDefinition").FormatDefinition<string, string, any, any>, import("./_common/FormatDefinition").FormatDefinition<string, string, any, any>, import("./_common/FormatDefinition").FormatDefinition<string, string, import("./csv/CsvSettings").CsvSettings, any>];
+export declare const FORMAT_DEFINITIONS: readonly [import("./_common/FormatParser").FormatParser<string, string, any, any>, import("./_common/FormatParser").FormatParser<string, string, any, any>, import("./_common/FormatParser").FormatParser<string, string, any, any>, import("./_common/FormatParser").FormatParser<string, string, import("./csv/CsvSettings").CsvSettings, any>];
 /**
  * Note: [💞] Ignore a discrepancy between file name and entity name
- */ 
+ */

package/esm/typings/src/formats/json/{JsonFormatDefinition.d.ts → JsonFormatParser.d.ts}

@@ -1,19 +1,19 @@
 import type { TODO_any } from '../../utils/organization/TODO_any';
-import type { FormatDefinition } from '../_common/FormatDefinition';
+import type { FormatParser } from '../_common/FormatParser';
 /**
  * Definition for JSON format
  *
  * @private still in development [🏢]
  */
-export declare const JsonFormatDefinition: FormatDefinition<string, string, TODO_any, TODO_any>;
+export declare const JsonFormatParser: FormatParser<string, string, TODO_any, TODO_any>;
 /**
  * TODO: [🧠] Maybe propper instance of object
  * TODO: [0] Make string_serialized_json
  * TODO: [1] Make type for JSON Settings and Schema
  * TODO: [🧠] What to use for validating JSONs - JSON Schema, ZoD, typescript types/interfaces,...?
- * TODO: [🍓] In `JsonFormatDefinition` implement simple `isValid`
- * TODO: [🍓] In `JsonFormatDefinition` implement partial `canBeValid`
- * TODO: [🍓] In `JsonFormatDefinition` implement `heal
- * TODO: [🍓] In `JsonFormatDefinition` implement `subvalueDefinitions`
+ * TODO: [🍓] In `JsonFormatParser` implement simple `isValid`
+ * TODO: [🍓] In `JsonFormatParser` implement partial `canBeValid`
+ * TODO: [🍓] In `JsonFormatParser` implement `heal
+ * TODO: [🍓] In `JsonFormatParser` implement `subvalueParsers`
  * TODO: [🏢] Allow to expect something inside JSON objects and other formats
  */

package/esm/typings/src/formats/text/{TextFormatDefinition.d.ts → TextFormatParser.d.ts}

@@ -1,19 +1,19 @@
 import type { TODO_any } from '../../utils/organization/TODO_any';
-import type { FormatDefinition } from '../_common/FormatDefinition';
+import type { FormatParser } from '../_common/FormatParser';
 /**
  * Definition for any text - this will be always valid
  *
- * Note: This is not useful for validation, but for splitting and mapping with `subvalueDefinitions`
+ * Note: This is not useful for validation, but for splitting and mapping with `subvalueParsers`
  *
  * @public exported from `@promptbook/core`
  */
-export declare const TextFormatDefinition: FormatDefinition<string, string, TODO_any, TODO_any>;
+export declare const TextFormatParser: FormatParser<string, string, TODO_any, TODO_any>;
 /**
  * TODO: [1] Make type for XML Text and Schema
  * TODO: [🧠][🤠] Here should be all words, characters, lines, paragraphs, pages available as subvalues
- * TODO: [🍓] In `TextFormatDefinition` implement simple `isValid`
- * TODO: [🍓] In `TextFormatDefinition` implement partial `canBeValid`
- * TODO: [🍓] In `TextFormatDefinition` implement `heal
- * TODO: [🍓] In `TextFormatDefinition` implement `subvalueDefinitions`
+ * TODO: [🍓] In `TextFormatParser` implement simple `isValid`
+ * TODO: [🍓] In `TextFormatParser` implement partial `canBeValid`
+ * TODO: [🍓] In `TextFormatParser` implement `heal
+ * TODO: [🍓] In `TextFormatParser` implement `subvalueParsers`
  * TODO: [🏢] Allow to expect something inside each item of list and other formats
  */

package/esm/typings/src/formats/xml/XmlFormatParser.d.ts

@@ -0,0 +1,19 @@
+import type { TODO_any } from '../../utils/organization/TODO_any';
+import type { FormatParser } from '../_common/FormatParser';
+/**
+ * Definition for XML format
+ *
+ * @private still in development [🏢]
+ */
+export declare const XmlFormatParser: FormatParser<string, string, TODO_any, TODO_any>;
+/**
+ * TODO: [🧠] Maybe propper instance of object
+ * TODO: [0] Make string_serialized_xml
+ * TODO: [1] Make type for XML Settings and Schema
+ * TODO: [🧠] What to use for validating XMLs - XSD,...
+ * TODO: [🍓] In `XmlFormatParser` implement simple `isValid`
+ * TODO: [🍓] In `XmlFormatParser` implement partial `canBeValid`
+ * TODO: [🍓] In `XmlFormatParser` implement `heal
+ * TODO: [🍓] In `XmlFormatParser` implement `subvalueParsers`
+ * TODO: [🏢] Allow to expect something inside XML and other formats
+ */

package/esm/typings/src/postprocessing/utils/extractJsonBlock.d.ts

@@ -21,5 +21,5 @@ import type { really_unknown } from '../../utils/organization/really_unknown';
 export declare function extractJsonBlock(markdown: string_markdown): string_json<really_unknown>;
 /**
  * TODO: Add some auto-healing logic + extract YAML, JSON5, TOML, etc.
- * TODO: [🏢] Make this logic part of `JsonFormatDefinition` or `isValidJsonString`
+ * TODO: [🏢] Make this logic part of `JsonFormatParser` or `isValidJsonString`
  */

package/esm/typings/src/storage/local-storage/getIndexedDbStorage.d.ts

@@ -0,0 +1,10 @@
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+/**
+ * Gets wrapper around IndexedDB which can be used as PromptbookStorage
+ *
+ * @public exported from `@promptbook/browser`
+ */
+export declare function getIndexedDbStorage<TItem>(): PromptbookStorage<TItem>;
+/**
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
+ */

package/esm/typings/src/storage/local-storage/utils/makePromptbookStorageFromIndexedDb.d.ts

@@ -0,0 +1,7 @@
+import type { PromptbookStorage } from '../../_common/PromptbookStorage';
+/**
+ * Creates a PromptbookStorage backed by IndexedDB.
+ * Uses a single object store named 'promptbook'.
+ * @private for `getIndexedDbStorage`
+ */
+export declare function makePromptbookStorageFromIndexedDb<TValue>(dbName?: string, storeName?: string): PromptbookStorage<TValue>;

package/esm/typings/src/utils/expectation-counters/index.d.ts

@@ -7,6 +7,6 @@ import type { ExpectationUnit } from '../../pipeline/PipelineJson/Expectations';
  */
 export declare const CountUtils: Record<ExpectationUnit, (text: string) => ExpectationAmount>;
 /**
- * TODO: [🧠][🤠] This should be probbably as part of `TextFormatDefinition`
+ * TODO: [🧠][🤠] This should be probbably as part of `TextFormatParser`
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/markdown-utils",
-    "version": "0.92.0-11",
+    "version": "0.92.0-13",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,