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

Author: Kitty Jose

RELEASE_NOTES.md

@@ -1,3 +1,28 @@
+# TerminusDB Client v10.0.12
+
+## New 🚀
+
+* Add the ability to add additional diff options to the diff endpoint
+
+# TerminusDB Client v10.0.11
+
+## New 🚀
+
+* Generating type definitions for typescript by @Neelterminusdb in https://github.com/terminusdb/terminusdb-client-js/pull/185
+* Added create query parameter for update document by @Neelterminusdb in https://github.com/terminusdb/terminusdb-client-js/pull/189
+
+## Fixes 🛠
+
+* Fixed woql start by @Neelterminusdb in https://github.com/terminusdb/terminusdb-client-js/pull/184
+* Fixed bug in WOQL.doc not encoding lists by @Neelterminusdb in https://github.com/terminusdb/terminusdb-client-js/pull/191
+* Fixed woql docs by @Neelterminusdb in https://github.com/terminusdb/terminusdb-client-js/pull/194
+
+## Deprecated ☠️
+
+* Deprecated query document by @Neelterminusdb in https://github.com/terminusdb/terminusdb-client-js/pull/187
+
+<br/><br/>
+
 # TerminusDB Client v10.0.10
 
 ## New 🚀
@@ -9,19 +34,23 @@
 * Fix the way of sending tokens to the cloud api by @GavinMendelGleason in https://github.com/terminusdb/terminusdb-client-js/pull/182
 * Upgrade async library to prevent prototype pollution
 
+---
 
 # TerminusDB Client v10.0.9
 
 ## New 🚀
 
 * Add diff endpoint by @GavinMendelGleason in https://github.com/terminusdb/terminusdb-client-js/pull/178
 
+---
+
 # TerminusDB Client v10.0.8
 
 ## New 🚀
 
 * Add gzip compression by @rrooij in https://github.com/terminusdb/terminusdb-client-js/pull/167
 
+---
 
 # TerminusDB Client v10.0.7
 

docs/api/woql.md

@@ -76,7 +76,7 @@ Logical conjunction of the contained queries - all queries must match or the ent
 //a start_station Start, and that start_station is labeled Start_Label
 let [Journey, Start, Start_Label] = vars("Journey", "Start", "Start_Label")
 WOQL.and(
-     WOQL.triple(Journey, "type", "scm:Journey"),
+     WOQL.triple(Journey, "rdf:type", "@schema:Journey"),
      WOQL.triple(Journey, "start_station", Start),
      WOQL.triple(Start, "label", Start_Label))
 ```
@@ -195,7 +195,7 @@ Specifies the graph resource to write the contained query into
 **Example**  
 ```javascript
 //Subq is an argument or a chained query
-using("admin/minecraft").into("instance/main").add_triple("a", "type", "scm:X")
+using("admin/minecraft").into("instance/main").add_triple("a", "rdf:type", "@schema:X")
 //writes a single tripe (doc:a, rdf:type, scm:X) into the main instance graph
 ```
 
@@ -453,8 +453,8 @@ Deletes a single triple from the graph [Subject, Predicate, Object, Graph]
 
 **Example**  
 ```javascript
-remove the class Person from the schema/main graph
-WOQL.delete_quad("Person", "type", "owl:Class", "schema/main")
+remove the class Person from the schema graph
+WOQL.delete_quad("Person", "rdf:type", "sys:Class", "schema")
 ```
 
 ## add_triple
@@ -1051,7 +1051,7 @@ Creates a count of the results of the query
 **Example**  
 ```javascript
 let [count, Person] = vars("count", "Person")
-WOQL.count(count).triple(Person, "type", "scm:Person")
+WOQL.count(count).triple(Person, "rdf:type", "@schema:Person")
 ```
 
 ## typecast
@@ -1261,7 +1261,7 @@ optionally into the specified graph
 **Example**  
 ```javascript
 insert("mydoc", "MyType")
-//equivalent to add_triple("mydoc", "type", "MyType")
+//equivalent to add_triple("mydoc", "rdf:type", "@schema:MyType")
 ```
 
 ## graph

docs/api/woqlclient.md

@@ -1123,7 +1123,7 @@ async funtion callGetUserOrganizations(){
 ```
 
 ## getDiff
-##### woqlClient.getDiff(before, after) ⇒ <code>Promise</code>
+##### woqlClient.getDiff(before, after, options) ⇒ <code>Promise</code>
 Get the patch of difference between two documents.
 
 **Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.  
@@ -1132,6 +1132,7 @@ Get the patch of difference between two documents.
 | --- | --- | --- |
 | before | <code>object</code> | The current state of JSON document |
 | after | <code>object</code> | The updated state of JSON document |
+| options | <code>object</code> | [{}] - Options to send to the diff endpoint |
 
 **Example**  
 ```javascript
@@ -1142,7 +1143,7 @@ const diff = await client.getDiff(
 ```
 
 ## getVersionObjectDiff
-##### woqlClient.getVersionObjectDiff(id, beforeVersion, after) ⇒ <code>Promise</code>
+##### woqlClient.getVersionObjectDiff(id, beforeVersion, after, options) ⇒ <code>Promise</code>
 Get the patch of difference between two documents.
 
 **Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.  
@@ -1152,6 +1153,7 @@ Get the patch of difference between two documents.
 | id | <code>string</code> | The object id to be diffed |
 | beforeVersion | <code>string</code> | The version from which to compare the object |
 | after | <code>object</code> | The updated state of JSON document |
+| options | <code>object</code> | [{}] - Options to send to the diff endpoint |
 
 **Example**  
 ```javascript
@@ -1163,7 +1165,7 @@ const diff = await client.getVersionObjectDiff(
 ```
 
 ## getVersionDiff
-##### woqlClient.getVersionDiff(id, beforeVersion, afterVersion) ⇒ <code>Promise</code>
+##### woqlClient.getVersionDiff(id, beforeVersion, afterVersion, options) ⇒ <code>Promise</code>
 Get the patch of difference between two documents.
 
 **Returns**: <code>Promise</code> - A promise that returns the call response object, or an Error if rejected.  
@@ -1173,6 +1175,7 @@ Get the patch of difference between two documents.
 | id | <code>string</code> | The object id to be diffed |
 | beforeVersion | <code>string</code> | The version from which to compare the object |
 | afterVersion | <code>string</code> | The version to which to compare the object |
+| options | <code>object</code> | [{}] - Options to send to the diff endpoint |
 
 **Example**  
 ```javascript

lib/woql.js

@@ -83,7 +83,7 @@ WOQL.distinct = function (...varNames) {
  * //a start_station Start, and that start_station is labeled Start_Label
  * let [Journey, Start, Start_Label] = vars("Journey", "Start", "Start_Label")
  * WOQL.and(
- *      WOQL.triple(Journey, "type", "scm:Journey"),
+ *      WOQL.triple(Journey, "rdf:type", "@schema:Journey"),
  *      WOQL.triple(Journey, "start_station", Start),
  *      WOQL.triple(Start, "label", Start_Label))
  *
@@ -191,7 +191,7 @@ WOQL.from = function (graphRef, query) {
  * @returns {WOQLQuery} A WOQLQuery which will be written into the graph in question
  * @example
  * //Subq is an argument or a chained query
- * using("admin/minecraft").into("instance/main").add_triple("a", "type", "scm:X")
+ * using("admin/minecraft").into("instance/main").add_triple("a", "rdf:type", "@schema:X")
  * //writes a single tripe (doc:a, rdf:type, scm:X) into the main instance graph
  *
  */
@@ -424,8 +424,8 @@ WOQL.delete_triple = function (subject, predicate, object) {
  * @param {string} object - The IRI of a node or a variable, or a literal
  * @param {typedef.GraphRef} graphRef - A valid graph resource identifier string
  * @returns {WOQLQuery} - A WOQLQuery which contains the Delete Quad Statement
- * @example remove the class Person from the schema/main graph
- * WOQL.delete_quad("Person", "type", "owl:Class", "schema/main")
+ * @example remove the class Person from the schema graph
+ * WOQL.delete_quad("Person", "rdf:type", "sys:Class", "schema")
  */
 WOQL.delete_quad = function (subject, predicate, object, graphRef) {
   return new WOQLQuery().delete_quad(subject, predicate, object, graphRef);
@@ -975,7 +975,7 @@ WOQL.immediately = function (subquery) {
  * @returns {WOQLQuery} A WOQLQuery object containing the count sub Query
  * @example
  * let [count, Person] = vars("count", "Person")
- * WOQL.count(count).triple(Person, "type", "scm:Person")
+ * WOQL.count(count).triple(Person, "rdf:type", "@schema:Person")
  */
 WOQL.count = function (countVarName, subquery) {
   return new WOQLQuery().count(countVarName, subquery);
@@ -1186,7 +1186,7 @@ WOQL.node = function (nodeid, chainType) {
  * @returns {WOQLQuery} A WOQLQuery which contains the insert expression
  * @example
  * insert("mydoc", "MyType")
- * //equivalent to add_triple("mydoc", "type", "MyType")
+ * //equivalent to add_triple("mydoc", "rdf:type", "@schema:MyType")
  */
 WOQL.insert = function (classId, classType, graphRef) {
   return new WOQLQuery().insert(classId, classType, graphRef);

lib/woqlClient.js

@@ -1468,23 +1468,25 @@ WOQLClient.prototype.userOrganizations = function (orgList) {
  * Get the patch of difference between two documents.
  * @param {object} before - The current state of JSON document
  * @param {object} after - The updated state of JSON document
+ * @param {object} options [{}] - Options to send to the diff endpoint
  * @returns {Promise}  A promise that returns the call response object, or an Error if rejected.
  * @example
  *  const diff = await client.getDiff(
  *      { "@id": "Person/Jane", "@type": "Person", name: "Jane" },
  *      { "@id": "Person/Jane", "@type": "Person", name: "Janine" }
  *  );
  */
-WOQLClient.prototype.getDiff = function (before, after) {
+WOQLClient.prototype.getDiff = function (before, after, options) {
   if (typeof before !== 'object' || typeof after !== 'object') {
     const errmsg = '"before" or "after" parameter error - you must specify a valid before or after json document';
 
     return Promise.reject(
       new Error(ErrorMessage.getInvalidParameterMessage(CONST.GET_DIFF, errmsg)),
     );
   }
+  const opt = (typeof options === 'undefined') ? {} : options;
+  const payload = { before, after, ...opt };
 
-  const payload = { before, after };
   return this.dispatch(
     CONST.POST,
     `${this.connectionConfig.apiURL()}diff`,
@@ -1497,6 +1499,7 @@ WOQLClient.prototype.getDiff = function (before, after) {
  * @param {string} id - The object id to be diffed
  * @param {string} beforeVersion - The version from which to compare the object
  * @param {object} after - The updated state of JSON document
+ * @param {object} options [{}] - Options to send to the diff endpoint
  * @returns {Promise}  A promise that returns the call response object, or an Error if rejected.
  * @example
  *  const diff = await client.getVersionObjectDiff(
@@ -1505,16 +1508,18 @@ WOQLClient.prototype.getDiff = function (before, after) {
  *      { "@id": "Person/Jane", "@type": "Person", name: "Janine" }
  *  );
  */
-WOQLClient.prototype.getVersionObjectDiff = function (id, beforeVersion, after) {
+WOQLClient.prototype.getVersionObjectDiff = function (id, beforeVersion, after, options) {
   if (typeof id !== 'string' || typeof beforeVersion !== 'string' || typeof after !== 'object') {
     const errmsg = '"id", "beforeVersion" or "after" parameter error - you must specify a valid after json document and valid id and version';
 
     return Promise.reject(
       new Error(ErrorMessage.getInvalidParameterMessage(CONST.GET_DIFF, errmsg)),
     );
   }
-
-  const payload = { document_id: id, before_data_version: beforeVersion, after };
+  const opt = (typeof options === 'undefined') ? {} : options;
+  const payload = {
+    document_id: id, before_data_version: beforeVersion, after, ...opt,
+  };
   return this.dispatch(
     CONST.POST,
     this.connectionConfig.diffURL(),
@@ -1527,6 +1532,7 @@ WOQLClient.prototype.getVersionObjectDiff = function (id, beforeVersion, after)
  * @param {string} id - The object id to be diffed
  * @param {string} beforeVersion - The version from which to compare the object
  * @param {string} afterVersion - The version to which to compare the object
+ * @param {object} options [{}] - Options to send to the diff endpoint
  * @returns {Promise}  A promise that returns the call response object, or an Error if rejected.
  * @example
  *  const diff = await client.getVersionDiff(
@@ -1535,19 +1541,20 @@ WOQLClient.prototype.getVersionObjectDiff = function (id, beforeVersion, after)
  *      "branch:73rqpooz65kbsheuno5dsayh71x7wf4"
  *  );
  */
-WOQLClient.prototype.getVersionDiff = function (id, beforeVersion, afterVersion) {
+WOQLClient.prototype.getVersionDiff = function (id, beforeVersion, afterVersion, options) {
   if (typeof id !== 'string' || typeof beforeVersion !== 'string' || typeof afterVersion !== 'string') {
     const errmsg = '"id", "beforeVersion" or "after" parameter error - you must specify a valid after json document and valid id and version';
 
     return Promise.reject(
       new Error(ErrorMessage.getInvalidParameterMessage(CONST.GET_DIFF, errmsg)),
     );
   }
-
+  const opt = (typeof options === 'undefined') ? {} : options;
   const payload = {
     document_id: id,
     before_data_version: beforeVersion,
     after_data_version: afterVersion,
+    ...opt,
   };
   return this.dispatch(
     CONST.POST,

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@terminusdb/terminusdb-client",
-  "version": "10.0.10",
+  "version": "10.0.12",
   "description": "TerminusDB client library",
   "main": "index.js",
   "types": "./dist/typescript/index.d.ts",