@rasifix/orienteering-utils 1.0.6 → 2.0.1

package/package.json

@@ -1,11 +1,16 @@
 {
   "name": "@rasifix/orienteering-utils",
-  "version": "1.0.6",
+  "version": "2.0.1",
   "description": "utility functions for orienteering result analyzis",
-  "main": "index",
-  "typings": "index",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib/**/*.js",
+    "lib/**/*.d.ts"
+  ],
   "scripts": {
-    "test": "mocha test/test.js"
+    "test": "mocha test/test.js",
+    "build": "tsc"
   },
   "keywords": [
     "orienteering"
@@ -19,5 +24,12 @@
   "dependencies": {
     "chai": "^4.3.6",
     "mocha": "^9.2.1"
+  },
+  "devDependencies": {
+    "@types/chai": "^5.2.3",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^16.0.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^4.5.5"
   }
 }

package/index.d.ts

@@ -1,4 +0,0 @@
-export declare const oware;
-export declare const kraemer;
-export declare const solv;
-export declare const time;

package/index.js

@@ -1,11 +0,0 @@
-const oware = require('./lib/oware');
-const kraemer = require('./lib/kraemer');
-const solv = require('./lib/solv');
-const time = require('./lib/time');
-
-module.exports = {
-    oware: oware,
-    kraemer: kraemer,
-    solv: solv,
-    time: time
-};

package/lib/anonymizer.js

@@ -1,72 +0,0 @@
-const names = [
-    'Gustavson', 'Hendrikson', 'Meyer', 'Marlovic', 'Torres', 'Huber',
-    'Wüst', 'Zürcher', 'Berner', 'Rufer', 'Gutmann', 'Hübscher',
-    'Schneller', 'Widemar', 'Rohrer', 'Kunz', 'Kinzle', 'Steinle',
-    'Allemann', 'Röhrig', 'Meyer', 'Uhlmann', 'Garaio', 'Regazoni',
-    'Maudet', 'Zoja'
-];
-
-const firstNames = {
-    f: [
-        'Anna', 'Alia', 'Ava', 'Berta', 'Benita', 'Carla', 'Cloe',
-        'Dina', 'Daria', 'Eva', 'Esther', 'Elin', 'Franca', 'Franziska',
-        'Gaby', 'Gerta', 'Gudrun', 'Hanna', 'Isabel', 'Ilda', 'Kim', 'Kathrin',
-        'Lia', 'Lisa', 'Lena', 'Liselotte', 'Lara', 'Mia', 'Marla', 'Nele', 'Olga',
-        'Pia', 'Rahel', 'Sara', 'Simona', 'Sina', 'Siri', 'Xenia', 'Zoé'
-    ],
-    m: [
-        'Albert', 'Bruno', 'Chris', 'Dirk', 'David', 'Erwin', 'Francesco',
-        'Fritz', 'Gianni', 'Gustav', 'Hans', 'Ian', 'Jan', 'Karl', 'Lars',
-        'Martin', 'Marco', 'Markus', 'Nico', 'Nino', 'Otto', 'Olav',
-        'Patric', 'Pablo', 'Quentin', 'Ralf', 'Rudolf', 'Simon', 'Steve',
-        'Thomas', 'Tim', 'Urs', 'Udo'
-    ]
-};
-
-const cities = [
-    'Aarberg', 'Bern', 'Colombier', 'Diemerswil', 'Elm', 'Fribourg',
-    'Goldiwil', 'Heimiswil', 'Illiswil', 'Konolfingen', 'Lausanne',
-    'Lugano', 'Martigny', 'Neuchatel', 'Orbe', 'Zürich'
-];
-
-const clubs = {
-    prefixes: [ 'OLG', 'OLV', 'OL', 'CA' ],
-    names: ['Bernstein', 'Erdmannlistein', 'Blanc', 'Piz Balü', 'Bartli und Most', 'Aare', 'Reuss' ]
-};
-
-function random(arr) {
-    if (arr.lenght === 0) {
-        return null;
-    }
-    const idx = Math.floor(Math.random() * (arr.length - 1));
-    return arr[idx];
-}
-
-function randInt(from, to) {
-    return from + Math.round(Math.random() * (to - from));
-}
-
-module.exports.anonymize = function(event) {
-    event.categories.forEach(category => {
-        category.runners.forEach(runner => {
-            runner.name = random(names);
-
-            if (runner.sex === 'M' || runner.sex === 'm') {
-                runner.firstName = random(firstNames.m);
-                runner.sex = 'M';
-            } else {
-                runner.firstName = random(firstNames.f);
-                runner.sex = 'F';
-            }
-
-            runner.fullName = runner.firstName + ' ' + runner.name;
-
-            runner.city = random(cities);
-            runner.club = random(clubs.prefixes) + ' ' + random(clubs.names);
-            runner.yearOfBirth = randInt(1925, 2010);
-            runner.nation = 'SUI';
-            runner.ecard = Math.round(Math.random() * 1000000);
-        });
-    });
-    return event;
-};

package/lib/butterfly.js

@@ -1,59 +0,0 @@
-function extractCourses(category) {
-    var courses = { };
-    category.runners.forEach(function(runner) {
-        const course = runner.splits.map(function(split, index, splits) {
-            return split.code;
-        });
-        const key = 'St-' + course.join('-');
-        if (!courses[key]) {
-            courses[key] = {
-                runners: [],
-                controls: course.map(function(c) { 
-                    return { code: c };
-                })
-            };
-        }
-        courses[key].runners.push(runner);
-    });
-    const coursesArray = Object.keys(courses).map(function(course) {
-        return courses[course];
-    });
-
-    for (var i = 0; i < coursesArray[0].controls.length; i++) {
-        const base = coursesArray[0].controls[i].code;
-        const shared = coursesArray.every(function(course) {
-            return course.controls[i].code === base;
-        });
-        coursesArray.forEach(function(course) {
-            course.controls[i].shared = shared;
-        });
-    }
-
-    return coursesArray;
-};
-
-module.exports.extractCourses = extractCourses;
-
-/**
- * A category is classified as "fair" if all the runners have the exact same legs, although
- * potentially in different order.
- */
-module.exports.isFair = function(category) {
-    const courses = extractCourses(category);
-    const courseLegs = courses.map(function(course) {
-        const legs = [];
-        for (var i = 0; i < course.controls.length - 1; i++) {
-            const from = course.controls[i].code;
-            const to = course.controls[i + 1].code;
-            legs.push(from + '-' + to);
-        }
-        return legs.sort().join(':');
-    });
-
-    const grouped = { };
-    courseLegs.forEach(function(course) {
-        grouped[course] = true;
-    });
-
-    return Object.keys(grouped).length === 1;
-};

package/lib/kraemer.js

@@ -1,125 +0,0 @@
-var { parseTime, formatTime } = require('./time');
-
-function strip(str) {
-	if (!str) {
-		return '';
-	} else if (str.length > 0 && str[0] === '"') {
-		return str.substring(1, str.length - 1);
-	} else {
-		return str;
-	}
-}
-
-// OE0014;Stnr;XStnr;Chipnr;Datenbank Id;Nachname;Vorname;Jg;G;Block; AK;	Start;Ziel;	 Zeit;		Wertung;Gutschrift -;Zuschlag +;Kommentar;Club-Nr.;Abk; Ort; Nat; Sitz;Region;Katnr;Kurz; Lang;		 MeldeKat. Nr;MeldeKat. (kurz);MeldeKat. (lang);Rang;Ranglistenpunkte;Num1;Num2; Num3;		 Text1;	 Text2;		Text3;	Adr. Nachname;Adr. Vorname;Straße;Zeile2;PLZ;				Adr. Ort;Tel;				 Mobil;			Fax;		EMail;	 Gemietet;Startgeld;Bezahlt;Mannschaft;Bahnnummer;Bahn;	 km;		 Hm;			Bahn Posten;Platz;	 Startstempel;Zielstempel;Posten1;Stempel1;Posten2;Stempel2;Posten3; Stempel3;Posten4;Stempel4;Posten5;Stempel5;Posten6;Stempel6;Posten7;Stempel7;Posten8;Stempel8;Posten9;Stempel9;Posten10;Stempel10;Posten11;Stempel11;Posten12;Stempel12;Posten13;Stempel13;Posten14;Stempel14;Posten15;Stempel15;Posten16;Stempel16;Posten17;Stempel17;Posten18;Stempel18;Posten19;Stempel19;Posten20;Stempel20;Posten21;Stempel21;Posten22;Stempel22;Posten23;Stempel23;Posten24;Stempel24;Posten25;Stempel25;Posten26;Stempel26;Posten27;Stempel27;Posten28;Stempel28;Posten29;Stempel29;Posten30;Stempel30;Posten31;Stempel31;Posten32;Stempel32;Posten33;Stempel33;Posten34;Stempel34;Posten35;Stempel35;Posten36;Stempel36;Posten37;Stempel37;Posten38;Stempel38;Posten39;Stempel39;Posten40;Stempel40;Posten41;Stempel41;Posten42;Stempel42;Posten43;Stempel43;Posten44;Stempel44;Posten45;Stempel45;Posten46;Stempel46;Posten47;Stempel47;Posten48;Stempel48;Posten49;Stempel49;Posten50;Stempel50;Posten51;Stempel51;Posten52;Stempel52;Posten53;Stempel53;Posten54;Stempel54;Posten55;Stempel55;Posten56;Stempel56;Posten57;Stempel57;Posten58;Stempel58;Posten59;Stempel59;Posten60;Stempel60;Posten61;Stempel61;Posten62;Stempel62;Posten63;Stempel63;Posten64;Stempel64;
-// Stnr	;Chip;Datenbank Id;Nachname;Vorname;Jg;G;Block;AK;Start;Ziel;Zeit; Wertung;Club-Nr.;Abk;		Ort;				 Nat;			 Katnr;		Kurz;		Lang;Num1;Num2;Num3;Text1; Text2;Text3;Adr. Name;Straße;			Zeile2;					PLZ;						 Ort; Tel;						 Fax; EMail;Id/Verein;Gemietet;Startgeld;Bezahlt;Bahnnummer;	 Bahn;				km;		Hm;		Bahn Posten;Pl;			Startstempel;Zielstempel;Posten1;Stempel1;Posten2; Stempel2; Posten3;Stempel3;	Posten4;	Stempel4;Posten5;Stempel5;Posten6;		Stempel6;Posten7;		 Stempel7;	 Posten8;Stempel8;Posten9;Stempel9;Posten10;Stempel10;(und weitere)...
-module.exports.parse = function(text, options = {}) {
-    // split text into lines
-    var lines = text.split('[\r\n]+');
-        
-	// extract header
-	var header = lines[0].split(";");
-	var firstTimeIdx;
-    
-    // trying to get hold of correct column indices
-	var indices = { };
-	indices['Nachname'] = header.indexOf('Nachname');
-	indices['Vorname'] = header.indexOf('Vorname');
-	indices['Jg'] = header.indexOf('Jg');
-	indices['G'] = header.indexOf('G');
-	indices['Datenbank Id'] = header.indexOf('Datenbank Id');
-	indices['Abk'] = header.indexOf('Abk');
-	indices['Club'] = header.indexOf('Ort');
-	indices['Ort'] = header.indexOf('Adr. Ort');
-	indices['Nat'] = header.indexOf('Nat');
-	indices['Start'] = header.indexOf('Start');
-	indices['Ziel'] = header.indexOf('Ziel');
-	indices['Zeit'] = header.indexOf('Zeit');
-	indices['Katnr'] = header.indexOf('Kurz');
-	indices['Wertung'] = header.indexOf('Wertung');
-	indices['Posten'] = header.indexOf('Bahn Posten');
-	indices['km'] = header.indexOf('km');
-	indices['hm'] = header.indexOf('Hm');
-	firstTimeIdx = header.indexOf('Posten1');
-	
-	if (header[0] === 'OE0014') {
-		indices['Chip'] = header.indexOf('Chipnr');
-	} else {
-		indices['Chip'] = header.indexOf('Chip');
-	}
-	
-	lines = lines.slice(1);
-	
-	// the result object
-	var categories = { };
-	
-	function objectify(cols) {
-		var result = { };
-		Object.keys(indices).forEach(function(key) {
-			result[key] = cols[indices[key]];
-		});
-		return result;
-	}
-	
-	lines.forEach(function(line) {
-		var cols = line.split(";");
-		var lineObj = objectify(cols);
-		
-		if (lineObj['Wertung'] !== '0') {
-			return;
-		}
-        
-        let runnerName = strip(lineObj['Nachname']);
-        let runnerFirstname = strip(lineObj['Vorname']);
-		var runner = {
-			name: runnerName,
-            firstName: runnerFirstname,
-            fullName: [runnerFirstname, runnerName].join(' '),
-			yearOfBirth: lineObj['Jg'],
-			sex: strip(lineObj['G']),
-			club: (strip(lineObj['Abk']) + ' ' + strip(lineObj['Club'])).trim(),
-			city: strip(lineObj['Ort']),
-			nation: strip(lineObj['Nat']),
-			time: formatTime(parseTime(lineObj['Zeit'])),
-			startTime: formatTime(parseTime(lineObj['Start'])),
-			ecard: strip(lineObj['Chip']),
-			splits: []
-		};
-
-		var category = categories[strip(lineObj['Katnr'])];
-		if (typeof category === 'undefined') {
-			category = {
-				name: strip(lineObj['Katnr']),
-				distance: parseInt(strip(lineObj['km']), 10) * 1000,
-				ascent: strip(lineObj['hm']),
-				controls: strip(lineObj['Posten']),
-				runners: []
-			};
-			categories[category.name] = category;
-		}
-
-		var times = cols.slice(firstTimeIdx);
-		for (var idx = 0; idx < parseInt(lineObj['Posten'], 10) * 2; idx += 2) {
-			if (idx === times.length - 1) {
-				continue;
-			}
-			runner.splits.push([times[idx], formatTime(parseTime(times[idx + 1]))]);
-		}
-		runner.course = runner.splits.map(function(split) { return split[0]; }).join(',');
-
-		category.runners.push(runner);
-	});
-
-	return {
-		name: options.event || 'Anonymous Event',
-		map: options.map || 'Unknown Map',
-		date: date || '',
-		startTime: startTime || '',
-		categories: Object.keys(categories).map(function(category) {
-			return categories[category];
-		})
-	}; 
-};
-
-module.exports.formatCheck = function(text) {
-    return text.substring(0, 6) === 'OE0014' || text.substring(0, 23) === 'Stnr;Chip;Datenbank Id;';
-};

package/lib/oware.js

@@ -1,105 +0,0 @@
-function parseCategory(row) {
-	return {
-		name: row[0],
-		distance: parseInt(row[1], 10),
-		ascent: parseInt(row[2], 10),
-		controls: parseInt(row[3], 10),
-		runners: []
-	};
-}
-
-function parseRunner(row, category, id) {
-	var headerLength = 15;
-	var i;
-
-	var splits = [];
-	for (i = headerLength; i < row.length; i += 2) {
-		splits.push({ 'code': row[i], 'time': row[i + 1] });
-	}
-
-	// split cleanup - detect two following splits with identical time
-	// --> control not working properly; set 's' as split time (substitute)
-	// going from back to front to catch several not working controls
-	for (i = splits.length - 1;	i > 0; i--) {
-		if (splits[i].time === splits[i - 1].time && splits[i].time !== '-') {
-			splits[i].time = 's';
-		}
-	}
-
-	return {
-		id: id,
-		category: category,
-		rank: row[0] ? parseInt(row[0]) : null,
-		name: row[1],
-        firstName: row[2],
-        fullName: [row[2], row[1]].join(' '),
-		yearOfBirth: row[3],
-		sex: row[4],
-		club: row[8],
-		city: row[7],
-		nation: row[9],
-		time: row[12],
-		startTime: row[13],
-		ecard: row[11],
-		splits: splits
-	};
-}
-
-module.exports.parse = function(text) {
-    // split text into lines
-	var lines = text.trim().split(/[\r\n]+/);
-
-	// throw away first row containing headers
-	lines = lines.splice(1);
-
-    // second row contains information about the event
-	var header = lines[0].split(';');
-
-	var event = {
-        // row starts with a double slash
-		name: header[0].substring(2, header[0].length),
-		map: header[1],
-		date: header[2],
-		startTime: header[3],
-		categories: [ ]
-	};
-
-	// throw a way the now parsed header
-	lines = lines.splice(1);
-
-	var category = null;
-
-	let idx = 0;
-	lines.filter(line => line.trim().length > 0).forEach(function(line) {
-		var cols = line.split(';');
-		if (cols.length === 4) {
-			category = parseCategory(cols);
-			event.categories.push(category);
-		} else {
-			category.runners.push(parseRunner(cols, category.name, ++idx));
-		}
-	});
-
-	return event;
-};
-
-module.exports.serialize = function(event) {
-    var result = '//Format: Rank;Name;Firstname;YearOfBirth;SexMF;FedNr;Zip;Town;Club;NationIOF;StartNr;eCardNr;RunTime;StartTime;FinishTime;CtrlCode;SplitTime; ...\n';
-    result += '//' + [event.name, event.map, event.date, event.startTime, ''].join(';') + '\n';
-
-    event.categories.forEach(function(category) {
-        result += [category.name, category.distance, category.ascent, category.controls].join(';') + '\n';
-        category.runners.forEach(function(runner) {
-            result += [runner.rank, runner.name, runner.firstName, runner.yearOfBirth, runner.sex, '', runner.zip, runner.city, runner.club, runner.nation, '', runner.ecard, runner.time, runner.startTime, ''].join(';');
-            result += ';' + runner.splits.map(function(split) {
-                return split.code + ';' + split.time;
-            }).join(';') + '\n';
-        });
-    });
-
-    return result;
-};
-
-module.exports.formatCheck = function(text) {
-    return text.substring(0, 8) === '//Format';
-};