Message Templates Microservice Client Library for Node.js / ES2017 V2

This is a Node.js client library for the service-msgtemplates2 microservice.

It provides an easy-to-use abstraction over communication protocols:

• HTTP/REST client
• gRPC client
• AWS Lambda function client
• Direct client for monolytic deployments
• Null client to be used in testing
• Resolver for clients

Quick Links

• Develop:
  • Environment Setup
  • Installing
  • Building
  • Testing
  • Contributing
• Install
• Use
• Acknowledgements
• Source Documentation

Develop

Environment Setup

This is a Node.js project and you have to install Node.js tools. You can download them from the official Node.js website: https://nodejs.org/en/download/

After Node.js is installed, you can verify its version:

node --version

Then you need to install some node tools (recommended to be global):

# Install typescript compiler
npm install typescript -g
 
# Install mocha test runner
npm install mocha -g

To work with the code repository, you need to install Git: https://git-scm.com/downloads

Installing

After your environment is ready, you can copy the client library source code from the repository:

git clone [email protected]:entinco/eic-services-content2.git

Then go to the project folder and install dependent modules:

# Install dependencies
npm install

If you have worked with the client library before, you can check out the latest changes and update the dependencies:

# Update source code
git pull

# Update dependencies
npm update

Building

This client library is written in TypeScript language which is transcompiled into JavaScript. So, if you make changes to the source code, you need to compile it before running or committing. The process will output compiled JavaScript files into the "obj" folder:

tsc

When you do continuous edit-build-test cycles, you can run the TypeScript compiler with "--watch" to detect and compile changes you make automatically:

tsc --watch

Testing

Unless you have to do something special, you don't need to worry about configuring and running the client library. The tests are designed to do that task automatically.

Run unit tests:

npm test

Execute benchmarks:

npm run benchmark

Contributing

Developers interested in contributing should read the following instructions:

• How to Contribute
• Guidelines
• Styleguide
• Changelog

Please do not ask general questions in an issue. Issues are only to report bugs, request enhancements, or request new features. For general questions and discussions, use the Contributors Forum.

It is important to note that for each release, the Changelog is a resource that will itemize all:

• Bug Fixes
• New Features
• Breaking Changes

Install

Add a dependency to the client library into the package.json file of your project:

{
    ...
    "dependencies": {
        ...
        "client-msgtemplates2-node": "^1.0.*",
        ...
    }
}

Then install the dependency:

# Install new dependencies
npm install

# Update already installed dependencies
npm update

Use

Inside your code, get the reference to the client library:

let node_lib = new require('client-msgtemplates2-node');

Define client configuration parameters that match the configuration of the microservice external API:

// Client configuration
let config = {
    connection: {
        protocol: 'http',
        host: 'localhost', 
        port: 8080
    }
};

Instantiate the client and open a connection to the microservice:

// Create the client instance
let client = node_lib.MessageTemplatesCommandableHttpClientV1(config);

// Connect to the microservice
try {
    await client.open(null);
    // Work with the microservice
    ...
}
catch (err) {
    console.error('Connection to the microservice failed');
    console.error(err);
}

Now the client is ready to perform operations:

// Create message template
let template = {
    name: 'Welcome',
    subject: { en: 'Welcome to our product' },
    text: { en: 'Welcome <%= name %>!' },
    html: { en: '<h1>Welcome <%= name %>!<h1>' },
    status: 'completed'
};

template = await client.createTemplate(
    null,
    template
);

// Get message template
template = await client.getTemplateByIdOrName(
    null, 'Welcome',
);

Acknowledgements

This client library was created by Sergey Seroukhov and is currently maintained by Michael Seroukhov.