@jscad/modeling 2.11.1 → 3.0.0-alpha.0

package/src/maths/mat4/rotate.js

@@ -1,20 +1,20 @@
-const { EPS } = require('../constants')
+import { EPS } from '../constants.js'
 
-const { sin, cos } = require('../utils/trigonometry')
+import { sin, cos } from '../utils/trigonometry.js'
 
-const copy = require('./copy')
+import { copy } from './copy.js'
 
 /**
  * Rotates a matrix by the given angle about the given axis.
  *
- * @param {mat4} out - receiving matrix
- * @param {mat4} matrix - matrix to rotate
- * @param {Number} radians - angle to rotate the matrix by
- * @param {vec3} axis - axis to rotate around
- * @returns {mat4} out
+ * @param {Mat4} out - receiving matrix
+ * @param {Mat4} matrix - matrix to rotate
+ * @param {number} radians - angle to rotate the matrix by
+ * @param {Vec3} axis - axis to rotate around
+ * @returns {Mat4} out
  * @alias module:modeling/maths/mat4.rotate
  */
-const rotate = (out, matrix, radians, axis) => {
+export const rotate = (out, matrix, radians, axis) => {
   let [x, y, z] = axis
   const lengthSquared = x * x + y * y + z * z
 
@@ -78,5 +78,3 @@ const rotate = (out, matrix, radians, axis) => {
   }
   return out
 }
-
-module.exports = rotate

package/src/maths/mat4/rotate.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { rotate, create } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { rotate, create } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('mat4: rotate() called with out parameter should return a new mat4 with correct values', (t) => {
   const rotation = 90 * 0.017453292519943295
@@ -9,12 +10,12 @@ test('mat4: rotate() called with out parameter should return a new mat4 with cor
   const idn = create()
 
   // invalid condition when axis is 0,0,0
-  const out1 = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
+  const out1 = create()
   const ret1 = rotate(out1, idn, rotation, [0, 0, 0])
   t.is(out1, ret1)
   t.true(compareVectors(out1, [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]))
 
-  const out2 = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
+  const out2 = create()
   const ret2 = rotate(out2, idn, rotation, [0, 0, 1])
   t.true(compareVectors(out2, [0, 1, 0, 0, -1, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]))
   t.true(compareVectors(ret2, [0, 1, 0, 0, -1, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]))

package/src/maths/mat4/rotateX.d.ts

@@ -1,5 +1,3 @@
-import Mat4 from './type'
+import type { Mat4 } from './type.d.ts'
 
-export default rotateX
-
-declare function rotateX(out: Mat4, matrix: Mat4, radians: number): Mat4
+export function rotateX(out: Mat4, matrix: Mat4, radians: number): Mat4

package/src/maths/mat4/rotateX.js

@@ -1,15 +1,15 @@
-const { sin, cos } = require('../utils/trigonometry')
+import { sin, cos } from '../utils/trigonometry.js'
 
 /**
  * Rotates a matrix by the given angle around the X axis.
  *
- * @param {mat4} out - receiving matrix
- * @param {mat4} matrix - matrix to rotate
- * @param {Number} radians - angle to rotate the matrix by
- * @returns {mat4} out
+ * @param {Mat4} out - receiving matrix
+ * @param {Mat4} matrix - matrix to rotate
+ * @param {number} radians - angle to rotate the matrix by
+ * @returns {Mat4} out
  * @alias module:modeling/maths/mat4.rotateX
  */
-const rotateX = (out, matrix, radians) => {
+export const rotateX = (out, matrix, radians) => {
   const s = sin(radians)
   const c = cos(radians)
   const a10 = matrix[4]
@@ -43,5 +43,3 @@ const rotateX = (out, matrix, radians) => {
   out[11] = a23 * c - a13 * s
   return out
 }
-
-module.exports = rotateX

package/src/maths/mat4/rotateX.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { rotateX, create } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { rotateX, create } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('mat4: rotateX() called with out parameter should return a new mat4 with correct values', (t) => {
   const rotation = 90 * 0.017453292519943295

package/src/maths/mat4/rotateY.d.ts

@@ -1,5 +1,3 @@
-import Mat4 from './type'
+import type { Mat4 } from './type.d.ts'
 
-export default rotateY
-
-declare function rotateY(out: Mat4, matrix: Mat4, radians: number): Mat4
+export function rotateY(out: Mat4, matrix: Mat4, radians: number): Mat4

package/src/maths/mat4/rotateY.js

@@ -1,15 +1,15 @@
-const { sin, cos } = require('../utils/trigonometry')
+import { sin, cos } from '../utils/trigonometry.js'
 
 /**
  * Rotates a matrix by the given angle around the Y axis.
  *
- * @param {mat4} out - receiving matrix
- * @param {mat4} matrix - matrix to rotate
- * @param {Number} radians - angle to rotate the matrix by
- * @returns {mat4} out
+ * @param {Mat4} out - receiving matrix
+ * @param {Mat4} matrix - matrix to rotate
+ * @param {number} radians - angle to rotate the matrix by
+ * @returns {Mat4} out
  * @alias module:modeling/maths/mat4.rotateY
  */
-const rotateY = (out, matrix, radians) => {
+export const rotateY = (out, matrix, radians) => {
   const s = sin(radians)
   const c = cos(radians)
   const a00 = matrix[0]
@@ -43,5 +43,3 @@ const rotateY = (out, matrix, radians) => {
   out[11] = a03 * s + a23 * c
   return out
 }
-
-module.exports = rotateY

package/src/maths/mat4/rotateY.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { rotateY, create } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { rotateY, create } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('mat4: rotateY() called with out parameter should return a new mat4 with correct values', (t) => {
   const rotation = 90 * 0.017453292519943295

package/src/maths/mat4/rotateZ.d.ts

@@ -1,5 +1,3 @@
-import Mat4 from './type'
+import type { Mat4 } from './type.d.ts'
 
-export default rotateZ
-
-declare function rotateZ(out: Mat4, matrix: Mat4, radians: number): Mat4
+export function rotateZ(out: Mat4, matrix: Mat4, radians: number): Mat4

package/src/maths/mat4/rotateZ.js

@@ -1,15 +1,15 @@
-const { sin, cos } = require('../utils/trigonometry')
+import { sin, cos } from '../utils/trigonometry.js'
 
 /**
  * Rotates a matrix by the given angle around the Z axis.
  *
- * @param {mat4} out - receiving matrix
- * @param {mat4} matrix - matrix to rotate
- * @param {Number} radians - angle to rotate the matrix by
- * @returns {mat4} out
+ * @param {Mat4} out - receiving matrix
+ * @param {Mat4} matrix - matrix to rotate
+ * @param {number} radians - angle to rotate the matrix by
+ * @returns {Mat4} out
  * @alias module:modeling/maths/mat4.rotateZ
  */
-const rotateZ = (out, matrix, radians) => {
+export const rotateZ = (out, matrix, radians) => {
   const s = sin(radians)
   const c = cos(radians)
   const a00 = matrix[0]
@@ -43,5 +43,3 @@ const rotateZ = (out, matrix, radians) => {
   out[7] = a13 * c - a03 * s
   return out
 }
-
-module.exports = rotateZ

package/src/maths/mat4/rotateZ.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { rotateZ, create } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { rotateZ, create } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('mat4: rotateZ() called with out parameter should return a new mat4 with correct values', (t) => {
   const rotation = 90 * 0.017453292519943295

package/src/maths/mat4/scale.d.ts

@@ -1,6 +1,4 @@
-import Mat4 from './type'
-import Vec3 from '../vec3/type'
+import type { Mat4 } from './type.d.ts'
+import type { Vec3 } from '../vec3/type.d.ts'
 
-export default scale
-
-declare function scale(out: Mat4, matrix: Mat4, dimensions: Vec3): Mat4
+export function scale(out: Mat4, matrix: Mat4, dimensions: Vec3): Mat4

package/src/maths/mat4/scale.js

@@ -1,13 +1,13 @@
 /**
  * Scales the matrix by the given dimensions.
  *
- * @param {mat4} out - receiving matrix
- * @param {mat4} matrix - matrix to scale
- * @param {vec3} dimensions - dimensions to scale the matrix by
- * @returns {mat4} out
+ * @param {Mat4} out - receiving matrix
+ * @param {Mat4} matrix - matrix to scale
+ * @param {Vec3} dimensions - dimensions to scale the matrix by
+ * @returns {Mat4} out
  * @alias module:modeling/maths/mat4.scale
  */
-const scale = (out, matrix, dimensions) => {
+export const scale = (out, matrix, dimensions) => {
   const x = dimensions[0]
   const y = dimensions[1]
   const z = dimensions[2]
@@ -30,5 +30,3 @@ const scale = (out, matrix, dimensions) => {
   out[15] = matrix[15]
   return out
 }
-
-module.exports = scale

package/src/maths/mat4/scale.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { scale } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { scale } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('mat4: scale() called with out parameter should return a new mat4 with correct values', (t) => {
   const obs1 = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]

package/src/maths/mat4/subtract.d.ts

@@ -1,5 +1,3 @@
-import Mat4 from './type'
+import type { Mat4 } from './type.d.ts'
 
-export default subtract
-
-declare function subtract(out: Mat4, a: Mat4, b: Mat4): Mat4
+export function subtract(out: Mat4, a: Mat4, b: Mat4): Mat4

package/src/maths/mat4/subtract.js

@@ -1,13 +1,13 @@
 /**
  * Subtracts matrix b from matrix a. (A-B)
  *
- * @param {mat4} out - receiving matrix
- * @param {mat4} a - first operand
- * @param {mat4} b - second operand
- * @returns {mat4} out
+ * @param {Mat4} out - receiving matrix
+ * @param {Mat4} a - first operand
+ * @param {Mat4} b - second operand
+ * @returns {Mat4} out
  * @alias module:modeling/maths/mat4.subtract
  */
-const subtract = (out, a, b) => {
+export const subtract = (out, a, b) => {
   out[0] = a[0] - b[0]
   out[1] = a[1] - b[1]
   out[2] = a[2] - b[2]
@@ -26,5 +26,3 @@ const subtract = (out, a, b) => {
   out[15] = a[15] - b[15]
   return out
 }
-
-module.exports = subtract

package/src/maths/mat4/subtract.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { subtract } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { subtract } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('mat4: subtract() called with out parameter should return a new mat4 with correct values', (t) => {
   const obs1 = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]

package/src/maths/mat4/toString.d.ts

@@ -1,5 +1,3 @@
-import Mat4 from './type'
+import type { Mat4 } from './type.d.ts'
 
-export default toString
-
-declare function toString(matrix: Mat4): string
+export function toString(matrix: Mat4): string

package/src/maths/mat4/toString.js

@@ -1,10 +1,8 @@
 /**
  * Return a string representing the given matrix.
  *
- * @param {mat4} mat - matrix of reference
- * @returns {String} string representation
+ * @param {Mat4} mat - matrix of reference
+ * @returns {string} string representation
  * @alias module:modeling/maths/mat4.toString
  */
-const toString = (mat) => mat.map((n) => n.toFixed(7)).toString()
-
-module.exports = toString
+export const toString = (mat) => mat.map((n) => n.toFixed(7)).toString()

package/src/maths/mat4/translate.d.ts

@@ -1,6 +1,4 @@
-import Mat4 from './type'
-import Vec3 from '../vec3/type'
+import type { Mat4 } from './type.d.ts'
+import type { Vec3 } from '../vec3/type.d.ts'
 
-export default translate
-
-declare function translate(out: Mat4, matrix: Mat4, offsets: Vec3): Mat4
+export function translate(out: Mat4, matrix: Mat4, offsets: Vec3): Mat4

package/src/maths/mat4/translate.js

@@ -1,13 +1,13 @@
 /**
  * Translate the matrix by the given offset vector.
  *
- * @param {mat4} out - receiving matrix
- * @param {mat4} matrix - matrix to translate
- * @param {vec3} offsets - offset vector to translate by
- * @returns {mat4} out
+ * @param {Mat4} out - receiving matrix
+ * @param {Mat4} matrix - matrix to translate
+ * @param {Vec3} offsets - offset vector to translate by
+ * @returns {Mat4} out
  * @alias module:modeling/maths/mat4.translate
  */
-const translate = (out, matrix, offsets) => {
+export const translate = (out, matrix, offsets) => {
   const x = offsets[0]
   const y = offsets[1]
   const z = offsets[2]
@@ -47,5 +47,3 @@ const translate = (out, matrix, offsets) => {
 
   return out
 }
-
-module.exports = translate

package/src/maths/mat4/translate.test.js

@@ -1,15 +1,11 @@
-const test = require('ava')
-const { translate, create } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { translate, create, fromValues } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('mat4: translate() called with three parameters should update a mat4 with correct values', (t) => {
-  const identityMatrix = [
-    1, 0, 0, 0,
-    0, 1, 0, 0,
-    0, 0, 1, 0,
-    0, 0, 0, 1
-  ]
+  const identityMatrix = create()
 
   const obs1 = create()
   const ret1 = translate(obs1, identityMatrix, [0, 0, 0])
@@ -25,12 +21,12 @@ test('mat4: translate() called with three parameters should update a mat4 with c
   const x = 1
   const y = 5
   const z = 7
-  const translationMatrix = [
+  const translationMatrix = fromValues(
     1, 0, 0, 0,
     0, 1, 0, 0,
     0, 0, 1, 0,
     x, y, z, 1
-  ]
+  )
 
   const obs3 = create()
   const ret3 = translate(obs3, translationMatrix, [-2, -3, -6])
@@ -40,24 +36,24 @@ test('mat4: translate() called with three parameters should update a mat4 with c
   const w = 1
   const h = 3
   const d = 5
-  const scaleMatrix = [
+  const scaleMatrix = fromValues(
     w, 0, 0, 0,
     0, h, 0, 0,
     0, 0, d, 0,
     0, 0, 0, 1
-  ]
+  )
 
   const obs4 = create()
   const ret4 = translate(obs4, scaleMatrix, [2, 3, 6])
   t.true(compareVectors(obs4, [1, 0, 0, 0, 0, 3, 0, 0, 0, 0, 5, 0, 2, 9, 30, 1]))
   t.true(compareVectors(ret4, [1, 0, 0, 0, 0, 3, 0, 0, 0, 0, 5, 0, 2, 9, 30, 1]))
 
-  const rotateZMatrix = [
+  const rotateZMatrix = fromValues(
     0, -1, 0, 0,
     1, 0, 0, 0,
     0, 0, 1, 0,
     0, 0, 0, 1
-  ]
+  )
 
   const obs5 = create()
   const ret5 = translate(obs5, rotateZMatrix, [6, 4, 2])

package/src/maths/mat4/type.d.ts

@@ -1,6 +1,4 @@
-export default Mat4
-
-declare type Mat4 = [
+export type Mat4 = [
   number, number, number, number,
   number, number, number, number,
   number, number, number, number,

package/src/maths/plane/clone.d.ts

@@ -1,5 +1,3 @@
-import Plane from './type'
+import type { Plane } from './type.d.ts'
 
-export default clone
-
-declare function clone(plane: Plane): Plane
+export function clone(plane: Plane): Plane

package/src/maths/plane/clone.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { clone, fromValues } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { clone, fromValues } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('plane: clone() with one param should update a new plane with same values', (t) => {
   const plane1 = fromValues(0, 0, 0, 0)

package/src/maths/plane/copy.d.ts

@@ -1,5 +1,3 @@
-import Plane from './type'
+import type { Plane } from './type.d.ts'
 
-export default copy
-
-declare function copy(out: Plane, plane: Plane): Plane
+export function copy(out: Plane, plane: Plane): Plane

package/src/maths/plane/copy.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { create, copy, fromValues } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { create, copy, fromValues } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('plane: copy() with two params should update a plane with same values', (t) => {
   const org1 = create()

package/src/maths/plane/create.d.ts

@@ -1,5 +1,3 @@
-import Plane from './type'
+import type { Plane } from './type.d.ts'
 
-export default create
-
-declare function create(): Plane
+export function create(): Plane

package/src/maths/plane/create.test.js

@@ -1,8 +1,8 @@
-const test = require('ava')
+import test from 'ava'
 
-const { create } = require('./index')
+import { create } from './index.js'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('plane: create() should return a plane with initial values', (t) => {
   const obs = create()

package/src/maths/plane/equals.d.ts

@@ -1,5 +1,3 @@
-import Plane from './type'
+import type { Plane } from './type.d.ts'
 
-export default equals
-
-declare function equals(a: Plane, b: Plane): boolean
+export function equals(a: Plane, b: Plane): boolean

package/src/maths/plane/equals.test.js

@@ -1,5 +1,6 @@
-const test = require('ava')
-const { equals, fromValues } = require('./index')
+import test from 'ava'
+
+import { equals, fromValues } from './index.js'
 
 test('plane: equals() should return correct booleans', (t) => {
   const plane0 = fromValues(0, 0, 0, 0)

package/src/maths/plane/flip.d.ts

@@ -1,5 +1,3 @@
-import Plane from './type'
+import type { Plane } from './type.d.ts'
 
-export default flip
-
-declare function flip(out: Plane, plane: Plane): Plane
+export function flip(out: Plane, plane: Plane): Plane

package/src/maths/plane/flip.js

@@ -1,17 +1,15 @@
 /**
  * Flip the given plane.
  *
- * @param {plane} out - receiving plane
- * @param {plane} plane - plane to flip
- * @return {plane} out
+ * @param {Plane} out - receiving plane
+ * @param {Plane} plane - plane to flip
+ * @return {Plane} out
  * @alias module:modeling/maths/plane.flip
  */
-const flip = (out, plane) => {
+export const flip = (out, plane) => {
   out[0] = -plane[0]
   out[1] = -plane[1]
   out[2] = -plane[2]
   out[3] = -plane[3]
   return out
 }
-
-module.exports = flip

package/src/maths/plane/flip.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { create, flip } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { create, flip } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('plane: flip() called with two parameters should update a plane with correct values', (t) => {
   const org1 = create()

package/src/maths/plane/fromNormalAndPoint.d.ts

@@ -1,6 +1,4 @@
-import Plane from './type'
-import Vec3 from '../vec3/type'
+import type { Plane } from './type.d.ts'
+import type { Vec3 } from '../vec3/type.d.ts'
 
-export default fromNormalAndPoint
-
-declare function fromNormalAndPoint(out: Plane, normal: Vec3, point: Vec3): Plane
+export function fromNormalAndPoint(out: Plane, normal: Vec3, point: Vec3): Plane

package/src/maths/plane/fromNormalAndPoint.js

@@ -1,4 +1,4 @@
-const vec3 = require('../vec3')
+import * as vec3 from '../vec3/index.js'
 
 /**
  * Represents a plane in 3D coordinate space as determined by a normal (perpendicular to the plane)
@@ -6,19 +6,18 @@ const vec3 = require('../vec3')
  *
  * The contents of the array are a normal [0,1,2] and a distance [3].
  * @see https://en.wikipedia.org/wiki/Hesse_normal_form
- * @typedef {Array} plane
  */
 
 /**
  * Create a new plane from the given normal and point values.
  *
- * @param {plane} out - receiving plane
- * @param {vec3} normal - directional vector
- * @param {vec3} point - origin of plane
- * @returns {plane} out
+ * @param {Plane} out - receiving plane
+ * @param {Vec3} normal - directional vector
+ * @param {Vec3} point - origin of plane
+ * @returns {Plane} out
  * @alias module:modeling/maths/plane.fromNormalAndPoint
  */
-const fromNormalAndPoint = (out, normal, point) => {
+export const fromNormalAndPoint = (out, normal, point) => {
   const u = vec3.normalize(vec3.create(), normal)
   const w = vec3.dot(point, u)
 
@@ -28,5 +27,3 @@ const fromNormalAndPoint = (out, normal, point) => {
   out[3] = w
   return out
 }
-
-module.exports = fromNormalAndPoint

package/src/maths/plane/fromNormalAndPoint.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { fromNormalAndPoint, create } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { fromNormalAndPoint, create } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('plane: fromNormalAndPoint() should return a new plant with correct values', (t) => {
   const obs1 = fromNormalAndPoint(create(), [5, 0, 0], [0, 0, 0])