@bitbybit-dev/base 0.19.8 → 0.20.0

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

@@ -0,0 +1,114 @@
+import * as Inputs from "../inputs";
+import { MathBitByBit } from "./math";
+export declare class Color {
+    private readonly math;
+    constructor(math: MathBitByBit);
+    /**
+     * Creates a hex color
+     * @param inputs Color hex
+     * @returns color string
+     * @group create
+     * @shortname color
+     * @drawable false
+     */
+    hexColor(inputs: Inputs.Color.HexDto): Inputs.Base.Color;
+    /**
+     * Creates rgb color from hex
+     * @param inputs Color hex
+     * @returns rgb color
+     * @group convert
+     * @shortname hex to rgb
+     * @drawable false
+     */
+    hexToRgb(inputs: Inputs.Color.HexDto): Inputs.Base.ColorRGB;
+    /**
+     * Creates hex color from rgb
+     * @param inputs Color hext
+     * @returns hex color
+     * @group convert
+     * @shortname rgb to hex
+     * @drawable false
+     */
+    rgbToHex(inputs: Inputs.Color.RGBMinMaxDto): Inputs.Base.Color;
+    /**
+     * Creates hex color from rgb obj that contains {r, g, b} properties in certain range
+     * @param inputs Color hext
+     * @returns hex color string
+     * @group convert
+     * @shortname rgb obj to hex
+     * @drawable false
+     */
+    rgbObjToHex(inputs: Inputs.Color.RGBObjectMaxDto): Inputs.Base.Color;
+    /**
+     * Creates rgb color from hex and maps to different range if needed
+     * @param inputs Color hext
+     * @returns rgb color
+     * @group convert
+     * @shortname hex to rgb mapped
+     * @drawable false
+     */
+    hexToRgbMapped(inputs: Inputs.Color.HexDtoMapped): Inputs.Base.ColorRGB;
+    /**
+     * Get red param
+     * @param inputs Color hext
+     * @returns rgb color
+     * @group hex to
+     * @shortname red
+     * @drawable false
+     */
+    getRedParam(inputs: Inputs.Color.HexDtoMapped): number;
+    /**
+     * Get green param
+     * @param inputs Color hext
+     * @returns rgb color
+     * @group hex to
+     * @shortname green
+     * @drawable false
+     */
+    getGreenParam(inputs: Inputs.Color.HexDtoMapped): number;
+    /**
+     * Get blue param
+     * @param inputs Color hext
+     * @returns blue param
+     * @group hex to
+     * @shortname blue
+     * @drawable false
+     */
+    getBlueParam(inputs: Inputs.Color.HexDtoMapped): number;
+    /**
+     * RGB to red
+     * @param inputs Color rgb
+     * @returns red param
+     * @group  rgb to
+     * @shortname red
+     * @drawable false
+     */
+    rgbToRed(inputs: Inputs.Color.RGBObjectDto): number;
+    /**
+     * RGB to green
+     * @param inputs Color rgb
+     * @returns green param
+     * @group rgb to
+     * @shortname green
+     * @drawable false
+     */
+    rgbToGreen(inputs: Inputs.Color.RGBObjectDto): number;
+    /**
+     * RGB to blue
+     * @param inputs Color rgb
+     * @returns blue param
+     * @group rgb to
+     * @shortname blue
+     * @drawable false
+     */
+    rgbToBlue(inputs: Inputs.Color.RGBObjectDto): number;
+    /**
+     * Invert color
+     * @param inputs hex color and black and white option
+     * @returns inverted color
+     * @group hex to
+     * @shortname invert color
+     * @drawable false
+     */
+    invert(inputs: Inputs.Color.InvertHexDto): Inputs.Base.Color;
+}

package/lib/api/services/{color.ts → color.js}

@@ -1,11 +1,7 @@
-import * as Inputs from "../inputs";
-import { MathBitByBit } from "./math";
-
 export class Color {
-
-
-    constructor(private readonly math: MathBitByBit) { }
-
+    constructor(math) {
+        this.math = math;
+    }
     /**
      * Creates a hex color
      * @param inputs Color hex
@@ -14,10 +10,9 @@ export class Color {
      * @shortname color
      * @drawable false
      */
-    hexColor(inputs: Inputs.Color.HexDto): Inputs.Base.Color {
+    hexColor(inputs) {
         return inputs.color;
     }
-
     /**
      * Creates rgb color from hex
      * @param inputs Color hex
@@ -26,7 +21,7 @@ export class Color {
      * @shortname hex to rgb
      * @drawable false
      */
-    hexToRgb(inputs: Inputs.Color.HexDto): Inputs.Base.ColorRGB {
+    hexToRgb(inputs) {
         const result = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(inputs.color);
         return result ? {
             r: parseInt(result[1], 16),
@@ -34,7 +29,6 @@ export class Color {
             b: parseInt(result[3], 16)
         } : undefined;
     }
-
     /**
      * Creates hex color from rgb
      * @param inputs Color hext
@@ -43,11 +37,10 @@ export class Color {
      * @shortname rgb to hex
      * @drawable false
      */
-    rgbToHex(inputs: Inputs.Color.RGBMinMaxDto): Inputs.Base.Color {
+    rgbToHex(inputs) {
         let r = inputs.r;
         let g = inputs.g;
         let b = inputs.b;
-
         // sometimes rgb values are in 0 - 100 or 0 - 1 ranges
         // so we need to remap them to 0 - 255
         if (inputs.max !== 255) {
@@ -55,13 +48,9 @@ export class Color {
             g = Math.round(this.math.remap({ number: g, fromLow: inputs.min, fromHigh: inputs.max, toLow: 0, toHigh: 255 }));
             b = Math.round(this.math.remap({ number: b, fromLow: inputs.min, fromHigh: inputs.max, toLow: 0, toHigh: 255 }));
         }
-
         const s = `#${Number(0x1000000 + r * 0x10000 + g * 0x100 + b).toString(16).substring(1, 7)}`;
-
         return s;
     }
-
-
     /**
      * Creates hex color from rgb obj that contains {r, g, b} properties in certain range
      * @param inputs Color hext
@@ -70,10 +59,9 @@ export class Color {
      * @shortname rgb obj to hex
      * @drawable false
      */
-    rgbObjToHex(inputs: Inputs.Color.RGBObjectMaxDto): Inputs.Base.Color {
+    rgbObjToHex(inputs) {
         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
      * @param inputs Color hext
@@ -82,7 +70,7 @@ export class Color {
      * @shortname hex to rgb mapped
      * @drawable false
      */
-    hexToRgbMapped(inputs: Inputs.Color.HexDtoMapped): Inputs.Base.ColorRGB {
+    hexToRgbMapped(inputs) {
         const rgb = this.hexToRgb(inputs);
         return {
             r: this.math.remap({ number: rgb.r, fromLow: 0, fromHigh: 255, toLow: inputs.from, toHigh: inputs.to }),
@@ -90,7 +78,6 @@ export class Color {
             b: this.math.remap({ number: rgb.b, fromLow: 0, fromHigh: 255, toLow: inputs.from, toHigh: inputs.to }),
         };
     }
-
     /**
      * Get red param
      * @param inputs Color hext
@@ -99,11 +86,10 @@ export class Color {
      * @shortname red
      * @drawable false
      */
-    getRedParam(inputs: Inputs.Color.HexDtoMapped): number {
+    getRedParam(inputs) {
         const rgb = this.hexToRgbMapped(inputs);
         return rgb.r;
     }
-
     /**
      * Get green param
      * @param inputs Color hext
@@ -112,11 +98,10 @@ export class Color {
      * @shortname green
      * @drawable false
      */
-    getGreenParam(inputs: Inputs.Color.HexDtoMapped): number {
+    getGreenParam(inputs) {
         const rgb = this.hexToRgbMapped(inputs);
         return rgb.g;
     }
-
     /**
      * Get blue param
      * @param inputs Color hext
@@ -125,11 +110,10 @@ export class Color {
      * @shortname blue
      * @drawable false
      */
-    getBlueParam(inputs: Inputs.Color.HexDtoMapped): number {
+    getBlueParam(inputs) {
         const rgb = this.hexToRgbMapped(inputs);
         return rgb.b;
     }
-
     /**
      * RGB to red
      * @param inputs Color rgb
@@ -138,10 +122,9 @@ export class Color {
      * @shortname red
      * @drawable false
      */
-    rgbToRed(inputs: Inputs.Color.RGBObjectDto): number {
+    rgbToRed(inputs) {
         return inputs.rgb.r;
     }
-
     /**
      * RGB to green
      * @param inputs Color rgb
@@ -150,10 +133,9 @@ export class Color {
      * @shortname green
      * @drawable false
      */
-    rgbToGreen(inputs: Inputs.Color.RGBObjectDto): number {
+    rgbToGreen(inputs) {
         return inputs.rgb.g;
     }
-
     /**
      * RGB to blue
      * @param inputs Color rgb
@@ -162,10 +144,9 @@ export class Color {
      * @shortname blue
      * @drawable false
      */
-    rgbToBlue(inputs: Inputs.Color.RGBObjectDto): number {
+    rgbToBlue(inputs) {
         return inputs.rgb.b;
     }
-
     /**
      * Invert color
      * @param inputs hex color and black and white option
@@ -174,7 +155,7 @@ export class Color {
      * @shortname invert color
      * @drawable false
      */
-    invert(inputs: Inputs.Color.InvertHexDto): Inputs.Base.Color {
+    invert(inputs) {
         const { r, g, b } = this.hexToRgbMapped({ color: inputs.color, from: 0, to: 255 });
         if (inputs.blackAndWhite) {
             return (r * 0.299 + g * 0.587 + b * 0.114) > 186

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

@@ -0,0 +1,367 @@
+import * as Inputs from "../inputs";
+/**
+ * Contains various date methods.
+ */
+export declare class Dates {
+    /**
+     * Returns a date as a string value.
+     * @param inputs a date
+     * @returns date as string
+     * @group convert
+     * @shortname date to string
+     * @drawable false
+     */
+    toDateString(inputs: Inputs.Dates.DateDto): string;
+    /**
+     * Returns a date as a string value in ISO format.
+     * @param inputs a date
+     * @returns date as string
+     * @group convert
+     * @shortname date to iso string
+     * @drawable false
+     */
+    toISOString(inputs: Inputs.Dates.DateDto): string;
+    /**
+     * Returns a date as a string value in JSON format.
+     * @param inputs a date
+     * @returns date as string
+     * @group convert
+     * @shortname date to json
+     * @drawable false
+     */
+    toJSON(inputs: Inputs.Dates.DateDto): string;
+    /**
+     * Returns a string representation of a date. The format of the string depends on the locale.
+     * @param inputs a date
+     * @returns date as string
+     * @group convert
+     * @shortname date to locale string
+     * @drawable false
+     */
+    toString(inputs: Inputs.Dates.DateDto): string;
+    /**
+     * Returns a time as a string value.
+     * @param inputs a date
+     * @returns time as string
+     * @group convert
+     * @shortname date to time string
+     * @drawable false
+     */
+    toTimeString(inputs: Inputs.Dates.DateDto): string;
+    /**
+     * Returns a date converted to a string using Universal Coordinated Time (UTC).
+     * @param inputs a date
+     * @returns date as utc string
+     * @group convert
+     * @shortname date to utc string
+     * @drawable false
+     */
+    toUTCString(inputs: Inputs.Dates.DateDto): string;
+    /**
+     * Returns the current date and time.
+     * @returns date
+     * @group create
+     * @shortname now
+     * @drawable false
+     */
+    now(): Date;
+    /**
+     * Creates a new date object using the provided date params.
+     * @param inputs a date
+     * @returns date
+     * @group create
+     * @shortname create date
+     * @drawable false
+     */
+    createDate(inputs: Inputs.Dates.CreateDateDto): Date;
+    /**
+     * Returns the number of milliseconds between midnight, January 1, 1970 Universal Coordinated Time (UTC) (or GMT) and the specified date.
+     * @param inputs a date
+     * @returns date
+     * @group create
+     * @shortname create utc date
+     * @drawable false
+     */
+    createDateUTC(inputs: Inputs.Dates.CreateDateDto): Date;
+    /**
+     * Creates a new date object using the provided unix time stamp.
+     * @param inputs a unix time stamp
+     * @returns date
+     * @group create
+     * @shortname create from unix timestamp
+     * @drawable false
+     */
+    createFromUnixTimeStamp(inputs: Inputs.Dates.CreateFromUnixTimeStampDto): Date;
+    /**
+     * Parses a string containing a date, and returns the number of milliseconds between that date and midnight, January 1, 1970.
+     * @param inputs a date string
+     * @returns the number of milliseconds between that date and midnight, January 1, 1970.
+     * @group parse
+     * @shortname parse date string
+     * @drawable false
+     */
+    parseDate(inputs: Inputs.Dates.DateStringDto): number;
+    /**
+     * Gets the day-of-the-month, using local time.
+     * @returns date
+     * @group get
+     * @shortname get date of month
+     * @drawable false
+     */
+    getDayOfMonth(inputs: Inputs.Dates.DateDto): number;
+    /**
+     * Gets the day of the week, using local time.
+     * @returns day
+     * @group get
+     * @shortname get weekday
+     * @drawable false
+     */
+    getWeekday(inputs: Inputs.Dates.DateDto): number;
+    /**
+     * Gets the year, using local time.
+     * @returns year
+     * @group get
+     * @shortname get year
+     * @drawable false
+     */
+    getYear(inputs: Inputs.Dates.DateDto): number;
+    /**
+     * Gets the month, using local time.
+     * @returns month
+     * @group get
+     * @shortname get month
+     * @drawable false
+     */
+    getMonth(inputs: Inputs.Dates.DateDto): number;
+    /**
+     * Gets the hours in a date, using local time.
+     * @returns hours
+     * @group get
+     * @shortname get hours
+     * @drawable false
+     */
+    getHours(inputs: Inputs.Dates.DateDto): number;
+    /**
+     * Gets the minutes of a Date object, using local time.
+     * @returns minutes
+     * @group get
+     * @shortname get minutes
+     * @drawable false
+     */
+    getMinutes(inputs: Inputs.Dates.DateDto): number;
+    /**
+     * Gets the seconds of a Date object, using local time.
+     * @returns seconds
+     * @group get
+     * @shortname get seconds
+     * @drawable false
+     */
+    getSeconds(inputs: Inputs.Dates.DateDto): number;
+    /**
+     * Gets the milliseconds of a Date, using local time.
+     * @returns milliseconds
+     * @group get
+     * @shortname get milliseconds
+     * @drawable false
+     */
+    getMilliseconds(inputs: Inputs.Dates.DateDto): number;
+    /**
+     * Returns the stored time value in milliseconds since midnight, January 1, 1970 UTC.
+     * @returns time
+     * @group get
+     * @shortname get time
+     * @drawable false
+     */
+    getTime(inputs: Inputs.Dates.DateDto): number;
+    /**
+     * Gets the year using Universal Coordinated Time (UTC).
+     * @returns year
+     * @group get
+     * @shortname get utc year
+     * @drawable false
+     */
+    getUTCYear(inputs: Inputs.Dates.DateDto): number;
+    /**
+     * Gets the month of a Date object using Universal Coordinated Time (UTC).
+     * @returns month
+     * @group get
+     * @shortname get utc month
+     * @drawable false
+     */
+    getUTCMonth(inputs: Inputs.Dates.DateDto): number;
+    /**
+     * Gets the day-of-the-month, using Universal Coordinated Time (UTC).
+     * @returns day
+     * @group get
+     * @shortname get utc day
+     * @drawable false
+     */
+    getUTCDay(inputs: Inputs.Dates.DateDto): number;
+    /**
+     * Gets the hours value in a Date object using Universal Coordinated Time (UTC).
+     * @returns hours
+     * @group get
+     * @shortname get utc hours
+     * @drawable false
+     */
+    getUTCHours(inputs: Inputs.Dates.DateDto): number;
+    /**
+     * Gets the minutes of a Date object using Universal Coordinated Time (UTC).
+     * @returns minutes
+     * @group get
+     * @shortname get utc minutes
+     * @drawable false
+     */
+    getUTCMinutes(inputs: Inputs.Dates.DateDto): number;
+    /**
+     * Gets the seconds of a Date object using Universal Coordinated Time (UTC).
+     * @returns seconds
+     * @group get
+     * @shortname get utc seconds
+     * @drawable false
+     */
+    getUTCSeconds(inputs: Inputs.Dates.DateDto): number;
+    /**
+     * Gets the milliseconds of a Date object using Universal Coordinated Time (UTC).
+     * @returns milliseconds
+     * @group get
+     * @shortname get utc milliseconds
+     * @drawable false
+     */
+    getUTCMilliseconds(inputs: Inputs.Dates.DateDto): number;
+    /**
+     * Sets the year of the Date object using local time.
+     * @param inputs a date and the year
+     * @returns date
+     * @group set
+     * @shortname set year
+     * @drawable false
+     * */
+    setYear(inputs: Inputs.Dates.DateYearDto): Date;
+    /**
+     * Sets the month value in the Date object using local time.
+     * @param inputs a date and the month
+     * @returns date
+     * @group set
+     * @shortname set month
+     * @drawable false
+     * */
+    setMonth(inputs: Inputs.Dates.DateMonthDto): Date;
+    /**
+     * Sets the numeric day-of-the-month value of the Date object using local time.
+     * @param inputs a date and the day
+     * @returns date
+     * @group set
+     * @shortname set day of month
+     * @drawable false
+     */
+    setDayOfMonth(inputs: Inputs.Dates.DateDayDto): Date;
+    /**
+     * Sets the hour value in the Date object using local time.
+     * @param inputs a date and the hours
+     * @returns date
+     * @group set
+     * @shortname set hours
+     * @drawable false
+     * */
+    setHours(inputs: Inputs.Dates.DateHoursDto): Date;
+    /**
+     * Sets the minutes value in the Date object using local time.
+     * @param inputs a date and the minutes
+     * @returns date
+     * @group set
+     * @shortname set minutes
+     * @drawable false
+     * */
+    setMinutes(inputs: Inputs.Dates.DateMinutesDto): Date;
+    /**
+     * Sets the seconds value in the Date object using local time.
+     * @param inputs a date and the seconds
+     * @returns date
+     * @group set
+     * @shortname set seconds
+     * @drawable false
+     */
+    setSeconds(inputs: Inputs.Dates.DateSecondsDto): Date;
+    /**
+     * Sets the milliseconds value in the Date object using local time.
+     * @param inputs a date and the milliseconds
+     * @returns date
+     * @group set
+     * @shortname set milliseconds
+     * @drawable false
+     */
+    setMilliseconds(inputs: Inputs.Dates.DateMillisecondsDto): Date;
+    /**
+     * Sets the date and time value in the Date object.
+     * @param inputs a date and the time
+     * @returns date
+     * @group set
+     * @shortname set time
+     * @drawable false
+     */
+    setTime(inputs: Inputs.Dates.DateTimeDto): Date;
+    /**
+     * Sets the year value in the Date object using Universal Coordinated Time (UTC).
+     * @param inputs a date and the year
+     * @returns date
+     * @group set
+     * @shortname set utc year
+     * @drawable false
+     * */
+    setUTCYear(inputs: Inputs.Dates.DateYearDto): Date;
+    /**
+     * Sets the month value in the Date object using Universal Coordinated Time (UTC).
+     * @param inputs a date and the month
+     * @returns date
+     * @group set
+     * @shortname set utc month
+     * @drawable false
+     * */
+    setUTCMonth(inputs: Inputs.Dates.DateMonthDto): Date;
+    /**
+     * Sets the numeric day of the month in the Date object using Universal Coordinated Time (UTC).
+     * @param inputs a date and the day
+     * @returns date
+     * @group set
+     * @shortname set utc day
+     * @drawable false
+     */
+    setUTCDay(inputs: Inputs.Dates.DateDayDto): Date;
+    /**
+     * Sets the hours value in the Date object using Universal Coordinated Time (UTC).
+     * @param inputs a date and the hours
+     * @returns date
+     * @group set
+     * @shortname set utc hours
+     * @drawable false
+     * */
+    setUTCHours(inputs: Inputs.Dates.DateHoursDto): Date;
+    /**
+     * Sets the minutes value in the Date object using Universal Coordinated Time (UTC).
+     * @param inputs a date and the minutes
+     * @returns date
+     * @group set
+     * @shortname set utc minutes
+     * @drawable false
+     * */
+    setUTCMinutes(inputs: Inputs.Dates.DateMinutesDto): Date;
+    /**
+     * Sets the seconds value in the Date object using Universal Coordinated Time (UTC).
+     * @param inputs a date and the seconds
+     * @returns date
+     * @group set
+     * @shortname set utc seconds
+     * @drawable false
+     */
+    setUTCSeconds(inputs: Inputs.Dates.DateSecondsDto): Date;
+    /**
+     * Sets the milliseconds value in the Date object using Universal Coordinated Time (UTC).
+     * @param inputs a date and the milliseconds
+     * @returns date
+     * @group set
+     * @shortname set utc milliseconds
+     * @drawable false
+     */
+    setUTCMilliseconds(inputs: Inputs.Dates.DateMillisecondsDto): Date;
+}