@bitbybit-dev/base 0.19.6 → 0.19.8

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

@@ -1,13 +1,17 @@
+
+import * as Inputs from "../inputs";
+import { GeometryHelper } from "./geometry-helper";
+import { MathBitByBit } from "./math";
+
 /**
  * Contains various methods for vector mathematics. Vector in bitbybit is simply an array, usually containing numbers.
  * In 3D [x, y, z] form describes space, where y is the up vector.
  * Because of this form Vector can be interchanged with Point, which also is an array in [x, y, z] form.
  */
 export class Vector {
-    constructor(math, geometryHelper) {
-        this.math = math;
-        this.geometryHelper = geometryHelper;
-    }
+
+    constructor(private readonly math: MathBitByBit, private readonly geometryHelper: GeometryHelper) { }
+
     /**
      * Removes all duplicate vectors from the input array
      * @param inputs Contains vectors and a tolerance value
@@ -16,9 +20,10 @@ export class Vector {
      * @shortname remove all duplicates
      * @drawable false
      */
-    removeAllDuplicateVectors(inputs) {
+    removeAllDuplicateVectors(inputs: Inputs.Vector.RemoveAllDuplicateVectorsDto): number[][] {
         return this.geometryHelper.removeAllDuplicateVectors(inputs.vectors, inputs.tolerance);
     }
+
     /**
      * Removes consecutive duplicate vectors from the input array
      * @param inputs Contains vectors and a tolerance value
@@ -27,7 +32,7 @@ export class Vector {
      * @shortname remove consecutive duplicates
      * @drawable false
      */
-    removeConsecutiveDuplicateVectors(inputs) {
+    removeConsecutiveDuplicateVectors(inputs: Inputs.Vector.RemoveConsecutiveDuplicateVectorsDto): number[][] {
         return this.geometryHelper.removeConsecutiveVectorDuplicates(inputs.vectors, inputs.checkFirstAndLast, inputs.tolerance);
     }
     /**
@@ -38,11 +43,12 @@ export class Vector {
      * @returns Number in degrees
      * @drawable false
      */
-    angleBetween(inputs) {
+    angleBetween(inputs: Inputs.Vector.TwoVectorsDto): number {
         return this.math.radToDeg({
             number: Math.acos(this.dot({ first: inputs.first, second: inputs.second }) / (this.norm({ vector: inputs.first }) * this.norm({ vector: inputs.second })))
         });
     }
+
     /**
      * Measures the normalized 2d angle between two vectors in degrees
      * @param inputs Contains two vectors represented as number arrays
@@ -51,12 +57,13 @@ export class Vector {
      * @shortname angle normalized 2d
      * @drawable false
      */
-    angleBetweenNormalized2d(inputs) {
+    angleBetweenNormalized2d(inputs: Inputs.Vector.TwoVectorsDto): number {
         const perpDot = inputs.first[0] * inputs.second[1] - inputs.first[1] * inputs.second[0];
         return this.math.radToDeg({
             number: Math.atan2(perpDot, this.dot({ first: inputs.first, second: inputs.second }))
         });
     }
+
     /**
      * Measures a positive angle between two vectors given the reference vector in degrees
      * @param inputs Contains information of two vectors and a reference vector
@@ -65,10 +72,11 @@ export class Vector {
      * @shortname positive angle
      * @drawable false
      */
-    positiveAngleBetween(inputs) {
+    positiveAngleBetween(inputs: Inputs.Vector.TwoVectorsReferenceDto): number {
         const angle = this.signedAngleBetween(inputs);
         return angle < 0 ? 360 + angle : angle;
     }
+
     /**
      * Adds all vector xyz values together and create a new vector
      * @param inputs Vectors to be added
@@ -77,7 +85,7 @@ export class Vector {
      * @shortname add all
      * @drawable false
      */
-    addAll(inputs) {
+    addAll(inputs: Inputs.Vector.VectorsDto): number[] {
         const res = [];
         for (let i = 0; i < inputs.vectors[0].length; i++) {
             let sum = 0;
@@ -88,6 +96,7 @@ export class Vector {
         }
         return res;
     }
+
     /**
      * Adds two vectors together
      * @param inputs Two vectors to be added
@@ -96,13 +105,14 @@ export class Vector {
      * @shortname add
      * @drawable false
      */
-    add(inputs) {
+    add(inputs: Inputs.Vector.TwoVectorsDto): number[] {
         const res = [];
         for (let i = 0; i < inputs.first.length; i++) {
             res.push(inputs.first[i] + inputs.second[i]);
         }
         return res;
     }
+
     /**
      * Checks if the boolean array contains only true values, if there's a single false it will return false.
      * @param inputs Vectors to be checked
@@ -111,9 +121,10 @@ export class Vector {
      * @shortname all
      * @drawable false
      */
-    all(inputs) {
+    all(inputs: Inputs.Vector.VectorBoolDto): boolean {
         return inputs.vector.every(v => v);
     }
+
     /**
      * Cross two vectors
      * @param inputs Two vectors to be crossed
@@ -122,13 +133,14 @@ export class Vector {
      * @returns Crossed vector
      * @drawable false
      */
-    cross(inputs) {
+    cross(inputs: Inputs.Vector.TwoVectorsDto): number[] {
         const res = [];
         res.push(inputs.first[1] * inputs.second[2] - inputs.first[2] * inputs.second[1]);
         res.push(inputs.first[2] * inputs.second[0] - inputs.first[0] * inputs.second[2]);
         res.push(inputs.first[0] * inputs.second[1] - inputs.first[1] * inputs.second[0]);
         return res;
     }
+
     /**
      * Squared distance between two vectors
      * @param inputs Two vectors
@@ -137,13 +149,14 @@ export class Vector {
      * @shortname dist squared
      * @drawable false
      */
-    distSquared(inputs) {
+    distSquared(inputs: Inputs.Vector.TwoVectorsDto): number {
         let res = 0;
         for (let i = 0; i < inputs.first.length; i++) {
             res += Math.pow(inputs.first[i] - inputs.second[i], 2);
         }
         return res;
     }
+
     /**
      * Distance between two vectors
      * @param inputs Two vectors
@@ -152,9 +165,10 @@ export class Vector {
      * @shortname dist
      * @drawable false
      */
-    dist(inputs) {
+    dist(inputs: Inputs.Vector.TwoVectorsDto): number {
         return Math.sqrt(this.distSquared(inputs));
     }
+
     /**
      * Divide the vector by a scalar value
      * @param inputs Contains vector and a scalar
@@ -163,13 +177,14 @@ export class Vector {
      * @shortname div
      * @drawable false
      */
-    div(inputs) {
+    div(inputs: Inputs.Vector.VectorScalarDto): number[] {
         const res = [];
         for (let i = 0; i < inputs.vector.length; i++) {
             res.push(inputs.vector[i] / inputs.scalar);
         }
         return res;
     }
+
     /**
      * Computes the domain between minimum and maximum values of the vector
      * @param inputs Vector information
@@ -178,9 +193,10 @@ export class Vector {
      * @shortname domain
      * @drawable false
      */
-    domain(inputs) {
+    domain(inputs: Inputs.Vector.VectorDto): number {
         return inputs.vector[inputs.vector.length - 1] - inputs.vector[0];
     }
+
     /**
      * Dot product between two vectors
      * @param inputs Two vectors
@@ -189,13 +205,14 @@ export class Vector {
      * @shortname dot
      * @drawable false
      */
-    dot(inputs) {
+    dot(inputs: Inputs.Vector.TwoVectorsDto): number {
         let res = 0;
         for (let i = 0; i < inputs.first.length; i++) {
             res += inputs.first[i] * inputs.second[i];
         }
         return res;
     }
+
     /**
      * Checks if vector is finite for each number and returns a boolean array
      * @param inputs Vector with possibly infinite values
@@ -205,9 +222,10 @@ export class Vector {
      * @shortname finite
      * @drawable false
      */
-    finite(inputs) {
+    finite(inputs: Inputs.Vector.VectorDto): boolean[] {
         return inputs.vector.map(v => isFinite(v));
     }
+
     /**
      * Checks if the vector is zero length
      * @param inputs Vector to be checked
@@ -216,9 +234,10 @@ export class Vector {
      * @shortname isZero
      * @drawable false
      */
-    isZero(inputs) {
+    isZero(inputs: Inputs.Vector.VectorDto): boolean {
         return this.norm({ vector: inputs.vector }) === 0;
     }
+
     /**
      * Finds in between vector between two vectors by providing a fracture
      * @param inputs Information for finding vector between two vectors using a fraction
@@ -227,12 +246,15 @@ export class Vector {
      * @shortname lerp
      * @drawable false
      */
-    lerp(inputs) {
-        return this.add({
-            first: this.mul({ vector: inputs.first, scalar: inputs.fraction }),
-            second: this.mul({ vector: inputs.second, scalar: 1.0 - inputs.fraction })
-        });
+    lerp(inputs: Inputs.Vector.FractionTwoVectorsDto): number[] {
+        return this.add(
+            {
+                first: this.mul({ vector: inputs.first, scalar: inputs.fraction }),
+                second: this.mul({ vector: inputs.second, scalar: 1.0 - inputs.fraction })
+            }
+        );
     }
+
     /**
      * Finds the maximum value in the vector
      * @param inputs Vector to be checked
@@ -241,9 +263,10 @@ export class Vector {
      * @shortname max
      * @drawable false
      */
-    max(inputs) {
+    max(inputs: Inputs.Vector.VectorDto): number {
         return Math.max(...inputs.vector);
     }
+
     /**
      * Finds the minimum value in the vector
      * @param inputs Vector to be checked
@@ -252,9 +275,10 @@ export class Vector {
      * @shortname min
      * @drawable false
      */
-    min(inputs) {
+    min(inputs: Inputs.Vector.VectorDto): number {
         return Math.min(...inputs.vector);
     }
+
     /**
      * Multiple vector with the scalar
      * @param inputs Vector with a scalar
@@ -263,13 +287,14 @@ export class Vector {
      * @shortname mul
      * @drawable false
      */
-    mul(inputs) {
+    mul(inputs: Inputs.Vector.VectorScalarDto): number[] {
         const res = [];
         for (let i = 0; i < inputs.vector.length; i++) {
             res.push(inputs.vector[i] * inputs.scalar);
         }
         return res;
     }
+
     /**
      * Negates the vector
      * @param inputs Vector to negate
@@ -278,13 +303,14 @@ export class Vector {
      * @shortname neg
      * @drawable false
      */
-    neg(inputs) {
+    neg(inputs: Inputs.Vector.VectorDto): number[] {
         const res = [];
         for (let i = 0; i < inputs.vector.length; i++) {
             res.push(-inputs.vector[i]);
         }
         return res;
     }
+
     /**
      * Compute squared norm
      * @param inputs Vector for squared norm
@@ -293,9 +319,10 @@ export class Vector {
      * @shortname norm squared
      * @drawable false
      */
-    normSquared(inputs) {
+    normSquared(inputs: Inputs.Vector.VectorDto): number {
         return this.dot({ first: inputs.vector, second: inputs.vector });
     }
+
     /**
      * Norm of the vector
      * @param inputs Vector to compute the norm
@@ -304,10 +331,11 @@ export class Vector {
      * @shortname norm
      * @drawable false
      */
-    norm(inputs) {
+    norm(inputs: Inputs.Vector.VectorDto): number {
         const norm2 = this.normSquared(inputs);
         return norm2 !== 0.0 ? Math.sqrt(norm2) : norm2;
     }
+
     /**
      * Normalize the vector into a unit vector, that has a length of 1
      * @param inputs Vector to normalize
@@ -316,9 +344,10 @@ export class Vector {
      * @shortname normalized
      * @drawable false
      */
-    normalized(inputs) {
+    normalized(inputs: Inputs.Vector.VectorDto): number[] {
         return this.div({ scalar: this.norm(inputs), vector: inputs.vector });
     }
+
     /**
      * Finds a point coordinates on the given distance ray that spans between the point along the direction vector
      * @param inputs Provide a point, vector and a distance for finding a point
@@ -327,9 +356,10 @@ export class Vector {
      * @shortname on ray
      * @drawable false
      */
-    onRay(inputs) {
+    onRay(inputs: Inputs.Vector.RayPointDto): number[] {
         return this.add({ first: inputs.point, second: this.mul({ vector: inputs.vector, scalar: inputs.distance }) });
     }
+
     /**
      * Create a xyz vector
      * @param inputs Vector coordinates
@@ -338,9 +368,10 @@ export class Vector {
      * @shortname vector XYZ
      * @drawable true
      */
-    vectorXYZ(inputs) {
+    vectorXYZ(inputs: Inputs.Vector.VectorXYZDto): Inputs.Base.Vector3 {
         return [inputs.x, inputs.y, inputs.z];
     }
+
     /**
      * Create 2d xy vector
      * @param inputs Vector coordinates
@@ -349,9 +380,10 @@ export class Vector {
      * @shortname vector XY
      * @drawable true
      */
-    vectorXY(inputs) {
+    vectorXY(inputs: Inputs.Vector.VectorXYDto): Inputs.Base.Vector2 {
         return [inputs.x, inputs.y];
     }
+
     /**
      * Creates a vector of integers between 0 and maximum ceiling integer
      * @param inputs Max value for the range
@@ -360,13 +392,14 @@ export class Vector {
      * @shortname range
      * @drawable false
      */
-    range(inputs) {
+    range(inputs: Inputs.Vector.RangeMaxDto): number[] {
         const res = [];
         for (let i = 0; i < inputs.max; i++) {
             res.push(i);
         }
         return res;
     }
+
     /**
      * Computes signed angle between two vectors and a reference. This will always return a smaller angle between two possible angles.
      * @param inputs Contains information of two vectors and a reference vector
@@ -375,7 +408,7 @@ export class Vector {
      * @shortname signed angle
      * @drawable false
      */
-    signedAngleBetween(inputs) {
+    signedAngleBetween(inputs: Inputs.Vector.TwoVectorsReferenceDto): number {
         const nab = this.cross({ first: inputs.first, second: inputs.second });
         const al = this.norm({ vector: inputs.first });
         const bl = this.norm({ vector: inputs.second });
@@ -388,6 +421,7 @@ export class Vector {
         const res = s > 0.0 ? w : 2 * Math.PI - w;
         return this.math.radToDeg({ number: res });
     }
+
     /**
      * Creates a vector that contains numbers spanning between minimum and maximum values at a given step
      * @param inputs Span information containing min, max and step values
@@ -396,13 +430,14 @@ export class Vector {
      * @shortname span
      * @drawable false
      */
-    span(inputs) {
+    span(inputs: Inputs.Vector.SpanDto): number[] {
         const res = [];
         for (let i = inputs.min; i <= inputs.max; i += inputs.step) {
             res.push(i);
         }
         return res;
     }
+
     /**
      * Creates a vector that contains numbers spanning between minimum and maximum values at a given ease function
      * @param inputs Span information containing min, max and ease function
@@ -411,7 +446,7 @@ export class Vector {
      * @shortname span ease items
      * @drawable false
      */
-    spanEaseItems(inputs) {
+    spanEaseItems(inputs: Inputs.Vector.SpanEaseItemsDto): number[] {
         const res = [];
         for (let i = 0; i < inputs.nrItems; i++) {
             const x = i * 1 / (inputs.nrItems - 1);
@@ -422,6 +457,7 @@ export class Vector {
         }
         return res;
     }
+
     /**
      * Creates a vector that contains numbers spanning between minimum and maximum values by giving nr of items
      * @param inputs Span information containing min, max and step values
@@ -430,7 +466,7 @@ export class Vector {
      * @shortname span linear items
      * @drawable false
      */
-    spanLinearItems(inputs) {
+    spanLinearItems(inputs: Inputs.Vector.SpanLinearItemsDto): number[] {
         const res = [];
         const dist = (inputs.max - inputs.min);
         for (let i = 0; i < inputs.nrItems; i++) {
@@ -439,6 +475,7 @@ export class Vector {
         }
         return res;
     }
+
     /**
      * Subtract two vectors
      * @param inputs Two vectors
@@ -447,13 +484,14 @@ export class Vector {
      * @shortname sub
      * @drawable false
      */
-    sub(inputs) {
+    sub(inputs: Inputs.Vector.TwoVectorsDto): number[] {
         const res = [];
         for (let i = 0; i < inputs.first.length; i++) {
             res.push(inputs.first[i] - inputs.second[i]);
         }
         return res;
     }
+
     /**
      * Sums the values of the vector
      * @param inputs Vector to sum
@@ -462,7 +500,7 @@ export class Vector {
      * @shortname sum
      * @drawable false
      */
-    sum(inputs) {
+    sum(inputs: Inputs.Vector.VectorDto): number {
         return inputs.vector.reduce((a, b) => a + b, 0);
     }
 }

package/lib/{index.d.ts → index.ts}

@@ -1 +1,2 @@
 export * from "./api";
+

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@bitbybit-dev/base",
-    "version": "0.19.6",
+    "version": "0.19.8",
     "description": "Bit By Bit Developers Base CAD Library to Program Geometry",
     "main": "index.js",
     "repository": {

package/tsconfig.bitbybit.json

@@ -0,0 +1,26 @@
+/* To learn more about this file see: https://angular.io/config/tsconfig. */
+{
+    "compileOnSave": false,
+    "exclude": [
+        "./**/*.test.ts"
+    ],
+    "compilerOptions": {
+        "outDir": "./dist",
+        "baseUrl": "./",
+        "sourceMap": false,
+        "declaration": true,
+        "downlevelIteration": true,
+        "experimentalDecorators": true,
+        "moduleResolution": "node",
+        "skipLibCheck": true,
+        "target": "es2015",
+        "module": "es2020",
+        "allowJs": true,
+        "emitDeclarationOnly": false,
+        "paths": {},
+        "lib": [
+            "es2020",
+            "dom"
+        ],
+    }
+}

package/tsconfig.json

@@ -0,0 +1,24 @@
+/* To learn more about this file see: https://angular.io/config/tsconfig. */
+{
+    "compileOnSave": false,
+    "compilerOptions": {
+        "outDir": "./dist/bitbybit-dev",
+        "baseUrl": "./",
+        "sourceMap": false,
+        "declaration": true,
+        "downlevelIteration": true,
+        "experimentalDecorators": true,
+        "moduleResolution": "node",
+        "skipLibCheck": true,
+        "target": "es2015",
+        "module": "es2020",
+        "strict": false,
+        "allowJs": true,
+        "emitDeclarationOnly": false,
+        "paths": {},
+        "lib": [
+            "es2020",
+            "dom"
+        ],
+    }
+}

package/babel.config.d.cts

@@ -1,5 +0,0 @@
-export const presets: (string | (string | {
-    targets: {
-        node: string;
-    };
-})[])[];

package/index.d.ts

@@ -1 +0,0 @@
-export * from "./lib";

package/lib/api/index.js

@@ -1 +0,0 @@
-export * from "./services";

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

@@ -1,35 +0,0 @@
-export declare namespace Base {
-    type Color = string;
-    type ColorRGB = {
-        r: number;
-        g: number;
-        b: number;
-    };
-    type Material = any;
-    type Point2 = [number, number];
-    type Vector2 = [number, number];
-    type Point3 = [number, number, number];
-    type Vector3 = [number, number, number];
-    type Line2 = {
-        start: Base.Point2;
-        end: Base.Point2;
-    };
-    type Line3 = {
-        start: Base.Point3;
-        end: Base.Point3;
-    };
-    type Polyline3 = {
-        points: Base.Point3[];
-        isClosed?: boolean;
-        color?: number[];
-    };
-    type Polyline2 = {
-        points: Base.Point2[];
-        isClosed?: boolean;
-        color?: number[];
-    };
-    type TransformMatrix3x3 = [number, number, number, number, number, number, number, number, number];
-    type TransformMatrixes3x3 = TransformMatrix3x3[];
-    type TransformMatrix = [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number];
-    type TransformMatrixes = TransformMatrix[];
-}

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

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