@promptbook/browser 0.92.0-8 → 0.92.0

package/esm/typings/src/utils/parameters/mapAvailableToExpectedParameters.d.ts

@@ -1,26 +1,26 @@
 import type { string_parameter_name } from '../../types/typeAliases';
 import type { string_parameter_value } from '../../types/typeAliases';
 /**
- * @@@
+ * Options for mapping available parameters to expected parameters in a pipeline task.
  */
 type MakeapAvailableToExpectedParametersOptions = {
     /**
-     * @@@
+     * The set of expected parameter names (keys) for the task, all values are null.
      */
     readonly expectedParameters: Readonly<Record<string_parameter_name, null>>;
     /**
-     * @@@
+     * The set of available parameters (name-value pairs) to map to the expected parameters.
      */
     readonly availableParameters: Readonly<Record<string_parameter_name, string_parameter_value>>;
 };
 /**
- * Maps available parameters to expected parameters
+ * Maps available parameters to expected parameters for a pipeline task.
  *
  * The strategy is:
- * 1) @@@
- * 2) @@@
+ * 1) First, match parameters by name where both available and expected.
+ * 2) Then, if there are unmatched expected and available parameters, map them by order.
  *
- * @throws {PipelineExecutionError} @@@
+ * @throws {PipelineExecutionError} If the number of unmatched expected and available parameters does not match, or mapping is ambiguous.
  * @private within the repository used in `createPipelineExecutor`
  */
 export declare function mapAvailableToExpectedParameters(options: MakeapAvailableToExpectedParametersOptions): Readonly<Record<string_parameter_name, string_parameter_value>>;

package/esm/typings/src/utils/removeQuotes.d.ts

@@ -1,9 +1,9 @@
 /**
  * Removes quotes from a string
  *
- * Tip: This is very usefull for post-processing of the result of the LLM model
+ * Tip: This is very useful for post-processing of the result of the LLM model
  * Note: This function removes only the same quotes from the beginning and the end of the string
- * Note: There are two simmilar functions:
+ * Note: There are two similar functions:
  * - `removeQuotes` which removes only bounding quotes
  * - `unwrapResult` which removes whole introduce sentence
  *

package/esm/typings/src/utils/serialization/clonePipeline.d.ts

@@ -1,10 +1,11 @@
 import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
 /**
- * @@@
+ * Creates a deep clone of a PipelineJson object, copying all properties explicitly.
  *
- * Note: It is usefull @@@
+ * Note: It is useful for ensuring that modifications to the returned pipeline do not affect the original.
  *
- * @param pipeline
+ * @param pipeline The pipeline to clone.
+ * @returns A new PipelineJson object with the same properties as the input.
  * @public exported from `@promptbook/utils`
  */
 export declare function clonePipeline(pipeline: PipelineJson): PipelineJson;

package/esm/typings/src/utils/serialization/deepClone.d.ts

@@ -1,7 +1,11 @@
 import type { WritableDeep } from 'type-fest';
 /**
- * @@@
+ * Creates a deep clone of the given object
  *
+ * Note: This method only works for objects that are fully serializable to JSON and do not contain functions, Dates, or special types.
+ *
+ * @param objectValue The object to clone.
+ * @returns A deep, writable clone of the input object.
  * @public exported from `@promptbook/utils`
  */
 export declare function deepClone<TObject>(objectValue: TObject): WritableDeep<TObject>;

package/esm/typings/src/utils/trimCodeBlock.d.ts

@@ -1,7 +1,7 @@
 /**
  * Function trimCodeBlock will trim starting and ending code block from the string if it is present.
  *
- * Note: This is usefull for post-processing of the result of the chat LLM model
+ * Note: This is useful for post-processing of the result of the chat LLM model
  *       when the model wraps the result in the (markdown) code block.
  *
  * @public exported from `@promptbook/utils`

package/esm/typings/src/utils/trimEndOfCodeBlock.d.ts

@@ -1,7 +1,7 @@
 /**
  * Function trimEndOfCodeBlock will remove ending code block from the string if it is present.
  *
- * Note: This is usefull for post-processing of the result of the completion LLM model
+ * Note: This is useful for post-processing of the result of the completion LLM model
  *       if you want to start code block in the prompt but you don't want to end it in the result.
  *
  * @public exported from `@promptbook/utils`

package/esm/typings/src/utils/unwrapResult.d.ts

@@ -20,9 +20,9 @@ type UnwrapResultOptions = {
 /**
  * Removes quotes and optional introduce text from a string
  *
- * Tip: This is very usefull for post-processing of the result of the LLM model
+ * Tip: This is very useful for post-processing of the result of the LLM model
  * Note: This function trims the text and removes whole introduce sentence if it is present
- * Note: There are two simmilar functions:
+ * Note: There are two similar functions:
  * - `removeQuotes` which removes only bounding quotes
  * - `unwrapResult` which removes whole introduce sentence
  *

package/esm/typings/src/utils/validators/javascriptName/isValidJavascriptName.d.ts

@@ -1,10 +1,10 @@
 import type { string_javascript_name } from '../../../types/typeAliases';
 import type { really_unknown } from '../../organization/really_unknown';
 /**
- * @@@
+ * Checks if the given value is a valid JavaScript identifier name.
  *
- * @param javascriptName @@@
- * @returns @@@
+ * @param javascriptName The value to check for JavaScript identifier validity.
+ * @returns `true` if the value is a valid JavaScript name, false otherwise.
  * @public exported from `@promptbook/utils`
  */
 export declare function isValidJavascriptName(javascriptName: really_unknown): javascriptName is string_javascript_name;

package/esm/typings/src/utils/validators/parameterName/validateParameterName.d.ts

@@ -1,10 +1,11 @@
 import type { string_parameter_name } from '../../../types/typeAliases';
 /**
- * Function `validateParameterName` will @@@
+ * Function `validateParameterName` will normalize and validate a parameter name for use in pipelines.
+ * It removes diacritics, emojis, and quotes, normalizes to camelCase, and checks for reserved names and invalid characters.
  *
- * @param parameterName @@@
- * @returns @@@
- * @throws {ParseError} @@@
+ * @param parameterName The parameter name to validate and normalize.
+ * @returns The validated and normalized parameter name.
+ * @throws {ParseError} If the parameter name is empty, reserved, or contains invalid characters.
  * @private within the repository
  */
 export declare function validateParameterName(parameterName: string): string_parameter_name;

package/esm/typings/src/utils/validators/semanticVersion/isValidPromptbookVersion.d.ts

@@ -6,7 +6,7 @@ import type { really_unknown } from '../../organization/really_unknown';
  *
  * @see https://www.npmjs.com/package/promptbook?activeTab=versions
  * Note: When you are using for example promptbook 2.0.0 and there already is promptbook 3.0.0 it don`t know about it.
- * Note: There are two simmilar functions:
+ * Note: There are two similar functions:
  * - `isValidSemanticVersion` which tests any semantic version
  * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
  *

package/esm/typings/src/utils/validators/semanticVersion/isValidSemanticVersion.d.ts

@@ -3,7 +3,7 @@ import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid semantic version
  *
- * Note: There are two simmilar functions:
+ * Note: There are two similar functions:
  * - `isValidSemanticVersion` which tests any semantic version
  * - `isValidPromptbookVersion` *(this one)* which tests just Promptbook versions
  *

package/esm/typings/src/utils/validators/url/isHostnameOnPrivateNetwork.d.ts

@@ -2,7 +2,7 @@ import type { string_hostname } from '../../../types/typeAliases';
 /**
  * Checks if an URL is reserved for private networks or localhost.
  *
- * Note: There are two simmilar functions:
+ * Note: There are two similar functions:
  * - `isUrlOnPrivateNetwork` which tests full URL
  * - `isHostnameOnPrivateNetwork` *(this one)* which tests just hostname
  *

package/esm/typings/src/utils/validators/url/isUrlOnPrivateNetwork.d.ts

@@ -2,7 +2,7 @@ import type { string_url } from '../../../types/typeAliases';
 /**
  * Checks if an IP address or hostname is reserved for private networks or localhost.
  *
- * Note: There are two simmilar functions:
+ * Note: There are two similar functions:
  * - `isUrlOnPrivateNetwork` *(this one)* which tests full URL
  * - `isHostnameOnPrivateNetwork` which tests just hostname
  *

package/esm/typings/src/utils/validators/url/isValidPipelineUrl.d.ts

@@ -3,7 +3,7 @@ import type { really_unknown } from '../../organization/really_unknown';
 /**
  * Tests if given string is valid pipeline URL URL.
  *
- * Note: There are two simmilar functions:
+ * Note: There are two similar functions:
  * - `isValidUrl` which tests any URL
  * - `isValidPipelineUrl` *(this one)* which tests just pipeline URL
  *

package/esm/typings/src/utils/validators/url/isValidUrl.d.ts

@@ -4,7 +4,7 @@ import type { really_unknown } from '../../organization/really_unknown';
  * Tests if given string is valid URL.
  *
  * Note: Dataurl are considered perfectly valid.
- * Note: There are two simmilar functions:
+ * Note: There are two similar functions:
  * - `isValidUrl` which tests any URL
  * - `isValidPipelineUrl` *(this one)* which tests just promptbook URL
  *

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-35`).
  *
  * @generated
  */

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

@@ -24,7 +24,7 @@ declare class Wizzard {
      * 2) As a URL https://promptbook.studio/hejny/write-cv.book fetched from the internet
      * 3) As a string
      *
-     * Note: This works simmilar to the `ptbk run` command
+     * Note: This works similar to the `ptbk run` command
      */
     execute(book: string_pipeline_url | string_filename | PipelineString, inputParameters: InputParameters): Promise<{
         /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/browser",
-    "version": "0.92.0-8",
+    "version": "0.92.0",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "private": false,
     "sideEffects": false,
@@ -47,11 +47,23 @@
         "node": ">=16.0.0",
         "npm": ">=8.0.0"
     },
+    "cspell": {
+        "version": "0.2",
+        "language": "en",
+        "ignorePaths": [
+            "node_modules",
+            ".next",
+            "coverage",
+            "dist",
+            ".git"
+        ],
+        "words": []
+    },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/browser.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.92.0-8"
+        "@promptbook/core": "0.92.0"
     },
     "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-8';
+    const PROMPTBOOK_ENGINE_VERSION = '0.92.0';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -54,7 +54,7 @@
             super(message);
             this.name = 'PipelineExecutionError';
             // TODO: [🐙] DRY - Maybe $randomId
-            this.id = `error-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid simmilar char conflicts   */)}`;
+            this.id = `error-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid similar char conflicts   */)}`;
             Object.setPrototypeOf(this, PipelineExecutionError.prototype);
         }
     }
@@ -181,7 +181,7 @@
     const LOOP_LIMIT = 1000;
     // <- TODO: [🧜‍♂️]
     /**
-     * @@@
+     * Default settings for parsing and generating CSV files in Promptbook.
      *
      * @public exported from `@promptbook/core`
      */
@@ -274,7 +274,7 @@
                     ${block(message)}
 
                     Note: This error should not happen.
-                    It's probbably a bug in the pipeline collection
+                    It's probably a bug in the pipeline collection
 
                     Please report issue:
                     ${block(getErrorReportUrl(new Error(message)).href)}
@@ -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`
@@ -367,11 +368,11 @@
     }
 
     /**
-     * Register is @@@
+     * Global registry for storing and managing registered entities of a given type.
      *
      * Note: `$` is used to indicate that this function is not a pure function - it accesses and adds variables in global scope.
      *
-     * @private internal utility, exported are only signleton instances of this class
+     * @private internal utility, exported are only singleton instances of this class
      */
     class $Register {
         constructor(registerName) {
@@ -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`
      */
@@ -450,6 +455,85 @@
         return scrapers;
     }
 
+    /**
+     * Creates a PromptbookStorage backed by IndexedDB.
+     * Uses a single object store named 'promptbook'.
+     * @private for `getIndexedDbStorage`
+     */
+    function makePromptbookStorageFromIndexedDb(options) {
+        const { databaseName, storeName } = options;
+        function getDatabase() {
+            return new Promise((resolve, reject) => {
+                const request = indexedDB.open(databaseName, 1);
+                request.onupgradeneeded = () => {
+                    request.result.createObjectStore(storeName);
+                };
+                request.onsuccess = () => resolve(request.result);
+                request.onerror = () => reject(request.error);
+            });
+        }
+        return {
+            async getItem(key) {
+                const database = await getDatabase();
+                return new Promise((resolve, reject) => {
+                    const transaction = database.transaction(storeName, 'readonly');
+                    const objectStore = transaction.objectStore(storeName);
+                    const request = objectStore.get(key);
+                    request.onsuccess = () => { var _a; return resolve((_a = request.result) !== null && _a !== void 0 ? _a : null); };
+                    request.onerror = () => reject(request.error);
+                });
+            },
+            async setItem(key, value) {
+                const database = await getDatabase();
+                return new Promise((resolve, reject) => {
+                    const transaction = database.transaction(storeName, 'readwrite');
+                    const objectStore = transaction.objectStore(storeName);
+                    const request = objectStore.put(value, key);
+                    request.onsuccess = () => resolve();
+                    request.onerror = () => reject(request.error);
+                });
+            },
+            async removeItem(key) {
+                const database = await getDatabase();
+                return new Promise((resolve, reject) => {
+                    const transaction = database.transaction(storeName, 'readwrite');
+                    const objectStore = transaction.objectStore(storeName);
+                    const request = objectStore.delete(key);
+                    request.onsuccess = () => resolve();
+                    request.onerror = () => reject(request.error);
+                });
+            },
+        };
+    }
+
+    /**
+     * Cache storage
+     *
+     * @private internal cache for `getIndexedDbStorage`
+     */
+    const indexedDbStorageCache = new Map();
+    /**
+     * Gets wrapper around IndexedDB which can be used as PromptbookStorage
+     *
+     * @public exported from `@promptbook/browser`
+     */
+    function getIndexedDbStorage(options) {
+        if (!core.isRunningInBrowser()) {
+            throw new EnvironmentMismatchError(`You can get IndexedDB storage only in browser environment`);
+        }
+        const { databaseName, storeName } = options;
+        const cacheKey = `${databaseName}/${storeName}`;
+        if (indexedDbStorageCache.has(cacheKey)) {
+            return indexedDbStorageCache.get(cacheKey);
+        }
+        const storage = makePromptbookStorageFromIndexedDb({ databaseName, storeName });
+        indexedDbStorageCache.set(cacheKey, storage);
+        return storage;
+    }
+    /**
+     * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
+     */
+
     /**
      * Converts a JavaScript Object Notation (JSON) string into an object.
      *
@@ -479,15 +563,12 @@
             }
             throw new Error(spaceTrim__default["default"]((block) => `
                     ${block(error.message)}
-            
+
                     The JSON text:
                     ${block(value)}
                 `));
         }
     }
-    /**
-     * TODO: !!!! Use in Promptbook.studio
-     */
 
     /**
      * Orders JSON object by keys
@@ -718,8 +799,12 @@
      */
 
     /**
-     * @@@
+     * Creates a deep clone of the given object
      *
+     * Note: This method only works for objects that are fully serializable to JSON and do not contain functions, Dates, or special types.
+     *
+     * @param objectValue The object to clone.
+     * @returns A deep, writable clone of the input object.
      * @public exported from `@promptbook/utils`
      */
     function deepClone(objectValue) {
@@ -865,14 +950,15 @@
         return pipelineJsonStringified;
     }
     /**
-     * TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.book
+     * TODO: [🐝] Not Working properly @see https://promptbook.studio/examples/mixed-knowledge.book
      * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
      * TODO: [🧠] Maybe more elegant solution than replacing via regex
      * TODO: [🍙] Make some standard order of json properties
      */
 
     /**
-     * @@@
+     * 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`
      */
@@ -904,6 +990,12 @@
      * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
      */
 
+    /**
+     * Cache storage
+     *
+     * @private internal cache for `getLocalStorage`
+     */
+    let promptbookLocalStorage = null;
     /**
      * Gets wrapper around `localStorage` object which can be used as `PromptbookStorage`
      *
@@ -913,12 +1005,22 @@
         if (!core.isRunningInBrowser()) {
             throw new EnvironmentMismatchError(`You can get localStorage works only in browser environment`);
         }
-        return makePromptbookStorageFromWebStorage(localStorage);
+        if (promptbookLocalStorage) {
+            return promptbookLocalStorage;
+        }
+        promptbookLocalStorage = makePromptbookStorageFromWebStorage(localStorage);
+        return promptbookLocalStorage;
     }
     /**
      * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
      */
 
+    /**
+     * Cache storage
+     *
+     * @private internal cache for `getSessionStorage`
+     */
+    let promptbookSessionStorage = null;
     /**
      * Gets wrapper around `sessionStorage` object which can be used as `PromptbookStorage`
      *
@@ -928,7 +1030,11 @@
         if (!core.isRunningInBrowser()) {
             throw new EnvironmentMismatchError(`You can get sessionStorage works only in browser environment`);
         }
-        return makePromptbookStorageFromWebStorage(sessionStorage);
+        if (promptbookSessionStorage) {
+            return promptbookSessionStorage;
+        }
+        promptbookSessionStorage = makePromptbookStorageFromWebStorage(sessionStorage);
+        return promptbookSessionStorage;
     }
     /**
      * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
@@ -938,6 +1044,7 @@
     exports.BOOK_LANGUAGE_VERSION = BOOK_LANGUAGE_VERSION;
     exports.PROMPTBOOK_ENGINE_VERSION = PROMPTBOOK_ENGINE_VERSION;
     exports.SimplePromptInterfaceTools = SimplePromptInterfaceTools;
+    exports.getIndexedDbStorage = getIndexedDbStorage;
     exports.getLocalStorage = getLocalStorage;
     exports.getSessionStorage = getSessionStorage;