@promptbook/pdf 0.92.0-24 → 0.92.0-25

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/pdf",
-    "version": "0.92.0-24",
+    "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/pdf.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.92.0-24"
+        "@promptbook/core": "0.92.0-25"
     },
     "dependencies": {
         "crypto": "1.0.1",

package/umd/index.umd.js

@@ -25,7 +25,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.92.0-24';
+    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
@@ -369,7 +369,8 @@
      */
 
     /**
-     * @@@
+     * 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`
      */
@@ -622,10 +623,10 @@
     */
 
     /**
-     * @@@
+     * 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`
      */
     function removeDiacritics(input) {
@@ -639,10 +640,10 @@
      */
 
     /**
-     * @@@
+     * 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`
@@ -784,11 +785,11 @@
     }
 
     /**
-     * @@@
+     * 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`
      */
     function titleToName(value) {
@@ -821,9 +822,8 @@
     }
 
     /**
-     * Create a filename for intermediate cache for scrapers
-     *
-     * Note: It also checks if directory exists and creates it if not
+     * Retrieves an intermediate source for a scraper based on the knowledge source.
+     * Manages the caching and retrieval of intermediate scraper results for optimized performance.
      *
      * @private as internal utility for scrapers
      */
@@ -1457,13 +1457,13 @@
      */
     const REPLACING_NONCE = 'ptbkauk42kV2dzao34faw7FudQUHYPtW';
     /**
-     * @@@
+     * Placeholder value indicating a parameter is missing its value.
      *
      * @private within the repository
      */
     const RESERVED_PARAMETER_MISSING_VALUE = 'MISSING-' + REPLACING_NONCE;
     /**
-     * @@@
+     * Placeholder value indicating a parameter is restricted and cannot be used directly.
      *
      * @private within the repository
      */
@@ -2126,8 +2126,8 @@
      * @public exported from `@promptbook/core`
      */
     function isPipelinePrepared(pipeline) {
-        // Note: Ignoring `pipeline.preparations` @@@
-        // Note: Ignoring `pipeline.knowledgePieces` @@@
+        // Note: Ignoring `pipeline.preparations`
+        // Note: Ignoring `pipeline.knowledgePieces`
         if (pipeline.title === undefined || pipeline.title === '' || pipeline.title === DEFAULT_BOOK_TITLE) {
             // TODO: !!! Comment this out
             console.log('Pipeline is not prepared because title is undefined or empty', pipeline);
@@ -3111,10 +3111,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`
@@ -3166,10 +3166,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`
@@ -3239,10 +3239,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');
@@ -3420,7 +3421,9 @@
      */
 
     /**
-     * @@@
+     * Factory function that creates a handler for processing knowledge sources.
+     * Provides standardized processing of different types of knowledge sources
+     * across various scraper implementations.
      *
      * @public exported from `@promptbook/core`
      */
@@ -3661,9 +3664,12 @@
      */
 
     /**
-     * @@@
+     * Prepares tasks by adding knowledge to the prompt and ensuring all necessary parameters are included.
      *
-     * @public exported from `@promptbook/core`
+     * @param tasks Sequence of tasks that are chained together to form a pipeline
+     * @returns A promise that resolves to the prepared tasks.
+     *
+     * @private internal utility of `preparePipeline`
      */
     async function prepareTasks(pipeline, tools, options) {
         const { maxParallelCount = DEFAULT_MAX_PARALLEL_COUNT } = options;
@@ -4426,7 +4432,7 @@
             else if (!availableParametersNames.has(parameterName) && expectedParameterNames.has(parameterName)) ;
         }
         if (expectedParameterNames.size === 0) {
-            // Note: [👨‍👨‍👧] Now we can freeze `mappedParameters` to prevent @@@
+            // Note: [👨‍👨‍👧] Now we can freeze `mappedParameters` to prevent accidental modifications after mapping
             Object.freeze(mappedParameters);
             return mappedParameters;
         }
@@ -4457,7 +4463,7 @@
         for (let i = 0; i < expectedParameterNames.size; i++) {
             mappedParameters[expectedParameterNamesArray[i]] = availableParameters[availableParametersNamesArray[i]];
         }
-        // Note: [👨‍👨‍👧] Now we can freeze `mappedParameters` to prevent @@@
+        // Note: [👨‍👨‍👧] Now we can freeze `mappedParameters` to prevent accidental modifications after mapping
         Object.freeze(mappedParameters);
         return mappedParameters;
     }
@@ -5210,11 +5216,10 @@
                     const highLevelError = new PipelineExecutionError(spaceTrim__default["default"]((block) => `
                             ${error.message}
 
-                            This is error in FOREACH command when mapping data
+                            This is error in FOREACH command when mapping ${formatDefinition.formatName} ${subvalueParser.subvalueName} data (${index + 1}/${length})
                             You have probbably passed wrong data to pipeline or wrong data was generated which are processed by FOREACH command
 
                             ${block(pipelineIdentification)}
-                            Subparameter index: ${index}
                         `));
                     if (length > BIG_DATASET_TRESHOLD) {
                         console.error(highLevelError);
@@ -5242,12 +5247,11 @@
                 catch (error) {
                     if (length > BIG_DATASET_TRESHOLD) {
                         console.error(spaceTrim__default["default"]((block) => `
-                              Error in FOREACH command:
+                              ${error.message}
 
-                              ${block(pipelineIdentification)}
+                              This is error in FOREACH command when processing ${formatDefinition.formatName} ${subvalueParser.subvalueName} data (${index + 1}/${length})
 
                               ${block(pipelineIdentification)}
-                              Subparameter index: ${index}
                           `));
                         return FAILED_VALUE_PLACEHOLDER;
                     }
@@ -6165,8 +6169,8 @@
                 extension: 'md',
                 isVerbose,
             });
-            // TODO: @@@ Preserve, delete or modify
-            // Note: Running Pandoc ONLY if the file in the cache does not exist
+            // TODO: Determine if Markitdown conversion should run only if the cache file doesn't exist, or always.
+            // Note: Running Markitdown conversion ONLY if the file in the cache does not exist
             if (!(await isFileExisting(cacheFilehandler.filename, this.tools.fs))) {
                 const src = source.filename || source.url || null;
                 // console.log('!!', { src, source, cacheFilehandler });
@@ -6188,11 +6192,11 @@
             return cacheFilehandler;
         }
         /**
-         * 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.
          */
         async scrape(source) {
             const cacheFilehandler = await this.$convert(source);
-            // TODO: @@@ Preserve, delete or modify
+            // TODO: Ensure this correctly creates the source object for the internal MarkdownScraper using the converted file.
             const markdownSource = {
                 source: source.source,
                 filename: cacheFilehandler.filename,
@@ -6336,7 +6340,8 @@
      */
 
     /**
-     * @@@
+     * Factory function to create an instance of PdfScraper.
+     * It bundles the scraper class with its metadata.
      *
      * @public exported from `@promptbook/pdf`
      */