Merge branch 'canary' into rc

Author: rrooij

.ci/publish_gcloud.sh

@@ -0,0 +1,2 @@
+BRANCH=$1
+gsutil cp -r dist/* "gs://cdn.terminusdb.com/js_libs/terminusdb-client/${BRANCH}/"

.github/workflows/workflow.yml

@@ -19,6 +19,19 @@ jobs:
         node-version: 14
     - run: npm install
     - run: npm run build
-    - run: bash ".ci/publish_bintray.sh" "${GITHUB_REF##*/}"
+    - run: |
+        if [ $(echo "${{ github.ref }}" | grep -P "dev|canary") ]; then
+            bash ".ci/publish_bintray.sh" "${GITHUB_REF##*/}"
+        fi
       env:
         BINTRAY_API_TOKEN: ${{ secrets.BINTRAY_API_TOKEN }}
+    - name: Set up Cloud SDK
+      uses: google-github-actions/setup-gcloud@master
+      with:
+        project_id: ${{ secrets.GCP_PROJECT_ID }}
+        service_account_key: ${{ secrets.GCLOUD_TOKEN }}
+        export_default_credentials: true
+    - run: |
+        if [ $(echo "${{ github.ref }}" | grep -P "dev|canary") ]; then
+            bash ".ci/publish_gcloud.sh" "${GITHUB_REF##*/}"
+        fi

.gitignore

@@ -1,4 +1,9 @@
 package-lock.json
+docs/api/*.json
+
+.vscode
+
+local_test
 
 dist
 # Logs

.npmignore

@@ -1,6 +1,6 @@
 *.log
 npm-debug.log*
-
+docs
 public_pages
 
 # Coverage directory used by tools like istanbul

README.md

@@ -1,4 +1,4 @@
-# terminusdb-client
+# TerminusDB-Client
 
 [![build status](https://api.travis-ci.com/terminusdb/terminusdb-client.svg?branch=master)](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)
@@ -141,4 +141,4 @@ Please check [Contributing.md](Contributing.md) for more information.
 
 The APACHE 2.0 License
 
-Copyright (c) 2019
+Copyright (c) 2019

docs/.nojekyll

@@ -0,0 +1,146 @@
+# TerminusDB-Client
+
+[![build status](https://api.travis-ci.com/terminusdb/terminusdb-client.svg?branch=master)](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)
+
+Promise based terminus client for the browser and node.js
+
+## Requirements
+
+- [TerminusDB](https://github.com/terminusdb/terminusdb-server)
+- [NodeJS 8.1.4+](https://nodejs.org/en/)
+
+## 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.
+
+### NPM Module
+
+Before installing, download and install Node.js. Node.js 0.10 or higher is required.
+
+Installation is done using the npm install command:
+
+Using npm:
+
+```bash
+$ npm install --save @terminusdb/terminusdb-client
+```
+
+### Minified Script
+
+Using cdn:
+
+```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:
+
+```html
+<script src="http://my.saved.location/terminusdb-client.min.js"></script>
+```
+
+## Usage
+
+This example creates a simple Express.js server that will post an account to
+a database with the id "banker" and the default "admin" user with password "root"
+For the [full Documentation](https://terminusdb.com/docs/reference/js-client)
+
+```javascript
+const express = require("express");
+const app = express();
+const port = 3000;
+
+const TerminusClient = require("@terminusdb/terminusdb-client");
+
+// Connect and configure the TerminusClient
+const client = new TerminusClient.WOQLClient("https://127.0.0.1:6363/", {
+  db: "banker",
+  user: "admin",
+  key: "root",
+});
+
+//to change the starting settings
+client.db("banker01");
+client.organization("admin");
+
+async function postAccount() {
+  try {
+    const WOQL = TerminusClient.WOQL;
+    const query = WOQL.using("admin/banker").and(
+      WOQL.add_triple("doc:smog", "type", "scm:BankAccount"),
+      WOQL.add_triple("doc:smog", "owner", "smog"),
+      WOQL.add_triple("doc:smog", "balance", 999)
+    );
+    await client.connect();
+    client
+      .query(query, "adding smog's bank account")
+      .then((response) => {
+        return response;
+      })
+      .catch((err) => {
+        console.log("error", err);
+      });
+  } catch (err) {
+    console.error(err);
+  }
+}
+
+app.post("/account", (req, res) => {
+  postAccount().then((dbres) => res.send(JSON.stringify(dbres)));
+});
+
+app.listen(port, () => {
+  console.log(`Backend Server listening at http://localhost:${port}`);
+  client
+    .connect()
+    .then(function (response) {
+      // handle success
+      console.log(response);
+    })
+    .catch(function (error) {
+      // handle error
+      console.log(error);
+    });
+});
+```
+
+## Options
+
+connections options.
+
+To initialize `TerminusDB client` with custom options use
+
+```js
+const TerminusClient = require("@terminusdb/terminusdb-client");
+
+const client = new TerminusClient.WOQLClient("https://127.0.0.1:6363/", {
+  id: "test_db",
+  user: "admin",
+  key: "my_secret_key",
+});
+```
+
+## API
+
+The API is documented at: https://terminusdb.com/docs/reference/js-client/core/#terminusdb-client-api
+
+## Report Issues
+
+If you have encounter any issues, please report it with your os and environment setup, version that you are using and a simple reproducible case.
+
+If you encounter other questions, you can ask in our community [forum](https://community.terminusdb.com/) or [Slack channel](http://bit.ly/terminusdb-slack).
+
+## Contribute
+
+It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.
+
+Please check [Contributing.md](Contributing.md) for more information.
+
+## Licence
+
+The APACHE 2.0 License
+
+Copyright (c) 2019

docs/README.md

@@ -0,0 +1,191 @@
+<!-- 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)
+    - [Create Graph](api/woqlClient.js?id=create-graph)
+    - [Delete Graph](api/woqlClient.js?id=delete-graph)
+    - [Get Triples](api/woqlClient.js?id=get-triples)
+    - [Update Triples](api/woqlClient.js?id=update-triples)
+    - [Query](api/woqlClient.js?id=query)
+    - [Clonedb](api/woqlClient.js?id=clonedb)
+    - [Branch](api/woqlClient.js?id=branch)
+    - [Rebase](api/woqlClient.js?id=rebase)
+    - [Pull](api/woqlClient.js?id=pull)
+    - [Push](api/woqlClient.js?id=push)
+    - [Fetch](api/woqlClient.js?id=fetch)
+    - [Insert CSV](api/woqlClient.js?id=insert-csv)
+    - [Update CSV](api/woqlClient.js?id=update-csv)
+    - [Get CSV](api/woqlClient.js?id=get-csv)
+    - [Delete CSV](api/woqlClient.js?id=delete-csv)
+    - [copy](api/woqlClient.js?id=copy)
+    - [server](api/woqlClient.js?id=server)
+    - [api](api/woqlClient.js?id=api)
+    - [organization](api/woqlClient.js?id=organization)
+    - [user](api/woqlClient.js?id=user)
+    - [uid](api/woqlClient.js?id=uid)
+    - [userOrganization](api/woqlClient.js?id=userOrganization)
+    - [databases](api/woqlClient.js?id=databases)
+    - [databaseInfo](api/woqlClient.js?id=databaseInfo)
+    - [db](api/woqlClient.js?id=db)
+    - [setSystemDb](api/woqlClient.js?id=setSystemDb)
+    - [repo](api/woqlClient.js?id=repo)
+    - [checkout](api/woqlClient.js?id=checkout)
+    - [ref](api/woqlClient.js?id=ref)
+    - [localAuth](api/woqlClient.js?id=localAuth)
+    - [remoteAuth](api/woqlClient.js?id=remoteAuth)
+    - [author](api/woqlClient.js?id=author)
+    - [set](api/woqlClient.js?id=set)
+    - [resource](api/woqlClient.js?id=resource)
+    - [insertTriples](api/woqlClient.js?id=insertTriples)
+    - [message](api/woqlClient.js?id=message)
+    - [action](api/woqlClient.js?id=action)
+    - [info](api/woqlClient.js?id=info)
+    - [squashBranch](api/woqlClient.js?id=squashBranch)
+    - [resetBranch](api/woqlClient.js?id=resetBranch)
+    - [optimizeBranch](api/woqlClient.js?id=optimizeBranch)
+    - [deleteBranch](api/woqlClient.js?id=deleteBranch)
+    - [reset](api/woqlClient.js?id=reset)
+    - [dispatch](api/woqlClient.js?id=dispatch)
+    - [generateCommitInfo](api/woqlClient.js?id=generateCommitInfo)
+    - [generateCommitDescriptor](api/woqlClient.js?id=generateCommitDescriptor)
+    - [prepareRevisionControlArgs](api/woqlClient.js?id=prepareRevisionControlArgs)
+    - [_load_db_prefixes](api/woqlClient.js?id=_load_db_prefixes)
+    - [getClassFrame](api/woqlClient.js?id=getClassFrame)
+    - [updateDatabase](api/woqlClient.js?id=updateDatabase)
+    - [organizations](api/woqlClient.js?id=organizations)
+    - [action_permitted](api/woqlClient.js?id=action_permitted)
+    - [createUser](api/woqlClient.js?id=createUser)
+    - [getUser](api/woqlClient.js?id=getUser)
+    - [updateUser](api/woqlClient.js?id=updateUser)
+    - [deleteUser](api/woqlClient.js?id=deleteUser)
+    - [createOrganization](api/woqlClient.js?id=createOrganization)
+    - [getOrganization](api/woqlClient.js?id=getOrganization)
+    - [updateOrganization](api/woqlClient.js?id=updateOrganization)
+    - [deleteOrganization](api/woqlClient.js?id=deleteOrganization)
+    - [getRoles](api/woqlClient.js?id=getRoles)
+    - [updateRoles](api/woqlClient.js?id=updateRoles)
+- [WOQL](api/woql.js?id=WOQL)
+  - [eval](api/woql.js?id=eval)
+  - [using](api/woql.js?id=using)
+  - [comment](api/woql.js?id=comment)
+  - [select](api/woql.js?id=select)
+  - [distinct](api/woql.js?id=distinct)
+  - [and](api/woql.js?id=and)
+  - [or](api/woql.js?id=or)
+  - [from](api/woql.js?id=from)
+  - [into](api/woql.js?id=into)
+  - [triple](api/woql.js?id=triple)
+  - [added_triple](api/woql.js?id=added_triple)
+  - [removed_triple](api/woql.js?id=removed_triple)
+  - [quad](api/woql.js?id=quad)
+  - [added_quad](api/woql.js?id=added_quad)
+  - [removed_quad](api/woql.js?id=removed_quad)
+  - [sub](api/woql.js?id=sub)
+  - [eq](api/woql.js?id=eq)
+  - [substr](api/woql.js?id=substr)
+  - [update_object](api/woql.js?id=update_object)
+  - [delete_object](api/woql.js?id=delete_object)
+  - [read_object](api/woql.js?id=read_object)
+  - [get](api/woql.js?id=get)
+  - [put](api/woql.js?id=put)
+  - [as](api/woql.js?id=as)
+  - [remote](api/woql.js?id=remote)
+  - [file](api/woql.js?id=file)
+  - [post](api/woql.js?id=post)
+  - [delete_triple](api/woql.js?id=delete_triple)
+  - [delete_quad](api/woql.js?id=delete_quad)
+  - [add_triple](api/woql.js?id=add_triple)
+  - [add_quad](api/woql.js?id=add_quad)
+  - [when](api/woql.js?id=when)
+  - [trim](api/woql.js?id=trim)
+  - [evaluate](api/woql.js?id=evaluate)
+  - [plus](api/woql.js?id=plus)
+  - [minus](api/woql.js?id=minus)
+  - [times](api/woql.js?id=times)
+  - [divide](api/woql.js?id=divide)
+  - [div](api/woql.js?id=div)
+  - [exp](api/woql.js?id=exp)
+  - [floor](api/woql.js?id=floor)
+  - [isa](api/woql.js?id=isa)
+  - [like](api/woql.js?id=like)
+  - [less](api/woql.js?id=less)
+  - [greater](api/woql.js?id=greater)
+  - [opt](api/woql.js?id=opt)
+  - [unique](api/woql.js?id=unique)
+  - [idgen](api/woql.js?id=idgen)
+  - [upper](api/woql.js?id=upper)
+  - [lower](api/woql.js?id=lower)
+  - [pad](api/woql.js?id=pad)
+  - [split](api/woql.js?id=split)
+  - [member](api/woql.js?id=member)
+  - [concat](api/woql.js?id=concat)
+  - [join](api/woql.js?id=join)
+  - [sum](api/woql.js?id=sum)
+  - [start](api/woql.js?id=start)
+  - [limit](api/woql.js?id=limit)
+  - [re](api/woql.js?id=re)
+  - [length](api/woql.js?id=length)
+  - [not](api/woql.js?id=not)
+  - [once](api/woql.js?id=once)
+  - [immediately](api/woql.js?id=immediately)
+  - [count](api/woql.js?id=count)
+  - [typecast](api/woql.js?id=typecast)
+  - [order_by](api/woql.js?id=order_by)
+  - [group_by](api/woql.js?id=group_by)
+  - [true](api/woql.js?id=true)
+  - [path](api/woql.js?id=path)
+  - [size](api/woql.js?id=size)
+  - [triple_count](api/woql.js?id=triple_count)
+  - [type_of](api/woql.js?id=type_of)
+  - [star](api/woql.js?id=star)
+  - [all](api/woql.js?id=all)
+  - [node](api/woql.js?id=node)
+  - [insert](api/woql.js?id=insert)
+  - [schema](api/woql.js?id=schema)
+  - [graph](api/woql.js?id=graph)
+  - [add_class](api/woql.js?id=add_class)
+  - [add_property](api/woql.js?id=add_property)
+  - [delete_class](api/woql.js?id=delete_class)
+  - [delete_property](api/woql.js?id=delete_property)
+  - [doctype](api/woql.js?id=doctype)
+  - [insert_data](api/woql.js?id=insert_data)
+  - [insert_class_data](api/woql.js?id=insert_class_data)
+  - [insert_doctype_data](api/woql.js?id=insert_doctype_data)
+  - [insert_property_data](api/woql.js?id=insert_property_data)
+  - [nuke](api/woql.js?id=nuke)
+  - [query](api/woql.js?id=query)
+  - [json](api/woql.js?id=json)
+  - [string](api/woql.js?id=string)
+  - [literal](api/woql.js?id=literal)
+  - [iri](api/woql.js?id=iri)
+  - [vars](api/woql.js?id=vars)
+  - [client](api/woql.js?id=client)
+  - [emerge](api/woql.js?id=emerge)
+  - [update_triple](api/woql.js?id=update_triple)
+  - [update_quad](api/woql.js?id=update_quad)
+  - [value](api/woql.js?id=value)
+  - [link](api/woql.js?id=link)
+  - [makeEnum](api/woql.js?id=makeEnum)
+  - [generateChoiceList](api/woql.js?id=generateChoiceList)
+  - [updateChoiceList](api/woql.js?id=updateChoiceList)
+  - [deleteChoiceList](api/woql.js?id=deleteChoiceList)
+  - [libs](api/woql.js?id=libs)
+  - [boxClasses](api/woql.js?id=boxClasses)
+  - [GraphRef](api/typedef.js?id=GraphRef)
+  - [DataFormatObj](api/typedef.js?id=DataFormatObj)
+  - [FuntionType](api/typedef.js?id=FuntionType)
+  - [ClassObj](api/typedef.js?id=ClassObj)
+  - [PropertyObj](api/typedef.js?id=PropertyObj)
+  - [ResourceType](api/typedef.js?id=ResourceType)
+  - [GraphType](api/typedef.js?id=GraphType)
+  - [CredentialObj](api/typedef.js?id=CredentialObj)
+  - [ActionType](api/typedef.js?id=ActionType)
+  - [ParamsObj](api/typedef.js?id=ParamsObj)
+  - [RolesObj](api/typedef.js?id=RolesObj)
+  - [RepoType](api/typedef.js?id=RepoType)
+  - [DbDetails](api/typedef.js?id=DbDetails)
+  - [RemoteRepoDetails](api/typedef.js?id=RemoteRepoDetails)
+  - [CloneSourceDetails](api/typedef.js?id=CloneSourceDetails)
+