@vived/core 1.2.1 → 1.2.3

package/src/Utilities/easeFunctions.ts

@@ -1,180 +0,0 @@
-import { EaseFn } from "../Types";
-
-
-export const easeLinear: EaseFn = (x: number): number => {
-  if (x <= 0) return 0;
-  if (x >= 1) return 1;
-
-  return x;
-};
-
-export const quadIn: EaseFn = (x: number) => {
-  if (x <= 0) return 0;
-  if (x >= 1) return 1;
-
-  return x * x;
-};
-
-export const quadOut: EaseFn = (x: number) => {
-  if (x <= 0) return 0;
-  if (x >= 1) return 1;
-
-  return x * (2 - x);
-};
-
-export const quadInOut: EaseFn = (x: number): number => {
-  if (x <= 0) return 0;
-  if (x >= 1) return 1;
-
-  if (x < 0.5) {
-    return 2 * x * x;
-  } else {
-    return 1 - Math.pow(-2 * x + 2, 2) / 2;
-  }
-};
-
-export const cubicIn: EaseFn = (x: number): number => {
-  if (x <= 0) return 0;
-  if (x >= 1) return 1;
-
-  return x * x * x;
-};
-
-export const cubicOut: EaseFn = (x: number): number => {
-  if (x <= 0) return 0;
-  if (x >= 1) return 1;
-
-  return --x * x * x + 1;
-};
-
-export const cubicInOut: EaseFn = (x: number): number => {
-  if (x <= 0) return 0;
-  if (x >= 1) return 1;
-
-  x *= 2;
-
-  if (x <= 1) {
-    return (x * x * x) / 2;
-  } else {
-    return ((x -= 2) * x * x + 2) / 2;
-  }
-};
-
-export const expoIn: EaseFn = (x: number): number => {
-  if (x <= 0) return 0;
-  if (x >= 1) return 1;
-
-  return Math.pow(2, 10 * x - 10);
-};
-
-export const expoOut: EaseFn = (x: number): number => {
-  if (x <= 0) return 0;
-  if (x >= 1) return 1;
-
-  return 1 - Math.pow(2, -10 * x);
-};
-
-export const expoInOut: EaseFn = (x: number): number => {
-  if (x <= 0) return 0;
-  if (x >= 1) return 1;
-
-  return x < 0.5
-    ? Math.pow(2, 20 * x - 10) / 2
-    : (2 - Math.pow(2, -20 * x + 10)) / 2;
-};
-
-export const sinIn: EaseFn = (x: number): number => {
-  if (x <= 0) return 0;
-  if (x >= 1) return 1;
-
-  return 1 - Math.cos((x * Math.PI) / 2);
-};
-
-export const sinOut: EaseFn = (x: number): number => {
-  if (x <= 0) return 0;
-  if (x >= 1) return 1;
-
-  return Math.sin((x * Math.PI) / 2);
-};
-
-export const sinInOut: EaseFn = (x: number): number => {
-  if (x <= 0) return 0;
-  if (x >= 1) return 1;
-
-  return -(Math.cos(Math.PI * x) - 1) / 2;
-};
-
-export const quartIn: EaseFn = (x: number): number => {
-  if (x <= 0) return 0;
-  if (x >= 1) return 1;
-
-  return x * x * x * x;
-};
-
-export const quartOut: EaseFn = (x: number): number => {
-  if (x <= 0) return 0;
-  if (x >= 1) return 1;
-
-  return 1 - Math.pow(1 - x, 4);
-};
-
-export const quartInOut: EaseFn = (x: number): number => {
-  if (x <= 0) return 0;
-  if (x >= 1) return 1;
-
-  if (x < 0.5) {
-    return 8 * x * x * x * x;
-  } else {
-    return 1 - Math.pow(-2 * x + 2, 4) / 2;
-  }
-};
-
-export const quintIn: EaseFn = (x: number): number => {
-  if (x <= 0) return 0;
-  if (x >= 1) return 1;
-
-  return x * x * x * x * x;
-};
-
-export const quintOut: EaseFn = (x: number): number => {
-  if (x <= 0) return 0;
-  if (x >= 1) return 1;
-
-  return 1 - Math.pow(1 - x, 5);
-};
-
-export const quintInOut: EaseFn = (x: number): number => {
-  if (x <= 0) return 0;
-  if (x >= 1) return 1;
-
-  if (x < 0.5) {
-    return 16 * x * x * x * x * x;
-  } else {
-    return 1 - Math.pow(-2 * x + 2, 5) / 2;
-  }
-};
-
-export const circIn: EaseFn = (x: number): number => {
-  if (x <= 0) return 0;
-  if (x >= 1) return 1;
-
-  return 1 - Math.sqrt(1 - Math.pow(x, 2));
-};
-
-export const circOut: EaseFn = (x: number): number => {
-  if (x <= 0) return 0;
-  if (x >= 1) return 1;
-
-  return Math.sqrt(1 - Math.pow(x - 1, 2));
-};
-
-export const circInOut: EaseFn = (x: number): number => {
-  if (x <= 0) return 0;
-  if (x >= 1) return 1;
-
-  if (x < 0.5) {
-    return (1 - Math.sqrt(1 - Math.pow(2 * x, 2))) / 2;
-  } else {
-    return (Math.sqrt(1 - Math.pow(-2 * x + 2, 2)) + 1) / 2;
-  }
-};

package/src/Utilities/generateUniqueID.ts

@@ -1,5 +0,0 @@
-import { v4 as uuidv4 } from "uuid";
-
-export function generateUniqueID(): string {
-  return uuidv4();
-}

package/src/Utilities/interpolateNumber.test.ts

@@ -1,28 +0,0 @@
-import { interpolateNumber } from "./interpolateNumber";
-
-describe("Lerp number", () => {
-  it("Interpolate as expected", () => {
-    const lerpedVal = interpolateNumber(0, 10, 0.5);
-    expect(lerpedVal).toEqual(5);
-  });
-
-  it("Interpolate without clamping", () => {
-    const lerpedVal = interpolateNumber(0, 10, -0.5);
-    expect(lerpedVal).toEqual(-5);
-  });
-
-  it("Interpolate without clamping", () => {
-    const lerpedVal = interpolateNumber(0, 10, 1.5);
-    expect(lerpedVal).toEqual(15);
-  });
-
-  it("Interpolate with clamping", () => {
-    const lerpedVal = interpolateNumber(0, 10, -0.5, true);
-    expect(lerpedVal).toEqual(0);
-  });
-
-  it("Interpolate with clamping", () => {
-    const lerpedVal = interpolateNumber(0, 10, 1.5, true);
-    expect(lerpedVal).toEqual(10);
-  });
-});

package/src/Utilities/interpolateNumber.ts

@@ -1,21 +0,0 @@
-export function interpolateNumber(
-  start: number,
-  end: number,
-  percent: number,
-  clamp: boolean = false
-): number {
-  const range = end - start;
-
-  if (!clamp) {
-    return percent * range + start;
-  }
-
-  let clampedP = percent;
-  if (clampedP < 0) {
-    clampedP = 0;
-  } else if (clampedP > 1) {
-    clampedP = 1;
-  }
-
-  return clampedP * range + start;
-}

package/src/ValueObjects/Angle.test.ts

@@ -1,30 +0,0 @@
-import { Angle } from "./Angle";
-describe("Angle Value Object", () => {
-  it("Creates an angle from degrees", () => {
-    const ang = Angle.FromDegrees(125);
-    expect(ang.degrees).toEqual(125);
-  });
-
-  it("Creates an angle from degrees", () => {
-    const ang = Angle.FromRadians(1.25);
-    expect(ang.radians).toEqual(1.25);
-  });
-
-  it("Converts from degrees and radians", () => {
-    const ang = Angle.FromDegrees(125);
-    expect(ang.radians).toBeCloseTo(2.18166);
-  });
-
-  it("Converts from radians to degrees", () => {
-    const ang = Angle.FromRadians(1.25);
-    expect(ang.degrees).toBeCloseTo(71.61972);
-  });
-
-  it("Checks for closeness", ()=>{
-    const ang1 = Angle.FromDegrees(1.555);
-    const ang2 = Angle.FromDegrees(1.556);
-
-    expect(Angle.Close(ang1, ang2, 0.0011)).toEqual(true);
-    expect(Angle.Close(ang1, ang2, 0.001)).toEqual(false);
-  })
-});

package/src/ValueObjects/Angle.ts

@@ -1,47 +0,0 @@
-export class Angle {
-  /**
-   * Creates an angle from degrees
-   * @param degrees Angle in degrees
-   * @returns The angle
-   */
-  public static FromDegrees(degrees: number): Angle {
-    return new Angle(degrees);
-  }
-
-  /**
-   * Creates an angle from radians
-   * @param radians Angle in radians
-   * @returns The angle
-   */
-  public static FromRadians(radians: number): Angle {
-    return new Angle((radians * 180) / Math.PI);
-  }
-
-  /**
-   * Check to see if two angles are close
-   * @param a Angle A
-   * @param b Angle B
-   * @param tolerance Tolerance for "Close" in degrees. Defaults to 0.001;
-   * @returns True if the difference between A and B (in degress) is less than the tolerance
-   */
-  public static Close(a: Angle, b: Angle, tolerance: number = 0.001): boolean {
-    let diff = a.degrees - b.degrees;
-    if (diff < 0) {
-      diff = -diff;
-    }
-    return diff < tolerance;
-  }
-
-  private _degrees = 0;
-  public get degrees() {
-    return this._degrees;
-  }
-
-  public get radians() {
-    return (this._degrees * Math.PI) / 180;
-  }
-
-  private constructor(degrees: number) {
-    this._degrees = degrees;
-  }
-}

package/src/ValueObjects/Color.test.ts

@@ -1,181 +0,0 @@
-import { Color } from "./Color";
-
-describe("Color value object - RGBA", () => {
-  it("Make a color as expected", () => {
-    const color = Color.RGBA(10, 20, 30, 40);
-
-    expect(color.r).toEqual(10);
-    expect(color.g).toEqual(20);
-    expect(color.b).toEqual(30);
-    expect(color.a).toEqual(40);
-  });
-
-  it("Clamps the color values to a minumum value of 0", () => {
-    const color = Color.RGBA(-1, -1, -1, -1);
-
-    expect(color.r).toEqual(0);
-    expect(color.g).toEqual(0);
-    expect(color.b).toEqual(0);
-    expect(color.a).toEqual(0);
-  });
-
-  it("Clamps the color values to a maximum value of 255", () => {
-    const color = Color.RGBA(300, 300, 300, 300);
-
-    expect(color.r).toEqual(255);
-    expect(color.g).toEqual(255);
-    expect(color.b).toEqual(255);
-    expect(color.a).toEqual(255);
-  });
-});
-
-describe("Color value object - RGB", () => {
-  it("Make a color as expected", () => {
-    const color = Color.RGB(10, 20, 30);
-
-    expect(color.r).toEqual(10);
-    expect(color.g).toEqual(20);
-    expect(color.b).toEqual(30);
-    expect(color.a).toEqual(255);
-  });
-
-  it("Clamps the color values to a minumum value of 0", () => {
-    const color = Color.RGB(-1, -1, -1);
-
-    expect(color.r).toEqual(0);
-    expect(color.g).toEqual(0);
-    expect(color.b).toEqual(0);
-    expect(color.a).toEqual(255);
-  });
-
-  it("Clamps the color values to a maximum value of 255", () => {
-    const color = Color.RGB(300, 300, 300);
-
-    expect(color.r).toEqual(255);
-    expect(color.g).toEqual(255);
-    expect(color.b).toEqual(255);
-    expect(color.a).toEqual(255);
-  });
-});
-
-describe("Color from Hex", () => {
-  // See https://www.rapidtables.com/convert/color/hex-to-rgb.html
-  it("Properly converts red", () => {
-    const color = Color.Hex("FF0000");
-
-    expect(color.r).toEqual(255);
-    expect(color.g).toEqual(0);
-    expect(color.b).toEqual(0);
-    expect(color.a).toEqual(255);
-  });
-
-  it("Properly converts green", () => {
-    const color = Color.Hex("00FF00");
-
-    expect(color.r).toEqual(0);
-    expect(color.g).toEqual(255);
-    expect(color.b).toEqual(0);
-    expect(color.a).toEqual(255);
-  });
-
-  it("Properly converts blue", () => {
-    const color = Color.Hex("0000FF");
-
-    expect(color.r).toEqual(0);
-    expect(color.g).toEqual(0);
-    expect(color.b).toEqual(255);
-    expect(color.a).toEqual(255);
-  });
-
-  it("Properly converts gray", () => {
-    const color = Color.Hex("808080");
-
-    expect(color.r).toEqual(128);
-    expect(color.g).toEqual(128);
-    expect(color.b).toEqual(128);
-    expect(color.a).toEqual(255);
-  });
-
-  it("Warns if something goes wrong and returns black", () => {
-    console.warn = jest.fn();
-    const color = Color.Hex("Your Mom goes to college");
-
-    expect(color.r).toEqual(0);
-    expect(color.g).toEqual(0);
-    expect(color.b).toEqual(0);
-    expect(color.a).toEqual(255);
-
-    expect(console.warn).toBeCalled();
-  });
-});
-
-describe("Color from X11", () => {
-  it("Finds the proper color by name", () => {
-    const color = Color.X11("OrangeRed");
-
-    expect(color.r).toEqual(255);
-    expect(color.g).toEqual(69);
-    expect(color.b).toEqual(0);
-    expect(color.a).toEqual(255);
-  });
-
-  it("Warns if the X11 color is not found and returns black", () => {
-    console.warn = jest.fn();
-    const color = Color.X11("Your Mom goes to college");
-
-    expect(color.r).toEqual(0);
-    expect(color.g).toEqual(0);
-    expect(color.b).toEqual(0);
-    expect(color.a).toEqual(255);
-
-    expect(console.warn).toBeCalled();
-  });
-
-  it("Checks for equality", () => {
-    const colorA = Color.X11("OrangeRed");
-    const colorB = Color.X11("LemonChiffon");
-    const colorC = Color.X11("OrangeRed");
-
-    expect(Color.Equal(colorA, colorC)).toEqual(true);
-    expect(Color.Equal(colorA, colorB)).toEqual(false);
-  });
-
-  it("Gets the hex", () => {
-    const c = Color.Hex("#fcba03");
-    expect(c.hex).toEqual("#fcba03");
-  });
-
-  it("Gets the Data Transfer Object", () => {
-    const color = Color.RGBA(10, 20, 30, 40);
-
-    expect(color.dto).toEqual({
-      r: 10,
-      g: 20,
-      b: 30,
-      a: 40,
-    });
-  });
-
-  it("Makes a Color from a DTO", () => {
-    const color = Color.FromDTO({
-      r: 10,
-      g: 20,
-      b: 30,
-      a: 40,
-    });
-
-    expect(color.r).toEqual(10);
-    expect(color.g).toEqual(20);
-    expect(color.b).toEqual(30);
-    expect(color.a).toEqual(40);
-  });
-
-  it("Color name is not case sensitive", () => {
-    const color1 = Color.X11("OrangeRed");
-    const color2 = Color.X11("orangered");
-    const color3 = Color.X11("orangeRed");
-
-    expect(color1).toEqual(color2);
-    expect(color1).toEqual(color3);
-  });
-});