Merge branch 'main' into fix_integration

Author: Francesca-Bit

docs/api/typedef.md

@@ -47,6 +47,7 @@ the PUT document interface query parameters
 | Name | Type | Description |
 | --- | --- | --- |
 | [raw_json] | <code>boolean</code> | default is false, If true, the input documents  are treated as raw JSON, inserted as type sys:JSONDocument and are not subject  to schema restrictions. |
+| [create] | <code>boolean</code> | If true, the function will create  a new document if it doesn't exist. |
 | [graph_type] | <code>GraphType</code> | default is instance, instance|schema Used to switch between  getting documents from the instance or the schema graph. |
 
 
@@ -60,7 +61,7 @@ the DELETE document interface query parameters
 | --- | --- | --- |
 | [graph_type] | <code>GraphType</code> | default is instance, instance|schema Used to switch between  getting documents from the instance or the schema graph. |
 | id | <code>string</code> \| <code>array</code> | a single id or a list of ids to delete. |
-| [nuke] | <code>booleam</code> | default is false, If true, delete everything at this resource  location (dangerous!). |
+| [nuke] | <code>boolean</code> | default is false, If true, delete everything at this resource  location (dangerous!). |
 
 
 ## GraphRef

docs/api/woql.md

@@ -1455,8 +1455,10 @@ const doc = WOQL.doc({ "@type": "Person", name: "Newperson" })
 ```
 
 ## client
-##### WOQL.client(client) ⇒ <code>WOQLClient</code>
-Gets/Sets woqlClient
+##### ~~WOQL.client(client) ⇒ <code>WOQLClient</code>~~
+***Deprecated***
+
+Use instead to run your query woqlclient.query('myWOQLQuery')
 
 
 | Param | Type |

docs/api/woqlclient.md

@@ -55,11 +55,8 @@ async function getSchema() {
 ##### ~~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,
-and database meta-data for the connected server
-this.connectionConfig.server will be used if present,
+You can call this to get the server info or override the start params
+configuration, this.connectionConfig.server will be used if present,
 or the promise will be rejected.
 
 **Returns**: <code>Promise</code> - the connection capabilities response object or an error object  
@@ -863,8 +860,8 @@ client.getDocument({"graph_type":"schema","as_list":true,"id":"Country"}).then(r
 })
 
 //pass a document query template to query the document interface
-const queryTemplate = { "name": "Ireland", "@type":"Country" }
-client.getDocument({"graph_type":"schema","as_list":true,
+const queryTemplate = { "name": "Ireland"}
+client.getDocument({"as_list":true, "@type":"Country"
            query:queryTemplate}).then(result=>{
    console.log(result)
 })
@@ -896,7 +893,7 @@ const response1 = await client.getDocument({"graph_type":"schema","as_list":true
 ```
 
 ## updateDocument
-##### woqlClient.updateDocument(json, [params], [dbId], [message], [lastDataVersion], [getDataVersion], [create]) ⇒ <code>Promise</code>
+##### woqlClient.updateDocument(json, [params], [dbId], [message], [lastDataVersion], [getDataVersion], [compress], [create]) ⇒ <code>Promise</code>
 **Returns**: <code>Promise</code> - A promise that returns the call response object or object having *result*
 and *dataVersion* object if ***getDataVersion*** parameter is true, or an Error if rejected.  
 
@@ -908,7 +905,8 @@ and *dataVersion* object if ***getDataVersion*** parameter is true, or an Error
 | [message] | <code>\*</code> | the update commit message |
 | [lastDataVersion] | <code>string</code> | the last data version tracking id. |
 | [getDataVersion] | <code>boolean</code> | If true the function will return object having result and dataVersion. |
-| [create] | <code>boolean</code> | If true, the function will create a new document if it doesn't exist. |
+| [compress] | <code>boolean</code> | If true, the function will create a new document if it doesn't exist. |
+| [create] | <code>boolean</code> | Perform an *upsert* which inserts if the document is not present (also works on nested documents) |
 
 **Example**  
 ```javascript
@@ -967,6 +965,17 @@ const response1 = await client.updateDocument(
       "",
       response.dataVersion
     );
+
+ // update a document and create the linked document together
+ // we are update the document "Person/Person01"
+ // and create a new document {"@type": "Person","name": "child01"} at the same time
+ const response1 = await client.updateDocument(
+     {
+      "@id": "Person/Person01",
+      "@type": "Person",
+      "name": "Person01"
+      "children":[{"@type": "Person","name": "child01"}]
+    },{create:true})
 ```
 
 ## deleteDocument

lib/query/woqlDoc.js

@@ -72,6 +72,12 @@ function convert(obj) {
  */
 function Var(name) {
   this.name = name;
+  this.json = function () {
+    return {
+      '@type': 'Value',
+      variable: this.name,
+    };
+  };
 }
 
 /**

lib/woqlClient.js

@@ -750,11 +750,10 @@ WOQLClient.prototype.squashBranch = function (branchId, commitMsg) {
 WOQLClient.prototype.resetBranch = function (branchId, commitId) {
   if (commitId && branchId) {
     // eslint-disable-next-line camelcase
-    const commit_descriptor = this.generateCommitDescriptor(commitId);
     return this.dispatch(
       CONST.RESET_BRANCH,
       this.connectionConfig.resetBranchUrl(branchId),
-      commit_descriptor,
+      { commit_descriptor: commitId },
     );
   }
   const errmsg = 'Branch parameter error - you must specify a valid new branch id and a commit message';
@@ -1227,7 +1226,9 @@ WOQLClient.prototype.getDocument = function (params, dbId, branch, lastDataVersi
  * @param {string} [lastDataVersion] the last data version tracking id.
  * @param {boolean} [getDataVersion] If true the function will return object having result
  * and dataVersion.
- * @param {boolean} [create] If true, the function will create a new document if it doesn't exist.
+ * @param {boolean} [compress] If true, the function will create a new document if it doesn't exist.
+ * @param {boolean} [create] Perform an *upsert* which inserts if the document
+ * is not present (also works on nested documents)
  * @returns {Promise}  A promise that returns the call response object or object having *result*
  * and *dataVersion* object if ***getDataVersion*** parameter is true, or an Error if rejected.
  * @example