@bitbybit-dev/base 0.19.9 → 0.20.1

package/lib/api/services/dates.js

@@ -0,0 +1,450 @@
+/**
+ * Contains various date methods.
+ */
+export 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) {
+        return inputs.date.toDateString();
+    }
+    /**
+     * 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) {
+        return inputs.date.toISOString();
+    }
+    /**
+     * 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) {
+        return inputs.date.toJSON();
+    }
+    /**
+     * 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) {
+        return inputs.date.toString();
+    }
+    /**
+     * 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) {
+        return inputs.date.toTimeString();
+    }
+    /**
+     * 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) {
+        return inputs.date.toUTCString();
+    }
+    /**
+     * Returns the current date and time.
+     * @returns date
+     * @group create
+     * @shortname now
+     * @drawable false
+     */
+    now() {
+        return new Date(Date.now());
+    }
+    /**
+     * 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) {
+        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.
+     * @param inputs a date
+     * @returns date
+     * @group create
+     * @shortname create utc date
+     * @drawable false
+     */
+    createDateUTC(inputs) {
+        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.
+     * @param inputs a unix time stamp
+     * @returns date
+     * @group create
+     * @shortname create from unix timestamp
+     * @drawable false
+     */
+    createFromUnixTimeStamp(inputs) {
+        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.
+     * @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) {
+        return Date.parse(inputs.dateString);
+    }
+    /**
+     * Gets the day-of-the-month, using local time.
+     * @returns date
+     * @group get
+     * @shortname get date of month
+     * @drawable false
+     */
+    getDayOfMonth(inputs) {
+        return inputs.date.getDate();
+    }
+    /**
+     * Gets the day of the week, using local time.
+     * @returns day
+     * @group get
+     * @shortname get weekday
+     * @drawable false
+     */
+    getWeekday(inputs) {
+        return inputs.date.getDay();
+    }
+    /**
+     * Gets the year, using local time.
+     * @returns year
+     * @group get
+     * @shortname get year
+     * @drawable false
+     */
+    getYear(inputs) {
+        return inputs.date.getFullYear();
+    }
+    /**
+     * Gets the month, using local time.
+     * @returns month
+     * @group get
+     * @shortname get month
+     * @drawable false
+     */
+    getMonth(inputs) {
+        return inputs.date.getMonth();
+    }
+    /**
+     * Gets the hours in a date, using local time.
+     * @returns hours
+     * @group get
+     * @shortname get hours
+     * @drawable false
+     */
+    getHours(inputs) {
+        return inputs.date.getHours();
+    }
+    /**
+     * Gets the minutes of a Date object, using local time.
+     * @returns minutes
+     * @group get
+     * @shortname get minutes
+     * @drawable false
+     */
+    getMinutes(inputs) {
+        return inputs.date.getMinutes();
+    }
+    /**
+     * Gets the seconds of a Date object, using local time.
+     * @returns seconds
+     * @group get
+     * @shortname get seconds
+     * @drawable false
+     */
+    getSeconds(inputs) {
+        return inputs.date.getSeconds();
+    }
+    /**
+     * Gets the milliseconds of a Date, using local time.
+     * @returns milliseconds
+     * @group get
+     * @shortname get milliseconds
+     * @drawable false
+     */
+    getMilliseconds(inputs) {
+        return inputs.date.getMilliseconds();
+    }
+    /**
+     * Returns the stored time value in milliseconds since midnight, January 1, 1970 UTC.
+     * @returns time
+     * @group get
+     * @shortname get time
+     * @drawable false
+     */
+    getTime(inputs) {
+        return inputs.date.getTime();
+    }
+    /**
+     * Gets the year using Universal Coordinated Time (UTC).
+     * @returns year
+     * @group get
+     * @shortname get utc year
+     * @drawable false
+     */
+    getUTCYear(inputs) {
+        return inputs.date.getUTCFullYear();
+    }
+    /**
+     * Gets the month of a Date object using Universal Coordinated Time (UTC).
+     * @returns month
+     * @group get
+     * @shortname get utc month
+     * @drawable false
+     */
+    getUTCMonth(inputs) {
+        return inputs.date.getUTCMonth();
+    }
+    /**
+     * Gets the day-of-the-month, using Universal Coordinated Time (UTC).
+     * @returns day
+     * @group get
+     * @shortname get utc day
+     * @drawable false
+     */
+    getUTCDay(inputs) {
+        return inputs.date.getUTCDate();
+    }
+    /**
+     * 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) {
+        return inputs.date.getUTCHours();
+    }
+    /**
+     * Gets the minutes of a Date object using Universal Coordinated Time (UTC).
+     * @returns minutes
+     * @group get
+     * @shortname get utc minutes
+     * @drawable false
+     */
+    getUTCMinutes(inputs) {
+        return inputs.date.getUTCMinutes();
+    }
+    /**
+     * Gets the seconds of a Date object using Universal Coordinated Time (UTC).
+     * @returns seconds
+     * @group get
+     * @shortname get utc seconds
+     * @drawable false
+     */
+    getUTCSeconds(inputs) {
+        return inputs.date.getUTCSeconds();
+    }
+    /**
+     * Gets the milliseconds of a Date object using Universal Coordinated Time (UTC).
+     * @returns milliseconds
+     * @group get
+     * @shortname get utc milliseconds
+     * @drawable false
+     */
+    getUTCMilliseconds(inputs) {
+        return inputs.date.getUTCMilliseconds();
+    }
+    /**
+     * 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) {
+        return new Date(inputs.date.setFullYear(inputs.year));
+    }
+    /**
+     * 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) {
+        return new Date(inputs.date.setMonth(inputs.month));
+    }
+    /**
+     * 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) {
+        return new Date(inputs.date.setDate(inputs.day));
+    }
+    /**
+     * 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) {
+        return new Date(inputs.date.setHours(inputs.hours));
+    }
+    /**
+     * 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) {
+        return new Date(inputs.date.setMinutes(inputs.minutes));
+    }
+    /**
+     * 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) {
+        return new Date(inputs.date.setSeconds(inputs.seconds));
+    }
+    /**
+     * 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) {
+        return new Date(inputs.date.setMilliseconds(inputs.milliseconds));
+    }
+    /**
+     * 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) {
+        return new Date(inputs.date.setTime(inputs.time));
+    }
+    /**
+     * 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) {
+        return new Date(inputs.date.setUTCFullYear(inputs.year));
+    }
+    /**
+     * 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) {
+        return new Date(inputs.date.setUTCMonth(inputs.month));
+    }
+    /**
+     * 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) {
+        return new Date(inputs.date.setUTCDate(inputs.day));
+    }
+    /**
+     * 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) {
+        return new Date(inputs.date.setUTCHours(inputs.hours));
+    }
+    /**
+     * 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) {
+        return new Date(inputs.date.setUTCMinutes(inputs.minutes));
+    }
+    /**
+     * 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) {
+        return new Date(inputs.date.setUTCSeconds(inputs.seconds));
+    }
+    /**
+     * 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) {
+        return new Date(inputs.date.setUTCMilliseconds(inputs.milliseconds));
+    }
+}

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

@@ -4,6 +4,7 @@ export * from "./logic";
 export * from "./math";
 export * from "./point";
 export * from "./text";
+export * from "./dates";
 export * from "./vector";
 export * from "./transforms";
 export * from "./geometry-helper";

package/lib/api/services/index.js

@@ -4,6 +4,7 @@ export * from "./logic";
 export * from "./math";
 export * from "./point";
 export * from "./text";
+export * from "./dates";
 export * from "./vector";
 export * from "./transforms";
 export * from "./geometry-helper";

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

@@ -1,6 +1,7 @@
 import { GeometryHelper } from "./geometry-helper";
 import * as Inputs from "../inputs";
 import { Transforms } from "./transforms";
+import { Vector } from "./vector";
 /**
  * Contains various methods for points. Point in bitbybit is simply an array containing 3 numbers for [x, y, z].
  * Because of this form Point can be interchanged with Vector, which also is an array in [x, y, z] form.
@@ -9,7 +10,8 @@ import { Transforms } from "./transforms";
 export declare class Point {
     private readonly geometryHelper;
     private readonly transforms;
-    constructor(geometryHelper: GeometryHelper, transforms: Transforms);
+    private readonly vector;
+    constructor(geometryHelper: GeometryHelper, transforms: Transforms, vector: Vector);
     /**
      * Transforms the single point
      * @param inputs Contains a point and the transformations to apply
@@ -82,6 +84,15 @@ export declare class Point {
      * @drawable true
      */
     rotatePointsCenterAxis(inputs: Inputs.Point.RotatePointsCenterAxisDto): Inputs.Base.Point3[];
+    /**
+     * Gets a bounding box of the points
+     * @param inputs Points
+     * @returns Bounding box of points
+     * @group extract
+     * @shortname bounding box pts
+     * @drawable true
+     */
+    boundingBoxOfPoints(inputs: Inputs.Point.PointsDto): Inputs.Base.BoundingBox;
     /**
      * Measures the closest distance between a point and a collection of points
      * @param inputs Point from which to measure and points to measure the distance against
@@ -218,5 +229,14 @@ export declare class Point {
      * @drawable true
      */
     removeConsecutiveDuplicates(inputs: Inputs.Point.RemoveConsecutiveDuplicatesDto): Inputs.Base.Point3[];
+    /**
+     * Creates a normal vector from 3 points
+     * @param inputs Three points and the reverse normal flag
+     * @returns Normal vector
+     * @group create
+     * @shortname normal from 3 points
+     * @drawable true
+     */
+    normalFromThreePoints(inputs: Inputs.Point.ThreePointsNormalDto): Inputs.Base.Vector3;
     private closestPointFromPointData;
 }

package/lib/api/services/point.js

@@ -4,9 +4,10 @@
  * When creating 2D points, z coordinate is simply set to 0 - [x, y, 0].
  */
 export class Point {
-    constructor(geometryHelper, transforms) {
+    constructor(geometryHelper, transforms, vector) {
         this.geometryHelper = geometryHelper;
         this.transforms = transforms;
+        this.vector = vector;
     }
     /**
      * Transforms the single point
@@ -114,6 +115,42 @@ export class Point {
         const rotationTransforms = this.transforms.rotationCenterAxis({ center: inputs.center, axis: inputs.axis, angle: inputs.angle });
         return this.geometryHelper.transformControlPoints(rotationTransforms, inputs.points);
     }
+    /**
+     * Gets a bounding box of the points
+     * @param inputs Points
+     * @returns Bounding box of points
+     * @group extract
+     * @shortname bounding box pts
+     * @drawable true
+     */
+    boundingBoxOfPoints(inputs) {
+        const xVals = [];
+        const yVals = [];
+        const zVals = [];
+        inputs.points.forEach(pt => {
+            xVals.push(pt[0]);
+            yVals.push(pt[1]);
+            zVals.push(pt[2]);
+        });
+        const min = [Math.min(...xVals), Math.min(...yVals), Math.min(...zVals)];
+        const max = [Math.max(...xVals), Math.max(...yVals), Math.max(...zVals)];
+        const center = [
+            (min[0] + max[0]) / 2,
+            (min[1] + max[1]) / 2,
+            (min[2] + max[2]) / 2,
+        ];
+        const width = max[0] - min[0];
+        const height = max[1] - min[1];
+        const length = max[2] - min[2];
+        return {
+            min,
+            max,
+            center,
+            width,
+            height,
+            length,
+        };
+    }
     /**
      * Measures the closest distance between a point and a collection of points
      * @param inputs Point from which to measure and points to measure the distance against
@@ -333,6 +370,47 @@ export class Point {
     removeConsecutiveDuplicates(inputs) {
         return this.geometryHelper.removeConsecutivePointDuplicates(inputs.points, inputs.checkFirstAndLast, inputs.tolerance);
     }
+    /**
+     * Creates a normal vector from 3 points
+     * @param inputs Three points and the reverse normal flag
+     * @returns Normal vector
+     * @group create
+     * @shortname normal from 3 points
+     * @drawable true
+     */
+    normalFromThreePoints(inputs) {
+        const p1 = inputs.point1;
+        const p2 = inputs.point2;
+        const p3 = inputs.point3;
+        if (!p1 || !p2 || !p3 || p1.length !== 3 || p2.length !== 3 || p3.length !== 3) {
+            throw new Error("All points must be arrays of 3 numbers [x, y, z]");
+        }
+        // Calculate vector A = p2 - p1
+        const ax = p2[0] - p1[0];
+        const ay = p2[1] - p1[1];
+        const az = p2[2] - p1[2];
+        // Calculate vector B = p3 - p1
+        const bx = p3[0] - p1[0];
+        const by = p3[1] - p1[1];
+        const bz = p3[2] - p1[2];
+        // Calculate the cross product N = A x B
+        let nx = (ay * bz) - (az * by);
+        let ny = (az * bx) - (ax * bz);
+        let nz = (ax * by) - (ay * bx);
+        // Check for collinear points (resulting in a zero vector)
+        // A zero vector indicates the points don't form a unique plane.
+        // You might want to handle this case depending on your application.
+        if (nx === 0 && ny === 0 && nz === 0) {
+            console.warn("Points are collinear or coincident; cannot calculate a unique normal.");
+            return undefined; // Or return [0, 0, 0] if that's acceptable
+        }
+        if (inputs.reverseNormal) {
+            nx = -nx;
+            ny = -ny;
+            nz = -nz;
+        }
+        return this.vector.normalized({ vector: [nx, ny, nz] });
+    }
     closestPointFromPointData(inputs) {
         let distance = Number.MAX_SAFE_INTEGER;
         let closestPointIndex;

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

@@ -1,8 +1,12 @@
 import * as Inputs from "../inputs";
+import * as Models from "../models";
+import { Point } from "./point";
 /**
  * Contains various text methods.
  */
 export declare class TextBitByBit {
+    private readonly point;
+    constructor(point: Point);
     /**
      * Creates a text
      * @param inputs a text
@@ -66,4 +70,24 @@ export declare class TextBitByBit {
      * @drawable false
      */
     format(inputs: Inputs.Text.TextFormatDto): string;
+    /**
+     * Creates a vector segments for character and includes width and height information
+     * @param inputs a text
+     * @returns width, height and segments as json
+     * @group vector
+     * @shortname vector char
+     * @drawable false
+     */
+    vectorChar(inputs: Inputs.Text.VectorCharDto): Models.Text.VectorCharData;
+    /**
+     * Creates a vector text lines for a given text and includes width and height information
+     * @param inputs a text as string
+     * @returns segments
+     * @group vector
+     * @shortname vector text
+     * @drawable false
+     */
+    vectorText(inputs: Inputs.Text.VectorTextDto): Models.Text.VectorTextData[];
+    private vectorParamsChar;
+    private translateLine;
 }