feat(core): V2 : Fix core packaging (#720)

* build(core): corrected main in configuration, and adjusted test script

* feat(core): reorganizing code into src directory, following standard library organization

* fix(core): added indexes for the contents of each sub-directory

* fix(core): moved walkFileTree into core library, as this is key for general use of JSCAD

* fix(core): corrected default options for rebuildGeometry, also added doc strings

* build(core): a little clean up on the package

* docs(core): improved docs for rebuildGeometry

* fix(core): improved transformFileList to handle a single file

* fix(cli web): corrected require of @jscad/core

Author: z3dev

packages/cli/src/generateOutputData.js

@@ -3,8 +3,8 @@ const { isAbsolute, resolve } = require('path')
 
 const { deserializers, solidsAsBlob } = require('@jscad/io')
 
-const rebuildSolids = require('@jscad/core/code-evaluation/rebuildGeometryCli')
-const { registerAllExtensions } = require('@jscad/core/io/registerExtensions')
+const { rebuildGeometryCli } = require('@jscad/core').evaluation
+const { registerAllExtensions } = require('@jscad/core').io
 
 /**
  * generate output data from source
@@ -56,7 +56,7 @@ const generateOutputData = (source, params, options) => {
       //    } else if ((inputFormat === 'jscad' || inputFormat === 'js') &&
       //               outputFormat !== 'jscad' && outputFormat !== 'js') {
       try {
-        const solids = rebuildSolids({ mainPath: inputPath, parameterValues: params, useFakeFs, source })
+        const solids = rebuildGeometryCli({ mainPath: inputPath, parameterValues: params, useFakeFs, source })
         resolve(solids)
       } catch (error) {
         reject(error)

packages/cli/src/parseArgs.js

@@ -1,6 +1,6 @@
 const fs = require('fs')
 
-const { getDesignEntryPoint } = require('@jscad/core/code-loading/requireDesignUtilsFs')
+const { getDesignEntryPoint } = require('@jscad/core').loading.requireDesignUtilsFs
 const { supportedInputExtensions, supportedOutputExtensions, supportedOutputFormats } = require('@jscad/io/formats')
 
 const env = require('./env')

packages/core/code-evaluation/rebuildGeometry.js

@@ -1,16 +1,15 @@
 {
   "name": "@jscad/core",
   "version": "2.0.0-alpha.9",
-  "description": "reuseable utilities for the various jscad user interfaces",
+  "description": "Reuseable utilities for the various JSCAD user interfaces",
   "repository": "https://github.com/jscad/OpenJSCAD.org",
-  "main": "module.js",
+  "main": "src/index.js",
   "scripts": {
     "coverage": "nyc --all --reporter=html --reporter=text npm test",
-    "test": "ava './**/*.test.js' --verbose --timeout 2m",
+    "test": "ava './src/**/*.test.js' --verbose --timeout 2m",
     "release-patch": "git checkout master && git pull origin master && npm version patch",
     "release-minor": "git checkout master && git pull origin master && npm version minor",
-    "release-major": "git checkout master && git pull origin master && npm version major",
-    "postinstall": "node -e \"console.log('\\u001b[35m\\u001b[1mLove OpenJSCAD? You can now donate to our open collective:\\u001b[22m\\u001b[39m\\n > \\u001b[34mhttps://opencollective.com/openjscad/donate\\u001b[0m')\""
+    "release-major": "git checkout master && git pull origin master && npm version major"
   },
   "contributors": [
     {

packages/core/package.json

@@ -0,0 +1,7 @@
+module.exports = {
+  deserializeSolids: require('./deserializeSolids'),
+  rebuildGeometry: require('./rebuildGeometry'),
+  rebuildGeometryCli: require('./rebuildGeometryCli'),
+  rebuildGeometryWorker: require('./rebuildGeometryWorker'),
+  serializeSolids: require('./serializeSolids')
+}

…ore/code-evaluation/deserializeSolids.js …src/code-evaluation/deserializeSolids.jspackages/core/code-evaluation/deserializeSolids.js renamed to packages/core/src/code-evaluation/deserializeSolids.js packages/core/code-evaluation/deserializeSolids.js renamed to packages/core/src/code-evaluation/deserializeSolids.js

@@ -0,0 +1,76 @@
+const loadDesign = require('../code-loading/loadDesign')
+const instanciateDesign = require('./instanciateDesign')
+const applyParameterDefinitions = require('../parameters/applyParameterDefinitions')
+
+/**
+ * Rebuild JSCAD solids from the given filesAndFolders.
+ * The provided filesAndFolders is expected to consist of a valid JSCAD design.
+ * An array consisting of:
+ * - single file or project folder from the results of walkFileTree()
+ * - fake single file entry containing { name, ext, source, fullPath }
+ * @param {Object} data - data (and options) required for rebuilding
+ * @param {Array} data.filesAndFolders - array of files / directories
+ * @param {String} [data.mainPath] - path of the file containing the main function (optional)
+ * @param {Boolean} [data.serialize] - true to serialize the solids into JSON
+ * @param {Boolean} [data.vtreeMode] - true to use the experimental Vtree caching (optional)
+ * @param {Object} [data.lookup] - geometry cache lookup (optional)
+ * @param {Object} [data.lookupCounts] - geometry cache lookup counts (optional)
+ * @param {Object} [data.parameterValues] - over-rides of parameter values (optional)
+ * @param {Function} callback - function to process parameters and solids
+ * @return NONE
+ * This function extracts the parameters first, and then generates the solids.
+ * The parsed parameters (definitions and values) are passed back to the given callback function.
+ * The generated solids are also passed back to the given callback function.
+ * Everything is together in a single function, because this is usually run in the context of a web worker
+ * And transfering data back & forth is both complex (see transferables) and costly (time)
+ **/
+const rebuildSolids = (data, callback) => {
+  console.log('rebuildSolids',data)
+  const defaults = {
+    mainPath: '',
+    vtreeMode: false,
+    serialize: true,
+    lookup: null,
+    lookupCounts: null,
+    parameterValues: {}
+  }
+  let { mainPath, vtreeMode, serialize, lookup, lookupCounts, parameterValues } = Object.assign({}, defaults, data)
+
+  const apiMainPath = '@jscad/modeling'// vtreeMode ? '../code-loading/vtreeApi' : '@jscad/modeling'
+  const filesAndFolders = data.filesAndFolders
+
+  // let start = new Date()
+  const designData = loadDesign(mainPath, apiMainPath, filesAndFolders, parameterValues)
+  // send back parameter definitions & values
+  // in a worker this would be a postmessage, this is sent back early so that uis can update
+  // the parameters editor before the solids are displayed (which takes longer)
+  callback(null, {
+    type: 'params',
+    parameterDefaults: designData.parameterValues,
+    parameterDefinitions: designData.parameterDefinitions
+  })
+  // console.warn(`loadDesignData`, new Date() - start)
+  // make sure parameters are correct by applying parameter definitions
+  // this might be redundant with ui-side logic, but it makes sure this core piece works regardless of ui
+  parameterValues = applyParameterDefinitions(parameterValues, designData.parameterDefinitions)
+  parameterValues = Object.assign({}, designData.parameterValues, parameterValues)
+  // start = new Date()
+  const options = {
+    vtreeMode,
+    lookup,
+    lookupCounts,
+    serialize
+  }
+  const solidsData = instanciateDesign(designData.rootModule, parameterValues, options)
+  // console.warn(`instanciateDesign`, new Date() - start)
+
+  // send back solids & any other metadata
+  callback(null, {
+    type: 'solids',
+    solids: solidsData.solids,
+    lookup: solidsData.lookup,
+    lookupCounts: solidsData.lookupCounts
+  })
+}
+
+module.exports = rebuildSolids