# kgx > Helpful tools for (RDF/Linked Data) Knowledge Graph Exchange and Exploration Latest version **0.2.0** (published 2019-01-03) · MIT license · 0 weekly downloads ## Install ```sh npm install kgx pnpm add kgx yarn add kgx bun add kgx ``` Provides the command `kgx`. ## Health **Score 5/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: insecure dependencies; abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.2.0 | | Published | 2019-01-03 | | First published | 2018-11-13 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 7 | | Unpacked size | 66.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Sandro Hawke | | Maintainers | sandhawke | | Keywords | rdf, linked data, knowledge graph, dataweb, semantic web | ## Links - npm: https://www.npmjs.com/package/kgx - Repository: https://github.com/sandhawke/kgx - Homepage: https://github.com/sandhawke/kgx#readme - Issues: https://github.com/sandhawke/kgx/issues - npm.io page: https://npm.io/package/kgx ## Dependencies (7) - [n3](https://npm.io/package/n3.md) github:sandhawke/N3.js - [debug](https://npm.io/package/debug.md) ^4.1.0 - [moment](https://npm.io/package/moment.md) ^2.22.2 - [cnamify](https://npm.io/package/cnamify.md) ^1.0.0 - [ldfetch](https://npm.io/package/ldfetch.md) ^1.1.1-alpha - [await-mutex](https://npm.io/package/await-mutex.md) ^1.0.2 - [@rdfjs/namespace](https://npm.io/package/@rdfjs/namespace.md) ^1.0.0 ## Alternatives - [d3-force-3d](https://npm.io/package/d3-force-3d.md) — 1.0M weekly downloads - [ng2-charts](https://npm.io/package/ng2-charts.md) — 486.8K weekly downloads - [@arcgis/core](https://npm.io/package/@arcgis/core.md) — 257.8K weekly downloads - [react-sparklines](https://npm.io/package/react-sparklines.md) — 249.3K weekly downloads - [react-native-gifted-charts](https://npm.io/package/react-native-gifted-charts.md) — 182.3K weekly downloads ## Recent versions - 0.2.0 (latest) — 2019-01-03 - 0.1.0 — 2019-01-03 - 0.0.5 — 2018-12-20 - 0.0.4 — 2018-12-20 - 0.0.3 — 2018-11-16 - 0.0.2 — 2018-11-14 - 0.0.1 — 2018-11-13 ## README # kgx - knowledge graph toolkit [![NPM version](https://img.shields.io/npm/v/kgx.svg?style=flat-square)](https://npmjs.org/package/kgx) [![Coverage Status](https://coveralls.io/repos/github/sandhawke/kgx/badge.svg?branch=master)](https://coveralls.io/github/sandhawke/kgx?branch=master) **status: pretty dynamic, still changing the API when I feel like it** ## Motivation Sometimes I work with RDF data. I couldn't find any tools that did all the things I wanted, or generally behaved in a way I found comfortable. So I built this as a place to put the things I kept needing. Biggest things are probably: 1. Synchronous. Yes, async is great, esp with async/await, but you're going to have some of the data in memory, and when you do, things are simpler. Let's build the API around that, and then have a module for synchronizing that in-memory data with the remote data. (Maybe with async iterators now one could make asych stuff look as good. I might try that some day.) 2. Converting to/from JavaScript types. I don't always want to work with graphs, and especially with NamedNodes, Literals, etc, so the API tends to convert freely between "native" representation and RDF representations. 3. Organize the API around quadstores, aka graphstores, aka databases, aka datasets, aka knowledge bases. We call it a "kb" in the code. You make a kb, you add stuff to it, you look at what's in it, you change stuff, you delete stuff, you mirror it to a server somewhere, etc. (It's a "kb" not a "kg" because it can contain many distinct knowledge graphs and their metadata.) 4. We use trig/sparql-like strings in the API. Most API calls are not performance sensitive, and using a nice RDF syntax is much easier than putting together some complex JavaScript expression. ## Example From example [tbl.js](example/tbl.js) ```js const kgx = require('kgx') const kb = kgx.memKB() async function main () { const tbl = kb.named('https://www.w3.org/People/Berners-Lee/card#1') await kb.fetch(tbl) console.log('Got %d triples', [...kb].length) // => Got 87 triples // maybe: for (const q of kb) console.log(kb.quadAsNQ(q)) for (const {title, name} of kb.query('?tbl foaf:title ?title; foaf:name ?name', { bind: {'?tbl': tbl} })) { console.log(title,name) // => Sir Timothy Berners-Lee } } ``` ## API documentation Only parts of the API are currently documented, sorry. See [API Documentation](https://sandhawke.github.io/kgx/api/) ---- ## Thoughts / Plans / Notes From here on out is just a place where I write down idea, maybe when I've built something at a higher level, and am thinking about whether I can make a general version to go in kgx. ---- kgx-server sources... * runs web server to show those sources kgx-view sources... * runs private kgx server and opn the result * or loads it into current instance if there is one? at std port?? kgx-from-{csv|nt|turtle|jsonld|} * web centric, not just parsers * include ldfetch, all-your-base, headless-chrome-crawler, metascraper * include progress and error reporting * include some of the HTML stuff, maybe * so, ever load of a URL results in at least a Fetch (which might be failed) * `FETCHID :fetched NG` gets put into DG * `NG :origin ` * `NG :source ` kgx-to-{...} * as currently in quadsite * shape, format, dateformat, linkformat library: * new kgx.KB() * kb.tablify(shape) returns a kgx.Table() .rows, .headings * kb.filter(f) -> read-only kb * kb.load(src), kb.addSource(src), kb.loader.addSource(src) USE CRAWLER kgx-crawler * separate process from kgx library, kgx server * maybe just reads/writes to local fs * https://www.digitalocean.com/community/tutorials/how-to-install-and-secure-redis-on-debian-9 * https://www.npmjs.com/package/headless-chrome-crawler * https://news.ycombinator.com/item?id=16437082 * https://github.com/brendonboshell/supercrawler + puppeteer * https://www.browserless.io/ --- remote puppeteer ## Following / Crawling (planned) ```js kb.crawl({owlImports: true, predicates: true, classes: true}) kb.crawl(['some url', 'some other url']) ``` How is provenance recorded? 1. only fetch triples, and graph name is source 2. only fetch triples, and graph name is linked to source 3. okay to fetch quads, but .isolate them, then link to source kb.isolate() returns modified kb (or modifies in place? Or just operates on quadlist?) where any NamedNode graph names have been replaced by new BlankNodes, and the default graph is place into a named graph, whose label (another new BlankNode) is returned. isolate() allows multiple datasets to co-exist in one dataset without interacting until/unless we query across graphs. Linking to source is done like: ```trig _:gr332 { _:gr332_1 } _:gr332_1 { } :fetch332 providedDefaultGraph _:gr332; providedGraph _:gr332, _:gr332_1; completed $time; date $time; lastModified $time; fromURL $url . ``` vs ```trig $url { _:gr332_1 } _:gr332_1 { } # optional: :fetch332 providedDefaultGraph _:gr332; providedGraph _:gr332, _:gr332_1; completed $time; date $time; lastModified $time; fromURL $url . ``` Maybe it's an option: * defaultGraphName: 'default' | 'source' | 'blank' | But 'blank' (with isolate()) is the only one that can't get out of control, so it seems like best practice. But it also seems kinda complicated. It means we kinda want: ```js kb.crawler.sources = [ { url, lastStarted, lastEnded, **defaultGraphNode** } ] ``` so you can find the defaultGraphNode. Right? you could also find it via querying. Bascially, Crawler maintains a KB where it owns the default graph, keeping it full of metadata about fetches, and all the named graphs are what they are. ## On-Demand (Lazy) Data (planned) ```js kb.provide(pattern, providerFunction) ``` Add the pair to the set of active providers. The providers are used whenever looking in the kb for data. Can be used to implement overlayKb (unionKB? mergeKB?), and various otherwise-expensive tricks. Unclear if we want: * provideBindings (Solutions), nice if the pattern has lots of constants in it and maybe some joins. Basically backward chaining. Could make answering some kinds of queries super efficient; you never actually need to turn things into quads. * provideQuads, simpler in the simple cases, especially like looking for all quads. * provideTriples, even simpler, and lets the system offer provenance pointing to this provisionFunction. Maybe that's settled by an options parameter. ## Rules (planned) Example File `ruleset1.js` ```js const ruleset = [ { if: '?person foaf:firstName ?first; foaf:lastName ?last', do: v => { v.name = v.first + ' ' + v.last }, then: '?person foaf:name ?name' } ] ruleset.name = 'Name Vocabulary Conversion' ruleset.strategy = 'Forward' module.exports = ruleset ``` Use like: ```js kb.addRules(require('ruleset1')) ``` Variations: * if/then, all variables/bnodes match, pure datalog * if/then with fresh blank nodes in the then-clause, such as due to a [ ] or ( ) construct; this is now Horn logic (which is Turing complete). Not obvious how to implement backward-chaining with this without FOL-style "Terms". Maybe we make arrays (lists) native, and use them? * iff/then, implies the same rule with clauses swapped * if/do, just executable, forward only * if/do/then, a way to execute builtins to define vars for then (but best to make them side-effect free and using no data except what's in the the argument, which is why they are in a separate module in the example) ## Provenance Provenance chain can use graph label, at least when only triples are concluded. What happens when you want a rule about provenance, though? Terms/tuples seem much better for this than quads. Like, instead of graph literals, just use lists of triples, where triples are spo lists. But those are harder to search when we don't know the provenance. Does .isolate, and the .provide and Crawler stuff help with this? Do it just like that. Always output isolated stuff, and link it with the provenance. (If someone equates the graph labels, we'll get lost, though.) ```trig _:gr007 { _:gr007_1 } _:gr007_1 { } :fetch007 providedDefaultGraph _:gr007; providedGraph _:gr007, _:gr007_1; completed $time; date $time; lastModified $time; fromRule $ruleID # this is the only different part . ``` We're going to need views to be near-JS-level performance much of the time, via provide, I think. kb.provide inputs JS objects, kb.view outputs them, and we need to make sure there usually a combinatoric explosion of joins in the middle. ## owl:InverseFunctionalProperty As a special case, this reasoning can be done like: ```js const kb2 = kgx.owlifp.rewrite(kb1, prefns) ``` It's equivalent to running the IFP rule and the equate rules, but * doesn't use the rules engine or anything sophisticated * doesn't chain; so it's only really appropriate for Datatype Properties, where chaining isn't needed * picks one of the values and discards the rest (you can give the preferred namespace to keep) Issue: should we use keys instead of IFP? I don't understand the DL-Safe issue in https://www.w3.org/TR/owl2-syntax/#Keys See: * https://www.w3.org/TR/owl2-syntax/#Inverse-Functional_Object_Properties * https://www.w3.org/TR/owl2-mapping-to-rdf/ This is used for implemented movable schemas. --- _Source: https://npm.io/package/kgx · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._