Inovus SDK Utils

This repo is a collection of Typescript utilities that encapsulates helper functionality that can be shared across Inovus APIs.

Requirements

• Visual Studio Code, Visual Studio 2019 (or Rider)
• NPM
• Jest
• Prettier

Cloning the Repo (for Development)

Clone the repo using the following command:

git clone https://<USERNAME>@bitbucket.org/inovus/inovus-sdk-utils.git

Usage

Building

npm run build

Running the Tests

npm test

Installing the module

npm install inovus-sdk-utils

Using the module

Utilities Module Example

	const utilities = require('inovus-sdk-utils').Utilities;
	var timeTaken = utilities.getElapsedTime(timer);

Rest Module Example

	const rest = require('inovus-sdk-utils').Rest;
	var rest = rest.success(rest.generatePolicySimple("OK", "", "SIMPLE", 
		utilities.getElapsedTime(timer), true, "Operation completed Successfully"));

Updating the module

npm update inovus-sdk-utils

Removing the module

npm uninstall inovus-sdk-utils

Change Log

|Date |Version|Description | |-----------|-------|-------------------------| |2021-06-07|v0.1.0|Initial Commit| |2021-06-07|v0.1.1|Added: chunks, isNumeric and getElapsedTime Functions + Updated README| |2021-06-07|v0.1.2|Rearranged to Submodules and Added Rest module| |2021-06-07|v0.1.3|Fixed issue with export| |2021-06-07|v0.1.4|Added remainder of rest code todo: Add tests| |2021-06-07|v0.1.5|Minor Updates: README| |2021-06-08|v0.1.6|Added Auth module and tests and dependancy to cognito-jwt-token-validator| |2021-06-08|v0.1.7|Added fluent method of specifying token| |2021-06-08|v0.1.8|Added Simplified fail method and test| |2021-06-08|v0.1.9|Added Error Constants| |2021-06-08|v0.1.10|Fixed Export for Errors| |2021-06-09|v0.1.11|Added Media module| |2021-06-09|v0.1.12|Added additional functions to Media module| |2021-07-13|v0.1.13|Added Errors for Meta Service| |2021-08-04|v0.1.14|Added getReturnTypeFromPayload to Utilities| |2021-08-10|v0.1.15|Added getPathPartsCount to Utilities| |2021-08-10|v0.1.16|Ported additional functions to Media| |2021-08-11|v0.1.17|Added parseS3InputPath to Media| |2021-08-12|v0.1.18|Added gathering PreviewThumbnails| |2021-10-04|v0.1.19|Updated parseS3InputPath| |2021-10-04|v0.1.20|Added: Catch errors with getPlaylistPath| |2021-11-12|v0.1.21|Added: Convert Cognito Create User Response to Inovus SingleUser Response type| |2021-11-25|v0.1.22|Updated: Minor Updates| |2023-01-03|v1.0.0|First published to NPM with some minor updates|

Author/s

Mark Castle

Copyright

© 2021-2023 Inovus Medical Ltd. All Rights Reserved.

Licence

Closed Source. Proprietary & Confidential.

Useful Links

• https://itnext.io/step-by-step-building-and-publishing-an-npm-typescript-package-44fe7164964c