JavaScript SDK for LiteGraph

LiteGraph is a lightweight graph database with both relational and vector support, built using Sqlite, with support for exporting to GEXF. LiteGraph is intended to be a multi-modal database primarily for providing persistence and retrieval for knowledge and artificial intelligence applications.

Documentation

Full documentation is available at https://litegraph.readme.io/.

Features

- Multi-tenant support with tenant GUID management
- Graph management
- Node and edge operations
- Route finding between nodes
- Search capabilities for graphs, nodes, and edges
- GEXF format export support
- Built-in retry mechanism and error handling
- Comprehensive logging system
- Access key authentication support

Requirements

- Node.js v18.20.4
- npm

$3

- jest - for testing
- msw - for mocking the api
- superagent - for making the api calls
- url - for url parsing
- util - for utility functions
- uuid - for generating unique ids

Installation

Use the command below to install the package.

``bash
npm i litegraphdb
`

Quick Start

`js
import { LiteGraphSdk } from 'litegraphdb';

const sdk = new LiteGraphSdk(
'https://api.litegraphdb.com',
'your-tenant-guid',
'your-access-key'
);
const graphGuid = 'example-graph-guid';

// Create a new graph
sdk.Graph.create({name: 'MyGraph'}).then((graph) => {
console.log('Created graph:', graph);
});


const newMultipleNodes = [
{
"Name": "Active Directory",
"Labels": [
"test"
],
"Tags": {
"Type": "ActiveDirectory"
},
"Data": {
"Name": "Active Directory"
}
},
{
"Name": "Website",
"Labels": [
"test"
],
"Tags": {
"Type": "Website"
},
"Data": {
"Name": "Website"
}
}
]
//Create multiple Nodes
sdk.Node.create(graphGuid,newMultipleNodes).then((nodes) => {
console.log('Created Multiple Nodes:', nodes);
});

const searchNodes = async () => {
// Graph object to update

const searchRequest = {
GraphGUID: '00900db5-c9b7-4631-b250-c9e635a9036e',
Ordering: 'CreatedDescending',
Expr: {
Left: 'Hello',
Operator: 'Equals',
Right: 'World',
},
};

sdk.Node.search(searchRequest).then((response) => {
console.log('Search response:', response);
})
`

API Endpoints Reference

$3

| Method | Description | Parameters | Returns | Endpoint |
| ------------------------------- | ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ------------------------------------------------------------------- |
| sdk.Tenant.readAll | Retrieves a list of all tenants. | cancellationToken (optional) - AbortController | Promise - Array of tenants | GET /v1.0/tenants |
| sdk.Tenant.read | Retrieves a specific tenant by GUID. | tenantGuid (string) - The GUID of the tenant
cancellationToken (optional) - AbortController | Promise - The tenant | GET /v1.0/tenants/{tenantGuid} |
| sdk.Tenant.create | Creates a new tenant. | tenant (TenantMetaData) - The tenant object
tenant.name (string) - Name of the tenant
tenant.Active (boolean) - Active status
cancellationToken (optional) - AbortController | Promise - Created tenant | PUT /v1.0/tenants |
| sdk.Tenant.update | Updates an existing tenant. | tenant (TenantMetaData) - The tenant object
tenant.name (string) - Name of the tenant
tenant.Active (boolean) - Active status
cancellationToken (optional) - AbortController | Promise - Updated tenant | PUT /v1.0/tenants/{guid} |
| sdk.Tenant.delete | Deletes a tenant by GUID. | tenantGuid (string) - The GUID of the tenant
cancellationToken (optional) - AbortController | Promise | DELETE /v1.0/tenants/{tenantGuid} |
| sdk.Tenant.exists | Checks if a tenant exists by GUID. | tenantGuid (string) - The GUID of the tenant
cancellationToken (optional) - AbortController | Promise | HEAD /v1.0/tenants/{tenantGuid} |
| sdk.Tenant.enumerate | Enumerates tenants. | request (optional) - EnumerateRequest
cancellationToken (optional) - AbortController | Promise> - Array of tenants | GET /v2.0/tenants |
| sdk.Tenant.enumerateAndSearch | Enumerates and searches tenants. | request (EnumerateAndSearchRequest) - The request object
cancellationToken (optional) - AbortController | Promise> - Array of tenants | POST /v2.0/tenants |
| sdk.Tenant.readStatistics | Retrieves statistics for a tenant. | cancellationToken (optional) - AbortController | Promise | GET /v1.0/tenants/{tenantGuid}/stats |
| sdk.Tenant.readAllStatistics | Retrieves statistics for all tenants. | cancellationToken (optional) - AbortController | Promise | GET /v1.0/tenants/stats |
| sdk.Tenant.readMany | Retrieves multiple tenants by GUID. | tenantGuids (string[]) - The GUIDs of the tenants
cancellationToken (optional) - AbortController | Promise - Array of tenants | GET /v1.0/tenants?guids={tenantGuid1},{tenantGuid2},{tenantGuid3} |

$3

| Method | Description | Parameters | Returns | Endpoint |
| ----------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- | -------------------------------------------------------------------------------- |
| sdk.User.readAll | Retrieves all users. | cancellationToken (optional) - AbortController | Promise | GET /v1.0/tenants/{tenantGuid}/users |
| sdk.User.read | Retrieves a specific user by GUID. | userGuid (string) - User GUID
cancellationToken (optional) - AbortController | Promise | GET /v1.0/tenants/{tenantGuid}/users/{userGuid} |
| sdk.User.create | Creates a new user. | user (Object) - User object with FirstName, LastName, Active, Email, Password
cancellationToken (optional) - AbortController | Promise | PUT /v1.0/tenants/{tenantGuid}/users |
| sdk.User.exists | Checks if a user exists by GUID. | guid (string) - User GUID
cancellationToken (optional) - AbortController | Promise | HEAD /v1.0/tenants/{tenantGuid}/users/{guid} |
| sdk.User.update | Updates an existing user. | user (Object) - User object with FirstName, LastName, Active, Email, Password
guid (string) - User GUID
cancellationToken (optional) - AbortController | Promise | PUT /v1.0/tenants/{tenantGuid}/users/{guid} |
| sdk.User.delete | Deletes a user by GUID. | guid (string) - User GUID
cancellationToken (optional) - AbortController | Promise | DELETE /v1.0/tenants/{tenantGuid}/users/{guid} |
| sdk.User.enumerate | Enumerates users. | request (optional) - EnumerateRequest
cancellationToken (optional) - AbortController | Promise> - Array of users | GET /v2.0/tenants/{tenantGuid}/users |
| sdk.User.enumerateAndSearch | Enumerates and searches users. | request (EnumerateAndSearchRequest) - The request object
cancellationToken (optional) - AbortController | Promise> - Array of users | POST /v2.0/tenants/{tenantGuid}/users |
| sdk.User.readMany | Retrieves multiple users by GUID. | userGuids (string[]) - The GUIDs of the users
cancellationToken (optional) - AbortController | Promise - Array of users | GET /v1.0/tenants/{tenantGuid}/users?guids={userGuid1},{userGuid2},{userGuid3} |

$3

| Method | Description | Parameters | Returns | Endpoint |
| -------------------------------------- | --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | ------------------------- |
| sdk.Authorization.generateToken | Generates an authentication token. | email (string) - User's email
password (string) - User's password
tenantId (string) - Tenant ID
cancellationToken (optional) - AbortController | Promise | GET /v1.0/token |
| sdk.Authorization.getTokenDetails | Fetches details about an authentication token. | token (string) - Authentication token
cancellationToken (optional) - AbortController | Promise