@promptbook/vercel 0.92.0-9 → 0.92.0

package/esm/typings/src/pipeline/PipelineJson/ParameterJson.d.ts

@@ -93,6 +93,6 @@ export type CommonParameterJson = {
  * TODO: [🧠][🛴][♈] Maybe add type + expectations into the intefrace, like "a person name"
  *       [🛴] @see https://github.com/webgptorg/promptbook/discussions/53
  * TODO: [🧠] Should be here registered subparameters from foreach or not?
- * TODO: [♈] Probbably move expectations from tasks to parameters
+ * TODO: [♈] Probably move expectations from tasks to parameters
  * TODO: [🍙] Make some standard order of json properties
  */

package/esm/typings/src/pipeline/PipelineJson/PipelineJson.d.ts

@@ -15,12 +15,12 @@ import type { PersonaPreparedJson } from './PersonaJson';
 import type { PreparationJson } from './PreparationJson';
 import type { TaskJson } from './TaskJson';
 /**
- * Promptbook is the **core concept of this package**.
+ * Represents a Promptbook pipeline defined in JSON format.
  * It represents a series of tasks chained together to form a pipeline / one big task with input and result parameters.
  *
  * Note: [🚉] This is fully serializable as JSON
  *
- * @see @@@ https://github.com/webgptorg/promptbook#promptbook
+ * @see The main Promptbook documentation for more details: https://github.com/webgptorg/promptbook#promptbook
  */
 export type PipelineJson = {
     /**
@@ -103,6 +103,7 @@ export type PipelineJson = {
     }>;
 };
 /**
+ * TODO: [🌪] Make type for deprecated pipelines
  * TODO: [🛳] Default PERSONA for the pipeline `defaultPersonaName` (same as `defaultModelRequirements`)
  * TODO: [🍙] Make some standard order of json properties
  * TODO: [🧠] Maybe wrap all {parameterNames} in brackets for example { "resultingParameterName": "{foo}" }

package/esm/typings/src/pipeline/PipelineString.d.ts

@@ -2,7 +2,9 @@
  * Promptbook is the **core concept of this package**.
  * It represents a series of tasks chained together to form a pipeline / one big task with input and result parameters.
  *
- * @see @@@ https://github.com/webgptorg/promptbook#promptbook
+ * Represents a Promptbook pipeline defined as a string.
+ *
+ * @see The main Promptbook documentation for more details: https://github.com/webgptorg/promptbook#promptbook
  */
 export type PipelineString = string & {
     readonly _type: 'Promptbook';

package/esm/typings/src/pipeline/book-notation.d.ts

@@ -7,8 +7,8 @@ import type { PipelineString } from './PipelineString';
  * 2) `promptTemplate` alias for `prompt`
  * 3) `book` for notating and validating entire books exported from `@promptbook/utils`
  *
- * @param strings @@@
- * @param values @@@
+ * @param strings The static string parts of the template literal
+ * @param values The dynamic values embedded within the template literal used as data
  * @returns the pipeline string
  * @public exported from `@promptbook/core`
  */

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

@@ -4,7 +4,7 @@ import type { string_markdown } from '../../types/typeAliases';
  *
  * - When there are multiple or no code blocks the function throws a `ParseError`
  *
- * Note: There are multiple simmilar function:
+ * Note: There are multiple similar function:
  * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
  * - `extractJsonBlock` extracts exactly one valid JSON code block
  * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block

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

@@ -9,7 +9,7 @@ import type { really_unknown } from '../../utils/organization/really_unknown';
  * - When there are multiple JSON code blocks the function throws a `ParseError`
  *
  * Note: It is not important if marked as ```json BUT if it is VALID JSON
- * Note: There are multiple simmilar function:
+ * Note: There are multiple similar function:
  * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
  * - `extractJsonBlock` extracts exactly one valid JSON code block
  * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
@@ -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/prepare/prepareTasks.d.ts

@@ -4,25 +4,28 @@ import type { TaskJson } from '../pipeline/PipelineJson/TaskJson';
 import type { PrepareAndScrapeOptions } from './PrepareAndScrapeOptions';
 type PrepareTaskInput = Pick<PipelineJson, 'tasks' | 'parameters'> & {
     /**
-     * @@@
+     * The number of knowledge pieces available for the pipeline.
      */
     readonly knowledgePiecesCount: number;
 };
 type PreparedTasks = {
     /**
-     * @@@ Sequence of tasks that are chained together to form a pipeline
+     * The sequence of tasks after preparation.
      */
     readonly tasksPrepared: ReadonlyArray<TaskJson>;
 };
 /**
- * @@@
+ * 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`
  */
 export declare function prepareTasks(pipeline: PrepareTaskInput, tools: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options: PrepareAndScrapeOptions): Promise<PreparedTasks>;
 export {};
 /**
- * TODO: [😂] Adding knowledge should be convert to async high-level abstractions, simmilar thing with expectations to sync high-level abstractions
+ * TODO: [😂] Adding knowledge should be convert to async high-level abstractions, similar thing with expectations to sync high-level abstractions
  * TODO: [🧠] Add context to each task (if missing)
  * TODO: [🧠] What is better name `prepareTask` or `prepareTaskAndParameters`
  * TODO: [♨][main] !!3 Prepare index the examples and maybe tasks

package/esm/typings/src/remote-server/openapi.d.ts

@@ -1,5 +1,5 @@
 /**
- * @private !!!! Decide how to expose this
+ * @private [🥺] Decide how to expose this
  */
 export declare const openapiJson: {
     openapi: string;

package/esm/typings/src/remote-server/socket-types/listModels/PromptbookServer_ListModels_Response.d.ts

@@ -13,5 +13,5 @@ export type PromptbookServer_ListModels_Response = {
     readonly models: ReadonlyArray<AvailableModel>;
 };
 /**
- * TODO: [👒] Listing models (and checking configuration) probbably should go through REST API not Socket.io
+ * TODO: [👒] Listing models (and checking configuration) probably should go through REST API not Socket.io
  */

package/esm/typings/src/remote-server/startRemoteServer.d.ts

@@ -11,7 +11,7 @@ import type { RemoteServerOptions } from './types/RemoteServerOptions';
  */
 export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): RemoteServer;
 /**
- * TODO: [🌡] Add CORS and security - probbably via `helmet`
+ * TODO: [🌡] Add CORS and security - probably via `helmet`
  * TODO: Split this file into multiple functions - handler for each request
  * TODO: Maybe use `$exportJson`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`

package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts

@@ -13,12 +13,12 @@ import type { string_user_id } from '../../types/typeAliases';
 import type { ApplicationModeIdentification } from '../socket-types/_subtypes/Identification';
 import type { Identification } from '../socket-types/_subtypes/Identification';
 /**
- * @@@
+ * Options for configuring the Promptbook remote server.
  *
  * There are two modes of remote server:
  *
- * 1) **Application mode** Server will recieve `collection` and execute prompts only from this collection
- * 2) **Anonymous mode** Server will recieve full `LlmToolsConfiguration` (with api keys) and just acts as a proxy
+ * 1) **Application mode** Server will receive `collection` and execute prompts only from this collection
+ * 2) **Anonymous mode** Server will receive full `LlmToolsConfiguration` (with api keys) and just acts as a proxy
  *    In anonymous mode, `collection` will be ignored and any prompt will be executed
  *
  * You can enable both modes at the same time.
@@ -28,12 +28,13 @@ import type { Identification } from '../socket-types/_subtypes/Identification';
 export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
     /**
      * Port on which the server will listen
+     * @property {number} port The port number the server will listen on.
      */
     readonly port: number;
     /**
      * Creates execution tools the client
      *
-     * This is relevant also in anonymous mode in oposition to `createLlmExecutionTools`
+     * This is relevant also in anonymous mode in opposition to `createLlmExecutionTools`
      *
      * Note: You can provide only some tools and leave the rest to the default ones also llm tools are created by `createLlmExecutionTools`
      * Note: This is useful when you want to provide some custom restrictions for example:
@@ -86,7 +87,7 @@ export type ApplicationRemoteServerClientOptions<TCustomOptions> = {
     /**
      * Identifier of the application
      *
-     * Note: This is usefull when you use Promptbook remote server for multiple apps/frontends, if its used just for single app, use here just "app" or "your-app-name"
+     * Note: This is useful when you use Promptbook remote server for multiple apps/frontends, if its used just for single app, use here just "app" or "your-app-name"
      * Note: This can be some id or some semantic name like "email-agent"
      */
     readonly appId: string_app_id | null;
@@ -115,7 +116,7 @@ export type LoginRequest = {
     /**
      * Identifier of the application you are using
      *
-     * Note: This is usefull when you use Promptbook remote server for multiple apps/frontends, if its used just for single app, use here just "app" or "your-app-name"
+     * Note: This is useful when you use Promptbook remote server for multiple apps/frontends, if its used just for single app, use here just "app" or "your-app-name"
      */
     readonly appId: string_app_id | null;
     /**

package/esm/typings/src/scrapers/_boilerplate/BoilerplateScraper.d.ts

@@ -7,7 +7,7 @@ import type { Scraper } from '../_common/Scraper';
 import type { ScraperSourceHandler } from '../_common/Scraper';
 import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSource';
 /**
- * Scraper of @@@ files
+ * Scraper of @@ files
  *
  * @see `documentationUrl` for more details
  * @public exported from `@promptbook/boilerplate`
@@ -25,7 +25,7 @@ export declare class BoilerplateScraper implements Converter, Scraper {
     private readonly markdownScraper;
     constructor(tools: Pick<ExecutionTools, 'fs' | 'llm' | 'executables'>, options: PrepareAndScrapeOptions);
     /**
-     * Convert the `.@@@`  to `.md` file and returns intermediate source
+     * Convert the `.@@`  to `.md` file and returns intermediate source
      *
      * Note: `$` is used to indicate that this function is not a pure function - it leaves files on the disk and you are responsible for cleaning them by calling `destroy` method of returned object
      */
@@ -39,5 +39,5 @@ export declare class BoilerplateScraper implements Converter, Scraper {
  * TODO: [👣] Converted documents can act as cached items - there is no need to run conversion each time
  * TODO: [🪂] Do it in parallel
  * Note: No need to aggregate usage here, it is done by intercepting the llmTools
- * @@@ Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ * @@ Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */

package/esm/typings/src/scrapers/_boilerplate/createBoilerplateScraper.d.ts

@@ -11,7 +11,7 @@ export declare const createBoilerplateScraper: ((tools: Pick<ExecutionTools, 'll
     packageName: string;
     className: string;
     mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@@";
+    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     isAvilableInBrowser: false;
     requiredExecutables: never[];
 }>;

package/esm/typings/src/scrapers/_boilerplate/register-metadata.d.ts

@@ -9,7 +9,7 @@ export declare const boilerplateScraperMetadata: import("type-fest/source/readon
     packageName: string;
     className: string;
     mimeTypes: string[];
-    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@@";
+    documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
     isAvilableInBrowser: false;
     requiredExecutables: never[];
 }>;

package/esm/typings/src/scrapers/_common/Converter.d.ts

@@ -2,7 +2,9 @@ import type { ScraperAndConverterMetadata } from './register/ScraperAndConverter
 import type { ScraperSourceHandler } from './Scraper';
 import type { ScraperIntermediateSource } from './ScraperIntermediateSource';
 /**
- * @@@
+ * Interface defining the requirements for converter implementations.
+ * Converters transform scraped content from one format to another,
+ * optimizing it for knowledge extraction and processing.
  *
  * Note: [🌏] Converters are not usable in browser because they produce a files
  */

package/esm/typings/src/scrapers/_common/Scraper.d.ts

@@ -6,7 +6,8 @@ import type { string_mime_type } from '../../types/typeAliases';
 import type { string_url } from '../../types/typeAliases';
 import type { ScraperAndConverterMetadata } from './register/ScraperAndConverterMetadata';
 /**
- * @@@
+ * Interface defining the requirements for scraper implementations.
+ * Scrapers are responsible for extracting structured content from various knowledge sources.
  */
 export type Scraper = {
     /**
@@ -19,7 +20,8 @@ export type Scraper = {
     scrape(source: ScraperSourceHandler): Promisable<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
 };
 /**
- * @@@
+ * Handler for accessing and processing content from diverse knowledge sources.
+ * Provides standardized methods to interact with files, URLs and raw text sources.
  */
 export type ScraperSourceHandler = {
     /**
@@ -54,6 +56,5 @@ export type ScraperSourceHandler = {
 /**
  * TODO: [🧠] Maybe split `ScraperSourceHandler` into `ScraperWebsiteSourceHandler` + `ScraperFileSourceHandler`
  * TODO: [🥽] Add ` asBlob(): Promisable<Blob>;` or asFile
- * TODO: [🐝] @@@ Annotate all
  * TODO: [🔼] Export via types
  */

package/esm/typings/src/scrapers/_common/ScraperIntermediateSource.d.ts

@@ -1,11 +1,13 @@
 import type { IDestroyable } from 'destroyable';
 import type { string_absolute_filename } from '../../types/typeAliases';
 /**
- * @@@
+ * Interface representing an intermediate storage location for scraper results.
+ * Provides functionality for caching and managing temporary data during scraping operations.
  */
 export type ScraperIntermediateSource = IDestroyable & {
     /**
-     * @@@
+     * The absolute path to the file where intermediate data is stored.
+     * This file serves as a cache for scraped content to avoid redundant processing.
      */
     readonly filename: string_absolute_filename;
 };

package/esm/typings/src/scrapers/_common/prepareKnowledgePieces.d.ts

@@ -3,7 +3,7 @@ import type { KnowledgeSourceJson } from '../../pipeline/PipelineJson/KnowledgeS
 import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
 import type { ExecutionTools } from '../../execution/ExecutionTools';
 /**
- * Prepares the knowle
+ * Prepares the knowledge pieces
  *
  * @see https://github.com/webgptorg/promptbook/discussions/41
  * @public exported from `@promptbook/core`
@@ -13,7 +13,7 @@ export declare function prepareKnowledgePieces(knowledgeSources: ReadonlyArray<K
  * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
  *       Put `knowledgePieces` into `PrepareKnowledgeOptions`
  * TODO: [🪂] More than max things can run in parallel by acident [1,[2a,2b,_],[3a,3b,_]]
- * TODO: [🧠][❎] Do here propper M:N mapping
+ * TODO: [🧠][❎] Do here proper M:N mapping
  *       [x] One source can make multiple pieces
  *       [ ] One piece can have multiple sources
  */

package/esm/typings/src/scrapers/_common/register/$provideFilesystemForNode.d.ts

@@ -1,7 +1,8 @@
 import type { FilesystemTools } from '../../../execution/FilesystemTools';
 import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
 /**
- * @@@
+ * Provides filesystem access (for example for Node.js-based scrapers)
+ * Creates a standardized filesystem interface that scrapers can use for file operations.
  *
  * @public exported from `@promptbook/node`
  */

package/esm/typings/src/scrapers/_common/register/$provideScrapersForBrowser.d.ts

@@ -2,10 +2,13 @@ import type { ExecutionTools } from '../../../execution/ExecutionTools';
 import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
 import type { Scraper } from '../Scraper';
 /**
- * @@@
+ * 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`
  */

package/esm/typings/src/scrapers/_common/register/$provideScrapersForNode.d.ts

@@ -2,11 +2,9 @@ import type { ExecutionTools } from '../../../execution/ExecutionTools';
 import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
 import type { Scraper } from '../Scraper';
 /**
- * @@@
- *
- * 1) @@@
- * 2) @@@
- *
+ * Provides a collection of scrapers optimized for Node.js environment.
+ * 1) `provideScrapersForNode` use as default
+ * 2) `provideScrapersForBrowser` use in limited browser environment *
  * @public exported from `@promptbook/node`
  */
 export declare function $provideScrapersForNode(tools: Pick<ExecutionTools, 'fs' | 'llm' | 'executables'>, options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<Scraper>>;

package/esm/typings/src/scrapers/_common/register/$scrapersMetadataRegister.d.ts

@@ -1,10 +1,10 @@
 import { $Register } from '../../../utils/$Register';
 import type { ScraperAndConverterMetadata } from './ScraperAndConverterMetadata';
 /**
- * @@@
+ * Global registry for storing metadata about all available scrapers and converters.
  *
- * 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 @@@
+ * Note: `$` is used to indicate that this interacts with the global scope.
+ * @singleton Only one instance of each register is created per build, but there can be more in different contexts (e.g., tests).
  * @public exported from `@promptbook/core`
  */
 export declare const $scrapersMetadataRegister: $Register<ScraperAndConverterMetadata>;

package/esm/typings/src/scrapers/_common/register/$scrapersRegister.d.ts

@@ -1,10 +1,11 @@
 import { $Register } from '../../../utils/$Register';
 import type { ScraperConstructor } from './ScraperConstructor';
 /**
- * @@@
+ * 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`
  */
 export declare const $scrapersRegister: $Register<ScraperConstructor>;

package/esm/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts

@@ -4,9 +4,9 @@ import type { string_promptbook_documentation_url } from '../../../types/typeAli
 import type { string_title } from '../../../types/typeAliases';
 import type { Registered } from '../../../utils/$Register';
 /**
- * @@@
+ * Metadata interface for scrapers and converters in the system.
+ * Contains information about the capabilities and requirements of a scraper or converter.
  *
- * @@@
  * x) `Scraper`
  * x) `Converter`
  * x) `ScraperConstructor`
@@ -19,7 +19,8 @@ import type { Registered } from '../../../utils/$Register';
  */
 export type ScraperAndConverterMetadata = Registered & {
     /**
-     * @@@
+     * Human-readable title of the scraper or converter.
+     * Used for display purposes in logs and interfaces.
      */
     readonly title: string_title;
     /**
@@ -27,13 +28,15 @@ export type ScraperAndConverterMetadata = Registered & {
      */
     readonly mimeTypes: ReadonlyArray<string_mime_type>;
     /**
-     * @@@
+     * Flag indicating whether this scraper or converter can run in a browser environment.
+     * Some scrapers require Node.js capabilities and cannot run client-side.
      *
      * Note: [🌏] Only `MarkdownScraper` makes sense to be available in the browser, for scraping non-markdown sources in the browser use a remote server
      */
     readonly isAvilableInBrowser: boolean;
     /**
-     * @@@
+     * List of executables required by this scraper or converter to function properly.
+     * For example, PDF scrapers may require 'pandoc' to be installed on the system.
      */
     readonly requiredExecutables: ReadonlyArray<Capitalize<keyof Executables extends `${infer N}Path` ? N : never>>;
     /**

package/esm/typings/src/scrapers/_common/register/ScraperConstructor.d.ts

@@ -4,7 +4,8 @@ import type { Registered } from '../../../utils/$Register';
 import type { Scraper } from '../Scraper';
 import type { ScraperAndConverterMetadata } from './ScraperAndConverterMetadata';
 /**
- * @@@
+ * Type definition for a constructor function that creates a Scraper instance.
+ * Used for registering scrapers in the system to handle different content types.
  */
 export type ScraperConstructor = Registered & ScraperAndConverterMetadata & ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => Scraper);
 /**

package/esm/typings/src/scrapers/_common/utils/getScraperIntermediateSource.d.ts

@@ -3,13 +3,15 @@ import type { string_file_extension } from '../../../types/typeAliases';
 import type { ScraperSourceHandler } from '../Scraper';
 import type { ScraperIntermediateSource } from '../ScraperIntermediateSource';
 /**
- * @@@
+ * Type representing source information for generating intermediate storage.
+ * Contains essential file and URL information needed to create a deterministic storage path.
  *
  * @private internal utility of `getScraperIntermediateSource`
  */
 type GetScraperIntermediateSourceSource = Pick<ScraperSourceHandler, 'filename' | 'url'>;
 /**
- * @@@
+ * Options for intermediate source generation and management.
+ * Configures how intermediate files are named, stored, and cleaned up.
  *
  * @private internal utility of `getScraperIntermediateSource`
  */
@@ -17,9 +19,8 @@ type GetScraperIntermediateSourceHandler = Required<Pick<PrepareAndScrapeOptions
     readonly extension: string_file_extension;
 };
 /**
- * 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
  */

package/esm/typings/src/scrapers/_common/utils/makeKnowledgeSourceHandler.d.ts

@@ -4,7 +4,9 @@ import type { KnowledgeSourceJson } from '../../../pipeline/PipelineJson/Knowled
 import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeOptions';
 import type { ScraperSourceHandler } from '../Scraper';
 /**
- * @@@
+ * 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`
  */

package/esm/typings/src/scrapers/document/createDocumentScraper.d.ts

@@ -2,7 +2,7 @@ import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
 import { DocumentScraper } from './DocumentScraper';
 /**
- * @@@
+ * Creates a scraper for document content.
  *
  * @public exported from `@promptbook/documents`
  */

package/esm/typings/src/scrapers/document-legacy/createLegacyDocumentScraper.d.ts

@@ -2,7 +2,8 @@ import type { ExecutionTools } from '../../execution/ExecutionTools';
 import type { PrepareAndScrapeOptions } from '../../prepare/PrepareAndScrapeOptions';
 import { LegacyDocumentScraper } from './LegacyDocumentScraper';
 /**
- * @@@
+ * Creates a scraper for legacy document formats (.doc, .rtf, etc).
+ * Uses LibreOffice for conversion to extract content from older document formats.
  *
  * @public exported from `@promptbook/legacy-documents`
  */

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/JavascriptExecutionTools.d.ts

@@ -1,6 +1,6 @@
 import { JavascriptEvalExecutionTools } from './JavascriptEvalExecutionTools';
 /**
- * Placeholder for better implementation of JavascriptExecutionTools - some propper sandboxing
+ * Placeholder for better implementation of JavascriptExecutionTools - some proper sandboxing
  *
  * @alias JavascriptExecutionTools
  * @public exported from `@promptbook/javascript`

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/scripting/javascript/utils/preserve.d.ts

@@ -9,6 +9,6 @@ import type { really_any } from '../../../utils/organization/really_any';
  */
 export declare function preserve(func: (...params: ReadonlyArray<really_any>) => unknown): void;
 /**
- * TODO: Probbably remove in favour of `keepImported`
+ * TODO: Probably remove in favour of `keepImported`
  * TODO: [1] This maybe does memory leak
  */

package/esm/typings/src/storage/_common/PromptbookStorage.d.ts

@@ -3,7 +3,7 @@ import type { Promisable } from 'type-fest';
  * Storage of objects with asynchronous API
  *
  * Note: Naming `PromptbookStorage` not `Storage` to avoid name collision with global `Storage` interface.
- * Note: This is simmilar to Web Storage API interface but everything is asynchronous and can store JSON objects.
+ * Note: This is similar to Web Storage API interface but everything is asynchronous and can store JSON objects.
  */
 export type PromptbookStorage<TItem> = {
     /**