This repository is for the JavaScript client library for TerminusDB
TerminusDB is an open-source graph database and document store. It allows you to link and process structured and unstructured JSON documents in a powerful knowledge graph all through a simple document API.
It is the model-based, in-memory, and distributed knowledge graph database with version control for JSON documents with a git-for-data collaboration model at its heart. So many great things in a single package and a high precision datalog query language with advanced features like transactions, schema validation and unification.
For many, it serves as a headless content management system for complex enviroments with push, pull, clone, rebase and merge capabilities with immutable history and a strong schema checker that covers both the simplest and most advanced models.
Requirements
- Node.js version 22+ if using the TerminusDB client library as a Node.js package.
Installation
The TerminusDB JavaScript client library can be used either as a Node.js package or as a script that runs in the browser.
NPM Package
If you don't already have Node.js installed, install it first.
To install the terminusdb package as a dependency in an existing package, run:
$ npm install --save terminusdb
This command updates your package.json.
Script
To use the terminusdb-client script on a webpage sourced from a CDN, add this to your HTML:
<script src="https://unpkg.com/terminusdb/dist/terminusdb-client.min.js"></script>
Alternatively, you can download the latest terminusdb-client.min.js, add it to your sources, and use that in the <script> instead.
Usage
This example creates a simple dataProduct, starting to create a database model the schema and insert a simple document
For the full Documentation
const TerminusClient = require("terminusdb");
// Connect and configure the TerminusClient
const client = new TerminusClient.WOQLClient('SERVER_CLOUD_URL/mycloudTeam',
{user:"myemail@something.com", organization:'mycloudTeam'})
client.setApiKey(MY_ACCESS_TOKEN)
const bankerSchema = [
{
"@type":"Class",
"@id":"BankAccount",
"@key":{
"@type":"Hash",
"@fields":[
"account_id"
]
},
"account_id":"xsd:string",
"owner":"Person",
"balance":"xsd:decimal"
},
{
"@type":"Class",
"@id":"Person",
"@key":{
"@type":"Lexical",
"@fields":[
"name"
]
},
"name":"xsd:string"
}
]
async function createDataProduct(){
try{
await client.createDatabase("banker", {label: "Banker Account",
comment: "Testing", schema: true})
//add the schema documents
await client.addDocument(bankerSchema,{"graph_type":"schema"},null,"add new schema")
const accountObj = {"@type":"BankAccount",
"account_id":"DBZDFGET23456",
"owner":{
"@type":"Person",
"name":"Tom"
},
"balance":1000
}
//add a document instance
await client.addDocument(accountObj)
client.getDocument({"as_list":true,id:'Person/Tom'})
}catch(err){
console.error(err.message)
}
}
TypeScript
The package ships generated type declarations (dist/typescript), so TypeScript works out of the box with import.
WOQL functions accept either "v:name" strings or Var/Vars objects wherever a variable is expected.
The WOQLClient CRUD and query methods take an optional type parameter describing the expected result; pass a second type parameter when getDataVersion is set. Shared result and error shapes are importable by name from the package root (also available under the typedef namespace).
import {
WOQLClient,
WOQL,
type WithDataVersion,
type TerminusDBError,
} from "terminusdb";
interface Person {
"@id": string;
"@type": string;
name: string;
}
const client = new WOQLClient("http://127.0.0.1:6363/", {
user: "admin",
key: "my_secret_key",
db: "test_db",
});
// Typed query bindings
interface NameRow { name: string }
const result = await client.query<NameRow>(
WOQL.triple("v:p", "name", WOQL.Vars("name").name),
);
const names = result.bindings.map((row) => row.name);
// Typed document and getDataVersion wrapper
const person = await client.getDocument<Person>({ id: "Person/ada" });
const wrapped = await client.getDocument<Person, WithDataVersion<Person>>(
{ id: "Person/ada" }, undefined, undefined, undefined, true,
);
console.log(wrapped.dataVersion);
// Errors are standard Error objects carrying .status and the parsed server
// error body on .data (type: TerminusDBError)
try {
await client.getDocument<Person>({ id: "Person/missing" });
} catch (err) {
const e = err as TerminusDBError;
if (e.status === 404) {
console.log(e.data?.["api:error"]?.["@type"]); // "api:DocumentNotFound"
}
}
Removed in 12.1.0
The viewer classes formerly exported from lib/viewer — View, WOQLResult, WOQLTable, WOQLGraph (and their rule/config helpers) — were deprecated in 12.0.9 and removed in 12.1.0. Data rendering is outside this package's scope: the client connects to TerminusDB, your application renders the results.
Options
Connections options.
To initialize TerminusDB client with custom options use
const TerminusClient = require("terminusdb");
const client = new TerminusClient.WOQLClient("http://127.0.0.1:6363/", {
db: "test_db",
user: "admin",
key: "my_secret_key",
});
API
The TerminusDB API can be found at the TerminusDB Documentation.
TerminusDB communicates using JSON over HTTP. It works with advanced datatypes including integers, floats, decimals, big integers, arbitrary precision decimals, dates and other important XML Datatypes. Math is capped at 20 digits of precision, where the core is ready to support higher precision if needed.
Report Issues
If you encounter any issues, please report it with your os and environment setup, the version that you are using, and a simple reproducible case.
If you encounter other questions, you can ask them on our Discord Server.
Contribute
This project uses Husky which automatically runs lint, tests, and other scripts when you try to commit any changes to the repository. This helps us to improve each commit done to the repo and is automatically installed and configured when you do
npm install
It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.
Please check Contributing.md for more information.
Licence
The APACHE 2.0 License
Copyright (c) 2019
