Merge pull request #65 from DSACMS/DSACMS/nat/more-schema-updates

Add optional fields to model

Author: sachin-panayil

README.md

@@ -76,6 +76,8 @@ The automated code.json generator calculates specific fields by analyzing your r
 
 **languages**: This field populates the programming languages in your repository. No configuration needed.
 
+**SBOM**: The repository's SBOM URL in the format of {repositoryURL/network/dependencies}. If you already have a code.json file with the SBOM, the generator preserves those values. No configuration needed.
+
 **dateCreated**: The generator pulls your repository's creation date. No configuration needed.
 
 **dateLastModified**: This uses your repository's last update timestamp, reflecting the most recent changes. No configuration needed.

dist/index.js

@@ -3,6 +3,7 @@ import * as helpers from "./helper.js";
 
 const baselineCodeJSON: CodeJSON = {
   name: "",
+  version: "",
   description: "",
   longDescription: "",
   status: "",
@@ -18,9 +19,12 @@ const baselineCodeJSON: CodeJSON = {
   },
   organization: "",
   repositoryURL: "",
-  projectURL: "",
   repositoryHost: "github",
   repositoryVisibility: "",
+  homepageURL: "",
+  downloadURL: "",
+  disclaimerURL: "",
+  disclaimerText: "",
   vcs: "git",
   laborHours: 0,
   reuseFrequency: {
@@ -33,6 +37,10 @@ const baselineCodeJSON: CodeJSON = {
   languages: [],
   maintenance: "",
   contractNumber: [],
+  SBOM: "",
+  relatedCode: [],
+  reusedCode: [],
+  partners: [],
   date: {
     created: "",
     lastModified: "",
@@ -52,7 +60,6 @@ const baselineCodeJSON: CodeJSON = {
   group: "",
   projects: [],
   systems: [],
-  upstream: "",
   subsetInHealthcare: [],
   userType: [],
   maturityModelTier: 0,
@@ -66,6 +73,9 @@ async function getMetaData(
   // preserve existing feedback mechanisms if they exist, otherwise default to GitHub Issues
   const feedbackMechanism = existingCodeJSON?.feedbackMechanism || `${partialCodeJSON.repositoryURL}/issues`;
 
+  // preserve existing SBOM link if they exist, otherwise default to GitHub SBOM link
+  const SBOM = existingCodeJSON?.SBOM || `${partialCodeJSON.repositoryURL}/network/dependencies`;
+
   // only use the calculated description if its not empty, otherwise keep existing
   const shouldUpdateDescription =
     partialCodeJSON.description && partialCodeJSON.description.trim() !== "";
@@ -99,6 +109,7 @@ async function getMetaData(
         partialCodeJSON.date?.metaDataLastUpdated ?? new Date().toISOString(),
     },
     feedbackMechanism,
+    SBOM
   };
 }
 

dist/model.d.ts

@@ -1,14 +1,18 @@
 export interface CodeJSON {
   name: string; // calculated
+  version?: string;
   description: string; // calculated
   longDescription: string;
   status: string;
   permissions: Permissions;
   organization: string;
   repositoryURL: string; // calculated
-  projectURL: string;
   repositoryHost: string;
   repositoryVisibility: string; // calculated
+  homepageURL?: string;
+  downloadURL?: string;
+  disclaimerURL?: string;
+  disclaimerText?: string;
   vcs: string;
   laborHours: number; // calculated
   reuseFrequency: ReuseFrequency; // semi-calculated
@@ -18,6 +22,10 @@ export interface CodeJSON {
   languages: string[]; // calculated
   maintenance: string;
   contractNumber: string[];
+  SBOM: string; //calculated
+  relatedCode?: RelatedCode[];
+  reusedCode?: ReusedCode[];
+  partners?: Partner[];
   date: Date; // calculated
   tags: string[]; // calculated
   contact: Contact;
@@ -30,7 +38,6 @@ export interface CodeJSON {
   group: string;
   projects: string[];
   systems: string[];
-  upstream: string;
   subsetInHealthcare: string[];
   userType: string[];
   maturityModelTier: number;
@@ -52,6 +59,22 @@ export interface License {
   URL: string;
 }
 
+export interface RelatedCode {
+  name: string;
+  URL: string;
+  isGovernmentRepo: boolean;
+}
+
+export interface ReusedCode {
+  name: string;
+  URL: string;
+}
+
+export interface Partner {
+  name: string;
+  email: string;
+}
+
 export interface Date {
   created: string;
   lastModified: string;