@appthreat/cdx-proto
Version:
Library to serialize/deserialize CycloneDX BOM with protocol buffers
7 lines (5 loc) • 10.4 kB
HTML
<html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>cdx-proto</title><meta name="description" content="Documentation for cdx-proto"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">cdx-proto</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>cdx-proto</h1></div><div class="tsd-panel tsd-typography"><h1 id="cdx-proto" class="tsd-anchor-link">cdx-proto<a href="#cdx-proto" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>Runtime library to serialize/deserialize CycloneDX BOM with protocol buffers. The project was generated using <a href="https://github.com/bufbuild/protobuf-es">protoc-gen-es</a> from the official <a href="https://github.com/CycloneDX/specification/blob/master/schema/bom-1.5.proto">proto</a> specification.</p>
<h2 id="sample-usage" class="tsd-anchor-link">Sample usage<a href="#sample-usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><pre><code class="js"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">cdx_15</span><span class="hl-1">, </span><span class="hl-2">cdx_16</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">"@appthreat/cdx-proto"</span><span class="hl-1">;</span><br/><span class="hl-0">import</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">fromBinary</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">fromJsonString</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">toBinary</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">toJson</span><span class="hl-1">,</span><br/><span class="hl-1">} </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">"@bufbuild/protobuf"</span><span class="hl-1">;</span><br/><br/><span class="hl-4">// Create .proto files </span><br/><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-2">bomSchema</span><span class="hl-1">;</span><br/><span class="hl-0">if</span><span class="hl-1"> (+</span><span class="hl-2">bomJson</span><span class="hl-1">.</span><span class="hl-2">specVersion</span><span class="hl-1"> === </span><span class="hl-6">1.6</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-2">bomSchema</span><span class="hl-1"> = </span><span class="hl-2">cdx_16</span><span class="hl-1">.</span><span class="hl-2">BomSchema</span><span class="hl-1">;</span><br/><span class="hl-1">} </span><span class="hl-0">else</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">bomSchema</span><span class="hl-1"> = </span><span class="hl-2">cdx_15</span><span class="hl-1">.</span><span class="hl-2">BomSchema</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><span class="hl-7">writeFileSync</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">binFile</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-7">toBinary</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">bomSchema</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-7">fromJsonString</span><span class="hl-1">(</span><span class="hl-2">bomSchema</span><span class="hl-1">, </span><span class="hl-7">stringifyIfNeeded</span><span class="hl-1">(</span><span class="hl-2">bomJson</span><span class="hl-1">), {</span><br/><span class="hl-1"> </span><span class="hl-2">ignoreUnknownFields:</span><span class="hl-1"> </span><span class="hl-5">true</span><span class="hl-1">,</span><br/><span class="hl-1"> }),</span><br/><span class="hl-1"> ),</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">writeUnknownFields:</span><span class="hl-1"> </span><span class="hl-5">true</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">);</span><br/><br/><span class="hl-4">// Read .proto files</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-8">bomObject</span><span class="hl-1"> = </span><span class="hl-7">fromBinary</span><span class="hl-1">(</span><span class="hl-2">bomSchema</span><span class="hl-1">, </span><span class="hl-7">readFileSync</span><span class="hl-1">(</span><span class="hl-2">binFile</span><span class="hl-1">), {</span><br/><span class="hl-1"> </span><span class="hl-2">readUnknownFields:</span><span class="hl-1"> </span><span class="hl-5">true</span><span class="hl-1">,</span><br/><span class="hl-1">});</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-8">jsonstr</span><span class="hl-1"> = </span><span class="hl-7">toJson</span><span class="hl-1">(</span><span class="hl-2">bomSchema</span><span class="hl-1">, </span><span class="hl-2">bomObject</span><span class="hl-1">, { </span><span class="hl-2">emitDefaultValues:</span><span class="hl-1"> </span><span class="hl-5">true</span><span class="hl-1"> });</span>
</code><button type="button">Copy</button></pre>
<h2 id="license" class="tsd-anchor-link">License<a href="#license" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Apache-2.0</p>
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#cdx-proto"><span>cdx-<wbr/>proto</span></a><ul><li><a href="#sample-usage"><span>Sample usage</span></a></li><li><a href="#license"><span>License</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">cdx-proto</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>