npm

Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »

mongo-xlsx

1.0.3 • Public • Published

mongo-xlsx

IMPORTANT: Pre-ALPHA quality.

mongo-xlsx is a node.js utility module which provides tools that convert excel spreadsheets into/from MongoDB data. (MongoDB data -> Array of JSONs)

The general data conversion flow:

MongoDB   -> (extract data with mongoose.find)  -> MongoData -> (convert with mongoData2Xlsx)        -> file.xlsx
file.xlsx -> (convert data with xlsx2MongoData) -> MongoData -> (save to MongoDB with mongoose.save) -> MongoDB

alt tag

Quick Examples

var mongoXlsx = require('mongo-xlsx');
 
var data = [ { name : "Peter", lastName : "Parker", isSpider : true } , 
             { name : "Remy",  lastName : "LeBeau", powers : ["kinetic cards"] }];
 
/* Generate automatic model for processing (A static model should be used) */
var model = mongoXlsx.buildDynamicModel(data);
 
/* Generate Excel */
mongoxlsx.mongoData2Xlsx(json1Xlsx, model, function(err, data) {
  console.log('File saved at:', data.fullPath); 
});
/* Read Excel */
mongoxlsx.xlsx2MongoData("./file.xlsx", model, function(err, mongoData) {
  console.log('Mongo data:', mongoData); 
});

Instalation

npm install mongo-xlsx

Testing

node test

Documentation

buildDynamicModel(mongoData)

Generates a model for converting into/from Excel/MongoData. This can be used to create a static conversion model.

mongoData2Xlsx(monogData, mongoModel, [options], callback)

Converts MongoData into a Excel File

mongoData2XlsxData(mongoData, mongoModel)

Converts MongoData into Excel Data to allow merging into single Excel File

xlsx2MongoData(path, mongoModel, [options], callback)

Converts Excel File into Mongo Data. If mongoModel is null trys to use the file's header to build the JSON Otherwise the mongoModel map will be used to build the JSON

xlsxData2MongoData(excelData, mongoModel)

Converts Excel Data into Mongo Data. If mongoModel is null trys to use the file's header to build the JSON Otherwise the mongoModel map will be used to build the JSON

Roadmap

  • Fix test system & add more complex tests
  • Allow to read Excel without model
  • Read from the modelMap while converting from excel to json (allow custom headers on excel)
  • Allow to filter fields with model
  • Fix performance issues
  • Fix date objects (Fixed: test@ test_time.js but test are more lax)
  • Add model examples and tests
  • Allow to merge múltiple ExcelData into a single SpreadSheet w/multiple sheets.

Known Limitations

  1. Not using modelMap to convert from excel to json
  2. May not work well with mixed types for the same key

e.g. error1_test.json is passing but their may be unknown side effects. More test are needed

[{"a":1},{"a":["hello","world"]},{"a":{"b":true,"c":false}}]
  1. Nested objects "first" element element may not be a numeric or string-numeric: (ECMA-262 does not specify enumeration order. The de facto standard is to match insertion order.)

e.g.,

  {
    "0" : "Hello",
    "a" : "world"
  }
  1. Very Slow :'( Some Performance Issues @ JSON.parse(JSON.stringify(x)) to make a copy and not modify original data (error1_test.json)

  2. nulls, empty cells, undefined hell

install

npm i mongo-xlsx

Downloadsweekly downloads

312

version

1.0.3

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability