@bitbybit-dev/base 0.20.12 → 0.20.14

package/lib/api/inputs/text-inputs.js

@@ -117,6 +117,221 @@ export var Text;
         }
     }
     Text.TextFormatDto = TextFormatDto;
+    class TextSearchDto {
+        constructor(text, search) {
+            /**
+             * Text to search in
+             * @default hello world
+             */
+            this.text = "hello world";
+            /**
+             * Text to search for
+             * @default world
+             */
+            this.search = "world";
+            if (text !== undefined) {
+                this.text = text;
+            }
+            if (search !== undefined) {
+                this.search = search;
+            }
+        }
+    }
+    Text.TextSearchDto = TextSearchDto;
+    class TextSubstringDto {
+        constructor(text, start, end) {
+            /**
+             * Text to extract from
+             * @default hello world
+             */
+            this.text = "hello world";
+            /**
+             * Start index
+             * @default 0
+             * @minimum 0
+             * @maximum Infinity
+             * @step 1
+             */
+            this.start = 0;
+            /**
+             * End index
+             * @default 5
+             * @minimum 0
+             * @maximum Infinity
+             * @step 1
+             */
+            this.end = 5;
+            if (text !== undefined) {
+                this.text = text;
+            }
+            if (start !== undefined) {
+                this.start = start;
+            }
+            if (end !== undefined) {
+                this.end = end;
+            }
+        }
+    }
+    Text.TextSubstringDto = TextSubstringDto;
+    class TextIndexDto {
+        constructor(text, index) {
+            /**
+             * Text to get character from
+             * @default hello
+             */
+            this.text = "hello";
+            /**
+             * Index of character
+             * @default 0
+             * @minimum 0
+             * @maximum Infinity
+             * @step 1
+             */
+            this.index = 0;
+            if (text !== undefined) {
+                this.text = text;
+            }
+            if (index !== undefined) {
+                this.index = index;
+            }
+        }
+    }
+    Text.TextIndexDto = TextIndexDto;
+    class TextPadDto {
+        constructor(text, length, padString) {
+            /**
+             * Text to pad
+             * @default x
+             */
+            this.text = "x";
+            /**
+             * Target length
+             * @default 3
+             * @minimum 0
+             * @maximum Infinity
+             * @step 1
+             */
+            this.length = 3;
+            /**
+             * String to pad with
+             * @default a
+             */
+            this.padString = "a";
+            if (text !== undefined) {
+                this.text = text;
+            }
+            if (length !== undefined) {
+                this.length = length;
+            }
+            if (padString !== undefined) {
+                this.padString = padString;
+            }
+        }
+    }
+    Text.TextPadDto = TextPadDto;
+    class TextRepeatDto {
+        constructor(text, count) {
+            /**
+             * Text to repeat
+             * @default ha
+             */
+            this.text = "ha";
+            /**
+             * Number of repetitions
+             * @default 3
+             * @minimum 0
+             * @maximum Infinity
+             * @step 1
+             */
+            this.count = 3;
+            if (text !== undefined) {
+                this.text = text;
+            }
+            if (count !== undefined) {
+                this.count = count;
+            }
+        }
+    }
+    Text.TextRepeatDto = TextRepeatDto;
+    class TextConcatDto {
+        constructor(texts) {
+            /**
+             * Texts to concatenate
+             * @default ["hello", " ", "world"]
+             */
+            this.texts = ["hello", " ", "world"];
+            if (texts !== undefined) {
+                this.texts = texts;
+            }
+        }
+    }
+    Text.TextConcatDto = TextConcatDto;
+    class TextRegexDto {
+        constructor(text, pattern, flags) {
+            /**
+             * Text to search in
+             * @default hello123world
+             */
+            this.text = "hello123world";
+            /**
+             * Regular expression pattern
+             * @default [0-9]+
+             */
+            this.pattern = "[0-9]+";
+            /**
+             * Regular expression flags (g, i, m, s, u, y)
+             * @default g
+             */
+            this.flags = "g";
+            if (text !== undefined) {
+                this.text = text;
+            }
+            if (pattern !== undefined) {
+                this.pattern = pattern;
+            }
+            if (flags !== undefined) {
+                this.flags = flags;
+            }
+        }
+    }
+    Text.TextRegexDto = TextRegexDto;
+    class TextRegexReplaceDto {
+        constructor(text, pattern, flags, replaceWith) {
+            /**
+             * Text to search in
+             * @default hello123world456
+             */
+            this.text = "hello123world456";
+            /**
+             * Regular expression pattern
+             * @default [0-9]+
+             */
+            this.pattern = "[0-9]+";
+            /**
+             * Regular expression flags (g, i, m, s, u, y)
+             * @default g
+             */
+            this.flags = "g";
+            /**
+             * Text to replace matches with
+             * @default X
+             */
+            this.replaceWith = "X";
+            if (text !== undefined) {
+                this.text = text;
+            }
+            if (pattern !== undefined) {
+                this.pattern = pattern;
+            }
+            if (flags !== undefined) {
+                this.flags = flags;
+            }
+            if (replaceWith !== undefined) {
+                this.replaceWith = replaceWith;
+            }
+        }
+    }
+    Text.TextRegexReplaceDto = TextRegexReplaceDto;
     class VectorCharDto {
         constructor(char, xOffset, yOffset, height, extrudeOffset) {
             /**

package/lib/api/inputs/vector-inputs.d.ts

@@ -85,6 +85,14 @@ export declare namespace Vector {
          */
         vector: number[];
     }
+    class VectorStringDto {
+        constructor(vector?: string[]);
+        /**
+         * Vector array of stringified numbers
+         * @default undefined
+         */
+        vector: string[];
+    }
     class Vector3Dto {
         constructor(vector?: Base.Vector3);
         /**

package/lib/api/inputs/vector-inputs.js

@@ -93,6 +93,14 @@ export var Vector;
         }
     }
     Vector.VectorDto = VectorDto;
+    class VectorStringDto {
+        constructor(vector) {
+            if (vector !== undefined) {
+                this.vector = vector;
+            }
+        }
+    }
+    Vector.VectorStringDto = VectorStringDto;
     class Vector3Dto {
         constructor(vector) {
             if (vector !== undefined) {

package/lib/api/services/color.d.ts

@@ -4,7 +4,8 @@ export declare class Color {
     private readonly math;
     constructor(math: MathBitByBit);
     /**
-     * Creates a hex color
+     * Creates and returns a hex color string (pass-through for color input).
+     * Example: '#FF5733' → '#FF5733'
      * @param inputs Color hex
      * @returns color string
      * @group create
@@ -13,7 +14,8 @@ export declare class Color {
      */
     hexColor(inputs: Inputs.Color.HexDto): Inputs.Base.Color;
     /**
-     * Creates rgb color from hex
+     * Converts hex color to RGB object with r, g, b values (0-255 range).
+     * Example: '#FF5733' → {r: 255, g: 87, b: 51}
      * @param inputs Color hex
      * @returns rgb color
      * @group convert
@@ -22,7 +24,9 @@ export declare class Color {
      */
     hexToRgb(inputs: Inputs.Color.HexDto): Inputs.Base.ColorRGB;
     /**
-     * Creates hex color from rgb
+     * Converts RGB values to hex color string (supports custom min/max ranges, auto-remaps to 0-255).
+     * Example: r=255, g=87, b=51 with range [0,255] → '#ff5733'
+     * Example: r=1, g=0.5, b=0.2 with range [0,1] → '#ff7f33'
      * @param inputs Color hext
      * @returns hex color
      * @group convert
@@ -31,7 +35,8 @@ export declare class Color {
      */
     rgbToHex(inputs: Inputs.Color.RGBMinMaxDto): Inputs.Base.Color;
     /**
-     * Creates hex color from rgb obj that contains {r, g, b} properties in certain range
+     * Converts RGB object to hex color string (supports custom min/max ranges).
+     * Example: {r: 1, g: 0.5, b: 0.2} with range [0,1] → '#ff7f33'
      * @param inputs Color hext
      * @returns hex color string
      * @group convert
@@ -40,7 +45,9 @@ export declare class Color {
      */
     rgbObjToHex(inputs: Inputs.Color.RGBObjectMaxDto): Inputs.Base.Color;
     /**
-     * Creates rgb color from hex and maps to different range if needed
+     * Converts hex color to RGB and remaps values to a custom range.
+     * Example: '#FF5733' mapped to [0,1] → {r: 1, g: 0.341, b: 0.2}
+     * Example: '#FF5733' mapped to [0,100] → {r: 100, g: 34.1, b: 20}
      * @param inputs Color hext
      * @returns rgb color
      * @group convert
@@ -49,7 +56,8 @@ export declare class Color {
      */
     hexToRgbMapped(inputs: Inputs.Color.HexDtoMapped): Inputs.Base.ColorRGB;
     /**
-     * Get red param
+     * Extracts the red channel value from hex color (can be mapped to custom range).
+     * Example: '#FF5733' with range [0,1] → 1
      * @param inputs Color hext
      * @returns rgb color
      * @group hex to
@@ -58,7 +66,8 @@ export declare class Color {
      */
     getRedParam(inputs: Inputs.Color.HexDtoMapped): number;
     /**
-     * Get green param
+     * Extracts the green channel value from hex color (can be mapped to custom range).
+     * Example: '#FF5733' with range [0,1] → 0.341
      * @param inputs Color hext
      * @returns rgb color
      * @group hex to
@@ -67,7 +76,8 @@ export declare class Color {
      */
     getGreenParam(inputs: Inputs.Color.HexDtoMapped): number;
     /**
-     * Get blue param
+     * Extracts the blue channel value from hex color (can be mapped to custom range).
+     * Example: '#FF5733' with range [0,1] → 0.2
      * @param inputs Color hext
      * @returns blue param
      * @group hex to
@@ -76,7 +86,8 @@ export declare class Color {
      */
     getBlueParam(inputs: Inputs.Color.HexDtoMapped): number;
     /**
-     * RGB to red
+     * Extracts the red channel value from RGB object.
+     * Example: {r: 255, g: 87, b: 51} → 255
      * @param inputs Color rgb
      * @returns red param
      * @group  rgb to
@@ -85,7 +96,8 @@ export declare class Color {
      */
     rgbToRed(inputs: Inputs.Color.RGBObjectDto): number;
     /**
-     * RGB to green
+     * Extracts the green channel value from RGB object.
+     * Example: {r: 255, g: 87, b: 51} → 87
      * @param inputs Color rgb
      * @returns green param
      * @group rgb to
@@ -94,7 +106,8 @@ export declare class Color {
      */
     rgbToGreen(inputs: Inputs.Color.RGBObjectDto): number;
     /**
-     * RGB to blue
+     * Extracts the blue channel value from RGB object.
+     * Example: {r: 255, g: 87, b: 51} → 51
      * @param inputs Color rgb
      * @returns blue param
      * @group rgb to
@@ -103,7 +116,9 @@ export declare class Color {
      */
     rgbToBlue(inputs: Inputs.Color.RGBObjectDto): number;
     /**
-     * Invert color
+     * Inverts a hex color (flips RGB channels: 255-r, 255-g, 255-b).
+     * With blackAndWhite=true → returns '#000000' or '#ffffff' based on brightness.
+     * Example: '#FF5733' → '#00a8cc', '#FF5733' with blackAndWhite=true → '#ffffff'
      * @param inputs hex color and black and white option
      * @returns inverted color
      * @group hex to

package/lib/api/services/color.js

@@ -3,7 +3,8 @@ export class Color {
         this.math = math;
     }
     /**
-     * Creates a hex color
+     * Creates and returns a hex color string (pass-through for color input).
+     * Example: '#FF5733' → '#FF5733'
      * @param inputs Color hex
      * @returns color string
      * @group create
@@ -14,7 +15,8 @@ export class Color {
         return inputs.color;
     }
     /**
-     * Creates rgb color from hex
+     * Converts hex color to RGB object with r, g, b values (0-255 range).
+     * Example: '#FF5733' → {r: 255, g: 87, b: 51}
      * @param inputs Color hex
      * @returns rgb color
      * @group convert
@@ -30,7 +32,9 @@ export class Color {
         } : undefined;
     }
     /**
-     * Creates hex color from rgb
+     * Converts RGB values to hex color string (supports custom min/max ranges, auto-remaps to 0-255).
+     * Example: r=255, g=87, b=51 with range [0,255] → '#ff5733'
+     * Example: r=1, g=0.5, b=0.2 with range [0,1] → '#ff7f33'
      * @param inputs Color hext
      * @returns hex color
      * @group convert
@@ -52,7 +56,8 @@ export class Color {
         return s;
     }
     /**
-     * Creates hex color from rgb obj that contains {r, g, b} properties in certain range
+     * Converts RGB object to hex color string (supports custom min/max ranges).
+     * Example: {r: 1, g: 0.5, b: 0.2} with range [0,1] → '#ff7f33'
      * @param inputs Color hext
      * @returns hex color string
      * @group convert
@@ -63,7 +68,9 @@ export class Color {
         return this.rgbToHex({ r: inputs.rgb.r, g: inputs.rgb.g, b: inputs.rgb.b, min: inputs.min, max: inputs.max });
     }
     /**
-     * Creates rgb color from hex and maps to different range if needed
+     * Converts hex color to RGB and remaps values to a custom range.
+     * Example: '#FF5733' mapped to [0,1] → {r: 1, g: 0.341, b: 0.2}
+     * Example: '#FF5733' mapped to [0,100] → {r: 100, g: 34.1, b: 20}
      * @param inputs Color hext
      * @returns rgb color
      * @group convert
@@ -79,7 +86,8 @@ export class Color {
         };
     }
     /**
-     * Get red param
+     * Extracts the red channel value from hex color (can be mapped to custom range).
+     * Example: '#FF5733' with range [0,1] → 1
      * @param inputs Color hext
      * @returns rgb color
      * @group hex to
@@ -91,7 +99,8 @@ export class Color {
         return rgb.r;
     }
     /**
-     * Get green param
+     * Extracts the green channel value from hex color (can be mapped to custom range).
+     * Example: '#FF5733' with range [0,1] → 0.341
      * @param inputs Color hext
      * @returns rgb color
      * @group hex to
@@ -103,7 +112,8 @@ export class Color {
         return rgb.g;
     }
     /**
-     * Get blue param
+     * Extracts the blue channel value from hex color (can be mapped to custom range).
+     * Example: '#FF5733' with range [0,1] → 0.2
      * @param inputs Color hext
      * @returns blue param
      * @group hex to
@@ -115,7 +125,8 @@ export class Color {
         return rgb.b;
     }
     /**
-     * RGB to red
+     * Extracts the red channel value from RGB object.
+     * Example: {r: 255, g: 87, b: 51} → 255
      * @param inputs Color rgb
      * @returns red param
      * @group  rgb to
@@ -126,7 +137,8 @@ export class Color {
         return inputs.rgb.r;
     }
     /**
-     * RGB to green
+     * Extracts the green channel value from RGB object.
+     * Example: {r: 255, g: 87, b: 51} → 87
      * @param inputs Color rgb
      * @returns green param
      * @group rgb to
@@ -137,7 +149,8 @@ export class Color {
         return inputs.rgb.g;
     }
     /**
-     * RGB to blue
+     * Extracts the blue channel value from RGB object.
+     * Example: {r: 255, g: 87, b: 51} → 51
      * @param inputs Color rgb
      * @returns blue param
      * @group rgb to
@@ -148,7 +161,9 @@ export class Color {
         return inputs.rgb.b;
     }
     /**
-     * Invert color
+     * Inverts a hex color (flips RGB channels: 255-r, 255-g, 255-b).
+     * With blackAndWhite=true → returns '#000000' or '#ffffff' based on brightness.
+     * Example: '#FF5733' → '#00a8cc', '#FF5733' with blackAndWhite=true → '#ffffff'
      * @param inputs hex color and black and white option
      * @returns inverted color
      * @group hex to