add listing item json ld

Author: dnywh

e2e/seo.spec.ts

@@ -11,6 +11,17 @@ async function getListingJsonLdScripts(page: import("@playwright/test").Page) {
   return page.locator('script[type="application/ld+json"]').allTextContents();
 }
 
+type ListingJsonLd = {
+  "@id"?: string;
+  about?: {
+    additionalProperty?: unknown;
+  };
+};
+
+function parseJsonLdScripts(scripts: string[]) {
+  return scripts.map((script) => JSON.parse(script) as ListingJsonLd);
+}
+
 async function newLocalePage(
   browser: import("@playwright/test").Browser,
   locale: string,
@@ -53,6 +64,24 @@ test("public listing pages expose crawlable listing metadata", async ({
         script.includes("Marrickville Neighbourhood Compost")
     )
   ).toBeTruthy();
+
+  const listingJsonLd = parseJsonLdScripts(jsonLdScripts).find(
+    (data) =>
+      data["@id"] ===
+      "https://www.peels.app/listings/demo-marrickville-compost#webpage"
+  );
+  expect(listingJsonLd?.about?.additionalProperty).toEqual(
+    expect.arrayContaining([
+      expect.objectContaining({
+        name: "Accepted food scraps",
+        value: expect.stringContaining("Fruit and vegetable scraps"),
+      }),
+      expect.objectContaining({
+        name: "Items not accepted",
+        value: expect.stringContaining("Plastic bags"),
+      }),
+    ])
+  );
 });
 
 test("public listing pages localise Spanish SEO metadata", async ({

src/utils/listingUtils.test.ts

@@ -15,7 +15,7 @@ const communityListing = {
   description:
     "Households can subscribe to drop off their food scraps at a local community hub.",
   accepted_items: ["Food scraps"],
-  rejected_items: [],
+  rejected_items: ["Meat and dairy"],
   photos: ["demo/community-garden.jpg"],
   links: [],
   type: "community",
@@ -274,6 +274,20 @@ test("listing JSON-LD describes the public listing page and place conservatively
   assert.ok(jsonLd.about.address);
   assert.equal(jsonLd.about.address.addressLocality, "Marrickville");
   assert.equal(jsonLd.about.address.addressCountry, "Australia");
+  assert.deepEqual(jsonLd.about.additionalProperty, [
+    {
+      "@type": "PropertyValue",
+      name: "Accepted food scraps",
+      propertyID: "acceptedItems",
+      value: "Food scraps",
+    },
+    {
+      "@type": "PropertyValue",
+      name: "Items not accepted",
+      propertyID: "rejectedItems",
+      value: "Meat and dairy",
+    },
+  ]);
 });
 
 test("listing JSON-LD can use localised descriptions, country names, and language", () => {
@@ -312,6 +326,7 @@ test("anonymous residential listing JSON-LD omits structured location details",
   assert.equal(jsonLd.name, "Private Host");
   assert.equal(jsonLd.about.address, undefined);
   assert.equal(jsonLd.about.geo, undefined);
+  assert.equal(jsonLd.about.additionalProperty, undefined);
 });
 
 test("anonymous listing JSON-LD treats missing listing types as sensitive", () => {

src/utils/listingUtils.ts

@@ -15,6 +15,8 @@ type ListingLike = {
   country_code?: string | null;
   area_name?: string | null;
   description?: string | null;
+  accepted_items?: string[] | null;
+  rejected_items?: string[] | null;
   photos?: string[] | null;
   coordinates?: ListingCoordinates | null;
 };
@@ -98,6 +100,36 @@ function compactTextParts(parts: Array<string | null | undefined>) {
     .filter((part): part is string => Boolean(part));
 }
 
+function compactTextList(items: string[] | null | undefined) {
+  return items
+    ?.map((item) => item.trim())
+    .filter((item): item is string => Boolean(item));
+}
+
+function getListingItemProperties(listing: ListingLike) {
+  const acceptedItems = compactTextList(listing.accepted_items) ?? [];
+  const rejectedItems = compactTextList(listing.rejected_items) ?? [];
+
+  return [
+    acceptedItems.length
+      ? {
+          "@type": "PropertyValue",
+          name: "Accepted food scraps",
+          propertyID: "acceptedItems",
+          value: acceptedItems.join(", "),
+        }
+      : null,
+    rejectedItems.length
+      ? {
+          "@type": "PropertyValue",
+          name: "Items not accepted",
+          propertyID: "rejectedItems",
+          value: rejectedItems.join(", "),
+        }
+      : null,
+  ].filter((item): item is NonNullable<typeof item> => Boolean(item));
+}
+
 function getListingCountryName(
   listing: ListingLike | null | undefined,
   locale?: string
@@ -390,6 +422,9 @@ export function generateListingJsonLd(
   const structuredDataImage = canIncludePublicStructuredDetails
     ? getListingStructuredDataImage(listing, user)
     : null;
+  const itemProperties = canIncludePublicStructuredDetails
+    ? getListingItemProperties(listing)
+    : [];
   const address = {
     "@type": "PostalAddress",
     ...(listing.area_name ? { addressLocality: listing.area_name } : {}),
@@ -412,6 +447,7 @@ export function generateListingJsonLd(
         }
       : {}),
     ...(structuredDataImage ? { image: structuredDataImage } : {}),
+    ...(itemProperties.length ? { additionalProperty: itemProperties } : {}),
   };
 
   return {