LDkit, a Linked Data query toolkit for TypeScript developers
npm install ldkitLDkit is Linked Data query toolkit for TypeScript developers. It
provides ORM-like abstraction over RDF datasources.
You define the data model and then you can retrieve or update data without any
extra hustle. LDkit will generate SPARQL queries, retrieves RDF data and
converts them to TypeScript native types.
- Next-generation ORM-like RDF abstraction.
- Retrieve and update data using reusable data models.
- Compatible with Comunica query engine (you can even
write your own!).
- 10+ popular ontologies included.
- First class TypeScript support, best in class developer experience.
- Runs in browser, Deno and Node.
- ...and more!
The documentation and examples are available on
ldkit.io.
If you are using Node, then you can install LDkit using your favourite package
manager.
``bash`
npm i ldkit
For Deno environment, you can import LDkit like this:
`ts`
import * as ldkit from "https://deno.land/x/ldkit/mod.ts";
`ts
import { createLens, type Options } from "ldkit";
import { dbo, rdfs, xsd } from "ldkit/namespaces";
// Create a schema
const PersonSchema = {
"@type": dbo.Person,
name: rdfs.label,
abstract: dbo.abstract,
birthDate: {
"@id": dbo.birthDate,
"@type": xsd.date,
},
} as const;
// Create options for query engine
const options: Options = {
sources: ["https://dbpedia.org/sparql"], // SPARQL endpoint
language: "en", // Preferred language
};
// Create a resource using the data schema and options above
const Persons = createLens(PersonSchema, options);
`
`ts
// List all persons
const persons = await Persons.find();
for (const person of persons) {
console.log(person.name); // string
console.log(person.birthDate); // Date
}
// Get total count of all persons
const count = await Persons.count();
console.log(count); // number
`
`ts`
// Get a particular person identified by IRI
const ada = await Persons.findByIri("http://dbpedia.org/resource/Ada_Lovelace");
console.log(ada?.name); // string "Ada Lovelace"
console.log(ada?.birthDate); // Date object of 1815-12-10
`ts
// Insert a new person
Persons.insert({
$id: "http://dbpedia.org/resource/Alan_Turing",
name: "Alan Turing",
birthDate: new Date("1912-06-23"),
});
// Modify a person's name
Persons.update({
$id: "http://dbpedia.org/resource/Alan_Turing",
name: "Not Alan Turing",
});
// Delete a person
Persons.delete("http://dbpedia.org/resource/Alan_Turing");
`
More complex examples can be found in documentation.
- TypeScript v5.5 or newer
- Node.js v20.19.3 or newer
- Deno v2.1 or newer
LDkit complies with the following specifications:
- RDF/JS: Data model specification
- RDF/JS: Query specification
- SPARQL 1.1 Query Language
- SPARQL 1.1 Update
- SPARQL 1.1 Protocol
If you are using LDkit in a scientific publication, we would appreciate a
citation of our work.
`bibtexy}, Martin},
@inproceedings{klima2023ldkit,
title = {LDkit: Linked Data Object Graph Mapping Toolkit for Web Applications},
author = {Kl{\'\i}ma, Karel and Taelman, Ruben and Ne{\v{c}}ask{\
booktitle = {International Semantic Web Conference},
pages = {194--210},
year = {2023},
month = oct,
publisher = {Springer Nature Switzerland},
isbn = {978-3-031-47243-5},
url = {https://doi.org/10.1007/978-3-031-47243-5_11}
}
```
Copyright © 2021-present Karel Klima