fix(io-utils): added ensureString, updated io deserializers in order …

…to accept buffers

core: corrected registerDeserializer to read files as binary (buffers)

packages/cli/cli.conversions.test.js

@@ -8,19 +8,23 @@ test.afterEach.always((t) => {
   // remove files
   try {
     if (t.context.file1Path) fs.unlinkSync(t.context.file1Path)
-  } catch (err) {}
+  } catch (err) { }
 
   try {
     if (t.context.file2Path) fs.unlinkSync(t.context.file2Path)
-  } catch (err) {}
+  } catch (err) { }
 
   try {
     if (t.context.file3Path) fs.unlinkSync(t.context.file3Path)
-  } catch (err) {}
+  } catch (err) { }
 
   try {
     if (t.context.file4Path) fs.unlinkSync(t.context.file4Path)
-  } catch (err) {}
+  } catch (err) { }
+
+  try {
+    if (t.context.file5Path) fs.unlinkSync(t.context.file5Path)
+  } catch (err) { }
 })
 
 test.beforeEach((t) => {
@@ -68,6 +72,57 @@ module.exports = { main, getParameterDefinitions }
   return filePath
 }
 
+const createImportJscad = (id, extension) => {
+  const jscadScript = `// test script ${id} -- import
+
+const main = () => {
+  return require('./test${id}.${extension}')
+}
+
+module.exports = { main }
+`
+
+  const fileName = `./test${id}-import.jscad`;
+  const filePath = path.resolve(__dirname, fileName);
+  fs.writeFileSync(filePath, jscadScript);
+  return filePath;
+}
+
+const testBackImport = (t, testID, extension) => {
+  const cliPath = t.context.cliPath;
+
+  const file4Path = createImportJscad(testID, extension);
+  t.context.file4Path = file4Path;
+  t.true(fs.existsSync(file4Path));
+
+  const file5Name = `./test${testID}-import.stl`;
+  const file5Path = path.resolve(__dirname, file5Name);
+  t.context.file5Path = file5Path;
+  t.false(fs.existsSync(file5Path));
+
+  cmd = `node ${cliPath} ${file4Path}`
+  execSync(cmd, { stdio: [0, 1, 2] })
+  t.true(fs.existsSync(file5Path));
+}
+
+const runOnFixture = (t, fixtureName) => {
+  const inputFile = path.resolve(
+    __dirname,
+    path.join('test_fixtures', fixtureName, 'index.js'));
+
+  const outputFile = inputFile.replace('.js', '.stl');
+  t.context.file1Path = outputFile;
+
+  t.false(fs.existsSync(outputFile));
+
+  const cmd = `node ${t.context.cliPath} ${inputFile}`
+  execSync(cmd, { stdio: [0, 1, 2] });
+  t.true(fs.existsSync(outputFile))
+
+  return outputFile;
+}
+
+
 test('cli (conversions STL)', (t) => {
   const testID = 11
 
@@ -87,18 +142,20 @@ test('cli (conversions STL)', (t) => {
 
   let cmd = `node ${cliPath} ${file1Path}`
   execSync(cmd, { stdio: [0, 1, 2] })
-  t.true(fs.existsSync(file2Path))
+  t.true(fs.existsSync(file2Path));
 
   // convert from STL to JSCAD script
   const file3Name = `./test${testID}.js`
   const file3Path = path.resolve(__dirname, file3Name)
-  t.false(fs.existsSync(file3Path))
+  t.false(fs.existsSync(file3Path));
 
   t.context.file3Path = file3Path
 
   cmd = `node ${cliPath} ${file2Path} -o ${file3Path} -v -add-metadata false`
   execSync(cmd, { stdio: [0, 1, 2] })
-  t.true(fs.existsSync(file3Path))
+  t.true(fs.existsSync(file3Path));
+
+  testBackImport(t, testID, 'stl');
 })
 
 test('cli (conversions DXF)', (t) => {
@@ -132,6 +189,8 @@ test('cli (conversions DXF)', (t) => {
   cmd = `node ${cliPath} ${file2Path} -of js`
   execSync(cmd, { stdio: [0, 1, 2] })
   t.true(fs.existsSync(file3Path))
+
+  testBackImport(t, testID, 'dxf');
 })
 
 test('cli (conversions AMF)', (t) => {
@@ -165,6 +224,8 @@ test('cli (conversions AMF)', (t) => {
   cmd = `node ${cliPath} ${file2Path} -of js`
   execSync(cmd, { stdio: [0, 1, 2] })
   t.true(fs.existsSync(file3Path))
+
+  testBackImport(t, testID, 'amf');
 })
 
 test('cli (conversions JSON)', (t) => {
@@ -198,6 +259,8 @@ test('cli (conversions JSON)', (t) => {
   cmd = `node ${cliPath} ${file2Path} -of js`
   execSync(cmd, { stdio: [0, 1, 2] })
   t.true(fs.existsSync(file3Path))
+
+  testBackImport(t, testID, 'json');
 })
 
 test('cli (conversions SVG)', (t) => {
@@ -264,4 +327,12 @@ test('cli (conversions X3D)', (t) => {
   cmd = `node ${cliPath} ${file2Path} -of js`
   execSync(cmd, { stdio: [0, 1, 2] })
   t.true(fs.existsSync(file3Path))
+
+  testBackImport(t, testID, 'x3d');
+})
+
+test('cli (import STL)', (t) => {
+  const testID = 17
+
+  runOnFixture(t, 'stl_import')
 })

packages/cli/test_fixtures/stl_import/index.js

@@ -0,0 +1,6 @@
+
+function main() {
+  return require('./binary_stl.stl');
+}
+
+module.exports = { main }

packages/core/src/io/registerExtensions.js

@@ -16,8 +16,17 @@ const registerDeserializer = (extension, fs, _require) => {
   const deserializer = deserializers[extension]
   const fileExtension = '.' + extension
   _require.extensions[fileExtension] = (module, filename) => {
-    const content = fs.readFileSync(filename, 'utf8')
-    const parsed = deserializer({ filename, output: 'geometry' }, content)
+    const fileReadResult = fs.readFileSync(filename);
+
+    // https://nodejs.org/api/buffer.html#bufbuffer: Buffer.buffer is not 
+    // guaranteed to correspond exactly to the original Buffer.     
+    const fileContent = fileReadResult.buffer
+      ? fileReadResult.buffer.slice(
+        fileReadResult.byteOffset,
+        fileReadResult.byteOffset + fileReadResult.length)
+      : fileReadResult;
+
+    const parsed = deserializer({ filename, output: 'geometry' }, fileContent)
     module.exports = parsed
   }
 }

packages/io/amf-deserializer/package.json

@@ -32,6 +32,7 @@
   "license": "MIT",
   "dependencies": {
     "@jscad/modeling": "2.12.3",
+    "@jscad/io-utils": "2.0.28",
     "saxes": "5.0.1"
   },
   "devDependencies": {

packages/io/amf-deserializer/src/index.js

@@ -22,6 +22,8 @@ All code released under MIT license
  * const { deserializer, extension } = require('@jscad/amf-serializer')
  */
 
+const { ensureString } = require('@jscad/io-utils')
+
 const version = require('../package.json').version
 const translate = require('./translate')
 const instantiate = require('./deserialize')
@@ -48,6 +50,7 @@ const deserialize = (options, input) => {
   }
   options = Object.assign({}, defaults, options)
 
+  input = ensureString(input);
   return options.output === 'script' ? translate(options, input) : instantiate(options, input)
 }
 

packages/io/dxf-deserializer/index.js

@@ -7,7 +7,10 @@ All code released under MIT license
 
 */
 
+const { ensureString } = require('@jscad/io-utils')
+
 const version = require('./package.json').version
+
 const { BYLAYER, getTLA } = require('./autocad')
 const colorIndex = require('./colorindex2017')
 const dxf = require('./DxfReader')
@@ -275,7 +278,7 @@ const handleXcoord = (reader, group, value) => {
   const obj = reader.objstack.pop()
   if ('type' in obj) {
     if (obj.type === 'lwpolyline') {
-    // special handling to build a list of vertices
+      // special handling to build a list of vertices
       if (obj.pptxs === undefined) {
         obj.pptxs = []
         obj.bulgs = []
@@ -284,7 +287,7 @@ const handleXcoord = (reader, group, value) => {
       obj.bulgs.push(0)
     } else {
       if (obj.type === 'mesh') {
-      // special handling to build a list of vertices
+        // special handling to build a list of vertices
         if (obj.pptxs === undefined) {
           obj.pptxs = []
         }
@@ -307,7 +310,7 @@ const handleYcoord = (reader, group, value) => {
   const obj = reader.objstack.pop()
   if ('type' in obj) {
     if (obj.type === 'lwpolyline' || obj.type === 'mesh') {
-    // special handling to build a list of vertices
+      // special handling to build a list of vertices
       if (obj.pptys === undefined) {
         obj.pptys = []
       }
@@ -329,7 +332,7 @@ const handleZcoord = (reader, group, value) => {
   const obj = reader.objstack.pop()
   if ('type' in obj) {
     if (obj.type === 'mesh') {
-    // special handling to build a list of vertices
+      // special handling to build a list of vertices
       if (obj.pptzs === undefined) {
         obj.pptzs = []
       }
@@ -351,7 +354,7 @@ const handleBulge = (reader, group, value) => {
   const obj = reader.objstack.pop()
   if ('type' in obj) {
     if (obj.type === 'lwpolyline') {
-    // special handling to build a list of vertices
+      // special handling to build a list of vertices
       const bulgs = obj.bulgs
       if (bulgs !== undefined) {
         const pptxs = obj.pptxs
@@ -376,7 +379,7 @@ const handleLen = (reader, group, value) => {
   const obj = reader.objstack.pop()
   if ('type' in obj) {
     if (obj.type === 'mesh') {
-    // mesh has an order of lengths
+      // mesh has an order of lengths
       const state = obj.state
       // console.log('mesh len: '+group+','+value+','+state)
       switch (group) {
@@ -600,6 +603,8 @@ const deserialize = (options, src) => {
     }
   }
   options = Object.assign({}, defaults, options)
+
+  src = ensureString(src);
   return options.output === 'script' ? translate(src, options) : instantiate(src, options)
 }
 

packages/io/dxf-deserializer/package.json

@@ -28,7 +28,8 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@jscad/modeling": "2.12.3"
+    "@jscad/modeling": "2.12.3",
+    "@jscad/io-utils": "2.0.28"
   },
   "devDependencies": {
     "ava": "3.15.0",

packages/io/io-utils/ensureString.js

@@ -0,0 +1,9 @@
+const ensureString = (stringOrArrayBuffer, defaultBinaryEncoding = 'utf-8') => {
+  if (typeof (stringOrArrayBuffer) === 'string') {
+    return stringOrArrayBuffer;
+  }
+
+  return new TextDecoder(defaultBinaryEncoding).decode(new Uint8Array(stringOrArrayBuffer));
+}
+
+module.exports = ensureString;

packages/io/io-utils/index.js

@@ -8,5 +8,6 @@ module.exports = {
   convertToBlob: require('./convertToBlob'),
   makeBlob: require('./makeBlob'),
   BinaryReader: require('./BinaryReader'),
-  Blob: require('./Blob')
+  Blob: require('./Blob'),
+  ensureString: require('./ensureString')
 }

packages/io/json-deserializer/index.js

@@ -21,6 +21,7 @@ All code released under MIT license
  */
 
 const { flatten, toArray } = require('@jscad/array-utils')
+const { ensureString } = require('@jscad/io-utils')
 
 const version = require('./package.json').version
 
@@ -45,6 +46,7 @@ const deserialize = (options, input) => {
   options = Object.assign({}, defaults, options)
 
   // convert the JSON notation into anonymous object(s)
+  input = ensureString(input);
   let objects = JSON.parse(input)
 
   // cleanup the objects
@@ -69,7 +71,7 @@ const translate = (options, objects) => {
     : ''
 
   script +=
-`
+    `
 const { geometries } = require('@jscad/modeling')
 
 const main = () => {

packages/io/json-deserializer/package.json

@@ -28,7 +28,8 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@jscad/array-utils": "2.1.4"
+    "@jscad/array-utils": "2.1.4",
+    "@jscad/io-utils": "2.0.28"
   },
   "devDependencies": {
     "@jscad/modeling": "2.12.3",

packages/io/obj-deserializer/index.js

@@ -1,4 +1,5 @@
 const { colors, primitives } = require('@jscad/modeling')
+const { ensureString } = require('@jscad/io-utils')
 
 const version = require('./package.json').version
 
@@ -32,6 +33,8 @@ const deserialize = (options, input) => {
   options = Object.assign({}, defaults, options)
   const { output } = options
 
+  input = ensureString(input);
+
   options && options.statusCallback && options.statusCallback({ progress: 0 })
 
   const { positions, groups } = getGroups(input, options)

packages/io/obj-deserializer/package.json

@@ -32,7 +32,8 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@jscad/modeling": "2.12.3"
+    "@jscad/modeling": "2.12.3",
+    "@jscad/io-utils": "2.0.28"
   },
   "devDependencies": {
     "ava": "3.15.0",

packages/io/svg-deserializer/package.json

@@ -34,6 +34,7 @@
   "dependencies": {
     "@jscad/array-utils": "2.1.4",
     "@jscad/modeling": "2.12.3",
+    "@jscad/io-utils": "2.0.28",
     "saxes": "5.0.1"
   },
   "devDependencies": {