vis-chronicle 1.1.0 → 1.2.0

package/README.md

@@ -95,6 +95,8 @@ Item properties:
     * `general`: General query segment, usually for selecting the item and property.
 	* `start`: Query segment for selecting the start value.
 	* `end`: Query segment for selecting the end value.
+* `startPath`: Another way of writing Wikidata queries. TODO.
+* `endPath`: See `startPath`
 * `expectedDuration`: Describes the expected duration, for hinting if the start or end is missing.
     * `min`: The absolute minimum duration.
 	* `max`: The absolute maximum duration.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vis-chronicle",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Generates JSON for populating a vis.js timeline from Wikidata queries.",
   "keywords": [
     "wikidata",
@@ -18,7 +18,8 @@
   },
   "exports": {
     "./styles/style.css": "./styles/style.css",
-    ".": "./src/index.js"
+    ".": "./src/index.js",
+	"./wikidataToRange.js": "./src/wikidataToRange.js"
   },
   "scripts": {},
   "author": {

package/src/fetch.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 // Uses an input specification file to produce an output file for vis.js Timeline.
 
@@ -43,6 +43,12 @@ const wikidata = require('./wikidata.js')
 const renderer = require('./render.js')
 const mypath = require("./mypath.js");
 const { flattenRelativeDate } = require('./index.js');
+const wikidataToRange2 = require('./wikidataToRange.js')
+
+function wikidataToRange(param)
+{
+	return wikidataToRange2(param, wikidata.inputSpec.chronicle.maxUncertainTimePrecision)
+}
 
 wikidata.skipCache = values["skip-wd-cache"]
 wikidata.cacheBuster = values["cachebuster"]
@@ -51,55 +57,6 @@ wikidata.verboseLogging = values["verbose"]
 wikidata.setLang(values["lang"])
 wikidata.initialize()
 
-const wikidataToMomentPrecision = [
-	undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined,
-	'year', 'month', 'day', 'hour', 'minute', 'second'
-]
-
-// produces a range of moments {min,max} from a Wikidata time
-function wikidataToRange(inTime)
-{
-	if (!inTime || !inTime.value)
-	{
-		// missing value
-		return undefined
-	}
-
-	// moment has trouble with negative years unless they're six digits
-	const date = moment(inTime.value, 'YYYYYY-MM-DDThh:mm:ss')
-
-	switch (inTime.precision)
-	{
-		case 0: case 1: case 2: case 3: case 4: case 5: case 6: case 7: case 8:
-			const yearBase = Math.pow(10, 9 - inTime.precision)
-			var roundedYear = Math.floor(date.year() / yearBase) * yearBase
-
-			// correct for lack of year 0 ("-19" is actually "-20 BC")
-			// and also for the fact that "-20 BC" is really on the positive side of e.g. -18
-			if (date.year() < 0) roundedYear += 2
-
-			return {
-				min: moment({year:roundedYear}),
-				max: moment({year:roundedYear + yearBase}).subtract(1, 'minute').endOf('year')
-			}
-		default:
-			if (inTime.precision > wikidata.inputSpec.chronicle.maxUncertainTimePrecision)
-			{
-				const momentPrecision = wikidataToMomentPrecision[inTime.precision]
-				return { min: date.clone().startOf(momentPrecision), max: date.clone().startOf(momentPrecision) }
-			}
-			else if (inTime.precision < wikidataToMomentPrecision.length)
-			{
-				const momentPrecision = wikidataToMomentPrecision[inTime.precision]
-				return { min: date.clone().startOf(momentPrecision), max: date.clone().endOf(momentPrecision) }
-			}
-			else
-			{
-				throw `Unrecognized date precision ${inTime.precision}`
-			}
-	}
-}
-
 function rangeUnionAdv(value, min, max)
 {
 	var aggregate = {}

package/src/wikidataToRange.js

@@ -0,0 +1,58 @@
+
+const moment = require('moment')
+
+const wikidataToMomentPrecision = [
+	undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined,
+	'year', 'month', 'day', 'hour', 'minute', 'second'
+]
+
+/**
+ * Produces a range of moments from a Wikidata time.
+ * @param {*} inTime {value,precision}
+ * @param {*} maxUncertainPrecision Max Wikidata precision to treat as uncertain.
+ * @returns {*} {min,max}
+ */
+module.exports = function wikidataToRange(inTime, maxUncertainPrecision)
+{
+	if (!inTime || !inTime.value)
+	{
+		// missing value
+		return undefined
+	}
+
+	if (maxUncertainPrecision === undefined) maxUncertainPrecision = 10
+
+	// moment has trouble with negative years unless they're six digits
+	const date = moment(inTime.value, 'YYYYYY-MM-DDThh:mm:ss')
+
+	switch (inTime.precision)
+	{
+		case 0: case 1: case 2: case 3: case 4: case 5: case 6: case 7: case 8:
+			const yearBase = Math.pow(10, 9 - inTime.precision)
+			var roundedYear = Math.floor(date.year() / yearBase) * yearBase
+
+			// correct for lack of year 0 ("-19" is actually "-20 BC")
+			// and also for the fact that "-20 BC" is really on the positive side of e.g. -18
+			if (date.year() < 0) roundedYear += 2
+
+			return {
+				min: moment({year:roundedYear}),
+				max: moment({year:roundedYear + yearBase}).subtract(1, 'minute').endOf('year')
+			}
+		default:
+			if (inTime.precision > maxUncertainPrecision)
+			{
+				const momentPrecision = wikidataToMomentPrecision[inTime.precision]
+				return { min: date.clone().startOf(momentPrecision), max: date.clone().startOf(momentPrecision) }
+			}
+			else if (inTime.precision < wikidataToMomentPrecision.length)
+			{
+				const momentPrecision = wikidataToMomentPrecision[inTime.precision]
+				return { min: date.clone().startOf(momentPrecision), max: date.clone().endOf(momentPrecision) }
+			}
+			else
+			{
+				throw `Unrecognized date precision ${inTime.precision}`
+			}
+	}
+}