@math.gl/core 4.0.1 → 4.1.0-alpha.2

package/dist/index.d.ts

@@ -1,11 +1,16 @@
-export type { TypedArray, NumericArray } from '@math.gl/types';
-export type { isTypedArray, isNumericArray } from '@math.gl/types';
+export type { TypedArray, TypedArrayConstructor, NumericArray, NumberArray, NumberArray2, NumberArray3, NumberArray4, NumberArray6, NumberArray8, NumberArray9, NumberArray12, NumberArray16 } from '@math.gl/types';
+export type { isTypedArray, isNumberArray, isNumericArray } from '@math.gl/types';
 export { Vector2 } from "./classes/vector2.js";
 export { Vector3 } from "./classes/vector3.js";
 export { Vector4 } from "./classes/vector4.js";
 export { Matrix3 } from "./classes/matrix3.js";
 export { Matrix4 } from "./classes/matrix4.js";
 export { Quaternion } from "./classes/quaternion.js";
+export type { Vector2Like } from "./classes/vector2.js";
+export type { Vector3Like } from "./classes/vector3.js";
+export type { Vector4Like } from "./classes/vector4.js";
+export type { Matrix3Like } from "./classes/matrix3.js";
+export type { Matrix4Like } from "./classes/matrix4.js";
 export { SphericalCoordinates } from "./classes/spherical-coordinates.js";
 export { Pose } from "./classes/pose.js";
 export { Euler } from "./classes/euler.js";

package/dist/index.js

@@ -1,4 +1,6 @@
-// luma.gl, MIT license
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 // classes
 export { Vector2 } from "./classes/vector2.js";
 export { Vector3 } from "./classes/vector3.js";

package/dist/lib/assert.js

@@ -1,3 +1,6 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 export function assert(condition, message) {
     if (!condition) {
         throw new Error(`math.gl assertion ${message}`);

package/dist/lib/common.js

@@ -1,4 +1,6 @@
-// math.gl, MIT license
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 const RADIANS_TO_DEGREES = (1 / Math.PI) * 180;
 const DEGREES_TO_RADIANS = (1 / 180) * Math.PI;
 const DEFAULT_CONFIG = {

package/dist/lib/gl-matrix-extras.js

@@ -1,3 +1,6 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 // vec2 additions
 export function vec2_transformMat4AsVector(out, a, m) {
     const x = a[0];

package/dist/lib/math-utils.js

@@ -1,3 +1,6 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 // NOTE: Added to make Cesium-derived test cases work
 // TODO: Determine if/how to keep
 export const EPSILON1 = 1e-1;

package/dist/lib/validators.d.ts

@@ -1,5 +1,5 @@
-import { NumberArray } from '@math.gl/types';
-export declare function validateVector(v: NumberArray, length: number): boolean;
+import { NumericArray } from '@math.gl/types';
+export declare function validateVector(v: NumericArray, length: number): boolean;
 export declare function checkNumber(value: unknown): number;
-export declare function checkVector<T extends NumberArray>(v: T, length: number, callerName?: string): T;
+export declare function checkVector<T extends NumericArray>(v: T, length: number, callerName?: string): T;
 export declare function deprecated(method: string, version: string): void;

package/dist/lib/validators.js

@@ -1,3 +1,6 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 import { config } from "./common.js";
 export function validateVector(v, length) {
     if (v.length !== length) {

package/package.json

@@ -6,7 +6,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "4.0.1",
+  "version": "4.1.0-alpha.2",
   "keywords": [
     "webgl",
     "javascript",
@@ -45,7 +45,7 @@
     "./src/lib/common.js"
   ],
   "dependencies": {
-    "@math.gl/types": "4.0.1"
+    "@math.gl/types": "4.1.0-alpha.2"
   },
-  "gitHead": "33f369ba3a259f79acc3fa8181190c9da8841648"
+  "gitHead": "59eb434870991d06aecff5b1dee38078af0ca447"
 }

package/src/classes/base/math-array.ts

@@ -1,4 +1,7 @@
-// math.gl, MIT License
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
 import {NumericArray} from '@math.gl/types';
 import {ConfigurationOptions, config, formatValue, equals, isArray} from '../../lib/common';
 
@@ -47,7 +50,7 @@ export abstract class MathArray extends Array<number> {
     return Array.isArray(arrayOrObject)
       ? this.copy(arrayOrObject)
       : // @ts-ignore
-        this.fromObject(arrayOrObject);
+      this.fromObject(arrayOrObject);
   }
 
   to<T extends NumericArray | Record<string, unknown>>(arrayOrObject: T): T {

package/src/classes/base/matrix.ts

@@ -1,5 +1,8 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 // Copyright (c) 2017 Uber Technologies, Inc.
-// MIT License
+
 import {NumericArray} from '@math.gl/types';
 import {MathArray} from './math-array';
 import {checkNumber} from '../../lib/validators';

package/src/classes/base/vector.ts

@@ -1,5 +1,8 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 // Copyright (c) 2017 Uber Technologies, Inc.
-// MIT License
+
 import {NumericArray} from '@math.gl/types';
 import {MathArray} from './math-array';
 import {checkNumber} from '../../lib/validators';

package/src/classes/euler.ts

@@ -1,5 +1,8 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 // Copyright (c) 2017 Uber Technologies, Inc.
-// MIT License
+
 import {MathArray} from './base/math-array';
 import {Quaternion} from './quaternion';
 import {NumericArray} from '@math.gl/types';
@@ -11,6 +14,7 @@ import {checkNumber} from '../lib/validators';
 const ERR_UNKNOWN_ORDER = 'Unknown Euler angle order';
 const ALMOST_ONE = 0.99999;
 
+// eslint-disable-next-line no-shadow
 enum RotationOrder {
   ZYX = 0,
   YXZ = 1,
@@ -68,8 +72,8 @@ export class Euler extends MathArray {
     super(-0, -0, -0, -0);
     // eslint-disable-next-line prefer-rest-params
     if (arguments.length > 0 && Array.isArray(arguments[0])) {
-      // eslint-disable-next-line prefer-rest-params
       // @ts-expect-error
+      // eslint-disable-next-line prefer-rest-params
       this.fromVector3(...arguments);
     } else {
       this.set(x, y, z, order);

package/src/classes/matrix3.ts

@@ -1,7 +1,9 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 // Copyright (c) 2017 Uber Technologies, Inc.
-// MIT License
 
-import {NumericArray} from '@math.gl/types';
+import {NumericArray, NumberArray9} from '@math.gl/types';
 import {Matrix} from './base/matrix';
 import {checkVector} from '../lib/validators';
 
@@ -20,6 +22,7 @@ import {
 import {transformMat3 as vec2_transformMat3} from '../gl-matrix/vec2';
 import {transformMat3 as vec3_transformMat3} from '../gl-matrix/vec3';
 
+// eslint-disable-next-line no-shadow
 enum INDICES {
   COL0ROW0 = 0,
   COL0ROW1 = 1,
@@ -34,6 +37,13 @@ enum INDICES {
 
 const IDENTITY_MATRIX = Object.freeze([1, 0, 0, 0, 1, 0, 0, 0, 1]);
 
+/** Helper type that captures array length for a 3x3 matrix */
+export type Matrix3Like = Matrix3 | NumberArray9;
+
+/**
+ * A 3x3 matrix with common linear algebra operations
+ * Subclass of Array<number> meaning that it is highly compatible with other libraries
+ */
 export class Matrix3 extends Matrix {
   static get IDENTITY(): Readonly<Matrix3> {
     return getIdentityMatrix();

package/src/classes/matrix4.ts

@@ -1,7 +1,9 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 // Copyright (c) 2017 Uber Technologies, Inc.
-// MIT License
 
-import {NumericArray} from '@math.gl/types';
+import {NumericArray, NumberArray16} from '@math.gl/types';
 import {Matrix} from './base/matrix';
 import {checkVector} from '../lib/validators';
 
@@ -29,6 +31,7 @@ import {transformMat4 as vec2_transformMat4} from '../gl-matrix/vec2';
 import {transformMat4 as vec3_transformMat4} from '../gl-matrix/vec3';
 import {transformMat4 as vec4_transformMat4} from '../gl-matrix/vec4';
 
+// eslint-disable-next-line no-shadow
 enum INDICES {
   COL0ROW0 = 0,
   COL0ROW1 = 1,
@@ -55,7 +58,13 @@ const DEFAULT_FAR = 500;
 
 const IDENTITY_MATRIX = Object.freeze([1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]);
 
-/** 4x4 matrix */
+/** Helper type that captures array length for a 4x4 matrix */
+export type Matrix4Like = Matrix4 | NumberArray16;
+
+/**
+ * A 4x4 matrix with common linear algebra operations
+ * Subclass of Array<number> meaning that it is highly compatible with other libraries
+ */
 export class Matrix4 extends Matrix {
   static get IDENTITY(): Readonly<Matrix4> {
     return getIdentityMatrix();

package/src/classes/pose.ts

@@ -1,5 +1,8 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 // Copyright (c) 2017 Uber Technologies, Inc.
-// MIT License
+
 import {Matrix4} from './matrix4';
 import {Vector3} from './vector3';
 import {Euler} from './euler';

package/src/classes/quaternion.ts

@@ -1,5 +1,8 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 // Copyright (c) 2017 Uber Technologies, Inc.
-// MIT License
+
 import {NumericArray} from '@math.gl/types';
 import {MathArray} from './base/math-array';
 import {checkNumber, checkVector} from '../lib/validators';

package/src/classes/spherical-coordinates.ts

@@ -1,10 +1,12 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 // Copyright (c) 2017 Uber Technologies, Inc.
-// MIT License
+
 // Adaptation of THREE.js Spherical class, under MIT license
 import {NumericArray} from '@math.gl/types';
 import {Vector3} from './vector3';
-import {formatValue, equals, config} from '../lib/common';
-import {degrees, radians, clamp} from '../lib/common';
+import {formatValue, equals, config, degrees, radians, clamp} from '../lib/common';
 // @ts-ignore gl-matrix types...
 import * as vec3 from '../gl-matrix/vec3';
 

package/src/classes/vector2.ts

@@ -1,5 +1,10 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 // Copyright (c) 2017 Uber Technologies, Inc.
-// MIT License
+
+import {NumericArray, NumberArray2} from '@math.gl/types';
+
 import {Vector} from './base/vector';
 import {config, isArray} from '../lib/common';
 import {checkNumber} from '../lib/validators';
@@ -10,11 +15,13 @@ import {
   transformMat2 as vec2_transformMat2
 } from '../gl-matrix/vec2';
 import {vec2_transformMat4AsVector} from '../lib/gl-matrix-extras';
-import {NumericArray} from '@math.gl/types';
+
+/** Helper type that captures array length for a 2 element vector */
+export type Vector2Like = Vector2 | NumberArray2;
 
 /**
- * Two-element vector class.
- * Subclass of Array<number>
+ * Two-element vector class with common linear algebra operations.
+ * Subclass of Array<number> meaning that it is highly compatible with other libraries
  */
 export class Vector2 extends Vector {
   // Creates a new, empty vec2

package/src/classes/vector3.ts

@@ -1,6 +1,9 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 // Copyright (c) 2017 Uber Technologies, Inc.
-// MIT License
-import {NumericArray} from '@math.gl/types';
+
+import {NumericArray, NumberArray3} from '@math.gl/types';
 import {Vector} from './base/vector';
 import {config, isArray} from '../lib/common';
 import {checkNumber} from '../lib/validators';
@@ -22,9 +25,12 @@ const ORIGIN = [0, 0, 0];
 
 let ZERO: Vector3;
 
+/** Helper type that captures array length for a 3 element vector */
+export type Vector3Like = Vector3 | NumberArray3;
+
 /**
- * Three-element vector class.
- * Subclass of Array<number>
+ * Three-element vector class with common linear algebra operations.
+ * Subclass of Array<number> meaning that it is highly compatible with other libraries
  */
 export class Vector3 extends Vector {
   static get ZERO(): Vector3 {

package/src/classes/vector4.ts

@@ -1,7 +1,9 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 // Copyright (c) 2017 Uber Technologies, Inc.
-// MIT License
 
-import {NumericArray} from '@math.gl/types';
+import {NumericArray, NumberArray4} from '@math.gl/types';
 /* eslint-disable camelcase */
 import {
   transformMat4 as vec4_transformMat4,
@@ -17,9 +19,12 @@ import type {Matrix4} from './matrix4';
 
 let ZERO: Vector4;
 
+/** Helper type that captures array length for a 4 element vector */
+export type Vector4Like = Vector4 | NumberArray4;
+
 /**
- * Four-element vector class.
- * Subclass of Array<number>
+ * Four-element vector class with common linear algebra operations.
+ * Subclass of Array<number> meaning that it is highly compatible with other libraries
  */
 export class Vector4 extends Vector {
   static get ZERO(): Vector4 {

package/src/gl-matrix/vec2.ts

@@ -12,9 +12,9 @@ import * as glMatrix from './common.js';
 /**
  * Creates a new, empty vec2
  *
- * @returns {NumericArray} a new 2D vector
+ * @returns a new 2D vector
  */
-export function create() {
+export function create(): NumericArray {
   const out = new glMatrix.ARRAY_TYPE(2);
   if (glMatrix.ARRAY_TYPE != Float32Array) {
     out[0] = 0;
@@ -26,10 +26,10 @@ export function create() {
 /**
  * Creates a new vec2 initialized with values from an existing vector
  *
- * @param {Readonly<NumericArray>} a vector to clone
- * @returns {NumericArray} a new 2D vector
+ * @param a vector to clone
+ * @returns a new 2D vector
  */
-export function clone(a) {
+export function clone(a: Readonly<NumericArray>): NumericArray {
   const out = new glMatrix.ARRAY_TYPE(2);
   out[0] = a[0];
   out[1] = a[1];
@@ -39,11 +39,11 @@ export function clone(a) {
 /**
  * Creates a new vec2 initialized with the given values
  *
- * @param {Number} x X component
- * @param {Number} y Y component
- * @returns {NumericArray} a new 2D vector
+ * @param x X component
+ * @param y Y component
+ * @returns a new 2D vector
  */
-export function fromValues(x, y) {
+export function fromValues(x: number, y: number): NumericArray {
   const out = new glMatrix.ARRAY_TYPE(2);
   out[0] = x;
   out[1] = y;

package/src/gl-matrix/wip/index.js

@@ -1,3 +1,7 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
 // @eslint-disable
 // @ts-nocheck
 

package/src/gl-matrix/wip/mat2.js

@@ -1,3 +1,7 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
 // @ts-nocheck
 /* eslint-disable */
 

package/src/gl-matrix/wip/mat2d.js

@@ -1,3 +1,7 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
 // @ts-nocheck
 /* eslint-disable */
 

package/src/gl-matrix/wip/quat2.ts

@@ -1,3 +1,7 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
 // @ts-nocheck
 /* eslint-disable */
 import * as glMatrix from './common.js';

package/src/index.ts

@@ -1,9 +1,24 @@
-// luma.gl, MIT license
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 
 // types
-export type {TypedArray, NumericArray} from '@math.gl/types';
+export type {
+  TypedArray,
+  TypedArrayConstructor,
+  NumericArray,
+  NumberArray,
+  NumberArray2,
+  NumberArray3,
+  NumberArray4,
+  NumberArray6,
+  NumberArray8,
+  NumberArray9,
+  NumberArray12,
+  NumberArray16
+} from '@math.gl/types';
 
-export type {isTypedArray, isNumericArray} from '@math.gl/types';
+export type {isTypedArray, isNumberArray, isNumericArray} from '@math.gl/types';
 
 // classes
 export {Vector2} from './classes/vector2';
@@ -13,6 +28,12 @@ export {Matrix3} from './classes/matrix3';
 export {Matrix4} from './classes/matrix4';
 export {Quaternion} from './classes/quaternion';
 
+export type {Vector2Like} from './classes/vector2';
+export type {Vector3Like} from './classes/vector3';
+export type {Vector4Like} from './classes/vector4';
+export type {Matrix3Like} from './classes/matrix3';
+export type {Matrix4Like} from './classes/matrix4';
+
 // experimental
 export {SphericalCoordinates} from './classes/spherical-coordinates';
 export {Pose} from './classes/pose';

package/src/lib/assert.ts

@@ -1,3 +1,7 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
 export function assert(condition: unknown, message?: string): void {
   if (!condition) {
     throw new Error(`math.gl assertion ${message}`);

package/src/lib/common.ts

@@ -1,4 +1,8 @@
-// math.gl, MIT license
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+/* eslint-disable no-shadow */ // radians and degrees are common variable names
 
 import type {NumericArray} from '@math.gl/types';
 
@@ -299,7 +303,7 @@ function duplicateArray(array: NumericArray): NumericArray {
 // otherwise applies func to the argument value
 function map(
   value: number | NumericArray,
-  func: (x: number, index?: number, result?: NumericArray) => number,
+  func: (x: number, index?: number, resultArray?: NumericArray) => number,
   result?: NumericArray
 ): number | NumericArray {
   if (isArray(value)) {

package/src/lib/gl-matrix-extras.ts

@@ -1,3 +1,7 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
 /* eslint-disable camelcase */
 import {NumericArray} from '@math.gl/types';
 // vec2 additions

package/src/lib/gl-matrix.d.ts

@@ -1,3 +1,7 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
 type NumericArray =
   | Int8Array
   | Uint8Array

package/src/lib/math-utils.ts

@@ -1,3 +1,7 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
 // NOTE: Added to make Cesium-derived test cases work
 // TODO: Determine if/how to keep
 export const EPSILON1 = 1e-1;

package/src/lib/validators.ts

@@ -1,26 +1,11 @@
-// Copyright (c) 2017 Uber Technologies, Inc.
-//
-// Permission is hereby granted, free of charge, to any person obtaining a copy
-// of this software and associated documentation files (the "Software"), to deal
-// in the Software without restriction, including without limitation the rights
-// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-// copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in
-// all copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-// THE SOFTWARE.
-import {NumberArray} from '@math.gl/types';
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+import {NumericArray} from '@math.gl/types';
 import {config} from './common';
 
-export function validateVector(v: NumberArray, length: number): boolean {
+export function validateVector(v: NumericArray, length: number): boolean {
   if (v.length !== length) {
     return false;
   }
@@ -40,7 +25,7 @@ export function checkNumber(value: unknown): number {
   return value as number;
 }
 
-export function checkVector<T extends NumberArray>(
+export function checkVector<T extends NumericArray>(
   v: T,
   length: number,
   callerName: string = ''