@jscad/web 2.5.9 → 2.5.12

package/src/ui/flow/reducers.js

@@ -0,0 +1,304 @@
+const path = require('path')
+
+const { applyParameterDefinitions } = require('@jscad/core').parameters
+const { makeFakeFs } = require('@jscad/core').loading
+const { getDesignEntryPoint, getDesignName } = require('@jscad/core').loading.requireDesignUtilsFs
+
+const { keep } = require('../../utils/object')
+const packageMetadata = require('../../../package.json')
+const { availableExportFormatsFromSolids, exportFilePathFromFormatAndDesign } = require('../../core/io/exportUtils')
+
+// what fields should we check to determine if two designs are the same
+const designEqualityFields = [
+  'parameterDefinitions',
+  'parameterValues',
+  'mainPath',
+  'filesAndFolders',
+  'vtreeMode' // also trigger a recompute when vtree mode is enabled/disabled
+]
+
+// what fields we want to de/serialize
+const serializableFields = [
+  'name',
+  'mainPath',
+  'origin',
+  'parameterValues',
+  'vtreeMode',
+  'autoReload',
+  'instantUpdate',
+  'solidsTimeOut'
+]
+
+const reducers = {
+  /**
+   * initialise the design's state
+   * @returns {Object} the default state for designs
+   */
+  initialize: () => {
+    const design = {
+      // metadata
+      name: '',
+      path: '',
+      mainPath: '',
+      origin: undefined, // where the design came from : http, local etc
+      filesAndFolders: [], // file tree, of sorts
+      // code
+      instantUpdate: false,
+      autoReload: false,
+      // parameters
+      parameterDefinitions: [],
+      parameterValues: {},
+      parameterDefaults: {},
+      // solids
+      solidsTimeOut: 80000,
+      solids: [],
+      // geometry caching
+      vtreeMode: false,
+      lookup: {},
+      lookupCounts: {},
+      debug: {
+        startTime: 0,
+        endTime: 0,
+        totalTime: 0
+      }
+    }
+    return { design }
+  },
+
+  /** reset the content of the design
+   * @param  {Object} state
+   * @param  {String} origin
+   * @returns {Object} the updated state
+   */
+  resetDesign: (state, origin) => {
+    // we reset only the given fields: mostly all except design specific things
+    const fieldsToReset = [
+      'name', 'path', 'mainPath', 'origin', 'filesAndFolders',
+      'parameterDefinitions', 'parameterValues', 'parameterDefaults',
+      'lookup', 'lookupCounts', 'debug', 'solids'
+    ]
+    const design = Object.assign({},
+      state.design, keep(fieldsToReset, reducers.initialize().design)
+    )
+    // ugh
+    design.origin = origin
+    return { design }
+  },
+
+  /** set the content of the design usually after a reset
+   * bulk of the data is set here
+   * @param  {Object} state
+   * @param  {String} payload
+   * @returns {Object} the updated state
+   */
+  setDesignContent: (state, payload) => {
+    // all our available data (specific to web)
+    const { filesAndFolders } = payload
+    const fakeFs = makeFakeFs(filesAndFolders)
+    const rootPath = filesAndFolders[0].fullPath
+    const mainPath = getDesignEntryPoint(fakeFs, rootPath)
+    const designName = getDesignName(fakeFs, rootPath)
+    const designPath = path.dirname(rootPath)
+
+    let design = state.design
+    // to track computation time
+    const debug = Object.assign({ }, state.design.debug, { startTime: new Date() })
+
+    design = Object.assign({}, design, {
+      name: designName,
+      path: designPath,
+      mainPath,
+      filesAndFolders,
+      debug
+    })
+
+    const appTitle = `jscad v ${packageMetadata.version}: ${state.design.name}`
+
+    // FIXME: this is the same as clear errors?
+    const status = Object.assign({}, state.status, { busy: true, error: undefined })
+    return {
+      design,
+      appTitle,
+      status
+    }
+  },
+
+  /**
+   * set the solids (2d/ 3D /csg/cag data), and the geometry cache if applicable
+   * @param {Object} state
+   * @param {Object} options
+   * @param {Array} options.solids
+   * @param {Object} options.lookup
+   * @param {Object} options.lookupCounts
+   * @returns {Object} the updated state
+   */
+  setDesignSolids: (state, { solids, lookup, lookupCounts }) => {
+    solids = solids || []
+    lookup = lookup || {}
+    lookupCounts = lookupCounts || {}
+
+    // should debug be part of status ?
+    const endTime = new Date()
+    const totalTime = endTime - state.design.debug.startTime
+    const debug = Object.assign({ }, state.design.debug, {
+      endTime,
+      totalTime
+    })
+    console.warn('total time for design regeneration', totalTime, new Date().getSeconds())
+
+    const design = Object.assign({}, state.design, {
+      solids,
+      lookup,
+      lookupCounts,
+      debug
+    })
+
+    // TODO: move this to IO?
+    const { exportFormat, availableExportFormats } = availableExportFormatsFromSolids(solids)
+    const exportInfos = exportFilePathFromFormatAndDesign(design, exportFormat)
+    const io = {
+      exportFormat,
+      exportFilePath: exportInfos.exportFilePath, // default export file path
+      availableExportFormats
+    }
+
+    const status = Object.assign({}, state.status, { busy: false })
+
+    return {
+      design,
+      status,
+      io
+    }
+  },
+
+  setDesignParameterDefinitions: (state, data) => {
+    const parameterDefaults = data.parameterDefaults || state.design.parameterDefaults
+    const parameterDefinitions = data.parameterDefinitions || state.design.parameterDefinitions
+    const design = Object.assign({}, state.design, {
+      parameterDefaults,
+      parameterDefinitions,
+      parametersOrigin: data.origin
+    })
+    return { design }
+  },
+
+  /**
+   * set the parameters of this design
+   * @param  {Object} state
+   * @param  {Object} data
+   * @returns {Object} the updated state
+   */
+  setDesignParameterValues: (state, data) => {
+    let parameterValues = data.parameterValues
+    // one of many ways of filtering out data from instantUpdates
+    if (data.origin === 'instantUpdate' && !state.design.instantUpdate) {
+      parameterValues = state.design.parameterValues
+    }
+    parameterValues = parameterValues ? applyParameterDefinitions(parameterValues, state.design.parameterDefinitions) : parameterValues
+    parameterValues = Object.assign({}, state.design.parameterValues, parameterValues)
+
+    let design = Object.assign({}, state.design, {
+      parameterValues,
+      parametersOrigin: data.origin
+    })
+    // to track computation time
+    const debug = Object.assign({ }, state.design.debug, { startTime: new Date() })
+    design = Object.assign({}, design, { debug })
+
+    const status = Object.assign({}, state.status, { busy: true, error: undefined })
+
+    return {
+      design,
+      status
+    }
+  },
+
+  setSettings: (state, { data }) => {
+    const {
+      vtreeMode,
+      autoReload,
+      instantUpdate,
+      solidsTimeOut
+    } = data
+    // FIXME : clunky but needed to make sure we have no invalid settings
+    if (vtreeMode === undefined) {
+      return { design: state.design }
+    }
+    const design = Object.assign({}, state.design, { vtreeMode, autoReload, instantUpdate, solidsTimeOut })
+    return {
+      design
+    }
+  },
+
+  requestGeometryRecompute: ({ design }, _) => keep(['mainPath', 'parameterValues', 'filesAndFolders', 'vtreeMode', 'lookup', 'lookupCounts'], design),
+
+  timeoutGeometryRecompute: ({ status }, _) => {
+    if (status.isBusy) { // still computing... we can kill it
+      return Object.assign({}, status, {
+        busy: false,
+        error: new Error('Failed to generate design within an acceptable time, bailing out')
+      })
+    }
+    // no problem, just act as a no-op
+    return { status }
+  },
+
+  requestWriteCachedGeometry: ({ design }, cache) => {
+    const data = {}
+    Object.keys(cache).forEach((key) => {
+      data[key] = cache[key]
+    })
+    // we want to save the geometry cache under '.solidsCache'
+    return { path: '.solidsCache', options: { isRawData: true }, origin: design.origin }
+  },
+
+  // what do we want to save, return an object containing only that data?
+  requestSaveSettings: ({ design }) => keep(serializableFields, design),
+
+  // helpers
+  isDesignValid: (state) => (state.design && state.design.name && state.design.path !== ''),
+
+  // determine if a design has remained the same : does NOT include solids, as they are a result of all the other parameters
+  isDesignTheSame: (previousState, state) => {
+    if (!previousState.design) {
+      return false
+    }
+    const current = JSON.stringify(keep(designEqualityFields, state.design))
+    const previous = JSON.stringify(keep(designEqualityFields, previousState.design))
+    return previous === current
+  },
+
+  // same as above but with added fields for settings
+  isDesignTheSameForSerialization: (previousState, state) => {
+    if (!previousState.design) {
+      return false
+    }
+    // do a JSON compare of the previous & current fields to save if needed
+    const current = JSON.stringify(keep(serializableFields, state.design))
+    const previous = JSON.stringify(keep(serializableFields, previousState.design))
+    return previous === current
+  },
+
+  // ui/toggles
+  toggleAutoReload: (state, autoReload) => {
+    const design = Object.assign({}, state.design, { autoReload })
+    return { design }
+  },
+
+  toggleInstantUpdate: (state, instantUpdate) => {
+    const design = Object.assign({}, state.design, { instantUpdate })
+    return { design }
+  },
+
+  toggleVtreeMode: (state, vtreeMode) => {
+    const design = Object.assign({}, state.design, { vtreeMode })
+    return { design }
+  },
+
+  setSolidsTimeout: (state, solidsTimeOut) => {
+    const design = Object.assign({}, state.design, { solidsTimeOut })
+    return { design }
+  }
+}
+
+module.exports = reducers

package/src/ui/views/parameterControls.js

@@ -263,19 +263,19 @@ const createInputControl = (definition, prevValue) => {
 
   // check for required parameters
   if (!('type' in definition)) {
-    throw new Error('Parameter definition (' + definition + ") must include a 'type' parameter")
+    throw new Error(`Parameter definition (${definition.name}) must include a 'type' parameter`)
   }
   let typeData = controlList.filter((x) => definition.type === x.type)
   typeData = (typeData && typeData.length > 0) ? typeData[0] : undefined
   if (!typeData) {
-    throw new Error('Parameter definition (' + definition + ') is not known')
+    throw new Error(`Parameter definition (${definition.name}), invalid type "${definition.type}"`)
   }
 
   // validate fields
   const definitionFields = Object.keys(definition)
   typeData.required.forEach((requiredField) => {
     if (!definitionFields.includes(requiredField)) {
-      throw new Error(`Parameter definition for "${definition.name}" must include a "${requiredField}" parameter`)
+      throw new Error(`Parameter definition of type "${definition.type}" must include a "${requiredField}" parameter`)
     }
   })
 

package/src/ui/views/status.js

@@ -3,29 +3,36 @@ const html = require('nanohtml')
 // status display
 const status = (state, paramsCallbacktoStream) => {
   const status = state.status
-  const errorMessage = status.error !== undefined && status.error.message ? `${status.error.message}` : ''
-  const errorLine = status.error !== undefined && status.error.lineno ? `Line: ${status.error.lineno}` : ''
-  const errorStack = status.error !== undefined && status.error.stack ? `Stack: ${status.error.stack}` : ''
+  let errorWhere = ''
+  let errorMessage = ''
+  let errorStack = ''
+  if (status.error) {
+    if (status.error.fileName && !status.error.fileName.startsWith('blob')) {
+      // syntax errors provide file name, line, and column number
+      errorWhere = `${status.error.fileName}:${status.error.lineNumber}:${status.error.columnNumber}`
+    }
+    errorMessage = `${status.error.name}: ${status.error.message}`
+    if (status.error.stack) {
+      errorStack = status.error.stack.trim().split('\n').map((s) => html`<ul>${s}</ul>`)
+    }
+  }
 
   const statusMessage = status.error !== undefined
     ? html`<span>
-    <div>
-      ERROR: 
+    <div id='errormessage'>
+      <p>
+        ${errorWhere}
+      </p>
+      <p>
+        ${errorMessage}
+      </p>
     </div>
-    <div>
-      ${errorMessage}
-    </div>
-    <div>
-      ${errorLine}
-    </div>
-    <div>
+    <div id='stacktrace'>
       ${errorStack}
     </div>
   </span>`
     : ''
 
-  // ? `Error: ${status.error.message} line: ${status.error.lineno}, filename:${status.error.filename} stack:  ${status.error.stack}` : ''
-  // ${statusMessage}
   const busy = status.busy
   return html`
       <span id='status'>

package/examples/old/benchmark-cag.jscad

@@ -1,27 +0,0 @@
-// title      : Benchmark CAG
-// author     : Z3 Development
-// license    : MIT License
-// description: testing how fast the CAG objects are created
-
-function main () {
-  echo('OpenJSCAD ' + OpenJsCad.version + ' CSG Benchmark');
-
-  var p = {
-    'rectangles': CAG.rectangle,
-    'roundedRectangles': CAG.roundedRectangle,
-    'circles': CAG.circle
-  };
-
-  var o = [];
-  for (var i in p) {
-    var n = 100;
-    var start = new Date();
-    for (var j = 0; j < n; j++) {
-      o.push(p[i]());
-    }
-    var t = (new Date() - start) / n; // milliseconds per iteration
-    t = 1000 / t; // iterations per second
-    echo(i + ' ' + t.toFixed(4) + ' iterations / sec');
-  }
-  return o[0];
-}

package/examples/old/benchmark-csg.jscad

@@ -1,29 +0,0 @@
-// title      : Benchmark
-// author     : Z3 Development
-// license    : MIT License
-// description: testing how fast the CSG objects are created
-
-function main () {
-  echo('OpenJSCAD ' + OpenJsCad.version + ' CSG Benchmark');
-
-  var p = {
-    'cubes': CSG.cube,
-    'roundedCubes': CSG.roundedCube,
-    'spheres': CSG.sphere,
-    'cylinders': CSG.cylinder,
-    'roundedCylinders': CSG.roundedCylinder
-  };
-
-  var o = [];
-  for (var i in p) {
-    var n = 100;
-    var start = new Date();
-    for (var j = 0; j < n; j++) {
-      o.push(p[i]());
-    }
-    var t = (new Date() - start) / n; // milliseconds per iteration
-    t = 1000 / t; // iterations per second
-    echo(i + ' ' + t.toFixed(4) + ' interations / sec');
-  }
-  return o[0];
-}

package/examples/old/benchmark.jscad

@@ -1,25 +0,0 @@
-// title      : Benchmark SCAD Compatibility
-// author     : Rene K. Mueller
-// license    : MIT License
-// description: testing how fast the computations are done
-// file       : benchmark.jscad
-
-function main () {
-  var p = { 'spheres': sphere, 'cubes': cube, 'cylinders': cylinder, 'torus': torus };
-  var o = [];
-  var sum = 0;
-  echo('OpenJSCAD ' + OpenJsCad.version + ' Benchmark');
-  for (var i in p) {
-    var n = 100;
-    var start = new Date();
-    for (var j = 0; j < n; j++) {
-      o.push(p[i]());
-    }
-    var t = (new Date() - start) / n; // milliseconds per iteration
-    t = 1000 / t; // iterations per second
-    echo(i + ' ' + t.toFixed(4) + ' iterations / sec');
-    sum += t;
-  }
-  echo('total ' + sum.toFixed(4));
-  return o[0];
-}

package/examples/old/bunch-cubes.jscad

@@ -1,17 +0,0 @@
-// title      : Bunch of Cubes
-// author     : Rene K. Mueller
-// license    : MIT License
-// description: creating 100 cubes in space ...
-// file       : bunch-cubes.jscad
-
-function main () {
-  var cubes = [];
-
-  for (var i = 0; i < 100; i++) {
-    cubes.push(
-      translate([150 * Math.random() - 75, 150 * Math.random() - 75, 150 * Math.random() - 75],
-        cube(5).setColor(hsl2rgb(Math.random() * 0.2 + 0.7, 1, 0.5)))
-    );
-  }
-  return cubes;
-}

package/examples/old/complex/example001.jscad

@@ -1,31 +0,0 @@
-// title      : Example 001
-// author     : OpenSCAD.org, adapted by Rene K. Mueller
-// license    : MIT License
-// description: example001.scad ported to OpenJSCAD.org
-// file       : example001.jscad
-
-function radiusFromDiameter (d) {
-  return d / 2;
-}
-
-function rotcy (rot, r, h) {
-  return rotate(rot, cylinder({r: r, h: h, center: true}));
-}
-
-function example001 () {
-  var size = 50;
-  var hole = 25;
-  var radius = radiusFromDiameter(hole);
-  var height = radiusFromDiameter(size * 2.5);
-
-  return difference(
-    sphere({r: radiusFromDiameter(size)}),
-    rotcy([0, 0, 0], radius, height),
-    rotcy([90, 0, 0], radius, height),
-    rotcy([0, 90, 0], radius, height)
-  );
-}
-
-function main () {
-  return example001();
-}

package/examples/old/complex/example002.jscad

@@ -1,25 +0,0 @@
-// title      : Example 002
-// author     : OpenSCAD.org, adapted by Rene K. Mueller
-// license    : MIT License
-// description: example002.scad ported to OpenJSCAD.org
-// file       : example002.jscad
-
-function example002 () {
-  return intersection(
-    difference(
-      union(
-        cube({size: [30, 30, 30], center: true}),
-        translate([0, 0, -25], cube({size: [15, 15, 50], center: true}))
-      ),
-      union(
-        cube({size: [50, 10, 10], center: true}),
-        cube({size: [10, 50, 10], center: true}),
-        cube({size: [10, 10, 50], center: true})
-      )
-    ),
-    translate([0, 0, 5], cylinder({h: 50, r1: 20, r2: 5, center: true})));
-}
-
-function main () {
-  return example002();
-}

package/examples/old/complex/example003.jscad

@@ -1,25 +0,0 @@
-// title      : Example 003
-// author     : OpenSCAD.org, adapted by Rene K. Mueller
-// license    : MIT License
-// description: example003.scad ported to OpenJSCAD.org
-// file       : example003.jscad
-
-function example003 () {
-  return difference(
-    union(
-      cube({size: [30, 30, 30], center: true}),
-      cube({size: [40, 15, 15], center: true}),
-      cube({size: [15, 40, 15], center: true}),
-      cube({size: [15, 15, 40], center: true})
-    ),
-    union(
-      cube({size: [50, 10, 10], center: true}),
-      cube({size: [10, 50, 10], center: true}),
-      cube({size: [10, 10, 50], center: true})
-    )
-  );
-}
-
-function main () {
-  return example003();
-}

package/examples/old/complex/example004.jscad

@@ -1,16 +0,0 @@
-// title      : Example 004
-// author     : OpenSCAD.org, adapted by Rene K. Mueller
-// license    : MIT License
-// description: example004.scad ported to OpenJSCAD.org
-// file       : example004.jscad
-
-function example004 () {
-  return difference(
-    cube({size: 30, center: true}),
-    sphere(20)
-  );
-}
-
-function main () {
-  return example004();
-}

package/examples/old/complex/example005.jscad

@@ -1,27 +0,0 @@
-// title      : Example 005
-// author     : OpenSCAD.org, adapted by Rene K. Mueller
-// license    : MIT License
-// description: example005.scad ported to OpenJSCAD
-// file       : example005.jscad
-
-function example005 () {
-  var cy = [];
-  for (var i = 0; i <= 5; i++) {
-    cy[i] = translate([sin(360 * i / 6) * 80, cos(360 * i / 6) * 80, 0], cylinder({h: 200, r: 10}));
-  }
-  return translate([0, 0, -120],
-    union(
-      difference(
-        cylinder({h: 50, r: 100}),
-        translate([0, 0, 10], cylinder({h: 50, r: 80})),
-        translate([100, 0, 35], cube({size: 50, center: true}))
-      ),
-      cy,
-      translate([0, 0, 200], cylinder({h: 80, r1: 120, r2: 0}))
-    )
-  );
-}
-
-function main () {
-  return example005().scale(1 / 3);
-}