@furkot/export-expense-report 0.0.5 → 1.0.2

package/Readme.md

@@ -15,7 +15,7 @@ $ npm install --save @furkot/export-expense-report
 ## Usage
 
 ```js
-const expenseReport = require('@furkot/export-expense-report');
+import expenseReport from '@furkot/export-expense-report';
 
 expenseReport(trip);
 ```

package/lib/expense-report.js

@@ -1,10 +1,8 @@
-const format = require('./format');
+import { formatAmount, formatDate, formatDescription, formatDistance } from './format.js';
 
-exports = module.exports = expenseReport;
-
-exports.contentType = 'text/csv';
-exports.extension = 'csv';
-exports.encoding = 'utf8';
+expenseReport.contentType = 'text/csv';
+expenseReport.extension = 'csv';
+expenseReport.encoding = 'utf8';
 
 const types = init(
   [98, 161],
@@ -12,11 +10,7 @@ const types = init(
   init(
     [10, 25, 178, 179],
     'fuel',
-    init(
-      [9, 24, 27, 28, 30, 31, 32, 90, 139, 143, 156, 158, 159, 172],
-      'meal',
-      Object.create(null)
-    )
+    init([9, 24, 27, 28, 30, 31, 32, 90, 139, 143, 156, 158, 159, 172], 'meal', Object.create(null))
   )
 );
 
@@ -27,51 +21,39 @@ function init(arr, tp, r) {
   }, r);
 }
 function prepare(line) {
-  return line.map(function (item) {
-    if (typeof item === 'number') {
-      return '' + item;
-    }
-    if (typeof item === 'string') {
-      // quote strings
-      return '"' + item.replace(/"/g, '""') + '"';
+  const items = line.map(item => {
+    switch (typeof item) {
+      case 'number':
+        return item.toString();
+      case 'string':
+        // quote strings
+        return `"${item.replace(/"/g, '""')}"`;
+      default:
+        // empty string for everything else
+        return '';
     }
-    // empty string for everything else
-    return '';
-  }).join(',') + '\n';
+  });
+  return `${items.join(',')}\n`;
 }
 
-function getType({
-  nights,
-  sym
-}) {
+function getType({ nights, sym }) {
   if (nights) {
     return 'lodging';
   }
   return types[sym] || '';
 }
 
-function* expenseReport(options) {
+export default function* expenseReport(options) {
   const {
-    metadata: {
-      currency,
-      units,
-      mileageRate,
-      mode: tripMode
-    },
+    metadata: { currency, units, mileageRate, mode: tripMode },
     routes
   } = options;
 
-  const header = [
-    'Description',
-    'Date',
-    'Amount',
-    'Currency',
-    'Type',
-    'Notes'
-  ];
+  const header = ['Description', 'Date', 'Amount', 'Currency', 'Type', 'Notes'];
 
   const steps = routes[0].points;
   let from;
+  let passthruDistance = 0;
 
   function getLines(i) {
     const {
@@ -86,25 +68,35 @@ function* expenseReport(options) {
       name,
       nights,
       notes,
+      passthru,
       per_diem,
       tags
     } = steps[i];
+
+    if (passthru) {
+      passthruDistance += distance;
+      return [];
+    }
+    const stepDistance = (distance ?? 0) + passthruDistance;
+    passthruDistance = 0;
     const to = name || address;
-    const date = format.date(new Date(arrival_time));
+    const date = formatDate(new Date(arrival_time));
     const inTripMode = mode === undefined || mode === tripMode;
     const lines = [];
 
-    if (mileageRate && distance && inTripMode) {
+    if (mileageRate && stepDistance && inTripMode) {
       const line = [];
 
-      line.push(format.description(
-        [from, to].join(' - '),
-        dayLabel,
-        format.distance(distance, 1, units, true),
-        format.amount(mileageRate / 100, 3, currency)
-      ));
+      line.push(
+        formatDescription(
+          [from, to].join(' - '),
+          dayLabel,
+          formatDistance(stepDistance, 1, units, true),
+          formatAmount(mileageRate / 100, 3, currency)
+        )
+      );
       line.push(date);
-      line.push(format.distance(distance * mileageRate / 100, 2, units));
+      line.push(formatDistance((stepDistance * mileageRate) / 100, 2, units));
       line.push(currency);
       line.push('mileage');
 
@@ -113,9 +105,9 @@ function* expenseReport(options) {
     if (costRoute) {
       const line = [];
 
-      line.push(format.description([from, to].join(' - '), dayLabel));
+      line.push(formatDescription([from, to].join(' - '), dayLabel));
       line.push(date);
-      line.push(format.amount(costRoute / 100, 2));
+      line.push(formatAmount(costRoute / 100, 2));
       line.push(currency);
       line.push(inTripMode ? 'tolls' : 'transportation');
 
@@ -124,14 +116,16 @@ function* expenseReport(options) {
     if (cost) {
       const line = [];
 
-      line.push(format.description(name || address, tags, dayLabel,
-        nights > 1 &&
-        [
-          format.amount(cost / 100, 2, currency),
-          `${day + 1}/${nights}`
-        ]));
+      line.push(
+        formatDescription(
+          name || address,
+          tags,
+          dayLabel,
+          nights > 1 && [formatAmount(cost / 100, 2, currency), `${day + 1}/${nights}`]
+        )
+      );
       line.push(date);
-      line.push(format.amount(cost / (nights || 1) / 100, 2));
+      line.push(formatAmount(cost / (nights || 1) / 100, 2));
       line.push(currency);
       line.push(getType(steps[i]));
       line.push(notes);
@@ -141,9 +135,9 @@ function* expenseReport(options) {
     if (per_diem) {
       const line = [];
 
-      line.push(format.description(address || name, tags, dayLabel));
+      line.push(formatDescription(address || name, tags, dayLabel));
       line.push(date);
-      line.push(format.amount(per_diem / 100, 2));
+      line.push(formatAmount(per_diem / 100, 2));
       line.push(currency);
       line.push('per diem');
       line.push(notes);

package/lib/format.js

@@ -1,15 +1,8 @@
-module.exports = {
-  amount,
-  date,
-  description,
-  distance
-};
-
 function pad(n) {
-  return n < 10 ? '0' + n : n;
+  return n < 10 ? `0${n}` : n;
 }
 
-function amount(amt, precision, currency) {
+export function formatAmount(amt, precision, currency) {
   precision = precision || 0;
   const result = amt.toFixed(precision);
   if (currency) {
@@ -18,25 +11,15 @@ function amount(amt, precision, currency) {
   return result;
 }
 
-function date(d) {
+export function formatDate(d) {
   return [d.getUTCFullYear(), d.getUTCMonth() + 1, d.getUTCDate()].map(pad).join('-');
 }
 
-function description() {
-  return Array.prototype.reduce.call(arguments, (r, v) => {
-    if (v) {
-      if (Array.isArray(v)) {
-        r.push(...v);
-      }
-      else {
-        r.push(v);
-      }
-    }
-    return r;
-  }, []).join(' / ');
+export function formatDescription(...args) {
+  return args.filter(Boolean).flat().join(' / ');
 }
 
-function distance(dist, precision, units, withUnits) {
+export function formatDistance(dist, precision, units, withUnits) {
   const div = units === 'km' ? 1000 : 1609.344;
   precision = precision || 0;
   const result = (dist / div).toFixed(precision);

package/package.json

@@ -1,13 +1,18 @@
 {
   "name": "@furkot/export-expense-report",
-  "version": "0.0.5",
+  "version": "1.0.2",
   "description": "Generate CSV expense report from Furkot trip data.",
+  "type": "module",
+  "exports": "./lib/expense-report.js",
   "author": {
     "name": "Natalia Kowalczyk",
     "email": "melitele@code42day.com",
     "url": "https://melitele.me"
   },
-  "repository": "furkot/export-expense-report",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/furkot/export-expense-report.git"
+  },
   "license": "MIT",
   "keywords": [
     "expense-report",
@@ -17,16 +22,13 @@
     "planner",
     "CSV"
   ],
-  "dependencies": {},
   "devDependencies": {
-    "@pirxpilot/jshint": "~3",
-    "should": "~13"
+    "@biomejs/biome": "^1.9.4"
   },
   "scripts": {
     "test": "make check"
   },
   "files": [
-    "index.js",
     "lib"
   ]
-}
+}

package/index.js

@@ -1 +0,0 @@
-module.exports = require('./lib/expense-report');