@promptbook/markdown-utils 0.81.0-9 → 0.81.0

package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsFromEnv.d.ts

@@ -15,7 +15,7 @@ import type { CreateLlmToolsFromConfigurationOptions } from './createLlmToolsFro
  * @returns @@@
  * @public exported from `@promptbook/node`
  */
-export declare function $provideLlmToolsFromEnv(options?: CreateLlmToolsFromConfigurationOptions): MultipleLlmExecutionTools;
+export declare function $provideLlmToolsFromEnv(options?: CreateLlmToolsFromConfigurationOptions): Promise<MultipleLlmExecutionTools>;
 /**
  * TODO: @@@ write `$provideLlmToolsFromEnv` vs `$provideLlmToolsConfigurationFromEnv` vs `createLlmToolsFromConfiguration`
  * TODO: [🧠][🍛] Which name is better `$provideLlmToolsFromEnv` or `$provideLlmToolsFromEnvironment`?

package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts

@@ -16,7 +16,7 @@ export declare const ANTHROPIC_CLAUDE_MODELS: ReadonlyArray<AvailableModel & {
 }>;
 /**
  * Note: [🤖] Add models of new variant
- * TODO: [🧠][main] !!! Add embedding models OR Anthropic has only chat+completion models?
+ * TODO: [🧠][main] !!3 Add embedding models OR Anthropic has only chat+completion models?
  * TODO: [🧠] Some mechanism to propagate unsureness
  * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
  * TODO: [🎰] Some mechanism to auto-update available models

package/esm/typings/src/llm-providers/anthropic-claude/createAnthropicClaudeExecutionTools.d.ts

@@ -11,8 +11,8 @@ export declare const createAnthropicClaudeExecutionTools: ((options: AnthropicCl
     className: string;
 };
 /**
- * TODO: [🧠][main] !!!! Make anonymous this with all LLM providers
- * TODO: [🧠][🧱][main] !!!! Maybe change all `new AnthropicClaudeExecutionTools` -> `createAnthropicClaudeExecutionTools` in manual
+ * TODO: [🧠][main] !!4 Make anonymous this with all LLM providers
+ * TODO: [🧠][🧱][main] !!4 Maybe change all `new AnthropicClaudeExecutionTools` -> `createAnthropicClaudeExecutionTools` in manual
  * TODO: [🧠] Maybe auto-detect usage in browser and determine default value of `isProxied`
  * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"

package/esm/typings/src/llm-providers/anthropic-claude/playground/playground.d.ts

@@ -1,7 +1,7 @@
 #!/usr/bin/env ts-node
 export {};
 /**
- * TODO: [main] !!! Playground with WebGPT / Promptbook.studio anonymous server
- * TODO: [main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * TODO: [main] !!3 Playground with WebGPT / Promptbook.studio anonymous server
+ * TODO: [main] !!3 Test here that `systemMessage`, `temperature` and `seed` are working correctly
  * Note: [⚫] Code in this file should never be published in any package
  */

package/esm/typings/src/llm-providers/anthropic-claude/register-configuration.d.ts

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
  *
  * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _AnthropicClaudeMetadataRegistration: Registration;

package/esm/typings/src/llm-providers/anthropic-claude/register-constructor.d.ts

@@ -5,7 +5,9 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
  *
  * @public exported from `@promptbook/anthropic-claude`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
+ *
  */
 export declare const _AnthropicClaudeRegistration: Registration;
 /**

package/esm/typings/src/llm-providers/azure-openai/register-configuration.d.ts

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
  *
  * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _AzureOpenAiMetadataRegistration: Registration;

package/esm/typings/src/llm-providers/azure-openai/register-constructor.d.ts

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
  *
  * @public exported from `@promptbook/azure-openai`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _AzureOpenAiRegistration: Registration;

package/esm/typings/src/llm-providers/google/register-configuration.d.ts

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
  *
  * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _GoogleMetadataRegistration: Registration;

package/esm/typings/src/llm-providers/google/register-constructor.d.ts

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
  *
  * @public exported from `@promptbook/google`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _GoogleRegistration: Registration;

package/esm/typings/src/llm-providers/openai/playground/playground.d.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env ts-node
 export {};
 /**
- * TODO: [main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * TODO: [main] !!3 Test here that `systemMessage`, `temperature` and `seed` are working correctly
  * Note: [⚫] Code in this file should never be published in any package
  */

package/esm/typings/src/llm-providers/openai/register-configuration.d.ts

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
  *
  * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _OpenAiMetadataRegistration: Registration;
@@ -14,6 +15,7 @@ export declare const _OpenAiMetadataRegistration: Registration;
  * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
  *
  * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _OpenAiAssistantMetadataRegistration: Registration;

package/esm/typings/src/llm-providers/openai/register-constructor.d.ts

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available LLM tools
  *
  * @public exported from `@promptbook/openai`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _OpenAiRegistration: Registration;
@@ -14,6 +15,7 @@ export declare const _OpenAiRegistration: Registration;
  * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
  *
  * @public exported from `@promptbook/openai`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _OpenAiAssistantRegistration: Registration;

package/esm/typings/src/llm-providers/vercel/playground/playground.d.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env ts-node
 export {};
 /**
- * TODO: [main] !!! Test here that `systemMessage`, `temperature` and `seed` are working correctly
+ * TODO: [main] !!3 Test here that `systemMessage`, `temperature` and `seed` are working correctly
  * Note: [⚫] Code in this file should never be published in any package
  */

package/esm/typings/src/other/templates/getBookTemplates.d.ts

@@ -0,0 +1,22 @@
+import type { string_formfactor_name } from '../../formfactors/_common/string_formfactor_name';
+import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
+/**
+ * @@@
+ *
+ * @singleton
+ * @private internal cache of `getBookTemplate`
+ */
+export declare let pipelines: Array<PipelineJson> | null;
+/**
+ * Get template for new book
+ *
+ * @param formfactorName - optional filter for FORMFACTOR - get only pipelines for this formfactor
+ * @returns list of pipelines
+ * @public exported from `@promptbook/templates`
+ */
+export declare function getBookTemplates(formfactorName?: string_formfactor_name): ReadonlyArray<PipelineJson>;
+/**
+ * TODO: Unit test
+ * TODO: [🧠] Which is the best place for this function
+ * TODO: !!6 For GENERIC template ensure at least one pipeline is present for typescript in `getBookTemplates`
+ */

package/esm/typings/src/personas/preparePersona.d.ts

@@ -10,8 +10,8 @@ import type { string_persona_description } from '../types/typeAliases';
  */
 export declare function preparePersona(personaDescription: string_persona_description, tools: Pick<ExecutionTools, 'llm'>, options: PrepareAndScrapeOptions): Promise<PersonaPreparedJson['modelRequirements']>;
 /**
- * TODO: [🔃][main] !! If the persona was prepared with different version or different set of models, prepare it once again
- * TODO: [🏢] !! Check validity of `modelName` in pipeline
- * TODO: [🏢] !! Check validity of `systemMessage` in pipeline
- * TODO: [🏢] !! Check validity of `temperature` in pipeline
+ * TODO: [🔃][main] If the persona was prepared with different version or different set of models, prepare it once again
+ * TODO: [🏢] Check validity of `modelName` in pipeline
+ * TODO: [🏢] Check validity of `systemMessage` in pipeline
+ * TODO: [🏢] Check validity of `temperature` in pipeline
  */

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

@@ -7,6 +7,3 @@
 export type PipelineString = string & {
     readonly _type: 'Promptbook';
 };
-/**
- * TODO: [💩] Better validation (validatePipelineString) or remove branded type and make it just string
- */

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

@@ -0,0 +1,14 @@
+import type { PipelineString } from './PipelineString';
+/**
+ * Tag function for notating a pipeline with a book\`...\ notation as template literal
+ *
+ * @param strings @@@
+ * @param values @@@
+ * @returns the pipeline string
+ * @public exported from `@promptbook/core`
+ */
+export declare function book(strings: TemplateStringsArray, ...values: Array<string>): PipelineString;
+/**
+ * TODO: [🧠][🈴] Where is the best location for this file
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,13 @@
+import type { PipelineString } from './PipelineString';
+/**
+ * Function `isValidPipelineString` will validate the if the string is a valid pipeline string
+ * It does not check if the string is fully logically correct, but if it is a string that can be a pipeline string or the string looks completely different.
+ *
+ * @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/typings/src/pipeline/isValidPipelineString.test.d.ts

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

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

@@ -0,0 +1,14 @@
+import type { PipelineString } from './PipelineString';
+/**
+ * Function `validatePipelineString` will validate the if the string is a valid pipeline string
+ * It does not check if the string is fully logically correct, but if it is a string that can be a pipeline string or the string looks completely different.
+ *
+ * @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/typings/src/prepare/isPipelinePrepared.d.ts

@@ -2,11 +2,13 @@ import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
 /**
  * Determine if the pipeline is fully prepared
  *
+ * @see https://github.com/webgptorg/promptbook/discussions/196
+ *
  * @public exported from `@promptbook/core`
  */
 export declare function isPipelinePrepared(pipeline: PipelineJson): boolean;
 /**
- * TODO: [🔃][main] !! If the pipeline was prepared with different version or different set of models, prepare it once again
+ * TODO: [🔃][main] If the pipeline was prepared with different version or different set of models, prepare it once again
  * TODO: [🐠] Maybe base this on `makeValidator`
  * TODO: [🧊] Pipeline can be partially prepared, this should return true ONLY if fully prepared
  * TODO: [🧿] Maybe do same process with same granularity and subfinctions as `preparePipeline`

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

@@ -4,6 +4,8 @@ import type { PrepareAndScrapeOptions } from './PrepareAndScrapeOptions';
 /**
  * Prepare pipeline from string (markdown) format to JSON format
  *
+ * @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

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

@@ -25,7 +25,7 @@ export {};
  * TODO: [😂] Adding knowledge should be convert to async high-level abstractions, simmilar 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] !!! Prepare index the examples and maybe tasks
+ * 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

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

@@ -4,6 +4,7 @@ import type { ScraperIntermediateSource } from './ScraperIntermediateSource';
 /**
  * @@@
  *
+ * Note: [🌏] Converters are not usable in browser because they produce a files
  */
 export type Converter = {
     /**

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

@@ -7,7 +7,6 @@ import type { string_url } from '../../types/typeAliases';
 import type { ScraperAndConverterMetadata } from './register/ScraperAndConverterMetadata';
 /**
  * @@@
- *
  */
 export type Scraper = {
     /**
@@ -53,6 +52,7 @@ export type ScraperSourceHandler = {
     asText(): Promisable<string>;
 };
 /**
+ * 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

@@ -9,3 +9,6 @@ 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/typings/src/scrapers/_common/register/ScraperAndConverterMetadata.d.ts

@@ -28,6 +28,8 @@ export type ScraperAndConverterMetadata = Registered & {
     readonly mimeTypes: ReadonlyArray<string_mime_type>;
     /**
      * @@@
+     *
+     * 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;
     /**

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

@@ -5,3 +5,6 @@ import type { PromptbookFetch } from '../../../execution/PromptbookFetch';
  * @private as default `fetch` function used in Promptbook scrapers
  */
 export declare const scraperFetch: PromptbookFetch;
+/**
+ * TODO: [🧠] Maybe rename because it is not used only for scrapers but also in `$getCompiledBook`
+ */

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

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
  *
  * @public exported from `@promptbook/documents`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _DocumentScraperRegistration: Registration;

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

@@ -19,6 +19,7 @@ export declare const documentScraperMetadata: import("type-fest/source/readonly-
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
  *
  * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _DocumentScraperMetadataRegistration: Registration;

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

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
  *
  * @public exported from `@promptbook/legacy-documents`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _LegacyDocumentScraperRegistration: Registration;

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

@@ -19,6 +19,7 @@ export declare const legacyDocumentScraperMetadata: import("type-fest/source/rea
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
  *
  * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _LegacyDocumentScraperMetadataRegistration: Registration;

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

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
  *
  * @public exported from `@promptbook/markdown-utils`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _MarkdownScraperRegistration: Registration;

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

@@ -19,6 +19,7 @@ export declare const markdownScraperMetadata: import("type-fest/source/readonly-
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
  *
  * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _MarkdownScraperMetadataRegistration: Registration;

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

@@ -37,4 +37,5 @@ export declare class PdfScraper implements Converter, Scraper {
  * 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/typings/src/scrapers/pdf/createPdfScraper.d.ts

@@ -12,7 +12,7 @@ export declare const createPdfScraper: ((tools: Pick<ExecutionTools, 'llm'>, opt
     className: string;
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvilableInBrowser: true;
+    isAvilableInBrowser: false;
     requiredExecutables: never[];
 }>;
 /**

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

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
  *
  * @public exported from `@promptbook/pdf`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _PdfScraperRegistration: Registration;

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

@@ -10,7 +10,7 @@ export declare const pdfScraperMetadata: import("type-fest/source/readonly-deep"
     className: string;
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvilableInBrowser: true;
+    isAvilableInBrowser: false;
     requiredExecutables: never[];
 }>;
 /**
@@ -19,6 +19,7 @@ export declare const pdfScraperMetadata: import("type-fest/source/readonly-deep"
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
  *
  * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _PdfScraperMetadataRegistration: Registration;

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

@@ -12,7 +12,9 @@ export declare const createWebsiteScraper: ((tools: Pick<ExecutionTools, 'llm'>,
     className: string;
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvilableInBrowser: false;
+    isAvilableInBrowser: false; /**
+     * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+     */
     requiredExecutables: never[];
 }>;
 /**

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

@@ -5,6 +5,7 @@ import type { Registration } from '../../utils/$Register';
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
  *
  * @public exported from `@promptbook/website-crawler`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _WebsiteScraperRegistration: Registration;

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

@@ -19,6 +19,7 @@ export declare const websiteScraperMetadata: import("type-fest/source/readonly-d
  * Warning: This is not useful for the end user, it is just a side effect of the mechanism that handles all available known scrapers
  *
  * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/wizzard`
  * @public exported from `@promptbook/cli`
  */
 export declare const _WebsiteScraperMetadataRegistration: Registration;

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

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

package/esm/typings/src/scripting/javascript/utils/preserve.d.ts

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

package/esm/typings/src/types/typeAliases.d.ts

@@ -319,6 +319,12 @@ export type string_url = string;
  * For example `"https://collboard.com"`
  */
 export type string_base_url = string;
+/**
+ * Semantic helper
+ *
+ * For example `"https://promptbook.studio/webgpt/"`
+ */
+export type string_pipeline_root_url = string;
 /**
  * Semantic helper
  *
@@ -623,8 +629,8 @@ export type number_megabytes = number_positive;
 export type number_gigabytes = number_positive;
 export type number_terabytes = number_positive;
 /**.
- * TODO: [main] !!! Change "For example" to @example
- * TODO: !! Change to branded types
+ * TODO: [main] !!3 Change "For example" to @example
+ * TODO: Change to branded types
  * TODO: Delete type aliases that are not exported or used internally
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */

package/esm/typings/src/utils/markdown/flattenMarkdown.d.ts

@@ -2,7 +2,7 @@ import type { string_markdown } from '../../types/typeAliases';
 /**
  * Normalizes the markdown by flattening the structure
  *
- * - It always have h1 - if there is no h1 in the markdown, it will be added "# Untitled"
+ * - It always have h1 - if there is no h1 in the markdown, it will be added `DEFAULT_BOOK_TITLE`
  * - All other headings are normalized to h2
  *
  * @public exported from `@promptbook/markdown-utils`

package/esm/typings/src/utils/markdown/{removeContentComments.d.ts → removeMarkdownComments.d.ts}

@@ -1,10 +1,10 @@
 import type { string_html } from '../../types/typeAliases';
 import type { string_markdown } from '../../types/typeAliases';
 /**
- * Removes HTML or Markdown comments from a string.
+ * Removes Markdown (or HTML) comments
  *
  * @param {string} content - The string to remove comments from.
  * @returns {string} The input string with all comments removed.
  * @public exported from `@promptbook/markdown-utils`
  */
-export declare function removeContentComments<TContent extends string_html | string_markdown>(content: TContent): TContent;
+export declare function removeMarkdownComments<TContent extends string_html | string_markdown>(content: TContent): TContent;

package/esm/typings/src/utils/organization/$sideEffect.d.ts

@@ -0,0 +1,9 @@
+import type { really_any } from './really_any';
+/**
+ * Just says that the variable is not used directlys but should be kept because the existence of the variable is important
+ *
+ * @param value any values
+ * @returns void
+ * @private within the repository
+ */
+export declare function $sideEffect(...sideEffectSubjects: ReadonlyArray<really_any>): void;

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

@@ -40,6 +40,6 @@ export type CheckSerializableAsJsonOptions = {
 export declare function checkSerializableAsJson(options: CheckSerializableAsJsonOptions): void;
 /**
  * TODO: Can be return type more type-safe? like `asserts options.value is JsonValue`
- * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
+ * TODO: [🧠][main] !!3 In-memory cache of same values to prevent multiple checks
  * Note: [🐠] This is how `checkSerializableAsJson` + `isSerializableAsJson` together can just retun true/false or rich error message
  */

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

@@ -1,4 +1,4 @@
-import { JsonValue } from 'type-fest';
+import type { JsonValue } from 'type-fest';
 /**
  * Tests if the value is [🚉] serializable as JSON
  *
@@ -20,6 +20,6 @@ import { JsonValue } from 'type-fest';
  */
 export declare function isSerializableAsJson(value: unknown): value is JsonValue;
 /**
- * TODO: [🧠][main] !!! In-memory cache of same values to prevent multiple checks
+ * TODO: [🧠][main] !!3 In-memory cache of same values to prevent multiple checks
  * TODO: [🧠][💺] Can be done this on type-level?
  */

package/esm/typings/src/utils/validators/filePath/isRootPath.d.ts

@@ -0,0 +1,12 @@
+import type { string_dirname } from '../../../types/typeAliases';
+import type { string_filename } from '../../../types/typeAliases';
+/**
+ * Determines if the given path is a root path.
+ *
+ * Note: This does not check if the file exists only if the path is valid
+ * @public exported from `@promptbook/utils`
+ */
+export declare function isRootPath(value: string_dirname | string_filename): boolean;
+/**
+ * TODO: [🍏] Make for MacOS paths
+ */

package/esm/typings/src/utils/validators/filePath/isRootPath.test.d.ts

@@ -0,0 +1,4 @@
+export {};
+/**
+ * TODO: [🍏] Make for MacOS paths
+ */

package/esm/typings/src/utils/validators/filePath/isValidFilePath.d.ts

@@ -7,3 +7,6 @@ import type { really_unknown } from '../../organization/really_unknown';
  * @public exported from `@promptbook/utils`
  */
 export declare function isValidFilePath(filename: really_unknown): filename is string_filename;
+/**
+ * TODO: [🍏] Implement for MacOs
+ */

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

@@ -0,0 +1,16 @@
+import type { ExecutionTools } from '../execution/ExecutionTools';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../pipeline/PipelineString';
+import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions';
+import type { string_filename } from '../types/typeAliases';
+import type { string_pipeline_url } from '../types/typeAliases';
+/**
+ * @see ./wizzard.ts `getPipeline` method
+ *
+ * @private usable through `ptbk run` and `@prompbook/wizzard`
+ */
+export declare function $getCompiledBook(tools: Required<Pick<ExecutionTools, 'fs' | 'fetch'>>, pipelineSource: string_filename | string_pipeline_url | PipelineString, options?: PrepareAndScrapeOptions): Promise<PipelineJson>;
+/**
+ * TODO: Write unit test
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */