@statengine/siamese 0.0.18

package/README.md

@@ -0,0 +1,18 @@
+# siamese
+
+Pluggable library to help transform public safety data into standardized schemas.
+
+## Installation
+
+Using npm:
+```
+npm install @statengine/siamese
+```
+
+## Tests
+To run the test suite, first install the dependencies, then run `npm test`:
+
+```bash
+npm install
+npm test
+```

package/lib/helpers.js

@@ -0,0 +1,70 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _slicedToArray = function () { function sliceIterator(arr, i) { var _arr = []; var _n = true; var _d = false; var _e = undefined; try { for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"]) _i["return"](); } finally { if (_d) throw _e; } } return _arr; } return function (arr, i) { if (Array.isArray(arr)) { return arr; } else if (Symbol.iterator in Object(arr)) { return sliceIterator(arr, i); } else { throw new TypeError("Invalid attempt to destructure non-iterable instance"); } }; }();
+
+var _lodash = require('lodash');
+
+var _lodash2 = _interopRequireDefault(_lodash);
+
+var _priorityDispatchCodes = require('./priorityDispatchCodes');
+
+var _priorityDispatchCodes2 = _interopRequireDefault(_priorityDispatchCodes);
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var PRIORITY_DISPATCH_REGEX = /([0-9]+?)([ABCDEO])([0-9a-z]*)/;
+var SUBDETERMINATE_REGEX = /([0-9]+)([a-z]*)/;
+
+function split(code) {
+  /**
+  * @param {string} code - Priority dispatch code (eg: 32B).
+  * https://wiki.radioreference.com/index.php/Priority_Dispatch_Codes
+  */
+
+  var check = code.match(PRIORITY_DISPATCH_REGEX);
+
+  if (!check) {
+    return {};
+  }
+
+  var _check = _slicedToArray(check, 4),
+      protocol = _check[1],
+      determinate = _check[2],
+      subDeterminate = _check[3];
+
+  return {
+    protocol: protocol,
+    determinate: determinate,
+    subDeterminate: subDeterminate
+  };
+}
+
+function getProtocolDescription(protocol) {
+  if (protocol) {
+    return _lodash2.default.get(_priorityDispatchCodes2.default, '[' + Number(protocol).toString() + ']description');
+  }
+  return null;
+}
+
+function getSubDeterminateDescription(protocol, determinate, subDeterminate) {
+  if (protocol && determinate && subDeterminate) {
+    var _subDeterminate$toStr = subDeterminate.toString().match(SUBDETERMINATE_REGEX),
+        _subDeterminate$toStr2 = _slicedToArray(_subDeterminate$toStr, 2),
+        noSuffix = _subDeterminate$toStr2[1];
+
+    return _lodash2.default.get(_priorityDispatchCodes2.default, '[' + Number(protocol).toString() + ']determinates[' + determinate + ']subdeterminants[' + Number(noSuffix).toString() + '.description]');
+  }
+  return null;
+}
+
+exports.default = {
+  priorityDispatch: {
+    split: split,
+    getProtocolDescription: getProtocolDescription,
+    getSubDeterminateDescription: getSubDeterminateDescription
+  }
+};

package/lib/index.js

@@ -0,0 +1,551 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.helpers = exports.VehicleTelemetryNormalizer = exports.BaseNormalizer = undefined;
+
+var _slicedToArray = function () { function sliceIterator(arr, i) { var _arr = []; var _n = true; var _d = false; var _e = undefined; try { for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"]) _i["return"](); } finally { if (_d) throw _e; } } return _arr; } return function (arr, i) { if (Array.isArray(arr)) { return arr; } else if (Symbol.iterator in Object(arr)) { return sliceIterator(arr, i); } else { throw new TypeError("Invalid attempt to destructure non-iterable instance"); } }; }();
+
+var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
+
+exports.transformDate = transformDate;
+
+var _ngeohash = require('ngeohash');
+
+var _ngeohash2 = _interopRequireDefault(_ngeohash);
+
+var _momentTimezone = require('moment-timezone');
+
+var _momentTimezone2 = _interopRequireDefault(_momentTimezone);
+
+var _proj = require('proj4');
+
+var _proj2 = _interopRequireDefault(_proj);
+
+var _lodash = require('lodash');
+
+var _lodash2 = _interopRequireDefault(_lodash);
+
+var _jsonschema = require('jsonschema');
+
+var _shiftly = require('@statengine/shiftly');
+
+var _schemas = require('@statengine/schemas');
+
+var _fs = require('fs');
+
+var _fs2 = _interopRequireDefault(_fs);
+
+var _xml2js = require('xml2js');
+
+var _xml2js2 = _interopRequireDefault(_xml2js);
+
+var _bluebird = require('bluebird');
+
+var _bluebird2 = _interopRequireDefault(_bluebird);
+
+var _helpers = require('./helpers');
+
+var _helpers2 = _interopRequireDefault(_helpers);
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _possibleConstructorReturn(self, call) { if (!self) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return call && (typeof call === "object" || typeof call === "function") ? call : self; }
+
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+function transformDate(dateString, timeZone, format) {
+  return _momentTimezone2.default.tz(dateString, format, timeZone);
+}
+
+var BaseNormalizer = exports.BaseNormalizer = function () {
+  function BaseNormalizer() {
+    _classCallCheck(this, BaseNormalizer);
+  }
+
+  _createClass(BaseNormalizer, [{
+    key: 'transformCoordinates',
+    value: function transformCoordinates(x, y) {
+      var toProjection = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 'EPSG:4326';
+
+      return (0, _proj2.default)((0, _proj2.default)(this.projection), (0, _proj2.default)(toProjection), [x, y]);
+    }
+  }, {
+    key: 'parseDate',
+    value: function parseDate(incomingDate) {
+      // Assume dates are already in ISO-8601, just convert them into to the department's TZ.
+      return (0, _momentTimezone2.default)(incomingDate).tz(this.timeZone);
+    }
+  }, {
+    key: 'normalize',
+
+
+    // eslint-disable-next-line class-methods-use-this
+    value: function normalize() {
+      throw new Error('Not implemented.');
+    }
+  }, {
+    key: 'validate',
+    value: function validate() {
+      return (0, _jsonschema.validate)(this.normalize(), this.constructor.schema);
+    }
+  }], [{
+    key: 'latLongToGeohash',
+    value: function latLongToGeohash(x, y) {
+      var precision = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 12;
+
+      if (_lodash2.default.isNil(x) || _lodash2.default.isNil(y)) {
+        return null;
+      }
+      return _ngeohash2.default.encode(y, x, precision);
+    }
+  }, {
+    key: 'schema',
+
+    // eslint-disable-next-line class-methods-use-this
+    get: function get() {
+      throw new Error('Not implemented.');
+    }
+  }]);
+
+  return BaseNormalizer;
+}();
+
+var IncidentNormalizer = function (_BaseNormalizer) {
+  _inherits(IncidentNormalizer, _BaseNormalizer);
+
+  function IncidentNormalizer(payload) {
+    var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
+        _ref$timeZone = _ref.timeZone,
+        timeZone = _ref$timeZone === undefined ? 'US/Eastern' : _ref$timeZone,
+        _ref$projection = _ref.projection,
+        projection = _ref$projection === undefined ? 'EPSG:4326' : _ref$projection,
+        _ref$fdId = _ref.fdId,
+        fdId = _ref$fdId === undefined ? null : _ref$fdId,
+        _ref$firecaresId = _ref.firecaresId,
+        firecaresId = _ref$firecaresId === undefined ? null : _ref$firecaresId,
+        _ref$name = _ref.name,
+        name = _ref$name === undefined ? null : _ref$name,
+        _ref$state = _ref.state,
+        state = _ref$state === undefined ? null : _ref$state,
+        _ref$shiftConfig = _ref.shiftConfig,
+        shiftConfig = _ref$shiftConfig === undefined ? {} : _ref$shiftConfig;
+
+    _classCallCheck(this, IncidentNormalizer);
+
+    var _this = _possibleConstructorReturn(this, (IncidentNormalizer.__proto__ || Object.getPrototypeOf(IncidentNormalizer)).call(this));
+
+    _this.payload = payload;
+    _this.timeZone = timeZone;
+    _this.projection = projection;
+    _this.fdId = fdId;
+    _this.firecaresId = firecaresId;
+    _this.name = name;
+    _this.state = state;
+    // First use firecaresId to see if shift configuration exists in shiftly
+    var shiftlyConfig = IncidentNormalizer.lookupShiftlyConfig(_this.firecaresId);
+    if (shiftlyConfig != null) {
+      _this.shiftConfig = shiftlyConfig;
+    } else {
+      _this.shiftConfig = new _shiftly.ShiftConfiguration(shiftConfig);
+    }
+    return _this;
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+
+
+  _createClass(IncidentNormalizer, [{
+    key: 'normalize',
+
+
+    // eslint-disable-next-line class-methods-use-this
+    value: function normalize() {
+      return _lodash2.default.omitBy({
+        address: this.normalizeAddress(),
+        description: this.normalizeDescription(),
+        apparatus: this.normalizeApparatus(),
+        fire_department: this.normalizeFireDepartment(),
+        version: this.constructor.schema.version
+      }, _lodash2.default.isNil);
+    }
+
+    // eslint-disable-next-line class-methods-use-this
+
+  }, {
+    key: 'normalizeAddress',
+    value: function normalizeAddress() {
+      throw new Error('Not implemented.');
+    }
+
+    // eslint-disable-next-line class-methods-use-this
+
+  }, {
+    key: 'normalizeDescription',
+    value: function normalizeDescription() {
+      throw new Error('Not implemented.');
+    }
+
+    // eslint-disable-next-line class-methods-use-this
+
+  }, {
+    key: 'normalizeApparatus',
+    value: function normalizeApparatus() {
+      throw new Error('Not implemented.');
+    }
+
+    // eslint-disable-next-line class-methods-use-this
+
+  }, {
+    key: 'combineEntries',
+    value: function combineEntries() {
+      throw new Error('Not implemented.');
+    }
+  }, {
+    key: 'calculateShift',
+    value: function calculateShift(date) {
+      return this.shiftConfig.calculateShift(date);
+    }
+  }, {
+    key: 'normalizeFireDepartment',
+
+
+    // eslint-disable-next-line class-methods-use-this
+    value: function normalizeFireDepartment() {
+      return {
+        fd_id: this.fdId,
+        firecares_id: this.firecaresId,
+        name: this.name,
+        state: this.state,
+        timezone: this.timeZone
+      };
+    }
+  }], [{
+    key: 'calculateDuration',
+    value: function calculateDuration(startTime, endTime) {
+      return _momentTimezone2.default.duration(endTime.diff(startTime)).asSeconds();
+    }
+  }, {
+    key: 'calculateUnitStatusExtendedData',
+    value: function calculateUnitStatusExtendedData(unitStatus) {
+      var times = {};
+
+      var arr = _lodash2.default.values(unitStatus);
+
+      var clearedProperties = [];
+
+      _lodash2.default.map(['available', 'in_quarters', 'available_radio', 'available_mobile', 'cleared'], function (key) {
+        return clearedProperties.push(_lodash2.default.get(unitStatus, '' + key));
+      });
+
+      clearedProperties = _lodash2.default.filter(clearedProperties, function (prop) {
+        return !_lodash2.default.isNil(prop);
+      });
+
+      var cleared = void 0;
+      if (clearedProperties.length > 0) {
+        cleared = _lodash2.default.minBy(clearedProperties, function (o) {
+          return (0, _momentTimezone2.default)(o.timestamp).valueOf();
+        });
+      } else {
+        cleared = _lodash2.default.maxBy(arr, function (o) {
+          return (0, _momentTimezone2.default)(o.timestamp).valueOf();
+        });
+      }
+
+      var scene_left = void 0;
+      if (unitStatus.transport_started) {
+        scene_left = unitStatus.transport_started;
+      } else {
+        scene_left = cleared;
+      }
+
+      var scene_arrived = void 0;
+      if (unitStatus.staging) {
+        scene_arrived = unitStatus.staging;
+      } else {
+        scene_arrived = unitStatus.arrived;
+      }
+
+      var requirements = {
+        turnout_duration: [unitStatus.enroute, unitStatus.dispatched],
+        travel_duration: [scene_arrived, unitStatus.enroute],
+        staging_duration: [unitStatus.arrived, unitStatus.staging],
+        response_duration: [scene_arrived, unitStatus.dispatched],
+        on_scene_duration: [scene_left, scene_arrived],
+        event_duration: [cleared, unitStatus.dispatched],
+        on_scene_to_patient_contact: [unitStatus.patient_contact, scene_arrived],
+        on_scene_to_transport_arrived_duration: [unitStatus.transport_arrived, scene_arrived],
+        patient_contact_to_transport_arrived_duration: [unitStatus.transport_arrived, unitStatus.patient_contact],
+        transport_duration: [unitStatus.transport_arrived, unitStatus.transport_started],
+        at_hospital_duration: [cleared, unitStatus.transport_arrived]
+      };
+
+      Object.entries(requirements).forEach(function (_ref2) {
+        var _ref3 = _slicedToArray(_ref2, 2),
+            key = _ref3[0],
+            value = _ref3[1];
+
+        if (!_lodash2.default.every(value)) {
+          return;
+        }
+        times[key] = IncidentNormalizer.calculateDuration((0, _momentTimezone2.default)(value[1].timestamp), (0, _momentTimezone2.default)(value[0].timestamp));
+      });
+      return times;
+    }
+  }, {
+    key: 'calculateDescriptionExtendedData',
+    value: function calculateDescriptionExtendedData(description) {
+      var times = {};
+      var requirements = {
+        psap_answer_time_to_event_creation: [description.event_opened, description.psap_answer_time],
+        psap_answer_time_to_first_dispatch: [description.first_unit_dispatched, description.psap_answer_time],
+        psap_answer_time_to_first_arrival: [description.first_unit_arrived, description.psap_answer_time],
+        event_duration: [description.event_closed, description.event_opened],
+        response_duration: [description.first_unit_arrived, description.first_unit_dispatched]
+      };
+
+      Object.entries(requirements).forEach(function (_ref4) {
+        var _ref5 = _slicedToArray(_ref4, 2),
+            key = _ref5[0],
+            value = _ref5[1];
+
+        if (!_lodash2.default.every(value)) {
+          return;
+        }
+
+        times[key] = IncidentNormalizer.calculateDuration((0, _momentTimezone2.default)(value[1]), (0, _momentTimezone2.default)(value[0]));
+      });
+
+      return times;
+    }
+  }, {
+    key: 'toJSON',
+    value: function toJSON(string) {
+      return new _bluebird2.default(function (resolve, reject) {
+        try {
+          var js = JSON.parse(string);
+          resolve(js || string);
+        } catch (e) {
+          try {
+            var parser = new _xml2js2.default.Parser({ explicitArray: false });
+            parser.parseString(string, function (err, result) {
+              return resolve(result || string);
+            });
+          } catch (err) {
+            reject(err);
+          }
+        }
+      });
+    }
+  }, {
+    key: 'fromBytes',
+    value: function fromBytes(buffer) {
+      var encoding = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'utf8';
+
+      for (var _len = arguments.length, args = Array(_len > 2 ? _len - 2 : 0), _key = 2; _key < _len; _key++) {
+        args[_key - 2] = arguments[_key];
+      }
+
+      return this.fromString.apply(this, [buffer.toString(encoding)].concat(args));
+    }
+  }, {
+    key: 'fromString',
+    value: function fromString(string) {
+      var _this2 = this;
+
+      for (var _len2 = arguments.length, args = Array(_len2 > 1 ? _len2 - 1 : 0), _key2 = 1; _key2 < _len2; _key2++) {
+        args[_key2 - 1] = arguments[_key2];
+      }
+
+      // eslint-disable-next-line consistent-return
+      return new _bluebird2.default(function (resolve, reject) {
+        try {
+          return _this2.toJSON(string).then(function (res) {
+            return resolve(new (Function.prototype.bind.apply(_this2, [null].concat([res], args)))());
+          });
+        } catch (e) {
+          reject(e);
+        }
+      });
+    }
+  }, {
+    key: 'fromStrings',
+    value: function fromStrings(strings) {
+      var _this3 = this;
+
+      for (var _len3 = arguments.length, args = Array(_len3 > 1 ? _len3 - 1 : 0), _key3 = 1; _key3 < _len3; _key3++) {
+        args[_key3 - 1] = arguments[_key3];
+      }
+
+      // eslint-disable-next-line consistent-return
+      return _bluebird2.default.map(strings, this.toJSON).then(function (jsons) {
+        return new (Function.prototype.bind.apply(_this3, [null].concat([_this3.combineEntries(jsons)], args)))();
+      });
+    }
+  }, {
+    key: 'fromFile',
+    value: function fromFile(file) {
+      for (var _len4 = arguments.length, args = Array(_len4 > 2 ? _len4 - 2 : 0), _key4 = 2; _key4 < _len4; _key4++) {
+        args[_key4 - 2] = arguments[_key4];
+      }
+
+      var _this4 = this;
+
+      var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : { encoding: 'utf-8', flag: 'r' };
+
+      return new _bluebird2.default(function (resolve, reject) {
+        _fs2.default.readFile(file, options, function (err, data) {
+          if (err) {
+            reject(err);
+          }
+          return _this4.fromString.apply(_this4, [data].concat(args)).then(resolve);
+        });
+      });
+    }
+  }, {
+    key: 'fromFiles',
+    value: function fromFiles(files) {
+      var _this5 = this;
+
+      for (var _len5 = arguments.length, args = Array(_len5 > 1 ? _len5 - 1 : 0), _key5 = 1; _key5 < _len5; _key5++) {
+        args[_key5 - 1] = arguments[_key5];
+      }
+
+      // eslint-disable-next-line
+      return _bluebird2.default.map(files, function (file) {
+        return new _bluebird2.default(function (resolve, reject) {
+          _fs2.default.readFile(file, 'utf-8', function (err, data) {
+            if (err) {
+              reject(err);
+            }
+            resolve(data);
+          });
+        });
+      }).then(function (jsons) {
+        return _this5.fromStrings.apply(_this5, [jsons].concat(args));
+      });
+    }
+  }, {
+    key: 'lookupShiftlyConfig',
+    value: function lookupShiftlyConfig(firecaresId) {
+      var shiftlyFactoryMethod = _shiftly.FirecaresLookup[firecaresId];
+      var shiftlyConfig = null;
+      if (shiftlyFactoryMethod != null) {
+        shiftlyConfig = shiftlyFactoryMethod();
+      }
+      return shiftlyConfig;
+    }
+  }, {
+    key: 'schema',
+    get: function get() {
+      return _schemas.schemas.fire;
+    }
+  }]);
+
+  return IncidentNormalizer;
+}(BaseNormalizer);
+
+exports.default = IncidentNormalizer;
+
+var VehicleTelemetryNormalizer = exports.VehicleTelemetryNormalizer = function (_BaseNormalizer2) {
+  _inherits(VehicleTelemetryNormalizer, _BaseNormalizer2);
+
+  function VehicleTelemetryNormalizer(payload) {
+    var _ref6 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
+        _ref6$timeZone = _ref6.timeZone,
+        timeZone = _ref6$timeZone === undefined ? 'US/Eastern' : _ref6$timeZone,
+        _ref6$projection = _ref6.projection,
+        projection = _ref6$projection === undefined ? 'EPSG:4326' : _ref6$projection,
+        _ref6$fdId = _ref6.fdId,
+        fdId = _ref6$fdId === undefined ? null : _ref6$fdId,
+        _ref6$firecaresId = _ref6.firecaresId,
+        firecaresId = _ref6$firecaresId === undefined ? null : _ref6$firecaresId,
+        _ref6$name = _ref6.name,
+        name = _ref6$name === undefined ? null : _ref6$name,
+        _ref6$state = _ref6.state,
+        state = _ref6$state === undefined ? null : _ref6$state;
+
+    _classCallCheck(this, VehicleTelemetryNormalizer);
+
+    var _this6 = _possibleConstructorReturn(this, (VehicleTelemetryNormalizer.__proto__ || Object.getPrototypeOf(VehicleTelemetryNormalizer)).call(this));
+
+    _this6.payload = payload;
+    _this6.timeZone = timeZone;
+    _this6.projection = projection;
+    _this6.fdId = fdId;
+    _this6.firecaresId = firecaresId;
+    _this6.name = name;
+    _this6.state = state;
+    return _this6;
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+
+
+  _createClass(VehicleTelemetryNormalizer, [{
+    key: 'normalize',
+    value: function normalize() {
+      var incident = this.normalizeIncident();
+      var response = {
+        version: this.constructor.schema.version,
+        fire_department: this.normalizeFireDepartment(),
+        apparatus: this.normalizeApparatus(),
+        telemetry: this.normalizeTelemetry()
+      };
+
+      if (!_lodash2.default.isEmpty(incident.incident_number)) {
+        response.incident = incident;
+      }
+
+      return response;
+    }
+  }, {
+    key: 'normalizeFireDepartment',
+    value: function normalizeFireDepartment() {
+      return {
+        fd_id: this.fdId,
+        firecares_id: this.firecaresId,
+        name: this.name,
+        state: this.state,
+        timezone: this.timeZone
+      };
+    }
+
+    // eslint-disable-next-line class-methods-use-this
+
+  }, {
+    key: 'normalizeApparatus',
+    value: function normalizeApparatus() {
+      throw new Error('Not implemented.');
+    }
+
+    // eslint-disable-next-line class-methods-use-this
+
+  }, {
+    key: 'normalizeIncident',
+    value: function normalizeIncident() {
+      throw new Error('Not implemented.');
+    }
+
+    // eslint-disable-next-line class-methods-use-this
+
+  }, {
+    key: 'normalizeTelemetry',
+    value: function normalizeTelemetry() {
+      throw new Error('Not implemented.');
+    }
+  }], [{
+    key: 'schema',
+    get: function get() {
+      return _schemas.schemas.vehicleTelemetry;
+    }
+  }]);
+
+  return VehicleTelemetryNormalizer;
+}(BaseNormalizer);
+
+exports.helpers = _helpers2.default;