@pagefront/lint-commerce 0.5.0 → 0.6.0

package/README.md

@@ -24,6 +24,35 @@ failure. Both commerce page types are handled: product sheets and
 Commerce Organization Sheets each validate against their own schema and
 lint with their own catalogue, dispatched by sheet type.
 
+## Catalogue
+
+Catalogue 0.9.0, targeting format 0.9: 35 product rules (`PDP-E-001` to
+`PDP-E-004`, `PDP-W-001` to `PDP-W-030`, `PDP-I-001`) and 7 organization
+rules (`ORG-E-001`, `ORG-W-001` to `ORG-W-006`), each defined in
+[`rules.md`](https://github.com/themachineweb/pagefront/blob/main/commerce/spec/rules.md)
+with its target, check, message and remediation. Every report carries the
+`catalogue_version` it was produced with.
+
+Added in 0.5.0 (catalogue 0.8.0), from the product spec's
+["Tax inclusion"](https://themachineweb.org/pagefront/spec/commerce/product#tax-inclusion)
+section:
+
+- `PDP-W-028` — an Offer states a price but no `priceSpecification` entry
+  carries a boolean `valueAddedTaxIncluded`
+- `PDP-W-029` — an Offer states a price but declares neither `areaServed`
+  nor `eligibleRegion`
+- `PDP-E-004` — a `priceSpecification` entry mirroring the Offer's price
+  states a different amount in the same currency
+
+The two warnings exempt offers carrying `pagefront:priceOnRequest`.
+
+Added in 0.6.0 (catalogue 0.9.0), from the product spec's
+["Warranty"](https://themachineweb.org/pagefront/spec/commerce/product#warranty)
+section:
+
+- `PDP-W-030` — a `warranty` on an Offer, or a `pagefront:manufacturerWarranty`
+  on the Product, carries neither `durationOfWarranty` nor `description`
+
 ## API
 
 The public surface — everything importable from the package root, and

package/dist/catalogue.js

@@ -31,6 +31,7 @@ import { pdpW026 } from "./rules/pdp-w-026.js";
 import { pdpW027 } from "./rules/pdp-w-027.js";
 import { pdpW028 } from "./rules/pdp-w-028.js";
 import { pdpW029 } from "./rules/pdp-w-029.js";
+import { pdpW030 } from "./rules/pdp-w-030.js";
 import { pdpI001 } from "./rules/pdp-i-001.js";
 /**
  * The commerce product-sheet rule catalogue — the executable form of
@@ -42,6 +43,6 @@ import { pdpI001 } from "./rules/pdp-i-001.js";
 export const commerceCatalogue = {
     vertical: "commerce",
     formatVersion: "0.9",
-    catalogueVersion: "0.8.0",
-    rules: [pdpE001, pdpE002, pdpE003, pdpE004, pdpW001, pdpW002, pdpW003, pdpW004, pdpW005, pdpW006, pdpW007, pdpW008, pdpW009, pdpW010, pdpW011, pdpW012, pdpW013, pdpW014, pdpW015, pdpW016, pdpW017, pdpW018, pdpW019, pdpW020, pdpW021, pdpW022, pdpW023, pdpW024, pdpW025, pdpW026, pdpW027, pdpW028, pdpW029, pdpI001],
+    catalogueVersion: "0.9.0",
+    rules: [pdpE001, pdpE002, pdpE003, pdpE004, pdpW001, pdpW002, pdpW003, pdpW004, pdpW005, pdpW006, pdpW007, pdpW008, pdpW009, pdpW010, pdpW011, pdpW012, pdpW013, pdpW014, pdpW015, pdpW016, pdpW017, pdpW018, pdpW019, pdpW020, pdpW021, pdpW022, pdpW023, pdpW024, pdpW025, pdpW026, pdpW027, pdpW028, pdpW029, pdpW030, pdpI001],
 };

package/dist/organization-catalogue.js

@@ -17,6 +17,6 @@ import { orgW006 } from "./rules/org-w-006.js";
 export const organizationCatalogue = {
     vertical: "commerce",
     formatVersion: "0.9",
-    catalogueVersion: "0.8.0",
+    catalogueVersion: "0.9.0",
     rules: [orgE001, orgW001, orgW002, orgW003, orgW004, orgW005, orgW006],
 };

package/dist/product-schema.js

@@ -348,6 +348,9 @@ export const PRODUCT_SCHEMA = {
                 "pagefront:madeToOrderTerms": {
                     "$ref": "#/$defs/madeToOrderTerms"
                 },
+                "pagefront:manufacturerWarranty": {
+                    "type": "object"
+                },
                 "pagefront:careInstructions": {
                     "type": "array",
                     "items": {
@@ -1214,6 +1217,9 @@ export const PRODUCT_SCHEMA = {
                 "hasMerchantReturnPolicy": {
                     "type": "object"
                 },
+                "warranty": {
+                    "type": "object"
+                },
                 "areaServed": {},
                 "eligibleRegion": {
                     "type": "array"

package/dist/rules/pdp-w-030.d.ts

@@ -0,0 +1,2 @@
+import type { Rule } from "@pagefront/lint-core";
+export declare const pdpW030: Rule;

package/dist/rules/pdp-w-030.js

@@ -0,0 +1,52 @@
+/**
+ * PDP-W-030 — Offer or product warranty with no content.
+ * Transcribed from commerce/spec/rules.md (normative).
+ *
+ * Present-but-empty rule (the PDP-W-022 / PDP-W-027 family): a
+ * `warranty` on an offer, or the data block's
+ * `pagefront:manufacturerWarranty`, that carries neither
+ * `durationOfWarranty` nor a non-empty `description`. The rule's
+ * conceptual target spans two positions; the JSONPath target matches
+ * the data block once and the check walks both from there, giving each
+ * finding the entry's own path.
+ */
+const isEmptyWarranty = (entry) => {
+    if (typeof entry !== "object" || entry === null || Array.isArray(entry))
+        return false;
+    const e = entry;
+    if (e["durationOfWarranty"] !== undefined && e["durationOfWarranty"] !== null)
+        return false;
+    const description = e["description"];
+    return !(typeof description === "string" && description.trim() !== "");
+};
+export const pdpW030 = {
+    id: "PDP-W-030",
+    title: "Offer or product warranty with no content",
+    severity: "warning",
+    target: "$.data",
+    check: (match) => {
+        const data = match.value;
+        if (typeof data !== "object" || data === null)
+            return null;
+        const d = data;
+        const hits = [];
+        if (isEmptyWarranty(d["pagefront:manufacturerWarranty"])) {
+            hits.push({ path: `${match.path}['pagefront:manufacturerWarranty']` });
+        }
+        const offers = d["offers"];
+        if (Array.isArray(offers)) {
+            offers.forEach((offer, index) => {
+                if (typeof offer !== "object" || offer === null)
+                    return;
+                if (isEmptyWarranty(offer["warranty"])) {
+                    hits.push({ path: `${match.path}['offers'][${index}]['warranty']` });
+                }
+            });
+        }
+        return hits.length > 0 ? hits : null;
+    },
+    messageTemplate: "Warranty at `{path}` states neither a duration nor a description.",
+    remediation: "State the warranty as written in `description`, and add `durationOfWarranty` where a finite length is stated. A lifetime warranty carries `description` (and optionally `name`) with no `durationOfWarranty`.",
+    introduced: "v0.9",
+    specReference: "product.md#warranty",
+};

package/dist/schema-properties.js

@@ -46,6 +46,7 @@ export const DATA_BLOCK_PROPERTIES = [
     "pagefront:gemstone",
     "pagefront:legalEntity",
     "pagefront:madeToOrderTerms",
+    "pagefront:manufacturerWarranty",
     "pagefront:manufacturingChain",
     "pagefront:materialComposition",
     "pagefront:productHighlights",