idcs-webgate v2.5.0

README

This library simplifies access to Webgate REST API of IDCS project.

IDCS project backend is private and you probably do NOT want to use this package unles you are working with the author of the package.

Commands

Build:

make
or
make build

To generate documentation manually

typedoc --out public src

How to Publish to NPM

To publish to NPM the local copy must have no modified or staged content.

The following command publishes to GIT and NPM:

npm version X.Y.Z

where X.Y.Z is the next version to publish such as 1.2.3.

Conditions and effects:

• version must NOT be the same
• tag in the form vX.Y.Z will be created locally
• tag will be pushed to GIT
• Gitlab will trigger build on tag push.
• Trusted Gitlab runner will push build artifacts to NPM.

NOTE: only tagged builds will be pushed to NPM.

Client Code

To use:

import { baseUrl, AuthLogon } from 'webgate'

baseUrl = 'https://hostname'
await AuthLogon(email, password)

HTML needs to import:

<script crossorigin defer src="webgate/index.umd.js"></script>

UMD module is in 'webgate/index.umd.js' and it exposes 'webgate' variable.

rollup.config.js needs to define exports:

exports: ['webgate'],

output: {
    globals: {
        'webgate': 'webgate'
    }
}

History

2.x.x is fetch and REST API based.

1.x.x was based on gRPC-web project.