@nuxtjs/prismic 3.0.0-rc.4 → 3.0.0-rc.5

package/dist/module.d.ts

@@ -1,20 +1,20 @@
 import * as _nuxt_schema from '@nuxt/schema';
 import { PrismicPluginOptions } from '@prismicio/vue';
 
-type PrismicModuleOptions = Omit<PrismicPluginOptions, 'endpoint' | 'client' | 'linkResolver' | 'htmlSerializer'> & {
-    endpoint: string;
-    client?: string;
-    linkResolver?: string;
-    htmlSerializer?: string;
-    preview?: string | false;
-    toolbar?: boolean;
+type PrismicModuleOptions = Omit<PrismicPluginOptions, 'endpoint' | 'client' | 'linkResolver' | 'htmlSerializer'> & {
+    endpoint: string;
+    client?: string;
+    linkResolver?: string;
+    htmlSerializer?: string;
+    preview?: string | false;
+    toolbar?: boolean;
 };
 
-declare module '@nuxt/schema' {
-    interface PublicRuntimeConfig {
-        prismic: PrismicModuleOptions;
-    }
-}
+declare module '@nuxt/schema' {
+    interface PublicRuntimeConfig {
+        prismic: PrismicModuleOptions;
+    }
+}
 declare const _default: _nuxt_schema.NuxtModule<PrismicModuleOptions>;
 
 export { PrismicModuleOptions, _default as default };

package/dist/module.json

@@ -4,5 +4,5 @@
   "compatibility": {
     "nuxt": "^3.0.0"
   },
-  "version": "3.0.0-rc.4"
+  "version": "3.0.0-rc.5"
 }

package/dist/module.mjs

@@ -1,11 +1,11 @@
 import { join } from 'node:path';
 import { defu } from 'defu';
-import { defineNuxtModule, createResolver, addPlugin, addComponent, addImports, extendPages, addTemplate } from '@nuxt/kit';
+import { defineNuxtModule, addTemplate, createResolver, addPlugin, addComponent, addImports, extendPages } from '@nuxt/kit';
 import * as prismicVue from '@prismicio/vue';
-import consola from 'consola';
+import { consola } from 'consola';
 import { existsSync } from 'node:fs';
 
-const logger = consola.withScope("nuxt:prismic");
+const logger = consola.withTag("nuxt:prismic");
 
 const fileExists = (path, extensions = ["js", "ts"]) => {
   if (!path) {
@@ -37,7 +37,15 @@ const module = defineNuxtModule({
   hooks: {},
   setup(options, nuxt) {
     var _a;
-    if (!options.endpoint) {
+    (_a = nuxt.options.runtimeConfig).public || (_a.public = {});
+    const moduleOptions = defu(nuxt.options.runtimeConfig.public.prismic, options);
+    nuxt.options.runtimeConfig.public.prismic = moduleOptions;
+    nuxt.options.alias["#prismicOptions"] = addTemplate({
+      filename: "prismicOptions.mjs",
+      write: true,
+      getContents: () => `export default ${JSON.stringify(moduleOptions, void 0, 2)}`
+    }).dst || "";
+    if (!moduleOptions.endpoint) {
       logger.warn("Options `endpoint` is required, disabling module...");
       return;
     }
@@ -60,14 +68,12 @@ const module = defineNuxtModule({
         });
       }
     };
-    proxyUserFileWithUndefinedFallback("client", options.client);
-    proxyUserFileWithUndefinedFallback("linkResolver", options.linkResolver);
-    proxyUserFileWithUndefinedFallback("htmlSerializer", options.htmlSerializer);
-    (_a = nuxt.options.runtimeConfig).public || (_a.public = {});
-    nuxt.options.runtimeConfig.public.prismic = defu(nuxt.options.runtimeConfig.public.prismic, options);
+    proxyUserFileWithUndefinedFallback("client", moduleOptions.client);
+    proxyUserFileWithUndefinedFallback("linkResolver", moduleOptions.linkResolver);
+    proxyUserFileWithUndefinedFallback("htmlSerializer", moduleOptions.htmlSerializer);
     addPlugin(resolver.resolve("runtime/plugin"));
     addPlugin(resolver.resolve("runtime/plugin.client"));
-    if (options.injectComponents) {
+    if (moduleOptions.injectComponents) {
       [
         "PrismicEmbed",
         "PrismicImage",
@@ -96,21 +102,22 @@ const module = defineNuxtModule({
       as: "usePrismicPreview",
       from: resolver.resolve("runtime/usePrismicPreview")
     });
-    if (options.preview) {
-      const maybeUserPreviewPage = fileExists(join(nuxt.options.srcDir, nuxt.options.dir.pages, options.preview), ["js", "ts", "vue"]);
+    if (moduleOptions.preview) {
+      const maybeUserPreviewPage = fileExists(join(nuxt.options.srcDir, nuxt.options.dir.pages, moduleOptions.preview), ["js", "ts", "vue"]);
       if (maybeUserPreviewPage) {
-        logger.info(`Using user-defined preview page at \`${maybeUserPreviewPage.replace(join(nuxt.options.srcDir), "~").replace(nuxt.options.rootDir, "~~").replace(/\\/g, "/")}\`, available at \`${options.preview}\``);
+        logger.info(`Using user-defined preview page at \`${maybeUserPreviewPage.replace(join(nuxt.options.srcDir), "~").replace(nuxt.options.rootDir, "~~").replace(/\\/g, "/")}\`, available at \`${moduleOptions.preview}\``);
       } else {
-        logger.info(`Using default preview page, available at \`${options.preview}\``);
+        logger.info(`Using default preview page, available at \`${moduleOptions.preview}\``);
         extendPages((pages) => {
           pages.unshift({
             name: "prismic-preview",
-            path: options.preview,
+            path: moduleOptions.preview,
+            // Checked before
             file: resolver.resolve("runtime/preview.vue")
           });
         });
       }
-      if (!options.toolbar) {
+      if (!moduleOptions.toolbar) {
         logger.warn("`toolbar` option is disabled but `preview` is enabled. Previews won't work unless you manually load the toolbar.");
       }
     }

package/dist/runtime/plugin.client.d.ts

@@ -1,2 +1,2 @@
-declare const _default: any;
-export default _default;
+declare const _default: any;
+export default _default;

package/dist/runtime/plugin.client.mjs

@@ -1,6 +1,7 @@
-import { defineNuxtPlugin, refreshNuxtData, useRuntimeConfig } from "#imports";
+import { defineNuxtPlugin, refreshNuxtData } from "#imports";
+import moduleOptions from "#prismicOptions";
 export default defineNuxtPlugin((nuxtApp) => {
-  const options = useRuntimeConfig().public.prismic;
+  const options = moduleOptions;
   if (options.preview) {
     window.addEventListener("prismicPreviewUpdate", (event) => {
       event.preventDefault();

package/dist/runtime/plugin.d.ts

@@ -1,2 +1,2 @@
-declare const _default: any;
-export default _default;
+declare const _default: any;
+export default _default;

package/dist/runtime/plugin.mjs

@@ -1,18 +1,20 @@
 import NuxtLink from "#app/components/nuxt-link";
 import { isRepositoryEndpoint, getRepositoryName } from "@prismicio/client";
 import { createPrismic } from "@prismicio/vue";
-import { defineNuxtPlugin, useCookie, useRequestEvent, refreshNuxtData, useHead, useRuntimeConfig } from "#imports";
+import { defineNuxtPlugin, useCookie, useRequestEvent, refreshNuxtData, useHead } from "#imports";
 import client from "#build/prismic/proxy/client";
 import linkResolver from "#build/prismic/proxy/linkResolver";
 import htmlSerializer from "#build/prismic/proxy/htmlSerializer";
+import moduleOptions from "#prismicOptions";
 export default defineNuxtPlugin((nuxtApp) => {
-  const options = useRuntimeConfig().public.prismic;
+  const options = moduleOptions;
   const prismicPlugin = createPrismic({
     ...options,
     client,
     linkResolver,
     htmlSerializer,
     injectComponents: false,
+    // Handled at module level
     components: {
       linkInternalComponent: NuxtLink,
       linkExternalComponent: NuxtLink,

package/dist/runtime/usePrismicPreview.d.ts

@@ -1,6 +1,6 @@
-/**
- * Resolves Prismic previews on the preview entry page (`/preview`)
- *
- * @param defaultURL - The default URL to redirect to if the previewed document doesn't map to one.
- */
-export declare const usePrismicPreview: (defaultURL?: string) => void;
+/**
+ * Resolves Prismic previews on the preview entry page (`/preview`)
+ *
+ * @param defaultURL - The default URL to redirect to if the previewed document doesn't map to one.
+ */
+export declare const usePrismicPreview: (defaultURL?: string) => void;

package/dist/types.d.ts

@@ -3,4 +3,5 @@ import {  } from './module'
 
 
 
+
 export { PrismicModuleOptions, default } from './module'

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nuxtjs/prismic",
-	"version": "3.0.0-rc.4",
+	"version": "3.0.0-rc.5",
 	"description": "Easily connect your Nuxt 3 application to your content hosted on Prismic",
 	"keywords": [
 		"nuxt",
@@ -50,22 +50,22 @@
 		"unit:watch": "vitest watch"
 	},
 	"dependencies": {
-		"@nuxt/kit": "^3.3.2",
+		"@nuxt/kit": "^3.4.3",
 		"@prismicio/client": "^6.7.3",
-		"@prismicio/vue": "^3.1.3",
-		"consola": "^2.15.3",
+		"@prismicio/vue": "^3.1.4",
+		"consola": "^3.1.0",
 		"defu": "^6.1.2"
 	},
 	"devDependencies": {
-		"@nuxt/module-builder": "^0.2.1",
+		"@nuxt/module-builder": "^0.3.1",
 		"@nuxtjs/eslint-config-typescript": "^12.0.0",
-		"@vitest/coverage-c8": "^0.29.7",
-		"eslint": "^8.36.0",
+		"@vitest/coverage-c8": "^0.31.0",
+		"eslint": "^8.39.0",
 		"mock-fs": "^5.2.0",
-		"nuxt": "^3.3.2",
+		"nuxt": "^3.4.3",
 		"standard-version": "^9.5.0",
-		"typescript": "^4.9.5",
-		"vitest": "^0.29.7"
+		"typescript": "^5.0.4",
+		"vitest": "^0.31.0"
 	},
 	"engines": {
 		"node": ">=14.15.0"

package/src/lib/logger.ts

@@ -1,3 +1,3 @@
-import consola from 'consola'
+import { consola } from 'consola'
 
-export const logger = consola.withScope('nuxt:prismic')
+export const logger = consola.withTag('nuxt:prismic')

package/src/module.ts

@@ -45,7 +45,18 @@ export default defineNuxtModule<PrismicModuleOptions>({
 	}),
 	hooks: {},
 	setup (options, nuxt) {
-		if (!options.endpoint) {
+		// Expose options through public runtime config
+		nuxt.options.runtimeConfig.public ||= {} as typeof nuxt.options.runtimeConfig.public
+		const moduleOptions: PrismicModuleOptions = defu(nuxt.options.runtimeConfig.public.prismic, options)
+		nuxt.options.runtimeConfig.public.prismic = moduleOptions
+
+		nuxt.options.alias['#prismicOptions'] = addTemplate({
+			filename: 'prismicOptions.mjs',
+			write: true,
+			getContents: () => `export default ${JSON.stringify(moduleOptions, undefined, 2)}`
+		}).dst || ''
+
+		if (!moduleOptions.endpoint) {
 			logger.warn('Options `endpoint` is required, disabling module...')
 			return
 		}
@@ -76,20 +87,16 @@ export default defineNuxtModule<PrismicModuleOptions>({
 				})
 			}
 		}
-		proxyUserFileWithUndefinedFallback('client', options.client!)
-		proxyUserFileWithUndefinedFallback('linkResolver', options.linkResolver!)
-		proxyUserFileWithUndefinedFallback('htmlSerializer', options.htmlSerializer!)
-
-		// Expose options through public runtime config
-		nuxt.options.runtimeConfig.public ||= {} as typeof nuxt.options.runtimeConfig.public
-		nuxt.options.runtimeConfig.public.prismic = defu(nuxt.options.runtimeConfig.public.prismic, options)
+		proxyUserFileWithUndefinedFallback('client', moduleOptions.client!)
+		proxyUserFileWithUndefinedFallback('linkResolver', moduleOptions.linkResolver!)
+		proxyUserFileWithUndefinedFallback('htmlSerializer', moduleOptions.htmlSerializer!)
 
 		// Add plugin
 		addPlugin(resolver.resolve('runtime/plugin'))
 		addPlugin(resolver.resolve('runtime/plugin.client'))
 
 		// Add components auto import
-		if (options.injectComponents) {
+		if (moduleOptions.injectComponents) {
 			[
 				'PrismicEmbed',
 				'PrismicImage',
@@ -126,25 +133,25 @@ export default defineNuxtModule<PrismicModuleOptions>({
 		})
 
 		// Add preview route
-		if (options.preview) {
-			const maybeUserPreviewPage = fileExists(join(nuxt.options.srcDir, nuxt.options.dir.pages, options.preview), ['js', 'ts', 'vue'])
+		if (moduleOptions.preview) {
+			const maybeUserPreviewPage = fileExists(join(nuxt.options.srcDir, nuxt.options.dir.pages, moduleOptions.preview), ['js', 'ts', 'vue'])
 
 			if (maybeUserPreviewPage) {
 				logger.info(`Using user-defined preview page at \`${maybeUserPreviewPage.replace(join(nuxt.options.srcDir), '~').replace(nuxt.options.rootDir, '~~').replace(/\\/g, '/')
-				}\`, available at \`${options.preview}\``)
+				}\`, available at \`${moduleOptions.preview}\``)
 			} else {
-				logger.info(`Using default preview page, available at \`${options.preview}\``)
+				logger.info(`Using default preview page, available at \`${moduleOptions.preview}\``)
 
 				extendPages((pages) => {
 					pages.unshift({
 						name: 'prismic-preview',
-						path: options.preview as string, // Checked before
+						path: moduleOptions.preview as string, // Checked before
 						file: resolver.resolve('runtime/preview.vue')
 					})
 				})
 			}
 
-			if (!options.toolbar) {
+			if (!moduleOptions.toolbar) {
 				logger.warn('`toolbar` option is disabled but `preview` is enabled. Previews won\'t work unless you manually load the toolbar.')
 			}
 		}

package/src/runtime/plugin.client.ts

@@ -1,8 +1,10 @@
 import { PrismicModuleOptions } from '../types'
 import { defineNuxtPlugin, refreshNuxtData, useRuntimeConfig } from '#imports'
 
+import moduleOptions from '#prismicOptions'
+
 export default defineNuxtPlugin((nuxtApp) => {
-	const options: PrismicModuleOptions = useRuntimeConfig().public.prismic
+	const options = moduleOptions as PrismicModuleOptions
 
 	// Hot reload preview updates
 	if (options.preview) {

package/src/runtime/plugin.ts

@@ -13,8 +13,10 @@ import linkResolver from '#build/prismic/proxy/linkResolver'
 // @ts-expect-error vfs cannot be resolved here
 import htmlSerializer from '#build/prismic/proxy/htmlSerializer'
 
+import moduleOptions from '#prismicOptions'
+
 export default defineNuxtPlugin((nuxtApp) => {
-	const options: PrismicModuleOptions = useRuntimeConfig().public.prismic
+	const options = moduleOptions as PrismicModuleOptions
 
 	const prismicPlugin = createPrismic({
 		...options,