fix: tools' services/components omit empty (#1180)

Signed-off-by: Jan Kowalleck <[email protected]> Co-authored-by: jkowalleck <[email protected]>
CycloneDX · Nov 20, 2024 · 85a8f5e · 85a8f5e
1 parent 1ad0dd3
commit 85a8f5e
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 6 deletions.
diff --git a/HISTORY.md b/HISTORY.md
@@ -13,7 +13,7 @@ All notable changes to this project will be documented in this file.
   * Static function `Models.Tool.fromComponent()` (via [#1163])
   * Static function `Models.Tool.fromService()` (via [#1163])
   * New class `Models.Tools` ([#1152] via [#1163])
-  * New serialization/normalization for `Models.Tools` ([#1152] via [#1163])
+  * New serialization/normalization for `Models.Tools` ([#1152] via [#1163], [#1180])
 * Changed
   * Serializers and `Bom`-Normalizers will take changed `Models.Bom.tools` into account ([#1152] via [#1163])
 * Dependencies
@@ -24,6 +24,7 @@ All notable changes to this project will be documented in this file.
 [#1152]: https://github.com/CycloneDX/cyclonedx-javascript-library/issues/1152
 [#1163]: https://github.com/CycloneDX/cyclonedx-javascript-library/pull/1163
 [#1173]: https://github.com/CycloneDX/cyclonedx-javascript-library/pull/1173
+[#1180]: https://github.com/CycloneDX/cyclonedx-javascript-library/pull/1180
 
 ## 6.13.0 -- 2024-11-18
 

diff --git a/src/serialize/json/normalize.ts b/src/serialize/json/normalize.ts
@@ -302,8 +302,12 @@ export class ToolsNormalizer extends BaseJsonNormalizer<Models.Tools> {
         )), options)
     }
     return {
-      components: this._factory.makeForComponent().normalizeIterable(data.components, options),
-      services: this._factory.makeForService().normalizeIterable(data.services, options)
+      components: data.components.size > 0
+        ? this._factory.makeForComponent().normalizeIterable(data.components, options)
+        : undefined,
+      services: data.services.size > 0
+        ? this._factory.makeForService().normalizeIterable(data.services, options)
+        : undefined
     }
   }
 }

diff --git a/src/serialize/json/types.ts b/src/serialize/json/types.ts
@@ -120,8 +120,8 @@ export namespace Normalized {
 
   /** since CDX 1.5 */
   export interface Tools {
-    components: Component[]
-    services: Service[]
+    components?: Component[]
+    services?: Service[]
   }
 
   export type ToolsType = Tools | Tool[]

diff --git a/src/serialize/xml/normalize.ts b/src/serialize/xml/normalize.ts
@@ -389,7 +389,7 @@ export class ToolsNormalizer extends BaseXmlNormalizer<Models.Tools> {
           children: this._factory.makeForComponent().normalizeIterable(data.components, options, 'component')
         })
       }
-      if (data.components.size > 0) {
+      if (data.services.size > 0) {
         children.push({
           type: 'element',
           name: 'services',