@jscad/modeling 2.12.0 → 3.0.0-alpha.0

package/src/maths/vec3/min.js

@@ -1,17 +1,15 @@
 /**
  * Returns the minimum coordinates of the given vectors.
  *
- * @param {vec3} out - receiving vector
- * @param {vec3} a - first operand
- * @param {vec3} b - second operand
- * @returns {vec3} out
+ * @param {Vec3} out - receiving vector
+ * @param {Vec3} a - first operand
+ * @param {Vec3} b - second operand
+ * @returns {Vec3} out
  * @alias module:modeling/maths/vec3.min
  */
-const min = (out, a, b) => {
+export const min = (out, a, b) => {
   out[0] = Math.min(a[0], b[0])
   out[1] = Math.min(a[1], b[1])
   out[2] = Math.min(a[2], b[2])
   return out
 }
-
-module.exports = min

package/src/maths/vec3/min.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { min, fromValues } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { min, fromValues } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('vec3: min() called with three parameters should update a vec3 with correct values', (t) => {
   const obs1 = fromValues(0, 0, 0)

package/src/maths/vec3/multiply.d.ts

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

package/src/maths/vec3/multiply.js

@@ -1,17 +1,15 @@
 /**
  * Multiply the coordinates of the given vectors (A*B).
  *
- * @param {vec3} out - receiving vector
- * @param {vec3} a - first operand
- * @param {vec3} b - second operand
- * @returns {vec3} out
+ * @param {Vec3} out - receiving vector
+ * @param {Vec3} a - first operand
+ * @param {Vec3} b - second operand
+ * @returns {Vec3} out
  * @alias module:modeling/maths/vec3.multiply
  */
-const multiply = (out, a, b) => {
+export const multiply = (out, a, b) => {
   out[0] = a[0] * b[0]
   out[1] = a[1] * b[1]
   out[2] = a[2] * b[2]
   return out
 }
-
-module.exports = multiply

package/src/maths/vec3/multiply.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { multiply, fromValues } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { multiply, fromValues } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('vec3: multiply() called with three parameters should update a vec3 with correct values', (t) => {
   const obs1 = fromValues(0, 0, 0)

package/src/maths/vec3/negate.d.ts

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

package/src/maths/vec3/negate.js

@@ -1,16 +1,14 @@
 /**
  * Negates the coordinates of the given vector.
  *
- * @param {vec3} out - receiving vector
- * @param {vec3} vector - vector to negate
- * @returns {vec3} out
+ * @param {Vec3} out - receiving vector
+ * @param {Vec3} vector - vector to negate
+ * @returns {Vec3} out
  * @alias module:modeling/maths/vec3.negate
  */
-const negate = (out, vector) => {
+export const negate = (out, vector) => {
   out[0] = -vector[0]
   out[1] = -vector[1]
   out[2] = -vector[2]
   return out
 }
-
-module.exports = negate

package/src/maths/vec3/negate.test.js

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

package/src/maths/vec3/normalize.d.ts

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

package/src/maths/vec3/normalize.js

@@ -1,12 +1,12 @@
 /**
  * Normalize the given vector.
  *
- * @param {vec3} out - receiving vector
- * @param {vec3} vector - vector to normalize
- * @returns {vec3} out
+ * @param {Vec3} out - receiving vector
+ * @param {Vec3} vector - vector to normalize
+ * @returns {Vec3} out
  * @alias module:modeling/maths/vec3.normalize
  */
-const normalize = (out, vector) => {
+export const normalize = (out, vector) => {
   const x = vector[0]
   const y = vector[1]
   const z = vector[2]
@@ -19,5 +19,3 @@ const normalize = (out, vector) => {
   out[2] = z * len
   return out
 }
-
-module.exports = normalize

package/src/maths/vec3/normalize.test.js

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

package/src/maths/vec3/orthogonal.d.ts

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

package/src/maths/vec3/orthogonal.js

@@ -1,16 +1,16 @@
-const abs = require('./abs')
-const create = require('./create')
-const cross = require('./cross')
+import { abs } from './abs.js'
+import { create } from './create.js'
+import { cross } from './cross.js'
 
 /**
  * Create a new vector that is orthogonal to the given vector.
  *
- * @param {vec3} out - receiving vector
- * @param {vec3} vector - vector of reference
- * @returns {vec3} out
+ * @param {Vec3} out - receiving vector
+ * @param {Vec3} vector - vector of reference
+ * @returns {Vec3} out
  * @alias module:modeling/maths/vec3.orthogonal
  */
-const orthogonal = (out, vector) => {
+export const orthogonal = (out, vector) => {
   const bV = abs(create(), vector)
   const b0 = 0 + ((bV[0] < bV[1]) && (bV[0] < bV[2]))
   const b1 = 0 + ((bV[1] <= bV[0]) && (bV[1] < bV[2]))
@@ -18,5 +18,3 @@ const orthogonal = (out, vector) => {
 
   return cross(out, vector, [b0, b1, b2])
 }
-
-module.exports = orthogonal

package/src/maths/vec3/orthogonal.test.js

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

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

@@ -1,5 +1,3 @@
-import Vec3 from './type'
+import type { Vec3 } from './type.d.ts'
 
-export default rotateX
-
-declare function rotateX(out: Vec3, vector: Vec3, origin: Vec3, angle: number): Vec3
+export function rotateX(out: Vec3, vector: Vec3, origin: Vec3, angle: number): Vec3

package/src/maths/vec3/rotateX.js

@@ -1,14 +1,14 @@
 /**
  * Rotate the given vector around the given origin, X axis only.
  *
- * @param {vec3} out - receiving vector
- * @param {vec3} vector - vector to rotate
- * @param {vec3} origin - origin of the rotation
- * @param {Number} radians - angle of rotation
- * @returns {vec3} out
+ * @param {Vec3} out - receiving vector
+ * @param {Vec3} vector - vector to rotate
+ * @param {Vec3} origin - origin of the rotation
+ * @param {number} radians - angle of rotation
+ * @returns {Vec3} out
  * @alias module:modeling/maths/vec3.rotateX
  */
-const rotateX = (out, vector, origin, radians) => {
+export const rotateX = (out, vector, origin, radians) => {
   const p = []
   const r = []
 
@@ -29,5 +29,3 @@ const rotateX = (out, vector, origin, radians) => {
 
   return out
 }
-
-module.exports = rotateX

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

@@ -1,10 +1,10 @@
-const test = require('ava')
+import test from 'ava'
 
-const { TAU } = require('../constants')
+import { TAU } from '../constants.js'
 
-const { rotateX, fromValues } = require('./index')
+import { rotateX, fromValues } from './index.js'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('vec3: rotateX() called with four parameters should update a vec3 with correct values', (t) => {
   const radians = TAU / 4

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

@@ -1,5 +1,3 @@
-import Vec3 from './type'
+import type { Vec3 } from './type.d.ts'
 
-export default rotateY
-
-declare function rotateY(out: Vec3, vector: Vec3, origin: Vec3, angle: number): Vec3
+export function rotateY(out: Vec3, vector: Vec3, origin: Vec3, angle: number): Vec3

package/src/maths/vec3/rotateY.js

@@ -1,14 +1,14 @@
 /**
  * Rotate the given vector around the given origin, Y axis only.
  *
- * @param {vec3} out - receiving vector
- * @param {vec3} vector - vector to rotate
- * @param {vec3} origin - origin of the rotation
- * @param {Number} radians - angle of rotation
- * @returns {vec3} out
+ * @param {Vec3} out - receiving vector
+ * @param {Vec3} vector - vector to rotate
+ * @param {Vec3} origin - origin of the rotation
+ * @param {number} radians - angle of rotation
+ * @returns {Vec3} out
  * @alias module:modeling/maths/vec3.rotateY
  */
-const rotateY = (out, vector, origin, radians) => {
+export const rotateY = (out, vector, origin, radians) => {
   const p = []
   const r = []
 
@@ -29,5 +29,3 @@ const rotateY = (out, vector, origin, radians) => {
 
   return out
 }
-
-module.exports = rotateY

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

@@ -1,10 +1,10 @@
-const test = require('ava')
+import test from 'ava'
 
-const { TAU } = require('../constants')
+import { TAU } from '../constants.js'
 
-const { rotateY, fromValues } = require('./index')
+import { rotateY, fromValues } from './index.js'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('vec3: rotateY() called with three parameters should update a vec3 with correct values', (t) => {
   const radians = TAU / 4

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

@@ -1,5 +1,3 @@
-import Vec3 from './type'
+import type { Vec3 } from './type.d.ts'
 
-export default rotateZ
-
-declare function rotateZ(out: Vec3, vector: Vec3, origin: Vec3, angle: number): Vec3
+export function rotateZ(out: Vec3, vector: Vec3, origin: Vec3, angle: number): Vec3

package/src/maths/vec3/rotateZ.js

@@ -1,14 +1,14 @@
 /**
  * Rotate the given vector around the given origin, Z axis only.
  *
- * @param {vec3} out - receiving vector
- * @param {vec3} vector - vector to rotate
- * @param {vec3} origin - origin of the rotation
- * @param {Number} radians - angle of rotation in radians
- * @returns {vec3} out
+ * @param {Vec3} out - receiving vector
+ * @param {Vec3} vector - vector to rotate
+ * @param {Vec3} origin - origin of the rotation
+ * @param {number} radians - angle of rotation in radians
+ * @returns {Vec3} out
  * @alias module:modeling/maths/vec3.rotateZ
  */
-const rotateZ = (out, vector, origin, radians) => {
+export const rotateZ = (out, vector, origin, radians) => {
   const p = []
   const r = []
   // Translate point to the origin
@@ -26,5 +26,3 @@ const rotateZ = (out, vector, origin, radians) => {
 
   return out
 }
-
-module.exports = rotateZ

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

@@ -1,10 +1,10 @@
-const test = require('ava')
+import test from 'ava'
 
-const { TAU } = require('../constants')
+import { TAU } from '../constants.js'
 
-const { rotateZ, fromValues } = require('./index')
+import { rotateZ, fromValues } from './index.js'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('vec3: rotateZ() called with four parameters should update a vec3 with correct values', (t) => {
   const radians = TAU / 4

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

@@ -1,5 +1,3 @@
-import Vec3 from './type'
+import type { Vec3 } from './type.d.ts'
 
-export default scale
-
-declare function scale(out: Vec3, vector: Vec3, amount: number): Vec3
+export function scale(out: Vec3, vector: Vec3, amount: number): Vec3

package/src/maths/vec3/scale.js

@@ -1,17 +1,15 @@
 /**
  * Scales the coordinates of the given vector by a scalar number.
  *
- * @param {vec3} out - receiving vector
- * @param {vec3} vector - vector to scale
- * @param {Number} amount - amount to scale the vector by
- * @returns {vec3} out
+ * @param {Vec3} out - receiving vector
+ * @param {Vec3} vector - vector to scale
+ * @param {number} amount - amount to scale the vector by
+ * @returns {Vec3} out
  * @alias module:modeling/maths/vec3.scale
  */
-const scale = (out, vector, amount) => {
+export const scale = (out, vector, amount) => {
   out[0] = vector[0] * amount
   out[1] = vector[1] * amount
   out[2] = vector[2] * amount
   return out
 }
-
-module.exports = scale

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

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { scale, fromValues } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { scale, fromValues } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('vec3: scale() called with three parameters should update a vec3 with correct values', (t) => {
   const obs1 = fromValues(0, 0, 0)

package/src/maths/vec3/snap.d.ts

@@ -1,5 +1,3 @@
-import Vec3 from './type'
+import type { Vec3 } from './type.d.ts'
 
-export default snap
-
-declare function snap(out: Vec3, vector: Vec3, epsilon: number): Vec3
+export function snap(out: Vec3, vector: Vec3, epsilon: number): Vec3

package/src/maths/vec3/snap.js

@@ -1,17 +1,15 @@
 /**
  * Snaps the coordinates of the given vector to the given epsilon.
  *
- * @param {vec3} out - receiving vector
- * @param {vec3} vector - vector to snap
- * @param {Number} epsilon - epsilon of precision, less than 0
- * @returns {vec3} out
+ * @param {Vec3} out - receiving vector
+ * @param {Vec3} vector - vector to snap
+ * @param {number} epsilon - epsilon of precision, less than 0
+ * @returns {Vec3} out
  * @alias module:modeling/maths/vec3.snap
  */
-const snap = (out, vector, epsilon) => {
+export const snap = (out, vector, epsilon) => {
   out[0] = Math.round(vector[0] / epsilon) * epsilon + 0
   out[1] = Math.round(vector[1] / epsilon) * epsilon + 0
   out[2] = Math.round(vector[2] / epsilon) * epsilon + 0
   return out
 }
-
-module.exports = snap

package/src/maths/vec3/snap.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { snap, create } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { snap, create } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('vec3: snap() should return vec3 with correct values', (t) => {
   const output = create()

package/src/maths/vec3/squaredDistance.d.ts

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

package/src/maths/vec3/squaredDistance.js

@@ -1,16 +1,14 @@
 /**
  * Calculates the squared distance between two vectors.
  *
- * @param {vec3} a - first operand
- * @param {vec3} b - second operand
- * @returns {Number} squared distance
+ * @param {Vec3} a - first operand
+ * @param {Vec3} b - second operand
+ * @returns {number} squared distance
  * @alias module:modeling/maths/vec3.squaredDistance
  */
-const squaredDistance = (a, b) => {
+export const squaredDistance = (a, b) => {
   const x = b[0] - a[0]
   const y = b[1] - a[1]
   const z = b[2] - a[2]
   return x * x + y * y + z * z
 }
-
-module.exports = squaredDistance

package/src/maths/vec3/squaredDistance.test.js

@@ -1,8 +1,10 @@
-const test = require('ava')
-const { squaredDistance, fromValues } = require('./index')
+import test from 'ava'
 
-const { nearlyEqual } = require('../../../test/helpers/index')
-const { EPS } = require('../constants')
+import { EPS } from '../constants.js'
+
+import { squaredDistance, fromValues } from './index.js'
+
+import { nearlyEqual } from '../../../test/helpers/index.js'
 
 test('vec3: squaredDistance() should return correct values', (t) => {
   const vec0 = fromValues(0, 0, 0)

package/src/maths/vec3/squaredLength.d.ts

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

package/src/maths/vec3/squaredLength.js

@@ -1,15 +1,13 @@
 /**
  * Calculates the squared length of the given vector.
  *
- * @param {vec3} vector - vector to calculate squared length of
- * @returns {Number} squared length
+ * @param {Vec3} vector - vector to calculate squared length of
+ * @returns {number} squared length
  * @alias module:modeling/maths/vec3.squaredLength
  */
-const squaredLength = (vector) => {
+export const squaredLength = (vector) => {
   const x = vector[0]
   const y = vector[1]
   const z = vector[2]
   return x * x + y * y + z * z
 }
-
-module.exports = squaredLength

package/src/maths/vec3/squaredLength.test.js

@@ -1,8 +1,10 @@
-const test = require('ava')
-const { squaredLength, fromValues } = require('./index')
+import test from 'ava'
 
-const { nearlyEqual } = require('../../../test/helpers/index')
-const { EPS } = require('../constants')
+import { EPS } from '../constants.js'
+
+import { squaredLength, fromValues } from './index.js'
+
+import { nearlyEqual } from '../../../test/helpers/index.js'
 
 test('vec3: length() should return correct values', (t) => {
   const vec1 = fromValues(0, 0, 0)

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

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

package/src/maths/vec3/subtract.js

@@ -1,17 +1,15 @@
 /**
  * Subtracts the coordinates of two vectors (A-B).
  *
- * @param {vec3} out - receiving vector
- * @param {vec3} a - minuend vector
- * @param {vec3} b - subtrahend vector
- * @returns {vec3} out
+ * @param {Vec3} out - receiving vector
+ * @param {Vec3} a - minuend vector
+ * @param {Vec3} b - subtrahend vector
+ * @returns {Vec3} out
  * @alias module:modeling/maths/vec3.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]
   return out
 }
-
-module.exports = subtract

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

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { subtract, fromValues } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { subtract, fromValues } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('vec3: subtract() called with three parameters should update a vec3 with correct values', (t) => {
   const obs1 = fromValues(0, 0, 0)

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

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

package/src/maths/vec3/toString.js

@@ -1,9 +1,7 @@
 /**
  * Convert the given vector to a representative string.
- * @param {vec3} vec - vector of reference
- * @returns {String} string representation
+ * @param {Vec3} vec - vector of reference
+ * @returns {string} string representation
  * @alias module:modeling/maths/vec3.toString
  */
-const toString = (vec) => `[${vec[0].toFixed(7)}, ${vec[1].toFixed(7)}, ${vec[2].toFixed(7)}]`
-
-module.exports = toString
+export const toString = (vec) => `[${vec[0].toFixed(7)}, ${vec[1].toFixed(7)}, ${vec[2].toFixed(7)}]`