fixed modify document functions in WOQL (#111)

Author: Neelterminusdb

docs/_sidebar.md

@@ -148,6 +148,7 @@
   - [literal](api/woql.js?id=literal)
   - [iri](api/woql.js?id=iri)
   - [vars](api/woql.js?id=vars)
+  - [doc](api/woql.js?id=doc)
   - [client](api/woql.js?id=client)
   - [emerge](api/woql.js?id=emerge)
   - [update_triple](api/woql.js?id=update_triple)

docs/api/woql.js.md

@@ -100,17 +100,24 @@ Use [read_document](#read_document) instead.
 
 
 ## read_document
-##### WOQL.read\_document(IRI, output, formatObj) ⇒ <code>object</code>
+##### WOQL.read\_document(IRI, output) ⇒ <code>object</code>
 Read a node identified by an IRI as a JSON-LD document
 
 **Returns**: <code>object</code> - WOQLQuery  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| IRI | <code>string</code> | The document id  or a variable |
-| output | <code>string</code> | variable name |
-| formatObj | <code>object</code> |  |
+| IRI | <code>string</code> | The document id  or a variable to read |
+| output | <code>string</code> | Variable which will be bound to the document. |
 
+**Example**  
+```js
+const query = WOQL.read_document(
+     "Person/0b4feda109d9d13c9da809090b342ad9e4d8185545ce05f7cd20b97fe458f547",
+     "v:Person"
+);
+const res =  await client.query(query);
+```
 
 ## insert_document
 ##### WOQL.insert\_document(docjson, [IRI]) ⇒ <code>object</code>
@@ -123,6 +130,12 @@ Insert a document in the graph.
 | docjson | <code>object</code> | The document to insert. Must either have an '@id' or have a class specified key. |
 | [IRI] | <code>string</code> | An optional identifier specifying the document location. |
 
+**Example**  
+```js
+const res = await client.query(
+   WOQL.insert_document(WOQL.doc({ "@type" : "Person", "label": "John" }))
+)
+```
 
 ## update_document
 ##### WOQL.update\_document(docjson, [IRI]) ⇒ <code>object</code>
@@ -1367,6 +1380,22 @@ const [a, b, c] = WOQL.vars("a", "b", "c")
 //a, b, c are javascript variables which can be used as WOQL variables in subsequent queries
 ```
 
+## doc
+##### WOQL.doc(object) ⇒ <code>object</code>
+Produces an encoded form of a document that can be used by a WOQL operation
+such as `WOQL.insert_document`.
+
+**Returns**: <code>object</code> - The encoded document  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| object | <code>object</code> | Document to encode |
+
+**Example**  
+```js
+const doc = WOQL.doc({ "@type": "Person", name: "Newperson" })
+```
+
 ## client
 ##### WOQL.client(client) ⇒ <code>WOQLClient</code>
 Gets/Sets woqlClient

lib/query/woqlCore.js

@@ -37,6 +37,7 @@ function WOQLQuery(query) {
     'DeleteTriple',
     'AddQuad',
     'DeleteQuad',
+    'InsertDocument',
     'DeleteDocument',
     'UpdateDocument',
   ];

lib/query/woqlDoc.js

@@ -1,4 +1,3 @@
-/* eslint-disable no-restricted-syntax */
 // eslint-disable-next-line consistent-return
 function convert(obj) {
   if (obj == null) {
@@ -29,6 +28,7 @@ function convert(obj) {
     };
   } if (typeof (obj) === 'object') {
     const pairs = [];
+    // eslint-disable-next-line no-restricted-syntax
     for (const [key, value] of Object.entries(obj)) {
       pairs.push({
         '@type': 'FieldValuePair',
@@ -37,8 +37,11 @@ function convert(obj) {
       });
     }
     return {
-      '@type': 'DictionaryTemplate',
-      data: pairs,
+      '@type': 'Value',
+      dictionary: {
+        '@type': 'DictionaryTemplate',
+        data: pairs,
+      },
     };
   }
 }

lib/query/woqlQuery.js

@@ -20,24 +20,20 @@ const WOQLQuery = require('./woqlCore');
     }
 } */
 
-WOQLQuery.prototype.read_document = function (IRI, OutputVar, Format) {
+WOQLQuery.prototype.read_document = function (IRI, OutputVar) {
   if (this.cursor['@type']) this.wrapCursorWithAnd();
   this.cursor['@type'] = 'ReadDocument';
   this.cursor.identifier = this.cleanNodeValue(IRI);
   this.cursor.document = this.expandValueVariable(OutputVar);
-  return this.wform(Format);
+  return this;
 };
 
 WOQLQuery.prototype.insert_document = function (docjson, IRI) {
   if (this.cursor['@type']) this.wrapCursorWithAnd();
   this.cursor['@type'] = 'InsertDocument';
   if (typeof IRI !== 'undefined') this.cursor.identifier = this.cleanNodeValue(IRI);
 
-  if (typeof docjson === 'string') {
-    this.cursor.document = this.expandValueVariable(docjson);
-  } else {
-    this.cursor.document = docjson;
-  }
+  this.cursor.document = this.cleanObject(docjson);
 
   return this.updated();
 };
@@ -47,11 +43,7 @@ WOQLQuery.prototype.update_document = function (docjson, IRI) {
   this.cursor['@type'] = 'UpdateDocument';
   if (typeof IRI !== 'undefined') this.cursor.identifier = this.cleanNodeValue(IRI);
 
-  if (typeof docjson === 'string') {
-    this.cursor.document = this.expandValueVariable(docjson);
-  } else {
-    this.cursor.document = docjson;
-  }
+  this.cursor.document = this.cleanObject(docjson);
 
   return this.updated();
 };

lib/woql.js

@@ -3,7 +3,7 @@
 /// /@ts-check
 // I HAVE TO REVIEW THE Inheritance and the prototype chain
 const WOQLQuery = require('./query/woqlBuilder');
-const { Var } = require('./query/woqlDoc');
+const { Var, Doc } = require('./query/woqlDoc');
 /**
  * @license Apache Version 2
  * @module WOQL
@@ -102,14 +102,19 @@ WOQL.read_object = function (IRI, output, formatObj) {
 
 /**
  * Read a node identified by an IRI as a JSON-LD document
- * @param {string} IRI -  The document id  or a variable
- * @param {string} output - variable name
- * @param {object} formatObj
+ * @param {string} IRI -  The document id  or a variable to read
+ * @param {string} output - Variable which will be bound to the document.
  * @return {object} WOQLQuery
+ * @example
+ * const query = WOQL.read_document(
+ *      "Person/0b4feda109d9d13c9da809090b342ad9e4d8185545ce05f7cd20b97fe458f547",
+ *      "v:Person"
+ * );
+ * const res =  await client.query(query);
  */
 
-WOQL.read_document = function (IRI, output, formatObj) {
-  return new WOQLQuery().read_document(IRI, output, formatObj);
+WOQL.read_document = function (IRI, output) {
+  return new WOQLQuery().read_document(IRI, output);
 };
 
 /**
@@ -118,6 +123,10 @@ WOQL.read_document = function (IRI, output, formatObj) {
  * have a class specified key.
  * @param {string} [IRI] - An optional identifier specifying the document location.
  * @return {object} WOQLQuery
+ * @example
+ * const res = await client.query(
+ *    WOQL.insert_document(WOQL.doc({ "@type" : "Person", "label": "John" }))
+ * )
  */
 
 WOQL.insert_document = function (docjson, IRI) {
@@ -1264,6 +1273,19 @@ WOQL.vars = function (...varNames) {
   return varNames.map((item) => new Var(item));
 };
 
+/**
+ * Produces an encoded form of a document that can be used by a WOQL operation
+ * such as `WOQL.insert_document`.
+ * @param  {object} object - Document to encode
+ * @returns {object} The encoded document
+ * @example
+ * const doc = WOQL.doc({ "@type": "Person", name: "Newperson" })
+ */
+
+WOQL.doc = function (object) {
+  return new Doc(object);
+};
+
 /**
  * Gets/Sets woqlClient
  * @param {WOQLClient}