et-nd-sdk

ET-NODE-SDK

This is an SDK for entities and triggers API which must only be used in Angular environment. The Angular version must be the same version as the one used in the FE itself. As of now the version locked in to,

"@angular/common": "9.1.12"

Pre-requisite

This SDK is a commonJs module.

How to use

ex:

Module can be imported as follows in Angular based application

import { init } from "et-nd-sdk";

Module must be initialized (Ensure to use proper values for a client, host and port),

• client - HttpClient available in Angular environment, usually injected
• host - The host url of the end point, ex: http://api-gateway/
• port - usually 80, must be empty if need to use host URL as it is
• base-path - could be empty as well

// @ts-ignore
const etSDK = init(this._http, "http://localhost", 9999, "");

Use API endpoints as required. All endpoint calls return a valid Observable (Rxjx)

const observer = {
  next: (x) => console.log(`${(JSON.parse(x)[0]).entityName}`),
  error: (err) => console.log(`error ${err}`),
  complete: () => console.log(`Completed`)
};

etSDK.listAllEntities().subscribe(observer);
    
etSDK.addEntityValue(
      { channelId: "channel-from-nd-sdk-004", ownedBy: "1", value: "THis is whatever", entityName: "@Eligibility"} as AddEvRequest
    ).subscribe(observer);

How to publish

In order to publish a new version of this SDK, change the package.json "version": "1.2.xx" to the new version value. It must be noted that duplicate version are not possible to be published.

To publish,

npm publish

To simpy build,

npm run tsc

To include this as a dependency in your project,

npm install et-nd-sdk@<version>

Available Operations

• listAllEntities
• addEntityValue
• addMultiEntityValues
• evaluateEntityValue
• listTriggerMapping
• triggerInvokeDirect
• triggerLookupDirect
• invokeLandingPageTrigger
• resetEntityValue

Currently available version

1.2.83

run,

npm install et-nd-sdk@1.2.83

Other info

• package.json - files section would specific which files to be included for publish

{
 ...
 files: []
 ...
}

Limitations

This sdk currently has a sample implementation on how to access et-management back end API. Additional API endpoints must be implemented for further use.

TODO

This SDK must have provision to accept a JWT token for API authorization purpose. Must be implemented before using this sdk in a LIVE application.

Webpack based build is currently not in use.