nuxt-schema-org 2.2.0 → 3.0.0

package/README.md

@@ -1,21 +1,79 @@
-# nuxt-schema-org
+<h1 align='center'>nuxt-schema-org</h1>
 
-The Nuxt.js integration for [@vueuse/schema-org](https://github.com/vueuse/schema-org).
+<p align="center">
+<a href='https://github.com/harlan-zw/nuxt-schema-org/actions/workflows/test.yml'>
+</a>
+<a href="https://www.npmjs.com/package/nuxt-schema-org" target="__blank"><img src="https://img.shields.io/npm/v/nuxt-schema-org?style=flat&colorA=002438&colorB=28CF8D" alt="NPM version"></a>
+<a href="https://www.npmjs.com/package/nuxt-schema-org" target="__blank"><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/nuxt-schema-org?flat&colorA=002438&colorB=28CF8D"></a>
+<a href="https://github.com/harlan-zw/nuxt-schema-org" target="__blank"><img alt="GitHub stars" src="https://img.shields.io/github/stars/harlan-zw/nuxt-schema-org?flat&colorA=002438&colorB=28CF8D"></a>
+</p>
 
-## Install
+
+<p align="center">
+The quickest and easiest way to build Schema.org graphs for Nuxt.
+</p>
+
+<p align="center">
+<table>
+<tbody>
+<td align="center">
+<img width="800" height="0" /><br>
+<i>Status:</i> <a href="https://github.com/harlan-zw/nuxt-schema-org/releases/tag/v3.0.0">v3 Released 🎉</a></b> <br>
+<sup> Please report any issues 🐛</sup><br>
+<sub>Made possible by my <a href="https://github.com/sponsors/harlan-zw">Sponsor Program 💖</a><br> Follow me <a href="https://twitter.com/harlan_zw">@harlan_zw</a> 🐦 • Join <a href="https://discord.gg/275MBUBvgP">Discord</a> for help</sub><br>
+<img width="800" height="0" />
+</td>
+</tbody>
+</table>
+</p>
+
+## Features
+
+- 😎 Simple API based on [Google](https://developers.google.com/search/docs/advanced/structured-data/search-gallery) and [Yoast](https://developer.yoast.com/features/schema/overview) best practices
+- 🧙 30+ Nodes with automated relations, date, URL resolving and more for best practice Schema.org
+- 💡 Simple global meta provides for minimal boilerplate
+- 🌳 Minimal code, optimised for tree-shaking and SSR
+
+## Installation
+
+1. Install `nuxt-schema-org` dependency to your project:
 
 ```bash
-# NPM
-npm install -D nuxt-schema-org
-# or Yarn
+#
 yarn add -D nuxt-schema-org
-# or PNPM
-pnpm add -D nuxt-schema-org
+#
+npm install -D nuxt-schema-org
+#
+pnpm i -D nuxt-schema-org
+```
+
+
+2. Add it to your `modules` section in your `nuxt.config`:
+
+```ts
+export default defineNuxtConfig({
+  modules: ['nuxt-schema-org']
+})
 ```
 
-## Setup Module
+# Documentation
+
+[📖 Read the full documentation](https://nuxtseo.com/schema-org) for more information.
+
+
+### Demos
+
+- [Dynamic URLs - StackBlitz](https://stackblitz.com/edit/nuxt-starter-dyraxc?file=server%2Fapi%2F_sitemap-urls.ts)
+- [i18n - StackBlitz](https://stackblitz.com/edit/nuxt-starter-jwuie4?file=app.vue)
+
+## Sponsors
+
+<p align="center">
+  <a href="https://raw.githubusercontent.com/harlan-zw/static/main/sponsors.svg">
+    <img src='https://raw.githubusercontent.com/harlan-zw/static/main/sponsors.svg'/>
+  </a>
+</p>
 
-Find documentation in the [Nuxt Setup](https://unhead-schema-org.harlanzw.com/guide/setup/nuxt.html) guide
 
 ## License
 

package/dist/module.d.mts

@@ -0,0 +1,38 @@
+import { NuxtModule } from '@nuxt/schema';
+import { MetaInput } from '@unhead/schema-org';
+
+interface ModuleOptions {
+    /**
+     * Whether the module should be loaded.
+     *
+     * @default true
+     */
+    enabled: boolean;
+    /**
+     * Whether the output should be minified.
+     *
+     * @default `process.env.NODE_ENV === 'production'`
+     */
+    minify: boolean;
+    /**
+     * Whether the output should be reactive or just use the initial SSR output.
+     *
+     * @default `process.dev || !nuxt.options.ssr`
+     */
+    reactive: boolean;
+    /**
+     * Enables debug logs.
+     *
+     * @default false
+     */
+    debug: boolean;
+}
+interface ModuleHooks {
+    'schema-org:meta': (meta: MetaInput) => void | Promise<void>;
+}
+interface ModulePublicRuntimeConfig {
+    ['nuxt-schema-org']: MetaInput;
+}
+declare const _default: NuxtModule<ModuleOptions>;
+
+export { type ModuleHooks, type ModuleOptions, type ModulePublicRuntimeConfig, _default as default };

package/dist/module.d.ts

@@ -1,15 +1,38 @@
-import { MetaInput, UserConfig } from '@unhead/schema-org-vue';
 import { NuxtModule } from '@nuxt/schema';
+import { MetaInput } from '@unhead/schema-org';
 
-interface ModuleOptions extends UserConfig {
+interface ModuleOptions {
+    /**
+     * Whether the module should be loaded.
+     *
+     * @default true
+     */
+    enabled: boolean;
+    /**
+     * Whether the output should be minified.
+     *
+     * @default `process.env.NODE_ENV === 'production'`
+     */
+    minify: boolean;
+    /**
+     * Whether the output should be reactive or just use the initial SSR output.
+     *
+     * @default `process.dev || !nuxt.options.ssr`
+     */
+    reactive: boolean;
+    /**
+     * Enables debug logs.
+     *
+     * @default false
+     */
+    debug: boolean;
 }
 interface ModuleHooks {
+    'schema-org:meta': (meta: MetaInput) => void | Promise<void>;
 }
-declare module '@nuxt/schema' {
-    interface RuntimeNuxtHooks {
-        'schema-org:meta': (meta: MetaInput) => void;
-    }
+interface ModulePublicRuntimeConfig {
+    ['nuxt-schema-org']: MetaInput;
 }
 declare const _default: NuxtModule<ModuleOptions>;
 
-export { ModuleHooks, ModuleOptions, _default as default };
+export { type ModuleHooks, type ModuleOptions, type ModulePublicRuntimeConfig, _default as default };

package/dist/module.json

@@ -2,8 +2,8 @@
   "name": "nuxt-schema-org",
   "configKey": "schemaOrg",
   "compatibility": {
-    "nuxt": "^3.0.0",
+    "nuxt": "^3.7.0",
     "bridge": false
   },
-  "version": "2.2.0"
+  "version": "3.0.0"
 }

package/dist/module.mjs

@@ -1,44 +1,49 @@
-import { defineNuxtModule, createResolver, addPlugin, addTemplate, addComponent } from '@nuxt/kit';
-import { schemaOrgComponents, schemaOrgAutoImports } from '@unhead/schema-org-vue';
+import { defineNuxtModule, useLogger, createResolver, addPlugin, addComponent } from '@nuxt/kit';
+import { schemaOrgComponents, schemaOrgAutoImports } from '@unhead/schema-org/vue';
+import { installNuxtSiteConfig } from 'nuxt-site-config-kit';
 
 const module = defineNuxtModule({
   meta: {
     name: "nuxt-schema-org",
     configKey: "schemaOrg",
     compatibility: {
-      nuxt: "^3.0.0",
+      nuxt: "^3.7.0",
       bridge: false
     }
   },
   defaults(nuxt) {
-    const trailingSlash = process.env.NUXT_PUBLIC_TRAILING_SLASH || nuxt.options.runtimeConfig.public.trailingSlash;
     return {
-      host: process.env.NUXT_PUBLIC_SITE_URL || nuxt.options.runtimeConfig.public?.siteUrl,
-      trailingSlash: typeof trailingSlash !== "undefined" ? trailingSlash : false
+      enabled: true,
+      debug: false,
+      reactive: nuxt.options.dev || !nuxt.options.ssr,
+      minify: process.env.NODE_ENV === "production"
     };
   },
   async setup(config, nuxt) {
+    const logger = useLogger("nuxt-schema-org");
+    logger.level = config.debug || nuxt.options.debug ? 4 : 3;
+    if (config.enabled === false) {
+      logger.debug("The module is disabled, skipping setup.");
+      return;
+    }
     const { resolve } = createResolver(import.meta.url);
+    await installNuxtSiteConfig();
     const moduleRuntimeDir = resolve("./runtime");
+    nuxt.options.runtimeConfig.public["nuxt-schema-org"] = config;
     nuxt.options.build.transpile.push(...[
       moduleRuntimeDir,
-      "@vueuse/schema-org",
-      "@unhead/schema-org-vue"
+      "@unhead/schema-org"
     ]);
     addPlugin({
       src: resolve(moduleRuntimeDir, "plugin"),
-      mode: nuxt.options.dev || !nuxt.options.ssr ? "all" : "server"
+      mode: config.reactive ? "all" : "server"
     });
-    nuxt.options.alias["#nuxt-schema-org/config"] = addTemplate({
-      filename: "nuxt-schema-org-config.mjs",
-      getContents: () => `export default ${JSON.stringify(config)}`
-    }).dst;
     for (const component of schemaOrgComponents) {
       await addComponent({
         name: component,
         export: component,
         chunkName: "nuxt-schema-org/components",
-        filePath: "@unhead/schema-org-vue"
+        filePath: "@unhead/schema-org/vue"
       });
     }
     nuxt.hooks.hook("imports:sources", (autoImports) => {

package/dist/runtime/plugin.mjs

@@ -1,19 +1,29 @@
-import { SchemaOrgUnheadPlugin } from "@unhead/schema-org-vue";
-import config from "#nuxt-schema-org/config";
-import { defineNuxtPlugin, useRouter } from "#app";
-import { unref } from "#imports";
-export default defineNuxtPlugin((nuxtApp) => {
-  const head = nuxtApp.vueApp._context.provides.usehead;
-  const router = useRouter();
-  const currentRoute = router.currentRoute;
-  head.use(SchemaOrgUnheadPlugin(config, async () => {
-    const route = unref(currentRoute);
-    const meta = {
-      ...config,
-      path: route.path,
-      ...route.meta
-    };
-    await nuxtApp.hooks.callHook("schema-org:meta", meta);
-    return meta;
-  }));
+import { PluginSchemaOrg } from "@unhead/schema-org";
+import { defineNuxtPlugin, injectHead, unref, useRouter, useRuntimeConfig, useSiteConfig } from "#imports";
+export default defineNuxtPlugin({
+  name: "nuxt-schema-org:init",
+  enforce: "post",
+  setup(nuxtApp) {
+    const head = injectHead();
+    const config = useRuntimeConfig().public["nuxt-schema-org"];
+    const router = useRouter();
+    const currentRoute = router.currentRoute;
+    const siteConfig = useSiteConfig();
+    head.use(PluginSchemaOrg({
+      minify: config.minify,
+      resolveMeta: async () => {
+        const route = unref(currentRoute);
+        const meta = {
+          host: siteConfig.url,
+          trailingSlash: siteConfig.trailingSlash,
+          inLanguage: siteConfig.currentLocale || siteConfig.defaultLocale,
+          ...siteConfig,
+          ...route.meta,
+          path: route.path
+        };
+        await nuxtApp.hooks.callHook("schema-org:meta", meta);
+        return meta;
+      }
+    }));
+  }
 });

package/dist/types.d.mts

@@ -0,0 +1,19 @@
+
+import { ModuleOptions, ModuleHooks, ModulePublicRuntimeConfig } from './module'
+
+declare module '@nuxt/schema' {
+  interface NuxtConfig { ['schemaOrg']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['schemaOrg']?: ModuleOptions }
+  interface NuxtHooks extends ModuleHooks {}
+  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
+}
+
+declare module 'nuxt/schema' {
+  interface NuxtConfig { ['schemaOrg']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['schemaOrg']?: ModuleOptions }
+  interface NuxtHooks extends ModuleHooks {}
+  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
+}
+
+
+export { ModuleHooks, ModuleOptions, ModulePublicRuntimeConfig, default } from './module'

package/dist/types.d.ts

@@ -1,17 +1,19 @@
 
-import { ModuleOptions, ModuleHooks } from './module'
+import { ModuleOptions, ModuleHooks, ModulePublicRuntimeConfig } from './module'
 
 declare module '@nuxt/schema' {
   interface NuxtConfig { ['schemaOrg']?: Partial<ModuleOptions> }
   interface NuxtOptions { ['schemaOrg']?: ModuleOptions }
   interface NuxtHooks extends ModuleHooks {}
+  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
 }
 
 declare module 'nuxt/schema' {
   interface NuxtConfig { ['schemaOrg']?: Partial<ModuleOptions> }
   interface NuxtOptions { ['schemaOrg']?: ModuleOptions }
   interface NuxtHooks extends ModuleHooks {}
+  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
 }
 
 
-export { ModuleHooks, ModuleOptions, default } from './module'
+export { ModuleHooks, ModuleOptions, ModulePublicRuntimeConfig, default } from './module'

package/package.json

@@ -1,52 +1,65 @@
 {
   "name": "nuxt-schema-org",
   "type": "module",
-  "version": "2.2.0",
-  "description": "Nuxt module for @vueuse/schema-org",
+  "version": "3.0.0",
+  "packageManager": "pnpm@8.7.5",
+  "description": "Schema.org for Nuxt",
   "author": "Harlan Wilton <harlan@harlanzw.com>",
   "license": "MIT",
   "funding": "https://github.com/sponsors/harlan-zw",
-  "homepage": "https://github.com/vueuse/schema-org#readme",
+  "homepage": "https://nuxtseo.com/schema-org",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/vueuse/schema-org.git",
-    "directory": "packages/nuxt"
+    "url": "git+https://github.com/harlan-zw/nuxt-schema-org.git"
   },
   "bugs": {
-    "url": "https://github.com/vueuse/schema-org/issues"
+    "url": "https://github.com/harlan-zw/nuxt-schema-org/issues"
   },
   "keywords": [
     "schema-org",
     "nuxt",
-    "@vueuse/schema-org",
+    "@nuxt-schema-org",
     "nuxt-module",
     "nuxt3"
   ],
   "exports": {
     ".": {
-      "require": "./dist/module.cjs",
-      "import": "./dist/module.mjs"
+      "types": "./dist/types.d.ts",
+      "import": "./dist/module.mjs",
+      "require": "./dist/module.cjs"
     }
   },
-  "main": "dist/module.cjs",
-  "types": "dist/types.d.ts",
+  "main": "./dist/module.cjs",
+  "types": "./dist/types.d.ts",
   "files": [
     "dist"
   ],
   "dependencies": {
-    "@nuxt/kit": "^3.5.1",
-    "@unhead/schema-org-vue": "^0.6.0",
-    "pathe": "^1.1.0"
+    "@nuxt/kit": "^3.7.3",
+    "@unhead/schema-org": "^1.7.3",
+    "nuxt-site-config": "^1.2.1",
+    "nuxt-site-config-kit": "^1.2.1",
+    "pathe": "^1.1.1"
   },
   "devDependencies": {
-    "@nuxt/module-builder": "^0.3.1",
-    "@nuxt/schema": "3.5.1",
-    "nuxt": "3.5.1"
+    "@antfu/eslint-config": "^0.42.0",
+    "@nuxt/module-builder": "^0.5.1",
+    "@nuxt/schema": "^3.7.3",
+    "@nuxt/test-utils": "^3.7.3",
+    "@nuxtjs/eslint-config-typescript": "^12.1.0",
+    "bumpp": "^9.2.0",
+    "eslint": "8.49.0",
+    "nuxt": "^3.7.3",
+    "nuxt-windicss": "^2.6.1",
+    "vitest": "0.34.4"
   },
   "scripts": {
-    "build": "nuxi prepare ../../test/fixtures/nuxt && nuxt-module-build",
-    "stub": "nuxt-module-build --stub && nuxi prepare ../../test/fixtures/nuxt",
-    "play": "nuxi dev ../../test/fixtures/nuxt",
-    "play:build": "nuxi build ../../test/fixtures/nuxt"
+    "lint": "eslint . --fix",
+    "build": "pnpm run dev:prepare && nuxt-module-build",
+    "dev": "nuxi dev playground",
+    "dev:build": "nuxi build playground",
+    "dev:prepare": "nuxt-module-build --stub && nuxi prepare playground",
+    "release": "bumpp package.json --commit --push --tag",
+    "test": "vitest"
   }
 }