@promptbook/javascript 0.111.0-3 → 0.111.0-7

package/umd/src/utils/color/parsers/parseRgbColor.d.ts

@@ -0,0 +1,20 @@
+import type { string_color } from '../../../types/typeAliases';
+import type { ColorChannelSet } from './ColorChannelSet';
+/**
+ * Parses an RGB string into RGBA channel values.
+ *
+ * @param rgb - RGB string such as `rgb(0%, 62%, 86.7%)`.
+ * @returns RGBA channel values.
+ *
+ * @private function of Color
+ */
+export declare function parseRgbColor(rgb: string_color): ColorChannelSet;
+/**
+ * Parses an RGBA string into RGBA channel values.
+ *
+ * @param rgba - RGBA string such as `rgba(0, 158, 221, 0.5)`.
+ * @returns RGBA channel values.
+ *
+ * @private function of Color
+ */
+export declare function parseRgbaColor(rgba: string_color): ColorChannelSet;

package/umd/src/utils/color/utils/areColorsEqual.d.ts

@@ -0,0 +1,14 @@
+import { Color } from '../Color';
+/**
+ * Compares two colors to determine if they are equal based on their RGB values.
+ *
+ * @param color1 - The first color to compare.
+ * @param color2 - The second color to compare.
+ * @returns {boolean} True if the colors are equal, false otherwise.
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare function areColorsEqual(color1: Color, color2: Color): boolean;
+/**
+ * TODO: [🥎] Implement for N colors
+ */

package/umd/src/utils/color/utils/colorDistance.d.ts

@@ -0,0 +1,21 @@
+import { Color } from '../Color';
+/**
+ * Calculates distance between two colors
+ *
+ * @param color1 first color
+ * @param color2 second color
+ *
+ * Note: This function is inefficient. Use colorDistanceSquared instead if possible.
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare function colorDistance(color1: Color, color2: Color): number;
+/**
+ * Calculates distance between two colors without square root
+ *
+ * @param color1 first color
+ * @param color2 second color
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare function colorDistanceSquared(color1: Color, color2: Color): number;

package/umd/src/utils/color/utils/colorHue.d.ts

@@ -0,0 +1,11 @@
+import { Color } from '../Color';
+/**
+ * Calculates hue of the color
+ *
+ * @returns hue in degrees <0-360)
+ *
+ * @see https://en.wikipedia.org/wiki/HSL_and_HSV#Hue_and_chroma
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare function colorHue(color: Color): number;

package/umd/src/utils/color/utils/colorHueDistance.d.ts

@@ -0,0 +1,11 @@
+import { Color } from '../Color';
+/**
+ * Calculates hue distance of two colors
+ *
+ * @returns hue distance in degrees <0-180)
+ *
+ * @see https://en.wikipedia.org/wiki/HSL_and_HSV#Hue_and_chroma
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare function colorHueDistance(color1: Color, color2: Color): number;

package/umd/src/utils/color/utils/colorHueDistance.test.d.ts

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

package/umd/src/utils/color/utils/colorLuminance.d.ts

@@ -0,0 +1,9 @@
+import { Color } from '../Color';
+/**
+ * Calculates luminance of the color
+ *
+ * @see https://en.wikipedia.org/wiki/Relative_luminance
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare function colorLuminance(color: Color): number;

package/umd/src/utils/color/utils/colorSatulightion.d.ts

@@ -0,0 +1,7 @@
+import { Color } from '../Color';
+/**
+ * Calculates saturation*luminance of the color
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare function colorSatulightion(color: Color): number;

package/umd/src/utils/color/utils/colorSaturation.d.ts

@@ -0,0 +1,9 @@
+import { Color } from '../Color';
+/**
+ * Calculates saturation of the color
+ *
+ * @see https://en.wikipedia.org/wiki/HSL_and_HSV#Saturation
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare function colorSaturation(color: Color): number;

package/umd/src/utils/color/utils/colorToDataUrl.d.ts

@@ -0,0 +1,11 @@
+import { string_color, string_data_url, string_url_image } from '../../../types/typeAliases';
+import { Color } from '../Color';
+/**
+ * Makes data url from color
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare function colorToDataUrl(color: Color | string_color): string_data_url & string_url_image;
+/**
+ * TODO: Make as functions NOT const
+ */

package/umd/src/utils/color/utils/mixColors.d.ts

@@ -0,0 +1,11 @@
+import type { WithTake } from '../../take/interfaces/ITakeChain';
+import { Color } from '../Color';
+/**
+ * Mixes an array of colors and returns the average color
+ *
+ * @param {...Color} colors - The array of colors to be mixed.
+ * @returns {WithTake<Color>} - The mixed color.
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare function mixColors(...colors: Array<Color>): WithTake<Color>;

package/umd/src/utils/editable/edit-pipeline-string/addPipelineCommand.d.ts

@@ -0,0 +1,17 @@
+import type { PipelineString } from '../../../pipeline/PipelineString';
+import type { string_markdown_text } from '../../../types/typeAliases';
+type AddPipelineCommandOptions = {
+    commandString: string_markdown_text;
+    pipelineString: PipelineString;
+};
+/**
+ * Adds a new command to a pipeline string in the correct format.
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export declare function addPipelineCommand(options: AddPipelineCommandOptions): PipelineString;
+export {};
+/**
+ * TODO: [🧠] What is the better solution - `- xxx`, - `-   xxx` or preserve (see also next TODO)
+ * TODO: When existing commands 1) as 2) number 3) list, add 4) new command as next number
+ */

package/umd/src/utils/editable/edit-pipeline-string/addPipelineCommand.test.d.ts

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

package/umd/src/utils/editable/edit-pipeline-string/deflatePipeline.d.ts

@@ -0,0 +1,13 @@
+import type { PipelineString } from '../../../pipeline/PipelineString';
+/**
+ * Converts a pipeline structure to its string representation.
+ *
+ * Transforms a flat, simple pipeline into a properly formatted pipeline string
+ * with sections for title, prompt, and return statement.
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export declare function deflatePipeline(pipelineString: PipelineString): PipelineString;
+/**
+ * TODO: Unit test
+ */

package/umd/src/utils/editable/edit-pipeline-string/deflatePipeline.test.d.ts

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

package/umd/src/utils/editable/edit-pipeline-string/removePipelineCommand.d.ts

@@ -0,0 +1,22 @@
+import type { CommandType } from '../../../commands/_common/types/CommandType';
+import type { PipelineString } from '../../../pipeline/PipelineString';
+/**
+ * Options for `removePipelineCommand`
+ */
+type RemovePipelineCommandOptions = {
+    /**
+     * The command you want to remove
+     */
+    command: CommandType;
+    /**
+     * Pipeline you want to remove command from
+     */
+    pipelineString: PipelineString;
+};
+/**
+ * Function `removePipelineCommand` will remove one command from pipeline string
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export declare function removePipelineCommand(options: RemovePipelineCommandOptions): PipelineString;
+export {};

package/umd/src/utils/editable/edit-pipeline-string/removePipelineCommand.test.d.ts

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

package/umd/src/utils/editable/types/PipelineEditableSerialized.d.ts

@@ -0,0 +1,27 @@
+import type { ErrorJson } from '../../../errors/utils/ErrorJson';
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
+import type { string_date_iso8601 } from '../../../types/typeAliases';
+/**
+ * Represents a single pipeline in PromptbookStudio
+ *
+ * This is simple extension of PipelineJson with additional metadata
+ * Note: There are two similar entities:
+ *       1) Type (interface) `PipelineEditableSerialized` which represents just data in database
+ *       2) Class `PipelineEditable` which implements `PipelineEditableSerialized` and adds error handling and editing capabilities
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export type PipelineEditableSerialized = PipelineJson & {
+    /**
+     * When was the pipeline created
+     */
+    readonly createdAt: string_date_iso8601;
+    /**
+     * When was the pipeline last modified
+     */
+    readonly updatedAt: string_date_iso8601 | null;
+    /**
+     * Known errors to transfer to new PipelineEditable
+     */
+    readonly knownErrors: Array<ErrorJson>;
+};

package/umd/src/utils/editable/utils/isFlatPipeline.d.ts

@@ -0,0 +1,8 @@
+import type { PipelineString } from '../../../pipeline/PipelineString';
+/**
+ * Utility to determine if a pipeline string is in flat format.
+ * A flat pipeline is a simple text without proper structure (headers, blocks, etc).
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export declare function isFlatPipeline(pipelineString: PipelineString): boolean;

package/umd/src/utils/editable/utils/isFlatPipeline.test.d.ts

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

package/umd/src/utils/editable/utils/renamePipelineParameter.d.ts

@@ -0,0 +1,29 @@
+import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
+import type { string_name } from '../../../types/typeAliases';
+type RenameParameterOptions = {
+    /**
+     * Pipeline to search and replace for parameters
+     * This pipeline is returned as copy with replaced parameters
+     */
+    readonly pipeline: PipelineJson;
+    /**
+     * Original parameter name that should be replaced
+     */
+    readonly oldParameterName: string_name;
+    /**
+     * New parameter name that should replace the original parameter name
+     */
+    readonly newParameterName: string_name;
+};
+/**
+ * Function `renamePipelineParameter` will find all usable parameters for given task
+ * In other words, it will find all parameters that are not used in the task itseld and all its dependencies
+ *
+ * @throws {PipelineLogicError} If the new parameter name is already used in the pipeline
+ * @public exported from `@promptbook/editable`
+ */
+export declare function renamePipelineParameter(options: RenameParameterOptions): PipelineJson;
+export {};
+/**
+ * TODO: Also variant for `edit-pipeline-string`
+ */

package/umd/src/utils/editable/utils/renamePipelineParameter.test.d.ts

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

package/umd/src/utils/editable/utils/stringifyPipelineJson.d.ts

@@ -0,0 +1,16 @@
+import type { string_json } from '../../../types/typeAliases';
+/**
+ * Stringify the PipelineJson with proper formatting
+ *
+ * Note: [0] It can be used for more JSON types like whole collection of pipelines, single knowledge piece, etc.
+ * Note: In contrast to JSON.stringify, this function ensures that **embedding index** is on single line
+ *
+ * @public exported from `@promptbook/editable`
+ */
+export declare function stringifyPipelineJson<TType>(pipeline: TType): string_json<TType>;
+/**
+ * TODO: [🐝] Not Working properly @see https://promptbook.studio/examples/mixed-knowledge.book
+ * 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/umd/src/utils/environment/$detectRuntimeEnvironment.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Returns information about the current runtime environment
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - it looks at the global object to determine the environments
+ *
+ * @public exported from `@promptbook/utils`
+ */
+export declare function $detectRuntimeEnvironment(): {
+    isRunningInBrowser: boolean;
+    isRunningInJest: boolean;
+    isRunningInNode: boolean;
+    isRunningInWebWorker: boolean;
+};
+/**
+ * TODO: [🎺] Also detect and report node version here
+ */

package/umd/src/utils/environment/$getGlobalScope.d.ts

@@ -0,0 +1,10 @@
+import type { chococake } from '../organization/really_any';
+/**
+ * Safely retrieves the global scope object (window in browser, global in Node.js)
+ * regardless of the JavaScript environment in which the code is running
+ *
+ * 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(): chococake;

package/umd/src/utils/environment/$isRunningInBrowser.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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 function $isRunningInBrowser(): boolean;
+/**
+ * TODO: [🎺]
+ */

package/umd/src/utils/environment/$isRunningInJest.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Detects if the code is running in jest 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 function $isRunningInJest(): boolean;
+/**
+ * TODO: [🎺]
+ */

package/umd/src/utils/environment/$isRunningInNode.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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 function $isRunningInNode(): boolean;
+/**
+ * TODO: [🎺]
+ */

package/umd/src/utils/environment/$isRunningInWebWorker.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 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 function $isRunningInWebWorker(): boolean;
+/**
+ * TODO: [🎺]
+ */

package/umd/src/utils/execCommand/$execCommand.d.ts

@@ -0,0 +1,17 @@
+import type { $side_effect } from '../organization/$side_effect';
+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<$side_effect & string>;
+/**
+ * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment
+ */

package/umd/src/utils/execCommand/$execCommandNormalizeOptions.d.ts

@@ -0,0 +1,11 @@
+import type { ExecCommandOptions, 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' | 'env'> & {
+    humanReadableCommand: string;
+};

package/umd/src/utils/execCommand/$execCommands.d.ts

@@ -0,0 +1,19 @@
+import type { $side_effect } from '../organization/$side_effect';
+/**
+ * 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, }: $side_effect & {
+    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/umd/src/utils/execCommand/ExecCommandOptions.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @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' | 'env'>;
+/**
+ * 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;
+    /**
+     * Environment variables to pass to the command
+     *
+     * Note: These will be merged with process.env
+     */
+    readonly env?: Record<string, string>;
+};
+export {};
+/**
+ * TODO: [⏳] Make DEFAULT_TIMEOUT_MS as global constant
+ */

package/umd/src/utils/execCommand/execCommand.test.d.ts

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

package/umd/src/utils/execCommand/execCommandNormalizeOptions.test.d.ts

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

package/umd/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/umd/src/utils/expectation-counters/countCharacters.d.ts

@@ -0,0 +1,11 @@
+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;
+/**
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
+ */

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

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

package/umd/src/utils/expectation-counters/countLines.d.ts

@@ -0,0 +1,13 @@
+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;
+/**
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
+ */

package/umd/src/utils/expectation-counters/countLines.test.d.ts

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

package/umd/src/utils/expectation-counters/countPages.d.ts

@@ -0,0 +1,13 @@
+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;
+/**
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
+ */

package/umd/src/utils/expectation-counters/countPages.test.d.ts

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

package/umd/src/utils/expectation-counters/countParagraphs.d.ts

@@ -0,0 +1,11 @@
+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;
+/**
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
+ */

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

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

package/umd/src/utils/expectation-counters/countSentences.d.ts

@@ -0,0 +1,17 @@
+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;
+/**
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
+ */

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

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

package/umd/src/utils/expectation-counters/countWords.d.ts

@@ -0,0 +1,12 @@
+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;
+/**
+ * TODO: [🥴] Implement counting in formats - like JSON, CSV, XML,...
+ * TODO: [🧠][✌️] Make some Promptbook-native token system
+ * TODO: [✌️] `countWords` should be just `splitWords(...).length`, and all other counters should use this pattern as well
+ */

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

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

package/umd/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 probably as part of `TextFormatParser`
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/umd/src/utils/files/$induceBookDownload.d.ts

@@ -0,0 +1,13 @@
+import type { string_book } from '../../book-2.0/agent-source/string_book';
+import type { $side_effect } from '../organization/$side_effect';
+/**
+ * Download a Book in a browser
+ *
+ * Note: `$` is used to indicate that this function is not a pure function - its purpose is to cause a side effect (download a file)
+ *
+ * @public exported from `@promptbook/browser`
+ */
+export declare function $induceBookDownload(book: string_book): Promise<$side_effect>;
+/**
+ * Note: [🔵] Code in this file should never be published outside of `@promptbook/browser`
+ */