@promptbook/browser 0.92.0-23 → 0.92.0-25

package/esm/typings/src/scrapers/markdown/createMarkdownScraper.d.ts

@@ -2,7 +2,7 @@ import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
 import { MarkdownScraper } from './MarkdownScraper';
 /**
- * @@@
+ * Creates a scraper for markdown content.
  *
  * @public exported from `@promptbook/markdown-utils`
  */
@@ -13,6 +13,9 @@ export declare const createMarkdownScraper: ((tools: Pick<ExecutionTools, 'llm'>
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     isAvilableInBrowser: true;
+    /**
+     * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+     */
     requiredExecutables: never[];
 }>;
 /**

package/esm/typings/src/scrapers/markitdown/MarkitdownScraper.d.ts

@@ -37,7 +37,7 @@ export declare class MarkitdownScraper implements Converter, Scraper {
      */
     $convert(source: ScraperSourceHandler): Promise<ScraperIntermediateSource>;
     /**
-     * Scrapes the docx file and returns the knowledge pieces or `null` if it can't scrape it
+     * Scrapes the source document (PDF, DOCX, etc.) and returns the knowledge pieces or `null` if it can't scrape it.
      */
     scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
 }

package/esm/typings/src/scrapers/pdf/createPdfScraper.d.ts

@@ -2,7 +2,8 @@ import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
 import { PdfScraper } from './PdfScraper';
 /**
- * @@@
+ * Factory function to create an instance of PdfScraper.
+ * It bundles the scraper class with its metadata.
  *
  * @public exported from `@promptbook/pdf`
  */

package/esm/typings/src/scrapers/website/createWebsiteScraper.d.ts

@@ -2,7 +2,8 @@ import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
 import { WebsiteScraper } from './WebsiteScraper';
 /**
- * @@@
+ * Factory function to create an instance of WebsiteScraper.
+ * It bundles the scraper class with its metadata.
  *
  * @public exported from `@promptbook/website-crawler`
  */
@@ -12,9 +13,7 @@ export declare const createWebsiteScraper: ((tools: Pick<ExecutionTools, 'llm'>,
     className: string;
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvilableInBrowser: false; /**
-     * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
-     */
+    isAvilableInBrowser: false;
     requiredExecutables: never[];
 }>;
 /**

package/esm/typings/src/scripting/javascript/postprocessing-functions.d.ts

@@ -18,7 +18,11 @@ import { trimCodeBlock } from '../../utils/trimCodeBlock';
 import { trimEndOfCodeBlock } from '../../utils/trimEndOfCodeBlock';
 import { unwrapResult } from '../../utils/unwrapResult';
 /**
- * @@@
+ * Collection of utility functions that can be used for post-processing model outputs.
+ * These functions help transform, extract, or format the raw model responses.
+ *
+ * These utilities range from simple string manipulations to markdown processing
+ * and formatting functions for specific types of output.
  *
  * @public exported from `@promptbook/javascript`
  */

package/esm/typings/src/storage/file-cache-storage/FileCacheStorage.d.ts

@@ -2,7 +2,10 @@ import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { PromptbookStorage } from '../_common/PromptbookStorage';
 import type { FileCacheStorageOptions } from './FileCacheStorageOptions';
 /**
- * @@@
+ * A storage implementation that caches data in files organized in a directory structure.
+ * Provides methods for retrieving, storing, and managing cached data on the filesystem.
+ *
+ * This class implements the PromptbookStorage interface for filesystem-based caching.
  *
  * @public exported from `@promptbook/node`
  */
@@ -11,19 +14,23 @@ export declare class FileCacheStorage<TItem> implements PromptbookStorage<TItem>
     private readonly options;
     constructor(tools: Required<Pick<ExecutionTools, 'fs'>>, options: FileCacheStorageOptions);
     /**
-     * @@@
+     * Converts a storage key to a filesystem path where the data should be stored.
+     * Creates a consistent, deterministic file path based on the key string.
      */
     private getFilenameForKey;
     /**
-     * @@@ Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
+     * Returns the current value associated with the given key, or null if the given key does not exist.
+     * Retrieves the cached data from the file system storage.
      */
     getItem(key: string): Promise<TItem | null>;
     /**
-     * @@@ Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
+     * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
+     * Persists data to the file system, creating necessary directory structure if it doesn't exist.
      */
     setItem(key: string, value: TItem): Promise<void>;
     /**
-     * @@@ Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
+     * Removes the key/value pair with the given key from the storage, if a key/value pair with the given key exists.
+     * Deletes the corresponding file from the filesystem.
      */
     removeItem(key: string): Promise<void>;
 }

package/esm/typings/src/storage/file-cache-storage/FileCacheStorageOptions.d.ts

@@ -1,10 +1,12 @@
 import type { string_dirname } from '../../types/typeAliases';
 /**
- * @@@
+ * Configuration options for the FileCacheStorage implementation.
+ * Defines how and where file cache data should be stored and managed.
  */
 export type FileCacheStorageOptions = {
     /**
-     * @@@
+     * The absolute path to the root directory where cache files will be stored.
+     * This directory must exist and be writable by the application.
      */
     rootFolderPath: string_dirname;
 };

package/esm/typings/src/storage/file-cache-storage/utils/nameToSubfolderPath.d.ts

@@ -1,6 +1,7 @@
 import type { string_name } from '../../../types/typeAliases';
 /**
- * @@@
+ * Converts a name to a properly formatted subfolder path for cache storage.
+ * Handles normalization and path formatting to create consistent cache directory structures.
  *
  * @private for `FileCacheStorage`
  */

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

@@ -1,6 +1,7 @@
 import type { PromptbookStorage } from '../../_common/PromptbookStorage';
 /**
- * @@@
+ * Creates a Promptbook storage interface from a web storage object.
+ * Facilitates using Web Storage (localStorage/sessionStorage) as a storage backend.
  *
  * @private for `getLocalStorage` and `getSessionStorage`
  */

package/esm/typings/src/types/IntermediateFilesStrategy.d.ts

@@ -1,5 +1,6 @@
 /**
- * @@@
+ * Defines strategies for handling intermediate files during pipeline execution.
+ * Controls how temporary or intermediate files are managed throughout processing.
  */
 export type IntermediateFilesStrategy = 'HIDE_AND_CLEAN' | 'HIDE_AND_KEEP';
 /**

package/esm/typings/src/types/ModelVariant.d.ts

@@ -2,14 +2,14 @@ import type { TupleToUnion } from 'type-fest';
 /**
  * Model variant describes the very general type of the model
  *
- * There are two variants:
- * - **COMPLETION** - model that takes prompt and writes the rest of the text
- * - **CHAT** - model that takes prompt and previous messages and returns response
+ * There are theese supported model variants:
+ * - `COMPLETION` - Model that takes prompt and writes the rest of the text
+ * - `CHAT` - Model that takes prompt and previous messages and returns response
+ * - `EMBEDDING` - Model that convert text into vector representations
  */
 export type ModelVariant = TupleToUnion<typeof MODEL_VARIANTS>;
 /**
- * @@@
- *
+ * @see {@link ModelVariant}
  * @public exported from `@promptbook/core`
  */
 export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT", "EMBEDDING"];

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

@@ -149,27 +149,29 @@ export type string_persona_description = string;
  */
 export type string_model_description = string;
 /**
- * Source of one knowledge
+ * Source of one knowledge piece.
  *
- * It can be a link, a relative path to file or direct text
+ * It can be a link, a relative path to file or direct text content.
  *
  * For example `"https://pavolhejny.com/"`
  * For example `"./pavol-hejny-cv.pdf"`
  * For example `"Pavol Hejný has web https://pavolhejny.com/"`
  * For example `"Pavol Hejný is web developer and creator of Promptbook and Collboard"`
  *
- * @@@ string_knowledge_source vs string_knowledge_source_link
+ * Note: Distinguishes between `string_knowledge_source_content` and `string_knowledge_source_link`:
+ * `string_knowledge_source_content` refers to the actual content or source of knowledge
+ * `string_knowledge_source_link` refers to a reference or link to the knowledge source
  */
 export type string_knowledge_source_content = string_knowledge_source_link | string_markdown;
 /**
- * One link to knowledge source
+ * One link to a knowledge source.
  *
- * It can be a link or relative path
+ * It can be a URL or relative path.
  *
  * For example `"https://pavolhejny.com/"`
  * For example `"./pavol-hejny-cv.pdf"`
  *
- * @@@ string_knowledge_source vs string_knowledge_source_link
+ * Note: string_knowledge_source_link refers to a reference or link to the knowledge source, while string_knowledge_source_content can be the link or the actual content.
  */
 export type string_knowledge_source_link = string_url | string_filename;
 /**

package/esm/typings/src/utils/editable/edit-pipeline-string/addPipelineCommand.d.ts

@@ -5,7 +5,7 @@ type AddPipelineCommandOptions = {
     pipelineString: PipelineString;
 };
 /**
- * @@@
+ * Adds a new command to a pipeline string in the correct format.
  *
  * @public exported from `@promptbook/editable`
  */
@@ -14,4 +14,4 @@ export {};
 /**
  * TODO: [🧠] What is the better solution - `- xxx`, - `-   xxx` or preserve (see also next TODO)
  * TODO: When existing commands 1) as 2) number 3) list, add 4) new command as next number
- */
+ */ 

package/esm/typings/src/utils/editable/edit-pipeline-string/deflatePipeline.d.ts

@@ -1,6 +1,9 @@
 import type { PipelineString } from '../../../pipeline/PipelineString';
 /**
- * @@@
+ * Converts a pipeline structure to its string representation.
+ *
+ * Transforms a flat, simple pipeline into a properly formatted pipeline string
+ * with sections for title, prompt, and return statement.
  *
  * @public exported from `@promptbook/editable`
  */

package/esm/typings/src/utils/editable/utils/isFlatPipeline.d.ts

@@ -1,6 +1,7 @@
 import type { PipelineString } from '../../../pipeline/PipelineString';
 /**
- * @@@
+ * Utility to determine if a pipeline string is in flat format.
+ * A flat pipeline is a simple text without proper structure (headers, blocks, etc).
  *
  * @public exported from `@promptbook/editable`
  */

package/esm/typings/src/utils/environment/$getGlobalScope.d.ts

@@ -1,6 +1,7 @@
 import type { really_any } from '../organization/really_any';
 /**
- * @@@
+ * Safely retrieves the global scope object (window in browser, global in Node.js)
+ * regardless of the JavaScript environment in which the code is running
  *
  * Note: `$` is used to indicate that this function is not a pure function - it access global scope
  *

package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.d.ts

@@ -9,7 +9,7 @@ import type { string_markdown_text } from '../../types/typeAliases';
  * Note: It can not work with html syntax and comments
  *
  * @param markdown any valid markdown
- * @returns @@@
+ * @returns An array of strings, each representing an individual list item found in the markdown
  * @public exported from `@promptbook/markdown-utils`
  */
 export declare function extractAllListItemsFromMarkdown(markdown: string_markdown): string_markdown_text[];

package/esm/typings/src/utils/normalization/nameToUriPart.d.ts

@@ -1,9 +1,9 @@
 /**
- * @@@
+ * Converts a name string into a URI-compatible format.
  *
- * @param name @@@
- * @returns @@@
- * @example @@@
+ * @param name The string to be converted to a URI-compatible format.
+ * @returns A URI-compatible string derived from the input name.
+ * @example 'Hello World' -> 'hello-world'
  * @public exported from `@promptbook/utils`
  */
 export declare function nameToUriPart(name: string): string;

package/esm/typings/src/utils/normalization/nameToUriParts.d.ts

@@ -1,9 +1,9 @@
 /**
- * @@@
+ * Converts a given name into URI-compatible parts.
  *
- * @param name @@@
- * @returns @@@
- * @example @@@
+ * @param name The name to be converted into URI parts.
+ * @returns An array of URI-compatible parts derived from the name.
+ * @example 'Example Name' -> ['example', 'name']
  * @public exported from `@promptbook/utils`
  */
 export declare function nameToUriParts(name: string): string[];

package/esm/typings/src/utils/normalization/normalize-to-kebab-case.d.ts

@@ -7,10 +7,10 @@
  */
 export type string_kebab_case = string;
 /**
- * @@@
+ * Converts a given text to kebab-case format.
  *
- * @param text @@@
- * @returns @@@
+ * @param text The text to be converted.
+ * @returns The kebab-case formatted string.
  * @example 'hello-world'
  * @example 'i-love-promptbook'
  * @public exported from `@promptbook/utils`

package/esm/typings/src/utils/normalization/normalizeTo_SCREAMING_CASE.d.ts

@@ -7,10 +7,10 @@
  */
 export type string_SCREAMING_CASE = string;
 /**
- * @@@
+ * Normalizes a text string to SCREAMING_CASE (all uppercase with underscores).
  *
- * @param text @@@
- * @returns @@@
+ * @param text The text string to be converted to SCREAMING_CASE format.
+ * @returns The normalized text in SCREAMING_CASE format.
  * @example 'HELLO_WORLD'
  * @example 'I_LOVE_PROMPTBOOK'
  * @public exported from `@promptbook/utils`

package/esm/typings/src/utils/normalization/normalizeTo_camelCase.d.ts

@@ -7,11 +7,11 @@
  */
 export type string_camelCase = string;
 /**
- * @@@
+ * Normalizes a given text to camelCase format.
  *
- * @param text @@@
- * @param _isFirstLetterCapital @@@
- * @returns @@@
+ * @param text The text to be normalized.
+ * @param _isFirstLetterCapital Whether the first letter should be capitalized.
+ * @returns The camelCase formatted string.
  * @example 'helloWorld'
  * @example 'iLovePromptbook'
  * @public exported from `@promptbook/utils`

package/esm/typings/src/utils/normalization/normalizeTo_snake_case.d.ts

@@ -6,10 +6,10 @@
  */
 export type string_snake_case = string;
 /**
- * @@@
+ * Normalizes a text string to snake_case format.
  *
- * @param text @@@
- * @returns @@@
+ * @param text The text string to be converted to snake_case format.
+ * @returns The normalized text in snake_case format.
  * @example 'hello_world'
  * @example 'i_love_promptbook'
  * @public exported from `@promptbook/utils`

package/esm/typings/src/utils/normalization/removeDiacritics.d.ts

@@ -1,8 +1,8 @@
 /**
- * @@@
+ * Removes diacritic marks (accents) from characters in a string.
  *
- * @param input @@@
- * @returns @@@
+ * @param input The string containing diacritics to be normalized.
+ * @returns The string with diacritics removed or normalized.
  * @public exported from `@promptbook/utils`
  */
 export declare function removeDiacritics(input: string): string;

package/esm/typings/src/utils/normalization/searchKeywords.d.ts

@@ -1,6 +1,6 @@
 import type { Keywords } from './IKeywords';
 /**
- * @@@
+ * Searches set of keywords for a specific keyword
  *
  * @param haystack
  * @param needle
@@ -8,3 +8,6 @@ import type { Keywords } from './IKeywords';
  * @public exported from `@promptbook/utils`
  */
 export declare function searchKeywords(haystack: Keywords, needle: Keywords): boolean;
+/**
+ * TODO: Rename to `isKeywordInKeywords`
+ */

package/esm/typings/src/utils/normalization/titleToName.d.ts

@@ -1,9 +1,9 @@
 /**
- * @@@
+ * Converts a title string into a normalized name.
  *
- * @param value @@@
- * @returns @@@
- * @example @@@
+ * @param value The title string to be converted to a name.
+ * @returns A normalized name derived from the input title.
+ * @example 'Hello World!' -> 'hello-world'
  * @public exported from `@promptbook/utils`
  */
 export declare function titleToName(value: string): string;

package/esm/typings/src/utils/organization/empty_object.d.ts

@@ -2,8 +2,8 @@
  * Organizational helper to better mark the place where to really use empty object `{}`
  *
  * Note: There are 2 similar types>
- * - `empty_object` @@@
- * - `just_empty_object` @@@
+ * - `empty_object` Type used for empty data objects allowing for potential future extensions
+ * - `just_empty_object` Type used when an object must remain permanently empty
  *
  * @private within the repository
  */

package/esm/typings/src/utils/organization/just_empty_object.d.ts

@@ -1,9 +1,9 @@
 /**
- * Organizational helper to better @@@@
+ * Organizational helper to better distinguish different empty object use cases.
  *
- * Note: There are 2 similar types>
- * - `empty_object` @@@
- * - `just_empty_object` @@@
+ * Note: There are 2 similar types:
+ * - `empty_object` Type used for empty data objects with potential extensions
+ * - `just_empty_object` Type used specifically for objects that must remain empty
  *
  * Note: In most cases, you should use `empty_object`
  *

package/esm/typings/src/version.d.ts

@@ -14,7 +14,8 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
  */
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
- * @@@
+ * Represents the version string of the Promptbook engine.
+ * It follows semantic versioning (e.g., `0.92.0-24`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/browser",
-    "version": "0.92.0-23",
+    "version": "0.92.0-25",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -51,7 +51,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/browser.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.92.0-23"
+        "@promptbook/core": "0.92.0-25"
     },
     "dependencies": {
         "crypto": "1.0.1",

package/umd/index.umd.js

@@ -22,7 +22,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-23';
+    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-25';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -288,7 +288,8 @@
     }
 
     /**
-     * @@@
+     * Safely retrieves the global scope object (window in browser, global in Node.js)
+     * regardless of the JavaScript environment in which the code is running
      *
      * Note: `$` is used to indicate that this function is not a pure function - it access global scope
      *
@@ -299,10 +300,10 @@
     }
 
     /**
-     * @@@
+     * Normalizes a text string to SCREAMING_CASE (all uppercase with underscores).
      *
-     * @param text @@@
-     * @returns @@@
+     * @param text The text string to be converted to SCREAMING_CASE format.
+     * @returns The normalized text in SCREAMING_CASE format.
      * @example 'HELLO_WORLD'
      * @example 'I_LOVE_PROMPTBOOK'
      * @public exported from `@promptbook/utils`
@@ -354,10 +355,10 @@
      */
 
     /**
-     * @@@
+     * Normalizes a text string to snake_case format.
      *
-     * @param text @@@
-     * @returns @@@
+     * @param text The text string to be converted to snake_case format.
+     * @returns The normalized text in snake_case format.
      * @example 'hello_world'
      * @example 'i_love_promptbook'
      * @public exported from `@promptbook/utils`
@@ -415,10 +416,11 @@
     }
 
     /**
-     * @@@
+     * Registry for all available scrapers in the system.
+     * Central point for registering and accessing different types of content scrapers.
      *
      * Note: `$` is used to indicate that this interacts with the global scope
-     * @singleton Only one instance of each register is created per build, but thare can be more @@@
+     * @singleton Only one instance of each register is created per build, but there can be more than one in different build modules
      * @public exported from `@promptbook/core`
      */
     const $scrapersRegister = new $Register('scraper_constructors');
@@ -427,10 +429,13 @@
      */
 
     /**
-     * @@@
+     * Provides a collection of scrapers optimized for browser environments.
+     * Only includes scrapers that can safely run in a browser context.
      *
-     * 1) @@@
-     * 2) @@@
+     * Note: Browser scrapers have limitations compared to Node.js scrapers.
+     *
+     * 1) `provideScrapersForNode` use as default
+     * 2) `provideScrapersForBrowser` use in limited browser environment
      *
      * @public exported from `@promptbook/browser`
      */
@@ -938,7 +943,8 @@
      */
 
     /**
-     * @@@
+     * Creates a Promptbook storage interface from a web storage object.
+     * Facilitates using Web Storage (localStorage/sessionStorage) as a storage backend.
      *
      * @private for `getLocalStorage` and `getSessionStorage`
      */