Security News
How Threat Actors are Abusing GitHub’s File Upload Feature to Host Malware
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
@firebolt-js/openrpc
Advanced tools
Changelog
3.0.0-next.1 (2024-03-26)
Generalized templating engine to support both JavaScript and CPP (and other languages).
chore: Copy JS templates to C and create language.config.json
feat(languages): Add support for a distinct JSON-type for each schema
Also started tweaking C templates and adding a few useful macros.
chore: Dropped debug logs
fix: Stop passing non-schemas in to getSchemaType
feat(accessors): New macro section for schema property accessors
Readme
Tools to enable consistent Firebolt SDK and document generation.
Version 2.0 of firebolt-openrpc
has two major changes.
The openrpc
task takes a single OpenRPC document and "Fireboltizes" it, i.e. Interprets Firebolt method tags and inserts external Markdown descriptions via JSON-Schema $ref.
This task continues to support a directory of modules and will merge and Fireboltize them into a single file.
To support outputting multipel SDK's, there is a new slice
task. This task takes a single OpenRPC document and slices it into separate OpenRPC documents based on a provided sdk.config.json
, e.g.:
{
"info": {
"title": "Firebolt Core SDK",
},
"methods": [
{
"module": "Lifecycle",
"use": [
"xrn:firebolt:capability:lifecycle:ready"
"xrn:firebolt:capability:lifecycle:ready"
],
"manage": [],
"provide": [
"xrn:firebolt:capability:discovery:entityInfo",
"xrn:firebolt:capability:discovery:purchases"
]
}
]
}
The info.title
attribute is copied to the output, and each entry in the methods
array is used to query methods from the input using module names and capabilities.
Any info.x-
extension attributes will also be copied from the sdk.config.json into the output OpenRPC document.
Generally, this task is run using the output of the openrpc
task as input, however, it's not required.
Wildcards are supported in module
as well as use
, manage
, and provide
.
These tasks all take a single OpenRPC document and generate their respective artifacts.
They all have the same arguments and are all implemented using shared code for more consistency.
--input: The input OpenRPC document --output: The output location --template: An optional template directory for adding to and overriding the built in templates
Module.listen('eventName')
Indicated by --task validate
. Reads and validates a corpus of individual OpenRPC documents and validates the result of assembling them together into a single OpenRPC document.
FAQs
The Firebolt SDK Code & Doc Generator
The npm package @firebolt-js/openrpc receives a total of 111 weekly downloads. As such, @firebolt-js/openrpc popularity was classified as not popular.
We found that @firebolt-js/openrpc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 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
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.