fix(schema-org): allow @id override (#275)

Co-authored-by: Thomas Lamant <tom@tmlmt.com>
unjs · Nov 21, 2023 · 2cc88b7 · 2cc88b7
1 parent cc4f7df
commit 2cc88b7
Show file tree

Hide file tree

Showing 4 changed files with 95 additions and 2 deletions.
diff --git a/packages/schema-org/src/core/resolve.ts b/packages/schema-org/src/core/resolve.ts
@@ -105,7 +105,7 @@ export function resolveNodeId<T extends Thing>(node: T, ctx: SchemaOrgGraph, res
     return node
   }
 
-  const rootId = Array.isArray(resolver.idPrefix) ? resolver.idPrefix?.[1] : undefined
+  const rootId = node['@id'] || (Array.isArray(resolver.idPrefix) ? resolver.idPrefix?.[1] : undefined)
   // transform ['host', PrimaryWebPageId] to https://host.com/#webpage
   if (resolveAsRoot && rootId) {
     // allow overriding root ids

diff --git a/packages/schema-org/src/nodes/LocalBusiness/index.test.ts b/packages/schema-org/src/nodes/LocalBusiness/index.test.ts
@@ -80,4 +80,46 @@ describe('defineLocalBusiness', () => {
       `)
     })
   })
+
+  it('can have custom id', async () => {
+    await useSetup(async () => {
+      useSchemaOrg([
+        defineLocalBusiness({
+          '@type': 'Dentist',
+          'name': 'test',
+          'address': {
+            addressCountry: 'Australia',
+            postalCode: '2000',
+            streetAddress: '123 st',
+          },
+          '@id': 'https://example.com/place/123#identity',
+          'url': 'https://www.test.com',
+        }),
+      ])
+
+      const graphNodes = await injectSchemaOrg()
+
+      expect(graphNodes).toMatchInlineSnapshot(`
+        [
+          {
+            "@id": "https://example.com/place/123#identity",
+            "@type": [
+              "Organization",
+              "LocalBusiness",
+              "Dentist",
+            ],
+            "address": {
+              "@type": "PostalAddress",
+              "addressCountry": "Australia",
+              "postalCode": "2000",
+              "streetAddress": "123 st",
+            },
+            "currenciesAccepted": "AUD",
+            "name": "test",
+            "url": "https://www.test.com",
+          },
+        ]
+      `)
+    })
+  })
 })
diff --git a/packages/schema-org/src/utils/index.ts b/packages/schema-org/src/utils/index.ts
@@ -75,7 +75,7 @@ export function dedupeMerge<T extends Thing>(node: T, field: keyof T, value: any
 export function prefixId(url: string, id: Id | string) {
   // already prefixed
   if (hasProtocol(id))
-    return url as Id
+    return id as Id
   if (!id.startsWith('#'))
     id = `#${id}`
   return joinURL(url, id) as Id

diff --git a/test/schema.org/ssr/ids.test.ts b/test/schema.org/ssr/ids.test.ts
@@ -0,0 +1,51 @@
+import { describe, expect, it } from 'vitest'
+import { createHead, useHead } from 'unhead'
+import { defineWebPage, useSchemaOrg } from '@unhead/schema-org'
+
+describe('schema.org ssr ids', () => {
+  it('adds host prefix to custom id without host', async () => {
+    const ssrHead = createHead()
+
+    useHead({
+      templateParams: {
+        schemaOrg: {
+          host: 'https://example.com',
+        },
+      },
+    })
+
+    useSchemaOrg([
+      defineWebPage({
+        '@id': '#foo',
+        'name': 'foo',
+      }),
+    ])
+
+
+    const tags = await ssrHead.resolveTags()
+    const id = JSON.parse(tags[0].innerHTML!)['@graph'][0]['@id']
+    expect(id).toMatchInlineSnapshot('"https://example.com/#foo"')
+  })
+  it('allows ids with custom domains', async () => {
+    const ssrHead = createHead()
+
+    useHead({
+      templateParams: {
+        schemaOrg: {
+          host: 'https://example.com',
+        },
+      },
+    })
+
+    useSchemaOrg([
+      defineWebPage({
+        '@id': 'https://custom-domain.com/#foo',
+        'name': 'foo',
+      }),
+    ])
+
+    const tags = await ssrHead.resolveTags()
+    const id = JSON.parse(tags[0].innerHTML!)['@graph'][0]['@id']
+    expect(id).toMatchInlineSnapshot('"https://custom-domain.com/#foo"')
+  })
+})