@speleotica/frcsdata 3.0.1 → 4.0.1

package/formatFrcsShot.d.ts

@@ -0,0 +1,3 @@
+import { FrcsTripHeader } from './FrcsTrip';
+import { FrcsShot } from './FrcsShot';
+export default function formatFrcsShot(shot: FrcsShot, header: FrcsTripHeader): string;

package/formatFrcsShot.js

@@ -0,0 +1,72 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = formatFrcsShot;
+var _FrcsShot = require("./FrcsShot");
+var _unitized = require("@speleotica/unitized");
+var STATION_WIDTH = 5;
+var EMPTY_STATION = ' '.repeat(STATION_WIDTH);
+function formatStation(station) {
+  if (station.length > STATION_WIDTH) {
+    throw new Error("station is too long: ".concat(station));
+  }
+  return station.padStart(STATION_WIDTH, ' ');
+}
+function trimZeroes(str) {
+  var match = /(-?\d+)(\.[1-9]*)0+$/.exec(str);
+  if (!match) return str;
+  return match[2].length > 1 ? match[1] + match[2] : match[1];
+}
+var formatNumber = function formatNumber(width) {
+  return function (num) {
+    if (num == null || !Number.isFinite(num)) return ' '.repeat(width);
+    var formatted = trimZeroes(num.toFixed(2));
+    if (formatted.length <= width) return formatted.padStart(width, ' ');
+    if (formatted.length > width + 2) return formatted.substring(0, width);
+    return trimZeroes(num.toFixed(2 - formatted.length + width)).padStart(width, ' ');
+  };
+};
+var LRUD_WIDTH = 3;
+var formatLrud = formatNumber(LRUD_WIDTH);
+var DISTANCE_WIDTH = 6;
+var EMPTY_DISTANCE = ' '.repeat(DISTANCE_WIDTH);
+var formatDistance = formatNumber(DISTANCE_WIDTH);
+var AZIMUTH_WIDTH = 6;
+var EMPTY_AZIMUTH = ' '.repeat(AZIMUTH_WIDTH);
+var formatAzimuth = formatNumber(AZIMUTH_WIDTH);
+var INCLINATION_WIDTH = 5;
+var EMPTY_INCLINATION = ' '.repeat(INCLINATION_WIDTH);
+var formatInclination = formatNumber(INCLINATION_WIDTH);
+var formatVerticalDistance = formatNumber(INCLINATION_WIDTH);
+var FEET_WIDTH = 4;
+var EMPTY_FEET = ' '.repeat(FEET_WIDTH);
+function formatFeet(distance) {
+  if (!distance) return EMPTY_FEET;
+  return formatNumber(FEET_WIDTH)(Math.trunc(distance.get(_unitized.Length.feet)));
+}
+var INCHES_WIDTH = 3;
+var EMPTY_INCHES = ' '.repeat(INCHES_WIDTH);
+function formatInches(distance) {
+  if (!distance) return EMPTY_INCHES;
+  return formatNumber(INCHES_WIDTH)(Math.round(distance.get(_unitized.Length.inches) % 12));
+}
+function formatFrcsShot(shot, header) {
+  var _shot$frontsightAzimu, _shot$backsightAzimut, _shot$frontsightIncli, _shot$verticalDistanc, _shot$backsightInclin, _shot$toLruds, _shot$toLruds$left, _shot$toLruds2, _shot$toLruds2$right, _shot$toLruds3, _shot$toLruds3$up, _shot$toLruds4, _shot$toLruds4$down;
+  var azimuthUnit = header.azimuthUnit,
+    inclinationUnit = header.inclinationUnit;
+  var distanceUnit = header.distanceUnit;
+  var inches = distanceUnit === _unitized.Length.inches;
+  if (inches) distanceUnit = _unitized.Length.feet;
+  if (!shot.to) {
+    var _shot$fromLruds, _shot$fromLruds$left, _shot$fromLruds2, _shot$fromLruds2$righ, _shot$fromLruds3, _shot$fromLruds3$up, _shot$fromLruds4, _shot$fromLruds4$down;
+    return [formatStation(shot.from), EMPTY_STATION, EMPTY_DISTANCE, ' ',
+    // kind
+    ' ',
+    // exclude
+    EMPTY_AZIMUTH, EMPTY_AZIMUTH, EMPTY_INCLINATION, EMPTY_INCLINATION, formatLrud((_shot$fromLruds = shot.fromLruds) === null || _shot$fromLruds === void 0 ? void 0 : (_shot$fromLruds$left = _shot$fromLruds.left) === null || _shot$fromLruds$left === void 0 ? void 0 : _shot$fromLruds$left.get(distanceUnit)), formatLrud((_shot$fromLruds2 = shot.fromLruds) === null || _shot$fromLruds2 === void 0 ? void 0 : (_shot$fromLruds2$righ = _shot$fromLruds2.right) === null || _shot$fromLruds2$righ === void 0 ? void 0 : _shot$fromLruds2$righ.get(distanceUnit)), formatLrud((_shot$fromLruds3 = shot.fromLruds) === null || _shot$fromLruds3 === void 0 ? void 0 : (_shot$fromLruds3$up = _shot$fromLruds3.up) === null || _shot$fromLruds3$up === void 0 ? void 0 : _shot$fromLruds3$up.get(distanceUnit)), formatLrud((_shot$fromLruds4 = shot.fromLruds) === null || _shot$fromLruds4 === void 0 ? void 0 : (_shot$fromLruds4$down = _shot$fromLruds4.down) === null || _shot$fromLruds4$down === void 0 ? void 0 : _shot$fromLruds4$down.get(distanceUnit))].join('');
+  }
+  var distColumnValue = shot.kind === _FrcsShot.FrcsShotKind.Horizontal ? shot.horizontalDistance : shot.distance;
+  return [formatStation(shot.to), formatStation(shot.from), inches ? formatFeet(distColumnValue) : formatDistance(distColumnValue === null || distColumnValue === void 0 ? void 0 : distColumnValue.get(distanceUnit)), inches ? formatInches(distColumnValue) : shot.kind, inches ? shot.kind : shot.excludeDistance ? '*' : ' ', formatAzimuth((_shot$frontsightAzimu = shot.frontsightAzimuth) === null || _shot$frontsightAzimu === void 0 ? void 0 : _shot$frontsightAzimu.get(azimuthUnit)), formatAzimuth((_shot$backsightAzimut = shot.backsightAzimuth) === null || _shot$backsightAzimut === void 0 ? void 0 : _shot$backsightAzimut.get(azimuthUnit)), shot.kind === _FrcsShot.FrcsShotKind.Normal ? formatInclination((_shot$frontsightIncli = shot.frontsightInclination) === null || _shot$frontsightIncli === void 0 ? void 0 : _shot$frontsightIncli.get(inclinationUnit)) : formatVerticalDistance((_shot$verticalDistanc = shot.verticalDistance) === null || _shot$verticalDistanc === void 0 ? void 0 : _shot$verticalDistanc.get(distanceUnit)), shot.kind === _FrcsShot.FrcsShotKind.Normal ? formatInclination((_shot$backsightInclin = shot.backsightInclination) === null || _shot$backsightInclin === void 0 ? void 0 : _shot$backsightInclin.get(inclinationUnit)) : EMPTY_INCLINATION, formatLrud((_shot$toLruds = shot.toLruds) === null || _shot$toLruds === void 0 ? void 0 : (_shot$toLruds$left = _shot$toLruds.left) === null || _shot$toLruds$left === void 0 ? void 0 : _shot$toLruds$left.get(distanceUnit)), formatLrud((_shot$toLruds2 = shot.toLruds) === null || _shot$toLruds2 === void 0 ? void 0 : (_shot$toLruds2$right = _shot$toLruds2.right) === null || _shot$toLruds2$right === void 0 ? void 0 : _shot$toLruds2$right.get(distanceUnit)), formatLrud((_shot$toLruds3 = shot.toLruds) === null || _shot$toLruds3 === void 0 ? void 0 : (_shot$toLruds3$up = _shot$toLruds3.up) === null || _shot$toLruds3$up === void 0 ? void 0 : _shot$toLruds3$up.get(distanceUnit)), formatLrud((_shot$toLruds4 = shot.toLruds) === null || _shot$toLruds4 === void 0 ? void 0 : (_shot$toLruds4$down = _shot$toLruds4.down) === null || _shot$toLruds4$down === void 0 ? void 0 : _shot$toLruds4$down.get(distanceUnit))].join('');
+}

package/formatFrcsShot.spec.js

@@ -0,0 +1,139 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _mocha = require("mocha");
+var _chai = require("chai");
+var _formatFrcsShot = _interopRequireDefault(require("./formatFrcsShot"));
+var _unitized = require("@speleotica/unitized");
+var _FrcsShot = require("./FrcsShot");
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+(0, _mocha.describe)("formatFrcsShot", function () {
+  var defaultHeader = {
+    name: 'Foo',
+    distanceUnit: _unitized.Length.feet,
+    azimuthUnit: _unitized.Angle.degrees,
+    inclinationUnit: _unitized.Angle.degrees,
+    backsightAzimuthCorrected: true,
+    backsightInclinationCorrected: true
+  };
+  function testCase(desc, shot, expected) {
+    var header = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : defaultHeader;
+    (0, _mocha.it)(desc, function () {
+      (0, _chai.expect)((0, _formatFrcsShot["default"])(shot, header)).to.equal(expected);
+    });
+  }
+  testCase('normal shot', {
+    kind: _FrcsShot.FrcsShotKind.Normal,
+    to: 'PDF28',
+    from: 'PDF27',
+    distance: _unitized.Unitize.feet(31.7),
+    frontsightAzimuth: _unitized.Unitize.degrees(174.3),
+    backsightAzimuth: _unitized.Unitize.degrees(174.1),
+    frontsightInclination: _unitized.Unitize.degrees(-1.2),
+    backsightInclination: _unitized.Unitize.degrees(-1.6),
+    toLruds: {
+      left: _unitized.Unitize.feet(2),
+      right: _unitized.Unitize.feet(3),
+      up: _unitized.Unitize.feet(0.5),
+      down: _unitized.Unitize.feet(1.5)
+    }
+  }, 'PDF28PDF27  31.7   174.3 174.1 -1.2 -1.6  2  30.51.5');
+  testCase('excluded shot', {
+    kind: _FrcsShot.FrcsShotKind.Normal,
+    to: 'PDF28',
+    from: 'PDF27',
+    distance: _unitized.Unitize.feet(31.7),
+    excludeDistance: true,
+    frontsightAzimuth: _unitized.Unitize.degrees(174.3),
+    backsightAzimuth: _unitized.Unitize.degrees(174.1),
+    frontsightInclination: _unitized.Unitize.degrees(-1.2),
+    backsightInclination: _unitized.Unitize.degrees(-1.6),
+    toLruds: {
+      left: _unitized.Unitize.feet(2),
+      right: _unitized.Unitize.feet(3),
+      up: _unitized.Unitize.feet(0.5),
+      down: _unitized.Unitize.feet(1.5)
+    }
+  }, 'PDF28PDF27  31.7 * 174.3 174.1 -1.2 -1.6  2  30.51.5');
+  testCase('excluded horizontal shot', {
+    kind: _FrcsShot.FrcsShotKind.Horizontal,
+    to: 'PDF28',
+    from: 'PDF27',
+    distance: null,
+    horizontalDistance: _unitized.Unitize.feet(31.7),
+    verticalDistance: _unitized.Unitize.feet(5),
+    excludeDistance: true,
+    frontsightAzimuth: _unitized.Unitize.degrees(174.3),
+    backsightAzimuth: _unitized.Unitize.degrees(174.1),
+    toLruds: {
+      left: _unitized.Unitize.feet(2),
+      right: _unitized.Unitize.feet(3),
+      up: _unitized.Unitize.feet(0.5),
+      down: _unitized.Unitize.feet(1.5)
+    }
+  }, 'PDF28PDF27  31.7H* 174.3 174.1    5       2  30.51.5');
+  testCase('excluded diagonal shot', {
+    kind: _FrcsShot.FrcsShotKind.Diagonal,
+    to: 'PDF28',
+    from: 'PDF27',
+    distance: _unitized.Unitize.feet(31.7),
+    verticalDistance: _unitized.Unitize.feet(5),
+    excludeDistance: true,
+    frontsightAzimuth: _unitized.Unitize.degrees(174.3),
+    backsightAzimuth: _unitized.Unitize.degrees(174.1),
+    toLruds: {
+      left: _unitized.Unitize.feet(2),
+      right: _unitized.Unitize.feet(3),
+      up: _unitized.Unitize.feet(0.5),
+      down: _unitized.Unitize.feet(1.5)
+    }
+  }, 'PDF28PDF27  31.7D* 174.3 174.1    5       2  30.51.5');
+  testCase('horizontal feet and inches shot', {
+    to: 'A27',
+    from: 'A26',
+    kind: _FrcsShot.FrcsShotKind.Horizontal,
+    distance: null,
+    horizontalDistance: _unitized.Unitize.inches(16 * 12 + 9.6),
+    frontsightAzimuth: _unitized.Unitize.degrees(345),
+    backsightAzimuth: _unitized.Unitize.degrees(163),
+    verticalDistance: _unitized.Unitize.feet(-1),
+    toLruds: {
+      left: _unitized.Unitize.feet(0),
+      right: _unitized.Unitize.feet(3),
+      up: _unitized.Unitize.feet(5),
+      down: _unitized.Unitize.feet(4)
+    }
+  }, '  A27  A26  16 10H   345   163   -1       0  3  5  4', _objectSpread(_objectSpread({}, defaultHeader), {}, {
+    distanceUnit: _unitized.Length.inches
+  }));
+  testCase('diagonal feet and inches shot', {
+    to: 'A27',
+    from: 'A26',
+    kind: _FrcsShot.FrcsShotKind.Diagonal,
+    distance: _unitized.Unitize.inches(16 * 12 + 9.6),
+    frontsightAzimuth: _unitized.Unitize.degrees(345),
+    backsightAzimuth: _unitized.Unitize.degrees(163),
+    verticalDistance: _unitized.Unitize.feet(-1),
+    toLruds: {
+      left: _unitized.Unitize.feet(0),
+      right: _unitized.Unitize.feet(3),
+      up: _unitized.Unitize.feet(5),
+      down: _unitized.Unitize.feet(4)
+    }
+  }, '  A27  A26  16 10D   345   163   -1       0  3  5  4', _objectSpread(_objectSpread({}, defaultHeader), {}, {
+    distanceUnit: _unitized.Length.inches
+  }));
+  testCase('lrud-only shot', {
+    kind: _FrcsShot.FrcsShotKind.Normal,
+    from: 'A27',
+    distance: null,
+    fromLruds: {
+      left: _unitized.Unitize.feet(0),
+      right: _unitized.Unitize.feet(3),
+      up: _unitized.Unitize.feet(5),
+      down: _unitized.Unitize.feet(4)
+    }
+  }, '  A27                                     0  3  5  4');
+});

package/index.d.ts

@@ -8,4 +8,5 @@ import parseFrcsPlotFile from './parseFrcsPlotFile';
 import { FrcsTripSummary } from './FrcsTripSummary';
 import { FrcsTripSummaryFile } from './FrcsTripSummaryFile';
 import parseFrcsTripSummaryFile from './parseFrcsTripSummaryFile';
-export { FrcsShot, FrcsShotKind, FrcsSurveyFile, FrcsTrip, FrcsTripHeader, parseFrcsSurveyFile, FrcsPlotShot, FrcsPlotFile, parseFrcsPlotFile, FrcsTripSummary, FrcsTripSummaryFile, parseFrcsTripSummaryFile, };
+import formatFrcsShot from './formatFrcsShot';
+export { FrcsShot, FrcsShotKind, FrcsSurveyFile, FrcsTrip, FrcsTripHeader, parseFrcsSurveyFile, FrcsPlotShot, FrcsPlotFile, parseFrcsPlotFile, FrcsTripSummary, FrcsTripSummaryFile, parseFrcsTripSummaryFile, formatFrcsShot, };

package/index.js

@@ -1,20 +1,19 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-Object.defineProperty(exports, "FrcsTrip", {
+Object.defineProperty(exports, "FrcsPlotFile", {
   enumerable: true,
   get: function get() {
-    return _FrcsTrip.FrcsTrip;
+    return _FrcsPlotFile.FrcsPlotFile;
   }
 });
-Object.defineProperty(exports, "FrcsTripHeader", {
+Object.defineProperty(exports, "FrcsPlotShot", {
   enumerable: true,
   get: function get() {
-    return _FrcsTrip.FrcsTripHeader;
+    return _FrcsPlotShot.FrcsPlotShot;
   }
 });
 Object.defineProperty(exports, "FrcsShot", {
@@ -35,40 +34,46 @@ Object.defineProperty(exports, "FrcsSurveyFile", {
     return _FrcsSurveyFile.FrcsSurveyFile;
   }
 });
-Object.defineProperty(exports, "parseFrcsSurveyFile", {
+Object.defineProperty(exports, "FrcsTrip", {
   enumerable: true,
   get: function get() {
-    return _parseFrcsSurveyFile["default"];
+    return _FrcsTrip.FrcsTrip;
   }
 });
-Object.defineProperty(exports, "FrcsPlotShot", {
+Object.defineProperty(exports, "FrcsTripHeader", {
   enumerable: true,
   get: function get() {
-    return _FrcsPlotShot.FrcsPlotShot;
+    return _FrcsTrip.FrcsTripHeader;
   }
 });
-Object.defineProperty(exports, "FrcsPlotFile", {
+Object.defineProperty(exports, "FrcsTripSummary", {
   enumerable: true,
   get: function get() {
-    return _FrcsPlotFile.FrcsPlotFile;
+    return _FrcsTripSummary.FrcsTripSummary;
   }
 });
-Object.defineProperty(exports, "parseFrcsPlotFile", {
+Object.defineProperty(exports, "FrcsTripSummaryFile", {
   enumerable: true,
   get: function get() {
-    return _parseFrcsPlotFile["default"];
+    return _FrcsTripSummaryFile.FrcsTripSummaryFile;
   }
 });
-Object.defineProperty(exports, "FrcsTripSummary", {
+Object.defineProperty(exports, "formatFrcsShot", {
   enumerable: true,
   get: function get() {
-    return _FrcsTripSummary.FrcsTripSummary;
+    return _formatFrcsShot["default"];
   }
 });
-Object.defineProperty(exports, "FrcsTripSummaryFile", {
+Object.defineProperty(exports, "parseFrcsPlotFile", {
   enumerable: true,
   get: function get() {
-    return _FrcsTripSummaryFile.FrcsTripSummaryFile;
+    return _parseFrcsPlotFile["default"];
+  }
+});
+Object.defineProperty(exports, "parseFrcsSurveyFile", {
+  enumerable: true,
+  get: function get() {
+    return _parseFrcsSurveyFile["default"];
   }
 });
 Object.defineProperty(exports, "parseFrcsTripSummaryFile", {
@@ -77,23 +82,14 @@ Object.defineProperty(exports, "parseFrcsTripSummaryFile", {
     return _parseFrcsTripSummaryFile["default"];
   }
 });
-
 var _FrcsTrip = require("./FrcsTrip");
-
 var _FrcsShot = require("./FrcsShot");
-
 var _FrcsSurveyFile = require("./FrcsSurveyFile");
-
 var _parseFrcsSurveyFile = _interopRequireDefault(require("./parseFrcsSurveyFile"));
-
 var _FrcsPlotShot = require("./FrcsPlotShot");
-
 var _FrcsPlotFile = require("./FrcsPlotFile");
-
 var _parseFrcsPlotFile = _interopRequireDefault(require("./parseFrcsPlotFile"));
-
 var _FrcsTripSummary = require("./FrcsTripSummary");
-
 var _FrcsTripSummaryFile = require("./FrcsTripSummaryFile");
-
-var _parseFrcsTripSummaryFile = _interopRequireDefault(require("./parseFrcsTripSummaryFile"));
+var _parseFrcsTripSummaryFile = _interopRequireDefault(require("./parseFrcsTripSummaryFile"));
+var _formatFrcsShot = _interopRequireDefault(require("./formatFrcsShot"));

package/node/index.js

@@ -1,28 +1,20 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.parseFrcsTripSummaryFile = exports.parseFrcsPlotFile = exports.parseFrcsSurveyFile = void 0;
-
+exports.parseFrcsTripSummaryFile = exports.parseFrcsSurveyFile = exports.parseFrcsPlotFile = void 0;
 var _fs = _interopRequireDefault(require("fs"));
-
 var _readline = _interopRequireDefault(require("readline"));
-
 var _parseFrcsSurveyFile2 = _interopRequireDefault(require("../parseFrcsSurveyFile"));
-
 var _parseFrcsPlotFile2 = _interopRequireDefault(require("../parseFrcsPlotFile"));
-
 var _parseFrcsTripSummaryFile2 = _interopRequireDefault(require("../parseFrcsTripSummaryFile"));
-
 var convert = function convert(fn) {
   return function (file) {
     return fn(file, _readline["default"].createInterface(_fs["default"].createReadStream(file)));
   };
 };
-
 var parseFrcsSurveyFile = convert(_parseFrcsSurveyFile2["default"]);
 exports.parseFrcsSurveyFile = parseFrcsSurveyFile;
 var parseFrcsPlotFile = convert(_parseFrcsPlotFile2["default"]);