npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

som-et-nd-sdk

v1.0.0

Published

This README would normally document whatever steps are necessary to get your application up and running.

Downloads

3

Readme

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

Currently available version

1.2.83

run,

npm install [email protected]

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.