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

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

Author: Neelterminusdb

README.md

@@ -11,8 +11,8 @@
 [![npm version](https://img.shields.io/npm/v/@terminusdb/terminusdb-client?logo=npm)](https://www.npmjs.com/package/@terminusdb/terminusdb-client)
 [![npm downloads](https://img.shields.io/npm/dw/@terminusdb/terminusdb-client?color=red&label=npm%20package&logo=npm&style=flat)](https://www.npmjs.com/package/@terminusdb/terminusdb-client)
 
-> This repository is for the JavaScript client for TerminusDB and TerminusX. The
-> JavaScript client runs in the browser and on Node.js.
+> This repository is for the JavaScript client library for TerminusDB and
+> TerminusX.
 
 [**TerminusDB**][terminusdb] is an [open-source][terminusdb-repo] graph database
 and document store. It allows you to link JSON documents in a powerful knowledge
@@ -30,40 +30,41 @@ TerminusX is in public beta and you can [sign up now][dashboard].
 
 ## Requirements
 
-- [NodeJS 10+](https://nodejs.org/en/)
+- Node.js version 10+ if using the TerminusDB client library as a Node.js package
 
 ## Installation
 
-TerminusDB Client can be used as either a Node.js module available through the npm registry, or directly included in web-sites by including the script tag below.
+The TerminusDB JavaScript client library can be used either as a Node.js package
+or as a script that runs in the browser.
 
-### NPM Module
+### NPM Package
 
-Before installing, download and install Node.js.<br> 
-NodeJS version 10.X or higher is required. NodeJS version 14.X is recommended.
+> :memo: If you don't already have Node.js installed, [install it][node-install] first.
 
-Installation is done using the npm install command:
+[node-install]: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
 
-Using npm:
+To install the `terminusdb-client` package as a dependency in an existing
+package, run:
 
-```bash
+```sh
 $ npm install --save @terminusdb/terminusdb-client
 ```
 
-### Minified Script
+This command update your `package.json`.
 
-Using cdn:
+### Script
+
+To use the `terminusdb-client` script on a webpage sourced from a CDN, add this
+to your HTML:
 
 ```html
 <script src="https://unpkg.com/@terminusdb/terminusdb-client/dist/terminusdb-client.min.js"></script>
 ```
 
-Downloading:
-
-Download the terminusdb-client.min.js file from the /dist directory and save it to your location of choice, then:
+Alternatively, you can download the latest [`terminusdb-client.min.js`][js], add
+it to your sources, and use that in the `<script>` instead.
 
-```html
-<script src="http://my.saved.location/terminusdb-client.min.js"></script>
-```
+[js]: https://unpkg.com/@terminusdb/terminusdb-client/dist/terminusdb-client.min.js
 
 ## Usage
 

RELEASE_NOTES.md

@@ -1,3 +1,22 @@
+# TerminusDB Client v10.0.5
+
+## New 🚀
+
+* Add new [getDatabases](https://terminusdb.github.io/terminusdb-client-js/#/api/woqlClient.js?id=getdatabases) method [#121](/../../pull/121)
+* Add track version id [#116](/../../pull/116)
+
+## Fixes 🛠
+
+* Fixed tests [#123](/../../pull/123)
+* Modified AccessControl documentations, added api token [#124](/../../pull/124)
+* UPDATED packages [#126](/../../pull/126)
+
+## Deprecated ☠️
+
+* Deprecated connect function [#114](/../../pull/114)
+
+---
+
 # TerminusDB Client v10.0.4
 
 ## New 🚀

docs/README.md

@@ -11,8 +11,8 @@
 [![npm version](https://img.shields.io/npm/v/@terminusdb/terminusdb-client?logo=npm)](https://www.npmjs.com/package/@terminusdb/terminusdb-client)
 [![npm downloads](https://img.shields.io/npm/dw/@terminusdb/terminusdb-client?color=red&label=npm%20package&logo=npm&style=flat)](https://www.npmjs.com/package/@terminusdb/terminusdb-client)
 
-> This repository is for the JavaScript client for TerminusDB and TerminusX. The
-> JavaScript client runs in the browser and on Node.js.
+> This repository is for the JavaScript client library for TerminusDB and
+> TerminusX.
 
 [**TerminusDB**][terminusdb] is an [open-source][terminusdb-repo] graph database
 and document store. It allows you to link JSON documents in a powerful knowledge
@@ -30,40 +30,41 @@ TerminusX is in public beta and you can [sign up now][dashboard].
 
 ## Requirements
 
-- [NodeJS 10+](https://nodejs.org/en/)
+- Node.js version 10+ if using the TerminusDB client library as a Node.js package
 
 ## Installation
 
-TerminusDB Client can be used as either a Node.js module available through the npm registry, or directly included in web-sites by including the script tag below.
+The TerminusDB JavaScript client library can be used either as a Node.js package
+or as a script that runs in the browser.
 
-### NPM Module
+### NPM Package
 
-Before installing, download and install Node.js.<br> 
-NodeJS version 10.X or higher is required. NodeJS version 14.X is recommended.
+> :memo: If you don't already have Node.js installed, [install it][node-install] first.
 
-Installation is done using the npm install command:
+[node-install]: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
 
-Using npm:
+To install the `terminusdb-client` package as a dependency in an existing
+package, run:
 
-```bash
+```sh
 $ npm install --save @terminusdb/terminusdb-client
 ```
 
-### Minified Script
+This command update your `package.json`.
 
-Using cdn:
+### Script
+
+To use the `terminusdb-client` script on a webpage sourced from a CDN, add this
+to your HTML:
 
 ```html
 <script src="https://unpkg.com/@terminusdb/terminusdb-client/dist/terminusdb-client.min.js"></script>
 ```
 
-Downloading:
-
-Download the terminusdb-client.min.js file from the /dist directory and save it to your location of choice, then:
+Alternatively, you can download the latest [`terminusdb-client.min.js`][js], add
+it to your sources, and use that in the `<script>` instead.
 
-```html
-<script src="http://my.saved.location/terminusdb-client.min.js"></script>
-```
+[js]: https://unpkg.com/@terminusdb/terminusdb-client/dist/terminusdb-client.min.js
 
 ## Usage
 

docs/_sidebar.md

@@ -163,8 +163,8 @@
   - [first_commit](api/woqlLibrary.js?id=first_commit)
 - [AccessControl](api/accessControl.js?id=AccessControl)
   - [getDefaultOrganization](api/accessControl.js?id=getDefaultOrganization)
-  - [getJwtToken](api/accessControl.js?id=getJwtToken)
   - [setJwtToken](api/accessControl.js?id=setJwtToken)
+  - [setApiToken](api/accessControl.js?id=setApiToken)
   - [getAPIUrl](api/accessControl.js?id=getAPIUrl)
   - [getAccessRoles](api/accessControl.js?id=getAccessRoles)
   - [createOrganization](api/accessControl.js?id=createOrganization)

docs/api/accessControl.js.md

@@ -5,17 +5,30 @@
 
 #### new AccessControl()
 The AccessControl object has various methods to control the access for users.
+for the credential you can use the JWT token or the API token
 
 **Example**  
 ```js
+//connect with the API token 
+//(to request a token create an account in  https://terminusdb.com/)
+const accessContol = new AccessControl("https://servername.com",
+{organization:"my_team_name",
+token:"dGVybWludXNkYjovLy9kYXRhL2tleXNfYXB........"})
+accessControl.getOrgUsers().then(result=>{
+     console.log(result)
+})
+
+//connect with the jwt token this type of connection is only for the dashboard 
+//or for application integrate with our login workflow
 const accessContol = new AccessControl("https://servername.com",
 {organization:"my_team_name",
 jwt:"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkpXUjBIOXYyeTFORUd........"})
 accessControl.getOrgUsers().then(result=>{
      console.log(result)
 })
+
 //if the jwt is expired you can change it with
- accessControl.setJwtToken("eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkpXUjBIOXYyeTFORUd.......")
+accessControl.setJwtToken("eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkpXUjBIOXYyeTFORUd.......")
 ```
 
 ### getDefaultOrganization
@@ -29,25 +42,24 @@ Get a organization from parameters.
 | params | <code>object</code> | The parameters |
 
 
-### getJwtToken
-#### accessControl.getJwtToken(params) ⇒ <code>string</code>
-Get a API token from parameters.
+### setJwtToken
+#### accessControl.setJwtToken(jwt)
+Sets the Jwt token for the object
 
-**Returns**: <code>string</code> - jwt api token  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| params | <code>object</code> | The parameters |
+| jwt | <code>string</code> | The jwt api token to use |
 
 
-### setJwtToken
-#### accessControl.setJwtToken(jwt)
-Sets the API token for the object
+### setApiToken
+#### accessControl.setApiToken(atokenpi)
+Sets the API token for the object, to request a token create an account in  https://terminusdb.com/
 
 
 | Param | Type | Description |
 | --- | --- | --- |
-| jwt | <code>string</code> | The jwt api token to use |
+| atokenpi | <code>string</code> | The API token to use to connect with TerminusX |
 
 
 ### getAPIUrl

docs/createDocs.js

@@ -70,7 +70,7 @@ function createFile(filePath, options, outputDir) {
   // eslint-disable-next-line no-console
   console.log(`rendering ${filePath}`);
   const output = jsdoc2md.renderSync(options);
-  fs.writeFileSync(path.resolve(outputDir, `${fileName}.md`), output);
+  fs.writeFileSync(path.resolve(outputDir, `${fileName}.md`), setHeadings(fileName, output));
 }
 /// /([\w-]+)(.js)/
 function getFileName(filePath) {
@@ -130,6 +130,51 @@ function formatDataOrder(dataProvider, orderMenu) {
   return tt;
 }
 
+function setHeadings(sFileNm, sMD) {
+  /**
+     * Adjust MD heading levels to create a clean
+     * table of contents in GitBook. This method
+     * replaces the docsify _sidebar.md file.
+     *
+     * Notes:
+     *
+     * 1. This is a quick-fix for basic compliance with the GitBook framework.
+     * 2. Expression "~~" renders text as strikethrough for highlighting deprecations.
+     * 3. Inconsistent use of constants requires a fix.
+     */
+
+  const cHdrLv = '##### ';
+  const cWOQL = 'WOQL.';
+  const cWOQLClient = 'woqlClient.';
+  const cWOQLLib = 'woqlLibrary.';
+  const cAccessCtrl = 'accessControl.';
+
+  // No action for sidebar (code to create sidebar can be deprecated.)
+
+  if (sFileNm.match('sidebar')) return sMD;
+
+  // Simplified pattern for type definitions.
+
+  if (sFileNm.match('typedef.js')) {
+    return sMD
+      .replace(/## /g, '# ')
+      .replace(/### /g, cHdrLv);
+  }
+
+  // All other patterns.
+
+  return sMD
+    .replace(/##/g, '#')
+    .replace(/## ~~WOQL\./g, `${cHdrLv}~~${cWOQL}`)
+    .replace(/## ~~woqlClient\./g, `${cHdrLv}~~${cWOQLClient}`)
+    .replace(/## ~~woqlLibrary\./g, `${cHdrLv}~~${cWOQLLib}`)
+    .replace(/## ~~accessControl\./g, `${cHdrLv}~~${cAccessCtrl}`)
+    .replace(/## WOQL\./g, `${cHdrLv}${cWOQL}`)
+    .replace(/## woqlClient\./g, `${cHdrLv}${cWOQLClient}`)
+    .replace(/## woqlLibrary\./g, `${cHdrLv}${cWOQLLib}`)
+    .replace(/## accessControl\./g, `${cHdrLv}${cAccessCtrl}`);
+}
+
 /*
  {
     "id": "WOQLClient",