@promptbook/markdown-utils 0.81.0-19 → 0.81.0-21

package/esm/typings/books/index.d.ts

@@ -89,5 +89,43 @@ declare const _default: ({
         content: string;
     }[];
     sourceFile: string;
+} | {
+    title: string;
+    pipelineUrl: string;
+    formfactorName: string;
+    parameters: {
+        name: string;
+        description: string;
+        isInput: boolean;
+        isOutput: boolean;
+    }[];
+    tasks: {
+        taskType: string;
+        name: string;
+        title: string;
+        content: string;
+        resultingParameterName: string;
+        expectations: {
+            words: {
+                min: number;
+                max: number;
+            };
+            lines: {
+                min: number;
+                max: number;
+            };
+        };
+        dependentParameterNames: string[];
+    }[];
+    personas: never[];
+    preparations: never[];
+    knowledgeSources: never[];
+    knowledgePieces: never[];
+    sources: {
+        type: string;
+        path: null;
+        content: string;
+    }[];
+    sourceFile: string;
 })[];
 export default _default;

package/esm/typings/src/_packages/core.index.d.ts

@@ -10,7 +10,7 @@ import { ADMIN_GITHUB_NAME } from '../config';
 import { CLAIM } from '../config';
 import { LOGO_LIGHT_SRC } from '../config';
 import { LOGO_DARK_SRC } from '../config';
-import { DEFAULT_TITLE } from '../config';
+import { DEFAULT_BOOK_TITLE } from '../config';
 import { MAX_FILENAME_LENGTH } from '../config';
 import { DEFAULT_INTERMEDIATE_FILES_STRATEGY } from '../config';
 import { DEFAULT_MAX_PARALLEL_COUNT } from '../config';
@@ -31,8 +31,8 @@ import { DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME } from '../config';
 import { ORDER_OF_PIPELINE_JSON } from '../constants';
 import { RESERVED_PARAMETER_NAMES } from '../constants';
 import { compilePipeline } from '../conversion/compilePipeline';
+import { parsePipeline } from '../conversion/parsePipeline';
 import { pipelineJsonToString } from '../conversion/pipelineJsonToString';
-import { precompilePipeline } from '../conversion/precompilePipeline';
 import { prettifyPipelineString } from '../conversion/prettify/prettifyPipelineString';
 import { extractParameterNamesFromTask } from '../conversion/utils/extractParameterNamesFromTask';
 import { validatePipeline } from '../conversion/validation/validatePipeline';
@@ -132,7 +132,7 @@ export { ADMIN_GITHUB_NAME };
 export { CLAIM };
 export { LOGO_LIGHT_SRC };
 export { LOGO_DARK_SRC };
-export { DEFAULT_TITLE };
+export { DEFAULT_BOOK_TITLE };
 export { MAX_FILENAME_LENGTH };
 export { DEFAULT_INTERMEDIATE_FILES_STRATEGY };
 export { DEFAULT_MAX_PARALLEL_COUNT };
@@ -153,8 +153,8 @@ export { DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME };
 export { ORDER_OF_PIPELINE_JSON };
 export { RESERVED_PARAMETER_NAMES };
 export { compilePipeline };
+export { parsePipeline };
 export { pipelineJsonToString };
-export { precompilePipeline };
 export { prettifyPipelineString };
 export { extractParameterNamesFromTask };
 export { validatePipeline };

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

@@ -58,7 +58,7 @@ export declare const LOGO_DARK_SRC: string_url_image;
  *
  * @public exported from `@promptbook/core`
  */
-export declare const DEFAULT_TITLE = "Untitled";
+export declare const DEFAULT_BOOK_TITLE = "\u2728 Untitled Book";
 /**
  * Warning message for the generated sections and files files
  *

package/esm/typings/src/conversion/compilePipeline.d.ts

@@ -5,10 +5,7 @@ import type { PrepareAndScrapeOptions } from '../prepare/PrepareAndScrapeOptions
 /**
  * Compile pipeline from string (markdown) format to JSON format
  *
- * Note: There are 3 similar functions:
- * - `compilePipeline` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
- * - `precompilePipeline` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
- * - `preparePipeline` - just one step in the compilation process
+ * @see https://github.com/webgptorg/promptbook/discussions/196
  *
  * Note: This function does not validate logic of the pipeline only the parsing
  * Note: This function acts as compilation process

package/esm/typings/src/conversion/{precompilePipeline.d.ts → parsePipeline.d.ts}

@@ -5,7 +5,7 @@ import type { PipelineString } from '../pipeline/PipelineString';
  *
  * Note: There are 3 similar functions:
  * - `compilePipeline` **(preferred)** - which propperly compiles the promptbook and use embedding for external knowledge
- * - `precompilePipeline` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
+ * - `parsePipeline` - use only if you need to compile promptbook synchronously and it contains NO external knowledge
  * - `preparePipeline` - just one step in the compilation process
  *
  * Note: This function does not validate logic of the pipeline only the parsing
@@ -16,7 +16,7 @@ import type { PipelineString } from '../pipeline/PipelineString';
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */
-export declare function precompilePipeline(pipelineString: PipelineString): PipelineJson;
+export declare function parsePipeline(pipelineString: PipelineString): PipelineJson;
 /**
  * TODO: [🧠] Maybe more things here can be refactored as high-level abstractions
  * TODO: [main] !!!! Warn if used only sync version

package/esm/typings/src/high-level-abstractions/_common/HighLevelAbstraction.d.ts

@@ -1,6 +1,6 @@
 import type { $PipelineJson } from '../../commands/_common/types/CommandParser';
 /**
- * Used in `precompilePipeline`
+ * Used in `parsePipeline`
  *
  * @private
  */

package/esm/typings/src/high-level-abstractions/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * All high-level abstractions
  *
- * @private internal index of `precompilePipeline` (= used for sync) and `preparePipeline` (= used for async)
+ * @private internal index of `parsePipeline` (= used for sync) and `preparePipeline` (= used for async)
  */
 export declare const HIGH_LEVEL_ABSTRACTIONS: readonly [{
     type: "SYNC";

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

@@ -1,6 +1,6 @@
 import type { PipelineString } from './PipelineString';
 /**
- * Function for notating a pipeline with a book\`...\ notation as template literal
+ * Tag function for notating a pipeline with a book\`...\ notation as template literal
  *
  * @param strings @@@
  * @param values @@@
@@ -9,7 +9,7 @@ import type { PipelineString } from './PipelineString';
  */
 export declare function book(strings: TemplateStringsArray, ...values: Array<string>): PipelineString;
 /**
- * TODO: !!!!!! Use book\`...\ notation instead of as PipelineString
+ * TODO: Use ACRY book\`...\ notation instead of as PipelineString
  * TODO: [🧠][🈴] Where is the best location for this file
  * Note: [💞] Ignore a discrepancy between file name and entity name
  */

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

@@ -2,6 +2,8 @@ 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;

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/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/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-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[];
 }>;
 /**

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

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

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

@@ -10,7 +10,7 @@ export declare const websiteScraperMetadata: import("type-fest/source/readonly-d
     className: string;
     mimeTypes: string[];
     documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
-    isAvilableInBrowser: true;
+    isAvilableInBrowser: false;
     requiredExecutables: never[];
 }>;
 /**

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

@@ -8,36 +8,50 @@ 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
  *
+ * 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
  */
 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, inputParameters: InputParameters, onProgress?: (taskProgress: TaskProgress) => Promisable<void>): Promise<PipelineExecutorResult>;
+    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'>>>;
     /**
-     * TODO: Make standalone function from this exported from node and used here and in `ptbk run`
-     * @@@!!!
+     * Load book from the source
      *
-     * Strategies:
-     * 1) @@@!!!
-     * 2) @@@!!!
+     * 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
      */
     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`
@@ -45,7 +59,5 @@ declare class Wizzard {
 export declare const wizzard: Wizzard;
 export {};
 /**
- * TODO: !!!!!! Mark in jsdoc as non-pure
- * 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-19",
+    "version": "0.81.0-21",
     "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
     "--note-0": "    <- [🐊]",
     "private": false,