feat: Add tagPosition parameter

Author: resessh

cypress/e2e/test.cy.js

@@ -91,4 +91,16 @@ describe('nuxt-jsonld', () => {
         expect(json).to.have.property('count', 2);
       });
   });
+
+  it('places jsonld with tagPosition', () => {
+    cy.visit('/composable-options');
+    cy.get('body script[type="application/ld+json"]')
+      .should('exist')
+      .then((el) => {
+        const json = JSON.parse(el.text());
+        expect(json).to.have.property('@context', 'https://schema.org');
+        expect(json).to.have.property('@type', 'WebSite');
+        expect(json).to.have.property('name', 'nuxt-jsonld composable options');
+      });
+  });
 });

packages/example/pages/composable-options.vue

@@ -0,0 +1,24 @@
+<template>
+  <div>
+    <h1>Composable Options</h1>
+  </div>
+</template>
+
+<script lang="ts">
+export default defineComponent({
+  setup() {
+    useJsonld(
+      () => {
+        return {
+          '@context': 'https://schema.org',
+          '@type': 'WebSite',
+          name: 'nuxt-jsonld composable options',
+        };
+      },
+      {
+        tagPosition: 'bodyClose',
+      }
+    );
+  },
+});
+</script>

packages/example/pages/index.vue

@@ -10,6 +10,7 @@
       </li>
       <li><nuxt-link :to="{ name: 'static' }">Static JSON</nuxt-link></li>
       <li><nuxt-link :to="{ name: 'option' }">Options API</nuxt-link></li>
+      <li><nuxt-link :to="{ name: 'composable-options' }">Composable API Options</nuxt-link></li>
     </ul>
   </div>
 </template>

packages/nuxt-jsonld/src/module.ts

@@ -3,6 +3,8 @@ import { defineNuxtModule, addPlugin, addImports } from '@nuxt/kit';
 import type { Nuxt } from '@nuxt/schema';
 import type { JsonLDFunc } from './types';
 
+export type { UseJsonldOptions } from './runtime/composable';
+
 type ModuleOptions = {
   disableOptionsAPI: boolean;
 };

packages/nuxt-jsonld/src/runtime/composable.ts

@@ -1,10 +1,11 @@
 import { computed } from 'vue';
 import type { JsonLD, JsonLDFunc } from '../types';
-import { useHead } from '@unhead/vue';
+import { useHead, type UseHeadOptions } from '@unhead/vue';
 
 const isFunc = (json: JsonLD | JsonLDFunc): json is JsonLDFunc => typeof json === 'function';
+export type UseJsonldOptions = Pick<UseHeadOptions, 'tagPosition'>;
 
-export const useJsonld = (json: JsonLD | JsonLDFunc) => {
+export const useJsonld = (json: JsonLD | JsonLDFunc, options?: UseJsonldOptions) => {
   if (!json) {
     return;
   }
@@ -22,5 +23,5 @@ export const useJsonld = (json: JsonLD | JsonLDFunc) => {
         },
       ],
     };
-  });
+  }, options);
 };