@promptbook/markdown-utils 0.74.0-7 → 0.74.0

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

@@ -7,6 +7,7 @@ import { createSubcollection } from '../collection/constructors/createSubcollect
 import type { TemplateType } from '../commands/TEMPLATE/TemplateTypes';
 import { TemplateTypes } from '../commands/TEMPLATE/TemplateTypes';
 import { CLAIM } from '../config';
+import { DEFAULT_TITLE } from '../config';
 import { MAX_FILENAME_LENGTH } from '../config';
 import { DEFAULT_INTERMEDIATE_FILES_STRATEGY } from '../config';
 import { DEFAULT_MAX_PARALLEL_COUNT } from '../config';
@@ -84,8 +85,9 @@ import { _DocumentScraperMetadataRegistration } from '../scrapers/document/regis
 import { _MarkdownScraperMetadataRegistration } from '../scrapers/markdown/register-metadata';
 import { _PdfScraperMetadataRegistration } from '../scrapers/pdf/register-metadata';
 import { _WebsiteScraperMetadataRegistration } from '../scrapers/website/register-metadata';
+import { BlackholeStorage } from '../storage/blackhole/BlackholeStorage';
 import { MemoryStorage } from '../storage/memory/MemoryStorage';
-import { PrefixStorage } from '../storage/memory/utils/PrefixStorage';
+import { PrefixStorage } from '../storage/utils/PrefixStorage';
 import { executionReportJsonToString } from '../types/execution-report/executionReportJsonToString';
 import type { ExecutionReportStringOptions } from '../types/execution-report/ExecutionReportStringOptions';
 import { ExecutionReportStringOptionsDefaults } from '../types/execution-report/ExecutionReportStringOptions';
@@ -100,6 +102,7 @@ export { createSubcollection };
 export type { TemplateType };
 export { TemplateTypes };
 export { CLAIM };
+export { DEFAULT_TITLE };
 export { MAX_FILENAME_LENGTH };
 export { DEFAULT_INTERMEDIATE_FILES_STRATEGY };
 export { DEFAULT_MAX_PARALLEL_COUNT };
@@ -177,6 +180,7 @@ export { _DocumentScraperMetadataRegistration };
 export { _MarkdownScraperMetadataRegistration };
 export { _PdfScraperMetadataRegistration };
 export { _WebsiteScraperMetadataRegistration };
+export { BlackholeStorage };
 export { MemoryStorage };
 export { PrefixStorage };
 export { executionReportJsonToString };

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

@@ -12,6 +12,8 @@ import { $currentDate } from '../utils/$currentDate';
 import { $isRunningInBrowser } from '../utils/environment/$isRunningInBrowser';
 import { $isRunningInNode } from '../utils/environment/$isRunningInNode';
 import { $isRunningInWebWorker } from '../utils/environment/$isRunningInWebWorker';
+import { CHARACTERS_PER_STANDARD_LINE } from '../utils/expectation-counters/config';
+import { LINES_PER_STANDARD_PAGE } from '../utils/expectation-counters/config';
 import { countCharacters } from '../utils/expectation-counters/countCharacters';
 import { countLines } from '../utils/expectation-counters/countLines';
 import { countPages } from '../utils/expectation-counters/countPages';
@@ -83,6 +85,8 @@ export { $currentDate };
 export { $isRunningInBrowser };
 export { $isRunningInNode };
 export { $isRunningInWebWorker };
+export { CHARACTERS_PER_STANDARD_LINE };
+export { LINES_PER_STANDARD_PAGE };
 export { countCharacters };
 export { countLines };
 export { countPages };

package/esm/typings/src/cli/cli-commands/run.d.ts

@@ -6,7 +6,7 @@ import type { Command as Program } from 'commander';
  */
 export declare function initializeRunCommand(program: Program): void;
 /**
- * TODO: !!!!!! Catch and wrap all errors from CLI
+ * TODO: !!!!! Catch and wrap all errors from CLI
  * TODO: [🧠] Pass `maxExecutionAttempts`, `csvSettings`
  * TODO: [🥃][main] !!! Allow `ptbk run` without configuring any llm tools
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`

package/esm/typings/src/cli/main.d.ts

@@ -1,11 +1,14 @@
 import { promptbookCli } from './promptbookCli';
+/**
+ * Note: [🔺] Purpose of this file is to export CLI for production environment
+ */
 /**
  * Hidden utilities which should not be used by external consumers.
  *
  * @public exported from `@promptbook/cli`
  */
 export declare const _CLI: {
-    _initialize: typeof promptbookCli;
+    _initialize_promptbookCli: typeof promptbookCli;
 };
 /**
  * Note: [🟡] Code in this file should never be published outside of `@promptbook/cli`

package/esm/typings/src/cli/promptbookCli.d.ts

@@ -5,7 +5,7 @@
  */
 export declare function promptbookCli(): Promise<void>;
 /**
- * TODO: [🧠] Maybe `run` command the default, instead of `ptbk run ./foo.ptbk.md` -> `ptbk ./foo.ptbk.md`
+ * TODO: [🧠] Maybe `run` command the default, instead of `ptbk run ./foo.book.md` -> `ptbk ./foo.book.md`
  * TODO: [🥠] Do not export, its just for CLI script
  * TODO: [🕌] When more functionalities, rename
  * Note: 11:11

package/esm/typings/src/cli/test/ptbk.d.ts

@@ -1,5 +1,5 @@
 #!/usr/bin/env ts-node
 /**
- * Note: Purpose of this file !!!!!!! vs other place
+ * Note: [🔺] Purpose of this file is to test the CLI in development environment
  */
 import '../../_packages/cli.index.ts';

package/esm/typings/src/collection/collectionToJson.test.d.ts

@@ -1,6 +1,6 @@
 export {};
 /**
- * Note: [🐠] For example here URL https://example.com/pipeline.ptbk.md is not valid
+ * Note: [🐠] For example here URL https://example.com/pipeline.book.md is not valid
  *       because it is on private network BUT its very hard to debug because
  *       there is no error message and false return (the error) happen deep in:
  *       `isValidPipelineUrl` -> `isValidPipelineUrl` -> `isUrlOnPrivateNetwork`

package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts

@@ -5,7 +5,7 @@ import type { PipelineCollection } from '../PipelineCollection';
 /**
  * Options for `createCollectionFromDirectory` function
  *
- * Note: `rootDirname` is not needed because it is the folder in which `.ptbk.md` file is located
+ * Note: `rootDirname` is not needed because it is the folder in which `.book.md` file is located
  *       This is not same as `path` which is the first argument of `createCollectionFromDirectory` - it can be a subfolder
  */
 type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & {

package/esm/typings/src/commands/BOOK_VERSION/BookVersionCommand.d.ts

@@ -7,5 +7,5 @@ import type { string_semantic_version } from '../../types/typeAliases';
  */
 export type BookVersionCommand = {
     readonly type: 'BOOK_VERSION';
-    readonly promptbookVersion: string_semantic_version;
+    readonly bookVersion: string_semantic_version;
 };

package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts

@@ -3,12 +3,12 @@ import type { ForeachCommand } from './ForeachCommand';
 /**
  * Parses the foreach command
  *
- * Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.ptbk.md` file
+ * Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.book.md` file
  *
  * @see `documentationUrl` for more details
  * @private within the commands folder
  */
 export declare const foreachCommandParser: PipelineTemplateCommandParser<ForeachCommand>;
 /**
- * TODO: [🍭] Make .ptbk.md file with examples of the FOREACH with wrong parsing and logic
+ * TODO: [🍭] Make .book.md file with examples of the FOREACH with wrong parsing and logic
  */

package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { BoilerplateCommand } from './BoilerplateCommand';
 /**
  * Parses the boilerplate command
  *
- * Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.ptbk.md` file
+ * Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.book.md` file
  *
  * @see `documentationUrl` for more details
  * @private within the commands folder

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

@@ -14,6 +14,12 @@ export declare const GENERATOR_WARNING = "\u26A0\uFE0F WARNING: This code has be
  * @public exported from `@promptbook/core`
  */
 export declare const CLAIM = "Build responsible, controlled and transparent applications on top of LLM models!";
+/**
+ * When the title is not provided, the default title is used
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare const DEFAULT_TITLE = "Untitled";
 /**
  * Warning message for the generated sections and files files
  *

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

@@ -3,8 +3,8 @@ import type { PipelineString } from '../types/PipelineString';
 /**
  * Converts promptbook in JSON format to string format
  *
- * @param pipelineJson Promptbook in JSON format (.ptbk.json)
- * @returns Promptbook in string format (.ptbk.md)
+ * @param pipelineJson Promptbook in JSON format (.book.json)
+ * @returns Promptbook in string format (.book.md)
  * @public exported from `@promptbook/core`
  */
 export declare function pipelineJsonToString(pipelineJson: PipelineJson): PipelineString;
@@ -13,5 +13,5 @@ export declare function pipelineJsonToString(pipelineJson: PipelineJson): Pipeli
  * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
  * TODO: [🏛] Maybe make some markdown builder
  * TODO: [🏛] Escape all
- * TODO: [🧠] Should be in generated .ptbk.md file GENERATOR_WARNING
+ * TODO: [🧠] Should be in generated .book.md file GENERATOR_WARNING
  */

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

@@ -13,10 +13,10 @@ import type { PipelineString } from '../types/PipelineString';
  * Note: This function does not validate logic of the pipeline only the parsing
  * Note: This function acts as compilation process
  *
- * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
+ * @param pipelineString {Promptbook} in string markdown format (.book.md)
  * @param tools - Tools for the preparation and scraping - if not provided together with `llm`, the preparation will be skipped
  * @param options - Options and tools for the compilation
- * @returns {Promptbook} compiled in JSON format (.ptbk.json)
+ * @returns {Promptbook} compiled in JSON format (.book.json)
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */

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

@@ -11,8 +11,8 @@ import type { PipelineString } from '../types/PipelineString';
  * Note: This function does not validate logic of the pipeline only the parsing
  * Note: This function acts as compilation process
  *
- * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
- * @returns {Promptbook} compiled in JSON format (.ptbk.json)
+ * @param pipelineString {Promptbook} in string markdown format (.book.md)
+ * @returns {Promptbook} compiled in JSON format (.book.json)
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */

package/esm/typings/src/conversion/utils/stringifyPipelineJson.d.ts

@@ -9,7 +9,7 @@ import type { string_json } from '../../types/typeAliases';
  */
 export declare function stringifyPipelineJson<TType>(pipeline: TType): string_json<TType>;
 /**
- * TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.ptbk.md
+ * TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.book.md
  * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
  * TODO: [🧠] Maybe more elegant solution than replacing via regex
  * TODO: [🍙] Make some standard order of json properties

package/esm/typings/src/conversion/validation/_importPipeline.d.ts

@@ -2,7 +2,7 @@ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
 import type { PipelineString } from '../../types/PipelineString';
 import type { string_json } from '../../types/typeAliases';
 /**
- * Import the pipeline.ptbk.md or pipeline.ptbk.json file
+ * Import the pipeline.book.md or pipeline.book.json file
  *
  * Note: Using here custom import to work in jest tests
  * Note: Using sync version is 💩 in the production code, but it's ok here in tests
@@ -10,20 +10,20 @@ import type { string_json } from '../../types/typeAliases';
  * @param path - The path to the file relative to examples/pipelines directory
  * @private internal function of tests
  */
-export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.md`): PipelineString;
-export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.json`): PipelineJson;
+export declare function importPipelineWithoutPreparation(path: `${string}.book.md`): PipelineString;
+export declare function importPipelineWithoutPreparation(path: `${string}.book.json`): PipelineJson;
 /**
- * Import the pipeline.ptbk.json file as parsed JSON
+ * Import the pipeline.book.json file as parsed JSON
  *
  * @private internal function of tests
  */
-export declare function importPipelineJson(path: `${string}.ptbk.json`): PipelineJson;
+export declare function importPipelineJson(path: `${string}.book.json`): PipelineJson;
 /**
- * Import the pipeline.ptbk.json file as string
+ * Import the pipeline.book.json file as string
  *
  * @private internal function of tests
  */
-export declare function importPipelineJsonAsString(path: `${string}.ptbk.json`): string_json<PipelineJson>;
+export declare function importPipelineJsonAsString(path: `${string}.book.json`): string_json<PipelineJson>;
 /**
  * Note: [⚫] Code in this file should never be published in any package
  */

package/esm/typings/src/formats/_common/FormatDefinition.d.ts

@@ -13,7 +13,7 @@ import type { FormatSubvalueDefinition } from './FormatSubvalueDefinition';
  */
 export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSettings extends empty_object, TSchema extends empty_object> = {
     /**
-     * The name of the format used in .ptbk.md files
+     * The name of the format used in .book.md files
      *
      * @example "JSON"
      */

package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts

@@ -9,7 +9,7 @@ import type { empty_object } from '../../utils/organization/empty_object';
  */
 export type FormatSubvalueDefinition<TValue extends string, TSettings extends empty_object> = {
     /**
-     * The name of the format used in .ptbk.md files
+     * The name of the format used in .book.md files
      *
      * @example "CELL"
      */

package/esm/typings/src/storage/blackhole/BlackholeStorage.d.ts

@@ -0,0 +1,33 @@
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
+/**
+ * Behaves like a storage but forgets everything you put in it
+ *
+ * @public exported from `@promptbook/core`
+ */
+export declare class BlackholeStorage<TItem> implements PromptbookStorage<TItem> {
+    /**
+     * Returns the number of key/value pairs currently present in the list associated with the object.
+     */
+    get length(): number;
+    /**
+     * Empties the list associated with the object of all key/value pairs, if there are any.
+     */
+    clear(): void;
+    /**
+     * Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
+     * @param key
+     */
+    getItem(key: string): null;
+    /**
+     * Returns the name of the nth key in the list, or null if n is greater than or equal to the number of key/value pairs in the object.
+     */
+    key(index: number): null;
+    /**
+     * Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.
+     */
+    setItem(key: string, value: TItem): void;
+    /**
+     * Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
+     */
+    removeItem(key: string): void;
+}

package/esm/typings/src/storage/memory/MemoryStorage.d.ts

@@ -1,6 +1,6 @@
 import type { PromptbookStorage } from '../_common/PromptbookStorage';
 /**
- * Stores
+ * Stores data in memory (HEAP)
  *
  * @public exported from `@promptbook/core`
  */

package/esm/typings/src/storage/{memory/utils → utils}/PrefixStorage.d.ts

@@ -1,5 +1,5 @@
 import type { Promisable } from 'type-fest';
-import type { PromptbookStorage } from '../../_common/PromptbookStorage';
+import type { PromptbookStorage } from '../_common/PromptbookStorage';
 /**
  * This class behaves like LocalStorage but separates keys by prefix
  *

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

@@ -26,12 +26,12 @@ export type PipelineJson = {
      * Note: It must be unique across all pipeline collections
      * Note: It must use HTTPs URL
      * Tip: You can do versioning in the URL
-     *      For example: https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md@1.0.0
+     *      For example: https://promptbook.studio/webgpt/write-website-content-cs.book.md@1.0.0
      * Warning: Do not hash part of the URL, hash part is used for identification of the template in the pipeline
      */
     readonly pipelineUrl?: string_pipeline_url;
     /**
-     * Internal helper for tracking the source `.ptbk.md` file of the pipeline
+     * Internal helper for tracking the source `.book.md` file of the pipeline
      */
     readonly sourceFile?: string_filename;
     /**
@@ -40,9 +40,11 @@ export type PipelineJson = {
      */
     readonly title: string_markdown_text;
     /**
-     * Version of the .ptbk.json file
+     * Version of the Book language
+     *
+     * @see https://github.com/webgptorg/book
      */
-    readonly promptbookVersion?: string_semantic_version;
+    readonly bookVersion?: string_semantic_version;
     /**
      * Description of the promptbook
      * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure

package/esm/typings/src/types/PipelineJson/PreparationJson.d.ts

@@ -18,5 +18,5 @@ export type PreparationJson = {
 /**
  * TODO: [🍙] Make some standard order of json properties
  * TODO: Maybe put here used `modelName`
- * TODO: [🍥] When using `date` it changes all examples .ptbk.json files each time so until some more elegant solution omit the time from prepared pipeline
+ * TODO: [🍥] When using `date` it changes all examples .book.json files each time so until some more elegant solution omit the time from prepared pipeline
  */

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

@@ -95,7 +95,7 @@ export type CommonPrompt = {
     /**
      * Unique identifier of the pipeline with specific template name as hash
      *
-     * @example https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md#keywords
+     * @example https://promptbook.studio/webgpt/write-website-content-cs.book.md#keywords
      */
     readonly pipelineUrl?: string_pipeline_url_with_hashtemplate;
     /**

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

@@ -298,13 +298,13 @@ export type string_base_url = string;
 /**
  * Semantic helper
  *
- * For example `"https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md"`
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book.md"`
  */
 export type string_pipeline_url = string;
 /**
  * Semantic helper
  *
- * For example `"https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md#keywords"`
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book.md#keywords"`
  */
 export type string_pipeline_url_with_hashtemplate = string;
 /**

package/esm/typings/src/utils/expectation-counters/config.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Number of characters per standard line with 11pt Arial font size.
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const CHARACTERS_PER_STANDARD_LINE = 63;
+/**
+ * Number of lines per standard A4 page with 11pt Arial font size and standard margins and spacing.
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const LINES_PER_STANDARD_PAGE = 44;

package/esm/typings/src/utils/expectation-counters/countLines.d.ts

@@ -2,6 +2,8 @@ import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
 /**
  * Counts number of lines in the text
  *
+ * Note: This does not check only for the presence of newlines, but also for the length of the standard line.
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function countLines(text: string): ExpectationAmount;

package/esm/typings/src/utils/expectation-counters/countPages.d.ts

@@ -2,6 +2,8 @@ import type { ExpectationAmount } from '../../types/PipelineJson/Expectations';
 /**
  * Counts number of pages in the text
  *
+ * Note: This does not check only for the count of newlines, but also for the length of the standard line and length of the standard page.
+ *
  * @public exported from `@promptbook/utils`
  */
 export declare function countPages(text: string): ExpectationAmount;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/markdown-utils",
-    "version": "0.74.0-7",
+    "version": "0.74.0",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,