Merge branch 'main' of https://github.com/terminusdb/terminusdb-client-js into getDatabases

Signed-off-by: NeelParihar <[email protected]>

Author: Neelterminusdb

.eslintignore

@@ -6,3 +6,5 @@ package.json
 package-lock.json
 .ci
 .nyc_output
+test/
+tutorial/

.eslintrc.js

@@ -0,0 +1,17 @@
+module.exports = {
+  env: {
+    browser: true,
+    commonjs: true,
+    es2021: true,
+    node: true,
+  },
+  extends: [
+    'airbnb-base',
+  ],
+  parserOptions: {
+    ecmaVersion: 13,
+  },
+  rules: {
+    'func-names': ['error', 'never'],
+  },
+};

.github/workflows/ci.yml

@@ -0,0 +1,20 @@
+name: CI
+on:
+  pull_request:
+    branches:
+        - main
+
+jobs:
+  setup-test-lint:
+    name: Setup, Test, and Lint
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: 14
+    - run: npm install
+    - run: npm test
+    - run: npm run lint:check

docs/_sidebar.md

@@ -46,6 +46,7 @@
     - [generateCommitInfo](api/woqlClient.js?id=generateCommitInfo)
     - [generateCommitDescriptor](api/woqlClient.js?id=generateCommitDescriptor)
     - [prepareRevisionControlArgs](api/woqlClient.js?id=prepareRevisionControlArgs)
+    - [getDatabase](api/woqlClient.js?id=getDatabase)
     - [updateDatabase](api/woqlClient.js?id=updateDatabase)
     - [addDocument](api/woqlClient.js?id=addDocument)
     - [queryDocument](api/woqlClient.js?id=queryDocument)

docs/api/woql.js.md

@@ -394,7 +394,7 @@ file("/path/to/file", {type: 'turtle'} )
 ```
 
 ### post
-#### WOQL.post(url, [formatObj]) ⇒ <code>WOQLQuery</code>
+#### WOQL.post(url, [formatObj], [source]) ⇒ <code>WOQLQuery</code>
 Identifies a resource as a local path on the client, to be sent to the server through a
 HTTP POST request, with the format defined through the options
 
@@ -404,6 +404,7 @@ HTTP POST request, with the format defined through the options
 | --- | --- | --- |
 | url | <code>string</code> | The Path on the server at which the file resource can be accessed |
 | [formatObj] | <code>typedef.DataFormatObj</code> | imput options, optional |
+| [source] | <code>string</code> | It defines the source of the file, it can be 'url','post' |
 
 **Example**  
 ```js
@@ -1270,7 +1271,7 @@ get the predefined library query [WOQLLibrary](/api/woqlLibrary.js?id=WOQLLibrar
 const query = WOQL.lib().previousCommits('m8vpxewh2aovfauebfkbzwmj4qwr5lb')
 
 //return the commits of a specific branch starting from the head
-//you can add the limit (how many results to return.) and the start point 
+//you can add the limit (how many results to return.) and the start point
 //if a timestamp is given, gets the commits before the specified timestamp
 //WOQL.lib().commits(branch='main',limit=0,start=0,timestamp=0)
 

docs/api/woqlClient.js.md

@@ -4,10 +4,13 @@
 **License**: Apache Version 2  
 
 #### new WOQLClient(serverUrl, [params])
-The core functionality of the TerminusDB javascript client is defined in the WOQLClient class - in the woqlClient.js file.
-This class provides methods which allow you to directly get and set all of the configuration and API endpoints of the client.
-The other parts of the WOQL core - connectionConfig.js and connectionCapabilities.js - are used by the client to store internal state - they should never have to be accessed directly.
-For situations where you want to communicate with a TerminusDB server API, the WOQLClient class is all you will need.
+The core functionality of the TerminusDB javascript client is
+defined in the WOQLClient class - in the woqlClient.js file. This class provides
+methods which allow you to directly get and set all of the configuration and API
+endpoints of the client. The other parts of the WOQL core - connectionConfig.js
+and connectionCapabilities.js - are used by the client to store internal state - they
+should never have to be accessed directly. For situations where you want to communicate
+with a TerminusDB server API, the WOQLClient class is all you will need.
 
 
 | Param | Type | Description |
@@ -30,7 +33,7 @@ async function getSchema() {
 //to connect with your TerminusDB Cloud Instance
 const client = new TerminusClient.WOQLClient('SERVER_CLOUD_URL/mycloudTeam',
                      {user:"[email protected]", organization:'mycloudTeam'})
-                                          
+
 client.setApiKey(MY_ACCESS_TOKEN)
 
 //to get the list of all organization's databases
@@ -288,7 +291,8 @@ creates a copy of the client with identical internal state and context
 useful if we want to change context for a particular API call without changing
 the current client context
 
-**Returns**: [<code>WOQLClient</code>](#WOQLClient) - new client object with identical state to original but which can be manipulated independently  
+**Returns**: [<code>WOQLClient</code>](#WOQLClient) - new client object with identical state to original but
+which can be manipulated independently  
 **Example**  
 ```js
 let newClient = client.copy()
@@ -304,7 +308,8 @@ it can only be set creating a new WOQLCLient instance
 #### woqlClient.api() ⇒ <code>string</code>
 Retrieve the URL of the server’s API base that we are currently connected to
 
-**Returns**: <code>string</code> - the URL of the TerminusDB server api endpoint we are connected to (typically server() + “api/”)  
+**Returns**: <code>string</code> - the URL of the TerminusDB server api endpoint we are connected
+to (typically server() + “api/”)  
 **Example**  
 ```js
 let api_url = client.api()
@@ -504,7 +509,7 @@ of the current context for "commits" "meta" "branch" and "ref" special resources
 | Param | Type | Description |
 | --- | --- | --- |
 | resourceType | <code>typedef.ResourceType</code> | the type of resource string that is required - one of “db”, “meta”, “repo”, “commits”, “branch”, “ref” |
-| [resourceId] | <code>string</code> | can be used to specify a specific branch / ref - if not supplied the current context will be used |
+| [resourceId] | <code>string</code> | can be used to specify a specific branch / ref - if  not supplied the current context will be used |
 
 **Example**  
 ```js
@@ -661,6 +666,19 @@ Adds an author string (from the user object returned by connect) to the commit m
 | [rc_args] | <code>object</code> | 
 
 
+### getDatabase
+#### woqlClient.getDatabase() ⇒ <code>Promise</code>
+Server Version API
+Note: the below endpoints are not part of the terminusdb desktop package
+they belong to the server package version of the DB which is under construction.
+Until that package is released all of the below endpoints should be considered
+as unreliable and subject to change - they are provided complete with the desktop
+version to show users what is coming and to allow people to use them at their own risk
+Any use of them should be considered unsupported and at your own risk
+ get all the database information from the remote server
+
+**Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.  
+
 ### updateDatabase
 #### woqlClient.updateDatabase(dbDoc) ⇒ <code>Promise</code>
 update the database details
@@ -689,18 +707,18 @@ to add a new document or a list of new documents into the instance or the schema
 
 **Example**  
 ```js
-const json = [{ "@type" : "Class",   
+const json = [{ "@type" : "Class",
              "@id" : "Coordinate",
-             "@key" : { '@type' : 'Hash', 
-             '@fields' : ['x','y'] }, 
+             "@key" : { '@type' : 'Hash',
+             '@fields' : ['x','y'] },
              "x" : "xsd:decimal",
              "y" : "xsd:decimal" },
              { "@type" : "Class",
              "@id" : "Country",
-             "@key" : { '@type' : 'Lexical', 
-                         '@fields' : [name] }, 
+             "@key" : { '@type' : 'Lexical',
+                         '@fields' : [name] },
              "name" : "xsd:string",
-             "perimeter" : { "@type" : "List", 
+             "perimeter" : { "@type" : "List",
                              "@class" : "Coordinate" } }]
 client.addDocument(json,{"graph_type":"schema"},"mydb","add new schema")
 ```