read-excel-file
Version:
Read small to medium `*.xlsx` files in a browser or Node.js. Parse to JSON with a strict schema.
118 lines (107 loc) • 7.79 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports["default"] = readXlsx;
var _parseProperties = _interopRequireDefault(require("./parseProperties.js"));
var _parseFilePaths = _interopRequireDefault(require("./parseFilePaths.js"));
var _parseStyles = _interopRequireDefault(require("./parseStyles.js"));
var _parseSharedStrings = _interopRequireDefault(require("./parseSharedStrings.js"));
var _parseSheet = _interopRequireDefault(require("./parseSheet.js"));
var _getData = _interopRequireDefault(require("./getData.js"));
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
function _createForOfIteratorHelperLoose(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (it) return (it = it.call(o)).next.bind(it); if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; return function () { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
// For an introduction in reading `*.xlsx` files see "The minimum viable XLSX reader":
// https://www.brendanlong.com/the-minimum-viable-xlsx-reader.html
/**
* Reads an (unzipped) XLSX file structure into a 2D array of cells.
* @param {object} contents - A list of XML files inside XLSX file (which is a zipped directory).
* @param {number?} options.sheet - Workbook sheet id (`1` by default).
* @param {string?} options.dateFormat - Date format, e.g. "mm/dd/yyyy". Values having this format template set will be parsed as dates.
* @param {object} contents - A list of XML files inside XLSX file (which is a zipped directory).
* @return {object} An object of shape `{ data, cells, properties }`. `data: string[][]` is an array of rows, each row being an array of cell values. `cells: string[][]` is an array of rows, each row being an array of cells. `properties: object` is the spreadsheet properties (e.g. whether date epoch is 1904 instead of 1900).
*/
function readXlsx(contents, xml) {
var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
if (!options.sheet) {
options = _objectSpread({
sheet: 1
}, options);
}
var getXmlFileContent = function getXmlFileContent(filePath) {
if (!contents[filePath]) {
throw new Error("\"".concat(filePath, "\" file not found inside the *.xlsx file zip archive"));
}
return contents[filePath];
};
// Some Excel editors don't want to use standard naming scheme for sheet files.
// https://github.com/tidyverse/readxl/issues/104
var filePaths = (0, _parseFilePaths["default"])(getXmlFileContent('xl/_rels/workbook.xml.rels'), xml);
// Default file path for "shared strings": "xl/sharedStrings.xml".
var values = filePaths.sharedStrings ? (0, _parseSharedStrings["default"])(getXmlFileContent(filePaths.sharedStrings), xml) : [];
// Default file path for "styles": "xl/styles.xml".
var styles = filePaths.styles ? (0, _parseStyles["default"])(getXmlFileContent(filePaths.styles), xml) : {};
var properties = (0, _parseProperties["default"])(getXmlFileContent('xl/workbook.xml'), xml);
// A feature for getting the list of sheets in an Excel file.
// https://github.com/catamphetamine/read-excel-file/issues/14
if (options.getSheets) {
return properties.sheets.map(function (_ref) {
var name = _ref.name;
return {
name: name
};
});
}
// Find the sheet by name, or take the first one.
var sheetId = getSheetId(options.sheet, properties.sheets);
// If the sheet wasn't found then throw an error.
// Example: "xl/worksheets/sheet1.xml".
if (!sheetId || !filePaths.sheets[sheetId]) {
throw createSheetNotFoundError(options.sheet, properties.sheets);
}
// Parse sheet data.
var sheet = (0, _parseSheet["default"])(getXmlFileContent(filePaths.sheets[sheetId]), xml, values, styles, properties, options);
options = _objectSpread({
// Create a `rowIndexMap` for the original dataset, if not passed,
// because "empty" rows will be dropped from the input data.
rowMap: []
}, options);
// Get spreadsheet data.
var data = (0, _getData["default"])(sheet, options);
// Can return properties, if required.
if (options.properties) {
return {
data: data,
properties: properties
};
}
// Return spreadsheet data.
return data;
}
function getSheetId(sheet, sheets) {
if (typeof sheet === 'number') {
var _sheet = sheets[sheet - 1];
return _sheet && _sheet.relationId;
}
for (var _iterator = _createForOfIteratorHelperLoose(sheets), _step; !(_step = _iterator()).done;) {
var _sheet2 = _step.value;
if (_sheet2.name === sheet) {
return _sheet2.relationId;
}
}
}
function createSheetNotFoundError(sheet, sheets) {
var sheetsList = sheets && sheets.map(function (sheet, i) {
return "\"".concat(sheet.name, "\" (#").concat(i + 1, ")");
}).join(', ');
return new Error("Sheet ".concat(typeof sheet === 'number' ? '#' + sheet : '"' + sheet + '"', " not found in the *.xlsx file.").concat(sheets ? ' Available sheets: ' + sheetsList + '.' : ''));
}
//# sourceMappingURL=readXlsx.js.map