@nuxtjs/prismic 3.0.0-alpha.8 → 3.0.0-rc.1

package/README.md

@@ -3,8 +3,8 @@
 Replace all on all files (README.md, CONTRIBUTING.md, bug_report.md, package.json):
 - @nuxtjs/prismic
 - Easily connect your Nuxt 3 application to your content hosted on Prismic
-- nuxt-community/prismic-module
-- prismic-module
+- nuxt-modules/prismic
+- prismic
 
 -->
 
@@ -26,7 +26,7 @@ Easily connect your Nuxt.js application to your content hosted on [Prismic][pris
 ## Install
 
 ```bash
-npm install --save-dev @nuxtjs/prismic@alpha # or yarn add --dev @nuxtjs/prismic@alpha
+npm install --save-dev @nuxtjs/prismic@rc # or yarn add --dev @nuxtjs/prismic@rc
 ```
 
 Then, add `@nuxtjs/prismic` to the `modules` section of your Nuxt config and configure your Prismic API endpoint:
@@ -76,9 +76,9 @@ Whether you're helping us fix bugs, improve the docs, or spread the word, we'd l
 <!-- TODO: Replace link with a more useful one if available -->
 
 [forum-question]: https://community.prismic.io
-[repo-bug-report]: https://github.com/nuxt-community/prismic-module/issues/new?assignees=&labels=bug&template=bug_report.md&title=
-[repo-feature-request]: https://github.com/nuxt-community/prismic-module/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
-[repo-pull-requests]: https://github.com/nuxt-community/prismic-module/pulls
+[repo-bug-report]: https://github.com/nuxt-modules/prismic/issues/new?assignees=&labels=bug&template=bug_report.md&title=
+[repo-feature-request]: https://github.com/nuxt-modules/prismic/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=
+[repo-pull-requests]: https://github.com/nuxt-modules/prismic/pulls
 
 <!-- Badges -->
 
@@ -86,10 +86,10 @@ Whether you're helping us fix bugs, improve the docs, or spread the word, we'd l
 [npm-version-href]: https://npmjs.com/package/@nuxtjs/prismic
 [npm-downloads-src]: https://img.shields.io/npm/dm/@nuxtjs/prismic.svg
 [npm-downloads-href]: https://npmjs.com/package/@nuxtjs/prismic
-[github-actions-ci-src]: https://github.com/nuxt-community/prismic-module/workflows/ci/badge.svg
-[github-actions-ci-href]: https://github.com/nuxt-community/prismic-module/actions?query=workflow%3Aci
-[codecov-src]: https://img.shields.io/codecov/c/github/nuxt-community/prismic-module.svg
-[codecov-href]: https://codecov.io/gh/nuxt-community/prismic-module
+[github-actions-ci-src]: https://github.com/nuxt-modules/prismic/workflows/ci/badge.svg
+[github-actions-ci-href]: https://github.com/nuxt-modules/prismic/actions?query=workflow%3Aci
+[codecov-src]: https://img.shields.io/codecov/c/github/nuxt-modules/prismic.svg
+[codecov-href]: https://codecov.io/gh/nuxt-modules/prismic
 [conventional-commits-src]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg
 [conventional-commits-href]: https://conventionalcommits.org
 [license-src]: https://img.shields.io/npm/l/@nuxtjs/prismic.svg

package/dist/module.d.ts

@@ -7,6 +7,7 @@ declare type PrismicModuleOptions = Omit<PrismicPluginOptions, 'endpoint' | 'cli
     linkResolver?: string;
     htmlSerializer?: string;
     preview?: string | false;
+    toolbar?: boolean;
 };
 
 declare const _default: _nuxt_schema.NuxtModule<PrismicModuleOptions>;

package/dist/module.json

@@ -1,8 +1,8 @@
 {
   "name": "@nuxtjs/prismic",
-  "version": "3.0.0-alpha.8",
+  "version": "3.0.0-rc.1",
   "configKey": "prismic",
   "compatibility": {
-    "nuxt": "^3.0.0"
+    "nuxt": "^3.0.0-rc.6"
   }
 }

package/dist/module.mjs

@@ -1,13 +1,15 @@
-import { join } from 'path';
+import { join } from 'node:path';
 import { defineNuxtModule, createResolver, addPlugin, addComponent, addAutoImport, extendPages, addTemplate } from '@nuxt/kit';
 import { cleanDoubleSlashes } from 'ufo';
 import { isRepositoryEndpoint, getRepositoryName } from '@prismicio/client';
 import * as prismicVue from '@prismicio/vue';
-import { existsSync } from 'fs';
 import consola from 'consola';
+import { existsSync } from 'node:fs';
 
 const name = "@nuxtjs/prismic";
-const version = "3.0.0-alpha.8";
+const version = "3.0.0-rc.1";
+
+const logger = consola.withScope("nuxt:prismic");
 
 const fileExists = (path, extensions = ["js", "ts"]) => {
   if (!path) {
@@ -19,14 +21,12 @@ const fileExists = (path, extensions = ["js", "ts"]) => {
   return extension ? `${path}.${extension}` : null;
 };
 
-const logger = consola.withScope("nuxt:prismic");
-
 const module = defineNuxtModule({
   meta: {
     name: name,
     version: version,
     configKey: "prismic",
-    compatibility: { nuxt: "^3.0.0" }
+    compatibility: { nuxt: "^3.0.0-rc.6" }
   },
   defaults: (nuxt) => ({
     endpoint: "",
@@ -36,7 +36,8 @@ const module = defineNuxtModule({
     htmlSerializer: cleanDoubleSlashes(`~/${nuxt.options.dir.app}/prismic/htmlSerializer`),
     injectComponents: true,
     components: {},
-    preview: "/preview"
+    preview: "/preview",
+    toolbar: true
   }),
   hooks: {},
   setup(mergedOptions, nuxt) {
@@ -49,7 +50,7 @@ const module = defineNuxtModule({
     nuxt.options.build.transpile.push(resolver.resolve("runtime"), "@nuxtjs/prismic", "@prismicio/vue");
     const proxyUserFileWithUndefinedFallback = (filename, path, extensions = ["js", "mjs", "ts"]) => {
       const resolvedFilename = `prismic/proxy/${filename}.ts`;
-      const resolvedPath = path ? path.replace(/^(~~|@@)/, nuxt.options.rootDir).replace(/^(~|@)/, nuxt.options.srcDir) : void 0;
+      const resolvedPath = path.replace(/^(~~|@@)/, nuxt.options.rootDir).replace(/^(~|@)/, nuxt.options.srcDir);
       const maybeUserFile = fileExists(resolvedPath, extensions);
       if (maybeUserFile) {
         logger.info(`Using user-defined \`${filename}\` at \`${maybeUserFile.replace(nuxt.options.srcDir, "~").replace(nuxt.options.rootDir, "~~").replace(/\\/g, "/")}\``);
@@ -114,11 +115,19 @@ const module = defineNuxtModule({
           });
         });
       }
+      if (!mergedOptions.toolbar) {
+        logger.warn("`toolbar` option is disabled but `preview` is enabled. Previews won't work unless you manually load the toolbar.");
+      }
+    }
+    if (mergedOptions.toolbar) {
       const repositoryName = isRepositoryEndpoint(mergedOptions.endpoint) ? getRepositoryName(mergedOptions.endpoint) : mergedOptions.endpoint;
       (_b = nuxt.options.app).head || (_b.head = {});
       (_c = nuxt.options.app.head).script || (_c.script = []);
       nuxt.options.app.head.script.push({
-        src: `https://static.cdn.prismic.io/prismic.min.js?repo=${repositoryName}&new=true`
+        hid: "prismic-preview",
+        src: `https://static.cdn.prismic.io/prismic.min.js?repo=${repositoryName}&new=true`,
+        async: true,
+        defer: true
       });
     }
   }

package/dist/runtime/plugin.client.mjs

@@ -1,13 +1,11 @@
-import { defineNuxtPlugin } from "#app";
+import { defineNuxtPlugin, refreshNuxtData } from "#app";
 const pkgName = "@nuxtjs/prismic";
 export default defineNuxtPlugin((nuxtApp) => {
   const mergedOptions = nuxtApp.payload.config[pkgName] ?? nuxtApp.payload.config.public[pkgName] ?? {};
   if (mergedOptions.preview) {
     window.addEventListener("prismicPreviewUpdate", (event) => {
-      if (refreshNuxtData) {
-        event.preventDefault();
-        refreshNuxtData();
-      }
+      event.preventDefault();
+      refreshNuxtData();
     });
   }
 });

package/dist/runtime/plugin.mjs

@@ -1,4 +1,4 @@
-import { defineNuxtPlugin } from "#app";
+import { defineNuxtPlugin, useCookie, useRequestEvent, refreshNuxtData } from "#app";
 import NuxtLink from "#app/components/nuxt-link";
 import { createPrismic } from "@prismicio/vue";
 import client from "#build/prismic/proxy/client";
@@ -32,6 +32,7 @@ export default defineNuxtPlugin((nuxtApp) => {
           refreshNuxtData();
         }
       } catch (error) {
+        console.warn("Failed to parse Prismic preview cookie", error);
       }
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nuxtjs/prismic",
-	"version": "3.0.0-alpha.8",
+	"version": "3.0.0-rc.1",
 	"description": "Easily connect your Nuxt 3 application to your content hosted on Prismic",
 	"keywords": [
 		"nuxt",
@@ -12,7 +12,7 @@
 	],
 	"repository": {
 		"type": "git",
-		"url": "ssh://git@github.com/nuxt-community/prismic-module.git"
+		"url": "ssh://git@github.com/nuxt-modules/prismic.git"
 	},
 	"license": "MIT",
 	"author": "Nuxt.js Community",
@@ -38,27 +38,32 @@
 		"dev:build": "nuxi build playground",
 		"lint": "eslint --ext .js,.ts .",
 		"prepare": "nuxi prepare playground && npm run build",
-		"release": "npm run build && npm run test && standard-version && git push --follow-tags && npm run build && npm publish",
-		"release:alpha": "npm run build && npm run test && standard-version --release-as major --prerelease alpha && git push --follow-tags && npm run build && npm publish --tag alpha",
-		"release:alpha:dry": "standard-version --release-as major --prerelease alpha --dry-run",
+		"release": "npm run test && standard-version && git push --follow-tags && npm run build && npm publish",
+		"release:rc": "npm run test && standard-version --release-as major --prerelease rc && git push --follow-tags && npm run build && npm publish --tag rc",
+		"release:rc:dry": "standard-version --release-as major --prerelease rc --dry-run",
 		"release:dry": "standard-version --dry-run",
-		"test": "npm run lint && npm run unit",
-		"unit": "echo \"TODO: vitest & nuxt-test-utils\""
+		"test": "npm run lint && npm run unit && npm run build",
+		"unit": "vitest run --coverage",
+		"unit:watch": "vitest watch"
 	},
 	"dependencies": {
 		"@nuxt/kit": "^3.0.0-rc",
 		"@prismicio/client": "^6.6.1",
-		"@prismicio/vue": "^3.0.0-beta",
+		"@prismicio/vue": "^3.0.0",
 		"consola": "^2.15.3",
-		"ufo": "^0.8.4"
+		"ufo": "^0.8.5"
 	},
 	"devDependencies": {
 		"@nuxt/module-builder": "latest",
+		"@nuxt/test-utils": "npm:@nuxt/test-utils-edge@latest",
 		"@nuxtjs/eslint-config-typescript": "latest",
-		"eslint": "^8.18.0",
+		"c8": "^7.11.3",
+		"eslint": "^8.20.0",
+		"mock-fs": "^5.1.2",
 		"nuxt": "^3.0.0-rc",
 		"standard-version": "^9.5.0",
-		"typescript": "^4.7.4"
+		"typescript": "^4.7.4",
+		"vitest": "^0.18.1"
 	},
 	"engines": {
 		"node": ">=14.15.0"

package/src/{utils.ts → lib/fileExists.ts}

@@ -1,4 +1,4 @@
-import { existsSync } from 'fs'
+import { existsSync } from 'node:fs'
 
 export const fileExists = (path?: string, extensions = ['js', 'ts']): string | null => {
 	if (!path) {

package/src/lib/index.ts

@@ -0,0 +1,2 @@
+export { logger } from './logger'
+export { fileExists } from './fileExists'

package/src/module.ts

@@ -1,4 +1,4 @@
-import { join } from 'path'
+import { join } from 'node:path'
 
 import {
 	defineNuxtModule,
@@ -15,9 +15,8 @@ import { isRepositoryEndpoint, getRepositoryName } from '@prismicio/client'
 import * as prismicVue from '@prismicio/vue'
 
 import { name as pkgName, version as pkgVersion } from '../package.json'
+import { logger, fileExists } from './lib'
 import type { PrismicModuleOptions } from './types'
-import { fileExists } from './utils'
-import { logger } from './logger'
 
 // Options export
 export type { PrismicModuleOptions } from './types'
@@ -29,7 +28,7 @@ export default defineNuxtModule<PrismicModuleOptions>({
 		name: pkgName,
 		version: pkgVersion,
 		configKey: 'prismic',
-		compatibility: { nuxt: '^3.0.0' }
+		compatibility: { nuxt: '^3.0.0-rc.6' }
 	},
 	defaults: nuxt => ({
 		endpoint: '',
@@ -39,7 +38,8 @@ export default defineNuxtModule<PrismicModuleOptions>({
 		htmlSerializer: cleanDoubleSlashes(`~/${nuxt.options.dir.app}/prismic/htmlSerializer`),
 		injectComponents: true,
 		components: {},
-		preview: '/preview'
+		preview: '/preview',
+		toolbar: true
 	}),
 	hooks: {},
 	setup (mergedOptions, nuxt) {
@@ -53,11 +53,9 @@ export default defineNuxtModule<PrismicModuleOptions>({
 		nuxt.options.build.transpile.push(resolver.resolve('runtime'), '@nuxtjs/prismic', '@prismicio/vue')
 
 		// Add runtime user code
-		const proxyUserFileWithUndefinedFallback = (filename: string, path?: string, extensions = ['js', 'mjs', 'ts']) => {
+		const proxyUserFileWithUndefinedFallback = (filename: string, path: string, extensions = ['js', 'mjs', 'ts']) => {
 			const resolvedFilename = `prismic/proxy/${filename}.ts`
-			const resolvedPath = path
-				? path.replace(/^(~~|@@)/, nuxt.options.rootDir).replace(/^(~|@)/, nuxt.options.srcDir)
-				: undefined
+			const resolvedPath = path.replace(/^(~~|@@)/, nuxt.options.rootDir).replace(/^(~|@)/, nuxt.options.srcDir)
 			const maybeUserFile = fileExists(resolvedPath, extensions)
 
 			if (maybeUserFile) {
@@ -76,9 +74,9 @@ export default defineNuxtModule<PrismicModuleOptions>({
 				})
 			}
 		}
-		proxyUserFileWithUndefinedFallback('client', mergedOptions.client)
-		proxyUserFileWithUndefinedFallback('linkResolver', mergedOptions.linkResolver)
-		proxyUserFileWithUndefinedFallback('htmlSerializer', mergedOptions.htmlSerializer)
+		proxyUserFileWithUndefinedFallback('client', mergedOptions.client!)
+		proxyUserFileWithUndefinedFallback('linkResolver', mergedOptions.linkResolver!)
+		proxyUserFileWithUndefinedFallback('htmlSerializer', mergedOptions.htmlSerializer!)
 
 		// Expose options through public runtime config
 		nuxt.options.runtimeConfig.public ||= {} as typeof nuxt.options.runtimeConfig.public
@@ -143,6 +141,12 @@ export default defineNuxtModule<PrismicModuleOptions>({
 				})
 			}
 
+			if (!mergedOptions.toolbar) {
+				logger.warn('`toolbar` option is disabled but `preview` is enabled. Previews won\'t work unless you manually load the toolbar.')
+			}
+		}
+
+		if (mergedOptions.toolbar) {
 			// Add toolbar
 			const repositoryName = isRepositoryEndpoint(mergedOptions.endpoint)
 				? getRepositoryName(mergedOptions.endpoint)
@@ -150,7 +154,10 @@ export default defineNuxtModule<PrismicModuleOptions>({
 			nuxt.options.app.head ||= {}
 			nuxt.options.app.head.script ||= []
 			nuxt.options.app.head.script.push({
-				src: `https://static.cdn.prismic.io/prismic.min.js?repo=${repositoryName}&new=true`
+				hid: 'prismic-preview',
+				src: `https://static.cdn.prismic.io/prismic.min.js?repo=${repositoryName}&new=true`,
+				async: true,
+				defer: true
 			})
 		}
 	}

package/src/runtime/plugin.client.ts

@@ -1,4 +1,4 @@
-import { defineNuxtPlugin } from '#app'
+import { defineNuxtPlugin, refreshNuxtData } from '#app'
 
 // import { name as pkgName } from '../../package.json'
 import { PrismicModuleOptions } from '../types'
@@ -15,10 +15,8 @@ export default defineNuxtPlugin((nuxtApp) => {
 	// Hot reload preview updates
 	if (mergedOptions.preview) {
 		window.addEventListener('prismicPreviewUpdate', (event) => {
-			if (refreshNuxtData) {
-				event.preventDefault()
-				refreshNuxtData()
-			}
+			event.preventDefault()
+			refreshNuxtData()
 		})
 	}
 })

package/src/runtime/plugin.ts

@@ -1,4 +1,4 @@
-import { defineNuxtPlugin } from '#app'
+import { defineNuxtPlugin, useCookie, useRequestEvent, refreshNuxtData } from '#app'
 import NuxtLink from '#app/components/nuxt-link'
 
 import { createPrismic } from '@prismicio/vue'
@@ -59,7 +59,8 @@ export default defineNuxtPlugin((nuxtApp) => {
 					refreshNuxtData()
 				}
 			} catch (error) {
-				// noop
+				// eslint-disable-next-line no-console
+				console.warn('Failed to parse Prismic preview cookie', error)
 			}
 		}
 	}

package/src/types.ts

@@ -6,4 +6,5 @@ export type PrismicModuleOptions = Omit<PrismicPluginOptions, 'endpoint' | 'clie
 	linkResolver?: string;
 	htmlSerializer?: string;
 	preview?: string | false;
+	toolbar?: boolean;
 };