@promptbook/javascript 0.112.0-34 → 0.112.0-35

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

@@ -3,11 +3,9 @@ import type { CommonTaskJson } from './CommonTaskJson';
  * Task for simple concatenation of strings
  *
  * Note: [🚉] This is fully serializable as JSON
+ *
  * @see https://github.com/webgptorg/promptbook/discussions/17
  */
 export type SimpleTaskJson = CommonTaskJson & {
     readonly taskType: 'SIMPLE_TASK';
 };
-/**
- * TODO: [🍙] Make some standard order of json properties
- */

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

@@ -11,10 +11,7 @@ import type { PipelineString } from './PipelineString';
  * @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`
  */
 export declare function book(strings: TemplateStringsArray, ...values: Array<string>): string_book & PipelineString;
-/**
- * TODO: [🧠][🈴] Where is the best location for this file
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/esm/src/pipeline/isValidPipelineString.d.ts

@@ -5,9 +5,7 @@ import type { PipelineString } from './PipelineString';
  *
  * @param {string} pipelineString the candidate for a pipeline string
  * @returns {boolean} if the string is a valid pipeline string
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function isValidPipelineString(pipelineString: string): pipelineString is PipelineString;
-/**
- * TODO: [🧠][🈴] Where is the best location for this file
- */

package/esm/src/pipeline/isValidPipelineString.test.d.ts

@@ -1,4 +1 @@
 export {};
-/**
- * TODO: [🧠][🈴] Where is the best location for this file
- */

package/esm/src/pipeline/prompt-notation/helpers/ParameterEscaping.d.ts

@@ -2,6 +2,7 @@
  * Normalizes a JSON string so it can be safely rendered without double escaping.
  *
  * @param value Candidate JSON string.
+ *
  * @private function of ParameterEscaping
  */
 declare function normalizeJsonString(value: string): string | null;
@@ -9,6 +10,7 @@ declare function normalizeJsonString(value: string): string | null;
  * Hides brackets in a string to avoid confusion with template parameters.
  *
  * @param value Input string with literal brackets.
+ *
  * @private function of ParameterEscaping
  */
 declare function hideBrackets(value: string): string;
@@ -16,6 +18,7 @@ declare function hideBrackets(value: string): string;
  * Restores hidden brackets.
  *
  * @param value String with hidden brackets.
+ *
  * @private function of ParameterEscaping
  */
 declare function restoreBrackets(value: string): string;
@@ -23,6 +26,7 @@ declare function restoreBrackets(value: string): string;
  * Decides whether a parameter can be inlined safely.
  *
  * @param value Parameter rendered as string.
+ *
  * @private function of ParameterEscaping
  */
 declare function shouldInlineParameterValue(value: string): boolean;
@@ -31,6 +35,7 @@ declare function shouldInlineParameterValue(value: string): boolean;
  *
  * @param value Parameter value to escape.
  * @param options Escape options for additional characters.
+ *
  * @private function of ParameterEscaping
  */
 declare function escapePromptParameterValue(value: string, options: {

package/esm/src/pipeline/prompt-notation/helpers/ParameterNaming.d.ts

@@ -2,6 +2,7 @@
  * Builds placeholder names while avoiding collisions with parameter content.
  *
  * @param values Parameter values to scan for conflicting tokens.
+ *
  * @private function of ParameterNaming
  */
 declare function buildParameterNames(values: string[]): string[];

package/esm/src/pipeline/prompt-notation/helpers/ParameterSection.d.ts

@@ -12,6 +12,7 @@ type StructuredParameterEntry = {
  * Formats the placeholder used in the prompt body for a parameter.
  *
  * @param name Parameter placeholder name.
+ *
  * @private function of ParameterSection
  */
 declare function formatParameterPlaceholder(name: string): string;
@@ -19,6 +20,7 @@ declare function formatParameterPlaceholder(name: string): string;
  * Builds the structured parameters section appended to the prompt.
  *
  * @param items Parameter entries to include.
+ *
  * @private function of ParameterSection
  */
 declare function buildParametersSection(items: StructuredParameterEntry[]): string;

package/esm/src/pipeline/prompt-notation.d.ts

@@ -34,6 +34,7 @@ export declare class PromptString extends String {
  * @param strings
  * @param values
  * @returns prompt content wrapped as a PromptString
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function prompt(strings: TemplateStringsArray, ...values: Array<really_unknown>): PromptString;
@@ -46,11 +47,7 @@ export declare function prompt(strings: TemplateStringsArray, ...values: Array<r
  * 3) `book` for notating and validating entire books exported from `@promptbook/utils`
  *
  * @alias prompt
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare const promptTemplate: typeof prompt;
-/**
- * TODO: Maybe split into multiple files
- * TODO: [🧠][🈴] Where is the best location for this file
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/esm/src/pipeline/prompt-notation.test.d.ts

@@ -1,4 +1 @@
 export {};
-/**
- * TODO: [??][??] Where is the best location for this file
- */

package/esm/src/pipeline/validatePipelineString.d.ts

@@ -8,9 +8,7 @@ import type { PipelineString } from './PipelineString';
  * @param {string} pipelineString the candidate for a pipeline string
  * @returns {PipelineString} the same string as input, but validated as valid
  * @throws {ParseError} if the string is not a valid pipeline string
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function validatePipelineString(pipelineString: string): PipelineString;
-/**
- * TODO: [🧠][🈴] Where is the best location for this file
- */

package/esm/src/playground/permanent/_boilerplate.d.ts

@@ -1,3 +1,2 @@
 #!/usr/bin/env ts-node
 export {};
-/** Note: [⚫] Code for permanent playground [_boilerplate](src/playground/permanent/_boilerplate.ts) should never be published in any package */

package/esm/src/playground/permanent/agent-with-browser-playground.d.ts

@@ -1,3 +1,2 @@
 #!/usr/bin/env ts-node
 export {};
-/** Note: [⚫] Code for permanent playground [agent-with-browser-playground](src/playground/permanent/agent-with-browser-playground.ts) should never be published in any package */

package/esm/src/playground/permanent/error-handling-playground.d.ts

@@ -1,3 +1,2 @@
 #!/usr/bin/env ts-node
 export {};
-/** Note: [⚫] Code for permanent playground [error-handling-playground](src/playground/permanent/error-handling-playground.ts) should never be published in any package */

package/esm/src/playground/playground.d.ts

@@ -1,4 +1,2 @@
 #!/usr/bin/env ts-node
 export {};
-/** Note: [⚫] Code for playground [main playground](src/playground/playground.ts) should never be published in any package */
-/** TODO: !!!!!!! Extract to `other` and append DigitalOcean instructions */

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

@@ -10,7 +10,8 @@ import type { string_markdown } from '../../types/typeAliases';
  * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
  * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
  *
- * @public exported from `@promptbook/markdown-utils`
  * @throws {ParseError} if there is not exactly one code block in the markdown
+ *
+ * @public exported from `@promptbook/markdown-utils`
  */
 export declare function extractBlock(markdown: string_markdown): string;

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

@@ -15,11 +15,8 @@ import type { really_unknown } from '../../utils/organization/really_unknown';
  * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
  * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
  *
- * @public exported from `@promptbook/markdown-utils`
  * @throws {ParseError} if there is no valid JSON block in the markdown
+ *
+ * @public exported from `@promptbook/markdown-utils`
  */
 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 `JsonFormatParser` or `isValidJsonString`
- */

package/esm/src/prepare/PrepareAndScrapeOptions.d.ts

@@ -46,7 +46,3 @@ export type PrepareAndScrapeOptions = {
      */
     readonly isVerbose?: boolean;
 };
-/**
- * TODO: [🧠] Maybe extend from `CommonToolsOptions`
- * TODO: [🧠] Maybe split `PrepareAndScrapeOptions` and `ScrapeOptions` (`ScrapeOptions` should be extended from `PrepareAndScrapeOptions`)
- */

package/esm/src/prepare/preparePipeline.d.ts

@@ -4,11 +4,12 @@ import type { PrepareAndScrapeOptions } from './PrepareAndScrapeOptions';
 /**
  * Prepare pipeline locally
  *
- * @see https://github.com/webgptorg/promptbook/discussions/196
- *
  * Note: This function does not validate logic of the pipeline
  * Note: This function acts as part of compilation process
  * Note: When the pipeline is already prepared, it returns the same pipeline
+ *
+ * @see https://github.com/webgptorg/promptbook/discussions/196
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function preparePipeline(pipeline: PipelineJson, tools: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options: PrepareAndScrapeOptions): Promise<PipelineJson>;

package/esm/src/prepare/preparePipelineOnRemoteServer.d.ts

@@ -3,15 +3,12 @@ import type { RemoteClientOptions } from '../remote-server/types/RemoteClientOpt
 /**
  * Prepare pipeline on remote server
  *
- * @see https://github.com/webgptorg/promptbook/discussions/196
- *
  * Note: This function does not validate logic of the pipeline
  * Note: This function acts as part of compilation process
  * Note: When the pipeline is already prepared, it returns the same pipeline
  *
+ * @see https://github.com/webgptorg/promptbook/discussions/196
+ *
  * @public exported from `@promptbook/remote-client`
  */
 export declare function preparePipelineOnRemoteServer<TCustomOptions = undefined>(pipeline: PipelineJson, options: RemoteClientOptions<TCustomOptions>): Promise<PipelineJson>;
-/**
- * TODO: [🐚] Do not return `Promise<PipelineJson>` But `PreparationTask`
- */

package/esm/src/prepare/prepareTasks.d.ts

@@ -2,12 +2,18 @@ import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 import type { TaskJson } from '../pipeline/PipelineJson/TaskJson';
 import type { PrepareAndScrapeOptions } from './PrepareAndScrapeOptions';
+/**
+ * Type describing prepare task input.
+ */
 type PrepareTaskInput = Pick<PipelineJson, 'tasks' | 'parameters'> & {
     /**
      * The number of knowledge pieces available for the pipeline.
      */
     readonly knowledgePiecesCount: number;
 };
+/**
+ * Type describing prepared tasks.
+ */
 type PreparedTasks = {
     /**
      * The sequence of tasks after preparation.
@@ -24,13 +30,3 @@ type PreparedTasks = {
  */
 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, 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
- * TODO: Write tests for `preparePipeline`
- * TODO: [🏏] Leverage the batch API and build queues @see https://platform.openai.com/docs/guides/batch
- * TODO: [🧊] In future one preparation can take data from previous preparation and save tokens and time
- * TODO: [🛠] Actions, instruments (and maybe knowledge) => Functions and tools
- */

package/esm/src/prepare/unpreparePipeline.d.ts

@@ -3,11 +3,7 @@ import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
  * Unprepare just strips the preparation data of the pipeline
  *
  * @deprecated In future version this function will be removed or deprecated
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function unpreparePipeline(pipeline: PipelineJson): PipelineJson;
-/**
- * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`
- * TODO: Write tests for `preparePipeline`
- * TODO: [🍙] Make some standard order of json properties
- */

package/esm/src/remote-server/RemoteServer.d.ts

@@ -5,6 +5,9 @@ import http from 'http';
 import { DefaultEventsMap, Server } from 'socket.io';
 import type { TODO_any } from '../utils/organization/TODO_any';
 import type { TODO_narrow } from '../utils/organization/TODO_narrow';
+/**
+ * Type describing remote server.
+ */
 export type RemoteServer = IDestroyable & {
     /**
      * HTTP server instance

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

@@ -1,5 +1,7 @@
 /**
- * @private [🥺] Decide how to expose this
+ * [🥺] Decide how to expose this.
+ *
+ * @private
  */
 export declare const openapiJson: {
     openapi: string;
@@ -576,6 +578,3 @@ export declare const openapiJson: {
         description: string;
     }[];
 };
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/esm/src/remote-server/socket-types/_subtypes/Identification.d.ts

@@ -30,7 +30,7 @@ export type ApplicationModeIdentification<TCustomOptions> = ApplicationRemoteSer
  * Anonymous mode is when you run arbitrary user books without api keys from user
  *
  * Note: This is useful in situations when the LLM provider does not allow to call the API requests from the client side
- *       It is kind of a proxy mode
+ * It is kind of a proxy mode
  *
  * @public exported from `@promptbook/remote-server`
  * @public exported from `@promptbook/remote-client`
@@ -53,7 +53,3 @@ export type AnonymousModeIdentification = {
      */
     readonly llmToolsConfiguration: LlmToolsConfiguration;
 };
-/**
- * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
- * TODO: [🧠][🤺] Maybe allow overriding of `userId` for each prompt - Pass `userId` in `PromptbookServer_ListModels_Request`
- */

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

@@ -12,6 +12,3 @@ export type PromptbookServer_ListModels_Request<TCustomOptions> = {
      */
     readonly identification: Identification<TCustomOptions>;
 };
-/**
- * TODO: [🧠] Listing models inanonymous mode does not make sense - keeping only to preserve consistency
- */

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

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

package/esm/src/remote-server/startAgentServer.d.ts

@@ -1,5 +1,8 @@
 import type { number_port } from '../types/typeAliases';
 import type { TODO_any } from '../utils/organization/TODO_any';
+/**
+ * Options for agents server.
+ */
 type AgentsServerOptions = {
     /**
      * !!!
@@ -15,10 +18,11 @@ type AgentsServerOptions = {
  * You can simply use `RemoteExecutionTools` on client-side javascript and connect to your remote server.
  * This is useful to make all logic on browser side but not expose your API keys or no need to use customer's GPU.
  *
+ * TODO: [🐱‍🚀] Change to `@promptbook/agent-server`
+ *
  * @see https://github.com/webgptorg/promptbook#remote-server
+ *
  * @public exported from `@promptbook/remote-server`
- * <- TODO: [🐱‍🚀] Change to `@promptbook/agent-server`
  */
 export declare function startAgentServer(options: AgentsServerOptions): Promise<TODO_any>;
 export {};
-/** Note: [🟢] Code for Node server bootstrap [startAgentServer](src/remote-server/startAgentServer.ts) should never be published into packages that could be imported into browser environment */

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

@@ -7,21 +7,7 @@ import type { RemoteServerOptions } from './types/RemoteServerOptions';
  * This is useful to make all logic on browser side but not expose your API keys or no need to use customer's GPU.
  *
  * @see https://github.com/webgptorg/promptbook#remote-server
+ *
  * @public exported from `@promptbook/remote-server`
  */
 export declare function startRemoteServer<TCustomOptions = undefined>(options: RemoteServerOptions<TCustomOptions>): RemoteServer;
-/** Note: [🟢] Code for Node server bootstrap [startRemoteServer](src/remote-server/startRemoteServer.ts) should never be published into packages that could be imported into browser environment */
-/**
- * TODO: [🕋] Use here `aboutPromptbookInformation`
- * 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'`
- * TODO: [⚖] Expose the collection to be able to connect to same collection via createPipelineCollectionFromUrl
- * TODO: Handle progress - support streaming
- * TODO: [🗯] Do not hang up immediately but wait until client closes OR timeout
- * TODO: [🗯] Timeout on chat to free up resources
- * TODO: [🃏] Pass here some security token to prevent malitious usage and/or DDoS
- * TODO: [0] Set unavailable models as undefined in `RemoteLlmExecutionTools` NOT throw error here
- * TODO: Allow to constrain anonymous mode for specific models / providers
- */

package/esm/src/remote-server/types/RemoteClientOptions.d.ts

@@ -17,8 +17,3 @@ export type RemoteClientOptions<TCustomOptions> = CommonToolsOptions & {
      */
     readonly identification: Identification<TCustomOptions>;
 };
-/**
- * TODO: Pass more options from Socket.io to `RemoteClientOptions` (like `transports`)
- * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
- * TODO: [🧠][🧜‍♂️] Maybe join remoteServerUrl and path into single value
- */

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

@@ -14,7 +14,7 @@ import type { ApplicationModeIdentification, Identification } from '../socket-ty
  *
  * 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
+ * In anonymous mode, `collection` will be ignored and any prompt will be executed
  *
  * You can enable both modes at the same time.
  *
@@ -50,12 +50,18 @@ export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
 }) | ({
     readonly isAnonymousModeAllowed?: false;
 } & ApplicationRemoteServerOptions<TCustomOptions>) | (AnonymousRemoteServerOptions & ApplicationRemoteServerOptions<TCustomOptions>));
+/**
+ * Options for anonymous remote server.
+ */
 export type AnonymousRemoteServerOptions = {
     /**
      * Enable anonymous mode
      */
     readonly isAnonymousModeAllowed: true;
 };
+/**
+ * Options for application remote server.
+ */
 export type ApplicationRemoteServerOptions<TCustomOptions> = {
     /**
      * Enable application mode
@@ -84,6 +90,9 @@ export type ApplicationRemoteServerOptions<TCustomOptions> = {
      */
     createLlmExecutionTools(options: ApplicationModeIdentification<TCustomOptions>): Promisable<LlmExecutionTools>;
 };
+/**
+ * Options for application remote server client.
+ */
 export type ApplicationRemoteServerClientOptions<TCustomOptions> = {
     /**
      * Identifier of the application
@@ -160,6 +169,3 @@ export type LoginResponse<TCustomOptions> = {
      */
     readonly identification?: Identification<TCustomOptions>;
 };
-/**
- * TODO: Constrain anonymous mode for specific models / providers
- */

package/esm/src/remote-server/ui/ServerApp.d.ts

@@ -6,6 +6,7 @@ import type { ServerInfo } from './types';
  * including necessary meta tags, Tailwind CSS styling, and the server details body.
  *
  * @param props - Contains server information such as versions, port, and pipelines
+ *
  * @private internal utility of Remote Server
  */
 export declare function HtmlDoc({ info }: {

package/esm/src/remote-server/ui/types.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Information about server.
+ */
 export type ServerInfo = {
     bookLanguageVersion: string;
     promptbookEngineVersion: string;

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

@@ -9,6 +9,7 @@ import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSo
  * Scraper of @@ files
  *
  * @see `documentationUrl` for more details
+ *
  * @public exported from `@promptbook/boilerplate`
  */
 export declare class BoilerplateScraper implements Converter, Scraper {
@@ -34,7 +35,3 @@ export declare class BoilerplateScraper implements Converter, Scraper {
      */
     scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
 }
-/** 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 for Node scraper boilerplate [BoilerplateScraper](src/scrapers/_boilerplate/BoilerplateScraper.ts) should never be published into packages that could be imported into browser environment */

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

@@ -4,6 +4,3 @@
  * @public exported from `@promptbook/boilerplate`
  */
 export declare const createBoilerplateScraper: any;
-/**
- * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
- */

package/esm/src/scrapers/_boilerplate/playground/boilerplate-scraper-playground.d.ts

@@ -1,3 +1,2 @@
 #!/usr/bin/env ts-node
 export {};
-/** Note: [⚫] Code for playground [boilerplate-scraper-playground](src/scrapers/_boilerplate/playground/boilerplate-scraper-playground.ts) should never be published in any package */

package/esm/src/scrapers/_boilerplate/register-constructor.d.ts

@@ -9,7 +9,3 @@ import type { Registration } from '../../utils/misc/$Register';
  * @public exported from `@promptbook/cli`
  */
 export declare const _BoilerplateScraperRegistration: Registration;
-/**
- * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

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

@@ -15,6 +15,3 @@ export declare const boilerplateScraperMetadata: any;
  * @public exported from `@promptbook/cli`
  */
 export declare const _BoilerplateScraperMetadataRegistration: Registration;
-/**
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

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

@@ -53,8 +53,3 @@ export type ScraperSourceHandler = {
      */
     asText(): Promisable<string>;
 };
-/**
- * TODO: [🧠] Maybe split `ScraperSourceHandler` into `ScraperWebsiteSourceHandler` + `ScraperFileSourceHandler`
- * TODO: [🥽] Add ` asBlob(): Promisable<Blob>;` or asFile
- * TODO: [🔼] Export via types
- */

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

@@ -11,6 +11,3 @@ export type ScraperIntermediateSource = IDestroyable & {
      */
     readonly filename: string_absolute_filename;
 };
-/**
- * Note: [🌏] Converters can be used only in node because they uses `ScraperIntermediateSource` which  uses file system
- */

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

@@ -6,6 +6,7 @@ import type { ExecutionTools } from '../../execution/ExecutionTools';
  * Prepares the knowledge pieces
  *
  * @see https://github.com/webgptorg/promptbook/discussions/41
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function prepareKnowledgePieces(knowledgeSources: ReadonlyArray<KnowledgeSourceJson>, tools: Pick<ExecutionTools, 'llm' | 'fs' | 'scrapers'>, options: PrepareAndScrapeOptions): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'preparationIds'>>>;

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

@@ -7,5 +7,3 @@ import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeO
  * @public exported from `@promptbook/node`
  */
 export declare function $provideFilesystemForNode(options?: Pick<PrepareAndScrapeOptions, 'isVerbose'>): FilesystemTools;
-/** Note: [🟢] Code for Node scraper registration helper [$provideFilesystemForNode](src/scrapers/_common/register/$provideFilesystemForNode.ts) should never be published into packages that could be imported into browser environment */
-/** TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming */

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

@@ -5,8 +5,7 @@ import type { Scraper } from '../Scraper';
  * 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>>;
-/** Note: [🟢] Code for Node scraper registration helper [$provideScrapersForNode](src/scrapers/_common/register/$provideScrapersForNode.ts) should never be published into packages that could be imported into browser environment */
-/** TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming */

package/esm/src/scrapers/_common/register/$provideScriptingForNode.d.ts

@@ -6,5 +6,3 @@ import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeO
  * @public exported from `@promptbook/node`
  */
 export declare function $provideScriptingForNode(options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<ScriptExecutionTools>>;
-/** Note: [🟢] Code for Node scraper registration helper [$provideScriptingForNode](src/scrapers/_common/register/$provideScriptingForNode.ts) should never be published into packages that could be imported into browser environment */
-/** TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming */

package/esm/src/scrapers/_common/register/$registeredScrapersMessage.d.ts

@@ -8,6 +8,3 @@ import type { Scraper } from '../Scraper';
  * @private internal function of `createScrapersFromConfiguration` and `createScrapersFromEnv`
  */
 export declare function $registeredScrapersMessage(availableScrapers: ReadonlyArray<Scraper>): string_markdown;
-/**
- * TODO: [®] DRY Register logic
- */

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

@@ -4,10 +4,9 @@ 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 there can be more in different contexts (e.g., tests).
+ *
  * @public exported from `@promptbook/core`
  */
 export declare const $scrapersMetadataRegister: $Register<ScraperAndConverterMetadata>;
-/**
- * TODO: [®] DRY Register logic
- */

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

@@ -5,10 +5,9 @@ import type { ScraperConstructor } from './ScraperConstructor';
  * 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 there can be more than one in different build modules
+ *
  * @public exported from `@promptbook/core`
  */
 export declare const $scrapersRegister: $Register<ScraperConstructor>;
-/**
- * TODO: [®] DRY Register logic
- */

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

@@ -8,6 +8,3 @@ import type { ScraperAndConverterMetadata } from './ScraperAndConverterMetadata'
  * Used for registering scrapers in the system to handle different content types.
  */
 export type ScraperConstructor = Registered & ScraperAndConverterMetadata & ((tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions) => Scraper);
-/**
- * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
- */

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

@@ -26,10 +26,3 @@ type GetScraperIntermediateSourceHandler = Required<Pick<PrepareAndScrapeOptions
  */
 export declare function getScraperIntermediateSource(source: GetScraperIntermediateSourceSource, options: GetScraperIntermediateSourceHandler): Promise<ScraperIntermediateSource>;
 export {};
-/** Note: [🟢] Code for Node scraper helper [getScraperIntermediateSource](src/scrapers/_common/utils/getScraperIntermediateSource.ts) should never be published into packages that could be imported into browser environment */
-/**
- * Note: Not using `FileCacheStorage` for two reasons:
- * 1) Need to store more than serialized JSONs
- * 2) Need to switch between a `rootDirname` and `cacheDirname` <- TODO: [😡]
- * TODO: [🐱‍🐉][🧠] Make some smart crop
- */

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

@@ -1,4 +1 @@
 export {};
-/**
- * TODO: [🐱‍🐉][🧠] Make some smart crop
- */