skiz-parser 1.3.0 → 1.6.1

package/README.md

@@ -14,8 +14,8 @@ $ npm install skiz-parser
 import { promises as fsAsync } from 'fs';
 import { parseSkizFile } from 'skiz-parser';
 
-const file = await fsAsync.readFile('./example.skiz');
-const result = await parseSkizFile(file);
+const contents = await fsAsync.readFile('./example.skiz');
+const result = await parseSkizFile(contents);
 
 console.log(result);
 //=> { name: 'Day 1 - 2018/2019', … }
@@ -23,13 +23,13 @@ console.log(result);
 
 ## API
 
-### parseSkizFile(file, callback?)
+### parseSkizFile(contents, callback?)
 
 Returns a `Promise<object>` with the parsed .skiz file.
 
 Optionally a callback function may be used instead.
 
-#### file
+#### contents
 
 Type: `Buffer`
 

package/index.js

@@ -1,8 +1,13 @@
 import csv from 'csv-parser';
-import xmlParser from 'fast-xml-parser';
+import { XMLParser } from 'fast-xml-parser';
 import { promisify } from 'util';
 import yauzl from 'yauzl';
 
+const parser = new XMLParser({
+  attributeNamePrefix: '',
+  ignoreAttributes: false,
+});
+
 const convertReadStreamToBuffer = (readStream) => {
   return new Promise((resolve, reject) => {
     const chunks = [];
@@ -18,6 +23,28 @@ const convertReadStreamToBuffer = (readStream) => {
   });
 };
 
+const parseBatteryCsvFile = (readStream) => {
+  return new Promise((resolve, reject) => {
+    const batteryUsage = [];
+
+    readStream
+      .pipe(csv({ headers: false }))
+      .on('error', reject)
+      .on('data', (data) => {
+        const values = Object.values(data);
+
+        batteryUsage.push({
+          timestamp: new Date(values[0]),
+          status: values[1],
+          level: parseFloat(values[2]),
+        });
+      })
+      .once('end', () => {
+        resolve({ batteryUsage });
+      });
+  });
+};
+
 const parseNodeCsvFile = (readStream) => {
   return new Promise((resolve, reject) => {
     const trackNodes = [];
@@ -87,13 +114,8 @@ const parseSegmentCsvFile = (readStream) => {
 };
 
 const parseTrackXmlFile = async (readStream) => {
-  const options = {
-    attributeNamePrefix: '',
-    ignoreAttributes: false,
-  };
-
   const buffer = await convertReadStreamToBuffer(readStream);
-  const parsed = xmlParser.parse(buffer.toString('utf-8'), options);
+  const parsed = parser.parse(buffer.toString('utf-8'));
 
   const track = parsed.track;
   const metrics = track.metrics;
@@ -149,13 +171,8 @@ const parseTrackXmlFile = async (readStream) => {
 };
 
 const parseEventsXmlFile = async (readStream) => {
-  const options = {
-    attributeNamePrefix: '',
-    ignoreAttributes: false,
-  };
-
   const buffer = await convertReadStreamToBuffer(readStream);
-  const parsed = xmlParser.parse(buffer.toString('utf-8'), options);
+  const parsed = parser.parse(buffer.toString('utf-8'));
 
   const events = parsed.events.event || [];
   const trackEvents = events.map((event) => ({
@@ -167,9 +184,13 @@ const parseEventsXmlFile = async (readStream) => {
   return { trackEvents };
 };
 
-export const parseSkizFile = (file, callback) => {
+export const parseSkizFile = (contents, callback) => {
   const parse = (resolve, reject) => {
-    yauzl.fromBuffer(file, { lazyEntries: true }, (err, zipFile) => {
+    if (contents instanceof ArrayBuffer) {
+      contents = Buffer.from(contents);
+    }
+
+    yauzl.fromBuffer(contents, { lazyEntries: true }, (err, zipFile) => {
       if (err) {
         return reject(err);
       }
@@ -184,9 +205,13 @@ export const parseSkizFile = (file, callback) => {
         .on('error', reject)
         .on('entry', async (entry) => {
           if (
-            !['Events.xml', 'Nodes.csv', 'Segment.csv', 'Track.xml'].includes(
-              entry.fileName
-            )
+            ![
+              'Battery.csv',
+              'Events.xml',
+              'Nodes.csv',
+              'Segment.csv',
+              'Track.xml',
+            ].includes(entry.fileName)
           ) {
             return zipFile.readEntry();
           }
@@ -194,7 +219,9 @@ export const parseSkizFile = (file, callback) => {
           const readStream = await openReadStream(entry);
 
           let result;
-          if (entry.fileName === 'Events.xml') {
+          if (entry.fileName === 'Battery.csv') {
+            result = await parseBatteryCsvFile(readStream);
+          } else if (entry.fileName === 'Events.xml') {
             result = await parseEventsXmlFile(readStream);
           } else if (entry.fileName === 'Nodes.csv') {
             result = await parseNodeCsvFile(readStream);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "skiz-parser",
   "description": "Parse a .skiz file exported from Ski Tracks",
-  "version": "1.3.0",
+  "version": "1.6.1",
   "author": "Kirk Eaton <contact@kirkeaton.ca>",
   "ava": {
     "files": [
@@ -14,13 +14,13 @@
   },
   "dependencies": {
     "csv-parser": "^3.0.0",
-    "fast-xml-parser": "^3.19.0",
+    "fast-xml-parser": "^4.0.1",
     "yauzl": "^2.10.0"
   },
   "devDependencies": {
-    "ava": "^3.15.0",
-    "husky": "^6.0.0",
-    "lint-staged": "^10.5.4",
+    "ava": "^4.0.1",
+    "husky": "^7.0.0",
+    "lint-staged": "^12.1.4",
     "prettier": "^2.2.1"
   },
   "engines": {
@@ -31,11 +31,6 @@
     "index.js"
   ],
   "homepage": "https://github.com/kirkeaton/skiz-parser#readme",
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
-  },
   "keywords": [
     "file",
     "parse",
@@ -44,7 +39,7 @@
   ],
   "license": "BSD-3-Clause",
   "lint-staged": {
-    "*.{ts,tsx,json,md}": "prettier --write"
+    "*.{js,json,md}": "prettier --write"
   },
   "prettier": {
     "printWidth": 80,
@@ -62,6 +57,7 @@
     "url": "git+https://github.com/kirkeaton/skiz-parser.git"
   },
   "scripts": {
+    "prepare": "husky install",
     "test": "ava -v"
   },
   "type": "module"