@jscad/modeling 2.11.1 → 3.0.0-alpha.0

package/src/maths/index.js

@@ -4,17 +4,14 @@
  * @see Most computations are based upon the glMatrix library (glmatrix.net)
  * @module modeling/maths
  * @example
- * const { constants, line2, mat4, vec2, vec3 } = require('@jscad/modeling').maths
-
+ * import { constants, line2, line3, mat4, plane, utils, vec2, vec3, vec4 } from '@jscad/modeling'
  */
-module.exports = {
-  constants: require('./constants'),
-  line2: require('./line2'),
-  line3: require('./line3'),
-  mat4: require('./mat4'),
-  plane: require('./plane'),
-  utils: require('./utils'),
-  vec2: require('./vec2'),
-  vec3: require('./vec3'),
-  vec4: require('./vec4')
-}
+export * from './constants.js'
+export * as line2 from './line2/index.js'
+export * as line3 from './line3/index.js'
+export * as mat4 from './mat4/index.js'
+export * as plane from './plane/index.js'
+export * as vec2 from './vec2/index.js'
+export * as vec3 from './vec3/index.js'
+export * as vec4 from './vec4/index.js'
+export { cos, sin } from './utils/trigonometry.js'

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

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

package/src/maths/line2/clone.js

@@ -1,18 +1,16 @@
-const create = require('./create')
+import { create } from './create.js'
 
 /**
  * Create a clone of the given line.
  *
- * @param {line2} line - line to clone
- * @returns {line2} a new unbounded line
+ * @param {Line2} line - line to clone
+ * @returns {Line2} a new unbounded line
  * @alias module:modeling/maths/line2.clone
  */
-const clone = (line) => {
+export const clone = (line) => {
   const out = create()
   out[0] = line[0]
   out[1] = line[1]
   out[2] = line[2]
   return out
 }
-
-module.exports = clone

package/src/maths/line2/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('line2: clone() should return a new line2 with same values', (t) => {
   const org1 = fromValues(0, 0, 0)

package/src/maths/line2/closestPoint.d.ts

@@ -1,6 +1,4 @@
-import Line2 from './type'
-import Vec2 from '../vec2/type'
+import type { Line2 } from './type.d.ts'
+import type { Vec2 } from '../vec2/type.d.ts'
 
-export default closestPoint
-
-declare function closestPoint(line: Line2, point: Vec2): Vec2
+export function closestPoint(line: Line2, point: Vec2): Vec2

package/src/maths/line2/closestPoint.js

@@ -1,17 +1,17 @@
-const vec2 = require('../vec2')
+import * as vec2 from '../vec2/index.js'
 
-const direction = require('./direction')
-const origin = require('./origin')
+import { direction } from './direction.js'
+import { origin } from './origin.js'
 
 /**
  * Determine the closest point on the given line to the given point.
  *
- * @param {line2} line - line of reference
- * @param {vec2} point - point of reference
- * @returns {vec2} closest point
+ * @param {Line2} line - line of reference
+ * @param {Vec2} point - point of reference
+ * @returns {Vec2} closest point
  * @alias module:modeling/maths/line2.closestPoint
  */
-const closestPoint = (line, point) => {
+export const closestPoint = (line, point) => {
   const orig = origin(line)
   const dir = direction(line)
 
@@ -21,5 +21,3 @@ const closestPoint = (line, point) => {
   vec2.add(v, v, orig)
   return v
 }
-
-module.exports = closestPoint

package/src/maths/line2/closestPoint.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { closestPoint, create, fromPoints } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { closestPoint, create, fromPoints } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('line2: closestPoint() should return proper values', (t) => {
   const line1 = create()

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

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

package/src/maths/line2/copy.js

@@ -1,16 +1,14 @@
 /**
  * Copy the given line to the receiving line.
  *
- * @param {line2} out - receiving line
- * @param {line2} line - line to copy
- * @returns {line2} out
+ * @param {Line2} out - receiving line
+ * @param {Line2} line - line to copy
+ * @returns {Line2} out
  * @alias module:modeling/maths/line2.copy
  */
-const copy = (out, line) => {
+export const copy = (out, line) => {
   out[0] = line[0]
   out[1] = line[1]
   out[2] = line[2]
   return out
 }
-
-module.exports = copy

package/src/maths/line2/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('line2: copy() with two params should update a line2 with same values', (t) => {
   const line1 = create()

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

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

package/src/maths/line2/create.js

@@ -1,20 +1,17 @@
 /**
- * Represents a unbounded line in 2D space, positioned at a point of origin.
- * A line is parametrized by a normal vector (perpendicular to the line, rotated 90 degrees counter clockwise) and
- * distance from the origin.
+ * Represents an unbounded line in 2D space, positioned at a point of origin.
+ * A line is parametrized by a normal vector (perpendicular to the line,
+ * rotated 90 degrees counterclockwise) and distance from the origin.
  *
  * Equation: A Point (P) is on Line (L) if dot(L.normal, P) == L.distance
  *
  * The contents of the array are a normal [0,1] and a distance [2].
- * @typedef {Array} line2
  */
 
 /**
  * Create a line, positioned at 0,0, and running along the X axis.
  *
- * @returns {line2} a new unbounded line
+ * @returns {Line2} a new unbounded line
  * @alias module:modeling/maths/line2.create
  */
-const create = () => [0, 1, 0] // normal and distance
-
-module.exports = create
+export const create = () => [0, 1, 0] // normal and distance

package/src/maths/line2/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('line2: create() should return a line2 with initial values', (t) => {
   const obs = create()

package/src/maths/line2/direction.d.ts

@@ -1,6 +1,4 @@
-import Line2 from './type'
-import Vec2 from '../vec2/type'
+import type { Line2 } from './type.d.ts'
+import type { Vec2 } from '../vec2/type.d.ts'
 
-export default direction
-
-declare function direction(line: Line2): Vec2
+export function direction(line: Line2): Vec2

package/src/maths/line2/direction.js

@@ -1,16 +1,14 @@
-const vec2 = require('../vec2')
+import * as vec2 from '../vec2/index.js'
 
 /**
  * Return the direction of the given line.
  *
- * @param {line2} line - line of reference
- * @return {vec2} a vector in the direction of the line
+ * @param {Line2} line - line of reference
+ * @return {Vec2} a vector in the direction of the line
  * @alias module:modeling/maths/line2.direction
  */
-const direction = (line) => {
+export const direction = (line) => {
   const vector = vec2.normal(vec2.create(), line)
   vec2.negate(vector, vector)
   return vector
 }
-
-module.exports = direction

package/src/maths/line2/direction.test.js

@@ -1,8 +1,8 @@
-const test = require('ava')
+import test from 'ava'
 
-const { direction, create, fromPoints } = require('./index')
+import { direction, create, fromPoints } from './index.js'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('line2: direction() should return proper direction', (t) => {
   const line1 = create()

package/src/maths/line2/distanceToPoint.d.ts

@@ -1,6 +1,4 @@
-import Line2 from './type'
-import Vec2 from '../vec2/type'
+import type { Line2 } from './type.d.ts'
+import type { Vec2 } from '../vec2/type.d.ts'
 
-export default distanceToPoint
-
-declare function distanceToPoint(line: Line2, point: Vec2): number
+export function distanceToPoint(line: Line2, point: Vec2): number

package/src/maths/line2/distanceToPoint.js

@@ -1,17 +1,15 @@
-const vec2 = require('../vec2')
+import * as vec2 from '../vec2/index.js'
 
 /**
  * Calculate the distance (positive) between the given point and line.
  *
- * @param {line2} line - line of reference
- * @param {vec2} point - point of reference
- * @return {Number} distance between line and point
+ * @param {Line2} line - line of reference
+ * @param {Vec2} point - point of reference
+ * @return {number} distance between line and point
  * @alias module:modeling/maths/line2.distanceToPoint
  */
-const distanceToPoint = (line, point) => {
+export const distanceToPoint = (line, point) => {
   let distance = vec2.dot(point, line)
   distance = Math.abs(distance - line[2])
   return distance
 }
-
-module.exports = distanceToPoint

package/src/maths/line2/distanceToPoint.test.js

@@ -1,8 +1,10 @@
-const test = require('ava')
-const { distanceToPoint, create, fromPoints } = require('./index')
+import test from 'ava'
 
-const { nearlyEqual } = require('../../../test/helpers/index')
-const { EPS } = require('../constants')
+import { EPS } from '../constants.js'
+
+import { distanceToPoint, create, fromPoints } from './index.js'
+
+import { nearlyEqual } from '../../../test/helpers/index.js'
 
 test('line2: distanceToPoint() should return proper values', (t) => {
   const line1 = create()

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

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

package/src/maths/line2/equals.js

@@ -1,11 +1,9 @@
 /**
  * Compare the given lines for equality.
  *
- * @param {line2} line1 - first line to compare
- * @param {line2} line2 - second line to compare
- * @return {Boolean} true if lines are equal
+ * @param {Line2} line1 - first line to compare
+ * @param {Line2} line2 - second line to compare
+ * @return {boolean} true if lines are equal
  * @alias module:modeling/maths/line2.equals
  */
-const equals = (line1, line2) => (line1[0] === line2[0]) && (line1[1] === line2[1] && (line1[2] === line2[2]))
-
-module.exports = equals
+export const equals = (line1, line2) => (line1[0] === line2[0]) && (line1[1] === line2[1] && (line1[2] === line2[2]))

package/src/maths/line2/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('line2: equals() should return correct booleans', (t) => {
   const line0 = fromValues(0, 0, 0)

package/src/maths/line2/fromPoints.d.ts

@@ -1,6 +1,4 @@
-import Line2 from './type'
-import Vec2 from '../vec2/type'
+import type { Line2 } from './type.d.ts'
+import type { Vec2 } from '../vec2/type.d.ts'
 
-export default fromPoints
-
-declare function fromPoints(out: Line2, point1: Vec2, point2: Vec2): Line2
+export function fromPoints(out: Line2, point1: Vec2, point2: Vec2): Line2

package/src/maths/line2/fromPoints.js

@@ -1,15 +1,15 @@
-const vec2 = require('../vec2')
+import * as vec2 from '../vec2/index.js'
 
 /**
  * Create a new line that passes through the given points.
  *
- * @param {line2} out - receiving line
- * @param {vec2} point1 - start point of the line
- * @param {vec2} point2 - end point of the line
- * @returns {line2} a new unbounded line
+ * @param {Line2} out - receiving line
+ * @param {Vec2} point1 - start point of the line
+ * @param {Vec2} point2 - end point of the line
+ * @returns {Line2} a new unbounded line
  * @alias module:modeling/maths/line2.fromPoints
  */
-const fromPoints = (out, point1, point2) => {
+export const fromPoints = (out, point1, point2) => {
   const vector = vec2.subtract(vec2.create(), point2, point1) // directional vector
 
   vec2.normal(vector, vector)
@@ -22,5 +22,3 @@ const fromPoints = (out, point1, point2) => {
   out[2] = distance
   return out
 }
-
-module.exports = fromPoints

package/src/maths/line2/fromPoints.test.js

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

package/src/maths/line2/fromValues.d.ts

@@ -1,5 +1,3 @@
-import Line2 from './type'
+import type { Line2 } from './type.d.ts'
 
-export default fromValues
-
-declare function fromValues(x: number, y: number, d: number): Line2
+export function fromValues(x: number, y: number, d: number): Line2

package/src/maths/line2/fromValues.js

@@ -1,20 +1,18 @@
-const create = require('./create')
+import { create } from './create.js'
 
 /**
  * Creates a new line initialized with the given values.
  *
- * @param {Number} x - X coordinate of the unit normal
- * @param {Number} y - Y coordinate of the unit normal
- * @param {Number} d - distance of the line from [0,0]
- * @returns {line2} a new unbounded line
+ * @param {number} x - X coordinate of the unit normal
+ * @param {number} y - Y coordinate of the unit normal
+ * @param {number} d - distance of the line from [0,0]
+ * @returns {Line2} a new unbounded line
  * @alias module:modeling/maths/line2.fromValues
  */
-const fromValues = (x, y, d) => {
+export const fromValues = (x, y, d) => {
   const out = create()
   out[0] = x
   out[1] = y
   out[2] = d
   return out
 }
-
-module.exports = fromValues

package/src/maths/line2/fromValues.test.js

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

package/src/maths/line2/index.d.ts

@@ -1,18 +1,17 @@
-export { default as clone } from './clone'
-export { default as closestPoint } from './closestPoint'
-export { default as copy } from './copy'
-export { default as create } from './create'
-export { default as direction } from './direction'
-export { default as distanceToPoint } from './distanceToPoint'
-export { default as equals } from './equals'
-export { default as fromPoints } from './fromPoints'
-export { default as fromValues } from './fromValues'
-export { default as intersectPointOfLines } from './intersectPointOfLines'
-export { default as origin } from './origin'
-export { default as reverse } from './reverse'
-export { default as toString } from './toString'
-export { default as transform } from './transform'
-export { default as xAtY } from './xAtY'
+export { clone } from './clone.js'
+export { closestPoint } from './closestPoint.js'
+export { copy } from './copy.js'
+export { create } from './create.js'
+export { direction } from './direction.js'
+export { distanceToPoint } from './distanceToPoint.js'
+export { equals } from './equals.js'
+export { fromPoints } from './fromPoints.js'
+export { fromValues } from './fromValues.js'
+export { intersectPointOfLines } from './intersectPointOfLines.js'
+export { origin } from './origin.js'
+export { reverse } from './reverse.js'
+export { toString } from './toString.js'
+export { transform } from './transform.js'
+export { xAtY } from './xAtY.js'
 
-export { default as Line2 } from './type'
-export as namespace line2
+export type { Line2 } from './type.d.ts'

package/src/maths/line2/index.js

@@ -1,22 +1,20 @@
 /**
- * Represents a unbounded line in 2D space, positioned at a point of origin.
+ * Represents an unbounded line in 2D space, positioned at a point of origin.
  * @see {@link line2} for data structure information.
  * @module modeling/maths/line2
  */
-module.exports = {
-  clone: require('./clone'),
-  closestPoint: require('./closestPoint'),
-  copy: require('./copy'),
-  create: require('./create'),
-  direction: require('./direction'),
-  distanceToPoint: require('./distanceToPoint'),
-  equals: require('./equals'),
-  fromPoints: require('./fromPoints'),
-  fromValues: require('./fromValues'),
-  intersectPointOfLines: require('./intersectPointOfLines'),
-  origin: require('./origin'),
-  reverse: require('./reverse'),
-  toString: require('./toString'),
-  transform: require('./transform'),
-  xAtY: require('./xAtY')
-}
+export { clone } from './clone.js'
+export { closestPoint } from './closestPoint.js'
+export { copy } from './copy.js'
+export { create } from './create.js'
+export { direction } from './direction.js'
+export { distanceToPoint } from './distanceToPoint.js'
+export { equals } from './equals.js'
+export { fromPoints } from './fromPoints.js'
+export { fromValues } from './fromValues.js'
+export { intersectPointOfLines } from './intersectPointOfLines.js'
+export { origin } from './origin.js'
+export { reverse } from './reverse.js'
+export { toString } from './toString.js'
+export { transform } from './transform.js'
+export { xAtY } from './xAtY.js'

package/src/maths/line2/intersectPointOfLines.d.ts

@@ -1,6 +1,4 @@
-import Line2 from './type'
-import Vec2 from '../vec2/type'
+import type { Line2 } from './type.d.ts'
+import type { Vec2 } from '../vec2/type.d.ts'
 
-export default intersectPointOfLines
-
-declare function intersectPointOfLines(a: Line2, b: Line2): Vec2
+export function intersectPointOfLines(a: Line2, b: Line2): Vec2

package/src/maths/line2/intersectPointOfLines.js

@@ -1,5 +1,6 @@
-const vec2 = require('../vec2')
-const { solve2Linear } = require('../utils')
+import * as vec2 from '../vec2/index.js'
+
+import { solve2Linear } from '../utils/solve2Linear.js'
 
 /**
  * Return the point of intersection between the given lines.
@@ -8,14 +9,12 @@ const { solve2Linear } = require('../utils')
  * The point will have Infinity values if the lines are parallel.
  * The point will have NaN values if the lines are the same.
  *
- * @param {line2} line1 - line of reference
- * @param {line2} line2 - line of reference
- * @return {vec2} the point of intersection
+ * @param {Line2} line1 - line of reference
+ * @param {Line2} line2 - line of reference
+ * @return {Vec2} the point of intersection
  * @alias module:modeling/maths/line2.intersectPointOfLines
  */
-const intersectToLine = (line1, line2) => {
+export const intersectPointOfLines = (line1, line2) => {
   const point = solve2Linear(line1[0], line1[1], line2[0], line2[1], line1[2], line2[2])
   return vec2.clone(point)
 }
-
-module.exports = intersectToLine

package/src/maths/line2/intersectPointOfLines.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { intersectPointOfLines, create, fromPoints } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { intersectPointOfLines, create, fromPoints } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('line2: intersectPointOfLines() should return proper points', (t) => {
   const line1 = create()

package/src/maths/line2/origin.d.ts

@@ -1,6 +1,4 @@
-import Line2 from './type'
-import Vec2 from '../vec2/type'
+import type { Line2 } from './type.d.ts'
+import type { Vec2 } from '../vec2/type.d.ts'
 
-export default origin
-
-declare function origin(line: Line2): Vec2
+export function origin(line: Line2): Vec2

package/src/maths/line2/origin.js

@@ -1,13 +1,11 @@
-const vec2 = require('../vec2')
+import * as vec2 from '../vec2/index.js'
 
 /**
  * Return the origin of the given line.
  * The origin is the point on the line which is closest to the origin [0, 0].
  *
- * @param {line2} line - line of reference
- * @return {vec2} the origin of the line
+ * @param {Line2} line - line of reference
+ * @return {Vec2} the origin of the line
  * @alias module:modeling/maths/line2.origin
  */
-const origin = (line) => vec2.scale(vec2.create(), line, line[2])
-
-module.exports = origin
+export const origin = (line) => vec2.scale(vec2.create(), line, line[2])

package/src/maths/line2/origin.test.js

@@ -1,7 +1,8 @@
-const test = require('ava')
-const { origin, create, fromPoints } = require('./index')
+import test from 'ava'
 
-const { compareVectors } = require('../../../test/helpers/index')
+import { origin, create, fromPoints } from './index.js'
+
+import { compareVectors } from '../../../test/helpers/index.js'
 
 test('line2: origin() should return proper origins', (t) => {
   const line1 = create()