@bitbybit-dev/base 0.20.13 → 0.21.0

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

@@ -4,7 +4,8 @@ import * as Inputs from "../inputs";
  */
 export declare class Dates {
     /**
-     * Returns a date as a string value.
+     * Converts date to human-readable date string (excludes time).
+     * Example: Date(2024,0,15,14,30) → 'Mon Jan 15 2024'
      * @param inputs a date
      * @returns date as string
      * @group convert
@@ -13,7 +14,8 @@ export declare class Dates {
      */
     toDateString(inputs: Inputs.Dates.DateDto): string;
     /**
-     * Returns a date as a string value in ISO format.
+     * Converts date to ISO 8601 format string (standard format for APIs and data interchange).
+     * Example: Date(2024,0,15,14,30,45) → '2024-01-15T14:30:45.000Z'
      * @param inputs a date
      * @returns date as string
      * @group convert
@@ -22,7 +24,8 @@ export declare class Dates {
      */
     toISOString(inputs: Inputs.Dates.DateDto): string;
     /**
-     * Returns a date as a string value in JSON format.
+     * Converts date to JSON-compatible string (same as ISO format, used in JSON.stringify).
+     * Example: Date(2024,0,15,14,30) → '2024-01-15T14:30:00.000Z'
      * @param inputs a date
      * @returns date as string
      * @group convert
@@ -31,7 +34,8 @@ export declare class Dates {
      */
     toJSON(inputs: Inputs.Dates.DateDto): string;
     /**
-     * Returns a string representation of a date. The format of the string depends on the locale.
+     * Converts date to full locale-specific string (includes date, time, and timezone).
+     * Example: Date(2024,0,15,14,30) → 'Mon Jan 15 2024 14:30:00 GMT+0000'
      * @param inputs a date
      * @returns date as string
      * @group convert
@@ -40,7 +44,8 @@ export declare class Dates {
      */
     toString(inputs: Inputs.Dates.DateDto): string;
     /**
-     * Returns a time as a string value.
+     * Converts date to time string (excludes date, includes timezone).
+     * Example: Date(2024,0,15,14,30,45) → '14:30:45 GMT+0000'
      * @param inputs a date
      * @returns time as string
      * @group convert
@@ -49,7 +54,8 @@ export declare class Dates {
      */
     toTimeString(inputs: Inputs.Dates.DateDto): string;
     /**
-     * Returns a date converted to a string using Universal Coordinated Time (UTC).
+     * Converts date to UTC string format (Universal Coordinated Time, no timezone offset).
+     * Example: Date(2024,0,15,14,30) → 'Mon, 15 Jan 2024 14:30:00 GMT'
      * @param inputs a date
      * @returns date as utc string
      * @group convert
@@ -58,7 +64,8 @@ export declare class Dates {
      */
     toUTCString(inputs: Inputs.Dates.DateDto): string;
     /**
-     * Returns the current date and time.
+     * Returns the current date and time at the moment of execution.
+     * Example: calling now() → Date object representing current moment (e.g., '2024-01-15T14:30:45')
      * @returns date
      * @group create
      * @shortname now
@@ -66,7 +73,9 @@ export declare class Dates {
      */
     now(): Date;
     /**
-     * Creates a new date object using the provided date params.
+     * Creates a new date from individual components using local time.
+     * Month is 0-indexed: 0=January, 11=December.
+     * Example: year=2024, month=0, day=15, hours=14, minutes=30 → Date(Jan 15, 2024 14:30)
      * @param inputs a date
      * @returns date
      * @group create
@@ -75,7 +84,9 @@ export declare class Dates {
      */
     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.
+     * Creates a new date from individual components using UTC (ignores timezone).
+     * Returns milliseconds since Unix epoch (Jan 1, 1970 00:00:00 UTC).
+     * Example: year=2024, month=0, day=15 → Date representing Jan 15, 2024 00:00 UTC
      * @param inputs a date
      * @returns date
      * @group create
@@ -84,7 +95,8 @@ export declare class Dates {
      */
     createDateUTC(inputs: Inputs.Dates.CreateDateDto): Date;
     /**
-     * Creates a new date object using the provided unix time stamp.
+     * Creates a date from Unix timestamp (milliseconds since Jan 1, 1970 UTC).
+     * Example: unixTimeStamp=1705329000000 → Date(Jan 15, 2024 14:30:00)
      * @param inputs a unix time stamp
      * @returns date
      * @group create
@@ -93,7 +105,8 @@ export declare class Dates {
      */
     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.
+     * Parses a date string and returns Unix timestamp (milliseconds since Jan 1, 1970 UTC).
+     * Example: dateString='2024-01-15' → 1705276800000
      * @param inputs a date string
      * @returns the number of milliseconds between that date and midnight, January 1, 1970.
      * @group parse
@@ -102,7 +115,8 @@ export declare class Dates {
      */
     parseDate(inputs: Inputs.Dates.DateStringDto): number;
     /**
-     * Gets the day-of-the-month, using local time.
+     * Extracts day of the month from date (1-31) using local time.
+     * Example: Date(2024,0,15) → 15
      * @returns date
      * @group get
      * @shortname get date of month
@@ -110,7 +124,8 @@ export declare class Dates {
      */
     getDayOfMonth(inputs: Inputs.Dates.DateDto): number;
     /**
-     * Gets the day of the week, using local time.
+     * Extracts day of the week from date (0=Sunday, 6=Saturday) using local time.
+     * Example: Date(2024,0,15) → 1 (Monday)
      * @returns day
      * @group get
      * @shortname get weekday
@@ -118,7 +133,8 @@ export declare class Dates {
      */
     getWeekday(inputs: Inputs.Dates.DateDto): number;
     /**
-     * Gets the year, using local time.
+     * Extracts full year from date using local time.
+     * Example: Date(2024,0,15) → 2024
      * @returns year
      * @group get
      * @shortname get year
@@ -126,7 +142,8 @@ export declare class Dates {
      */
     getYear(inputs: Inputs.Dates.DateDto): number;
     /**
-     * Gets the month, using local time.
+     * Extracts month from date (0=January, 11=December) using local time.
+     * Example: Date(2024,0,15) → 0 (January)
      * @returns month
      * @group get
      * @shortname get month
@@ -134,7 +151,8 @@ export declare class Dates {
      */
     getMonth(inputs: Inputs.Dates.DateDto): number;
     /**
-     * Gets the hours in a date, using local time.
+     * Extracts hours from date (0-23) using local time.
+     * Example: Date(2024,0,15,14,30) → 14
      * @returns hours
      * @group get
      * @shortname get hours
@@ -142,7 +160,8 @@ export declare class Dates {
      */
     getHours(inputs: Inputs.Dates.DateDto): number;
     /**
-     * Gets the minutes of a Date object, using local time.
+     * Extracts minutes from date (0-59) using local time.
+     * Example: Date(2024,0,15,14,30) → 30
      * @returns minutes
      * @group get
      * @shortname get minutes
@@ -150,7 +169,8 @@ export declare class Dates {
      */
     getMinutes(inputs: Inputs.Dates.DateDto): number;
     /**
-     * Gets the seconds of a Date object, using local time.
+     * Extracts seconds from date (0-59) using local time.
+     * Example: Date(2024,0,15,14,30,45) → 45
      * @returns seconds
      * @group get
      * @shortname get seconds
@@ -158,7 +178,8 @@ export declare class Dates {
      */
     getSeconds(inputs: Inputs.Dates.DateDto): number;
     /**
-     * Gets the milliseconds of a Date, using local time.
+     * Extracts milliseconds from date (0-999) using local time.
+     * Example: Date(2024,0,15,14,30,45,123) → 123
      * @returns milliseconds
      * @group get
      * @shortname get milliseconds
@@ -166,7 +187,8 @@ export declare class Dates {
      */
     getMilliseconds(inputs: Inputs.Dates.DateDto): number;
     /**
-     * Returns the stored time value in milliseconds since midnight, January 1, 1970 UTC.
+     * Converts date to Unix timestamp (milliseconds since Jan 1, 1970 UTC).
+     * Example: Date(2024,0,15,14,30) → 1705329000000
      * @returns time
      * @group get
      * @shortname get time
@@ -174,7 +196,8 @@ export declare class Dates {
      */
     getTime(inputs: Inputs.Dates.DateDto): number;
     /**
-     * Gets the year using Universal Coordinated Time (UTC).
+     * Extracts full year from date using UTC (ignores timezone).
+     * Example: Date(2024,0,15) → 2024
      * @returns year
      * @group get
      * @shortname get utc year
@@ -182,7 +205,8 @@ export declare class Dates {
      */
     getUTCYear(inputs: Inputs.Dates.DateDto): number;
     /**
-     * Gets the month of a Date object using Universal Coordinated Time (UTC).
+     * Extracts month from date (0=January, 11=December) using UTC.
+     * Example: Date.UTC(2024,0,15) → 0 (January)
      * @returns month
      * @group get
      * @shortname get utc month
@@ -190,7 +214,8 @@ export declare class Dates {
      */
     getUTCMonth(inputs: Inputs.Dates.DateDto): number;
     /**
-     * Gets the day-of-the-month, using Universal Coordinated Time (UTC).
+     * Extracts day of the month from date (1-31) using UTC.
+     * Example: Date.UTC(2024,0,15) → 15
      * @returns day
      * @group get
      * @shortname get utc day
@@ -198,7 +223,8 @@ export declare class Dates {
      */
     getUTCDay(inputs: Inputs.Dates.DateDto): number;
     /**
-     * Gets the hours value in a Date object using Universal Coordinated Time (UTC).
+     * Extracts hours from date (0-23) using UTC.
+     * Example: Date.UTC(2024,0,15,14) → 14
      * @returns hours
      * @group get
      * @shortname get utc hours
@@ -206,7 +232,8 @@ export declare class Dates {
      */
     getUTCHours(inputs: Inputs.Dates.DateDto): number;
     /**
-     * Gets the minutes of a Date object using Universal Coordinated Time (UTC).
+     * Extracts minutes from date (0-59) using UTC.
+     * Example: Date.UTC(2024,0,15,14,30) → 30
      * @returns minutes
      * @group get
      * @shortname get utc minutes
@@ -214,7 +241,8 @@ export declare class Dates {
      */
     getUTCMinutes(inputs: Inputs.Dates.DateDto): number;
     /**
-     * Gets the seconds of a Date object using Universal Coordinated Time (UTC).
+     * Extracts seconds from date (0-59) using UTC.
+     * Example: Date.UTC(2024,0,15,14,30,45) → 45
      * @returns seconds
      * @group get
      * @shortname get utc seconds
@@ -222,7 +250,8 @@ export declare class Dates {
      */
     getUTCSeconds(inputs: Inputs.Dates.DateDto): number;
     /**
-     * Gets the milliseconds of a Date object using Universal Coordinated Time (UTC).
+     * Extracts milliseconds from date (0-999) using UTC.
+     * Example: Date.UTC(2024,0,15,14,30,45,123) → 123
      * @returns milliseconds
      * @group get
      * @shortname get utc milliseconds
@@ -230,7 +259,8 @@ export declare class Dates {
      */
     getUTCMilliseconds(inputs: Inputs.Dates.DateDto): number;
     /**
-     * Sets the year of the Date object using local time.
+     * Creates new date with modified year (returns new date, original unchanged).
+     * Example: Date(2024,0,15) with year=2025 → Date(2025,0,15)
      * @param inputs a date and the year
      * @returns date
      * @group set
@@ -239,7 +269,8 @@ export declare class Dates {
      * */
     setYear(inputs: Inputs.Dates.DateYearDto): Date;
     /**
-     * Sets the month value in the Date object using local time.
+     * Creates new date with modified month (0=January, 11=December, returns new date).
+     * Example: Date(2024,0,15) with month=5 → Date(2024,5,15) (June 15)
      * @param inputs a date and the month
      * @returns date
      * @group set
@@ -248,7 +279,8 @@ export declare class Dates {
      * */
     setMonth(inputs: Inputs.Dates.DateMonthDto): Date;
     /**
-     * Sets the numeric day-of-the-month value of the Date object using local time.
+     * Creates new date with modified day of month (1-31, returns new date).
+     * Example: Date(2024,0,15) with day=20 → Date(2024,0,20)
      * @param inputs a date and the day
      * @returns date
      * @group set

package/lib/api/services/dates.js

@@ -3,7 +3,8 @@
  */
 export class Dates {
     /**
-     * Returns a date as a string value.
+     * Converts date to human-readable date string (excludes time).
+     * Example: Date(2024,0,15,14,30) → 'Mon Jan 15 2024'
      * @param inputs a date
      * @returns date as string
      * @group convert
@@ -14,7 +15,8 @@ export class Dates {
         return inputs.date.toDateString();
     }
     /**
-     * Returns a date as a string value in ISO format.
+     * Converts date to ISO 8601 format string (standard format for APIs and data interchange).
+     * Example: Date(2024,0,15,14,30,45) → '2024-01-15T14:30:45.000Z'
      * @param inputs a date
      * @returns date as string
      * @group convert
@@ -25,7 +27,8 @@ export class Dates {
         return inputs.date.toISOString();
     }
     /**
-     * Returns a date as a string value in JSON format.
+     * Converts date to JSON-compatible string (same as ISO format, used in JSON.stringify).
+     * Example: Date(2024,0,15,14,30) → '2024-01-15T14:30:00.000Z'
      * @param inputs a date
      * @returns date as string
      * @group convert
@@ -36,7 +39,8 @@ export class Dates {
         return inputs.date.toJSON();
     }
     /**
-     * Returns a string representation of a date. The format of the string depends on the locale.
+     * Converts date to full locale-specific string (includes date, time, and timezone).
+     * Example: Date(2024,0,15,14,30) → 'Mon Jan 15 2024 14:30:00 GMT+0000'
      * @param inputs a date
      * @returns date as string
      * @group convert
@@ -47,7 +51,8 @@ export class Dates {
         return inputs.date.toString();
     }
     /**
-     * Returns a time as a string value.
+     * Converts date to time string (excludes date, includes timezone).
+     * Example: Date(2024,0,15,14,30,45) → '14:30:45 GMT+0000'
      * @param inputs a date
      * @returns time as string
      * @group convert
@@ -58,7 +63,8 @@ export class Dates {
         return inputs.date.toTimeString();
     }
     /**
-     * Returns a date converted to a string using Universal Coordinated Time (UTC).
+     * Converts date to UTC string format (Universal Coordinated Time, no timezone offset).
+     * Example: Date(2024,0,15,14,30) → 'Mon, 15 Jan 2024 14:30:00 GMT'
      * @param inputs a date
      * @returns date as utc string
      * @group convert
@@ -69,7 +75,8 @@ export class Dates {
         return inputs.date.toUTCString();
     }
     /**
-     * Returns the current date and time.
+     * Returns the current date and time at the moment of execution.
+     * Example: calling now() → Date object representing current moment (e.g., '2024-01-15T14:30:45')
      * @returns date
      * @group create
      * @shortname now
@@ -79,7 +86,9 @@ export class Dates {
         return new Date(Date.now());
     }
     /**
-     * Creates a new date object using the provided date params.
+     * Creates a new date from individual components using local time.
+     * Month is 0-indexed: 0=January, 11=December.
+     * Example: year=2024, month=0, day=15, hours=14, minutes=30 → Date(Jan 15, 2024 14:30)
      * @param inputs a date
      * @returns date
      * @group create
@@ -90,7 +99,9 @@ export class Dates {
         return new Date(inputs.year, inputs.month, inputs.day, inputs.hours, inputs.minutes, inputs.seconds, inputs.milliseconds);
     }
     /**
-     * Returns the number of milliseconds between midnight, January 1, 1970 Universal Coordinated Time (UTC) (or GMT) and the specified date.
+     * Creates a new date from individual components using UTC (ignores timezone).
+     * Returns milliseconds since Unix epoch (Jan 1, 1970 00:00:00 UTC).
+     * Example: year=2024, month=0, day=15 → Date representing Jan 15, 2024 00:00 UTC
      * @param inputs a date
      * @returns date
      * @group create
@@ -101,7 +112,8 @@ export class Dates {
         return new Date(Date.UTC(inputs.year, inputs.month, inputs.day, inputs.hours, inputs.minutes, inputs.seconds, inputs.milliseconds));
     }
     /**
-     * Creates a new date object using the provided unix time stamp.
+     * Creates a date from Unix timestamp (milliseconds since Jan 1, 1970 UTC).
+     * Example: unixTimeStamp=1705329000000 → Date(Jan 15, 2024 14:30:00)
      * @param inputs a unix time stamp
      * @returns date
      * @group create
@@ -112,7 +124,8 @@ export class Dates {
         return new Date(inputs.unixTimeStamp);
     }
     /**
-     * Parses a string containing a date, and returns the number of milliseconds between that date and midnight, January 1, 1970.
+     * Parses a date string and returns Unix timestamp (milliseconds since Jan 1, 1970 UTC).
+     * Example: dateString='2024-01-15' → 1705276800000
      * @param inputs a date string
      * @returns the number of milliseconds between that date and midnight, January 1, 1970.
      * @group parse
@@ -123,7 +136,8 @@ export class Dates {
         return Date.parse(inputs.dateString);
     }
     /**
-     * Gets the day-of-the-month, using local time.
+     * Extracts day of the month from date (1-31) using local time.
+     * Example: Date(2024,0,15) → 15
      * @returns date
      * @group get
      * @shortname get date of month
@@ -133,7 +147,8 @@ export class Dates {
         return inputs.date.getDate();
     }
     /**
-     * Gets the day of the week, using local time.
+     * Extracts day of the week from date (0=Sunday, 6=Saturday) using local time.
+     * Example: Date(2024,0,15) → 1 (Monday)
      * @returns day
      * @group get
      * @shortname get weekday
@@ -143,7 +158,8 @@ export class Dates {
         return inputs.date.getDay();
     }
     /**
-     * Gets the year, using local time.
+     * Extracts full year from date using local time.
+     * Example: Date(2024,0,15) → 2024
      * @returns year
      * @group get
      * @shortname get year
@@ -153,7 +169,8 @@ export class Dates {
         return inputs.date.getFullYear();
     }
     /**
-     * Gets the month, using local time.
+     * Extracts month from date (0=January, 11=December) using local time.
+     * Example: Date(2024,0,15) → 0 (January)
      * @returns month
      * @group get
      * @shortname get month
@@ -163,7 +180,8 @@ export class Dates {
         return inputs.date.getMonth();
     }
     /**
-     * Gets the hours in a date, using local time.
+     * Extracts hours from date (0-23) using local time.
+     * Example: Date(2024,0,15,14,30) → 14
      * @returns hours
      * @group get
      * @shortname get hours
@@ -173,7 +191,8 @@ export class Dates {
         return inputs.date.getHours();
     }
     /**
-     * Gets the minutes of a Date object, using local time.
+     * Extracts minutes from date (0-59) using local time.
+     * Example: Date(2024,0,15,14,30) → 30
      * @returns minutes
      * @group get
      * @shortname get minutes
@@ -183,7 +202,8 @@ export class Dates {
         return inputs.date.getMinutes();
     }
     /**
-     * Gets the seconds of a Date object, using local time.
+     * Extracts seconds from date (0-59) using local time.
+     * Example: Date(2024,0,15,14,30,45) → 45
      * @returns seconds
      * @group get
      * @shortname get seconds
@@ -193,7 +213,8 @@ export class Dates {
         return inputs.date.getSeconds();
     }
     /**
-     * Gets the milliseconds of a Date, using local time.
+     * Extracts milliseconds from date (0-999) using local time.
+     * Example: Date(2024,0,15,14,30,45,123) → 123
      * @returns milliseconds
      * @group get
      * @shortname get milliseconds
@@ -203,7 +224,8 @@ export class Dates {
         return inputs.date.getMilliseconds();
     }
     /**
-     * Returns the stored time value in milliseconds since midnight, January 1, 1970 UTC.
+     * Converts date to Unix timestamp (milliseconds since Jan 1, 1970 UTC).
+     * Example: Date(2024,0,15,14,30) → 1705329000000
      * @returns time
      * @group get
      * @shortname get time
@@ -213,7 +235,8 @@ export class Dates {
         return inputs.date.getTime();
     }
     /**
-     * Gets the year using Universal Coordinated Time (UTC).
+     * Extracts full year from date using UTC (ignores timezone).
+     * Example: Date(2024,0,15) → 2024
      * @returns year
      * @group get
      * @shortname get utc year
@@ -223,7 +246,8 @@ export class Dates {
         return inputs.date.getUTCFullYear();
     }
     /**
-     * Gets the month of a Date object using Universal Coordinated Time (UTC).
+     * Extracts month from date (0=January, 11=December) using UTC.
+     * Example: Date.UTC(2024,0,15) → 0 (January)
      * @returns month
      * @group get
      * @shortname get utc month
@@ -233,7 +257,8 @@ export class Dates {
         return inputs.date.getUTCMonth();
     }
     /**
-     * Gets the day-of-the-month, using Universal Coordinated Time (UTC).
+     * Extracts day of the month from date (1-31) using UTC.
+     * Example: Date.UTC(2024,0,15) → 15
      * @returns day
      * @group get
      * @shortname get utc day
@@ -243,7 +268,8 @@ export class Dates {
         return inputs.date.getUTCDate();
     }
     /**
-     * Gets the hours value in a Date object using Universal Coordinated Time (UTC).
+     * Extracts hours from date (0-23) using UTC.
+     * Example: Date.UTC(2024,0,15,14) → 14
      * @returns hours
      * @group get
      * @shortname get utc hours
@@ -253,7 +279,8 @@ export class Dates {
         return inputs.date.getUTCHours();
     }
     /**
-     * Gets the minutes of a Date object using Universal Coordinated Time (UTC).
+     * Extracts minutes from date (0-59) using UTC.
+     * Example: Date.UTC(2024,0,15,14,30) → 30
      * @returns minutes
      * @group get
      * @shortname get utc minutes
@@ -263,7 +290,8 @@ export class Dates {
         return inputs.date.getUTCMinutes();
     }
     /**
-     * Gets the seconds of a Date object using Universal Coordinated Time (UTC).
+     * Extracts seconds from date (0-59) using UTC.
+     * Example: Date.UTC(2024,0,15,14,30,45) → 45
      * @returns seconds
      * @group get
      * @shortname get utc seconds
@@ -273,7 +301,8 @@ export class Dates {
         return inputs.date.getUTCSeconds();
     }
     /**
-     * Gets the milliseconds of a Date object using Universal Coordinated Time (UTC).
+     * Extracts milliseconds from date (0-999) using UTC.
+     * Example: Date.UTC(2024,0,15,14,30,45,123) → 123
      * @returns milliseconds
      * @group get
      * @shortname get utc milliseconds
@@ -283,7 +312,8 @@ export class Dates {
         return inputs.date.getUTCMilliseconds();
     }
     /**
-     * Sets the year of the Date object using local time.
+     * Creates new date with modified year (returns new date, original unchanged).
+     * Example: Date(2024,0,15) with year=2025 → Date(2025,0,15)
      * @param inputs a date and the year
      * @returns date
      * @group set
@@ -296,7 +326,8 @@ export class Dates {
         return dateCopy;
     }
     /**
-     * Sets the month value in the Date object using local time.
+     * Creates new date with modified month (0=January, 11=December, returns new date).
+     * Example: Date(2024,0,15) with month=5 → Date(2024,5,15) (June 15)
      * @param inputs a date and the month
      * @returns date
      * @group set
@@ -309,7 +340,8 @@ export class Dates {
         return dateCopy;
     }
     /**
-     * Sets the numeric day-of-the-month value of the Date object using local time.
+     * Creates new date with modified day of month (1-31, returns new date).
+     * Example: Date(2024,0,15) with day=20 → Date(2024,0,20)
      * @param inputs a date and the day
      * @returns date
      * @group set

package/lib/api/services/geometry-helper.d.ts

@@ -1,15 +1,65 @@
 import * as Inputs from "../inputs";
 export declare class GeometryHelper {
+    /**
+     * Applies one or more 4×4 transformation matrices to a list of points sequentially.
+     * Each transformation is applied in order (composition of transformations).
+     * Example: points=[[0,0,0], [1,0,0]] with translation [5,0,0] → [[5,0,0], [6,0,0]]
+     */
     transformControlPoints(transformation: number[][] | number[][][], transformedControlPoints: Inputs.Base.Point3[]): Inputs.Base.Point3[];
+    /**
+     * Flattens nested transformation arrays into a single-level array of transformation matrices.
+     * Handles both 2D arrays (single transform list) and 3D arrays (nested transform lists).
+     * Example: [[[matrix1, matrix2]], [[matrix3]]] → [matrix1, matrix2, matrix3]
+     */
     getFlatTransformations(transformation: number[][] | number[][][]): number[][];
+    /**
+     * Calculates the nesting depth of an array recursively.
+     * Example: [1,2,3] → 1, [[1,2],[3,4]] → 2, [[[1]]] → 3
+     */
     getArrayDepth: (value: any) => number;
+    /**
+     * Applies a single 4×4 transformation matrix (as flat 16-element array) to multiple points.
+     * Example: points=[[0,0,0], [1,0,0]] with translation matrix → transformed points
+     */
     transformPointsByMatrixArray(points: Inputs.Base.Point3[], transform: number[]): Inputs.Base.Point3[];
+    /**
+     * Transforms multiple points using a transformation matrix (maps each point through the matrix).
+     * Example: points=[[1,0,0], [0,1,0]] with 90° rotation → [[0,1,0], [-1,0,0]]
+     */
     transformPointsCoordinates(points: Inputs.Base.Point3[], transform: number[]): Inputs.Base.Point3[];
+    /**
+     * Removes all duplicate vectors from a list (works with arbitrary-length numeric vectors).
+     * Compares vectors using tolerance for floating-point equality.
+     * Example: [[1,2], [3,4], [1,2], [5,6]] with tolerance=1e-7 → [[1,2], [3,4], [5,6]]
+     */
     removeAllDuplicateVectors(vectors: number[][], tolerance?: number): number[][];
+    /**
+     * Removes consecutive duplicate vectors from a list (keeps only first occurrence in each sequence).
+     * Optionally checks and removes duplicate if first and last vectors match.
+     * Example: [[1,2], [1,2], [3,4], [3,4], [5,6]] → [[1,2], [3,4], [5,6]]
+     */
     removeConsecutiveVectorDuplicates(vectors: number[][], checkFirstAndLast?: boolean, tolerance?: number): number[][];
+    /**
+     * Compares two vectors for approximate equality using tolerance (element-wise comparison).
+     * Returns false if vectors have different lengths.
+     * Example: [1.0000001, 2.0], [1.0, 2.0] with tolerance=1e-6 → true
+     */
     vectorsTheSame(vec1: number[], vec2: number[], tolerance: number): boolean;
+    /**
+     * Checks if two numbers are approximately equal within a tolerance.
+     * Example: 1.0000001, 1.0 with tolerance=1e-6 → true, 1.001, 1.0 with tolerance=1e-6 → false
+     */
     approxEq(num1: number, num2: number, tolerance: number): boolean;
+    /**
+     * Removes consecutive duplicate points from a list (specialized for 3D/2D points).
+     * Optionally checks and removes duplicate if first and last points match (for closed loops).
+     * Example: [[0,0,0], [0,0,0], [1,0,0], [1,0,0]] → [[0,0,0], [1,0,0]]
+     */
     removeConsecutivePointDuplicates(points: Inputs.Base.Point3[], checkFirstAndLast?: boolean, tolerance?: number): Inputs.Base.Point3[];
+    /**
+     * Checks if two points are approximately equal using tolerance (supports 2D and 3D points).
+     * Example: [1.0000001, 2.0, 3.0], [1.0, 2.0, 3.0] with tolerance=1e-6 → true
+     */
     arePointsTheSame(pointA: Inputs.Base.Point3 | Inputs.Base.Point2, pointB: Inputs.Base.Point3 | Inputs.Base.Point2, tolerance: number): boolean;
     private transformCoordinates;
 }