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

Author: Kitty Jose

.github/workflows/ci.yml

@@ -32,10 +32,14 @@ jobs:
     - uses: actions/setup-node@v1
       with:
         node-version: 14
-    - name: Install and test
-      run: npm install-ci-test
-    - name: Build
-      run: npm run build
+    - name: Run terminusdb server
+      run: docker run --detach --publish 127.0.0.1:6363:6363 terminusdb/terminusdb-server:dev && sleep 3
+    - name: Install, build and test
+      run: |
+        npm ci
+        npm run build
+        npm run test
+        npm run test:integration
     - name: Lint
       run: npm run lint:check
     - name: Check for changes to docs
@@ -50,4 +54,4 @@ jobs:
     - name: Update coveralls
       uses: coverallsapp/github-action@master
       with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
+        github-token: ${{ secrets.GITHUB_TOKEN }}

RELEASE_NOTES.md

@@ -1,3 +1,21 @@
+# TerminusDB Client v10.0.22
+
+## New 🚀
+
+* Add Woql.boolean in WOQL class
+* Add Woql.date in WOQL class
+* Add Woql.datetime in WOQL class
+
+# TerminusDB Client v10.0.21
+
+## New 🚀
+
+* Add getOrganizationRemote in AccessControl class
+
+## Fixes 🛠
+
+* Replace coveralls with coveralls-next
+
 # TerminusDB Client v10.0.19
 
 ## New 🚀

docs/README.md

@@ -22,9 +22,7 @@ graph all through a simple document API.
 [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].
+**TerminusX** TerminusX is TerminusDB as a service. SOC 2 certified hosting. Build your beta and get to market fast. Scale up and deploy your own instance. [Sign up now][dashboard].
 
 [dashboard]: https://dashboard.terminusdb.com/
 
@@ -71,7 +69,7 @@ it to your sources, and use that in the `<script>` instead.
 This example creates a simple dataProduct, starting to create a database model the schema
 and insert a simple document
 
-For the [full Documentation][terminusdb-client-js-docs]
+For the [full Documentation](https://terminusdb.com/docs/guides/reference-guides/javascript-client-reference)
 
 ```javascript
 const TerminusClient = require("@terminusdb/terminusdb-client");

docs/_sidebar.md

@@ -18,6 +18,7 @@
     - [server](api/woqlClient.js?id=server)
     - [api](api/woqlClient.js?id=api)
     - [organization](api/woqlClient.js?id=organization)
+    - [hasDatabase](api/woqlClient.js?id=hasDatabase)
     - [getDatabases](api/woqlClient.js?id=getDatabases)
     - [databases](api/woqlClient.js?id=databases)
     - [user](api/woqlClient.js?id=user)
@@ -57,6 +58,7 @@
     - [getEnums](api/woqlClient.js?id=getEnums)
     - [getClassDocuments](api/woqlClient.js?id=getClassDocuments)
     - [getBranches](api/woqlClient.js?id=getBranches)
+    - [getCommitsLog](api/woqlClient.js?id=getCommitsLog)
     - [getPrefixes](api/woqlClient.js?id=getPrefixes)
     - [getUserOrganizations](api/woqlClient.js?id=getUserOrganizations)
     - [userOrganizations](api/woqlClient.js?id=userOrganizations)
@@ -65,6 +67,8 @@
     - [getVersionDiff](api/woqlClient.js?id=getVersionDiff)
     - [apply](api/woqlClient.js?id=apply)
     - [patch](api/woqlClient.js?id=patch)
+    - [sendCustomRequest](api/woqlClient.js?id=sendCustomRequest)
+- [WOQLClient](api/woqlClient.js?id=WOQLClient)
 - [WOQL](api/woql.js?id=WOQL)
   - [using](api/woql.js?id=using)
   - [comment](api/woql.js?id=comment)
@@ -91,7 +95,6 @@
   - [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)
@@ -153,6 +156,7 @@
   - [vars](api/woql.js?id=vars)
   - [doc](api/woql.js?id=doc)
   - [client](api/woql.js?id=client)
+  - [Vars](api/woql.js?id=Vars)
   - [emerge](api/woql.js?id=emerge)
   - [update_triple](api/woql.js?id=update_triple)
   - [update_quad](api/woql.js?id=update_quad)
@@ -211,6 +215,7 @@
   - [ActionType](api/typedef.js?id=ActionType)
   - [ParamsObj](api/typedef.js?id=ParamsObj)
   - [RolesObj](api/typedef.js?id=RolesObj)
+  - [ResourceType](api/typedef.js?id=ResourceType)
   - [RepoType](api/typedef.js?id=RepoType)
   - [DbDetails](api/typedef.js?id=DbDetails)
   - [RemoteRepoDetails](api/typedef.js?id=RemoteRepoDetails)

docs/api/accesscontrol.md

@@ -254,7 +254,7 @@ accessControl.deleteUser(userId).then(result=>{
 ```
 
 ## manageCapability
-##### accessControl.manageCapability(userName, resourceName, rolesArr, operation, resourceType) ⇒ <code>Promise</code>
+##### accessControl.manageCapability(userName, resourceName, rolesArr, operation, scopeType) ⇒ <code>Promise</code>
 -- TerminusdDB API ---
 Grant/Revoke Capability
 
@@ -266,7 +266,7 @@ Grant/Revoke Capability
 | resourceName | <code>string</code> | the name of a (database or team) |
 | rolesArr | <code>array</code> | the roles name list |
 | operation | <code>typedef.CapabilityCommand</code> | grant/revoke operation |
-| resourceType | <code>typedef.ResourceType</code> | the resource type (database or organization) |
+| scopeType | <code>typedef.ScopeType</code> | the resource type (database or organization) |
 
 **Example**  
 ```javascript
@@ -385,6 +385,25 @@ exists and 404: if the organization does not exist
 | orgName | <code>string</code> | The organization name to check if exists. |
 
 
+## createOrganizationRemote
+##### accessControl.createOrganizationRemote(orgName) ⇒ <code>Promise</code>
+-- TerminusX API ---
+IMPORTANT This does not work with the API-TOKEN.
+Create an organization
+
+**Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| orgName | <code>string</code> | The organization name to create |
+
+**Example**  
+```javascript
+accessControl.createOrganization("my_org_name").then(result=>{
+     console.log(result)
+})
+```
+
 ## getPendingOrgInvites
 ##### accessControl.getPendingOrgInvites([orgName]) ⇒ <code>Promise</code>
 -- TerminusX API ---

docs/api/typedef.md

@@ -12,6 +12,7 @@ the GET document interface query parameters
 
 | Name | Type | Description |
 | --- | --- | --- |
+| [query] | <code>object</code> | object that descrive the document query |
 | [graph_type] | <code>GraphType</code> | instance|schema, default value is instance. Used to switch between getting documents from the instance or the schema graph. |
 | [type] | <code>string</code> | only documents of the given type are returned. |
 | [id] | <code>string</code> | only the document with the given ID is returned. |
@@ -131,8 +132,8 @@ the DELETE document interface query parameters
 | [invitation] | <code>string</code> | - |
 
 
-## ResourceType
-##### ResourceType:  `  "database"` |  `  "organization" ` 
+## ScopeType
+##### ScopeType:  `  "database"` |  `  "organization" ` 
 
 ## RepoType
 ##### RepoType:  `  "local"` |  `  "remote" ` 

docs/api/woql.md

@@ -1359,6 +1359,54 @@ literal(1, "nonNegativeInteger")
 //returns { "@type": "xsd:nonNegativeInteger", "@value": 1 }
 ```
 
+## date
+##### WOQL.date(date) ⇒ <code>object</code>
+Generates explicitly a JSON-LD literal date from the imput
+
+**Returns**: <code>object</code> - - A JSON-LD literal date  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| date | <code>string</code> | any date format string (YYYY-MM-DD) |
+
+**Example**  
+```javascript
+date("2022-10-02")
+//returns { "@type": "xsd:date", "@value": "2022-10-02" }
+```
+
+## datetime
+##### WOQL.datetime(datetime) ⇒ <code>object</code>
+Generates explicitly a JSON-LD literal datetime from the imput
+
+**Returns**: <code>object</code> - - A JSON-LD literal datetime  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| datetime | <code>string</code> | any datetime format string (YYYY-MM-DDThh-mm-ssZ) |
+
+**Example**  
+```javascript
+datetime("2022-10-19T14:17:12Z")
+//returns { "@type": "xsd:dateTime", "@value": "2022-10-19T14:17:12Z" }
+```
+
+## boolean
+##### WOQL.boolean(bool) ⇒ <code>object</code>
+Generates explicitly a JSON-LD literal boolean from the input
+
+**Returns**: <code>object</code> - - A JSON-LD literal boolean  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| bool | <code>boolean</code> | true | false |
+
+**Example**  
+```javascript
+boolean(true)
+//returns { "@type": "xsd:boolean", "@value": true }
+```
+
 ## iri
 ##### WOQL.iri(val) ⇒ <code>object</code>
 Explicitly sets a value to be an IRI - avoiding automatic type marshalling