Introduction

The client helpers core is the base component of the WebMAP's front-end architecture. It is responsible for managing the communication between the back-end server and the front-end. Also processes the information received and keep all the information about the control's models that are rendered in the client side.

Getting Started

1. Installation process

Once you have the repository downloaded and all the Software dependencies of section 2 are installed, go ahead and install all the dependencies using yarn:

Inside the root directory of this README execute yarn install or yarn in a command line.

For more information about yarn visit their website: Yarn

2. Software dependencies

Before you try to install the final dependencies of the project you'll need to set the npm registry and have the next ones:

• Node.js version 12 or greater Install
• npm registry can be set by executing the next command with Node.js installed: npm set registry http://ais-build-w7:81/npm/Frontend/ or npm set registry https://www.myget.org/F/mobilizenet/npm/
• Yarn: it can be installed by executing npm install -g yarn with Node.js installed.

3. API references

For a complete reference to the project documentation you can visit the next link:

ClientCore

Build and Test

To build the project, go to the root directory of the core project inside this repository, and then execute npm run build.

In case of testing, simply execute the npm script npm run test. This command already generates the coverage report files used by the TFS build process:

• TRX Report: test-results.trx
• Coverage Report (via cobertura): coverage/browser-name/coverage.xml

E2E Testing

To run e2e tests, follow the next steps:

Using npm link:

Execute the next commands in a cmd:

• cd path/to/ClientCore/core/package this means the location of the package.json inside the core project.
• npm link
• cd ./SamplesPATH this Samples can be the full path to the Samples or E2E directories inside WFNetKendo repository
• npm link @mobilize/webmap-core

And then follow the e2e instructions inside Samples or E2E README

Using the npm pack:

1. Build the project

2. Go to the root directory of the core project

3. run npm version x.x.x (x can be any number), this is just to put a version for the package

4. run npm pack

5. copy the path of the package (.tgz)

6. open ./package.json file that is located in the AngularClient/WebMap.Client.Angular folder and paste the path exactly in "@mobilize/webmap-core" value, just like this:

   "@mobilize/webmap-core": "path\to\the\package.tgz"

7. follow the e2e instructions inside AngularClient README

Folder Structure

root
└── dist:     compiled typescript, javascript and resources are placed here. 
└── src:      typescript source.
|   └── Application
|   └── Contract
|   └── Core
|   └── Server
|   └── System
|   └── UI
|   └── v5
└── test
|   └── features
|   └── userstories
└── typings

Main Modules

The modules also represent the main folder structure of the source directory.

• Application: app initialization and main point of contact with other modules.
• Contract: interfaces for all classes.
• Core: storage and handling of the models (in the view-model context).
• Server: encapsulates the communication with the web server.
• System: mainly for the handling of exceptions.
• UI: management of views (windows, modals, pop-ups).
• v5: classes that provide support for WebMAP 5 protocol.