Added HelpCenterQuery npm

Author: sponzillo

tiledesk-chatbot-util/test/test_parse_directives.js

@@ -149,4 +149,20 @@ JUST WAIT A MOMENT`);
         assert(result.findDirective("Dir2NoParam").name === "Dir2NoParam");
         assert(result.findDirective("Dir3").name === "Dir3");
     });
+
+    it('Finds 1 directive', function() {
+        const msg = "Andrea\n\\_tdWhenOfflineHours reply_with:offline_message";
+        let result = TiledeskChatbotUtil.parseDirectives(msg);
+        console.log("result:", JSON.stringify(result));
+        console.log("directives:", JSON.stringify(result.directives));
+        assert(result != null);
+        assert(result.directives != null);
+        assert.strictEqual(result.directives.length, 1);
+        assert(result.directives[0]);
+        
+        assert(result.directives[0].name === "WhenOfflineHours");
+        assert(result.directives[0].parameter === "reply_with:offline_message");
+        assert(result.text.trim() === "Andrea");
+        assert(result.findDirective("WhenOfflineHours").name === "WhenOfflineHours");
+    });
 });

tiledesk-helpcenter-client/.env

@@ -0,0 +1,8 @@
+EMAIL=[email protected]
+PASSWORD=testtest
+PROJECT_ID=630858150da8e800358687cf
+PROJECT_NAME=HelpCenter Test
+WORKSPACE_ID=6308582654a7290023c4a3cf
+API_ENDPOINT=https://tiledesk-cms-server-prod.herokuapp.com
+APIKEY=____TODO____
+LOG_STATUS=false

tiledesk-helpcenter-client/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Client library for Helpcenter query REST APIs
+
+This library is on npm: https://www.npmjs.com/package/@tiledesk/helpcenter-query-client
+
+
+### 0.1.4
+- Added README.md
+
+### 0.1.3
+- first public release

tiledesk-helpcenter-client/README.md

@@ -0,0 +1,103 @@
+Full [NodeJS API reference](https://tiledesk.github.io/tiledesk-nodejs-libs/TiledeskClient.html) is hosted on Github
+
+# Introduction
+
+Follow this guide to use the Tiledesk Helpcenter JavaScript SDK in your ``Node.js`` application.
+
+Before you can add Tiledesk Helpcenter npm lib to your Node.js app, you need a [Tiledesk account](https://docs.tiledesk.com/knowledge-base/creating-a-tiledesk-account/) and a [Tiledesk project](https://docs.tiledesk.com/knowledge-base/creating-a-tiledesk-account/). Once you create your project you will have a _projectID_, a _user_ to play with project APIs.
+Next you must create your own Helpcenter workspace (in one Tiledesk project you can create more Workspaces)
+
+# Add Helpcenter to your project
+
+Install ``HelpCenterQuery`` library with *npm* command:
+
+```
+npm install @tiledesk/helpcenter-query-client
+```
+
+Alternatively use package.json to import the library in the "dependencies" property, as in the following example:
+
+```json
+{
+  "name": "Hello Tiledesk nodeJS",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "node index.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@tiledesk/helpcenter-query-client": "^0.1.3"
+  }
+}
+```
+
+Then run
+
+```
+npm install
+```
+
+Once installed you can import ```HelpCenterQuery()``` class in your Node.js file using the "require" command:
+
+```
+const { HelpCenterQuery } = require('@tiledesk/helpcenter-query-client');
+```
+
+# The HelpCenterQuery class
+
+To interact with Tiledesk Helpcenter APIs and query your documents you need to create an instance of a HelpCenterQuery() class using his constructor. You MUST supply an *APIKEY*, an existing *Project ID* and a valid *Workspace ID*.
+
+Please refer to the official [Tiledesk Help Center guide](https://gethelp.tiledesk.com/articles/getting-started-with-help-center/) to better understand how Help Center works and how to get your *Workspace ID*.
+
+In the next example we first authenticate using our user credentials, then we create a new TiledeskClient instance using a ``PROJECT_ID`` and the ``token`` we got from authentication:
+
+```javascript
+const helpcenter = new HelpCenterQuery({
+  APIKEY: "__",
+  projectId: "YOUR_PROJECT_ID",
+  workspaceId: "YOUR_HELPCENTER_WORKSPACE_ID",
+  log: false
+});
+```
+
+# Query your Helpcenter Workspace
+
+Once you created your Helpcenter instance you can query your workspace as in the following example:
+
+```javascript
+const helpcenter = new HelpCenterQuery({
+    APIKEY: APIKEY,
+    projectId: PROJECT_ID,
+    workspaceId: WORKSPACE_ID
+});
+text_to_search = "military";
+maxresults = 3;
+helpcenter.search(text_to_search, maxresults, (err, results) => {
+    console.log("results:", results)
+    assert(results[0].title)
+    assert(results[0].score)
+    assert(results[0].url)
+});
+```
+
+### Specify the API endpoint in instance methods
+
+If instead you are using instance methods working with an instance of TiledeskClient, you must specify the parameter in the constructor config object as config.APIRUL:
+
+```javascript
+const helpcenter = new HelpCenterQuery({
+  APIKEY: APIKEY,
+  projectId: PROJECT_ID,
+  workspaceId: WORKSPACE_ID,
+  APIURL: API_ENDPOINT,
+  log: true
+});
+```
+
+
+

tiledesk-helpcenter-client/docbuild.sh

@@ -0,0 +1 @@
+jsdoc index.js -d ../docs

tiledesk-helpcenter-client/index.js

@@ -0,0 +1,129 @@
+let axios = require('axios');
+let https = require("https");
+
+class HelpCenterQuery {
+
+  static DEFAULT_API_ENDPOINT = "https://tiledesk-cms-server-prod.herokuapp.com";
+  
+  /**
+   * Constructor for HelpCenterQuery Client object
+   *
+   * @example
+   * const { HelpCenterQuery } = require('@tiledesk/helpcenter-query-client');
+   * const helpcenter = new HelpCenterQuery({APIKEY: 'THE_API_KEY', projectId: 'YOUR_PROJECT_ID', workspaceId: 'HELPCENTER_WORKSPACE'});
+   * const helpcenter = new HelpCenterQuery({APIKEY: 'THE_API_KEY', projectId: 'YOUR_PROJECT_ID', workspaceId: 'HELPCENTER_WORKSPACE', APIURL: 'OPTIONAL_SELF_HOSTED_INSTANCE_ENDPOINT', log: "OPTIONAL BOOLEAN true/false"});
+   * @param {Object} options JSON configuration.
+   * @param {string} options.APIKEY Mandatory. Tiledesk APIKEY
+   * @param {string} options.projectId Mandatory. Tiledesk projectId. Will be used in each call on project's APIs.
+   * @param {string} options.APIURL Optional. Tiledesk server API endpoint.
+   * @param {boolean} options.log Optional. If true HTTP requests are logged.
+   */
+  constructor(options) {
+    if (!options) {
+      throw new Error('options.APIKEY, options.projectId and options.token are mandatory.');
+    }
+
+    if (!options.APIKEY) {
+      throw new Error('options.APIKEY can NOT be null.');
+    }
+    else {
+      this.APIKEY = options.APIKEY;
+    }
+
+    if (options && options.APIURL) {
+      this.APIURL = options.APIURL
+    }
+    else {
+      this.APIURL = HelpCenterQuery.DEFAULT_API_ENDPOINT;
+    }
+
+    if (!options.projectId) {
+      throw new Error('options.projectId can NOT be null.');
+    }
+    else {
+      this.projectId = options.projectId;
+    }
+
+    if (!options.workspaceId) {
+      throw new Error('options.workspaceId can NOT be null.');
+    }
+    else {
+      this.workspaceId = options.workspaceId;
+    }
+
+    this.log = false;
+    if (options.log) {
+      this.log = options.log;
+    }
+  }
+
+  search(text, maxResults, callback) {
+
+    const escaped_text = encodeURI(text);
+    var url = this.APIURL + `/${this.projectId}/${this.workspaceId}/contents/search?text=${escaped_text}&maxresults=${maxResults}`
+
+    const HTTPREQUEST = {
+      url: url,
+      headers: {
+      },
+      method: 'GET'
+    };
+    this.myrequest(
+      HTTPREQUEST,
+      function(err, resbody) {
+        if (err) {
+          if (callback) {
+            callback(err);
+          }
+        }
+        else {
+          if (callback) {
+            callback(null, resbody);
+          }
+        }
+      }, this.log
+    );
+  }
+
+  myrequest(options, callback, log) {
+    //console.log("API URL:", options.url);
+    //console.log("** Options:", options);
+    const httpsAgent = new https.Agent({
+      rejectUnauthorized: false,
+    });
+    axios(
+      {
+        url: options.url,
+        method: options.method,
+        data: options.json,
+        httpsAgent: httpsAgent,
+        headers: options.headers
+      })
+    .then(function (res) {
+      if (log) {
+        console.log("Response for url:", options.url);
+        console.log("Response headers:\n", res.headers);
+        console.log("******** Response for url:", res);
+        console.log("Response body:\n", res.data);
+      }
+      if (res && res.status == 200 && res.data) {
+        if (callback) {
+          callback(null, res.data);
+        }
+      }
+      else {
+        if (callback) {
+          callback(TiledeskClient.getErr({message: "Response status not 200"}, options, res), null, null);
+        }
+      }
+    })
+    .catch(function (error) {
+      console.error("An error occurred:", error);
+      if (callback) {
+        callback(error, null, null);
+      }
+    });
+  }
+}
+
+module.exports = { HelpCenterQuery };