@gsriram24/structured-data-validator 1.6.0

package/src/types/LocalBusiness.js

@@ -0,0 +1,30 @@
+/**
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import BaseValidator from './base.js';
+
+export default class LocalBusinessValidator extends BaseValidator {
+  getConditions() {
+    return [
+      this.required('name'),
+      this.required('address', 'object'),
+
+      this.recommended('aggregateRating', 'object'),
+      this.recommended('geo', 'object'),
+      this.recommended('image', 'url'),
+      this.recommended('openingHoursSpecification', 'arrayOrObject'),
+      this.recommended('priceRange'),
+      this.recommended('review', 'arrayOrObject'),
+      this.recommended('telephone'),
+      this.recommended('url', 'url'),
+    ].map((c) => c.bind(this));
+  }
+}

package/src/types/MerchantReturnPolicy.js

@@ -0,0 +1,96 @@
+/**
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import BaseValidator from './base.js';
+
+export default class MerchantReturnPolicyValidator extends BaseValidator {
+  getConditions(data) {
+    const conditions = [this.countryOrLink];
+
+    const category = data.returnPolicyCategory;
+
+    // If returnPolicyCategory is present, we need to validate the return window
+    if (
+      category &&
+      (category.includes('MerchantReturnFiniteReturnWindow') ||
+        category.includes('MerchantReturnUnlimitedWindow'))
+    ) {
+      if (category.includes('MerchantReturnFiniteReturnWindow')) {
+        conditions.push(this.recommended('merchantReturnDays', 'number'));
+      }
+      conditions.push(
+        this.recommended('returnFees'),
+        this.recommended('returnMethod'),
+      );
+
+      if (data.returnFees && data.returnFees.includes('ReturnShippingFees')) {
+        conditions.push(this.recommended('returnShippingFeesAmount'));
+      }
+
+      // Additional properties for Organization context
+      // TODO: Consider other subtypes of Organization
+      if (
+        this.inType('Organization') &&
+        this.inProperty('hasMerchantReturnPolicy')
+      ) {
+        conditions.push(
+          this.recommended('customerRemorseReturnFees'),
+          this.recommended('customerRemorseReturnLabelSource'),
+          this.recommended('customerRemorseReturnShippingFeesAmount'),
+          this.recommended('itemCondition'),
+          this.recommended('itemDefectReturnFees'),
+          this.recommended('itemDefectReturnLabelSource'),
+          this.recommended('itemDefectReturnShippingFeesAmount'),
+          this.recommended('refundType'),
+          this.recommended('restockingFee'),
+          this.recommended('returnLabelSource'),
+          this.recommended('returnPolicyCountry'),
+        );
+      }
+    }
+
+    return conditions.map((c) => c.bind(this));
+  }
+
+  countryOrLink(data) {
+    // Either applicableCountry and returnPolicyCategory need to be present
+    // or merchantReturnLink needs to be present, but only when nested under Organization
+
+    let valid = false;
+    if (
+      this.inProperty('hasMerchantReturnPolicy') &&
+      this.inType('Organization') &&
+      this.required('merchantReturnLink')(data) === null
+    ) {
+      valid = true;
+    } else if (
+      this.required('applicableCountry')(data) === null &&
+      this.required('returnPolicyCategory')(data) === null
+    ) {
+      valid = true;
+    }
+
+    if (!valid) {
+      return {
+        issueMessage:
+          'Either applicableCountry and returnPolicyCategory or merchantReturnLink must be present',
+        severity: 'ERROR',
+        path: this.path,
+        fieldName: 'applicableCountry',
+        fieldNames: [
+          'applicableCountry',
+          'returnPolicyCategory',
+          'merchantReturnLink',
+        ],
+      };
+    }
+  }
+}

package/src/types/Offer.js

@@ -0,0 +1,39 @@
+/**
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import BaseValidator from './base.js';
+
+export default class PriceSpecificationValidator extends BaseValidator {
+  getConditions() {
+    const conditions = [];
+    const offerIndex = this.path.findIndex(
+      (pathElement) => pathElement.type === 'Offer',
+    );
+    const productIsParent =
+      offerIndex > 0 ? this.path[offerIndex - 1].type === 'Product' : false;
+
+    if (productIsParent) {
+      conditions.push(
+        this.or(
+          this.required('price', 'number'),
+          this.required('priceSpecification.price', 'number'),
+        ),
+        this.recommended('availability'),
+        this.or(
+          this.recommended('priceCurrency', 'currency'),
+          this.recommended('priceSpecification.priceCurrency', 'currency'),
+        ),
+        this.recommended('priceValidUntil', 'date'),
+      );
+    }
+    return conditions.map((c) => c.bind(this));
+  }
+}

package/src/types/OfferShippingDetails.js

@@ -0,0 +1,27 @@
+/**
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import BaseValidator from './base.js';
+
+export default class OfferShippingDetailsValidator extends BaseValidator {
+  getConditions() {
+    return [
+      this.required('deliveryTime'),
+      this.required('shippingDestination'),
+      this.required('shippingRate'),
+      this.required('shippingRate.currency'),
+      this.or(
+        this.required('shippingRate.value'),
+        this.required('shippingRate.maxValue'),
+      ),
+    ].map((c) => c.bind(this));
+  }
+}

package/src/types/Organization.js

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import BaseValidator from './base.js';
+
+export default class OrganizationValidator extends BaseValidator {
+  getConditions() {
+    return [this.required('name')].map((c) => c.bind(this));
+  }
+}

package/src/types/PeopleAudience.js

@@ -0,0 +1,37 @@
+/**
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import BaseValidator from './base.js';
+
+export default class PeopleAudienceValidator extends BaseValidator {
+  getConditions(data) {
+    const conditions = [
+      this.recommended('suggestedGender'),
+
+      this.or(
+        this.recommended('suggestedMinAge', 'number'),
+        this.recommended('suggestedAge.minValue', 'number'),
+      ),
+    ];
+
+    const minAge = data.suggestedMinAge || data.suggestedAge?.minValue;
+    if (minAge && minAge < 13) {
+      conditions.push(
+        this.or(
+          this.recommended('suggestedMaxAge', 'number'),
+          this.recommended('suggestedAge.maxValue', 'number'),
+        ),
+      );
+    }
+
+    return conditions.map((c) => c.bind(this));
+  }
+}

package/src/types/Person.js

@@ -0,0 +1,18 @@
+/**
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import BaseValidator from './base.js';
+
+export default class PersonValidator extends BaseValidator {
+  getConditions() {
+    return [this.required('name')].map((c) => c.bind(this));
+  }
+}

package/src/types/PriceSpecification.js

@@ -0,0 +1,21 @@
+/**
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import BaseValidator from './base.js';
+
+export default class PriceSpecificationValidator extends BaseValidator {
+  getConditions() {
+    return [
+      this.required('price', 'number'),
+      this.recommended('priceCurrency', 'currency'),
+    ].map((c) => c.bind(this));
+  }
+}

package/src/types/Product.js

@@ -0,0 +1,90 @@
+/**
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import BaseValidator from './base.js';
+
+export default class ProductValidator extends BaseValidator {
+  getConditions() {
+    return [
+      this.required('name'),
+      this.ratingReviewOrOffers,
+      this.notesCount,
+    ].map((c) => c.bind(this));
+  }
+
+  notesCount(data) {
+    if (!data.review) {
+      return null;
+    }
+
+    const issues = [];
+    let notes = 0;
+
+    const reviews = Array.isArray(data.review) ? data.review : [data.review];
+    for (const review of reviews) {
+      // positiveNotes and negativeNotes are optional, but if they are present, they must be correct
+      if (
+        (review.positiveNotes && review.positiveNotes.itemListElement) ||
+        (review.negativeNotes && review.negativeNotes.itemListElement)
+      ) {
+        notes += review.positiveNotes?.itemListElement?.length || 0;
+        notes += review.negativeNotes?.itemListElement?.length || 0;
+      }
+    }
+
+    // Need to have at least 2 or zero notes
+    if (notes === 1) {
+      issues.push({
+        issueMessage:
+          'At least 2 notes, either positive or negative, are required',
+        severity: 'WARNING',
+        path: this.path,
+        fieldName: 'review',
+        fieldNames: ['review.positiveNotes', 'review.negativeNotes'],
+      });
+    }
+
+    return issues;
+  }
+
+  ratingReviewOrOffers(data) {
+    const issues = [];
+
+    // One of the three is required
+    if (!data.aggregateRating && !data.offers && !data.review) {
+      issues.push({
+        issueMessage:
+          'One of the following attributes is required: "aggregateRating", "offers" or "review"',
+        severity: 'ERROR',
+        path: this.path,
+        fieldName: 'aggregateRating',
+        fieldNames: ['aggregateRating', 'offers', 'review'],
+      });
+    }
+
+    // If only offers is present, then aggregateRating and review are recommended
+    if (data.offers && (!data.aggregateRating || !data.review)) {
+      const aggregateRating = this.recommended(
+        'aggregateRating',
+        'object',
+      )(data);
+      if (aggregateRating) {
+        issues.push(aggregateRating);
+      }
+      const review = this.recommended('review', 'object')(data);
+      if (review) {
+        issues.push(review);
+      }
+    }
+
+    return issues;
+  }
+}

package/src/types/ProductMerchant.js

@@ -0,0 +1,88 @@
+/**
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import BaseValidator from './base.js';
+
+export default class ProductMerchantValidator extends BaseValidator {
+  getConditions() {
+    return [
+      this.required('image'),
+      this.required('offers'),
+
+      this.recommended('audience'),
+      this.recommended('brand'),
+      this.recommended('color', 'string'),
+      this.recommended('description', 'string'),
+      this.recommended('hasCertification'),
+      this.recommended('inProductGroupWithID', 'string'),
+      this.recommended('isVariantOf'),
+      this.recommended('material', 'string'),
+      this.recommended('mpn', 'string'),
+      this.recommended('pattern', 'string'),
+      this.recommended('size'),
+      this.recommended('sku', 'string'),
+      this.recommended('subjectOf'),
+      this.validateGtin,
+    ].map((c) => c.bind(this));
+  }
+
+  validateGtin(data) {
+    let gtinFields = ['gtin', 'gtin8', 'gtin12', 'gtin13', 'gtin14', 'isbn'];
+
+    // Check if gtin is present on product
+    const productPass =
+      this.or(...gtinFields.map((field) => this.recommended(field, 'string')))(
+        data,
+      ) === null;
+
+    // Check if gtin is present on offers object
+    let offerPass = false;
+    if (
+      data.offers &&
+      typeof data.offers === 'object' &&
+      !Array.isArray(data.offers)
+    ) {
+      offerPass =
+        this.or(
+          ...gtinFields.map((field) =>
+            this.recommended(`offers.${field}`, 'string'),
+          ),
+        )(data.offers) === null;
+    }
+
+    // Check if gtin is present on offers array
+    let allOffersPass = false;
+    if (data.offers && Array.isArray(data.offers)) {
+      allOffersPass = true;
+      data.offers.forEach((offer, index) => {
+        const offerPass =
+          this.or(
+            ...gtinFields.map((field) => this.recommended(field, 'string')),
+          )(offer, index, data) === null;
+        if (!offerPass) {
+          allOffersPass = false;
+        }
+      });
+    }
+
+    if (productPass || offerPass || allOffersPass) {
+      return null;
+    }
+
+    return {
+      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/QuantitativeValue.js

@@ -0,0 +1,36 @@
+/**
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import BaseValidator from './base.js';
+
+export default class QuantitativeValueValidator extends BaseValidator {
+  getConditions() {
+    if (this.inType('UnitPriceSpecification')) {
+      // If used in the context of unit pricing
+      return [
+        this.required('unitCode'),
+        this.required('value'),
+
+        this.recommended('valueReference'),
+      ].map((c) => c.bind(this));
+    }
+
+    if (this.inType('ShippingDeliveryTime')) {
+      return [
+        this.required('maxValue'),
+        this.required('minValue'),
+        this.required('unitCode'),
+      ].map((c) => c.bind(this));
+    }
+
+    return [];
+  }
+}

package/src/types/Question.js

@@ -0,0 +1,21 @@
+/**
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import BaseValidator from './base.js';
+
+export default class QuestionValidator extends BaseValidator {
+  getConditions() {
+    return [
+      this.required('name'),
+      this.required('acceptedAnswer', 'object'),
+    ].map((c) => c.bind(this));
+  }
+}

package/src/types/Rating.js

@@ -0,0 +1,56 @@
+/**
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import BaseValidator from './base.js';
+
+export default class RatingValidator extends BaseValidator {
+  getConditions() {
+    const conditions = [
+      this.required('ratingValue'),
+      this.validateRange,
+
+      // Those fields are listed as recommended in documentation
+      // BUT: Google validator does not show warnings and assumes default values 0 and 5.
+      this.recommended('bestRating'),
+      this.recommended('worstRating'),
+    ];
+
+    return conditions.map((c) => c.bind(this));
+  }
+
+  validateRange(data) {
+    // If number or if it can be parsed as number
+    // For % and / values, Google ignores the range
+    const from = data.worstRating || 0;
+    const to = data.bestRating || 5;
+    let value = data.ratingValue;
+    if (typeof value === 'string') {
+      // Try to parse as number
+      value = parseFloat(value);
+      if (!isNaN(value)) {
+        return null;
+      }
+    }
+
+    if (typeof value === 'number') {
+      if (value < from || value > to) {
+        return {
+          issueMessage: `Rating is outside the specified or default range`,
+          severity: 'ERROR',
+          path: this.path,
+          fieldName: 'ratingValue',
+        };
+      }
+    }
+
+    return null;
+  }
+}

package/src/types/Recipe.js

@@ -0,0 +1,75 @@
+/**
+ * Copyright 2025 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import BaseValidator from './base.js';
+
+export default class RecipeValidator extends BaseValidator {
+  getConditions() {
+    const conditions = [
+      this.validateImage,
+      this.required('name', 'string'),
+
+      this.recommended('aggregateRating'),
+      this.recommended('author'),
+      this.recommended('datePublished', 'date'),
+      this.recommended('description', 'string'),
+      this.recommended('keywords', 'string'),
+      this.recommended('recipeCategory', 'string'),
+      this.recommended('recipeCuisine', 'string'),
+      this.recommended('recipeIngredient'),
+      this.recommended('recipeInstructions'),
+      this.validateNutritionAndYield,
+      this.validateCookTime,
+      this.recommended('video'),
+    ];
+    return conditions.map((c) => c.bind(this));
+  }
+
+  validateNutritionAndYield(data) {
+    const issues = [];
+    if (data.nutrition?.calories && !data.recipeYield) {
+      issues.push(this.required('recipeYield')(data));
+    } else {
+      issues.push(this.recommended('recipeYield')(data));
+      issues.push(this.recommended('nutrition.calories')(data));
+    }
+    return issues.filter((issue) => issue !== null);
+  }
+
+  validateCookTime(data) {
+    const issues = [];
+    const hasCookTime = data.cookTime !== undefined && data.cookTime !== null;
+    const hasPrepTime = data.prepTime !== undefined && data.prepTime !== null;
+    const hasTotalTime =
+      data.totalTime !== undefined && data.totalTime !== null;
+
+    if (hasCookTime || hasPrepTime) {
+      issues.push(this.recommended('prepTime', 'duration')(data));
+      issues.push(this.recommended('cookTime', 'duration')(data));
+      if (hasTotalTime) {
+        issues.push(this.recommended('totalTime', 'duration')(data));
+      }
+    } else {
+      issues.push(this.recommended('totalTime', 'duration')(data));
+    }
+    return issues.filter((issue) => issue !== null);
+  }
+
+  validateImage(data) {
+    const issues = [];
+    if (Array.isArray(data.image)) {
+      issues.push(this.required('image', 'url')(data));
+    } else {
+      issues.push(this.required('image')(data));
+    }
+    return issues.filter((issue) => issue !== null);
+  }
+}