@adobe/structured-data-validator

!GitHub License
!Node Current

A JavaScript library for validating and parsing structured data according to Schema.org specifications and Google Rich Results requirements. This library ensures your structured data meets both Schema.org standards and Google's specific requirements for rich results, helping to optimize your content for search engines and other platforms.

Features

- Validates structured data against both Schema.org and Google Rich Results specifications
- Ensures compliance with Google's structured data guidelines
- Extensible validation system with custom type handlers

Installation

``bash
npm install @adobe/structured-data-validator
`

Usage

This library works in conjunction with @marbec/web-auto-extractor to validate structured data extracted from web pages.

`javascript
import { Validator } from '@adobe/structured-data-validator';
import WebAutoExtractor from '@marbec/web-auto-extractor';

// First, extract structured data from HTML
const extractor = new WebAutoExtractor({ addLocation: true, embedSource: ['rdfa', 'microdata'] });
const extractedData = extractor.parse(sampleHTML);

// Fetch the current schema.org schema
const schemaOrgJson = await (await fetch('https://schema.org/version/latest/schemaorg-all-https.jsonld')).json();

// Create a validator instance
const validator = new Validator(schemaOrgJson);

// Validate the extracted structured data
const results = await validator.validate(extractedData);
}
`

The validator expects the output format from @marbec/web-auto-extractor, which includes:

- JSON-LD structured data
- Microdata
- RDFa

$3

The validator returns an array of validation issues. Each issue object contains:

- issueMessage - Human-readable error or warning message
- severity - Either 'ERROR' or 'WARNING'
- path - Array representing the location in the data structure where the issue occurred
- fieldNames - Array of field paths that caused the validation issue (e.g., ['price'], ['offers.price'], or ['aggregateRating', 'offers', 'review'] for compound conditions)
- location - Character position in the original source (if available)

Example validation result:

`javascript
[
{
issueMessage: 'Required attribute "price" is missing',
severity: 'ERROR',
path: [{ type: 'Product', index: 0 }],
fieldNames: ['price'],
location: '35,100',
},
];
`

$3

You can run the parser and validator directly in the browser on any website using the following commands:

`js
const { default: WebAutoExtractor } = await import(
'https://unpkg.com/@marbec/web-auto-extractor@latest/dist/index.js'
);
const { default: Validator } = await import(
'https://unpkg.com/@adobe/structured-data-validator@latest/src/index.js'
);

const extractedData = new WebAutoExtractor({
addLocation: true,
embedSource: ['rdfa', 'microdata'],
}).parse(document.documentElement.outerHTML);
console.log(extractedData);
const schemaOrgJson = await (
await fetch('https://schema.org/version/latest/schemaorg-all-https.jsonld')
).json();
await new Validator(schemaOrgJson).validate(extractedData);
`

Development

$3

- Node.js (latest LTS version recommended)
- npm

$3

1. Clone the repository
2. Install dependencies:
`bash
npm install
`

$3

- npm test - Run tests with coverage
- npm run lint - Run ESLint
- npm run format - Check code formatting
- npm run format:fix - Fix code formatting issues

$3

To enable debug logging and see detailed validation output, set the debug property to true on your Validator instance:

`js
const validator = new Validator();
validator.debug = true; // Enable debug logging
``

This will print additional information to the console during validation, which is useful for development and troubleshooting.

Dependencies

- @marbec/web-auto-extractor - For extracting structured data from web pages