clevergy-sdk v0.4.16

Clevergy SDK

Token authentication

Technically, this SDK can be used with a backend in Node or frontend in Typescript. To use the SDK properly, you can build it with a token already like so:

    const {clevergySdk} =  buildClevergyApiSdk(YOUR_TOKEN_HERE);

or set it at a later time:

    const {clevergySdk, setToken} =  buildClevergyApiSdk();
    ...
    setToken(YOUR_TOKEN_HERE);

Note: If you decide to set the token at a later time, any calls made before the token is set up will not work.

also, you can set as second argument a function to provide a way of get a refreshed token on each api call to avoid expired token requests.

    async function refreshTokenHandler() {
        ...
        return token;
    }

    const {clevergySdk} =  buildClevergyApiSdk(undefined, refreshTokenHandler);

To publish to NPM:

1. In your .bashrc file (or wherever you set your ENV variables), set the CLEVERGY_NPM_TOKEN to the NPM TOKEN found in the secrets manager of GCP with the name of CLEVERGY_NPM_TOKEN

   Never commit this token to the repo. If you do, you'll have to change the token immediately.

2. Make changes to the SDK

3. Run npm run build

4. Commit and push changes

5. Run npm version patch --> upgrade version, commit and push

6. Run npm publish if your .bashrc contains the NPM's token or run CLEVERGY_NPM_TOKEN={npm_token} npm publish

7. Update the package where it's needed.

Keep in mind of breaking changes made in the sdk/api.