Pip-clients-msgtemplates-node NPM

Message Templates Microservice Client SDK for Node.js

This is a Node.js client SDK for pip-services-msgtemplates microservice. It provides an easy to use abstraction over communication protocols:

Direct client
HTTP client
Seneca client (see http://www.senecajs.org)
AWS Lambda client (see https://aws.amazon.com/lambda)
Null client to be used in testing
Message template resolver

Quick Links:

Install

Add dependency to the client SDK into package.json file of your project

{
    ...
    "dependencies": {
        ....
        "pip-clients-msgtemplates-node": "^2.0.*",
        ...
    }
}

Then install the dependency using npm tool

# Install new dependencies
npm install

# Update already installed dependencies
npm update

Use

Inside your code get the reference to the client SDK

var sdk = new require('pip-clients-msgtemplates-node');

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

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

Instantiate the client and open connection to the microservice

// Create the client instance
var client = sdk.MessageTemplatesHttpClientV1(config);

// Connect to the microservice
client.open(null, function(err) {
    if (err) {
        console.error('Connection to the microservice failed');
        console.error(err);
        return;
    }
    
    // Work with the microservice
    ...
});

Now the client is ready to perform operations

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

client.createTemplate(
    null,
    msgtemplate,
    function (err, msgtemplate) {
        ...
    }
);

// Get welcome message template
client.getTemplateByIdOrName(
    null, 'Welcome',
    function(err, template) {
    ...    
});

Acknowledgements

This client SDK was created and currently maintained by Sergey Seroukhov.