@promptbook/vercel 0.76.0

package/esm/typings/src/utils/emojis.d.ts

@@ -0,0 +1,24 @@
+import type { string_char_emoji } from '../types/typeAliasEmoji';
+/**
+ * All possible emoji chars like "🍆", "🍡", "🍤"...
+ * Note: this will be needed to update annually - now updated at 2022-01-19
+ *
+ * @see https://getemoji.com/
+ *
+ * @private within the repository
+ * @deprecated Use /\p{Extended_Pictographic}/ instead
+ */
+export declare const EMOJIS_IN_CATEGORIES: Record<string, ReadonlyArray<string_char_emoji>>;
+/**
+ *
+ * All possible emoji chars like "🍆", "🍡", "🍤"...
+ *
+ * @private within the repository
+ * @deprecated Use /\p{Extended_Pictographic}/ instead
+ */
+export declare const EMOJIS: Set<string_char_emoji>;
+/**
+ * TODO: [💴] DRY - just one version of emojis.ts
+ * TODO: Mirror from Collboard or some common package
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/utils/environment/$getGlobalScope.d.ts

@@ -0,0 +1,9 @@
+import type { really_any } from '../organization/really_any';
+/**
+ * @@@
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it access global scope
+ *
+ *  @private internal function of `$Register`
+ */
+export declare function $getGlobalScope(): really_any;

package/esm/typings/src/utils/environment/$isRunningInBrowser.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Detects if the code is running in a browser environment in main thread (Not in a web worker)
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it looks at the global object to determine the environment
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const $isRunningInBrowser: Function;

package/esm/typings/src/utils/environment/$isRunningInNode.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Detects if the code is running in a Node.js environment
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it looks at the global object to determine the environment
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const $isRunningInNode: Function;

package/esm/typings/src/utils/environment/$isRunningInWebWorker.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Detects if the code is running in a web worker
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it looks at the global object to determine the environment
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const $isRunningInWebWorker: Function;

package/esm/typings/src/utils/execCommand/$execCommand.d.ts

@@ -0,0 +1,16 @@
+import type { ExecCommandOptions } from './ExecCommandOptions';
+/**
+ * Run one command in a shell
+ *
+ *
+ * Note: There are 2 similar functions in the codebase:
+ * - `$execCommand` which runs a single command
+ * - `$execCommands` which runs multiple commands
+ * Note: `$` is used to indicate that this function is not a pure function - it runs a command in a shell
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare function $execCommand(options: ExecCommandOptions): Promise<string>;
+/**
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/utils/execCommand/$execCommandNormalizeOptions.d.ts

@@ -0,0 +1,12 @@
+import type { ExecCommandOptions } from './ExecCommandOptions';
+import type { ExecCommandOptionsAdvanced } from './ExecCommandOptions';
+/**
+ * Normalize options for `execCommand` and `execCommands`
+ *
+ * Note: `$` is used to indicate that this function behaves differently according to `process.platform`
+ *
+ * @private internal utility of `execCommand` and `execCommands`
+ */
+export declare function $execCommandNormalizeOptions(options: ExecCommandOptions): Pick<ExecCommandOptionsAdvanced, 'command' | 'args' | 'cwd' | 'crashOnError' | 'timeout' | 'isVerbose'> & {
+    humanReadableCommand: string;
+};

package/esm/typings/src/utils/execCommand/$execCommands.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Run multiple commands in a shell in sequence
+ *
+ * Note: There are 2 similar functions in the codebase:
+ * - `$execCommand` which runs a single command
+ * - `$execCommands` which runs multiple commands
+ * Note: `$` is used to indicate that this function is not a pure function - it runs a commands in a shell
+ *
+ * @public exported from `@promptbook/node`
+ */
+export declare function $execCommands({ commands, cwd, crashOnError, }: {
+    readonly commands: string[];
+    readonly cwd: string;
+    readonly crashOnError?: boolean;
+}): Promise<void>;
+/**
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/esm/typings/src/utils/execCommand/ExecCommandOptions.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @deprecated Use sth from type-fest or move this to type helpers
+ */
+type RequiredAndOptional<TBase, TRequired extends keyof TBase, TOptional extends keyof TBase> = Pick<TBase, TRequired> & Partial<Pick<TBase, TOptional>>;
+/**
+ * Simple options for `execCommand`
+ */
+export type ExecCommandOptions = string | RequiredAndOptional<ExecCommandOptionsAdvanced, 'command', 'args' | 'cwd' | 'crashOnError' | 'timeout' | 'isVerbose'>;
+/**
+ * Advanced options for `execCommand`
+ */
+export type ExecCommandOptionsAdvanced = {
+    /**
+     * Command to run
+     */
+    readonly command: string;
+    /**
+     * Arguments for the command
+     */
+    readonly args: string[];
+    /**
+     * Current working directory
+     *
+     * @default process.cwd()
+     */
+    readonly cwd: string;
+    /**
+     * If `true` then the command will throw an error if the return code is not `0`
+     */
+    readonly crashOnError: boolean;
+    /**
+     * Timeout in milliseconds
+     */
+    readonly timeout: number;
+    /**
+     * If `true` then the command and entire CLI output will be logged to the console
+     *
+     * @default false
+     */
+    readonly isVerbose?: boolean;
+};
+export {};
+/**
+ * TODO: [⏳] Make DEFAULT_TIMEOUT_MS as global constant
+ */

package/esm/typings/src/utils/execCommand/execCommand.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/utils/execCommand/execCommandNormalizeOptions.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,16 @@
+/**
+ * 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;
+/**
+ * TODO: [🧠] Should be this `constants.ts` or `config.ts`?
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

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

@@ -0,0 +1,7 @@
+import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations';
+/**
+ * Counts number of characters in the text
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function countCharacters(text: string): ExpectationAmount;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,9 @@
+import type { ExpectationAmount } from '../../pipeline/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/countLines.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,9 @@
+import type { ExpectationAmount } from '../../pipeline/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/esm/typings/src/utils/expectation-counters/countPages.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,7 @@
+import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations';
+/**
+ * Counts number of paragraphs in the text
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function countParagraphs(text: string): ExpectationAmount;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,13 @@
+import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations';
+/**
+ * Split text into sentences
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function splitIntoSentences(text: string): ReadonlyArray<string>;
+/**
+ * Counts number of sentences in the text
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function countSentences(text: string): ExpectationAmount;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,7 @@
+import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations';
+/**
+ * Counts number of words in the text
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function countWords(text: string): ExpectationAmount;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,12 @@
+import type { ExpectationAmount } from '../../pipeline/PipelineJson/Expectations';
+import type { ExpectationUnit } from '../../pipeline/PipelineJson/Expectations';
+/**
+ * Index of all counter functions
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare const CountUtils: Record<ExpectationUnit, (text: string) => ExpectationAmount>;
+/**
+ * TODO: [🧠][🤠] This should be probbably as part of `TextFormatDefinition`
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/utils/files/extensionToMimeType.d.ts

@@ -0,0 +1,8 @@
+import type { string_file_extension } from '../../types/typeAliases';
+import type { string_mime_type } from '../../types/typeAliases';
+/**
+ * Convert file extension to mime type
+ *
+ * @private within the repository
+ */
+export declare function extensionToMimeType(value: string_file_extension): string_mime_type;

package/esm/typings/src/utils/files/extensionToMimeType.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/utils/files/getFileExtension.d.ts

@@ -0,0 +1,8 @@
+import type { string_filename } from '../../types/typeAliases';
+import type { string_mime_type } from '../../types/typeAliases';
+/**
+ * Get the file extension from a file name
+ *
+ * @private within the repository
+ */
+export declare function getFileExtension(value: string_filename): string_mime_type | null;

package/esm/typings/src/utils/files/getFileExtension.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/utils/files/isDirectoryExisting.d.ts

@@ -0,0 +1,14 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+import type { string_dirname } from '../../types/typeAliases';
+/**
+ * Checks if the directory exists
+ *
+ * @private within the repository
+ */
+export declare function isDirectoryExisting(directoryPath: string_dirname, fs: FilesystemTools): Promise<boolean>;
+/**
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
+ * TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
+ * TODO: [🧠][📂] "directory" vs "folder"
+ * TODO: [🖇] What about symlinks?
+ */

package/esm/typings/src/utils/files/isDirectoryExisting.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/utils/files/isExecutable.d.ts

@@ -0,0 +1,11 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+/**
+ * Checks if the file is executable
+ *
+ * @private within the repository
+ */
+export declare function isExecutable(path: string, fs: FilesystemTools): Promise<boolean>;
+/**
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
+ * TODO: [🖇] What about symlinks?
+ */

package/esm/typings/src/utils/files/isFileExisting.d.ts

@@ -0,0 +1,13 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+import type { string_filename } from '../../types/typeAliases';
+/**
+ * Checks if the file exists
+ *
+ * @private within the repository
+ */
+export declare function isFileExisting(filename: string_filename, fs: FilesystemTools): Promise<boolean>;
+/**
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
+ * TODO: [🐠] This can be a validator - with variants that return true/false and variants that throw errors with meaningless messages
+ * TODO: [🖇] What about symlinks?
+ */

package/esm/typings/src/utils/files/isFileExisting.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/utils/files/listAllFiles.d.ts

@@ -0,0 +1,17 @@
+import type { FilesystemTools } from '../../execution/FilesystemTools';
+import type { string_dirname } from '../../types/typeAliases';
+import type { string_filename } from '../../types/typeAliases';
+/**
+ * Reads all files in the directory
+ *
+ * @param path
+ * @param isRecursive
+ * @returns List of all files in the directory
+ * @private internal function of `createCollectionFromDirectory`
+ */
+export declare function listAllFiles(path: string_dirname, isRecursive: boolean, fs: FilesystemTools): Promise<Array<string_filename>>;
+/**
+ * TODO: [😶] Unite floder listing
+ * Note: Not [~🟢~] because it is not directly dependent on `fs
+ * TODO: [🖇] What about symlinks?
+ */

package/esm/typings/src/utils/files/listAllFiles.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/utils/formatNumber.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Format either small or big number
+ *
+ * @private within the repository
+ */
+export declare function formatNumber(value: number): string;

package/esm/typings/src/utils/formatNumber.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/utils/getCurrentIsoDate.d.ts

@@ -0,0 +1,7 @@
+import type { string_date_iso8601 } from '../types/typeAliases';
+/**
+ * Get current date in ISO 8601 format
+ *
+ * @private internal utility
+ */
+export declare function getCurrentIsoDate(): string_date_iso8601;

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

@@ -0,0 +1,14 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_name } from '../../types/typeAliases';
+/**
+ * Add or modify an auto-generated section in a markdown file
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function addAutoGeneratedSection(content: string_markdown, options: {
+    readonly sectionName: string_name;
+    readonly sectionContent: string_markdown;
+}): string_markdown;
+/**
+ * TODO: [🏛] This can be part of markdown builder
+ */

package/esm/typings/src/utils/markdown/addAutoGeneratedSection.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,38 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { FromtoItems } from '../FromtoItems';
+/**
+ * Options for `CreateMarkdownChartOptions`
+ */
+type CreateMarkdownChartOptions = {
+    /**
+     * The header for the first column - the name of the item
+     */
+    readonly nameHeader: string;
+    /**
+     * The header for the second column - the value of the item
+     */
+    readonly valueHeader: string;
+    /**
+     * The items to be charted
+     */
+    readonly items: FromtoItems;
+    /**
+     * The width of the chart in squares
+     */
+    readonly width: number;
+    /**
+     * The name of the unit shown in the chart
+     */
+    readonly unitName: string;
+};
+/**
+ * Function createMarkdownChart will draw a chart in markdown from ⬛+🟦 tiles
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function createMarkdownChart(options: CreateMarkdownChartOptions): string_markdown;
+export {};
+/**
+ * TODO: Maybe use Mermain Gant Diagrams
+ *       @see https://jojozhuang.github.io/tutorial/mermaid-cheat-sheet/
+ */

package/esm/typings/src/utils/markdown/createMarkdownChart.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,11 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+/**
+ * Create a markdown table from a 2D array of strings
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function createMarkdownTable(table: Array<Array<string_markdown_text>>): string_markdown;
+/**
+ * TODO: [🏛] This can be part of markdown builder
+ */

package/esm/typings/src/utils/markdown/createMarkdownTable.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,11 @@
+import type { string_markdown_text } from '../../types/typeAliases';
+/**
+ * Function escapeMarkdownBlock will escape markdown block if needed
+ * It is useful when you want have block in block
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function escapeMarkdownBlock(value: string_markdown_text): string_markdown_text;
+/**
+ * TODO: [🏛] This can be part of markdown builder
+ */

package/esm/typings/src/utils/markdown/escapeMarkdownBlock.test.d.ts

@@ -0,0 +1 @@
+export {};

package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown-real.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,36 @@
+import type { string_markdown } from '../../types/typeAliases';
+/**
+ * Single code block inside markdown.
+ */
+export type CodeBlock = {
+    /**
+     * Which notation was used to open the code block
+     */
+    readonly blockNotation: '```' | '>';
+    /**
+     * Language of the code block OR null if the language is not specified in opening ```
+     */
+    readonly language: string | null;
+    /**
+     * Content of the code block (unescaped)
+     */
+    readonly content: string;
+};
+/**
+ * Extracts all code blocks from markdown.
+ *
+ * Note: There are multiple simmilar function:
+ * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
+ * - `extractJsonBlock` extracts exactly one valid JSON code block
+ * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
+ * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
+ *
+ * @param markdown any valid markdown
+ * @returns code blocks with language and content
+ * @throws {ParseError} if block is not closed properly
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function extractAllBlocksFromMarkdown(markdown: string_markdown): ReadonlyArray<CodeBlock>;
+/**
+ * TODO: Maybe name for `blockNotation` instead of  '```' and '>'
+ */

package/esm/typings/src/utils/markdown/extractAllBlocksFromMarkdown.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,15 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+/**
+ * Utility function to extract all list items from markdown
+ *
+ * Note: It works with both ul and ol
+ * Note: It omits list items in code blocks
+ * Note: It flattens nested lists
+ * Note: It can not work with html syntax and comments
+ *
+ * @param markdown any valid markdown
+ * @returns @@@
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function extractAllListItemsFromMarkdown(markdown: string_markdown): string_markdown_text[];

package/esm/typings/src/utils/markdown/extractAllListItemsFromMarkdown.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,22 @@
+import type { string_markdown } from '../../types/typeAliases';
+import type { CodeBlock } from './extractAllBlocksFromMarkdown';
+/**
+ * Extracts exactly ONE code block from markdown.
+ *
+ * - When there are multiple or no code blocks the function throws a `ParseError`
+ *
+ * Note: There are multiple simmilar function:
+ * - `extractBlock` just extracts the content of the code block which is also used as build-in function for postprocessing
+ * - `extractJsonBlock` extracts exactly one valid JSON code block
+ * - `extractOneBlockFromMarkdown` extracts exactly one code block with language of the code block
+ * - `extractAllBlocksFromMarkdown` extracts all code blocks with language of the code block
+ *
+ * @param markdown any valid markdown
+ * @returns code block with language and content
+ * @public exported from `@promptbook/markdown-utils`
+ * @throws {ParseError} if there is not exactly one code block in the markdown
+ */
+export declare function extractOneBlockFromMarkdown(markdown: string_markdown): CodeBlock;
+/***
+ * TODO: [🍓][🌻] Decide of this is internal utility, external util OR validator/postprocessor
+ */

package/esm/typings/src/utils/markdown/extractOneBlockFromMarkdown.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,17 @@
+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"
+ * - All other headings are normalized to h2
+ *
+ * @public exported from `@promptbook/markdown-utils`
+ */
+export declare function flattenMarkdown<TContent extends string_markdown>(markdown: TContent): TContent;
+/**
+ * TODO: [🏛] This can be part of markdown builder
+ * Note: [🕞] In past (commit 42086e1603cbed506482997c00a8ee979af0a247) there was much more
+ *       sophisticated implementation of this function through parsing markdown into JSON structure
+ *       and flattening the actual structure
+ *       NOW we are working just with markdown string and its good enough
+ */

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

@@ -0,0 +1 @@
+export {};