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

Author: Kitty Jose

docs/api/accesscontrol.md

@@ -4,8 +4,10 @@
 **License**: Apache Version 2  
 
 ## new AccessControl()
-The AccessControl object has various methods to control the access for users.
-for the credential you can use the JWT token or the API token
+The AccessControl is a driver to work with
+TerminusDB and TerminusX access control api
+for the credential you can use the JWT token, the API token or
+the basic authentication with username and password
 
 **Example**  
 ```javascript
@@ -92,6 +94,16 @@ Get a API url from cloudAPIUrl
 | cloudAPIUrl | <code>string</code> | The base url for cloud |
 
 
+## customHeaders
+##### accessControl.customHeaders(customHeaders) ⇒ <code>object</code>
+add extra headers to your request
+
+
+| Param | Type |
+| --- | --- |
+| customHeaders | <code>object</code> | 
+
+
 ## getAllOrganizations
 ##### accessControl.getAllOrganizations() ⇒ <code>Promise</code>
 -- TerminusDB API ---

docs/api/woql.md

@@ -1132,7 +1132,7 @@ Performs a path regular expression match on the graph
 | Param | Type | Description |
 | --- | --- | --- |
 | subject | <code>string</code> | An IRI or variable that refers to an IRI representing the subject, i.e. the starting point of the path |
-| pattern | <code>string</code> | (string) - A path regular expression describing a pattern through multiple edges of the graph Path regular expressions consist of a sequence of predicates and / or a set of alternatives, with quantification operators The characters that are interpreted specially are the following: | representing alternative choices , - representing a sequence of predcitates + - Representing a quantification of 1 or more of the preceding pattern in a sequence {min, max} - Representing at least min examples and at most max examples of the preceding pattern - Representing any predicate () - Parentheses, interpreted in the normal way to group clauses |
+| pattern | <code>string</code> | (string) - A path regular expression describing a pattern through multiple edges of the graph (see: https://terminusdb.com/docs/index/terminusx-db/how-to-guides/path-queries) |
 | object | <code>string</code> | An IRI or variable that refers to an IRI representing the object, i.e. ending point of the path |
 | [resultVarName] | <code>string</code> | A variable in which the actual paths traversed will be stored |
 

lib/accessControl.js

@@ -1,3 +1,4 @@
+/* eslint-disable no-underscore-dangle */
 const DispatchRequest = require('./dispatchRequest');
 const ErrorMessage = require('./errorMessage');
 const CONST = require('./const');
@@ -8,8 +9,10 @@ const typedef = require('./typedef');
  * @license Apache Version 2
  * @module AccessControl
  * @constructor AccessControl
- * @description The AccessControl object has various methods to control the access for users.
- * for the credential you can use the JWT token or the API token
+ * @description The AccessControl is a driver to work with
+ * TerminusDB and TerminusX access control api
+ * for the credential you can use the JWT token, the API token or
+ * the basic authentication with username and password
  * @example
  * //connect with the API token
  * //(to request a token create an account in  https://terminusdb.com/)
@@ -139,9 +142,23 @@ AccessControl.prototype.dispatch = function (requestUrl, action, payload) {
     action,
     payload,
     { type: this.apiType, key: this.apiKey, user: this.user },
+    null,
+    this.customHeaders(),
   );
 };
 
+/**
+ * add extra headers to your request
+ * @param {object} customHeaders
+ * @returns {object}
+ */
+
+// eslint-disable-next-line consistent-return
+AccessControl.prototype.customHeaders = function (customHeaders) {
+  if (customHeaders) this._customHeaders = customHeaders;
+  else return this._customHeaders;
+};
+
 /**
  * -- TerminusDB API ---
  * This end point works in basic authentication, admin user

lib/woql.js

@@ -1053,16 +1053,7 @@ WOQL.true = function () {
  * @param {string} subject -  An IRI or variable that refers to an IRI representing the subject,
  * i.e. the starting point of the path
  * @param {string} pattern -(string) - A path regular expression describing a pattern through
- * multiple edges of the graph
- * Path regular expressions consist of a sequence of predicates and / or a set of alternatives,
- * with quantification operators
- * The characters that are interpreted specially are the following:
- * | representing alternative choices
- * , - representing a sequence of predcitates
- * + - Representing a quantification of 1 or more of the preceding pattern in a sequence
- * {min, max} - Representing at least min examples and at most max examples of the preceding pattern
- * - Representing any predicate
- * () - Parentheses, interpreted in the normal way to group clauses
+ * multiple edges of the graph (see: https://terminusdb.com/docs/index/terminusx-db/how-to-guides/path-queries)
  * @param {string} object - An IRI or variable that refers to an IRI representing the object,
  * i.e. ending point of the path
  * @param {string} [resultVarName] - A variable in which the actual paths traversed will be stored

package.json

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

test/accessControl.spec.js

@@ -0,0 +1,18 @@
+const { expect } = require('chai');
+const AccessControl = require('../lib/accessControl');
+
+describe('AccessControl tests', () => {
+    const startServerUrl = 'http://localhost:6363/';
+    const organization = 'admin';
+    const user = 'admin';
+    const key ='mykey'
+
+    const accessContol = new AccessControl(startServerUrl,{user,organization,key})
+
+    it('check set headers in accessControl', () => {
+        const customHeaders = { "Custom-header-01":"test-headers", "Custom-header-02": "test"}
+        accessContol.customHeaders(customHeaders)
+        expect(accessContol.customHeaders()).to.eql(customHeaders);  
+    })
+
+})