@nuxtjs/prismic 3.0.0-alpha.1 → 3.0.0-alpha.2

package/dist/module.d.ts

@@ -1,10 +1,13 @@
 import * as _nuxt_schema from '@nuxt/schema';
 import { PrismicPluginOptions } from '@prismicio/vue';
 
-declare type PrismicModuleOptions = PrismicPluginOptions & {
+declare type PrismicModuleOptions = Omit<PrismicPluginOptions, 'endpoint' | 'client' | 'linkResolver'> & {
+    endpoint: string;
+    client?: string;
+    linkResolver?: string;
     preview?: string | false;
 };
 
 declare const _default: _nuxt_schema.NuxtModule<PrismicModuleOptions>;
 
-export { _default as default };
+export { PrismicModuleOptions as ModuleOptions, PrismicModuleOptions, _default as default };

package/dist/module.json

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

package/dist/module.mjs

@@ -1,11 +1,23 @@
 import { join } from 'path';
-import { existsSync } from 'fs';
-import { defineNuxtModule, createResolver, addPlugin, addComponent, addAutoImport, extendPages } from '@nuxt/kit';
+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';
 
 const name = "@nuxtjs/prismic";
-const version = "3.0.0-alpha.1";
+const version = "3.0.0-alpha.2";
+
+const fileExists = (path, extensions = ["js", "ts"]) => {
+  if (!path) {
+    return null;
+  } else if (existsSync(path)) {
+    return path;
+  }
+  const extension = extensions.find((extension2) => existsSync(`${path}.${extension2}`));
+  return extension ? `${path}.${extension}` : null;
+};
 
 const logger = consola.withScope("nuxt:prismic");
 
@@ -16,26 +28,44 @@ const module = defineNuxtModule({
     configKey: "prismic",
     compatibility: { nuxt: "^3.0.0" }
   },
-  defaults: {
+  defaults: (nuxt) => ({
     endpoint: "",
     clientConfig: {},
-    linkResolver: void 0,
+    client: cleanDoubleSlashes(`~/${nuxt.options.dir.app}/prismic/client`),
+    linkResolver: cleanDoubleSlashes(`~/${nuxt.options.dir.app}/prismic/linkResolver`),
     htmlSerializer: void 0,
     injectComponents: true,
-    components: {
-      linkInternalComponent: "nuxt-link"
-    },
+    components: {},
     preview: "/preview"
-  },
+  }),
   hooks: {},
   setup(mergedOptions, nuxt) {
     var _a, _b, _c;
-    if (!mergedOptions.client && !mergedOptions.endpoint) {
-      logger.warn("Options `endpoint` or `client` are required, disabling module...");
+    if (!mergedOptions.endpoint) {
+      logger.warn("Options `endpoint` is required, disabling module...");
       return;
     }
     const resolver = createResolver(import.meta.url);
     nuxt.options.build.transpile.push(resolver.resolve("runtime"));
+    const addUserFileWithUndefinedFallback = (filename, path, extensions = ["js", "ts"]) => {
+      const resolvedFilename = `prismic/${filename}.ts`;
+      const resolvedPath = path ? path.replace(/^(~~|@@)/, nuxt.options.rootDir).replace(/^(~|@)/, nuxt.options.srcDir) : void 0;
+      const maybeUserFile = fileExists(resolvedPath, extensions);
+      if (maybeUserFile) {
+        logger.info(`Using user-defined \`${filename}\` at \`${maybeUserFile.replace(nuxt.options.srcDir, "~").replace(/\\/g, "/")}\``);
+        addTemplate({
+          filename: resolvedFilename,
+          src: maybeUserFile
+        });
+      } else {
+        addTemplate({
+          filename: resolvedFilename,
+          getContents: () => "export default undefined"
+        });
+      }
+    };
+    addUserFileWithUndefinedFallback("client", mergedOptions.client);
+    addUserFileWithUndefinedFallback("linkResolver", mergedOptions.linkResolver);
     (_a = nuxt.options).publicRuntimeConfig || (_a.publicRuntimeConfig = {});
     nuxt.options.publicRuntimeConfig[name] = mergedOptions;
     addPlugin(resolver.resolve("runtime/plugin"));
@@ -64,9 +94,9 @@ const module = defineNuxtModule({
     });
     addAutoImport(composableAutoImports);
     if (mergedOptions.preview) {
-      const userPreviewPagePath = join(nuxt.options.srcDir, nuxt.options.dir.pages, `${mergedOptions.preview}.vue`);
-      if (existsSync(userPreviewPagePath)) {
-        logger.info(`Using user-defined preview page at \`${userPreviewPagePath.replace(join(nuxt.options.rootDir), "~~").replace(/\\/g, "/")}\`, available at \`${mergedOptions.preview}\``);
+      const maybeUserPreviewPage = fileExists(join(nuxt.options.srcDir, nuxt.options.dir.pages, mergedOptions.preview), ["js", "ts", "vue"]);
+      if (maybeUserPreviewPage) {
+        logger.info(`Using user-defined preview page at \`${maybeUserPreviewPage.replace(join(nuxt.options.srcDir), "~").replace(/\\/g, "/")}\`, available at \`${mergedOptions.preview}\``);
       } else {
         logger.info(`Using default preview page, available at \`${mergedOptions.preview}\``);
         extendPages((pages) => {
@@ -77,16 +107,7 @@ const module = defineNuxtModule({
           });
         });
       }
-      let repositoryName = "";
-      if (mergedOptions.client) {
-        repositoryName = new URL(mergedOptions.client.endpoint).host.split(".")[0];
-      } else {
-        try {
-          repositoryName = new URL(mergedOptions.endpoint).host.split(".")[0];
-        } catch (error) {
-          repositoryName = mergedOptions.endpoint;
-        }
-      }
+      const repositoryName = isRepositoryEndpoint(mergedOptions.endpoint) ? getRepositoryName(mergedOptions.endpoint) : mergedOptions.endpoint;
       (_b = nuxt.options).meta || (_b.meta = {});
       (_c = nuxt.options.meta).script || (_c.script = []);
       nuxt.options.meta.script.push({

package/dist/runtime/plugin.mjs

@@ -1,10 +1,20 @@
 import { defineNuxtPlugin } from "#app";
+import NuxtLink from "#app/components/nuxt-link";
 import { createPrismic } from "@prismicio/vue";
 import { name as pkgName } from "../../package.json";
+import linkResolver from "#build/prismic/linkResolver";
+import client from "#build/prismic/client";
 export default defineNuxtPlugin((nuxtApp) => {
   const mergedOptions = nuxtApp.payload.config[pkgName];
   nuxtApp.vueApp.use(createPrismic({
     ...mergedOptions,
-    injectComponents: false
+    client,
+    linkResolver,
+    injectComponents: false,
+    components: {
+      linkInternalComponent: NuxtLink,
+      linkExternalComponent: NuxtLink,
+      ...mergedOptions.components
+    }
   }));
 });

package/dist/types.d.ts

@@ -1,6 +1,10 @@
 
-import {  } from './module'
+import { ModuleOptions } from './module'
 
+declare module '@nuxt/schema' {
+  interface NuxtConfig { ['prismic']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['prismic']?: ModuleOptions }
+}
 
 
 export { default } from './module'

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nuxtjs/prismic",
-	"version": "3.0.0-alpha.1",
+	"version": "3.0.0-alpha.2",
 	"description": "Easily connect your Nuxt 3 application to your content hosted on Prismic",
 	"keywords": [
 		"nuxt",
@@ -36,31 +36,28 @@
 		"dev": "nuxi dev playground",
 		"dev:build": "nuxi build playground",
 		"lint": "eslint --ext .js,.ts .",
-		"playground:build": "nuxi build playground",
-		"playground:dev": "nuxi dev playground",
 		"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:dry": "standard-version --dry-run",
 		"test": "npm run lint && npm run unit",
-		"unit": "nyc --reporter=lcovonly --reporter=text --exclude-after-remap=false ava"
+		"unit": "echo \"TODO: vitest & nuxt-test-utils\""
 	},
 	"dependencies": {
 		"@nuxt/kit": "npm:@nuxt/kit-edge@latest",
+		"@prismicio/client": "^6.4.2",
 		"@prismicio/vue": "^3.0.0-beta",
-		"consola": "^2.15.3"
+		"consola": "^2.15.3",
+		"ufo": "^0.8.1"
 	},
 	"devDependencies": {
 		"@nuxt/module-builder": "latest",
 		"@nuxtjs/eslint-config-typescript": "latest",
-		"ava": "^3.15.0",
-		"eslint": "^8.9.0",
+		"eslint": "^8.11.0",
 		"nuxt3": "latest",
-		"nyc": "^15.1.0",
 		"standard-version": "^9.3.2",
-		"ts-eager": "^2.0.2",
-		"typescript": "^4.5.5"
+		"typescript": "^4.6.2"
 	},
 	"engines": {
 		"node": ">=12.7.0"

package/src/module.ts

@@ -1,13 +1,29 @@
 import { join } from 'path'
-import { existsSync } from 'fs'
-import { defineNuxtModule, createResolver, addPlugin, addAutoImport, addComponent, extendPages } from '@nuxt/kit'
 
+import {
+	defineNuxtModule,
+	createResolver,
+	addTemplate,
+	addPlugin,
+	addAutoImport,
+	addComponent,
+	extendPages
+} from '@nuxt/kit'
+import { cleanDoubleSlashes } from 'ufo'
+
+import { isRepositoryEndpoint, getRepositoryName } from '@prismicio/client'
 import * as prismicVue from '@prismicio/vue'
 
 import { name as pkgName, version as pkgVersion } from '../package.json'
-import { PrismicModuleOptions } from './types'
+import type { PrismicModuleOptions } from './types'
+import { fileExists } from './utils'
 import { logger } from './logger'
 
+// Options export
+export type { PrismicModuleOptions } from './types'
+export type { PrismicModuleOptions as ModuleOptions } from './types'
+
+// Module export
 export default defineNuxtModule<PrismicModuleOptions>({
 	meta: {
 		name: pkgName,
@@ -15,21 +31,20 @@ export default defineNuxtModule<PrismicModuleOptions>({
 		configKey: 'prismic',
 		compatibility: { nuxt: '^3.0.0' }
 	},
-	defaults: {
+	defaults: nuxt => ({
 		endpoint: '',
 		clientConfig: {},
-		linkResolver: undefined,
+		client: cleanDoubleSlashes(`~/${nuxt.options.dir.app}/prismic/client`),
+		linkResolver: cleanDoubleSlashes(`~/${nuxt.options.dir.app}/prismic/linkResolver`),
 		htmlSerializer: undefined,
 		injectComponents: true,
-		components: {
-			linkInternalComponent: 'nuxt-link'
-		},
+		components: {},
 		preview: '/preview'
-	},
+	}),
 	hooks: {},
 	setup (mergedOptions, nuxt) {
-		if (!mergedOptions.client && !mergedOptions.endpoint) {
-			logger.warn('Options `endpoint` or `client` are required, disabling module...')
+		if (!mergedOptions.endpoint) {
+			logger.warn('Options `endpoint` is required, disabling module...')
 			return
 		}
 
@@ -37,8 +52,33 @@ export default defineNuxtModule<PrismicModuleOptions>({
 		const resolver = createResolver(import.meta.url)
 		nuxt.options.build.transpile.push(resolver.resolve('runtime'))
 
+		// Add runtime user code
+		const addUserFileWithUndefinedFallback = (filename: string, path?: string, extensions = ['js', 'ts']) => {
+			const resolvedFilename = `prismic/${filename}.ts`
+			const resolvedPath = path
+				? path.replace(/^(~~|@@)/, nuxt.options.rootDir).replace(/^(~|@)/, nuxt.options.srcDir)
+				: undefined
+			const maybeUserFile = fileExists(resolvedPath, extensions)
+
+			if (maybeUserFile) {
+				logger.info(`Using user-defined \`${filename}\` at \`${maybeUserFile.replace(nuxt.options.srcDir, '~').replace(/\\/g, '/')}\``)
+
+				addTemplate({
+					filename: resolvedFilename,
+					src: maybeUserFile
+				})
+			} else {
+				addTemplate({
+					filename: resolvedFilename,
+					getContents: () => 'export default undefined'
+				})
+			}
+		}
+		addUserFileWithUndefinedFallback('client', mergedOptions.client)
+		addUserFileWithUndefinedFallback('linkResolver', mergedOptions.linkResolver)
+
 		// Expose options through public runtime config
-		nuxt.options.publicRuntimeConfig ||= {}
+		nuxt.options.publicRuntimeConfig ||= {} as typeof nuxt.options.publicRuntimeConfig
 		nuxt.options.publicRuntimeConfig[pkgName] = mergedOptions
 
 		// Add plugin
@@ -77,11 +117,10 @@ export default defineNuxtModule<PrismicModuleOptions>({
 
 		// Add preview route
 		if (mergedOptions.preview) {
-			const userPreviewPagePath = join(nuxt.options.srcDir, nuxt.options.dir.pages, `${mergedOptions.preview}.vue`)
+			const maybeUserPreviewPage = fileExists(join(nuxt.options.srcDir, nuxt.options.dir.pages, mergedOptions.preview), ['js', 'ts', 'vue'])
 
-			if (existsSync(userPreviewPagePath)) {
-				logger.info(`Using user-defined preview page at \`${
-					userPreviewPagePath.replace(join(nuxt.options.rootDir), '~~').replace(/\\/g, '/')
+			if (maybeUserPreviewPage) {
+				logger.info(`Using user-defined preview page at \`${maybeUserPreviewPage.replace(join(nuxt.options.srcDir), '~').replace(/\\/g, '/')
 				}\`, available at \`${mergedOptions.preview}\``)
 			} else {
 				logger.info(`Using default preview page, available at \`${mergedOptions.preview}\``)
@@ -95,19 +134,10 @@ export default defineNuxtModule<PrismicModuleOptions>({
 				})
 			}
 
-			// TODO: Refactor with new client helpers
-			let repositoryName = ''
-			if (mergedOptions.client) {
-				repositoryName = new URL(mergedOptions.client.endpoint).host.split('.')[0]
-			} else {
-				try {
-					repositoryName = new URL(mergedOptions.endpoint).host.split('.')[0]
-				} catch (error) {
-					repositoryName = mergedOptions.endpoint
-				}
-			}
-
 			// Add toolbar
+			const repositoryName = isRepositoryEndpoint(mergedOptions.endpoint)
+				? getRepositoryName(mergedOptions.endpoint)
+				: mergedOptions.endpoint
 			nuxt.options.meta ||= {}
 			nuxt.options.meta.script ||= []
 			nuxt.options.meta.script.push({

package/src/runtime/plugin.ts

@@ -1,14 +1,26 @@
 import { defineNuxtPlugin } from '#app'
+import NuxtLink from '#app/components/nuxt-link'
+
 import { createPrismic } from '@prismicio/vue'
 
 import { name as pkgName } from '../../package.json'
 import { PrismicModuleOptions } from '../types'
 
+import linkResolver from '#build/prismic/linkResolver'
+import client from '#build/prismic/client'
+
 export default defineNuxtPlugin((nuxtApp) => {
 	const mergedOptions: PrismicModuleOptions = nuxtApp.payload.config[pkgName]
 
 	nuxtApp.vueApp.use(createPrismic({
 		...mergedOptions,
-		injectComponents: false // Handled at module level
+		client,
+		linkResolver,
+		injectComponents: false, // Handled at module level
+		components: {
+			linkInternalComponent: NuxtLink,
+			linkExternalComponent: NuxtLink,
+			...mergedOptions.components
+		}
 	}))
 })

package/src/types.ts

@@ -1,5 +1,8 @@
 import { PrismicPluginOptions } from '@prismicio/vue'
 
-export type PrismicModuleOptions = PrismicPluginOptions & {
-	preview?: string | false
+export type PrismicModuleOptions = Omit<PrismicPluginOptions, 'endpoint' | 'client' | 'linkResolver'> & {
+	endpoint: string,
+	client?: string,
+	linkResolver?: string,
+	preview?: string | false,
 };

package/src/utils.ts

@@ -0,0 +1,14 @@
+import { existsSync } from 'fs'
+
+export const fileExists = (path?: string, extensions = ['js', 'ts']): string | null => {
+	if (!path) {
+		return null
+	} else if (existsSync(path)) {
+		// If path already contains/forces the extension
+		return path
+	}
+
+	const extension = extensions.find(extension => existsSync(`${path}.${extension}`))
+
+	return extension ? `${path}.${extension}` : null
+}