fix(schema-org): LocalBusiness extends Organization for Logo Rich Results

Fixes #270

Author: harlan-zw

packages/schema-org/src/nodes/Article/index.test.ts

@@ -378,7 +378,7 @@ describe('defineArticle', () => {
             "url": "https://example.com/test.png",
           },
           {
-            "@id": "#organization",
+            "@id": "https://example.com/#organization",
             "@type": "Organization",
             "logo": "https://example.com/test.png",
             "name": "Identity",

packages/schema-org/src/nodes/LocalBusiness/index.test.ts

@@ -48,14 +48,6 @@ describe('defineLocalBusiness', () => {
               "streetAddress": "123 st",
             },
             "currenciesAccepted": "AUD",
-            "logo": {
-              "@id": "https://example.com/#logo",
-              "@type": "ImageObject",
-              "caption": "test",
-              "contentUrl": "https://example.com/logo.png",
-              "inLanguage": "en-AU",
-              "url": "https://example.com/logo.png",
-            },
             "name": "test",
             "openingHoursSpecification": [
               {
@@ -76,6 +68,27 @@ describe('defineLocalBusiness', () => {
             ],
             "url": "https://example.com/",
           },
+          {
+            "@id": "https://example.com/#/schema/image/acd40d1",
+            "@type": "ImageObject",
+            "caption": "test",
+            "contentUrl": "https://example.com/logo.png",
+            "inLanguage": "en-AU",
+            "url": "https://example.com/logo.png",
+          },
+          {
+            "@id": "https://example.com/#organization",
+            "@type": "Organization",
+            "address": {
+              "@type": "PostalAddress",
+              "addressCountry": "Australia",
+              "postalCode": "2000",
+              "streetAddress": "123 st",
+            },
+            "logo": "https://example.com/logo.png",
+            "name": "test",
+            "url": "https://example.com/",
+          },
         ]
       `)
     })

packages/schema-org/src/nodes/LocalBusiness/index.ts

@@ -1,16 +1,14 @@
 import {
   IdentityId,
-  prefixId,
   resolveDefaultType,
-  setIfEmpty,
 } from '../../utils'
 import type { Organization } from '../Organization'
 import type { OpeningHoursSpecification } from '../OpeningHours'
 import { openingHoursResolver } from '../OpeningHours'
-import { imageResolver } from '../Image'
 import type { NodeRelations } from '../../types'
-import { defineSchemaOrgResolver, resolveRelation } from '../../core'
+import { defineSchemaOrgResolver, resolveNode, resolveRelation } from '../../core'
 import { addressResolver } from '../PostalAddress'
+import { organizationResolver } from '../Organization'
 
 type ValidLocalBusinessSubTypes = 'AnimalShelter' |
 'ArchiveOrganization' |
@@ -107,15 +105,9 @@ export const localBusinessResolver = defineSchemaOrgResolver<LocalBusiness>({
 
     node.address = resolveRelation(node.address, ctx, addressResolver)
     node.openingHoursSpecification = resolveRelation(node.openingHoursSpecification, ctx, openingHoursResolver)
-    node.logo = resolveRelation(node.logo, ctx, imageResolver, {
-      afterResolve(logo) {
-        const hasLogo = !!ctx.find('#logo')
-        if (!hasLogo)
-          logo['@id'] = prefixId(ctx.meta.host, '#logo')
 
-        setIfEmpty(logo, 'caption', node.name)
-      },
-    })
-    return node
+    node = resolveNode({ ...node }, ctx, organizationResolver) as LocalBusiness
+    organizationResolver.resolveRootNode!(node, ctx)
+    return node as LocalBusiness
   },
 })

packages/schema-org/src/nodes/Organization/index.test.ts

@@ -42,7 +42,7 @@ describe('defineOrganization', () => {
             "url": "https://example.com/logo.png",
           },
           {
-            "@id": "#organization",
+            "@id": "https://example.com/#organization",
             "@type": "Organization",
             "address": {
               "@type": "PostalAddress",

packages/schema-org/src/nodes/Organization/index.ts

@@ -96,11 +96,18 @@ export const organizationResolver
 
           // push a separate node that will just be used for the Logo rich result
           ctx.nodes.push({
-            ...node,
+            // we want to make a simple node that has the essentials, this will allow parent nodes to inject
+            // as well without inserting invalid data (i.e LocalBusiness operatingHours)
+            '@type': 'Organization',
+            'name': node.name,
+            'url': node.url,
+            'sameAs': node.sameAs,
+            // 'image': idReference(logoNode),
+            'address': node.address,
             // needs to be a URL
             'logo': resolveRelation(node.logo, ctx, imageResolver, { root: false }).url,
             '_priority': -1,
-            '@id': '#organization', // avoid the id so nothing can link to it
+            '@id': prefixId(ctx.meta.host, '#organization'), // avoid the id so nothing can link to it
           })
         }
         delete node.logo

packages/schema-org/src/nodes/WebPage/index.test.ts

@@ -292,7 +292,7 @@ describe('defineWebPage', () => {
             "url": "https://example.com/logo.png",
           },
           {
-            "@id": "#organization",
+            "@id": "https://example.com/#organization",
             "@type": "Organization",
             "logo": "https://example.com/logo.png",
             "name": "Harlan Wilton",

test/schema.org/ssr/ids.test.ts

@@ -21,7 +21,6 @@ describe('schema.org ssr ids', () => {
       }),
     ])
 
-
     const tags = await ssrHead.resolveTags()
     const id = JSON.parse(tags[0].innerHTML!)['@graph'][0]['@id']
     expect(id).toMatchInlineSnapshot('"https://example.com/#foo"')