Mx Model Sdk
Client Sdk to access Mx Model Server.
Installation:
> npm install
Build:
> npm run build
Run tests:
> npm test
Library architicture
MxSdkClient
: Maintains the server connection url and expose theDomainModel
to the outside world.DomainModel
: Is the umbrella for all Mx models. In addition, handles model operations likecreate
,load
,commit
.models/domainmodels
: Contains the interfaces & implementations for Mx models.services/RestService
: Helper class for different HTTP operations.
Unit tests:
test/mx-model-sdk-tests
contains unit Tests for the main functionality of the Sdk.
nock
used to isolate the Sdk testing from the server.
The assessment test (Removes Company
& Change WebSite
name) is included.
Dependencies
Runtime Dependencies
- request/request-promise: For making server rquests in
promise
style. - fast-json-patch: For observing the model changes and generate delta patches.
Development Dependencies
- tslint: For ensure coding standards.
- mocha: The primary test framework.
- chai: For tests assertion.
- nock: For mocking the server http calls.