Merge branch 'v6_restructure'

1. Update the application to the update version that includes all
dependencies, restructure project and README.md file

Author: Wasin Waeosri

.gitignore

@@ -1,5 +1,4 @@
 greeter.ts
 greeter.js
-package.json
-node_modules/
 greeter.html
+index_bulma.html

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2017 Thomson Reuters
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,63 @@
+# Elecktron WebSocket API with TypeScript Example
+## Overview
+
+[Elektron WebSocket API](https://developers.thomsonreuters.com/elektron/websocket-api-early-access) enables easy integration into a multitude of client technology environments such as scripting and web.  This API runs directly on your TREP infrastructure or the Thomson Reuters platform and presents data in an open (JSON) readable format. The API supports all Thomson Reuters Elektron data models and can be integrated into multiple client technology standards e.g. Python, R, .Net etc.
+
+[TypeScript](https://www.typescriptlang.org) programming language is a typed superset of JavaScript that compiles to readable, standards-based JavaScript. The language is designed for application-scale JavaScript by adding optional types, classes, modules, ECMAScript 2015 features and future proposals to JavaScript. TypeScript supports tools for large-scale JavaScript applications for any browser, for any host, on any OS. TypeScript is as a first-class programming language in Microsoft Visual Studio, [Angular](https://angularjs.org/) web application platform. It also supported by various application frameworks like [React](https://github.com/Microsoft/TypeScript-React-Starter#typescript-react-starter), [NodeJS and Express framework](https://github.com/Microsoft/TypeScript-Node-Starter#typescript-node-starter), [ASP.Net Core](https://www.typescriptlang.org/docs/handbook/asp-net-core.html), [Vue.js](https://github.com/Microsoft/TypeScript-Vue-Starter#typescript-vue-starter) and more. 
+
+This example shows how to implement the Elektron WebSocket API JavaScript web application with TypeScript. The web application source codes are implemented in TypeScript language to connect, consume and display data from the ADS server via the Elektron WebSocket API in the web browsers. All source codes will be compiled to readable JavaScript with [Webpack](https://webpack.js.org/) JavaScript module bundler.
+
+## Supported Web Browsers
+The example supports Chrome, Firefox and IE11 (based on the WebSocket and Web Workers browser supported platform).
+
+## Prerequisite
+This example requires the following dependencies softwares.
+1. [Node.js](https://nodejs.org/en/) - version 6.10 or higher.
+2. [npm](https://www.npmjs.com/) package manager (included in Node.js)
+2. [TypeScript](https://www.typescriptlang.org)
+
+This example also uses the following 3rd party libraries for UI presentation.
+1. [jQuery 3.2.1](https://jquery.com/) 
+2. [Bootstrap 3.3.7](https://getbootstrap.com/docs/3.3/)
+
+Both of jQuery and Bootstrap are distributed under the [MIT license](https://opensource.org/licenses/MIT). Please see more detail in the LICENSE.md file.
+
+## Package
+The project includes complete TypeScript source code, CSS files and all required static dependencies. The dynamic dependencies for compiling and building JavaScript source file are defined in *package.json* file which can be installed via ```npm install``` command.
+
+The project includes the following files and folder
+- *src/* folder: The folder that contains all TypeScript source files
+- *web/* folder: The folder that contains all application web page files
+    - *web/dist* folder: The folder that the compiled JavaScript file named *web_app.js* will be generated
+    - *web/index.html*: The application HTML page
+    - *web/css/cover.css*: The application CSS file
+    - *web/libs/jquery-3.2.1.min.js*: jQuery library file
+    - *web/bootstrap/css*, *web/bootstarp/fonts* and *web/bootstrap/js* folders: The folders for Bootstrap CSS and libraries files
+- package.json: Project's NPM dependencies file
+- tsconfig.json: Project's TypeSccript compiler options file
+- webpack.config.js: Project's Webpack compiler options file
+
+
+## How to run this example application
+1. Unzip or download the example project folder into a directory of your choice 
+2. Run ```$> npm install``` in the command prompt to install all the dependencies required to run the sample in a subdirectory called *node_modules/*.
+
+![npm command display](images/npm_install.png "npm command display")
+
+3. If the machine is behind a proxy server, you need to configure Node.js uses proxy instead of a direct HTTP connection via the following command in command prompt: ```set https_proxy=http://<proxy.server>:<port>```
+4. Run ```$> webpack``` in the command prompt to build and compile all TypeScript files in *src* into JavaScript source file (*/web/dist/* folder)
+
+![webpack command display](images/webpack.png "webpack command display")
+
+5. Copy and deploy the *web* folder into in any web server (recommend [http-server](https://www.npmjs.com/package/http-server) for quick dev/testing)
+6. Open web browser, then navigate to index.html of the web server (example for http-server: ```hhttp://localhost:8080/index.html```)  
+
+![application display](images/application.png "application display")
+
+## References
+For further details, please check out the following resources:
+* [Thomson Reuters Elektron WebSocket API page](https://developers.thomsonreuters.com/elektron/websocket-api-early-access) on the [Thomson Reuters Developer Community](https://developers.thomsonreuters.com/) web site.
+* [TypeScript programming language: Documentation](https://www.typescriptlang.org/docs/home.html).
+* [Mozilla Developer Network: Web Workers API page](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API)
+
+For any question related to this article or Elektron WebSocket API page, please use the Developer Community [Q&A Forum](https://community.developers.thomsonreuters.com/).

images/application.PNG

@@ -0,0 +1,20 @@
+{
+  "name": "elektron_ws_typescript",
+  "version": "1.0.0",
+  "description": "A simple project that demonstrates how to implement Elektron WebSocket with TypeScript",
+  "main": "index.html",
+  "dependencies": {
+    "@types/websocket": "0.0.34"
+  },
+  "devDependencies": {
+    "awesome-typescript-loader": "^3.4.0",
+    "source-map-loader": "^0.2.3",
+    "typescript": "^2.6.1",
+    "webpack": "^3.8.1"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Wasin Waeosri <wasin.waeosri@thomsonreuters.com> (https://developers.thomsonreuters.com/)",
+  "license": "MIT"
+}

images/npm_install.png

@@ -0,0 +1,84 @@
+import { JSONLogin } from "./json_msg_interface";
+import { JSONLoginKey } from "./json_msg_interface";
+import { JSONLoginKeyElements } from "./json_msg_interface";
+
+import { JSONItemRequestMsg } from "./json_msg_interface";
+import { JSONItemRequestKey } from "./json_msg_interface";
+
+import { JSONClose } from "./json_msg_interface";
+
+export { LoginMsg };
+export { ItemRequestMsg };
+export {CloseMsg};
+
+const loginDomain: string = "Login";
+
+class LoginMsg implements JSONLogin {
+  Id: number;
+  Domain: string = loginDomain;
+  Key: JSONLoginKey;
+
+  constructor(
+    Id: number,
+    Name: string,
+    ApplicationId: string,
+    Position: string
+  ) {
+    this.Id = Id;
+    let loginMsgKey_class = new LoginMsgKey(Name, ApplicationId, Position);
+    this.Key = loginMsgKey_class;
+  }
+}
+
+class LoginKeyElements implements JSONLoginKeyElements {
+  ApplicationId: string;
+  Position: string;
+  constructor(ApplicationId: string, Position: string) {
+    this.ApplicationId = ApplicationId;
+    this.Position = Position;
+  }
+}
+
+class LoginMsgKey implements JSONLoginKey {
+  Name: string;
+  Elements: JSONLoginKeyElements;
+  constructor(Name: string, ApplicationId: string, Position: string) {
+    this.Name = Name;
+    let loginKeyElements_class = new LoginKeyElements(ApplicationId, Position);
+    this.Elements = loginKeyElements_class;
+  }
+}
+
+class ItemRequestMsg implements JSONItemRequestMsg {
+  Id: number;
+  Key: JSONItemRequestKey;
+  constructor(Id: number, Name: string, Service: string) {
+    this.Id = Id;
+    let itemrequestKey_class = new ItemRequestMsgKey(Name, Service);
+    this.Key = itemrequestKey_class;
+  }
+}
+
+class ItemRequestMsgKey implements JSONItemRequestKey {
+  Name: string;
+  Service: string;
+
+  constructor(Name: string, Service: string) {
+    this.Name = Name;
+    this.Service = Service;
+  }
+}
+
+
+class CloseMsg implements JSONClose{
+  Domain?: string;
+  Id: number;
+  Type: string;
+
+  constructor(Id: number, Domain?: string) {
+    this.Id = Id;
+    this.Domain = Domain;
+    this.Type = "Close";
+  }
+
+}

images/webpack.PNG

@@ -0,0 +1,37 @@
+//Interface for Login domain JSON message
+export interface JSONLogin {
+    Id:number;
+    Domain:string;
+    Key: JSONLoginKey;
+}
+
+//Interface for Login domain's Key attribute JSON message
+export interface JSONLoginKey{
+    Elements: JSONLoginKeyElements;
+    Name: string;
+}
+
+//Interface for Login domain's Key's Elements attribute JSON message
+export interface JSONLoginKeyElements{
+    ApplicationId: string;
+    Position: string;
+}
+
+//Interface for Market Price domain item request JSON message
+export interface JSONItemRequestMsg {
+    Id: number;
+    Key: JSONItemRequestKey;
+}
+
+//Interface for Market Price domain item request's key attribute JSON message
+export interface JSONItemRequestKey {
+    Name: string;
+    Service: string;
+}
+
+//Interface for close JSON message
+export interface JSONClose {
+    Domain?: string;
+    Id: number;
+    Type: string;
+}