@carbonenginejs/runtime-utils 0.1.1 → 0.1.3

package/src/types/index.js

@@ -1,2 +1,2 @@
-export * from "./carbonTypes.js";
-export * from "../schema/index.js";
+export * from "./carbonTypes.js";
+export * from "../schema/index.js";

package/src/utils.js

@@ -1,58 +1,58 @@
-
-/**
- * Convert a nullable, scalar, or array-like value into an array.
- *
- * Kept local so geometry helpers do not depend on the old ccpwgl `utils`
- * webpack alias.
- *
- * @param {any} value Value to normalize.
- * @returns {Array} Normalized array.
- */
-export function toArray(value)
-{
-    if (value === undefined || value === null) return [];
-    return Array.isArray(value) ? value : [ value ];
-}
-
-/**
- * Copies array-like values into a writable indexed target.
- *
- * @template T
- * @param {T} target Writable indexed target.
- * @param {ArrayLike<any>} value Source values.
- * @returns {T} The target.
- */
-export function copyArrayLike(target, value)
-{
-    const
-        length = Math.min(target.length, value.length),
-        source = new Array(length);
-
-    for (let i = 0; i < length; i++)
-    {
-        source[i] = value[i];
-    }
-
-    for (let i = 0; i < length; i++)
-    {
-        target[i] = source[i];
-    }
-    return target;
-}
-
-/**
- * Fills a writable indexed target with a scalar value.
- *
- * @template T
- * @param {T} target Writable indexed target.
- * @param {number} value Fill value.
- * @returns {T} The target.
- */
-export function fillArrayLike(target, value)
-{
-    for (let i = 0; i < target.length; i++)
-    {
-        target[i] = value;
-    }
-    return target;
-}
+
+/**
+ * Convert a nullable, scalar, or array-like value into an array.
+ *
+ * Kept local so geometry helpers do not depend on the old ccpwgl `utils`
+ * webpack alias.
+ *
+ * @param {any} value Value to normalize.
+ * @returns {Array} Normalized array.
+ */
+export function toArray(value)
+{
+    if (value === undefined || value === null) return [];
+    return Array.isArray(value) ? value : [ value ];
+}
+
+/**
+ * Copies array-like values into a writable indexed target.
+ *
+ * @template T
+ * @param {T} target Writable indexed target.
+ * @param {ArrayLike<any>} value Source values.
+ * @returns {T} The target.
+ */
+export function copyArrayLike(target, value)
+{
+    const
+        length = Math.min(target.length, value.length),
+        source = new Array(length);
+
+    for (let i = 0; i < length; i++)
+    {
+        source[i] = value[i];
+    }
+
+    for (let i = 0; i < length; i++)
+    {
+        target[i] = source[i];
+    }
+    return target;
+}
+
+/**
+ * Fills a writable indexed target with a scalar value.
+ *
+ * @template T
+ * @param {T} target Writable indexed target.
+ * @param {number} value Fill value.
+ * @returns {T} The target.
+ */
+export function fillArrayLike(target, value)
+{
+    for (let i = 0; i < target.length; i++)
+    {
+        target[i] = value;
+    }
+    return target;
+}

package/src/validation.js

@@ -1,46 +1,46 @@
-import { isPlainObject } from "./is.js";
-
-export { isPlainObject } from "./is.js";
-
-/** Returns a plain object or throws a labelled TypeError. */
-export function assertPlainObject(value, label = "value")
-{
-    if (!isPlainObject(value))
-    {
-        throw new TypeError(`${label} must be a plain object.`);
-    }
-
-    return value;
-}
-
-/** Returns a trimmed non-empty string or throws a labelled TypeError. */
-export function assertNonEmptyString(value, label = "value")
-{
-    if (typeof value !== "string" || value.trim() === "")
-    {
-        throw new TypeError(`${label} must be a non-empty string.`);
-    }
-
-    return value.trim();
-}
-
-/** Normalizes and validates a non-negative safe-integer version. */
-export function assertSupportedVersion(value, supportedVersions, label = "version")
-{
-    const version = Number(value);
-    const supported = Array.from(supportedVersions, Number);
-
-    if (!Number.isSafeInteger(version) || version < 0)
-    {
-        throw new TypeError(`${label} must be a non-negative safe integer.`);
-    }
-
-    if (!supported.includes(version))
-    {
-        throw new RangeError(
-            `Unsupported ${label} ${JSON.stringify(value)}; expected one of ${supported.join(", ")}.`
-        );
-    }
-
-    return version;
-}
+import { isPlainObject } from "./is.js";
+
+export { isPlainObject } from "./is.js";
+
+/** Returns a plain object or throws a labelled TypeError. */
+export function assertPlainObject(value, label = "value")
+{
+    if (!isPlainObject(value))
+    {
+        throw new TypeError(`${label} must be a plain object.`);
+    }
+
+    return value;
+}
+
+/** Returns a trimmed non-empty string or throws a labelled TypeError. */
+export function assertNonEmptyString(value, label = "value")
+{
+    if (typeof value !== "string" || value.trim() === "")
+    {
+        throw new TypeError(`${label} must be a non-empty string.`);
+    }
+
+    return value.trim();
+}
+
+/** Normalizes and validates a non-negative safe-integer version. */
+export function assertSupportedVersion(value, supportedVersions, label = "version")
+{
+    const version = Number(value);
+    const supported = Array.from(supportedVersions, Number);
+
+    if (!Number.isSafeInteger(version) || version < 0)
+    {
+        throw new TypeError(`${label} must be a non-negative safe integer.`);
+    }
+
+    if (!supported.includes(version))
+    {
+        throw new RangeError(
+            `Unsupported ${label} ${JSON.stringify(value)}; expected one of ${supported.join(", ")}.`
+        );
+    }
+
+    return version;
+}

package/src/vec2.js

@@ -1,229 +1,229 @@
-import * as glVec2 from "gl-matrix/esm/vec2.js";
-import { pool } from "./pool.js";
-
-const vec2 = { ...glVec2 };
-
-export { vec2 };
-
-/**
- *
- * @returns {Float32Array}
- */
-vec2.alloc = function()
-{
-    return pool.allocF32(2);
-};
-
-/**
- *
- * @param a
- */
-vec2.unalloc = function(a)
-{
-    pool.freeType(a);
-};
-
-/**
- * Adds a scalar to a vec2
- *
- * @param {vec2} out
- * @param {vec2} a
- * @param {Number} s
- * @returns {vec2} out
- */
-vec2.addScalar = function(out, a, s)
-{
-    out[0] = a[0] + s;
-    out[1] = a[1] + s;
-    return out;
-};
-
-/**
- * Checks if a vector2 is empty
- * @param {vec2} a
- * @returns {boolean}
- */
-vec2.isEmpty = function(a)
-{
-    return a[0] === 0 && a[1] === 0;
-};
-
-/**
- * Divides a vec2 by a scalar
- *
- * @param {vec2} out
- * @param {vec2} a
- * @param {Number} s
- * @returns {vec2} out
- */
-vec2.divideScalar = function(out, a, s)
-{
-    return vec2.multiplyScalar(out, a, 1 / s);
-};
-
-
-/**
- * Multiplies a vec2 by a scalar
- *
- * @param {vec2} out
- * @param {vec2} a
- * @param {Number} s
- * @returns {vec2} out
- */
-vec2.multiplyScalar = function(out, a, s)
-{
-    out[0] = a[0] * s;
-    out[1] = a[1] * s;
-    return out;
-};
-
-/**
- * Sets a vec2 from a scalar
- *
- * @param {vec2} out
- * @param {Number} s
- * @returns {vec2} out
- */
-vec2.setScalar = function(out, s)
-{
-    out[0] = s;
-    out[1] = s;
-    return out;
-};
-
-/**
- * Subtracts a scalar from a vec2
- *
- * @param {vec2} out
- * @param {vec2} a
- * @param {Number} s
- * @returns {vec2} out
- */
-vec2.subtractScalar = function(out, a, s)
-{
-    out[0] = a[0] - s;
-    out[1] = a[1] - s;
-    return out;
-};
-
-/**
- * Sets a vec2 from an array with an optional offset
- * @param {vec3} out
- * @param {TypedArray|Array} array
- * @param {Number} [offset=0]
- * @returns {vec3} out
- */
-vec2.fromArray = function(out, array, offset=0)
-{
-    out[0] = array[offset];
-    out[1] = array[offset + 1];
-    return out;
-};
-
-/**
- * Gets mouse position from a mouse event
- * @param {vec2} out
- * @param {MouseEvent} event
- * @returns {vec2} out - mouse coordinates
- */
-vec2.mousePositionFromEvent = function(out, event)
-{
-    out[0] = event.clientX;
-    out[1] = event.clientY;
-    return out;
-};
-
-/**
- * Gets CSS position from an event
- * @param {vec2} out
- * @param {MouseEvent} event
- * @param {HTMLElement} [element=element.target]
- * @returns {vec2} out - css coordinates
- */
-vec2.cssPositionFromEvent = function(out, event, element=event.target)
-{
-    const rect = element.getBoundingClientRect();
-    out[0] = event.clientX - rect.left;
-    out[1] = event.clientY - rect.top;
-    return out;
-};
-
-/**
- * Gets the pixel coordinates from an element event
- * @param {vec2} out
- * @param {MouseEvent} event
- * @param {HTMLElement} [element=element.target]
- * @returns {vec2} out - the pixel coordinates
- */
-vec2.pixelPositionFromEvent = function(out, event, element=event.target)
-{
-    const
-        rect = element.getBoundingClientRect(),
-        cssX = event.clientX - rect.left,
-        cssY = event.clientY - rect.top;
-
-    out[0] = cssX * element.width / element.clientWidth;
-    out[1] = element.height - cssY * element.height / element.clientHeight - 1;
-    return out;
-};
-
-export const {
-    add,
-    angle,
-    ceil,
-    clone,
-    copy,
-    create,
-    cross,
-    dist,
-    distance,
-    div,
-    divide,
-    dot,
-    equals,
-    exactEquals,
-    floor,
-    forEach,
-    fromValues,
-    inverse,
-    len,
-    length,
-    lerp,
-    max,
-    min,
-    mul,
-    multiply,
-    negate,
-    normalize,
-    random,
-    rotate,
-    round,
-    scale,
-    scaleAndAdd,
-    set,
-    signedAngle,
-    sqrDist,
-    sqrLen,
-    squaredDistance,
-    squaredLength,
-    str,
-    sub,
-    subtract,
-    transformMat2,
-    transformMat2d,
-    transformMat3,
-    transformMat4,
-    zero,
-    alloc,
-    unalloc,
-    addScalar,
-    isEmpty,
-    divideScalar,
-    multiplyScalar,
-    setScalar,
-    subtractScalar,
-    fromArray,
-    mousePositionFromEvent,
-    cssPositionFromEvent,
-    pixelPositionFromEvent
-} = vec2;
+import * as glVec2 from "gl-matrix/esm/vec2.js";
+import { pool } from "./pool.js";
+
+const vec2 = { ...glVec2 };
+
+export { vec2 };
+
+/**
+ *
+ * @returns {Float32Array}
+ */
+vec2.alloc = function()
+{
+    return pool.allocF32(2);
+};
+
+/**
+ *
+ * @param a
+ */
+vec2.unalloc = function(a)
+{
+    pool.freeType(a);
+};
+
+/**
+ * Adds a scalar to a vec2
+ *
+ * @param {vec2} out
+ * @param {vec2} a
+ * @param {Number} s
+ * @returns {vec2} out
+ */
+vec2.addScalar = function(out, a, s)
+{
+    out[0] = a[0] + s;
+    out[1] = a[1] + s;
+    return out;
+};
+
+/**
+ * Checks if a vector2 is empty
+ * @param {vec2} a
+ * @returns {boolean}
+ */
+vec2.isEmpty = function(a)
+{
+    return a[0] === 0 && a[1] === 0;
+};
+
+/**
+ * Divides a vec2 by a scalar
+ *
+ * @param {vec2} out
+ * @param {vec2} a
+ * @param {Number} s
+ * @returns {vec2} out
+ */
+vec2.divideScalar = function(out, a, s)
+{
+    return vec2.multiplyScalar(out, a, 1 / s);
+};
+
+
+/**
+ * Multiplies a vec2 by a scalar
+ *
+ * @param {vec2} out
+ * @param {vec2} a
+ * @param {Number} s
+ * @returns {vec2} out
+ */
+vec2.multiplyScalar = function(out, a, s)
+{
+    out[0] = a[0] * s;
+    out[1] = a[1] * s;
+    return out;
+};
+
+/**
+ * Sets a vec2 from a scalar
+ *
+ * @param {vec2} out
+ * @param {Number} s
+ * @returns {vec2} out
+ */
+vec2.setScalar = function(out, s)
+{
+    out[0] = s;
+    out[1] = s;
+    return out;
+};
+
+/**
+ * Subtracts a scalar from a vec2
+ *
+ * @param {vec2} out
+ * @param {vec2} a
+ * @param {Number} s
+ * @returns {vec2} out
+ */
+vec2.subtractScalar = function(out, a, s)
+{
+    out[0] = a[0] - s;
+    out[1] = a[1] - s;
+    return out;
+};
+
+/**
+ * Sets a vec2 from an array with an optional offset
+ * @param {vec3} out
+ * @param {TypedArray|Array} array
+ * @param {Number} [offset=0]
+ * @returns {vec3} out
+ */
+vec2.fromArray = function(out, array, offset=0)
+{
+    out[0] = array[offset];
+    out[1] = array[offset + 1];
+    return out;
+};
+
+/**
+ * Gets mouse position from a mouse event
+ * @param {vec2} out
+ * @param {MouseEvent} event
+ * @returns {vec2} out - mouse coordinates
+ */
+vec2.mousePositionFromEvent = function(out, event)
+{
+    out[0] = event.clientX;
+    out[1] = event.clientY;
+    return out;
+};
+
+/**
+ * Gets CSS position from an event
+ * @param {vec2} out
+ * @param {MouseEvent} event
+ * @param {HTMLElement} [element=element.target]
+ * @returns {vec2} out - css coordinates
+ */
+vec2.cssPositionFromEvent = function(out, event, element=event.target)
+{
+    const rect = element.getBoundingClientRect();
+    out[0] = event.clientX - rect.left;
+    out[1] = event.clientY - rect.top;
+    return out;
+};
+
+/**
+ * Gets the pixel coordinates from an element event
+ * @param {vec2} out
+ * @param {MouseEvent} event
+ * @param {HTMLElement} [element=element.target]
+ * @returns {vec2} out - the pixel coordinates
+ */
+vec2.pixelPositionFromEvent = function(out, event, element=event.target)
+{
+    const
+        rect = element.getBoundingClientRect(),
+        cssX = event.clientX - rect.left,
+        cssY = event.clientY - rect.top;
+
+    out[0] = cssX * element.width / element.clientWidth;
+    out[1] = element.height - cssY * element.height / element.clientHeight - 1;
+    return out;
+};
+
+export const {
+    add,
+    angle,
+    ceil,
+    clone,
+    copy,
+    create,
+    cross,
+    dist,
+    distance,
+    div,
+    divide,
+    dot,
+    equals,
+    exactEquals,
+    floor,
+    forEach,
+    fromValues,
+    inverse,
+    len,
+    length,
+    lerp,
+    max,
+    min,
+    mul,
+    multiply,
+    negate,
+    normalize,
+    random,
+    rotate,
+    round,
+    scale,
+    scaleAndAdd,
+    set,
+    signedAngle,
+    sqrDist,
+    sqrLen,
+    squaredDistance,
+    squaredLength,
+    str,
+    sub,
+    subtract,
+    transformMat2,
+    transformMat2d,
+    transformMat3,
+    transformMat4,
+    zero,
+    alloc,
+    unalloc,
+    addScalar,
+    isEmpty,
+    divideScalar,
+    multiplyScalar,
+    setScalar,
+    subtractScalar,
+    fromArray,
+    mousePositionFromEvent,
+    cssPositionFromEvent,
+    pixelPositionFromEvent
+} = vec2;