@promptbook/wizard 0.100.0-47 → 0.100.0-48

package/README.md

@@ -329,6 +329,7 @@ Or you can install them separately:
 -   **[@promptbook/editable](https://www.npmjs.com/package/@promptbook/editable)** - Editable book as native javascript object with imperative object API
 -   **[@promptbook/templates](https://www.npmjs.com/package/@promptbook/templates)** - Useful templates and examples of books which can be used as a starting point
 -   **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
+-   **[@promptbook/color](https://www.npmjs.com/package/@promptbook/color)** - Just typescript types used in the library
 -   ⭐ **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
 -   🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** - Promptbook server
 

package/esm/index.es.js

@@ -39,7 +39,7 @@ const BOOK_LANGUAGE_VERSION = '1.0.0';
  * @generated
  * @see https://github.com/webgptorg/promptbook
  */
-const PROMPTBOOK_ENGINE_VERSION = '0.100.0-47';
+const PROMPTBOOK_ENGINE_VERSION = '0.100.0-48';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  * Note: [💞] Ignore a discrepancy between file name and entity name

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

@@ -0,0 +1,50 @@
+import { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION } from '../version';
+import { $randomColor } from '../utils/color/$randomColor';
+import { Color } from '../utils/color/Color';
+import { CSS_COLORS } from '../utils/color/css-colors';
+import type { ColorTransformer } from '../utils/color/operators/ColorTransformer';
+import { darken } from '../utils/color/operators/darken';
+import { furthest } from '../utils/color/operators/furthest';
+import { textColor } from '../utils/color/operators/furthest';
+import { grayscale } from '../utils/color/operators/grayscale';
+import { lighten } from '../utils/color/operators/lighten';
+import { mixWithColor } from '../utils/color/operators/mixWithColor';
+import { nearest } from '../utils/color/operators/nearest';
+import { negative } from '../utils/color/operators/negative';
+import { negativeLightness } from '../utils/color/operators/negativeLightness';
+import { withAlpha } from '../utils/color/operators/withAlpha';
+import { areColorsEqual } from '../utils/color/utils/areColorsEqual';
+import { colorDistance } from '../utils/color/utils/colorDistance';
+import { colorDistanceSquared } from '../utils/color/utils/colorDistance';
+import { colorHue } from '../utils/color/utils/colorHue';
+import { colorHueDistance } from '../utils/color/utils/colorHueDistance';
+import { colorLuminance } from '../utils/color/utils/colorLuminance';
+import { colorSatulightion } from '../utils/color/utils/colorSatulightion';
+import { colorSaturation } from '../utils/color/utils/colorSaturation';
+import { colorToDataUrl } from '../utils/color/utils/colorToDataUrl';
+import { mixColors } from '../utils/color/utils/mixColors';
+export { BOOK_LANGUAGE_VERSION, PROMPTBOOK_ENGINE_VERSION };
+export { $randomColor };
+export { Color };
+export { CSS_COLORS };
+export type { ColorTransformer };
+export { darken };
+export { furthest };
+export { textColor };
+export { grayscale };
+export { lighten };
+export { mixWithColor };
+export { nearest };
+export { negative };
+export { negativeLightness };
+export { withAlpha };
+export { areColorsEqual };
+export { colorDistance };
+export { colorDistanceSquared };
+export { colorHue };
+export { colorHueDistance };
+export { colorLuminance };
+export { colorSatulightion };
+export { colorSaturation };
+export { colorToDataUrl };
+export { mixColors };

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

@@ -10,6 +10,7 @@ import { AvatarProfileFromSource } from '../book-components/AvatarProfile/Avatar
 import type { BookEditorProps } from '../book-components/BookEditor/BookEditor';
 import { BookEditor } from '../book-components/BookEditor/BookEditor';
 import { DEFAULT_BOOK_FONT_CLASS } from '../book-components/BookEditor/config';
+import type { ChatProps } from '../book-components/Chat/Chat/Chat';
 import { Chat } from '../book-components/Chat/Chat/Chat';
 import type { ChatMessage } from '../book-components/Chat/interfaces/ChatMessage';
 import type { ChatParticipant } from '../book-components/Chat/interfaces/ChatParticipant';
@@ -25,6 +26,7 @@ export { AvatarProfileFromSource };
 export type { BookEditorProps };
 export { BookEditor };
 export { DEFAULT_BOOK_FONT_CLASS };
+export type { ChatProps };
 export { Chat };
 export type { ChatMessage };
 export type { ChatParticipant };

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

@@ -16,6 +16,7 @@ import type { AvatarChipFromSourceProps } from '../book-components/AvatarProfile
 import type { AvatarProfileProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfile';
 import type { AvatarProfileFromSourceProps } from '../book-components/AvatarProfile/AvatarProfile/AvatarProfileFromSource';
 import type { BookEditorProps } from '../book-components/BookEditor/BookEditor';
+import type { ChatProps } from '../book-components/Chat/Chat/Chat';
 import type { ChatMessage } from '../book-components/Chat/interfaces/ChatMessage';
 import type { ChatParticipant } from '../book-components/Chat/interfaces/ChatParticipant';
 import type { PipelineCollection } from '../collection/PipelineCollection';
@@ -303,6 +304,7 @@ import type { number_gigabytes } from '../types/typeAliases';
 import type { number_terabytes } from '../types/typeAliases';
 import type { Registered } from '../utils/$Register';
 import type { Registration } from '../utils/$Register';
+import type { ColorTransformer } from '../utils/color/operators/ColorTransformer';
 import type { PipelineEditableSerialized } from '../utils/editable/types/PipelineEditableSerialized';
 import type { ExecCommandOptions } from '../utils/execCommand/ExecCommandOptions';
 import type { ExecCommandOptionsAdvanced } from '../utils/execCommand/ExecCommandOptions';
@@ -322,6 +324,7 @@ import type { really_any } from '../utils/organization/really_any';
 import type { TODO_any } from '../utils/organization/TODO_any';
 import type { CheckSerializableAsJsonOptions } from '../utils/serialization/checkSerializableAsJson';
 import type { ExportJsonOptions } from '../utils/serialization/exportJson';
+import type { ITakeChain } from '../utils/take/interfaces/ITakeChain';
 import type { string_promptbook_version } from '../version';
 export type { AgentBasicInformation };
 export type { string_book };
@@ -341,6 +344,7 @@ export type { AvatarChipFromSourceProps };
 export type { AvatarProfileProps };
 export type { AvatarProfileFromSourceProps };
 export type { BookEditorProps };
+export type { ChatProps };
 export type { ChatMessage };
 export type { ChatParticipant };
 export type { PipelineCollection };
@@ -628,6 +632,7 @@ export type { number_gigabytes };
 export type { number_terabytes };
 export type { Registered };
 export type { Registration };
+export type { ColorTransformer };
 export type { PipelineEditableSerialized };
 export type { ExecCommandOptions };
 export type { ExecCommandOptionsAdvanced };
@@ -647,4 +652,5 @@ export type { really_any };
 export type { TODO_any };
 export type { CheckSerializableAsJsonOptions };
 export type { ExportJsonOptions };
+export type { ITakeChain };
 export type { string_promptbook_version };

package/esm/typings/src/book-components/Chat/Chat/Chat.d.ts

@@ -7,7 +7,10 @@ import type { ChatParticipant } from '../interfaces/ChatParticipant';
  * @private util of `<Chat />`
  */
 export declare const LOADING_INTERACTIVE_IMAGE = "Loading...";
-interface ChatProps {
+/**
+ * @public exported from `@promptbook/components`
+ */
+export interface ChatProps {
     /**
      * Optional callback to create a new agent from the template.
      * If provided, renders the [Use this template] button.
@@ -125,4 +128,3 @@ interface ChatProps {
  * @public exported from `@promptbook/components`
  */
 export declare function Chat(props: ChatProps): import("react/jsx-runtime").JSX.Element;
-export {};

package/esm/typings/src/book-components/Chat/interfaces/ChatParticipant.d.ts

@@ -1,6 +1,8 @@
+import type { string_color } from '../../../types/typeAliases';
 import type { string_name } from '../../../types/typeAliases';
 import type { string_person_fullname } from '../../../types/typeAliases';
 import type { string_url_image } from '../../../types/typeAliases';
+import { Color } from '../../../utils/color/Color';
 /**
  * A participant in the chat
  *
@@ -26,5 +28,5 @@ export type ChatParticipant = {
     /**
      * Color associated with the participant
      */
-    color: string;
+    color: string_color | Color;
 };

package/esm/typings/src/utils/color/$randomColor.d.ts

@@ -0,0 +1,11 @@
+import { Color } from './Color';
+/**
+ * Creates a random color
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare function $randomColor(): Color;
+/**
+ * TODO: !! Use Internally Color.fromValues
+ * TODO: !! randomColorWithAlpha
+ */

package/esm/typings/src/utils/color/Color.d.ts

@@ -0,0 +1,180 @@
+import type { string_color } from '../../types/typeAliases';
+import type { string_url_image } from '../../types/typeAliases';
+import type { WithTake } from '../take/interfaces/ITakeChain';
+import { CSS_COLORS } from './css-colors';
+/**
+ * Color object represents an RGB color with alpha channel
+ *
+ * Note: There is no fromObject/toObject because the most logical way to serialize color is as a hex string (#009edd)
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare class Color {
+    readonly red: number;
+    readonly green: number;
+    readonly blue: number;
+    readonly alpha: number;
+    /**
+     * Creates a new Color instance from miscellaneous formats
+     * - It can receive Color instance and just return the same instance
+     * - It can receive color in string format for example `#009edd`, `rgb(0,158,221)`, `rgb(0%,62%,86.7%)`, `hsl(197.1,100%,43.3%)`
+     *
+     * Note: This is not including fromImage because detecting color from an image is heavy task which requires async stuff and we cannot safely determine with overloading if return value will be a promise
+     *
+     * @param color
+     * @returns Color object
+     */
+    static from(color: string_color | Color): WithTake<Color>;
+    /**
+     * Creates a new Color instance from miscellaneous string formats
+     *
+     * @param color as a string for example `#009edd`, `rgb(0,158,221)`, `rgb(0%,62%,86.7%)`, `hsl(197.1,100%,43.3%)`, `red`, `darkgrey`,...
+     * @returns Color object
+     */
+    static fromString(color: string_color): WithTake<Color>;
+    /**
+     * Gets common color
+     *
+     * @param key as a css string like `midnightblue`
+     * @returns Color object
+     */
+    static get(key: keyof typeof CSS_COLORS): WithTake<Color>;
+    /**
+     * Creates a new Color instance from average color of given image
+     *
+     * @param image as a source for example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAAAXNSR0IArs4c6QAAAA1JREFUGFdjYJh39z8ABJgCe/ZvAS4AAAAASUVORK5CYII=`
+     * @returns Color object
+     */
+    static fromImage(image: string_url_image): Promise<Color>;
+    /**
+     * Creates a new Color instance from color in hex format
+     *
+     * @param color in hex for example `#009edd`, `009edd`, `#555`,...
+     * @returns Color object
+     */
+    static fromHex(hex: string_color): WithTake<Color>;
+    /**
+     * Creates a new Color instance from color in hex format with 3 color digits (without alpha channel)
+     *
+     * @param color in hex for example `09d`
+     * @returns Color object
+     */
+    private static fromHex3;
+    /**
+     * Creates a new Color instance from color in hex format with 6 color digits (without alpha channel)
+     *
+     * @param color in hex for example `009edd`
+     * @returns Color object
+     */
+    private static fromHex6;
+    /**
+     * Creates a new Color instance from color in hex format with 8 color digits (with alpha channel)
+     *
+     * @param color in hex for example `009edd`
+     * @returns Color object
+     */
+    private static fromHex8;
+    /**
+     * Creates a new Color instance from color in hsl format
+     *
+     * @param color as a hsl for example `hsl(197.1,100%,43.3%)`
+     * @returns Color object
+     */
+    static fromHsl(hsl: string_color): WithTake<Color>;
+    /**
+     * Creates a new Color instance from color in rgb format
+     *
+     * @param color as a rgb for example `rgb(0,158,221)`, `rgb(0%,62%,86.7%)`
+     * @returns Color object
+     */
+    static fromRgbString(rgb: string_color): WithTake<Color>;
+    /**
+     * Creates a new Color instance from color in rbga format
+     *
+     * @param color as a rgba for example `rgba(0,158,221,0.5)`, `rgb(0%,62%,86.7%,50%)`
+     * @returns Color object
+     */
+    static fromRgbaString(rgba: string_color): WithTake<Color>;
+    /**
+     * Creates a new Color for color channels values
+     *
+     * @param red number from 0 to 255
+     * @param green number from 0 to 255
+     * @param blue number from 0 to 255
+     * @param alpha number from 0 (transparent) to 255 (opaque = default)
+     * @returns Color object
+     */
+    static fromValues(red: number, green: number, blue: number, alpha?: number): WithTake<Color>;
+    /**
+     * Checks if the given value is a valid Color object.
+     *
+     * @param {unknown} value - The value to check.
+     * @return {value is WithTake<Color>} Returns true if the value is a valid Color object, false otherwise.
+     */
+    static isColor(value: unknown): value is WithTake<Color>;
+    /**
+     * Creates new Color object
+     *
+     * Note: Consider using one of static methods like `from` or `fromString`
+     *
+     * @param red number from 0 to 255
+     * @param green number from 0 to 255
+     * @param blue number from 0 to 255
+     * @param alpha number from 0 (transparent) to 255 (opaque)
+     */
+    private constructor();
+    /**
+     * Shortcut for `red` property
+     * Number from 0 to 255
+     * @alias red
+     */
+    get r(): number;
+    /**
+     * Shortcut for `green` property
+     * Number from 0 to 255
+     * @alias green
+     */
+    get g(): number;
+    /**
+     * Shortcut for `blue` property
+     * Number from 0 to 255
+     * @alias blue
+     */
+    get b(): number;
+    /**
+     * Shortcut for `alpha` property
+     * Number from 0 (transparent) to 255 (opaque)
+     * @alias alpha
+     */
+    get a(): number;
+    /**
+     * Shortcut for `alpha` property
+     * Number from 0 (transparent) to 255 (opaque)
+     * @alias alpha
+     */
+    get opacity(): number;
+    /**
+     * Shortcut for 1-`alpha` property
+     */
+    get transparency(): number;
+    clone(): WithTake<Color>;
+    toString(): string_color;
+    toHex(): string_color;
+    toRgb(): string_color;
+    toHsl(): string_color;
+}
+/**
+ * TODO: For each method a corresponding static method should be created
+ *       Like clone can be done by color.clone() OR Color.clone(color)
+ * TODO: Probably as an independent LIB OR add to LIB xyzt (ask @roseckyj)
+ * TODO: !! Transfer back to Collboard (whole directory)
+ * TODO: Maybe [🏌️‍♂️] change ACRY toString => (toHex) toRgb when there will be toRgb and toRgba united
+ * TODO: Convert getters to methods - getters only for values
+ * TODO: Write tests
+ * TODO: Getters for alpha, opacity, transparency, r, b, g, h, s, l, a,...
+ * TODO: [0] Should be fromRgbString and fromRgbaString one or two functions + one or two regex
+ * TODO: Use rgb, rgba, hsl for testing and parsing with the same regex
+ * TODO: Regex for rgb, rgba, hsl does not support all options like deg, rad, turn,...
+ * TODO: Convolution matrix
+ * TODO: Maybe connect with textures
+ */

package/esm/typings/src/utils/color/css-colors.d.ts

@@ -0,0 +1,159 @@
+/**
+ * 🎨 List of all 140 color names which are supported by CSS
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare const CSS_COLORS: {
+    readonly transparent: "rgba(0,0,0,0)";
+    readonly aliceblue: "#f0f8ff";
+    readonly antiquewhite: "#faebd7";
+    readonly aqua: "#00ffff";
+    readonly aquamarine: "#7fffd4";
+    readonly azure: "#f0ffff";
+    readonly beige: "#f5f5dc";
+    readonly bisque: "#ffe4c4";
+    readonly black: "#000000";
+    readonly blanchedalmond: "#ffebcd";
+    readonly blue: "#0000ff";
+    readonly blueviolet: "#8a2be2";
+    readonly brown: "#a52a2a";
+    readonly burlywood: "#deb887";
+    readonly cadetblue: "#5f9ea0";
+    readonly chartreuse: "#7fff00";
+    readonly chocolate: "#d2691e";
+    readonly coral: "#ff7f50";
+    readonly cornflowerblue: "#6495ed";
+    readonly cornsilk: "#fff8dc";
+    readonly crimson: "#dc143c";
+    readonly cyan: "#00ffff";
+    readonly darkblue: "#00008b";
+    readonly darkcyan: "#008b8b";
+    readonly darkgoldenrod: "#b8860b";
+    readonly darkgray: "#a9a9a9";
+    readonly darkgrey: "#a9a9a9";
+    readonly darkgreen: "#006400";
+    readonly darkkhaki: "#bdb76b";
+    readonly darkmagenta: "#8b008b";
+    readonly darkolivegreen: "#556b2f";
+    readonly darkorange: "#ff8c00";
+    readonly darkorchid: "#9932cc";
+    readonly darkred: "#8b0000";
+    readonly darksalmon: "#e9967a";
+    readonly darkseagreen: "#8fbc8f";
+    readonly darkslateblue: "#483d8b";
+    readonly darkslategray: "#2f4f4f";
+    readonly darkslategrey: "#2f4f4f";
+    readonly darkturquoise: "#00ced1";
+    readonly darkviolet: "#9400d3";
+    readonly deeppink: "#ff1493";
+    readonly deepskyblue: "#00bfff";
+    readonly dimgray: "#696969";
+    readonly dimgrey: "#696969";
+    readonly dodgerblue: "#1e90ff";
+    readonly firebrick: "#b22222";
+    readonly floralwhite: "#fffaf0";
+    readonly forestgreen: "#228b22";
+    readonly fuchsia: "#ff00ff";
+    readonly gainsboro: "#dcdcdc";
+    readonly ghostwhite: "#f8f8ff";
+    readonly gold: "#ffd700";
+    readonly goldenrod: "#daa520";
+    readonly gray: "#808080";
+    readonly grey: "#808080";
+    readonly green: "#008000";
+    readonly greenyellow: "#adff2f";
+    readonly honeydew: "#f0fff0";
+    readonly hotpink: "#ff69b4";
+    readonly indianred: "#cd5c5c";
+    readonly indigo: "#4b0082";
+    readonly ivory: "#fffff0";
+    readonly khaki: "#f0e68c";
+    readonly lavender: "#e6e6fa";
+    readonly lavenderblush: "#fff0f5";
+    readonly lawngreen: "#7cfc00";
+    readonly lemonchiffon: "#fffacd";
+    readonly lightblue: "#add8e6";
+    readonly lightcoral: "#f08080";
+    readonly lightcyan: "#e0ffff";
+    readonly lightgoldenrodyellow: "#fafad2";
+    readonly lightgray: "#d3d3d3";
+    readonly lightgrey: "#d3d3d3";
+    readonly lightgreen: "#90ee90";
+    readonly lightpink: "#ffb6c1";
+    readonly lightsalmon: "#ffa07a";
+    readonly lightseagreen: "#20b2aa";
+    readonly lightskyblue: "#87cefa";
+    readonly lightslategray: "#778899";
+    readonly lightslategrey: "#778899";
+    readonly lightsteelblue: "#b0c4de";
+    readonly lightyellow: "#ffffe0";
+    readonly lime: "#00ff00";
+    readonly limegreen: "#32cd32";
+    readonly linen: "#faf0e6";
+    readonly magenta: "#ff00ff";
+    readonly maroon: "#800000";
+    readonly mediumaquamarine: "#66cdaa";
+    readonly mediumblue: "#0000cd";
+    readonly mediumorchid: "#ba55d3";
+    readonly mediumpurple: "#9370db";
+    readonly mediumseagreen: "#3cb371";
+    readonly mediumslateblue: "#7b68ee";
+    readonly mediumspringgreen: "#00fa9a";
+    readonly mediumturquoise: "#48d1cc";
+    readonly mediumvioletred: "#c71585";
+    readonly midnightblue: "#191970";
+    readonly mintcream: "#f5fffa";
+    readonly mistyrose: "#ffe4e1";
+    readonly moccasin: "#ffe4b5";
+    readonly navajowhite: "#ffdead";
+    readonly navy: "#000080";
+    readonly oldlace: "#fdf5e6";
+    readonly olive: "#808000";
+    readonly olivedrab: "#6b8e23";
+    readonly orange: "#ffa500";
+    readonly orangered: "#ff4500";
+    readonly orchid: "#da70d6";
+    readonly palegoldenrod: "#eee8aa";
+    readonly palegreen: "#98fb98";
+    readonly paleturquoise: "#afeeee";
+    readonly palevioletred: "#db7093";
+    readonly papayawhip: "#ffefd5";
+    readonly peachpuff: "#ffdab9";
+    readonly peru: "#cd853f";
+    readonly pink: "#ffc0cb";
+    readonly plum: "#dda0dd";
+    readonly powderblue: "#b0e0e6";
+    readonly purple: "#800080";
+    readonly rebeccapurple: "#663399";
+    readonly red: "#ff0000";
+    readonly rosybrown: "#bc8f8f";
+    readonly royalblue: "#4169e1";
+    readonly saddlebrown: "#8b4513";
+    readonly salmon: "#fa8072";
+    readonly sandybrown: "#f4a460";
+    readonly seagreen: "#2e8b57";
+    readonly seashell: "#fff5ee";
+    readonly sienna: "#a0522d";
+    readonly silver: "#c0c0c0";
+    readonly skyblue: "#87ceeb";
+    readonly slateblue: "#6a5acd";
+    readonly slategray: "#708090";
+    readonly slategrey: "#708090";
+    readonly snow: "#fffafa";
+    readonly springgreen: "#00ff7f";
+    readonly steelblue: "#4682b4";
+    readonly tan: "#d2b48c";
+    readonly teal: "#008080";
+    readonly thistle: "#d8bfd8";
+    readonly tomato: "#ff6347";
+    readonly turquoise: "#40e0d0";
+    readonly violet: "#ee82ee";
+    readonly wheat: "#f5deb3";
+    readonly white: "#ffffff";
+    readonly whitesmoke: "#f5f5f5";
+    readonly yellow: "#ffff00";
+    readonly yellowgreen: "#9acd32";
+};
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/utils/color/internal-utils/checkChannelValue.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Validates that a channel value is a valid number within the range of 0 to 255.
+ * Throws an error if the value is not valid.
+ *
+ * @param channelName - The name of the channel being validated.
+ * @param value - The value of the channel to validate.
+ * @throws Will throw an error if the value is not a valid channel number.
+ *
+ * @private util of `@promptbook/color`
+ */
+export declare function checkChannelValue(channelName: string, value: number): asserts value is number;
+/**
+ * TODO: [🧠][🚓] Is/which combination it better to use asserts/check, validate or is utility function?
+ */

package/esm/typings/src/utils/color/internal-utils/hslToRgb.d.ts

@@ -0,0 +1,17 @@
+import type { number_integer } from '../../../types/typeAliases';
+import type { number_percent } from '../../../types/typeAliases';
+import type { number_positive } from '../../../types/typeAliases';
+/**
+ * Converts HSL values to RGB values
+ *
+ * @param hue [0-1]
+ * @param saturation [0-1]
+ * @param lightness [0-1]
+ * @returns [red, green, blue] [0-255]
+ *
+ * @private util of `@promptbook/color`
+ */
+export declare function hslToRgb(hue: number_percent, saturation: number_percent, lightness: number_percent): readonly [number_positive & number_integer, number_positive & number_integer, number_positive & number_integer];
+/**
+ * TODO: Properly name all used internal variables
+ */

package/esm/typings/src/utils/color/internal-utils/rgbToHsl.d.ts

@@ -0,0 +1,17 @@
+import type { number_integer } from '../../../types/typeAliases';
+import type { number_percent } from '../../../types/typeAliases';
+import type { number_positive } from '../../../types/typeAliases';
+/**
+ * Converts RGB values to HSL values
+ *
+ * @param red [0-255]
+ * @param green [0-255]
+ * @param blue [0-255]
+ * @returns [hue, saturation, lightness] [0-1]
+ *
+ * @private util of `@promptbook/color`
+ */
+export declare function rgbToHsl(red: number_positive & number_integer, green: number_positive & number_integer, blue: number_positive & number_integer): readonly [number_percent, number_percent, number_percent];
+/**
+ * TODO: Properly name all used internal variables
+ */

package/esm/typings/src/utils/color/operators/ColorTransformer.d.ts

@@ -0,0 +1,5 @@
+import { Color } from '../Color';
+/**
+ * @public exported from `@promptbook/color`
+ */
+export type ColorTransformer = (color: Color) => Color;

package/esm/typings/src/utils/color/operators/darken.d.ts

@@ -0,0 +1,9 @@
+import type { ColorTransformer } from './ColorTransformer';
+/**
+ * Makes color transformer which darker the given color
+ *
+ * @param amount from 0 to 1
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare function darken(amount: number): ColorTransformer;

package/esm/typings/src/utils/color/operators/furthest.d.ts

@@ -0,0 +1,16 @@
+import { Color } from '../Color';
+import type { ColorTransformer } from './ColorTransformer';
+/**
+ * Makes color transformer which finds the furthest color from the given list
+ *
+ * @param colors array of colors to choose from
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare function furthest(...colors: Color[]): ColorTransformer;
+/**
+ * Makes color transformer which finds the best text color (black or white) for the given background color
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare const textColor: ColorTransformer;

package/esm/typings/src/utils/color/operators/grayscale.d.ts

@@ -0,0 +1,9 @@
+import type { ColorTransformer } from './ColorTransformer';
+/**
+ * Makes color transformer which returns a grayscale version of the color
+ *
+ * @param amount from 0 to 1
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare function grayscale(amount: number): ColorTransformer;

package/esm/typings/src/utils/color/operators/lighten.d.ts

@@ -0,0 +1,12 @@
+import type { ColorTransformer } from './ColorTransformer';
+/**
+ * Makes color transformer which lighten the given color
+ *
+ * @param amount from 0 to 1
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare function lighten(amount: number): ColorTransformer;
+/**
+ * TODO: Maybe implement by mix+hsl
+ */

package/esm/typings/src/utils/color/operators/mixWithColor.d.ts

@@ -0,0 +1,11 @@
+import { Color } from '../Color';
+import type { ColorTransformer } from './ColorTransformer';
+/**
+ * Makes color transformer which returns a mix of two colors based on a ratio
+ *
+ * @param ratio the ratio of the first color to the second color, from 0 to 1
+ * @param additionalColor the second color to mix with the first color
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare function mixWithColor(ratio: number, additionalColor: Color): ColorTransformer;

package/esm/typings/src/utils/color/operators/nearest.d.ts

@@ -0,0 +1,10 @@
+import { Color } from '../Color';
+import type { ColorTransformer } from './ColorTransformer';
+/**
+ * Makes color transformer which finds the nearest color from the given list
+ *
+ * @param colors array of colors to choose from
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare function nearest(...colors: Color[]): ColorTransformer;

package/esm/typings/src/utils/color/operators/negative.d.ts

@@ -0,0 +1,7 @@
+import { Color } from '../Color';
+/**
+ * Color transformer which returns the negative color
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare function negative(color: Color): Color;

package/esm/typings/src/utils/color/operators/negativeLightness.d.ts

@@ -0,0 +1,7 @@
+import { Color } from '../Color';
+/**
+ * Color transformer which returns the negative color but preserves hue and saturation
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare function negativeLightness(color: Color): Color;

package/esm/typings/src/utils/color/operators/withAlpha.d.ts

@@ -0,0 +1,9 @@
+import type { ColorTransformer } from './ColorTransformer';
+/**
+ * Makes color transformer which sets alpha channel to given color
+ *
+ * @param alpha number from 0 (transparent) to 1 (opaque)
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare function withAlpha(alpha: number): ColorTransformer;

package/esm/typings/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/esm/typings/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/esm/typings/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/esm/typings/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/esm/typings/src/utils/color/utils/colorHueDistance.test.d.ts

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

package/esm/typings/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/esm/typings/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/esm/typings/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/esm/typings/src/utils/color/utils/colorToDataUrl.d.ts

@@ -0,0 +1,10 @@
+import { Color } from '../Color';
+/**
+ * Makes data url from color
+ *
+ * @public exported from `@promptbook/color`
+ */
+export declare function colorToDataUrl(color: Color): string;
+/**
+ * TODO: Make as functions NOT const
+ */

package/esm/typings/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/esm/typings/src/utils/take/classes/TakeChain.d.ts

@@ -0,0 +1,11 @@
+import type { ITakeChain } from '../interfaces/ITakeChain';
+import type { Takeable } from '../interfaces/Takeable';
+/**
+ * @private util of `@promptbook/color`
+ * @de
+ */
+export declare class TakeChain<TValue extends Takeable> implements ITakeChain<TValue> {
+    value: TValue;
+    constructor(value: TValue);
+    then<TResultValue extends Takeable>(callback: (oldValue: TValue) => TResultValue): TResultValue & ITakeChain<TResultValue>;
+}

package/esm/typings/src/utils/take/interfaces/ITakeChain.d.ts

@@ -0,0 +1,12 @@
+import type { Takeable } from './Takeable';
+/**
+ * Represents any value with take chain functionality
+ *
+ * @private util of `@promptbook/color`
+ * @deprecated [🤡] Use some better functional library instead of `TakeChain`
+ */
+export type WithTake<TValue extends Takeable> = TValue & ITakeChain<TValue>;
+export interface ITakeChain<TValue extends Takeable> {
+    readonly value: TValue;
+    then<TResultValue extends Takeable>(callback: (value: TValue) => TResultValue): WithTake<TResultValue>;
+}

package/esm/typings/src/utils/take/interfaces/Takeable.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Represents a type that can be chained in take pipe
+ *
+ * @private util of `@promptbook/color`
+ * @deprecated [🤡] Use some better functional library instead of `TakeChain`
+ */
+export type Takeable = Exclude<object, null>;

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

@@ -0,0 +1,12 @@
+import type { WithTake } from './interfaces/ITakeChain';
+import type { Takeable } from './interfaces/Takeable';
+/**
+ * A function that takes an initial value and returns a proxy object with chainable methods.
+ *
+ * @param {*} initialValue - The initial value.
+ * @returns {Proxy<WithTake<TValue>>} - A proxy object with a `take` method.
+ *
+ * @private util of `@promptbook/color`
+ * @deprecated [🤡] Use some better functional library instead of `TakeChain`
+ */
+export declare function take<TValue extends Takeable>(initialValue: TValue): WithTake<TValue>;

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

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

package/esm/typings/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.100.0-46`).
+ * It follows semantic versioning (e.g., `0.100.0-47`).
  *
  * @generated
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/wizard",
-    "version": "0.100.0-47",
+    "version": "0.100.0-48",
     "description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
     "private": false,
     "sideEffects": false,
@@ -95,7 +95,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/wizard.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.100.0-47"
+        "@promptbook/core": "0.100.0-48"
     },
     "dependencies": {
         "@ai-sdk/deepseek": "0.1.6",

package/umd/index.umd.js

@@ -50,7 +50,7 @@
      * @generated
      * @see https://github.com/webgptorg/promptbook
      */
-    const PROMPTBOOK_ENGINE_VERSION = '0.100.0-47';
+    const PROMPTBOOK_ENGINE_VERSION = '0.100.0-48';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      * Note: [💞] Ignore a discrepancy between file name and entity name