@jscad/core 2.5.2 → 2.5.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jscad/core",
-  "version": "2.5.2",
+  "version": "2.5.5",
   "description": "Core functionality for JSCAD Applications",
   "repository": "https://github.com/jscad/OpenJSCAD.org",
   "main": "src/index.js",
@@ -34,10 +34,10 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@jscad/array-utils": "2.1.1",
-    "@jscad/io": "2.2.2",
-    "@jscad/io-utils": "2.0.12",
-    "@jscad/modeling": "2.7.1",
+    "@jscad/array-utils": "2.1.2",
+    "@jscad/io": "2.2.5",
+    "@jscad/io-utils": "2.0.14",
+    "@jscad/modeling": "2.8.0",
     "json5": "2.2.0",
     "strip-bom": "4.0.0"
   },
@@ -52,5 +52,5 @@
     "url": "https://opencollective.com/openjscad",
     "logo": "https://opencollective.com/openjscad/logo.txt"
   },
-  "gitHead": "c8ac21281a7acf5a5575b940c18353c598ffa1a4"
+  "gitHead": "92fb9c75eb070fca5f5ee8c2bab6614b1f54514e"
 }

package/src/code-evaluation/rebuildGeometry.js

@@ -24,7 +24,6 @@ const applyParameterDefinitions = require('../parameters/applyParameterDefinitio
  * And transfering data back & forth is both complex (see transferables) and costly (time)
  **/
 const rebuildSolids = (data, callback) => {
-  console.log('rebuildSolids',data)
   const defaults = {
     mainPath: '',
     apiMainPath: '@jscad/modeling',
@@ -47,7 +46,6 @@ const rebuildSolids = (data, callback) => {
     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)
@@ -59,7 +57,6 @@ const rebuildSolids = (data, callback) => {
     serialize
   }
   const solidsData = instanciateDesign(designData.rootModule, parameterValues, options)
-  // console.warn(`instanciateDesign`, new Date() - start)
 
   // send back solids & any other metadata
   callback(null, {

package/src/code-evaluation/rebuildGeometryCli.js

@@ -7,10 +7,9 @@ const makeWebRequire = require('../code-loading/webRequire')
 
 const rebuildSolids = (data) => {
   const defaults = {
-    apiMainPath: '@jscad/modeling',
-    serialize: false
+    apiMainPath: '@jscad/modeling'
   }
-  let { apiMainPath, serialize, mainPath, parameterValues, useFakeFs } = Object.assign({}, defaults, data)
+  let { apiMainPath, mainPath, parameterValues, useFakeFs } = Object.assign({}, defaults, data)
   // we need to update the source for our module
   let requireFn = require
 

package/src/code-evaluation/serializeSolids.js

@@ -11,7 +11,7 @@ const serializeSolids = (solids) => {
   // imcomplete support for transfering objects via web workers
 
   // NOTE: JSON.stringify was used at some point, but was removed because it was no longer needed
-  // for postMessage JavaScript engines now use an optimized structured clone alg. 
+  // for postMessage JavaScript engines now use an optimized structured clone alg.
   // which should be at least as fast as JSON.stringify
   solids = solids.map((object) => {
     // apply the transforms before serializing
@@ -23,5 +23,4 @@ const serializeSolids = (solids) => {
   return solids
 }
 
-
 module.exports = serializeSolids

package/src/code-loading/loadDesign.js

@@ -1,4 +1,3 @@
-// loading
 const { registerAllExtensions } = require('../io/registerExtensions')
 
 const transformSources = require('./transformSources')
@@ -16,27 +15,6 @@ const getAllParameterDefintionsAndValues = require('../parameters/getParameterDe
  * @param {Object} parameterValuesOverride - the values to use to override the defaults for the current design
  */
 const loadDesign = (mainPath, apiMainPath, filesAndFolders, parameterValuesOverride) => {
-  // console.log('***** loadDesign',mainPath)
-  // the root script is the main entry point in a design
-  // ie either the only file if there is only one
-  // OR the file in the 'main' entry of package.js, index.js, main.js or <folderName>.js
-
-  /*
-    - if the script is a common.js file already
-      > load as it is
-        - if we have real require() access (CLI, desktop)
-          use standard require() to load the rootScript
-        - if we do NOT have real require() access (web)
-          use fake require() to load the rootScript
-    - if the script is NOT a common.js file (implicit imports)
-      > add explicit api imports to the rootScript's source
-      > add explicit exports ie module.exports {main, getParameterDefinitions}
-        - if we have real require() access (CLI, desktop)
-          use standard require() to load the rootScript
-        - if we do NOT have real require() access (web)
-          use fake require() to load the rootScript
-  */
-
   // transform the source if passed non-javascript content, i.e. stl
   filesAndFolders = transformSources({ apiMainPath }, filesAndFolders)
 
@@ -52,8 +30,6 @@ const loadDesign = (mainPath, apiMainPath, filesAndFolders, parameterValuesOverr
       }
     ]
   }
-  // console.log('filesAndFolders',filesAndFolders)
-
   const fakeFs = makeFakeFs(filesAndFolders)
 
   const webRequire = makeWebRequire(filesAndFolders, { apiMainPath })
@@ -64,8 +40,6 @@ const loadDesign = (mainPath, apiMainPath, filesAndFolders, parameterValuesOverr
   // find the root module
   let rootModule = webRequire(filesAndFolders[0].fullPath)
 
-  // console.log('***** rootModule',rootModule)
-
   rootModule = normalizeDesignModule(rootModule)
 
   // rootModule SHOULD contain a main() entry and optionally a getParameterDefinitions entry

package/src/code-loading/makeFakeFs.js

@@ -13,7 +13,6 @@ const makeFakeFs = (filesAndFolders) => {
       }
     }
     return undefined
-    // return filesAndFolders
   }
 
   const statSync = (path) => {
@@ -27,16 +26,13 @@ const makeFakeFs = (filesAndFolders) => {
     statSync,
     existsSync: (path) => {
       const entry = findMatch(path)
-      // console.log('does ', path, 'exist ?', entry !== undefined)
       return entry !== undefined
     },
     readdirSync: (path) => {
       const entry = findMatch(path)
       return entry.children.map((x) => x.name)
-      // filesAndFolders
     },
     readDir: (path, callback) => {
-      // console.log('readDir', path, callback)
       const entry = findMatch(path)
       callback(null, entry)
     },
@@ -48,7 +44,6 @@ const makeFakeFs = (filesAndFolders) => {
       if (!statSync(path).isFile()) {
         callback(new Error(`${entry} is not a file, cannot read`))
       } else {
-        // console.log('readFile', path, entry)
         callback(null, entry.source)
       }
     },
@@ -60,7 +55,6 @@ const makeFakeFs = (filesAndFolders) => {
       if (!statSync(path).isFile()) {
         throw new Error(`${entry} is not a file, cannot read`)
       } else {
-        // console.log('readFile sync', path, entry)
         return entry.source
       }
     }

package/src/code-loading/modulifySource.js

@@ -4,7 +4,8 @@
  */
 const modulifySource = (source, apiMainPath) => {
   const getParamsString = source.includes('getParameterDefinitions')
-    ? 'module.exports.getParameterDefinitions = getParameterDefinitions' : ''
+    ? 'module.exports.getParameterDefinitions = getParameterDefinitions'
+    : ''
   const updatedSource = `
     const {geom2, geom3, path2, pol2, poly3} = require('${apiMainPath}').geometries
 

package/src/code-loading/normalizeDesignModule.js

@@ -3,17 +3,17 @@
  */
 const normalizeDesignModule = (rootModule) => {
   if (!rootModule) {
-    throw new Error('no root module found')
+    throw new Error('no root module found, please check the project structure')
   }
   if (typeof (rootModule) === 'function') {
-    console.warn('please use named exports for the main() function')
+    console.warn('please refactor the exports, assigning main() as a property, i.e. module.exports = { main }')
     rootModule = { main: rootModule }
   }
   if (!rootModule.main) {
-    throw new Error('no main() function, check the exports')
+    throw new Error('no main() function found, please check the module.exports')
   }
-  if (!(typeof (rootModule.main) === 'function')) {
-    throw new Error('main is not a function, check the exports')
+  if (typeof (rootModule.main) !== 'function') {
+    throw new Error('main is not a function, please check the module.exports')
   }
   return rootModule
 }

package/src/code-loading/transformSources.js

@@ -1,19 +1,9 @@
 const { deserializers } = require('@jscad/io')
 
-const isCommonJsModule = require('./isCommonJsModule')
-const modulifySource = require('./modulifySource')
-
-const passThroughTransform = (options, entry) => entry
-
-/* function to turn old style jscad code with implicit imports
-into code with explicit exports/imports */
-// FIXME wouldn't a javascript error be better then 'hacking' the users code?
-const modulifyTransform = (options, entry) => {
-  const { apiMainPath } = options
-  const isFileCommonJs = isCommonJsModule(entry.source)
-  const source = !isFileCommonJs ? modulifySource(entry.source, apiMainPath) : entry.source
-  return Object.assign({}, entry, { source })
-}
+/*
+ * Transform the entry into a ready-to-use module.
+ */
+const modulifyTransform = (options, entry) => Object.assign({}, entry, { source: entry.source })
 
 /*
  * Create a new entry for a script (JSCAD) from the given entry and source
@@ -32,8 +22,6 @@ const createJscadEntry = (entry, source) => {
  * Transforms are NOT applied to projects.
  */
 const transformSources = (options, filesAndFolders) => {
-  // console.log('***** transformSources', options, filesAndFolders)
-
   if (filesAndFolders && filesAndFolders.length > 1) return filesAndFolders // skip projects
 
   const codeTransforms = {

package/src/code-loading/webRequire.js

@@ -72,6 +72,7 @@ const makeWebRequire = (filesAndFolders, options) => {
   // console.log('*****\n',filesAndFolders,'\n*****')
 
   const extensions = {}
+  const moduleCache = {}
 
   /* Require (obtain) the exports for the given require path, relative to the given current path.
    * The logic is based on the original NODE require() function.
@@ -105,11 +106,12 @@ const makeWebRequire = (filesAndFolders, options) => {
       if (entry.children) return null // directory
 
       if (extensions[baseExt]) {
+        if (moduleCache[requirePath]) return moduleCache[requirePath]
         // evaluate the content
         const matchingModule = {
           exports: {},
           _compile: (content, fileName) => {
-            const moduleMakerFunction = new Function('require', 'module', content)
+            const moduleMakerFunction = new Function('require', 'module', content) // eslint-disable-line no-new-func
             moduleMakerFunction(_require.bind(null, entry.fullPath), matchingModule)
 
             const paramDefFromSource = content.includes('@jscad-params') ? getParameterDefinitionsFromSource(content, fileName) : []
@@ -121,7 +123,8 @@ const makeWebRequire = (filesAndFolders, options) => {
           }
         }
         extensions[baseExt](matchingModule, entry.fullPath)
-        return matchingModule.exports
+        moduleCache[requirePath] = matchingModule.exports
+        return moduleCache[requirePath]
       }
       return null
     }

package/src/code-loading/webRequire.test.js

@@ -13,10 +13,14 @@ test('webRequire: should support require, from a single file', (t) => {
 
   let requireFn = makeWebRequire(singleFileJs, { apiMainPath })
   let designRootModule = requireFn(singleFileJs[0].fullPath)
+  const designRootModule2 = requireFn(singleFileJs[0].fullPath)
 
   t.true('main' in designRootModule)
   t.true(designRootModule.main instanceof Function)
 
+  t.is(designRootModule, designRootModule2)
+  t.deepEqual(designRootModule, designRootModule2)
+
   // NOTE: 'jscad' must be registered as an extension
   const fakeFs = makeFakeFs(singleFileJscad)
   requireFn = makeWebRequire(singleFileJscad, { apiMainPath })
@@ -32,7 +36,6 @@ test('webRequire: should support require, from a directory with index.js', (t) =
 
   const requireFn = makeWebRequire(directoryWithIndexJs, { apiMainPath })
   const designRootModule = requireFn('/project')
-
   t.true('main' in designRootModule)
   t.true(designRootModule.main instanceof Function)
 })

package/src/parameters/getParameterDefinitionsFromSource.test.js

@@ -224,5 +224,5 @@ test('multiline error', (t) => {
 test('single line /* ...*/ ok', (t) => {
   t.deepEqual(getParameterDefinitionsFromSource(`function main({//@jscad-params
   /* group */
-  width=14})`), [{type:'group', caption:'group', name:'_group_1'},...sampleParams2])
+  width=14})`), [{ type: 'group', caption: 'group', name: '_group_1' }, ...sampleParams2])
 })

package/src/parameters/getParameterValuesFromUIControls.js

@@ -13,14 +13,6 @@ const getParameterValuesFromUIControls = (paramControls, parameterDefinitions, o
     switch (control.paramType) {
       case 'choice':
         value = control.options[control.selectedIndex].value
-        /* console.log('choice', control, control.paramName)
-        // we try to match values against captions, then parse as numbers if applicable, then fallback to original value
-        const valueIndex = !definition ? -1 : definition.captions.indexOf(value)
-        const valueInDefinition = valueIndex > -1
-        // const valueInDefintionCaptionsAndValue = valueInDefinition && definition.values.length >= valueIndex
-        value = definition.values.length > 0 && isNumber(definition.values[0]) ? parseFloat(value) : value
-        value = definition.values.length > 0 && typeof value === 'boolean' ? !!value : value
-        console.log('foo', value) */
         break
       case 'float':
       case 'number':
@@ -63,7 +55,6 @@ const getParameterValuesFromUIControls = (paramControls, parameterDefinitions, o
       }
     }
     parameterValues[control.paramName] = value
-  // console.log(control.paramName+":"+parameterValues[control.paramName])
   }
   return parameterValues
 }

package/src/web/walkFileTree.js

@@ -30,8 +30,6 @@ const binaryMimetypes = {
  * @returns {Promise} new promise to read and convert the file
  */
 const readFileAsync = (file, fileMeta) => {
-  // console.log('readFileAsync',file,fileMeta)
-
   const fullPath = file.fullPath ? file.fullPath : fileMeta.fullPath ? fileMeta.fullPath : ''
   const ext = getFileExtensionFromString(file.name)
   const mimetype = file.mimetype
@@ -43,7 +41,7 @@ const readFileAsync = (file, fileMeta) => {
       const result = event.target.result
       if (result.byteLength) {
         resolve({ name: file.name, ext, fullPath, mimetype, source: result })
-      } else if (typeof(result) === 'string') {
+      } else if (typeof result === 'string') {
         resolve({ name: file.name, ext, fullPath, mimetype, source: result })
       }
     }
@@ -87,7 +85,6 @@ const isEmpty = (x) => x !== null && x !== undefined // skip empty items
  * @returns {Promise} one promise to resolve them all
  */
 const processEntries = (items) => {
-  // console.log('processEntries',items)
   const results = pseudoArraytoArray(items.filter(isEmpty))
     .filter(isEmpty) // skip empty items
     .reduce((result, item) => {
@@ -117,7 +114,6 @@ const processEntries = (items) => {
  * @returns {Promise} new promise to read and process the file
  */
 const processFile = (fileItem) => {
-  // console.log('processFile',fileItem)
   const promiseFile = new Promise((resolve, reject) => {
     fileItem.file(
       (fileData) => {
@@ -138,7 +134,6 @@ const processFile = (fileItem) => {
  * @returns {Promise} new promise to read and process the directory
  */
 const processDirectory = (directory) => {
-  // console.log('processDirectory',directory)
   const promiseDirectory = new Promise((resolve, reject) => {
     if (directory.entries) {
       directory.entries.length ? processEntries(directory.entries).then(resolve) : resolve([])