Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hcl-tech-software/voltscript-voltmx-middleware
Libraries for integrating with Volt Foundry from VoltScript
https://github.com/hcl-tech-software/voltscript-voltmx-middleware
volt-mx-go voltscript
Last synced: 10 days ago
JSON representation
Libraries for integrating with Volt Foundry from VoltScript
- Host: GitHub
- URL: https://github.com/hcl-tech-software/voltscript-voltmx-middleware
- Owner: HCL-TECH-SOFTWARE
- License: apache-2.0
- Created: 2024-04-17T16:45:13.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-10-03T12:29:42.000Z (3 months ago)
- Last Synced: 2024-12-20T12:15:46.636Z (17 days ago)
- Topics: volt-mx-go, voltscript
- Homepage: https://opensource.hcltechsw.com/voltscript-voltmx-middleware
- Size: 2.07 MB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# VoltScript Volt MX Middleware
Libraries for integrating with Volt MX Foundry.
## Using dependency management
Dependency management is available in the documentation for each project, but also aggregated here:
### Authentication
You'll need a [Personal Access Token](../howto/writing/archipelago.md#github-personal-access-token) to use GitHub REST APIs. You'll then need to add this to the JSON object in your [atlas-settings.json](../howto/writing/archipelago.md#atlas-settingsjson), in the .vss directory of your user home directory:
```json
"hcl-github": {
"type": "github",
"token": "${env.TOKEN}"
}
```
For downstream dependencies, you'll need to sign up for the Volt MX Marketplace. Instructions are in the [how-to-guide](https://help.hcltechsw.com/docs/voltscript/early-access/howto/writing/archipelago.html#volt-mx-marketplace-credentials). **NOTE:** Ensure you log into the Volt MX Marketplace via a browser after confirming your account, to ensure the account is properly activated. Otherwise authentication to gain an access token will fail.
You'll then need to add this to the JSON object in your [atlas-settings.json](https://help.hcltechsw.com/docs/voltscript/early-access/howto/writing/archipelago.md#atlas-settingsjson), in the .vss directory of your user home directory:
```json
"volt-mx-marketplace": {
"type": "marketplace",
"username": "YOUR_USERNAME",
"password": "YOUR_PASSWORD",
"authUrl": "https://accounts.auth.hclvoltmx.net/login"
}
```
### Repository
You'll need to add to your **repositories** object in the atlas.json of your project:
```json
{
"id": "hcl-github",
"type": "github",
"url": "https://api.github.com/repos/HCL-TECH-SOFTWARE"
}
```
### Dependency
You'll need the relevant dependency to add to your **dependencies** or **testDependencies** object in the atlas.json of your project:
```json
{
"library": "voltscript-voltmx-middleware",
"version": "1.0.2",
"module": "VoltMXObjects.vss",
"repository": "hcl-github"
}
```
## VoltMXObjects
VoltMXObjects is used for parsing the JSON object sent by a Foundry integration service (also also used behind the scenes in pre/postprocessors). The key objects are exposed as global properties. The JSON object will be passed as the context and accessed via ContextVSE:
```voltscript
Dim ctx as New Context()
data = ctx.context
```
The `extractObjects()` function will then parse the JSON object and populate the variables.
### Error Handling and Returning Context
The return output should be a JSON object **and only the JSON object**. This should be `VoltMxResult.toJson()`. Errors should be passed by call `VoltMxResult.setError()`.
## Contributing
See [CONTRIBUTING.md](contributing.md).
## Code of Conduct
See [CODE_OF_CONDUCT.md](code_of_conduct.md).
## Issues and discussions
Let's chat on [OpenNTF Discord](https://openntf.org/discord).
For long-running discussions, use Discussions area in GitHub. For bugs and feature requests **specific to VoltScript VoltMX Middleware** use, Issues area.