Merge pull request #60 from DSACMS/DSACMS/nat/schema-update

Updated contractNumber type and feedbackMechanism type and generation

Author: natalialuzuriaga

README.md

@@ -82,7 +82,7 @@ The automated code.json generator calculates specific fields by analyzing your r
 
 **dateMetaDataLastUpdated**: The generator sets this to the current timestamp each time it runs, providing a record of when the metadata was last refreshed. No configuration needed.
 
-**feedbackMechanisms**: A list of containing your repository's issues URL in the format of {repositoryURL}/issues. If you already have a code.json file with existing feedback mechanisms, the generator preserves those values. No configuration needed.
+**feedbackMechanism**: The repository's issues URL in the format of {repositoryURL}/issues. If you already have a code.json file with existing feedback mechanisms, the generator preserves those values. No configuration needed.
 
 ## Project Vision
 

code.json

@@ -29,7 +29,7 @@
   "softwareType": "standalone/backend",
   "languages": ["TypeScript", "JavaScript"],
   "maintenance": "internal",
-  "contractNumber": "",
+  "contractNumber": [],
   "date": {
     "created": "2025-02-07T16:29:38Z",
     "lastModified": "2025-06-06T17:48:49Z",
@@ -40,9 +40,7 @@
     "email": "opensource@cms.hhs.gov",
     "name": "CMS Open Source Team"
   },
-  "feedbackMechanisms": [
-    "https://github.com/DSACMS/automated-codejson-generator/issues"
-  ],
+  "feedbackMechanism": "https://github.com/DSACMS/automated-codejson-generator/issues",
   "localisation": false,
   "repositoryType": "tools",
   "userInput": false,

dist/index.js

@@ -13,7 +13,7 @@ const baselineCodeJSON: CodeJSON = {
         URL: "",
       },
     ],
-    usageType: "",
+    usageType: [],
     exemptionText: "",
   },
   organization: "",
@@ -32,7 +32,7 @@ const baselineCodeJSON: CodeJSON = {
   softwareType: "",
   languages: [],
   maintenance: "",
-  contractNumber: "",
+  contractNumber: [],
   date: {
     created: "",
     lastModified: "",
@@ -43,7 +43,8 @@ const baselineCodeJSON: CodeJSON = {
     email: "",
     name: "",
   },
-  feedbackMechanisms: [],
+  feedbackMechanism: "",
+  AIUseCaseID: "0",
   localisation: false,
   repositoryType: "",
   userInput: false,
@@ -63,11 +64,7 @@ async function getMetaData(
   const partialCodeJSON = await helpers.calculateMetaData();
 
   // preserve existing feedback mechanisms if they exist, otherwise default to GitHub Issues
-  const existingMechanisms = existingCodeJSON?.feedbackMechanisms || [];
-  const feedbackMechanisms =
-    existingMechanisms.length > 0
-      ? existingMechanisms
-      : [`${partialCodeJSON.repositoryURL}/issues`];
+  const feedbackMechanism = existingCodeJSON?.feedbackMechanism || `${partialCodeJSON.repositoryURL}/issues`;
 
   // only use the calculated description if its not empty, otherwise keep existing
   const shouldUpdateDescription =
@@ -101,7 +98,7 @@ async function getMetaData(
       metaDataLastUpdated:
         partialCodeJSON.date?.metaDataLastUpdated ?? new Date().toISOString(),
     },
-    feedbackMechanisms,
+    feedbackMechanism,
   };
 }
 

dist/model.d.ts

@@ -17,11 +17,12 @@ export interface CodeJSON {
   softwareType: string;
   languages: string[]; // calculated
   maintenance: string;
-  contractNumber: string;
+  contractNumber: string[];
   date: Date; // calculated
   tags: string[]; // calculated
   contact: Contact;
-  feedbackMechanisms: string[]; // semi-calculated
+  feedbackMechanism: string; // calculated
+  AIUseCaseID: string;
   localisation: boolean;
   repositoryType: string;
   userInput: boolean;
@@ -42,7 +43,7 @@ export interface ReuseFrequency {
 
 export interface Permissions {
   license: License[];
-  usageType: string;
+  usageType: string[];
   exemptionText: string;
 }