@or-sdk/graph 1.3.0 → 1.3.1

package/CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.3.1](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/compare/@or-sdk/graph@1.3.0...@or-sdk/graph@1.3.1) (2023-04-07)
+
+
+### Bug Fixes
+
+* **@or-sdk/graphs:** Improve docs ([5b1cbd5](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/commit/5b1cbd5d405419f1160e2bdd84641dd1a61dbfc5))
+
+
+
 ## [1.3.0](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/compare/@or-sdk/graph@1.1.1...@or-sdk/graph@1.3.0) (2023-03-29)
 
 

package/README.md

@@ -1,21 +1,204 @@
-## Installation:
+## Overview
+
+The `@or-sdk/graph` package provides a client for working with the graphs in OneReach.ai. With this client, you can perform operations such as querying graphs, creating new graphs and managing saved queries.
+
+The OneReach.ai Graphs application is a graph-based database that allows you to store and manipulate data using nodes and edges. You can use it to model complex relationships between entities and perform complex queries on them.
+
+The database implements the openCypher query language, which is a declarative SQL-like language for querying graph databases. You can learn more about openCypher by visiting the [official documentation](https://redis.io/docs/stack/graph/cypher_support/).
+
+The OneReach.ai Graphs application is built on top of RedisGraph, which is a graph database that uses the Redis store as its underlying storage engine.
+
+## Installation
+
+To install the package, run the following command:
+
 ```
-$ npm i @or-sdk/graph
+$ npm install @or-sdk/graph
 ```
 
-## Usage:
+## Usage
+
+To use the `Graphs` client, you need to create an instance of the class with the appropriate configuration options. You can either provide the direct API URL or the service discovery URL. Here is an example:
+
 ```typescript
-import { Graph } from '@or-sdk/graph'
+import { Graphs } from '@or-sdk/graph';
 
 // with direct api url
-const graph = new Graph({
+const graph = new Graphs({
   token: 'my-account-token-string',
   graphUrl: 'http://example.graph/endpoint'
 });
 
 // with service discovery(slower)
-const graph = new Graph({
+const graph = new Graphs({
   token: 'my-account-token-string',
   discoveryUrl: 'http://example.graph/endpoint'
 });
- ```
+```
+
+Once you have an instance of the `Graphs`
+client, you can use its methods to interact with the OneReach.ai Graphs application. The available methods are:
+
+
+### `query`
+Executes a query on a graph and returns the results.
+
+#### Params
+- `[0].query: string` - Cypher Query to execute
+- `[0].query: graph` - Graph name to execute the query in
+- `[0].params?: Object` - Optional substitution params.
+
+#### Example
+```typescript
+type Place = Node<{ name: string; description: string; lat: number; lng: number }>
+
+const res = await graph.query<{ p: Place }>({
+  graph: 'places',
+  query: 'MATCH (p: Place) WHERE p.name = $name RETURN p',
+  params: { name: 'CoffeePlace' }
+});
+
+console.log(res[0].n.name)
+// Outputs: "CoffeePlace"
+
+```
+
+### `listGraphs`
+Lists all graphs available to the authenticated user.
+
+#### Params
+- `[0]?: string` - Optional name of graph to search for.
+
+#### Example
+```typescript
+const graphs = await graph.listGraphs();
+
+console.log(graphs.items);
+// Outputs: Array<Graph>
+```
+
+### `getGraphInfo`
+Gets detailed information about a specific graph.
+
+#### Params
+- `[0]: string` - Name of graph to get info for.
+
+#### Example
+```typescript
+const result = await graph.getGraphInfo('graph-name');
+
+console.log(result);
+// Outputs: GraphInfo object
+```
+
+### `createGraph`
+Creates a new graph.
+
+#### Params
+- `[0]: Graph` - New graph to create.
+
+#### Example
+```typescript
+const result = await graph.createGraph({
+  name: 'graph-name',
+  description: 'First steps in graphs',
+});
+
+console.log(result);
+// Outputs: WriteResponse object
+```
+
+### `updateGraph`
+Updates an existing graph.
+
+#### Params
+- `[0]: Graph` - Graph to update.
+
+#### Example
+```typescript
+const result = await graph.updateGraph({
+  name: 'graph-name',
+  description: 'First steps in graphs',
+});
+
+console.log(result);
+// Outputs: WriteResponse object
+```
+
+### `deleteGraph`
+Deletes an existing graph.
+
+#### Params
+- `[0]: string` - Name of graph to delete.
+
+#### Example
+```typescript
+const result = await graph.deleteGraph('graph-name');
+
+console.log(result);
+// Outputs: WriteResponse object
+```
+
+### `saveQuery`
+Saves a new Cypher query for future reuse.
+
+#### Params
+- `[0]: string` - Graph name to save query for.
+- `[1]: Query` - Query to save.
+
+#### Example
+```typescript
+const result = await graph.saveQuery('graph-name', {
+  name: 'query-name',
+  query: 'MATCH (p: Place) WHERE p.name = $name RETURN p',
+});
+
+console.log(result);
+// Outputs: WriteResponse object
+```
+
+### `listQueries`
+Lists all saved queries for a graph.
+
+#### Params
+- `[0]: string` - Name of graph to list queries for.
+- `[1]?: string` - Optional name of query to search for.
+
+#### Example
+```typescript
+const queries = await graph.listQueries('graph-name');
+
+console.log(queries.items);
+// Outputs: Array<Query> object
+```
+
+### `getQuery`
+Gets detailed information about a specific saved query.
+
+#### Params
+- `[0]: string` - Name of graph the query belongs to.
+- `[1]: string` - Name of query to get info for.
+
+#### Example
+```typescript
+const result = await graph.getQuery('graph-name', 'query-name');
+
+console.log(result);
+// Outputs: Query object
+```
+
+### `deleteQuery`
+Deletes a saved query.
+
+#### Params
+- `[0]: string` - Name of graph the query belongs to.
+- `[1]: string` - Name of query to delete.
+
+#### Example
+```typescript
+const result = await graph.deleteQuery('graph-name', 'query-name');
+
+console.log(result);
+// Outputs: WriteResponse object
+```
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@or-sdk/graph",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
@@ -28,5 +28,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "33f72bd306b564871e26eb6aedf247e8c750bbbc"
+  "gitHead": "fdf5a567d2f342106696085f8aa004657bb75b37"
 }