add fix

Author: Francesca-Bit

lib/connectionConfig.js

@@ -1,6 +1,6 @@
 /// /@ts-check
 // connectionConfig
-const { encodeURISegment } = require('./utils');
+const { encodeURISegment, URIEncodePayload } = require('./utils');
 
 /**
  * @file Terminus DB connection configuration
@@ -699,7 +699,6 @@ ConnectionConfig.prototype.prefixesURL = function () {
 ConnectionConfig.prototype.queryParameter = function (params) {
   if (!params || typeof params !== 'object') return '';
   const queryString = Object.keys(params).map((key) => `${key}=${encodeURISegment(params[key])}`).join('&');
-
   return `?${queryString}`;
 };
 

lib/dispatchRequest.js

@@ -151,6 +151,7 @@ function DispatchRequest(url, action, payload, local_auth, remote_auth = null, c
     case CONST.GET: {
       if (payload) {
         const ext = UTILS.URIEncodePayload(payload);
+        console.log('getPayload', payload, ext);
         // eslint-disable-next-line no-param-reassign
         if (ext) url += `?${ext}`;
       }

lib/typedef.js

@@ -25,6 +25,7 @@ const { ACTIONS } = Utils.ACTIONS;
  *@property {boolean} [as_list]  default is false, If true, don't return a stream of json objects,
  but a json list.
  *@property {string} [graph_type] - instance|schema default value is instance
+ *@property {object} [query] - object that descrive the document query
  */
 
 /**

lib/woqlClient.js

@@ -74,13 +74,6 @@ class WOQLClient {
   }
 }
 
-/* function WOQLClient(serverUrl, params) {
-  // current connection context variables
-  this.connectionConfig = new ConnectionConfig(serverUrl, params);
-  this.databaseList = [];
-  this.organizationList = [];
-} */
-
 /**
  * set the api key to access the cloud resources
  * @param {string} accessToken
@@ -1138,26 +1131,36 @@ WOQLClient.prototype.queryDocument = function (query, params, dbId, branch, last
 
 /**
  *
- * @param {typedef.DocParamsGet} [params] - the get parameters
+ * @param {typedef.DocParamsGet} [params] - the get parameters,
+ * you can pass document query search template with the params
  * @param {string} [dbId] - the database id
  * @param {string} [branch] - the database branch
  * @param {string} [lastDataVersion] the last data version tracking id.
  * @param {boolean} [getDataVersion] If true the function will return object having result
  * and dataVersion.
- * @param {object} [query] If a query object is provided, the function will use it to
- * query the database.
+ * @param {object} [query] document query search template
  * @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
  * //return the schema graph as a json array
- * client.getDocument({"graph_type":"schema","as_list":true})
+ * client.getDocument({"graph_type":"schema","as_list":true}).then(result={
+ *    console.log(result)
+ * })
  *
  * //retutn the Country class document from the schema graph
- * client.getDocument({"graph_type":"schema","as_list":true,"id":"Country"})
+ * client.getDocument({"graph_type":"schema","as_list":true,"id":"Country"}).then(result={
+ *    console.log(result)
+ * })
  *
+ * //pass a document query template to query the document interface
+ * const queryTemplate = { "name": "Ireland", "@type":"Country" }
+ * client.getDocument({"graph_type":"schema","as_list":true,
+ *            query:queryTemplate}).then(result=>{
+ *    console.log(result)
+ * })
  *
- * // Here we will pass true to show how to get dataVersion
  *
+ * // Here we will pass true to show how to get dataVersion
  * const response = await client.getDocument({"graph_type":"schema","as_list":true},
  *   "",
  *   "",
@@ -1192,12 +1195,19 @@ WOQLClient.prototype.getDocument = function (params, dbId, branch, lastDataVersi
   if (typeof lastDataVersion === 'string' && lastDataVersion !== '') {
     this.customHeaders({ 'TerminusDB-Data-Version': lastDataVersion });
   }
-
+  let queryDoc;
   if (query) {
+    queryDoc = query;
+  } else if (params && typeof params === 'object' && params.query) {
+    queryDoc = params.query;
+    delete params.query;
+  }
+  // if query we are send a get with a payload
+  if (queryDoc) {
     return this.dispatch(
       CONST.QUERY_DOCUMENT,
       this.connectionConfig.documentURL(params),
-      query,
+      queryDoc,
       getDataVersion,
     );
   }