@gsriram24/structured-data-validator 1.7.0 → 1.7.2

package/README.md

@@ -11,8 +11,8 @@ A JavaScript library for validating and parsing structured data according to Sch
 
 This fork adds the following features on top of Adobe's original library:
 
-### 1. `fieldName` Property on Validation Errors
-Every validation error now includes a `fieldName` property for precise programmatic access:
+### 1. `fieldNames` Property on Validation Errors
+Every validation error now includes a `fieldNames` array for precise programmatic access:
 
 ```javascript
 // Before (Adobe's version) - requires string parsing
@@ -27,19 +27,20 @@ Every validation error now includes a `fieldName` property for precise programma
   issueMessage: 'Required attribute "price" is missing',
   severity: 'ERROR',
   path: [...],
-  fieldName: 'price'  // ✨ New!
+  fieldNames: ['price']  // ✨ New!
 }
 ```
 
-For `or()` conditions, both `fieldName` and `fieldNames` are provided:
+For `or()` conditions with multiple fields:
 ```javascript
 {
   issueMessage: 'One of the following attributes is required...',
-  fieldName: 'aggregateRating',           // First field
-  fieldNames: ['aggregateRating', 'offers', 'review']  // All fields
+  fieldNames: ['aggregateRating', 'offers', 'review']  // All relevant fields
 }
 ```
 
+Access the primary field with `error.fieldNames[0]}`, or iterate over all fields as needed.
+
 ### 2. New Validators for Common Schema Types
 Added validators for commonly-used schema.org types:
 
@@ -90,10 +91,10 @@ const validator = new Validator(schemaOrgJson);
 // Validate the extracted structured data
 const results = await validator.validate(extractedData);
 
-// Use fieldName for precise error handling
+// Use fieldNames for precise error handling
 results.forEach(issue => {
   if (issue.severity === 'ERROR') {
-    console.log(`Field "${issue.fieldName}" has error: ${issue.issueMessage}`);
+    console.log(`Field "${issue.fieldNames?.[0]}" has error: ${issue.issueMessage}`);
   }
 });
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gsriram24/structured-data-validator",
-  "version": "1.7.0",
+  "version": "1.7.2",
   "publishConfig": {
     "access": "public"
   },
@@ -34,16 +34,16 @@
     "@marbec/web-auto-extractor": "^2.1.0",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/github": "^11.0.2",
-    "@semantic-release/npm": "^12.0.1",
+    "@semantic-release/github": "^12.0.0",
+    "@semantic-release/npm": "^13.0.0",
     "c8": "^10.1.3",
-    "chai": "^5.2.0",
+    "chai": "^6.0.0",
     "eslint": "^9.22.0",
     "eslint-plugin-headers": "^1.2.1",
     "globals": "^16.0.0",
     "mocha": "^11.1.0",
     "prettier": "^3.5.3",
-    "semantic-release": "^24.2.4",
+    "semantic-release": "^25.0.0",
     "sinon": "^21.0.0"
   }
 }

package/src/types/BreadcrumbList.js

@@ -32,7 +32,7 @@ export default class BreadcrumbListValidator extends BaseValidator {
         issueMessage: 'At least two ListItems are required',
         severity: 'WARNING',
         path: this.path,
-        fieldName: 'itemListElement',
+        fieldNames: ['itemListElement'],
       };
     }
     return null;
@@ -138,7 +138,7 @@ export default class BreadcrumbListValidator extends BaseValidator {
           issueMessage: e,
           severity: 'WARNING',
           path: newPath,
-          fieldName: urlPath || 'item',
+          fieldNames: [urlPath || 'item'],
         });
       }
     }

package/src/types/DefinedRegion.js

@@ -30,7 +30,6 @@ export default class DefinedRegionValidator extends BaseValidator {
         issueMessage: 'Only one of addressRegion or postalCode can be used',
         severity: 'WARNING',
         path: this.path,
-        fieldName: 'addressRegion',
         fieldNames: ['addressRegion', 'postalCode'],
       };
     }

package/src/types/MerchantReturnPolicy.js

@@ -84,7 +84,6 @@ export default class MerchantReturnPolicyValidator extends BaseValidator {
           'Either applicableCountry and returnPolicyCategory or merchantReturnLink must be present',
         severity: 'ERROR',
         path: this.path,
-        fieldName: 'applicableCountry',
         fieldNames: [
           'applicableCountry',
           'returnPolicyCategory',

package/src/types/Product.js

@@ -47,7 +47,6 @@ export default class ProductValidator extends BaseValidator {
           'At least 2 notes, either positive or negative, are required',
         severity: 'WARNING',
         path: this.path,
-        fieldName: 'review',
         fieldNames: ['review.positiveNotes', 'review.negativeNotes'],
       });
     }
@@ -65,7 +64,6 @@ export default class ProductValidator extends BaseValidator {
           'One of the following attributes is required: "aggregateRating", "offers" or "review"',
         severity: 'ERROR',
         path: this.path,
-        fieldName: 'aggregateRating',
         fieldNames: ['aggregateRating', 'offers', 'review'],
       });
     }

package/src/types/ProductMerchant.js

@@ -81,7 +81,6 @@ export default class ProductMerchantValidator extends BaseValidator {
       issueMessage: `Missing one of field ${gtinFields.map((a) => `"${a}"`).join(', ')} on either product or all offers`,
       severity: 'WARNING',
       path: this.path,
-      fieldName: 'gtin',
       fieldNames: gtinFields,
     };
   }

package/src/types/Rating.js

@@ -46,7 +46,7 @@ export default class RatingValidator extends BaseValidator {
           issueMessage: `Rating is outside the specified or default range`,
           severity: 'ERROR',
           path: this.path,
-          fieldName: 'ratingValue',
+          fieldNames: ['ratingValue'],
         };
       }
     }

package/src/types/base.js

@@ -58,7 +58,7 @@ export default class BaseValidator {
           issueMessage: `Required attribute "${name}" is missing`,
           severity: 'ERROR',
           path: this.path,
-          fieldName: name,
+          fieldNames: [name],
         };
       }
       if (type && !this.checkType(value, type, ...opts)) {
@@ -66,7 +66,7 @@ export default class BaseValidator {
           issueMessage: `Invalid type for attribute "${name}"`,
           severity: 'ERROR',
           path: this.path,
-          fieldName: name,
+          fieldNames: [name],
         };
       }
       return null;
@@ -94,8 +94,8 @@ export default class BaseValidator {
       // Collect all field names from the conditions
       const fieldNames = issues
         .flat()
-        .filter((i) => i && i.fieldName)
-        .map((i) => i.fieldName);
+        .filter((i) => i && i.fieldNames)
+        .flatMap((i) => i.fieldNames);
 
       return {
         issueMessage: `One of the following conditions needs to be met: ${issues
@@ -104,8 +104,7 @@ export default class BaseValidator {
           .join(' or ')}`,
         severity,
         path: this.path,
-        fieldName: fieldNames[0] || null,
-        fieldNames: fieldNames.length > 0 ? fieldNames : undefined,
+        fieldNames: fieldNames.length > 0 ? fieldNames : [],
       };
     };
   }
@@ -118,7 +117,7 @@ export default class BaseValidator {
           issueMessage: `Missing field "${name}" (optional)`,
           severity: 'WARNING',
           path: this.path,
-          fieldName: name,
+          fieldNames: [name],
         };
       }
       if (type && !this.checkType(value, type, ...opts)) {
@@ -126,7 +125,7 @@ export default class BaseValidator {
           issueMessage: `Invalid type for attribute "${name}"`,
           severity: 'WARNING',
           path: this.path,
-          fieldName: name,
+          fieldNames: [name],
         };
       }
       return null;

package/src/types/schemaOrg.js

@@ -209,7 +209,7 @@ export default class SchemaOrgValidator {
       if (!typeExists) {
         issues.push({
           issueMessage: `Type "${typeId}" is not a valid schema.org type`,
-          severity: 'WARNING',
+          severity: 'ERROR',
           path: this.path,
           errorType: 'schemaOrg',
           fieldName: '@type',
@@ -235,7 +235,7 @@ export default class SchemaOrgValidator {
               severity: 'WARNING',
               path: this.path,
               errorType: 'schemaOrg',
-              fieldName: propertyId,
+              fieldNames: [propertyId],
             });
           }
         }),