@ospin/nexus


Documentation can be found here.

---

Table of Contents

- Use Overview
- Configuration
- Authenticating
- Use Examples
- Contributing
---

Overview

The @ospin/nexus is a JavaScript SDK to communicate to Ospin's HTTP API. It is build on top of @aws-amplify. To use it, the user has to be registered at OSPIN.

- configure nexus for the environment
- Authentication

#### Configuration
``js
const nexus = require('@ospin/nexus')

nexus.configure() // set up the SDK for default usage
`

#### Authenticating

With the nexus configured, a user can authenticate as their OSPIN AWS Cognito user:

`js
const username = 'Nero'
const password = 'BurnRome'
nexus.auth.signIn(username, password) // may require 2FA
`

Use Example


`js
// loading a process

const processId = "a3339d89-345b-4baf-9859-46a4542a505a"
const {
status: 200,
data: process,
} = await nexus.process.get(processId)


`

Contributing

This repo employs the github action semantic-release, which, on approved PRs to main, sniffs the PR title/commit message to automatically bump the semantic versioning and publish the package to NPM.

All PRs to the main` branch should indicate the semantic version change via the following options:

Available types:
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes (unclear if this bumps version)
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- refactor: A code change that neither fixes a bug nor adds a feature
- perf: A code change that improves performance
- test: Adding missing tests or correcting existing tests
- build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
- ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
- chore: Other changes that don't modify src or test files
- revert: Reverts a previous commit

Add BREAKING CHANGE into the commit message body (!) to indicate a major version release.