vis-chronicle 1.2.4 → 1.3.5

package/README.md

@@ -95,8 +95,6 @@ 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.2.4",
+  "version": "1.3.5",
   "description": "Generates JSON for populating a vis.js timeline from Wikidata queries.",
   "keywords": [
     "wikidata",

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.
 
@@ -112,7 +112,6 @@ entryPoint()
 		var templateItem = wikidata.inputSpec.items[i]
 		if (templateItem.itemQuery || templateItem.items)
 		{
-			//TODO: caching for item queries
 			wikidata.inputSpec.items.splice(i, 1)
 			const newItems = await wikidata.createTemplateItems(templateItem)
 			for (const newItem of newItems)
@@ -200,8 +199,16 @@ entryPoint()
 	{
 		if (item.finished) continue
 
-		if (item.startPath) pathQueries.push(item.startPath)
-		if (item.endPath) pathQueries.push(item.endPath)
+		if (item.startPath)
+		{
+			item.startPath = wikidata.replaceQueryWildcards(item.startPath, item)
+			pathQueries.push(item.startPath)
+		}
+		if (item.endPath)
+		{
+			item.endPath = wikidata.replaceQueryWildcards(item.endPath, item)
+			pathQueries.push(item.endPath)
+		}
 
 		// the bundle key is the queries, as well as any wildcard parameters
 		const keyObject = {}
@@ -368,8 +375,11 @@ entryPoint()
 			if (startTime)
 			{
 				const range = wikidataToRange(startTime)
-				item.start_min = range.min
-				item.start_max = range.max
+				if (range)
+				{
+					item.start_min = range.min
+					item.start_max = range.max
+				}
 			}
 			else
 				console.error(`Date for '${item.startPath}' wasn't cached.`)
@@ -380,8 +390,11 @@ entryPoint()
 			if (endTime)
 			{
 				const range = wikidataToRange(endTime)
-				item.end_min = range.min
-				item.end_max = range.max
+				if (range)
+				{
+					item.end_min = range.min
+					item.end_max = range.max
+				}
 			}
 			else
 				console.error(`Date for '${item.endPath}' wasn't cached.`)

package/src/index.js

@@ -3,5 +3,5 @@ module.exports = {
 
 	SparqlBuilder: require('./sparql-builder'),
 	Wikidata: require('./wikidata.js'),
-	flattenRelativeDate: require('./relativeDates.js')
 }
+module.exports = Object.assign(module.exports, require('./relativeDates.js'))

package/src/relativeDates.js

@@ -24,54 +24,61 @@ function durationToWikidataPrecision(duration)
 	else return 9
 }
 
-// Flattens a relative date string into a hard date string
-module.exports = function flattenRelativeDate(wikidataCache, dateString)
+/**
+ * Breaks down a relative date path into its components.
+ * @param {*} dateString 
+ * @returns An array of strings, or null.
+ */
+function breakRelativeDate(dateString)
 {
 	if (dateString == '') return null
 
 	// parse out relative date components
-	var relSplit
 	var match = dateString.match(wikidata.pathQueryRegex)
-	if (match)
-	{
-		relSplit = match.slice(1)
-	}
-	else
+	if (!match)
 	{
 		console.error(`Failed to parse relative date '${dateString}'.`)
 		return null
 	}
 
-	if (!relSplit[0])
+	const dateComponents = [ match[1] ]
+	var opStartIndex = 0
+	const operatorString = match[2]
+	if (operatorString.length > 0)
+	{
+		for (var i = 1; i < operatorString.length; i++)
+		{
+			if (operatorString[i] == '+' || operatorString[i] == '>')
+			{
+				dateComponents.push(operatorString.substring(opStartIndex, i))
+				opStartIndex = i
+			}
+		}
+		dateComponents.push(operatorString.substring(opStartIndex, i))
+	}
+	return dateComponents
+}
+
+// Flattens a relative date string into a hard date string
+function flattenRelativeDate(wikidataCache, dateString)
+{
+	var parsedPath = breakRelativeDate(dateString)
+	if (!parsedPath)
 	{
 		return null
 	}
-	else if (!wikidataCache[relSplit[0]])
+	else if (!wikidataCache[parsedPath[0]])
 	{
-		console.error(`Date for '${relSplit[0]}' wasn't cached.`)
+		console.error(`Date for '${parsedPath[0]}' wasn't cached.`)
 		return null
 	}
 	else
 	{
-		const cacheEntry = wikidataCache[relSplit[0]]
-		if (relSplit.length > 1)
+		const cacheEntry = wikidataCache[parsedPath[0]]
+		if (cacheEntry.value && parsedPath.length > 1)
 		{
 			// break up operators
-			const dateOperators = []
-			var opStartIndex = 0
-			const operatorString = relSplit[1]
-			if (operatorString.length > 0)
-			{
-				for (var i = 1; i < operatorString.length; i++)
-				{
-					if (operatorString[i] == '+' || operatorString[i] == '>')
-					{
-						dateOperators.push(operatorString.substring(opStartIndex, i))
-						opStartIndex = i
-					}
-				}
-				dateOperators.push(operatorString.substring(opStartIndex, i))
-			}
+			const dateOperators = parsedPath.slice(1)
 
 			// handle relative segments of date
 			// About precision:
@@ -136,7 +143,7 @@ module.exports = function flattenRelativeDate(wikidataCache, dateString)
 					}
 					else
 					{
-						console.error(`Cannot advance/'>' to '${componentVal}'.`)
+						console.error(`Cannot advance/'>' to '${component.substring(1)}'.`)
 					}
 				}
 				else
@@ -156,4 +163,6 @@ module.exports = function flattenRelativeDate(wikidataCache, dateString)
 			return {...cacheEntry}
 		}
 	}
-}
+}
+
+module.exports = { breakRelativeDate, flattenRelativeDate }

package/src/render.js

@@ -461,7 +461,12 @@ renderer.produceOutput = function(inputSpec, items)
 		{
 			const labelItem = {...outputItem}
 			labelItem.id += "-label"
-			labelItem.className = [labelItem.className, "visc-toplabel"].join(' '),
+
+			var classes = labelItem.className.split(' ')
+			classes = classes.filter(c => c != "visc-left-connection" && c != "visc-right-connection")
+			classes.push("visc-toplabel")
+			labelItem.className = classes.join(' ')
+
 			outputObject.items.push(labelItem)
 			outputItem.content = outputItem.content ? " " : ""
 		}

package/src/wikidata.js

@@ -12,9 +12,9 @@ const wikidata = module.exports = {
 	verboseLogging: false,
 
 	/**
-	 * 
+	 * Caches results for SPARQL queries, using the query string as the key.
 	 */
-	cache: {},
+	queryCache: {},
 
 	/**
 	 * Caches results for path queries, using the path as the key.
@@ -25,9 +25,9 @@ const wikidata = module.exports = {
 	cacheBuster: undefined,
 
 	/**
-	 * Relative path to the term cache file.
+	 * Relative path to the query cache file.
 	 */
-	termCacheFile: "intermediate/wikidata-term-cache.json",
+	queryCacheFile: "intermediate/sparql-query-cache.json",
 
 	/**
 	 * Relative path to the path cache file.
@@ -126,8 +126,8 @@ const wikidata = module.exports = {
 	{
 		try
 		{
-			const contents = await fs.promises.readFile(this.termCacheFile)
-			this.cache = JSON.parse(contents)
+			const contents = await fs.promises.readFile(this.queryCacheFile)
+			this.queryCache = JSON.parse(contents)
 		}
 		catch
 		{
@@ -147,11 +147,11 @@ const wikidata = module.exports = {
 
 	writeCache: async function()
 	{
-		await mypath.ensureDirectoryForFile(this.termCacheFile)
+		await mypath.ensureDirectoryForFile(this.queryCacheFile)
 
-		fs.writeFile(this.termCacheFile, JSON.stringify(this.cache), err => {
+		fs.writeFile(this.queryCacheFile, JSON.stringify(this.queryCache), err => {
 			if (err) {
-				console.error(`Error writing wikidata term cache:`)
+				console.error(`Error writing wikidata query cache:`)
 				console.error(err)
 			}
 		})
@@ -184,25 +184,32 @@ const wikidata = module.exports = {
 		}
 	},
 
-	postprocessQueryTerm: function(context, term, item)
+	replaceQueryWildcards: function(term, item, itemPrefix = "")
 	{
-		if (!term)
-		{
-			return term;
-		}
-
 		// replace query wildcards
 		for (const key in item)
 		{
 			var insertValue = item[key]
 			if (typeof insertValue === "string" && insertValue.startsWith("Q"))
-				insertValue = "wd:" + insertValue
+				insertValue = itemPrefix + insertValue
 			term = term.replaceAll(`{${key}}`, insertValue)
 		}
 
 		// detect unreplaced wildcards
 		//TODO:
 
+		return term
+	},
+
+	preprocessQueryTerm: function(context, term, item)
+	{
+		if (!term)
+		{
+			return term
+		}
+
+		term = this.replaceQueryWildcards(term, item, "wd:")
+
 		// terminate term
 		if (!term.trim().endsWith("."))
 		{
@@ -238,7 +245,7 @@ const wikidata = module.exports = {
 
 		//TODO: validate query has required wildcards
 		
-		queryTerm = this.postprocessQueryTerm(inQueryTerm, queryTerm, item)
+		queryTerm = this.preprocessQueryTerm(inQueryTerm, queryTerm, item)
 		return queryTerm
 	},
 
@@ -275,7 +282,7 @@ const wikidata = module.exports = {
 		if (typeof queryTerm === 'string' || queryTerm instanceof String)
 		{
 			return {
-				value: this.postprocessQueryTerm(inQueryTerm, queryTerm, item),
+				value: this.preprocessQueryTerm(inQueryTerm, queryTerm, item),
 				min: "?_prop pqv:P1319 ?_min_value.",
 				max: "?_prop pqv:P1326 ?_max_value."
 			}
@@ -285,7 +292,7 @@ const wikidata = module.exports = {
 			const result = {}
 			for (const key in queryTerm)
 			{
-				result[key] = this.postprocessQueryTerm(inQueryTerm, queryTerm[key], item)
+				result[key] = this.preprocessQueryTerm(inQueryTerm, queryTerm[key], item)
 			}
 			return result
 		}
@@ -393,15 +400,7 @@ const wikidata = module.exports = {
 		queryBuilder.addOptionalQueryTerm(`${propVar} wikibase:rank ${rankVar}.`)
 
 		const query = queryBuilder.build()
-
-		// read cache
-		const cacheKey = query
-		if (!this.skipCache && !item.skipCache && this.cache[cacheKey])
-		{
-			return this.cache[cacheKey]
-		}
-		
-		const data = await this.runQuery(query)
+		const data = await this.runQuery(query, item.skipCache)
 		console.log(`\tQuery for ${item.id} returned ${data.results.bindings.length} results.`)
 
 		const readBinding = function(binding)
@@ -487,7 +486,6 @@ const wikidata = module.exports = {
 			}
 		}
 
-		this.cache[cacheKey] = result;
 		return result;
 	},
 
@@ -695,7 +693,11 @@ const wikidata = module.exports = {
 		queryBuilder.addWikibaseLabel(this.lang)
 		
 		const query = queryBuilder.build()
-		const data = await this.runQuery(query)
+		const data = await this.runQuery(query, templateItem.skipCache)
+		if (!data)
+		{
+			throw 'No response data from Wikidata query.'
+		}
 
 		const newItems = []
 
@@ -723,8 +725,13 @@ const wikidata = module.exports = {
 	},
 
 	// runs a SPARQL query
-	runQuery: async function(query)
+	runQuery: async function(query, skipCache = false)
 	{
+		if (!skipCache && !this.skipCache && this.queryCache[query])
+		{
+			return this.queryCache[query]
+		}
+
 		if (this.verboseLogging) console.log(query)
 
 		assert(this.options)
@@ -739,6 +746,7 @@ const wikidata = module.exports = {
 		else
 		{
 			const data = await response.json()
+			this.queryCache[query] = data
 			return data
 		}
 	}