@ospin/nexus
Advanced tools
This documentation is likely to remain sparse, as it is for internal use and under development!
For additional documentation see our endpoint documentation
The @ospin/nexus exposes a set of conveniences methods wrapping calls to the OSPIN AWS backend, JSON serving, rest-like, API. Unless a method is explicitly labeled as using a public endpoint, or otherwise stated, all nexus consumers must do the following before using the methods provided:
const nexus = require('@ospin/nexus') // or import
nexus.connect({
ENV: <oneOf['dev', 'staging', 'prod']>), // default: 'prod'
AWS_REGION, // default: 'eu-central-1'
})
// -> { result, config }
// if you'd like to inspect the configuration object that `connect` is ultimately using:
nexus.createConfig() // <- returns the default configuration
nexus.createConfig({ ENV, AWS_REGION }) // <- returns a custom configuration
With the nexus configured, a user can authenticate as their OSPIN AWS Cognito user:
const nexus = require('@ospin/nexus')
nexus.auth.signIn(<username>, <password>) // may require 2FA
With the nexus configured, a device can authenticate using its certificate:
const nexus = require('@ospin/nexus')
nexus.createConfig()
nexus.connect()
nexus.deviceAPI.authentication.setCredentials({
deviceId: <deviceId>,
pathToCert: <pathToCert>
})
nexus.deviceAPI.validateAuthorization()
// -> { sucess, status, data, errorMsg }
nexus
├── auth
│ ├── signIn(<username>, <password>) // may require 2FA
│ ├── signOut()
│ ├── globalSignOut()
│ └── getCurrentSession()
├── user
│ ├── get(<userId>) // may require 2FA
│ ├── list()
│ ├── createDeletionRequest(<userId>)
│ ├── update(<userId>, <userParamsObj>)
│ └── notifications
│ └── putAll(<notificationObj>)
├── command
│ └── device
│ └── process
│ └── startProcess(<deviceId>, <processId>)
├── datapoints
│ └── get(<processId>, <reporterFctId>, <params>)
├── device
│ ├── list()
│ ├── create(<deviceParamsObj>)
│ ├── createHeidolphCoreGateway(<deviceParamsObj>)
│ └── certificate
│ └── get(<deviceId>)
├── log
| └── device
| └── deleteMany(<deviceId>)
├── process
| ├── functionality
| │ └── image
| │ ├── create(<processId>, <fctId>, <body>)
| │ └── list(<processId>, <fctId>, <opts>)
| └── annotation
│ ├── create({ processId: <processId>, data: <dataObject> })
│ ├── delete({ processId: <processId>, annotationId: <annotationId> })
│ └── update({ processId: <processId>, annotationId: <annotationId>, data: <dataObject> })
└── deviceAPI
├── authentication
| ├── setCredentials({ deviceId, pathToCert })
| └── validateAuthorization()
└── process
├── get(<processId>)
└── functionality
└── image
├── createFromUri(<processId>, <fctId>, <body>)
└── createFromFile(<processId>, <fctId>, <body>)
const nexus = require('@ospin/nexus')
const {
success: <boolean>,
status: <100 - 500>, // HTTP response status code
data: {}, // JSON safe object
error: <errObj>, // the error if the request failed
errorMsg: <string>, // a conveniently parsed error message
} = nexus.user.list()
nexus
├── createConfig(connectionOpts) // See the #Configuration section above
└── connect(connectionOpts) // uses createConfig's returned object - sets the configuration to the nexus
// getting the list representation of all devices (that the authenticated consumer is privileged to)
const nexus = require('@ospin/nexus')
nexus.connect()
const username = 'Nero Claudius Caesar Augustus Germanicus'
const password = 'BurnRomeToMakeANewPalace@Good-Plan-&-Ok-Password',
nexus.auth.signIn(username, password)
const {
success: listDevicesWasSuccessful,
data: devicesList,
errorMsg: listDevicesErrorMsg,
error: listDevicesError
} = nexus.device.list()
if (listDevicesWasSuccessful) {
console.log(deviceList)
// -> [ { ...deviceObj }, { ...deviceObj }, ... ]
} else {
// kindly find out why...
console.error(errorMsg)
// ..or live up to the username and be an unforgiving and unyielding tyrant
throw listDevicesError
// -> 💣
}
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:
FAQs
OSPIN client sdk for calls to rest-like, JSON serving, HTTP API
The npm package @ospin/nexus receives a total of 3 weekly downloads. As such, @ospin/nexus popularity was classified as not popular.
We found that @ospin/nexus demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.