@promptbook/javascript 0.112.0-32 → 0.112.0-35

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,7 +7,3 @@ import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeO
  * @public exported from `@promptbook/node`
  */
 export declare function $provideFilesystemForNode(options?: Pick<PrepareAndScrapeOptions, 'isVerbose'>): FilesystemTools;
-/**
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
- * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
- */

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

@@ -5,10 +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 in this file should never be never released in packages that could be imported into browser environment
- * TODO: [🏓] Unite `xxxForServer` and `xxxForNode` naming
- */

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

@@ -6,7 +6,3 @@ import type { PrepareAndScrapeOptions } from '../../../prepare/PrepareAndScrapeO
  * @public exported from `@promptbook/node`
  */
 export declare function $provideScriptingForNode(options?: PrepareAndScrapeOptions): Promise<ReadonlyArray<ScriptExecutionTools>>;
-/**
- * Note: [🟢] Code in this file should never be never released in 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: 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
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
- */

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

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

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

@@ -5,6 +5,3 @@ import type { PromptbookFetch } from '../../../execution/PromptbookFetch';
  * @public exported from `@promptbook/core`
  */
 export declare const promptbookFetch: PromptbookFetch;
-/**
- * TODO: [🧠] Maybe rename because it is not used only for scrapers but also in `$getCompiledBook`
- */

package/esm/src/scrapers/document/DocumentScraper.d.ts

@@ -9,6 +9,7 @@ import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSo
  * Scraper of .docx and .odt files
  *
  * @see `documentationUrl` for more details
+ *
  * @public exported from `@promptbook/documents`
  */
 export declare class DocumentScraper implements Converter, Scraper {
@@ -34,9 +35,3 @@ export declare class DocumentScraper 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 11:11
- * 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
- */

package/esm/src/scrapers/document/DocumentScraper.test.d.ts

@@ -1,4 +1 @@
 export {};
-/**
- * TODO: [📓] Maybe test all file in examples (not just 10-simple.docx)
- */

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

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

package/esm/src/scrapers/document/playground/document-scraper-playground.d.ts

@@ -1,5 +1,2 @@
 #!/usr/bin/env ts-node
 export {};
-/**
- * Note: [⚫] Code in this file should never be published in any package
- */

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

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

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

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

package/esm/src/scrapers/document-legacy/LegacyDocumentScraper.d.ts

@@ -9,6 +9,7 @@ import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSo
  * Scraper for old document files (like .doc and .rtf)
  *
  * @see `documentationUrl` for more details
+ *
  * @public exported from `@promptbook/legacy-documents`
  */
 export declare class LegacyDocumentScraper implements Converter, Scraper {
@@ -34,9 +35,3 @@ export declare class LegacyDocumentScraper 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 11:11
- * 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
- */

package/esm/src/scrapers/document-legacy/LegacyDocumentScraper.test.d.ts

@@ -1,4 +1 @@
 export {};
-/**
- * TODO: [📓] Maybe test all file in examples (not just 10-simple.doc)
- */

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

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

package/esm/src/scrapers/document-legacy/playground/legacy-document-scraper-playground.d.ts

@@ -1,5 +1,2 @@
 #!/usr/bin/env ts-node
 export {};
-/**
- * Note: [⚫] Code in this file should never be published in any package
- */

package/esm/src/scrapers/document-legacy/register-constructor.d.ts

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

package/esm/src/scrapers/document-legacy/register-metadata.d.ts

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

package/esm/src/scrapers/markdown/MarkdownScraper.d.ts

@@ -7,6 +7,7 @@ import type { ScraperAndConverterMetadata } from '../_common/register/ScraperAnd
  * Scraper for markdown files
  *
  * @see `documentationUrl` for more details
+ *
  * @public exported from `@promptbook/markdown-utils`
  */
 export declare class MarkdownScraper implements Scraper {
@@ -22,7 +23,3 @@ export declare class MarkdownScraper implements Scraper {
      */
     scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
 }
-/**
- * TODO: [🪂] Do it in parallel 11:11
- * Note: No need to aggregate usage here, it is done by intercepting the llmTools
- */

package/esm/src/scrapers/markdown/MarkdownScraper.test.d.ts

@@ -1,4 +1 @@
 export {};
-/**
- * TODO: [📓] Maybe test all file in examples (not just 10-simple.md)
- */

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

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

package/esm/src/scrapers/markdown/playground/markdown-scraper-playground.d.ts

@@ -1,5 +1,2 @@
 #!/usr/bin/env ts-node
 export {};
-/**
- * Note: [⚫] Code in this file should never be published in any package
- */

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

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

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

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

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

@@ -11,6 +11,7 @@ import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSo
  *
  * @see https://github.com/microsoft/markitdown
  * @see `documentationUrl` for more details
+ *
  * @public exported from `@promptbook/markitdown`
  * @public exported from `@promptbook/pdf`
  */
@@ -41,10 +42,3 @@ export declare class MarkitdownScraper implements Converter, Scraper {
      */
     scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
 }
-/**
- * TODO: [🧠][🌜] Export only from `@promptbook/markitdown` or `@promptbook/pdf` NOT both
- * 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
- */

package/esm/src/scrapers/markitdown/createMarkitdownScraper.d.ts

@@ -5,7 +5,3 @@
  * @public exported from `@promptbook/pdf`
  */
 export declare const createMarkitdownScraper: any;
-/**
- * TODO: [🧠][🌜] Export only from `@promptbook/markitdown` or `@promptbook/pdf` NOT both
- * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
- */

package/esm/src/scrapers/markitdown/playground/markitdown-scraper-playground.d.ts

@@ -1,5 +1,2 @@
 #!/usr/bin/env ts-node
 export {};
-/**
- * Note: [⚫] Code in this file should never be published in any package
- */

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

@@ -10,8 +10,3 @@ import type { Registration } from '../../utils/misc/$Register';
  * @public exported from `@promptbook/cli`
  */
 export declare const _MarkitdownScraperRegistration: Registration;
-/**
- * TODO: [🧠][🌜] Export only from `@promptbook/markitdown` or `@promptbook/pdf` NOT both
- * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

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

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

package/esm/src/scrapers/pdf/PdfScraper.d.ts

@@ -10,6 +10,7 @@ import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSo
  * Scraper for .pdf files
  *
  * @see `documentationUrl` for more details
+ *
  * @public exported from `@promptbook/pdf`
  */
 export declare class PdfScraper implements Converter, Scraper {
@@ -33,9 +34,3 @@ export declare class PdfScraper implements Converter, Scraper {
      */
     scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
 }
-/**
- * TODO: [👣] Converted pdf documents can act as cached items - there is no need to run conversion each time
- * TODO: [🪂] Do it in parallel 11:11
- * 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
- */

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

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

package/esm/src/scrapers/pdf/playground/pdf-scraper-playground.d.ts

@@ -1,5 +1,2 @@
 #!/usr/bin/env ts-node
 export {};
-/**
- * Note: [⚫] Code in this file should never be published in any package
- */

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

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

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

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

package/esm/src/scrapers/website/WebsiteScraper.d.ts

@@ -11,6 +11,7 @@ import type { ScraperIntermediateSource } from '../_common/ScraperIntermediateSo
  * Scraper for websites
  *
  * @see `documentationUrl` for more details
+ *
  * @public exported from `@promptbook/website-crawler`
  */
 export declare class WebsiteScraper implements Converter, Scraper {
@@ -42,9 +43,3 @@ export declare class WebsiteScraper implements Converter, Scraper {
      */
     scrape(source: ScraperSourceHandler): Promise<ReadonlyArray<Omit<KnowledgePiecePreparedJson, 'sources' | 'preparationIds'>> | null>;
 }
-/**
- * TODO: [👣] Scraped website in .md can act as cache item - there is no need to run conversion each time
- * TODO: [🪂] Do it in parallel 11:11
- * 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
- */

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

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

package/esm/src/scrapers/website/playground/website-scraper-playground.d.ts

@@ -1,5 +1,2 @@
 #!/usr/bin/env ts-node
 export {};
-/**
- * Note: [⚫] Code in this file should never be published in any package
- */

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

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

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

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

package/esm/src/scripting/javascript/JavascriptEvalExecutionTools.d.ts

@@ -4,7 +4,7 @@ import type { JavascriptExecutionToolsOptions } from './JavascriptExecutionTools
  * ScriptExecutionTools for JavaScript implemented via eval
  *
  * Warning: It is used for testing and mocking
- *          **NOT intended to use in the production** due to its unsafe nature, use `JavascriptExecutionTools` instead.
+ * **NOT intended to use in the production** due to its unsafe nature, use `JavascriptExecutionTools` instead.
  *
  * @public exported from `@promptbook/javascript`
  */
@@ -16,7 +16,3 @@ export declare class JavascriptEvalExecutionTools implements ScriptExecutionTool
      */
     execute(options: ScriptExecutionToolsExecuteOptions): Promise<string>;
 }
-/**
- * TODO: Put predefined functions (like removeQuotes, spaceTrim, etc.) into annotation OR pass into constructor
- * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
- */

package/esm/src/scripting/javascript/JavascriptEvalExecutionTools.test.d.ts

@@ -1,4 +1 @@
 export {};
-/**
- * TODO: Make shared test between JavascriptEvalExecutionTools and JavascriptExecutionTools to test the same functionality when implemented via vm2
- */

package/esm/src/scripting/javascript/JavascriptExecutionTools.d.ts

@@ -3,6 +3,7 @@ import { JavascriptEvalExecutionTools } from './JavascriptEvalExecutionTools';
  * Placeholder for better implementation of JavascriptExecutionTools - some proper sandboxing
  *
  * @alias JavascriptExecutionTools
+ *
  * @public exported from `@promptbook/javascript`
  */
 export declare const JavascriptExecutionTools: typeof JavascriptEvalExecutionTools;

package/esm/src/scripting/javascript/JavascriptExecutionToolsOptions.d.ts

@@ -26,6 +26,3 @@ export type PostprocessingFunction = ((value: string) => Promisable<string>) | F
  * Function that can be used as tool for AI model
  */
 export type ToolFunction = (args: TODO_any) => Promise<TODO_any>;
-/**
- * TODO: [🧠][💙] Distinct between options passed into ExecutionTools and to ExecutionTools.execute
- */

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

@@ -50,7 +50,3 @@ export declare const POSTPROCESSING_FUNCTIONS: {
     normalizeTo_SCREAMING_CASE: typeof normalizeTo_SCREAMING_CASE;
     extractBlock: typeof extractBlock;
 };
-/**
- * TODO: DRY [🍯], [🧠] Where should be POSTPROCESSING_FUNCTIONS located and how it should be named
- * Note: [💞] Ignore a discrepancy between file name and entity name
- */

package/esm/src/scripting/javascript/utils/extractVariablesFromJavascript.d.ts

@@ -6,9 +6,7 @@ import type { string_javascript_name } from '../../../types/typeAliases';
  * @param script from which to extract the variables
  * @returns the list of variable names
  * @throws {ParseError} if the script is invalid
+ *
  * @public exported from `@promptbook/javascript`
  */
 export declare function extractVariablesFromJavascript(script: string_javascript): Set<string_javascript_name>;
-/**
- * TODO: [🔣] Support for multiple languages - python, java,...
- */

package/esm/src/search-engines/SearchEngine.d.ts

@@ -1,6 +1,9 @@
 import type { Promisable } from 'type-fest';
 import type { string_markdown, string_markdown_text, string_title } from '../types/typeAliases';
 import type { SearchResult } from './SearchResult';
+/**
+ * Type describing search engine.
+ */
 export type SearchEngine = {
     readonly title: string_title & string_markdown_text;
     readonly description?: string_markdown;

package/esm/src/speech-recognition/BrowserSpeechRecognition.d.ts

@@ -15,7 +15,3 @@ export declare class BrowserSpeechRecognition implements SpeechRecognition {
     subscribe(callback: (event: SpeechRecognitionEvent) => void): () => void;
     private emit;
 }
-/**
- * TODO: !!!! Search ACRY for `window` and put -> [🔵]
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
- */

package/esm/src/speech-recognition/OpenAiSpeechRecognition.d.ts

@@ -12,9 +12,9 @@ export type OpenAiSpeechRecognitionOptions = {
 /**
  * Speech recognition using OpenAI Whisper API to transcribe audio into text
  *
- * @private because it requires server-client communication with a proxy endpoint
- *
  * Note: This implementation uses a server-side proxy to avoid exposing the OpenAI API key on the client.
+ *
+ * @private because it requires server-client communication with a proxy endpoint
  */
 export declare class OpenAiSpeechRecognition implements SpeechRecognition {
     private readonly options;

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

@@ -19,7 +19,3 @@ export type PromptbookStorage<TItem> = {
      */
     removeItem(key: string): Promisable<void>;
 };
-/**
- * TODO: [💺] Constrain `TItem` to [🚉] JSON-serializable objects only in type level
- * TODO: [☹️] Unite the storages
- */

package/esm/src/storage/_common/PromptbookStorage.test-type.d.ts

@@ -1,5 +1 @@
 export {};
-/**
- * Note: [⚪] This should never be in any released package
- * TODO: Is this a good pattern to do type testing?
- */

package/esm/src/storage/env-storage/$EnvStorage.d.ts

@@ -36,6 +36,3 @@ export declare class $EnvStorage<TItem> implements PromptbookStorage<TItem> {
      */
     removeItem(key: string): void;
 }
-/**
- * TODO: Write file more securely - ensure that there can be no accidental overwriting of existing variables and other content
- */

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

@@ -34,7 +34,3 @@ export declare class FileCacheStorage<TItem> implements PromptbookStorage<TItem>
      */
     removeItem(key: string): Promise<void>;
 }
-/**
- * TODO: [🌗] Maybe some checkers, not all valid JSONs are desired and valid values
- * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
- */

package/esm/src/storage/local-storage/getIndexedDbStorage.d.ts

@@ -6,6 +6,3 @@ import type { IndexedDbStorageOptions } from './utils/IndexedDbStorageOptions';
  * @public exported from `@promptbook/browser`
  */
 export declare function getIndexedDbStorage<TItem>(options: IndexedDbStorageOptions): PromptbookStorage<TItem>;
-/**
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
- */

package/esm/src/storage/local-storage/getLocalStorage.d.ts

@@ -5,6 +5,3 @@ import type { PromptbookStorage } from '../_common/PromptbookStorage';
  * @public exported from `@promptbook/browser`
  */
 export declare function getLocalStorage<TItem>(): PromptbookStorage<TItem>;
-/**
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
- */

package/esm/src/storage/local-storage/getSessionStorage.d.ts

@@ -5,6 +5,3 @@ import type { PromptbookStorage } from '../_common/PromptbookStorage';
  * @public exported from `@promptbook/browser`
  */
 export declare function getSessionStorage<TItem>(): PromptbookStorage<TItem>;
-/**
- * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
- */

package/esm/src/storage/local-storage/utils/makePromptbookStorageFromIndexedDb.d.ts

@@ -3,6 +3,7 @@ import type { IndexedDbStorageOptions } from './IndexedDbStorageOptions';
 /**
  * Creates a PromptbookStorage backed by IndexedDB.
  * Uses a single object store named 'promptbook'.
+ *
  * @private for `getIndexedDbStorage`
  */
 export declare function makePromptbookStorageFromIndexedDb<TValue>(options: IndexedDbStorageOptions): PromptbookStorage<TValue>;