nuxt-schema-org 1.0.0-beta.2 → 1.0.0-beta.20

package/dist/module.d.ts

@@ -1,24 +1,16 @@
-import { MetaInput } from 'schema-org-graph-js';
 import { NuxtModule } from '@nuxt/schema';
+import { UserConfig } from '@vueuse/schema-org';
+import { MetaInput } from 'schema-org-graph-js';
 
-interface ModuleOptions {
-    /**
-     * Should schema.org only be rendered by the server.
-     *
-     * Useful for optimising performance as it may not be needed by search engines. Changes runtime package size to 0kb.
-     *
-     * @default false
-     */
-    client?: boolean;
-    /**
-     * Should full schema types from `schema-dts` be used over a simplified version.
-     * @default false
-     */
-    full?: boolean;
-    meta?: MetaInput;
+interface ModuleOptions extends UserConfig {
 }
 interface ModuleHooks {
 }
+declare module 'nuxt' {
+    interface RuntimeNuxtHooks {
+        'schema-org:meta': (meta: MetaInput) => void;
+    }
+}
 declare const _default: NuxtModule<ModuleOptions>;
 
 export { ModuleHooks, ModuleOptions, _default as default };

package/dist/module.json

@@ -1,8 +1,9 @@
 {
   "configKey": "schemaOrg",
   "compatibility": {
+    "nuxt": ">=3.0.0-rc.8",
     "bridge": false
   },
   "name": "nuxt-schema-org",
-  "version": "1.0.0-beta.2"
+  "version": "1.0.0-beta.20"
 }

package/dist/module.mjs

@@ -1,64 +1,98 @@
-import { defineNuxtModule, createResolver, addPlugin, addTemplate, addComponent } from '@nuxt/kit';
-import { RootSchemas, schemaOrgComponents } from '@vueuse/schema-org';
+import { defineNuxtModule, createResolver, addPlugin, addTemplate, addComponent, extendWebpackConfig } from '@nuxt/kit';
+import { resolveUserConfig, AliasProvider, AliasRuntime, schemaOrgComponents, schemaOrgAutoImports } from '@vueuse/schema-org';
 import { dirname } from 'pathe';
-import { SchemaOrg } from '@vueuse/schema-org-vite';
+import { AliasRuntimePluginVite, AliasRuntimePluginWebpack } from '@vueuse/schema-org-vite';
 
 const Pkg = "@vueuse/schema-org";
-const RuntimeDir = "#vueuse/schema-org/runtime";
 const module = defineNuxtModule({
   meta: {
     configKey: "schemaOrg",
     compatibility: {
+      nuxt: ">=3.0.0-rc.8",
       bridge: false
     }
   },
   async setup(moduleOptions, nuxt) {
     const { resolve, resolvePath } = createResolver(import.meta.url);
+    moduleOptions = resolveUserConfig(moduleOptions);
+    if (nuxt.options.ssr && !moduleOptions.canonicalHost && !moduleOptions.meta?.host) {
+      console.warn("WARN [nuxt-schema-org] Please provide a `canonicalHost` to use this module with SSR enabled.");
+      return;
+    }
     const schemaOrgPath = dirname(await resolvePath(Pkg));
-    const moduleRuntime = resolve("./runtime");
-    nuxt.options.build.transpile.push(...[moduleRuntime, RuntimeDir]);
+    if (!nuxt.options.ssr)
+      moduleOptions.client = true;
     if (typeof moduleOptions.client === "undefined")
       moduleOptions.client = !!nuxt.options.dev;
+    const providerPath = await resolvePath(`${schemaOrgPath}/providers/${moduleOptions.full ? "full" : "simple"}`);
+    const runtimePath = await resolvePath(`${schemaOrgPath}/runtime`);
+    const runtimeMockPath = await resolvePath(`${schemaOrgPath}/runtime-mock`);
+    nuxt.options.alias[AliasProvider] = providerPath;
+    nuxt.options.alias[AliasRuntime] = runtimePath;
+    nuxt.options.alias[Pkg] = schemaOrgPath;
+    const moduleRuntimeDir = resolve("./runtime");
+    nuxt.options.build.transpile.push(...[moduleRuntimeDir, AliasRuntime]);
     if (!moduleOptions.client)
-      addPlugin(resolve(moduleRuntime, "plugin-fallback.client"));
+      addPlugin(resolve(moduleRuntimeDir, "plugin-fallback.client"));
     addPlugin({
-      src: resolve(moduleRuntime, "plugin"),
+      src: resolve(moduleRuntimeDir, "plugin"),
       mode: moduleOptions.client ? "all" : "server"
     });
-    nuxt.options.alias[Pkg] = schemaOrgPath;
-    nuxt.options.alias["#vueuse/schema-org/provider"] = await resolvePath(`${schemaOrgPath}/providers/full`);
-    nuxt.options.alias["#vueuse/schema-org/runtime"] = await resolvePath(`${schemaOrgPath}/runtime`);
-    nuxt.hook("vite:extendConfig", (config, { isClient }) => {
-      config.optimizeDeps = config.optimizeDeps || {};
-      config.optimizeDeps.exclude = config.optimizeDeps.exclude || [];
-      config.optimizeDeps.exclude.push(...[`${schemaOrgPath}/runtime`, Pkg]);
-      config.plugins = config.plugins || [];
-      config.plugins.push(SchemaOrg({
-        mock: !moduleOptions.client && isClient,
-        full: moduleOptions.full
-      }));
-    });
     addTemplate({
       filename: "nuxt-schema-org-config.mjs",
       getContents: () => `export default ${JSON.stringify(moduleOptions)}`
     });
-    nuxt.hooks.hook("autoImports:sources", (autoImports) => {
-      autoImports.unshift({
-        from: `${moduleRuntime}/schema-org-runtime`,
-        imports: [
-          "injectSchemaOrg",
-          "useSchemaOrg",
-          ...RootSchemas.map((schema) => [`define${schema}`]).flat()
-        ]
-      });
-    });
-    schemaOrgComponents.forEach((component) => {
-      addComponent({
+    for (const component of schemaOrgComponents) {
+      await addComponent({
         name: component,
         export: component,
-        chunkName: "schema-org-components",
-        filePath: "#vueuse/schema-org/runtime"
+        chunkName: "nuxt-schema-org/components",
+        filePath: AliasRuntime
       });
+    }
+    await addComponent({
+      name: "SchemaOrgDebug",
+      export: "SchemaOrgDebug",
+      filePath: `${schemaOrgPath}/runtime/components/SchemaOrgDebug`
+    });
+    nuxt.hooks.hook("autoImports:sources", (autoImports) => {
+      autoImports.unshift(...schemaOrgAutoImports);
+    });
+    const realPaths = {
+      runtime: runtimePath,
+      provider: providerPath,
+      pkg: schemaOrgPath
+    };
+    const mockPaths = {
+      runtime: runtimeMockPath,
+      provider: runtimeMockPath,
+      pkg: schemaOrgPath
+    };
+    nuxt.hooks.hook("vite:extendConfig", (config, { isClient }) => {
+      config.plugins = config.plugins || [];
+      config.plugins.push(AliasRuntimePluginVite({
+        paths: !moduleOptions.client && isClient ? mockPaths : realPaths
+      }));
+    });
+    extendWebpackConfig((config) => {
+      config.plugins = config.plugins || [];
+      config.plugins.push(AliasRuntimePluginWebpack({
+        paths: realPaths
+      }));
+    }, {
+      client: false,
+      modern: false,
+      server: true
+    });
+    extendWebpackConfig((config) => {
+      config.plugins = config.plugins || [];
+      config.plugins.push(AliasRuntimePluginWebpack({
+        paths: !moduleOptions.client ? mockPaths : realPaths
+      }));
+    }, {
+      client: true,
+      modern: true,
+      server: false
     });
   }
 });

package/dist/runtime/plugin.mjs

@@ -2,34 +2,40 @@ import { createSchemaOrg } from "@vueuse/schema-org";
 import { defineNuxtPlugin } from "#app";
 import { unref, watch } from "#imports";
 import config from "#build/nuxt-schema-org-config.mjs";
-export default defineNuxtPlugin((nuxtApp) => {
+export default defineNuxtPlugin(async (nuxtApp) => {
   const ssr = !!nuxtApp.ssrContext?.url;
   const client = createSchemaOrg({
     updateHead(fn) {
       nuxtApp._useHead(unref(fn));
     },
-    meta() {
+    async meta() {
       const head = nuxtApp.vueApp._context.provides.usehead;
       const inferredMeta = {};
       const headTag = head.headTags.reverse().filter((t) => t.tag === "title" && !!t.props.children);
       if (headTag.length)
         inferredMeta.title = headTag[0].props.children;
-      return {
+      const descTag = head.headTags.reverse().filter((t) => t.tag === "meta" && t.props.name === "description" && !!t.props.content);
+      if (descTag.length)
+        inferredMeta.description = descTag[0].props.content;
+      const imageTag = head.headTags.reverse().filter((t) => t.tag === "meta" && t.props.property === "og:image" && !!t.props.content);
+      if (imageTag.length)
+        inferredMeta.image = imageTag[0].props.content;
+      const schemaOrgMeta = {
         path: nuxtApp._route.path,
         ...inferredMeta,
         ...nuxtApp._route.meta,
         ...config.meta || {}
       };
+      await nuxtApp.hooks.callHook("schema-org:meta", schemaOrgMeta);
+      return schemaOrgMeta;
     }
   });
-  nuxtApp._injectSchemaOrg = () => client;
   nuxtApp.vueApp.use(client);
   if (ssr) {
-    client.generateSchema();
-    client.setupDOM();
+    await client.forceRefresh();
     return;
   }
   watch(() => nuxtApp._route.path, () => {
-    client.generateSchema();
+    client.forceRefresh();
   });
 });

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "nuxt-schema-org",
-  "version": "1.0.0-beta.2",
+  "type": "module",
+  "version": "1.0.0-beta.20",
   "description": "Nuxt module for @vueuse/schema-org",
   "author": "Harlan Wilton <harlan@harlanzw.com>",
   "license": "MIT",
@@ -21,10 +22,8 @@
     "nuxt-module",
     "nuxt3"
   ],
-  "sideEffects": false,
   "exports": {
     ".": {
-      "types": "./dist/types.d.ts",
       "require": "./dist/module.cjs",
       "import": "./dist/module.mjs"
     }
@@ -35,21 +34,20 @@
     "dist"
   ],
   "dependencies": {
-    "@nuxt/kit": "3.0.0-rc.8",
-    "@vueuse/schema-org": "1.0.0-beta.2",
-    "@vueuse/schema-org-vite": "1.0.0-beta.2",
-    "pathe": "^0.3.4",
-    "schema-org-graph-js": "0.3.3"
+    "@nuxt/kit": "^3.0.0-rc.8",
+    "@vueuse/schema-org": "1.0.0-beta.20",
+    "@vueuse/schema-org-vite": "1.0.0-beta.20",
+    "pathe": "^0.3.5",
+    "schema-org-graph-js": "0.4.4"
   },
   "devDependencies": {
     "@nuxt/module-builder": "latest",
-    "@nuxt/schema": "3.0.0-rc.8",
-    "nuxt": "3.0.0-rc.8"
+    "@nuxt/schema": "3.0.0-rc.8"
   },
   "scripts": {
-    "build": "npm run -C ../../playgrounds/nuxt3 prepare && nuxt-module-build",
+    "build": "npm run -C ../../test/fixtures/nuxt nuxt:prepare && nuxt-module-build",
+    "stub": "nuxt-module-build --stub && nuxi prepare ../../test/fixtures/nuxt",
     "play": "nuxi dev ../../playgrounds/nuxt3",
-    "play:build": "nuxi build ../../playgrounds/nuxt3",
-    "stub": "nuxt-module-build --stub && nuxi prepare ../../playgrounds/nuxt3"
+    "play:build": "nuxi build ../../playgrounds/nuxt3"
   }
 }

package/dist/runtime/schema-org-runtime.d.ts

@@ -1,3 +0,0 @@
-export * from '#vueuse/schema-org/provider';
-export { useSchemaOrg } from '#vueuse/schema-org/runtime';
-export declare function injectSchemaOrg(): any;

package/dist/runtime/schema-org-runtime.mjs

@@ -1,8 +0,0 @@
-import { useNuxtApp } from "#app";
-export * from "#vueuse/schema-org/provider";
-export { useSchemaOrg } from "#vueuse/schema-org/runtime";
-export function injectSchemaOrg() {
-  const nuxtApp = useNuxtApp();
-  if (nuxtApp._injectSchemaOrg)
-    return nuxtApp._injectSchemaOrg();
-}