@promptbook/markdown-utils 0.114.0-4 → 0.114.0-40

package/umd/src/utils/ascii-art/createAnsiColorCode.d.ts

@@ -0,0 +1,46 @@
+import type { AsciiArtColorDepth } from './convertImageDataToAsciiArt';
+/**
+ * ANSI escape sequence that resets all colors and attributes.
+ *
+ * @private within the repository
+ */
+export declare const ANSI_RESET = "\u001B[0m";
+/**
+ * One opaque 24-bit color which should be written into an ANSI escape sequence.
+ *
+ * @private within the repository
+ */
+export type AnsiRgbColor = {
+    /**
+     * Red channel in the range `[0, 255]`.
+     */
+    readonly red: number;
+    /**
+     * Green channel in the range `[0, 255]`.
+     */
+    readonly green: number;
+    /**
+     * Blue channel in the range `[0, 255]`.
+     */
+    readonly blue: number;
+};
+/**
+ * Creates the ANSI escape code that sets the foreground color of following characters.
+ *
+ * @param color Color painted onto the characters.
+ * @param colorDepth Color depth supported by the target terminal.
+ * @returns ANSI escape sequence.
+ *
+ * @private within the repository
+ */
+export declare function createAnsiForegroundColorCode(color: AnsiRgbColor, colorDepth: AsciiArtColorDepth): string;
+/**
+ * Creates the ANSI escape code that sets the background color of following characters.
+ *
+ * @param color Color painted behind the characters.
+ * @param colorDepth Color depth supported by the target terminal.
+ * @returns ANSI escape sequence.
+ *
+ * @private within the repository
+ */
+export declare function createAnsiBackgroundColorCode(color: AnsiRgbColor, colorDepth: AsciiArtColorDepth): string;

package/umd/src/utils/files/findFilesByGlob.d.ts

@@ -0,0 +1,28 @@
+import { type GlobOptionsWithFileTypesUnset } from 'glob';
+import type { string_filename } from '../../types/string_filename';
+/**
+ * Options of `findFilesByGlob`
+ *
+ * Note: These are the options of `glob` itself, only `ignore` also accepts a readonly array
+ *       @see https://www.npmjs.com/package/glob#options
+ *
+ * @private internal type of `findFilesByGlob`
+ */
+export type FindFilesByGlobOptions = Omit<GlobOptionsWithFileTypesUnset, 'ignore'> & {
+    /**
+     * Glob patterns which are excluded from the result
+     */
+    readonly ignore?: string | ReadonlyArray<string>;
+};
+/**
+ * Finds all filenames matching a glob pattern
+ *
+ * Note: This is the single place where `glob` is used, so that every caller gets the same shape of results
+ *       on every operating system - POSIX separators and a stable order - which `glob` itself does not guarantee
+ *
+ * @param pattern Glob pattern to match, for example `./src/**\/*.ts`
+ * @param options Options passed to `glob`
+ * @returns Matching filenames with `/` separators, sorted alphabetically
+ * @private within the repository
+ */
+export declare function findFilesByGlob(pattern: string, options?: FindFilesByGlobOptions): Promise<Array<string_filename>>;

package/umd/src/utils/misc/debounce.d.ts

@@ -1,7 +1,9 @@
 import type { TODO_any } from '../organization/TODO_any';
 /**
- * Handles debounce.
+ * Creates a debounced function that runs after calls have been quiet for the given delay.
  *
  * @public exported from `@promptbook/utils`
  */
-export declare function debounce<T extends (...args: TODO_any[]) => void>(fn: T, delay: number): (...args: Parameters<T>) => void;
+export declare function debounce<T extends (...args: TODO_any[]) => void>(fn: T, delay: number): ((...args: Parameters<T>) => void) & {
+    cancel: () => void;
+};

package/umd/src/utils/misc/debounce.test.d.ts

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

package/umd/src/utils/misc/emojis.d.ts

@@ -10,9 +10,10 @@ import type { string_char_emoji } from '../../types/typeAliasEmoji';
  */
 export declare const EMOJIS_IN_CATEGORIES: Record<string, ReadonlyArray<string_char_emoji>>;
 /**
- * All possible emoji chars like "🍆", "🍡", "🍤"...
+ * Curated repository catalogue of emoji and legacy pictographic symbols.
  *
- * @deprecated Use /\p{Extended_Pictographic}/ instead
+ * Code that needs to generate a valid Unicode emoji should apply its own validation
+ * to this catalogue rather than assume every entry is an emoji.
  *
  * @private within the repository
  */

package/umd/src/utils/random/$generateBookBoilerplate.test.d.ts

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

package/umd/src/version.d.ts

@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
 export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
 /**
  * Represents the version string of the Promptbook engine.
- * It follows semantic versioning (e.g., `0.114.0-3`).
+ * It follows semantic versioning (e.g., `0.114.0-39`).
  *
  * @generated
  */

package/esm/src/cli/cli-commands/coder/agentCodingFile.d.ts

@@ -1,13 +0,0 @@
-import { string_markdown } from '../../../types/typeAliases';
-/**
- * Relative path to the Promptbook Coder quick-reference file initialized in project roots.
- *
- * @private internal utility of `ptbk coder`
- */
-export declare const AGENT_CODING_FILE_PATH = "AGENT_CODING.md";
-/**
- * Returns the default coder `AGENT_CODING.md` quick-reference content.
- *
- * @private internal utility of `ptbk coder`
- */
-export declare function getDefaultCoderAgentCodingFileContent(): string_markdown;

package/esm/src/cli/cli-commands/common/harness/$askForHarnessInstallationApproval.d.ts

@@ -1,9 +0,0 @@
-/**
- * Asks the user in the terminal whether the harness should be installed or updated right now.
- *
- * Note: `$` is used to indicate that this function is not a pure function - it reads the answer from stdin
- *
- * @returns `true` when the user confirms, `false` when the user declines or the terminal is not interactive
- * @private internal utility of `promptbookCli`
- */
-export declare function $askForHarnessInstallationApproval(question: string): Promise<boolean>;

package/esm/src/cli/cli-commands/common/harness/$installHarness.d.ts

@@ -1,13 +0,0 @@
-import type { HarnessDefinition } from './HarnessDefinition';
-/**
- * Installs or updates one CLI coding harness globally through npm.
- *
- * A failed installation is reported but never aborts the running command, because the harness check
- * is only an assistant - the command itself may still work with a manually managed harness.
- *
- * Note: `$` is used to indicate that this function is not a pure function - it installs a global npm package
- *
- * @returns `true` when the harness has been installed, `false` when the installation failed
- * @private internal utility of `promptbookCli`
- */
-export declare function $installHarness(definition: HarnessDefinition): Promise<boolean>;

package/esm/src/cli/cli-commands/common/harness/extractHarnessVersionFromOutput.d.ts

@@ -1,11 +0,0 @@
-/**
- * Extracts the version from the raw output of a harness `--version` command.
- *
- * Harness CLIs print their version in many shapes, for example `2.1.199 (Claude Code)`,
- * `codex-cli 0.144.4`, `GitHub Copilot CLI 1.0.61.` or after unrelated deprecation warning lines,
- * so the first version-looking token of the first matching line wins.
- *
- * @returns The parsed version or `null` when the output contains no version
- * @private internal utility of `promptbookCli`
- */
-export declare function extractHarnessVersionFromOutput(output: string): string | null;

package/esm/src/cli/cli-commands/common/harness/isHarnessVersionOutdated.d.ts

@@ -1,9 +0,0 @@
-/**
- * Compares the installed harness version with the newest version published to npm.
- *
- * Only the numeric `major.minor.patch` segments are compared and pre-release suffixes are ignored,
- * so a harness installed from a pre-release build of the newest version is not reported as outdated.
- *
- * @private internal utility of `promptbookCli`
- */
-export declare function isHarnessVersionOutdated(installedVersion: string, latestVersion: string): boolean;

package/umd/src/cli/cli-commands/coder/agentCodingFile.d.ts

@@ -1,13 +0,0 @@
-import { string_markdown } from '../../../types/typeAliases';
-/**
- * Relative path to the Promptbook Coder quick-reference file initialized in project roots.
- *
- * @private internal utility of `ptbk coder`
- */
-export declare const AGENT_CODING_FILE_PATH = "AGENT_CODING.md";
-/**
- * Returns the default coder `AGENT_CODING.md` quick-reference content.
- *
- * @private internal utility of `ptbk coder`
- */
-export declare function getDefaultCoderAgentCodingFileContent(): string_markdown;

package/umd/src/cli/cli-commands/common/harness/$askForHarnessInstallationApproval.d.ts

@@ -1,9 +0,0 @@
-/**
- * Asks the user in the terminal whether the harness should be installed or updated right now.
- *
- * Note: `$` is used to indicate that this function is not a pure function - it reads the answer from stdin
- *
- * @returns `true` when the user confirms, `false` when the user declines or the terminal is not interactive
- * @private internal utility of `promptbookCli`
- */
-export declare function $askForHarnessInstallationApproval(question: string): Promise<boolean>;

package/umd/src/cli/cli-commands/common/harness/$installHarness.d.ts

@@ -1,13 +0,0 @@
-import type { HarnessDefinition } from './HarnessDefinition';
-/**
- * Installs or updates one CLI coding harness globally through npm.
- *
- * A failed installation is reported but never aborts the running command, because the harness check
- * is only an assistant - the command itself may still work with a manually managed harness.
- *
- * Note: `$` is used to indicate that this function is not a pure function - it installs a global npm package
- *
- * @returns `true` when the harness has been installed, `false` when the installation failed
- * @private internal utility of `promptbookCli`
- */
-export declare function $installHarness(definition: HarnessDefinition): Promise<boolean>;

package/umd/src/cli/cli-commands/common/harness/extractHarnessVersionFromOutput.d.ts

@@ -1,11 +0,0 @@
-/**
- * Extracts the version from the raw output of a harness `--version` command.
- *
- * Harness CLIs print their version in many shapes, for example `2.1.199 (Claude Code)`,
- * `codex-cli 0.144.4`, `GitHub Copilot CLI 1.0.61.` or after unrelated deprecation warning lines,
- * so the first version-looking token of the first matching line wins.
- *
- * @returns The parsed version or `null` when the output contains no version
- * @private internal utility of `promptbookCli`
- */
-export declare function extractHarnessVersionFromOutput(output: string): string | null;

package/umd/src/cli/cli-commands/common/harness/isHarnessVersionOutdated.d.ts

@@ -1,9 +0,0 @@
-/**
- * Compares the installed harness version with the newest version published to npm.
- *
- * Only the numeric `major.minor.patch` segments are compared and pre-release suffixes are ignored,
- * so a harness installed from a pre-release build of the newest version is not reported as outdated.
- *
- * @private internal utility of `promptbookCli`
- */
-export declare function isHarnessVersionOutdated(installedVersion: string, latestVersion: string): boolean;