Merge pull request #114 from terminusdb/depricConnect

Deprecated connect function

Author: Francesca-Bit

README.md

@@ -110,7 +110,7 @@ const bankerSchema = [
 
 async function createDataProduct(){
     try{
-        await client.connect()
+
         await client.createDatabase("banker", {label: "Banker Account", 
                                               comment: "Testing", schema: true})
         //add the schema documents

docs/README.md

@@ -1,21 +1,32 @@
-TerminusDB Client Javascript
-==========================
+[![TerminusDB JavaScript Client](https://assets.terminusdb.com/readmes/terminusdb-client-js/header.gif)][terminusdb-client-js-docs]
 
-[![Discord online](https://img.shields.io/discord/689805612053168129?color=7289da&logo=Discord&label=Discord%20chat)](https://discord.gg/yTJKAma)
-[![Discourse topics](https://img.shields.io/discourse/topics?color=yellow&logo=Discourse&server=https%3A%2F%2Fdiscuss.terminusdb.com%2F)](https://discuss.terminusdb.com/)
-[![Follow on Twitter](https://img.shields.io/twitter/follow/terminusdb?color=skyblue&label=Follow%20on%20Twitter&logo=twitter&style=flat)](https://twitter.com/TerminusDB)
+[terminusdb-client-js-docs]: https://terminusdb.github.io/terminusdb-client-js/
 
-**Development status ⚙️**
+---
 
-[![build status](https://api.travis-ci.com/terminusdb/terminusdb-client.svg?branch=main)](https://travis-ci.com/terminusdb/terminusdb-client)
-[![Coverage Status](https://coveralls.io/repos/github/terminusdb/terminusdb-client/badge.svg?branch=master)](https://coveralls.io/repos/github/terminusdb/terminusdb-client/badge.svg?branch=master)
+[![Discord](https://img.shields.io/discord/689805612053168129?label=Discord&logo=Discord&style=plastic)](https://discord.gg/yTJKAma)
+[![Discourse](https://img.shields.io/discourse/topics?color=yellow&logo=Discourse&server=https%3A%2F%2Fdiscuss.terminusdb.com%2F&style=plastic)](https://discuss.terminusdb.com/)
+[![Twitter](https://img.shields.io/twitter/follow/terminusdb?color=skyblue&label=Follow%20on%20Twitter&logo=twitter&style=flat)](https://twitter.com/TerminusDB)
 
-**NPM Package status 📦**
+[![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)
 
-[![npm version shields.io](https://img.shields.io/npm/v/@terminusdb/terminusdb-client?logo=npm)](https://www.npmjs.com/package/@terminusdb/terminusdb-client)
-[![PyPI download month](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.
 
-Promise based terminus client for the browser and node.js
+[**TerminusDB**][terminusdb] is an [open-source][terminusdb-repo] graph database
+and document store. It allows you to link JSON documents in a powerful knowledge
+graph all through a simple document API.
+
+[terminusdb]: https://terminusdb.com/
+[terminusdb-docs]: https://terminusdb.com/docs/
+[terminusdb-repo]: https://github.com/terminusdb/terminusdb
+
+**TerminusX** is a self-service data platform that allows you to build, deploy,
+execute, monitor, and share versioned data products. It is built on TerminusDB.
+TerminusX is in public beta and you can [sign up now][dashboard].
+
+[dashboard]: https://dashboard.terminusdb.com/
 
 ## Requirements
 
@@ -59,7 +70,7 @@ Download the terminusdb-client.min.js file from the /dist directory and save it
 This example creates a simple dataProduct, starting to create a database model the schema
 and insert a simple document
 
-For the [full Documentation](https://terminusdb.github.io/terminusdb-client-js/)
+For the [full Documentation][terminusdb-client-js-docs]
 
 ```javascript
 const TerminusClient = require("@terminusdb/terminusdb-client");
@@ -99,7 +110,7 @@ const bankerSchema = [
 
 async function createDataProduct(){
     try{
-        await client.connect()
+
         await client.createDatabase("banker", {label: "Banker Account", 
                                               comment: "Testing", schema: true})
         //add the schema documents
@@ -144,7 +155,7 @@ const client = new TerminusClient.WOQLClient("http://127.0.0.1:6363/", {
 
 ## API
 
-The API of the most recent release is documented at: <https://terminusdb.com/docs/v10.0/#/reference/reference-api>
+The TerminusDB API can be found at the [TerminusDB Documentation][terminusdb-docs].
 
 ## Report Issues
 

docs/_sidebar.md

@@ -1,7 +1,6 @@
 <!-- docs/_sidebar.md -->
 - [WOQLClient](api/woqlClient.js?id=WOQLClient)
   - [TerminusDB Client API](api/woqlClient.js?id=terminusdb-client-api)
-    - [Connect](api/woqlClient.js?id=connect)
     - [Create Database](api/woqlClient.js?id=create-database)
     - [Delete Database](api/woqlClient.js?id=delete-database)
     - [Get Triples](api/woqlClient.js?id=get-triples)

docs/api/woqlClient.js.md

@@ -20,7 +20,6 @@ For situations where you want to communicate with a TerminusDB server API, the W
 //to connect with your local terminusDB
 const client = new TerminusClient.WOQLClient(SERVER_URL,{user:"admin",key:"myKey"})
 async function getSchema() {
-     await client.connect()
      client.db("test")
      client.checkout("dev")
      const schema = await client.getSchema()
@@ -34,7 +33,6 @@ const client = new TerminusClient.WOQLClient('SERVER_CLOUD_URL/mycloudTeam',
 
 client.setApiKey(MY_ACCESS_TOKEN)
 async function getSchema() {
-     await client.connect()
      client.db("test")
      client.checkout("dev")
      const schema = await client.getSchema()
@@ -44,7 +42,9 @@ async function getSchema() {
 ### TerminusDB Client API
 
 ### Connect
-#### woqlClient.connect([params]) ⇒ <code>Promise</code>
+#### ~~woqlClient.connect([params]) ⇒ <code>Promise</code>~~
+***Deprecated***
+
 Connect to a Terminus server at the given URI with an API key
 Stores the system:ServerCapability document returned
 in the connection register which stores, the url, key, capabilities,
@@ -328,7 +328,7 @@ user has fields: [id, name, notes, author]
 
 ### databases
 #### woqlClient.databases([dbList]) ⇒ <code>array</code>
-Retrieves a list of databases (id, organization, label, comment) that the current user has access to on the server. Note that this requires the client to call connect() first.
+Retrieves a list of databases (id, organization, label, comment) that the current user has access to on the server.
 
 **Returns**: <code>array</code> - the user databases list  
 
@@ -343,7 +343,7 @@ const my_dbs = client.databases()
 
 ### userOrganizations
 #### woqlClient.userOrganizations([orgList]) ⇒ <code>array</code>
-Retrieves a list of databases (id, organization, label, comment) that the current user has access to on the server. Note that this requires the client to call connect() first.
+Retrieves a list of databases (id, organization, label, comment) that the current user has access to on the server.
 
 **Returns**: <code>array</code> - the user databases list  
 

lib/woqlClient.js

@@ -22,7 +22,6 @@ const { default: axios } = require('axios')
  * //to connect with your local terminusDB
  * const client = new TerminusClient.WOQLClient(SERVER_URL,{user:"admin",key:"myKey"})
  * async function getSchema() {
- *      await client.connect()
  *      client.db("test")
  *      client.checkout("dev")
  *      const schema = await client.getSchema()
@@ -36,7 +35,6 @@ const { default: axios } = require('axios')
  *                                           
  * client.setApiKey(MY_ACCESS_TOKEN)
  * async function getSchema() {
- *      await client.connect()
  *      client.db("test")
  *      client.checkout("dev")
  *      const schema = await client.getSchema()
@@ -149,7 +147,7 @@ WOQLClient.prototype.userOrganization = function() {
 
 
 /**
- * Retrieves a list of databases (id, organization, label, comment) that the current user has access to on the server. Note that this requires the client to call connect() first.
+ * Retrieves a list of databases (id, organization, label, comment) that the current user has access to on the server.
  * @param {array} [dbList] a list of databases the user has access to on the server, each having:
  * @returns {array} the user databases list
  * @example
@@ -161,7 +159,7 @@ WOQLClient.prototype.databases = function(dbList) {
 }
 
 /**
- * Retrieves a list of databases (id, organization, label, comment) that the current user has access to on the server. Note that this requires the client to call connect() first.
+ * Retrieves a list of databases (id, organization, label, comment) that the current user has access to on the server.
  * @param {array} [orgList] a list of databases the user has access to on the server, each having:
  * @returns {array} the user databases list
  * @example
@@ -346,6 +344,9 @@ WOQLClient.prototype.resource = function(resourceType, resourceId) {
  * and database meta-data for the connected server
  * this.connectionConfig.server will be used if present,
  * or the promise will be rejected.
+ * 
+ * @deprecated
+ * 
  * @param {typedef.ParamsObj} [params] - TerminusDB Server connection parameters
  * @returns {Promise}  the connection capabilities response object or an error object
  * @example