@promptbook/markdown-utils 0.81.0-9 → 0.82.0-0

package/esm/typings/src/{llm-providers/remote → remote-server}/interfaces/RemoteServerOptions.d.ts

@@ -1,10 +1,10 @@
 import type { Promisable } from 'type-fest';
-import type { PipelineCollection } from '../../../collection/PipelineCollection';
-import type { CommonToolsOptions } from '../../../execution/CommonToolsOptions';
-import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
-import type { string_app_id } from '../../../types/typeAliases';
-import type { string_uri } from '../../../types/typeAliases';
-import type { string_user_id } from '../../../types/typeAliases';
+import type { PipelineCollection } from '../../collection/PipelineCollection';
+import type { CommonToolsOptions } from '../../execution/CommonToolsOptions';
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { string_app_id } from '../../types/typeAliases';
+import type { string_uri } from '../../types/typeAliases';
+import type { string_user_id } from '../../types/typeAliases';
 /**
  * @@@
  *
@@ -31,14 +31,14 @@ export type RemoteServerOptions<TCustomOptions> = CommonToolsOptions & {
      * @example '/promptbook/socket.io'
      */
     readonly path: string_uri;
-} & (AnonymousRemoteServerOptions | CollectionRemoteServerOptions<TCustomOptions> | (AnonymousRemoteServerOptions & CollectionRemoteServerOptions<TCustomOptions>));
+} & (AnonymousRemoteServerOptions | ApplicationRemoteServerOptions<TCustomOptions> | (AnonymousRemoteServerOptions & ApplicationRemoteServerOptions<TCustomOptions>));
 export type AnonymousRemoteServerOptions = {
     /**
      * Enable anonymous mode
      */
     readonly isAnonymousModeAllowed: true;
 };
-export type CollectionRemoteServerOptions<TCustomOptions> = {
+export type ApplicationRemoteServerOptions<TCustomOptions> = {
     /**
      * Enable application mode
      */
@@ -52,9 +52,9 @@ export type CollectionRemoteServerOptions<TCustomOptions> = {
     /**
      * Creates llm execution tools for each client
      */
-    createLlmExecutionTools(options: CollectionRemoteServerClientOptions<TCustomOptions>): Promisable<LlmExecutionTools>;
+    createLlmExecutionTools(options: ApplicationRemoteServerClientOptions<TCustomOptions>): Promisable<LlmExecutionTools>;
 };
-export type CollectionRemoteServerClientOptions<TCustomOptions> = {
+export type ApplicationRemoteServerClientOptions<TCustomOptions> = {
     /**
      * @@@
      */

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
+ */

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

@@ -1,19 +1,63 @@
 import { Promisable } from 'type-fest';
+import type { ExecutionTools } from '../execution/ExecutionTools';
 import type { PipelineExecutorResult } from '../execution/PipelineExecutorResult';
+import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
+import type { PipelineString } from '../pipeline/PipelineString';
 import type { TaskProgress } from '../types/TaskProgress';
 import type { InputParameters } from '../types/typeAliases';
+import type { string_filename } from '../types/typeAliases';
 import type { string_pipeline_url } from '../types/typeAliases';
 /**
- * @@@
+ * Wizzard for simple usage of the Promptbook
+ * Look at `wizzard` for more details
  *
- * @public exported from `@promptbook/node`
+ * Note: This works only in Node.js environment and looks for the configuration, environment, tools and cache in the Node.js environment
+ *
+ * @private just for single instance
  */
-export declare const wizzard: {
+declare class Wizzard {
+    /**
+     * Run the book
+     *
+     * It can be loaded from:
+     * 1) As a file ./books/write-cv.book.md
+     * 2) As a URL https://promptbook.studio/hejny/write-cv.book.md found in ./books folder recursively
+     * 2) As a URL https://promptbook.studio/hejny/write-cv.book.md fetched from the internet
+     * 3) As a string
+     *
+     * Note: This works simmilar to the `ptbk run` command
+     */
+    execute(book: string_pipeline_url | string_filename | PipelineString, inputParameters: InputParameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
+    private executionTools;
+    /**
+     * Provides the tools automatically for the Node.js environment
+     *
+     * @param pipelineSource
+     */
+    getExecutionTools(): Promise<Required<Pick<ExecutionTools, 'fs' | 'fetch'>>>;
     /**
-     * @@@!!!!!!
+     * Load book from the source
+     *
+     * Pipelines can be loaded from:
+     * 1) As a file ./books/write-cv.book.md
+     * 2) As a URL https://promptbook.studio/hejny/write-cv.book.md found in ./books folder recursively
+     * 2) As a URL https://promptbook.studio/hejny/write-cv.book.md fetched from the internet
+     * 3) As a string
+     *
+     * @param pipelineSource
      */
-    execute(book: string_pipeline_url, inputParameters: InputParameters, onProgress?: ((taskProgress: TaskProgress) => Promisable<void>) | undefined): Promise<PipelineExecutorResult>;
-};
+    getCompiledBook(pipelineSource: string_filename | string_pipeline_url | PipelineString): Promise<PipelineJson>;
+}
+/**
+ * Wizzard for simple usage of the Promptbook
+ *
+ * Note: This works only in Node.js environment and looks for the configuration, environment, tools and cache in the Node.js environment
+ *
+ * @singleton
+ * @public exported from `@promptbook/wizzard`
+ */
+export declare const wizzard: Wizzard;
+export {};
 /**
- * TODO: !!!!!! Add to readmes - one markdown here imported in all packages
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/markdown-utils",
-    "version": "0.81.0-9",
+    "version": "0.82.0-0",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,