Fixing broken field bug (#104)

* add .or literal addition

* adding verbose error logging

* editing code.json to trigger validation

* changing version for action

* manually editing code.json schema to trigger fail

* adding package to handle errors

* reverting things

Author: sachin-panayil

.github/workflows/updateCodeJSON.yml

@@ -22,7 +22,7 @@ jobs:
 
       - name: Update code.json
         id: generator
-        uses: DSACMS/automated-codejson-generator@sachin/inheriting-from-source-model
+        uses: DSACMS/automated-codejson-generator@main
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           ADMIN_TOKEN: ${{ secrets.ADMIN_PAT }}

code.json

@@ -68,4 +68,4 @@
   "subsetInHealthcare": ["operational"],
   "userType": ["government"],
   "maturityModelTier": 3
-}
+}

package-lock.json

@@ -42,7 +42,8 @@
     "@octokit/action": "^7.0.0",
     "json-schema-to-zod": "^2.7.0",
     "octokit-plugin-create-pull-request": "^6.0.0",
-    "zod": "^4.2.1"
+    "zod": "^4.2.1",
+    "zod-validation-error": "^5.0.0"
   },
   "devDependencies": {
     "@eslint/compat": "^1.2.6",

package.json

@@ -7,6 +7,11 @@ const schemaVersion = "2.0.0";
 const schemaURL = `https://raw.githubusercontent.com/DSACMS/gov-codejson/refs/heads/main/schemas/cms/schema-${schemaVersion}.json`;
 const filePath = "src/types/CodeJSONSchema.ts";
 
+function allowEmptyUrls(zodCode: string): string {
+    // allow empty strings for all URL fields while still validating non-empty values
+    return zodCode.replace(/\.url\(\)/g, '.url().or(z.literal(""))');
+  }
+
 function fixUniqueArrays(zodCode: string): string {
     // replace .unique() with .refine() pattern since Zod doesn't have .unique() for arrays but converter adds it in there
     return zodCode.replace(
@@ -71,6 +76,7 @@ async function generateSchema() {
     let zodSourceCode = jsonSchemaToZod(jsonSchema);
 
     zodSourceCode = fixUniqueArrays(zodSourceCode);
+    zodSourceCode = allowEmptyUrls(zodSourceCode)
 
     const fileContent = `
         // DO NOT EDIT - AUTOMATICALLY GENERATED FILE!!!

src/scripts/generate-schema.ts

@@ -57,6 +57,7 @@ export const CodeJSONSchema = z
                 URL: z
                   .string()
                   .url()
+                  .or(z.literal(""))
                   .describe("The URL of the release license in the repository"),
               })
               .strict(),
@@ -115,6 +116,7 @@ export const CodeJSONSchema = z
     repositoryURL: z
       .string()
       .url()
+      .or(z.literal(""))
       .describe(
         "The URL of the public release repository for open source repositories. This field is not required for repositories that are only available as government-wide reuse or are closed (pursuant to one of the exemptions). It can be listed as 'private' for repositories that are closed.",
       ),
@@ -134,16 +136,19 @@ export const CodeJSONSchema = z
     homepageURL: z
       .string()
       .url()
+      .or(z.literal(""))
       .describe("The URL of the public release homepage.")
       .optional(),
     downloadURL: z
       .string()
       .url()
+      .or(z.literal(""))
       .describe("The URL where a distribution of the release can be found.")
       .optional(),
     disclaimerURL: z
       .string()
       .url()
+      .or(z.literal(""))
       .describe(
         "The URL where disclaimer language regarding the release can be found.",
       )
@@ -236,6 +241,7 @@ export const CodeJSONSchema = z
             URL: z
               .string()
               .url()
+              .or(z.literal(""))
               .describe(
                 "The URL where the code repository, project, library or release can be found.",
               )
@@ -264,6 +270,7 @@ export const CodeJSONSchema = z
             URL: z
               .string()
               .url()
+              .or(z.literal(""))
               .describe("The URL where the software can be found.")
               .optional(),
           })
@@ -336,6 +343,7 @@ export const CodeJSONSchema = z
     feedbackMechanism: z
       .string()
       .url()
+      .or(z.literal(""))
       .describe(
         "Method a repository receives feedback from the community (i.e. URL to GitHub repository issues page)",
       ),

src/types/CodeJSONSchema.ts

@@ -1,17 +1,18 @@
 import { z } from "zod";
+import { createErrorMap } from "zod-validation-error";
 import { CodeJSONSchema } from "./types/CodeJSONSchema.js";
 
+z.config({
+  customError: createErrorMap(),
+});
+
 export function validateCodeJSON(codeJSON: any): string[] {
   const result = CodeJSONSchema.safeParse(codeJSON);
 
   if (result.success) {
     return [];
   }
 
-  return result.error.issues.map((err: z.ZodIssue) => {
-    const path = err.path.join(".");
-    const field = path || "root";
-    return `${field}: ${err.message}`;
-  });
+  return [z.prettifyError(result.error)]
 }