@jscad/x3d-serializer 2.4.10 → 3.0.1-alpha.0

package/package.json

@@ -1,26 +1,31 @@
 {
   "name": "@jscad/x3d-serializer",
-  "version": "2.4.10",
+  "version": "3.0.1-alpha.0",
   "description": "X3D Serializer for JSCAD",
   "homepage": "https://openjscad.xyz/",
   "repository": "https://github.com/jscad/OpenJSCAD.org",
+  "type": "module",
   "main": "src/index.js",
+  "unpkg": "dist/jscad-x3d-serializer.min.js",
+  "module": "dist/jscad-x3d-serializer.es.js",
   "scripts": {
-    "coverage": "nyc --all --reporter=html --reporter=text npm test",
-    "test": "ava --verbose --timeout 2m './tests/*.test.js'"
+    "build": "rollup --config",
+    "coverage": "c8 --all --reporter=html --reporter=text pnpm test",
+    "test": "ava --verbose --timeout 2m './tests/*.test.js'",
+    "version": "pnpm run build && git add dist"
   },
   "contributors": [
     {
       "name": "Rene K. Mueller",
-      "url": "http://renekmueller.com"
+      "url": "https://github.com/Spiritdude"
     },
     {
       "name": "z3dev",
-      "url": "http://www.z3d.jp"
+      "url": "https://github.com/z3dev"
     },
     {
       "name": "Mark 'kaosat-dev' Moissette",
-      "url": "http://kaosat.net"
+      "url": "https://github.com/kaosat-dev"
     }
   ],
   "keywords": [
@@ -32,13 +37,18 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@jscad/array-utils": "2.1.4",
-    "@jscad/modeling": "2.12.5",
-    "onml": "1.3.0"
+    "@jscad/array-utils": "3.0.1-alpha.0",
+    "@jscad/io-utils": "^3.0.1-alpha.0",
+    "@jscad/modeling": "3.0.1-alpha.0",
+    "onml": "^1.3.0"
   },
   "devDependencies": {
-    "ava": "3.15.0",
-    "nyc": "15.1.0"
+    "@rollup/plugin-node-resolve": "^15.0.1",
+    "@rollup/plugin-terser": "^0.4.3",
+    "ava": "^4.3.3",
+    "c8": "^8.0.0",
+    "rollup": "^2.79.1",
+    "rollup-plugin-banner": "^0.2.1"
   },
-  "gitHead": "d8010c4f1d70685404a510d604f8b6d5c362f93a"
+  "gitHead": "0660b5c1f1a5faf54d4cfae1cb85bb94182a8d32"
 }

package/rollup.config.js

@@ -0,0 +1,25 @@
+import banner from 'rollup-plugin-banner'
+import { nodeResolve } from '@rollup/plugin-node-resolve'
+import terser from '@rollup/plugin-terser'
+
+export default {
+  input: 'src/index.js',
+
+  output: [
+    {
+      file: 'dist/jscad-x3d-serializer.min.js',
+      format: 'umd',
+      name: 'jscadX3dSerializer'
+    },
+    {
+      file: 'dist/jscad-x3d-serializer.es.js',
+      format: 'es'
+    }
+  ],
+
+  plugins: [
+    nodeResolve(),
+    banner('<%= pkg.description %>\n@module <%= pkg.name %>\n@version <%= pkg.version %>\n@license <%= pkg.license %>'),
+    terser({ compress: { module: true }, mangle: false, format: { comments: 'some' } })
+  ]
+}

package/src/index.js

@@ -1,20 +1,8 @@
-/*
-JSCAD Object to X3D (XML) Format Serialization
-
-## License
+import { generalize, geom2, geom3, path2, poly2, poly3 } from '@jscad/modeling'
 
-Copyright (c) 2018-2022 JSCAD Organization https://github.com/jscad
+import { flatten } from '@jscad/array-utils'
 
-All code released under MIT license
-
-Notes:
-1) geom2 conversion to:
-     Polyline2D with lineSegment and Color
-2) geom3 conversion to:
-     IndexedTriangleSet with Coordinates and Colors
-3) path2 conversion to:
-     Polyline2D with lineSegment and Color
-*/
+import { stringify } from '@jscad/io-utils'
 
 /**
  * Serializer of JSCAD geometries to X3D source data (XML).
@@ -31,17 +19,6 @@ Notes:
  * const { serializer, mimeType } = require('@jscad/x3d-serializer')
  */
 
-const { geometries, modifiers } = require('@jscad/modeling')
-const { geom2, geom3, path2, poly2, poly3 } = geometries
-
-const { flatten } = require('@jscad/array-utils')
-
-const stringify = require('onml/lib/stringify')
-
-// http://www.web3d.org/x3d/content/X3dTooltips.html
-// http://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Meshes
-// https://x3dgraphics.com/examples/X3dForWebAuthors/Chapter13GeometryTrianglesQuadrilaterals/
-
 const mimeType = 'model/x3d+xml'
 const defNames = new Map()
 
@@ -120,7 +97,7 @@ const convertObjects = (objects, options) => {
 
     if (geom3.isA(object)) {
       // convert to triangles
-      object = modifiers.generalize({ snap: true, triangulate: true }, object)
+      object = generalize({ snap: true, triangulate: true }, object)
       const polygons = geom3.toPolygons(object)
       if (polygons.length > 0) {
         shapes.push(convertGeom3(object, options))
@@ -190,7 +167,7 @@ const checkDefName = (defName) => {
  * Convert the given object (poly2) to X3D source
  */
 const convertPolyline2D = (object, options) => {
-  const lineSegments = object.vertices.map((p) => `${p[0]} ${p[1]}`).join(' ')
+  const lineSegments = object.points.map((p) => `${p[0]} ${p[1]}`).join(' ')
   return ['Polyline2D', { lineSegments }]
 }
 
@@ -248,7 +225,7 @@ const convertToTriangles = (object, options) => {
   polygons.forEach((poly) => {
     const firstVertex = poly.vertices[0]
     for (let i = poly.vertices.length - 3; i >= 0; i--) {
-      const triangle = poly3.fromPoints([
+      const triangle = poly3.create([
         firstVertex,
         poly.vertices[i + 1],
         poly.vertices[i + 2]
@@ -312,7 +289,7 @@ const polygons2coordinates = (polygons, options) => {
   return [indexList, pointList, colorList]
 }
 
-module.exports = {
-  serialize,
-  mimeType
+export {
+  mimeType,
+  serialize
 }

package/tests/geom2ToX3D.test.js

@@ -1,13 +1,13 @@
-const test = require('ava')
+import test from 'ava'
 
-const countOf = require('../../test/helpers/countOf')
+import { countOf } from '../../test/helpers/countOf.js'
 
-const { colors, geometries, primitives } = require('@jscad/modeling')
+import { colorize, geom2, rectangle } from '@jscad/modeling'
 
-const { serialize } = require('../src/index.js')
+import { serialize } from '../src/index.js'
 
 test('serialize 2D geometry to X3D Polyline2D', (t) => {
-  const shape1 = geometries.geom2.create()
+  const shape1 = geom2.create()
 
   let results = serialize({}, shape1)
   t.is(results.length, 1)
@@ -22,7 +22,7 @@ test('serialize 2D geometry to X3D Polyline2D', (t) => {
   t.is(countOf('Scene', obs), 2)
   t.is(countOf('Group', obs), 1)
 
-  const shape2 = primitives.rectangle()
+  const shape2 = rectangle()
 
   results = serialize({ metadata: false }, shape2)
   t.is(results.length, 1)
@@ -39,7 +39,7 @@ test('serialize 2D geometry to X3D Polyline2D', (t) => {
   t.is(countOf('Shape', obs), 2)
   t.is(countOf('Polyline2D', obs), 1)
 
-  const shape3 = colors.colorize([0, 0, 0], shape2)
+  const shape3 = colorize([0, 0, 0], shape2)
 
   results = serialize({ metadata: false }, shape3)
   t.is(results.length, 1)

package/tests/geom3ToX3D.test.js

@@ -1,15 +1,15 @@
-const test = require('ava')
+import test from 'ava'
 
-const countOf = require('../../test/helpers/countOf')
+import { countOf } from '../../test/helpers/countOf.js'
 
-const { colors, geometries, primitives, transforms } = require('@jscad/modeling')
+import { center, colorize, cube, geom3 } from '@jscad/modeling'
 
-const serializer = require('../src/index.js')
+import { serialize } from '../src/index.js'
 
 test('serialize 3D geometry to X3D IndexedTriangleSet', (t) => {
-  const geom1 = geometries.geom3.create()
+  const g1 = geom3.create()
 
-  let results = serializer.serialize({}, geom1)
+  let results = serialize({}, g1)
   t.is(results.length, 1)
 
   let obs = results[0]
@@ -21,9 +21,9 @@ test('serialize 3D geometry to X3D IndexedTriangleSet', (t) => {
   t.is(countOf('Created by JSCAD', obs), 1)
   t.is(countOf('Scene', obs), 2)
 
-  const geom2 = primitives.cube()
+  const g2 = cube()
 
-  results = serializer.serialize({ metadata: false }, geom2)
+  results = serialize({ metadata: false }, g2)
   t.is(results.length, 1)
 
   obs = results[0]
@@ -41,10 +41,10 @@ test('serialize 3D geometry to X3D IndexedTriangleSet', (t) => {
   t.is(countOf('Coordinate', obs), 1)
   t.is(countOf('Color', obs), 1)
 
-  const geom3 = colors.colorize([0.5, 1, 0.5, 1.0], transforms.center({ relativeTo: [5, 5, 5] }, primitives.cube()))
-  geom2.id = geom3.id = 'g23'
+  const g3 = colorize([0.5, 1, 0.5, 1.0], center({ relativeTo: [5, 5, 5] }, cube()))
+  g2.id = g3.id = 'g23'
 
-  results = serializer.serialize({ metadata: false }, geom2, geom3)
+  results = serialize({ metadata: false }, g2, g3)
   t.is(results.length, 1)
 
   obs = results[0]

package/tests/path2ToX3D.test.js

@@ -1,15 +1,15 @@
-const test = require('ava')
+import test from 'ava'
 
-const countOf = require('../../test/helpers/countOf')
+import { countOf } from '../../test/helpers/countOf.js'
 
-const { colors, geometries, primitives } = require('@jscad/modeling')
+import { arc, colorize, path2 } from '@jscad/modeling'
 
-const { serialize } = require('../src/index.js')
+import { serialize } from '../src/index.js'
 
 test('serialize 2D path to X3D Polyline2D', (t) => {
-  const path1 = geometries.path2.create()
+  const p1 = path2.create()
 
-  let results = serialize({}, path1)
+  let results = serialize({}, p1)
   t.is(results.length, 1)
 
   let obs = results[0]
@@ -20,9 +20,9 @@ test('serialize 2D path to X3D Polyline2D', (t) => {
   t.is(countOf('content', obs), 3)
   t.is(countOf('Created by JSCAD', obs), 1)
 
-  const path2 = primitives.arc({ center: [5, 5], endAngle: 45, segments: 16 })
+  const p2 = arc({ center: [5, 5], endAngle: 45, segments: 16 })
 
-  results = serialize({ metadata: false }, path2)
+  results = serialize({ metadata: false }, p2)
   t.is(results.length, 1)
 
   obs = results[0]
@@ -33,9 +33,9 @@ test('serialize 2D path to X3D Polyline2D', (t) => {
   t.is(countOf('Polyline2D', obs), 1)
   t.is(countOf('lineSegments', obs), 1)
 
-  const path3 = colors.colorize([0, 0, 0], path2)
+  const p3 = colorize([0, 0, 0], p2)
 
-  results = serialize({ metadata: false }, path2, path3)
+  results = serialize({ metadata: false }, p2, p3)
   t.is(results.length, 1)
 
   obs = results[0]