fix(schemaOrg): broken entry patching types

Author: harlan-zw

packages/schema-org/src/runtime.ts

@@ -1,4 +1,4 @@
-import type { HeadEntryOptions, Unhead } from 'unhead/types'
+import type {ActiveHeadEntry, HeadEntryOptions, Unhead} from 'unhead/types'
 import type {
   AggregateOffer,
   AggregateRating,
@@ -37,7 +37,6 @@ import type {
   WebSite,
 } from './nodes'
 import type { Arrayable, Thing } from './types'
-import { useHead } from 'unhead'
 import { UnheadSchemaOrg } from './plugin'
 
 function provideResolver<T>(input?: T, resolver?: string) {
@@ -160,19 +159,22 @@ export function defineBookEdition<T extends Record<string, any>>(input?: BookEdi
 
 export type UseSchemaOrgInput = Arrayable<Thing | Record<string, any>>
 
-export function useSchemaOrg(head: Unhead<any>, input: UseSchemaOrgInput, options?: HeadEntryOptions) {
-  // lazy initialise the plugin
-  if ((Array.isArray(input) && input.length === 0) || !input) {
-    return
-  }
-  head.use(UnheadSchemaOrg())
-  return useHead(head, {
+export function normalizeSchemaOrgInput(input: UseSchemaOrgInput) {
+  return {
     script: [
       {
         type: 'application/ld+json',
         key: 'schema-org-graph',
         nodes: input,
       },
     ],
-  }, options)
+  }
+}
+
+export function useSchemaOrg(unhead: Unhead<any>, input: UseSchemaOrgInput = [], options: HeadEntryOptions = {}): ActiveHeadEntry<UseSchemaOrgInput> {
+  unhead.use(UnheadSchemaOrg())
+  const entry = unhead.push(normalizeSchemaOrgInput(input), options)
+  const corePatch = entry.patch
+  entry.patch = input => corePatch(normalizeSchemaOrgInput(input))
+  return entry
 }

packages/schema-org/src/vue/runtime/composables.ts

@@ -1,4 +1,5 @@
 import type { ResolvableProperties, UseHeadOptions } from '@unhead/vue'
+import type { ActiveHeadEntry } from 'unhead/types'
 import type {
   AggregateOffer,
   AggregateRating,
@@ -39,6 +40,8 @@ import type {
 } from '../../'
 import type { Arrayable } from '../../types'
 import { injectHead, useHead } from '@unhead/vue'
+import { normalizeSchemaOrgInput,
+} from '../../'
 import { UnheadSchemaOrg } from '../../plugin'
 
 function provideResolver<T>(input?: T, resolver?: string) {
@@ -158,19 +161,12 @@ export function defineBookEdition<T extends Record<string, any>>(input?: Resolva
 
 export type UseSchemaOrgInput = Arrayable<ResolvableProperties<Thing | Record<string, any>>>
 
-export function useSchemaOrg(input: UseSchemaOrgInput, options?: UseHeadOptions) {
+export function useSchemaOrg(input: UseSchemaOrgInput = [], options: UseHeadOptions = {}): ActiveHeadEntry<UseSchemaOrgInput> {
   // lazy initialise the plugin
-  const head = options?.head || injectHead()
-  head.use(UnheadSchemaOrg())
-  return useHead<{ script: { nodes: UseSchemaOrgInput } }>({
-    script: [
-      {
-        type: 'application/ld+json',
-        key: 'schema-org-graph',
-        nodes: input,
-      },
-    ],
-  }, {
-    head,
-  })
+  const unhead = options.head || injectHead()
+  unhead.use(UnheadSchemaOrg())
+  const entry = useHead(normalizeSchemaOrgInput(input), options) as ActiveHeadEntry<UseSchemaOrgInput>
+  const corePatch = entry.patch
+  entry.patch = input => corePatch(normalizeSchemaOrgInput(input))
+  return entry
 }

packages/schema-org/test/e2e/basic.test.ts

@@ -314,9 +314,9 @@ describe('schema.org e2e', () => {
     useSchemaOrg(ssrHead, ['test'])
     useSchemaOrg(ssrHead, [])
     // @ts-expect-error intentional
-    useSchemaOrg('')
+    useSchemaOrg(ssrHead, '')
     // @ts-expect-error intentional
-    useSchemaOrg('test')
+    useSchemaOrg(ssrHead, 'test')
 
     const data = await renderSSRHead(ssrHead)
     expect(data.bodyTags).toMatchInlineSnapshot(`""`)

packages/schema-org/test/vue/vue.test.ts

@@ -121,4 +121,33 @@ describe('schema.org e2e', () => {
       </body></html>"
     `)
   })
+  it('empty', async () => {
+    const head = await ssrVueAppWithUnhead(() => {
+      const schema = useSchemaOrg()
+      schema.patch([
+        defineWebPage({
+          name: 'test',
+        }),
+      ])
+    })
+    const data = await renderSSRHead(head)
+    expect(data).toMatchInlineSnapshot(`
+      {
+        "bodyAttrs": "",
+        "bodyTags": "<script type="application/ld+json" data-hid="schema-org-graph">{
+        "@context": "https://schema.org",
+        "@graph": [
+          {
+            "@id": "#webpage",
+            "@type": "WebPage",
+            "name": "test"
+          }
+        ]
+      }</script>",
+        "bodyTagsOpen": "",
+        "headTags": "",
+        "htmlAttrs": "",
+      }
+    `)
+  })
 })