Comparing version 0.3.0-rc6 to 0.3.0
{ | ||
"name": "rdf-ext", | ||
"version": "0.3.0-rc6", | ||
"version": "0.3.0", | ||
"description": "Extended Linked Data module", | ||
@@ -27,4 +27,4 @@ "main": "rdf-ext.js", | ||
"es6-promise": "^3.0.2", | ||
"rdf-graph-array": "^0.3.0-rc6", | ||
"rdf-store-inmemory": "^0.3.0-rc1" | ||
"rdf-graph-array": "^0.3.0", | ||
"rdf-store-inmemory": "^0.3.0" | ||
}, | ||
@@ -34,5 +34,5 @@ "devDependencies": { | ||
"nock": "^2.17.0", | ||
"rdf-test-data": "^0.3.0-rc2" | ||
"rdf-test-data": "^0.3.0" | ||
}, | ||
"readmeFilename": "README.md" | ||
} |
111
README.md
@@ -9,85 +9,90 @@ # RDF Interfaces Extension | ||
> RDF-Ext provides a JavaScript library for working with RDF & Linked Data. | ||
RDF-Ext provides a JavaScript library for working with RDF & Linked Data. | ||
This module contains the core classes to handle RDF Model data. | ||
Additional modules may be required to handle data in different formats (Turtle, JSON-LD, RDF/XML) or stores (LDP, SPARQL). | ||
The [module section](#modules) lists the most common modules. | ||
### Parsing | ||
* [Abstract](https://github.com/rdf-ext/rdf-parser-abstract) | ||
* [JSON-LD](https://github.com/rdf-ext/rdf-parser-jsonld) | ||
* [Turtle](https://github.com/rdf-ext/rdf-parser-n3) | ||
* [N-Triples](https://github.com/rdf-ext/rdf-parser-n3) | ||
* [DOM/RDFa](https://github.com/rdf-ext/rdf-parser-dom) | ||
* [RDF/XML](https://github.com/rdf-ext/rdf-parser-rdfxml) | ||
* [Microdata](https://github.com/rdf-ext/rdf-parser-microdata) | ||
## Usage | ||
### Serializing | ||
* [Abstract](https://github.com/rdf-ext/rdf-serializer-abstract) | ||
* [JSON-LD](https://github.com/rdf-ext/rdf-serializer-jsonld) | ||
* [Turtle](https://github.com/rdf-ext/rdf-serializer-ntriples) | ||
* [Microdata](https://github.com/rdf-ext/rdf-serializer-sparql-update) | ||
In general, consult the [API documentation](https://github.com/rdf-ext/rdf-ext-spec/blob/gh-pages/API.md) for details about how to interact with the library. | ||
### Stores | ||
For persistence, RDF-Ext provides several store implementations. | ||
### node.js | ||
- [**Abstract**](http://github.com/rdf-ext/rdf-store-abstract) - Abstract implementation, can be used to build your own store | ||
- [**LDP**](http://github.com/rdf-ext/rdf-store-ldp) - Query an external Linked Data Platform via RESTful HTTP requests | ||
- [**File system**](http://github.com/rdf-ext/rdf-store-fs) - Using the file system | ||
- [**In Memory**](http://github.com/rdf-ext/rdf-store-inmemory) - Store loaded in memomory | ||
- [**Single graph (memory)**](http://github.com/rdf-ext/rdf-store-singlegraph) - Store has only a single graph | ||
- [**SPARQL**](http://github.com/rdf-ext/rdf-store-sparql) - Uses the Graph Store HTTP Protocol interface | ||
- [**RDFStore wrapper**](http://github.com/rdf-ext/rdf-store-rdfstore-js) - Store built on top of [Rdfstore-js](http://github.com/antoniogarrote/rdfstore-js) | ||
- [**Multistore**](http://github.com/nicola/rdf-store-multi) - Use multiple store depending on the IRI | ||
- [**Local/Remote**](http://github.com/nicola/rdf-store-server) - Uses a local store or a remote store depending on the IRI | ||
- [**ACL wrapper**](http://github.com/nicola/rdf-store-acl) - Add ACL support to your RDF store | ||
RDF-Ext is available on `npm`, to install it run: | ||
npm install rdf-ext | ||
## Design | ||
In the code, import RDF-Ext: | ||
[RDF-Ext](http://bergos.github.io/rdf-ext-spec/) is an extension of the [RDF Interfaces](http://www.w3.org/TR/rdf-interfaces/) specification. The RDF Interfaces specification defines interfaces for graphs, triples, nodes and parsers/serializers. However, the spec does not define an interface to access triplestores using NamedGraph IRIs. RDF-Ext fills this gap by providing a definition of a [Store](http://bergos.github.io/rdf-ext-spec/#store-1)-Interface with an asynchronous API. | ||
var rdf = require('rdf-ext'); | ||
The motivation for an asynchronous API is simple: A JSON-LD context for example can be defined as an URL. The parsing and serialization process must therefore be asynchronous. The RDF-Ext spec contains an extended interface for parsers and serializers to work asynchronously. | ||
With ECMAScript 6 (ES6) JavaScript introduces some new features. RDF-Ext uses the new [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) feature to handle asynchronous function calls easier. | ||
### Browser | ||
## Requirements | ||
Just import the RDF-Ext distribution: | ||
RDF-Ext requires a library, which implements the W3C [RDF Interfaces](http://www.w3.org/TR/rdf-interfaces/) API. | ||
Here is a list of known working implementations: | ||
<script src="/js/rdf-ext.js"></script> | ||
* [reference implementation](https://github.com/bergos/rdf-interfaces) | ||
* [rdf](https://github.com/Acubed/node-rdf) | ||
* [rdfstore-js](https://github.com/antoniogarrote/rdfstore-js) | ||
## Usage | ||
#### Distribution | ||
In general, consult the documentation for the [RDF Interfaces](http://www.w3.org/TR/rdf-interfaces/) and [RDF-Ext](http://bergos.github.io/rdf-ext-spec/) specifications for details about how to interact with the library. | ||
You can download a prebuilt or custom distribution from the [RDF-Ext distribution builder site](http://rdf-ext.bergnet.org/). | ||
The [RDF-Ext distribution builder](https://github.com/rdf-ext/rdf-ext-dist-builder) also offers a command line interface to build custom distributions. | ||
### node.js | ||
RDF-Ext is available on `npm`, to install it run: | ||
#### Browserify | ||
npm install rdf-ext | ||
If you build your application with Browserify, RDF-Ext can be bundled flawless. | ||
In the code, import RDF-Ext: | ||
var rdf = require('rdf-ext'); | ||
## Support | ||
### Browser | ||
Issues & feature requests should be reported on Github. | ||
Just import RDF-Ext: | ||
Pull requests are very welcome. | ||
<script src="/js/rdf-ext.js"></script> | ||
If you want to use rdfstore-js it must be imported first. | ||
Because rdfstore-js comes with an outdated version of JSON-LD it must be deleted afterwards: | ||
## Modules | ||
<script src="/js/rdfstore.js"></script> | ||
<script>delete jsonld;</script> | ||
There are many modules for parsing, serializing, stores for persistence and simplified data handling. | ||
## Support | ||
Issues & feature requests should be reported on Github. | ||
### Parsers | ||
Pull requests are very welcome. | ||
* [Abstract](https://github.com/rdf-ext/rdf-parser-abstract) - Can be used to implement own parsers | ||
* [DOM](https://github.com/rdf-ext/rdf-parser-dom) - Can be used to implement parsers for XML or HTML formats | ||
* [JSON-LD](https://github.com/rdf-ext/rdf-parser-jsonld) - Uses the reference implementation to supports all document forms | ||
* [Microdata](https://github.com/rdf-ext/rdf-parser-microdata) - Fork of the [Green Turtle](https://github.com/alexmilowski/green-turtle) parser | ||
* [RDF/XML](https://github.com/rdf-ext/rdf-parser-rdfxml) - Fork of the [rdflib.js](https://github.com/linkeddata/rdflib.js/) RDF/XML parser | ||
* [Turtle & N-Triples](https://github.com/rdf-ext/rdf-parser-n3) - Uses [N3.js](https://github.com/RubenVerborgh/N3.js) for parsing | ||
### Serializers | ||
* [Abstract](https:https://github.com/rdf-ext/rdf-ext-spec/blob/gh-pages/API.md//github.com/rdf-ext/rdf-serializer-abstract) - Can be used to implement own serializers | ||
* [JSON-LD](https://github.com/rdf-ext/rdf-serializer-jsonld) - Outputs JSON-LD in flat document form | ||
* [N-Triples](https://github.com/rdf-ext/rdf-serializer-ntriples) - Uses the `.toNT()` method to serialize N-Triples | ||
* [Turtle](https://github.com/rdf-ext/rdf-serializer-ntriples) - Uses [N3.js](https://github.com/RubenVerborgh/N3.js) for serializing | ||
* [SPARQL Update](https://github.com/rdf-ext/rdf-serializer-sparql-update) - Generates `INSERT DATA` SPARQL updates | ||
### Stores | ||
- [Abstract](http://github.com/rdf-ext/rdf-store-abstract) - Abstract implementation, can be used to build your own store | ||
- [ACL wrapper](http://github.com/nicola/rdf-store-acl) - Add ACL support to your RDF store | ||
- [File system](http://github.com/rdf-ext/rdf-store-fs) - Using the file system | ||
- [In Memory](http://github.com/rdf-ext/rdf-store-inmemory) - Store loaded in memomory | ||
- [LDP](http://github.com/rdf-ext/rdf-store-ldp) - Query an external Linked Data Platform via RESTful HTTP requests | ||
- [Local/Remote](http://github.com/nicola/rdf-store-server) - Uses a local store or a remote store depending on the IRI | ||
- [Multistore](http://github.com/nicola/rdf-store-multi) - Use multiple store depending on the IRI | ||
- [Single graph (memory)](http://github.com/rdf-ext/rdf-store-singlegraph) - Store has only a single graph | ||
- [SPARQL](http://github.com/rdf-ext/rdf-store-sparql) - Uses the Graph Store HTTP Protocol interface | ||
### Others | ||
- [Clownface](https://github.com/rdf-ext/clownface) - Simple but powerful graph traversing library | ||
- [Common Formats](https://github.com/rdf-ext/rdf-formats-common) - Loads parsers and serializers for the most common formats | ||
- [SimpleRDF](https://github.com/nicola/simplerdf/) - Simple but powerful graph to object mapping |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
98
44892
- Removedrdf-ext@0.3.0(transitive)
Updatedrdf-graph-array@^0.3.0
Updatedrdf-store-inmemory@^0.3.0