@nuxtjs/prismic 5.2.0 → 5.2.1-canary.776ac17

package/README.md

@@ -27,18 +27,7 @@ Install the module to your Nuxt application with one command:
 npx nuxi@latest module add prismic
 ```
 
-Then, configure your Prismic API endpoint:
-
-```javascript
-import { defineNuxtConfig } from "nuxt"
-
-export default defineNuxtConfig({
-	modules: ["@nuxtjs/prismic"],
-	prismic: {
-		endpoint: "my-repository",
-	},
-})
-```
+The module automatically loads your repository name and `routes` from `prismic.config.json`, so for most projects all you need to do is register the module (done by the `module add` command). If needed, you can still override those values and configure the Nuxt module further in `nuxt.config.ts` or Nuxt's `runtimeConfig`.
 
 That's it! You can now use Prismic in your Nuxt app ✨
 

package/dist/module.d.mts

@@ -82,9 +82,9 @@ type PrismicModuleOptions = {
      * Controls which auto-imports are added by the module.
      *
      * - `"all"` will add all imports.
-     * - `["vue"]` will add `@nuxtjs/prismic` and `@prismicio/vue` imports.
-     * - `["javascript"]` will add `@prismicio/client` imports.
-     * - `["content"]` will add the `Content` type import.
+     * - `"vue"` will add `@nuxtjs/prismic` and `@prismicio/vue` imports.
+     * - `"javascript"` will add `@prismicio/client` imports.
+     * - `"content"` will add the `Content` type import.
      * - `false` will not add any import.
      *
      * @defaultValue `["vue"]`

package/dist/module.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuxtjs/prismic",
-  "version": "5.2.0",
+  "version": "5.2.1-canary.776ac17",
   "configKey": "prismic",
   "compatibility": {
     "nuxt": ">=3.7.0"

package/dist/module.mjs

@@ -1,4 +1,4 @@
-import { existsSync } from 'node:fs';
+import { existsSync, readFileSync } from 'node:fs';
 import { readFile } from 'node:fs/promises';
 import { join } from 'node:path';
 import { useLogger, defineNuxtModule, createResolver, addPlugin, addComponent, addImports, extendPages, getNuxtVersion, addTemplate } from '@nuxt/kit';
@@ -7,9 +7,10 @@ import { addDependency } from 'nypm';
 import { readPackage } from 'pkg-types';
 
 const name = "@nuxtjs/prismic";
-const version = "5.2.0";
+const version = "5.2.1-canary.776ac17";
 
 const logger = useLogger("nuxt:prismic");
+const PRISMIC_CONFIG_FILENAME = "prismic.config.json";
 async function addPrismicClient() {
   try {
     const pkg = await readPackage();
@@ -73,6 +74,7 @@ const module$1 = defineNuxtModule({
       nuxt.options.runtimeConfig.public?.prismic,
       options
     );
+    loadPrismicConfig();
     exposeRuntimeConfig();
     transpileDependencies();
     const ok = proxyUserFiles();
@@ -81,6 +83,29 @@ const module$1 = defineNuxtModule({
     addAutoImports();
     addPreviewRoute();
     extendESLintConfig();
+    function loadPrismicConfig() {
+      const prismicConfigPath = join(nuxt.options.rootDir, PRISMIC_CONFIG_FILENAME);
+      const prismicConfig = readPrismicConfig(prismicConfigPath);
+      const configKeys = [];
+      if (!moduleOptions.endpoint && prismicConfig.repositoryName) {
+        moduleOptions.endpoint = prismicConfig.repositoryName;
+        configKeys.push("repository name");
+      }
+      if (!moduleOptions.clientConfig?.routes && prismicConfig.routes) {
+        moduleOptions.clientConfig.routes = prismicConfig.routes;
+        configKeys.push("routes");
+      }
+      if (configKeys.length > 0) {
+        nuxt.options.watch.push(prismicConfigPath);
+        nuxt.hook("builder:watch", async (_, path) => {
+          if (path.replace(/\\/g, "/") === prismicConfigPath.replace(/\\/g, "/")) {
+            logger.info(`${PRISMIC_CONFIG_FILENAME} updated`);
+            await nuxt.callHook("restart");
+          }
+        });
+        logger.info(`Loaded ${configKeys.join(" and ")} from \`${PRISMIC_CONFIG_FILENAME}\``);
+      }
+    }
     function exposeRuntimeConfig() {
       nuxt.options.runtimeConfig.public ||= {};
       nuxt.options.runtimeConfig.public.prismic = moduleOptions;
@@ -298,5 +323,27 @@ function fileExists(path, extensions = ["js", "ts"]) {
   );
   return extension ? `${path}.${extension}` : null;
 }
+function readPrismicConfig(configPath) {
+  if (!existsSync(configPath)) {
+    return {};
+  }
+  try {
+    const contents = readFileSync(configPath, "utf-8");
+    const rawConfig = JSON.parse(contents);
+    if (!rawConfig || typeof rawConfig !== "object" || Array.isArray(rawConfig)) {
+      return {};
+    }
+    const config = {};
+    if ("repositoryName" in rawConfig && typeof rawConfig.repositoryName === "string") {
+      config.repositoryName = rawConfig.repositoryName;
+    }
+    if ("routes" in rawConfig && Array.isArray(rawConfig.routes)) {
+      config.routes = rawConfig.routes;
+    }
+    return config;
+  } catch {
+    return {};
+  }
+}
 
 export { module$1 as default };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nuxtjs/prismic",
-	"version": "5.2.0",
+	"version": "5.2.1-canary.776ac17",
 	"description": "Easily connect your Nuxt application to your content hosted on Prismic",
 	"keywords": [
 		"nuxt",
@@ -52,30 +52,30 @@
 		"test": "npm run lint && npm run types && npm run unit && npm run build"
 	},
 	"dependencies": {
-		"@nuxt/kit": "^4.2.2",
-		"@prismicio/vue": "^6.1.1",
-		"defu": "^6.1.4",
-		"nypm": "^0.6.2",
-		"pkg-types": "^2.3.0"
+		"@nuxt/kit": "^4.4.4",
+		"@prismicio/vue": "^6.1.3",
+		"defu": "^6.1.7",
+		"nypm": "^0.6.6",
+		"pkg-types": "^2.3.1"
 	},
 	"devDependencies": {
 		"@nuxt/module-builder": "^1.0.2",
-		"@nuxt/schema": "^4.2.2",
+		"@nuxt/schema": "^4.4.4",
 		"@nuxt/test-utils": "^3.23.0",
-		"@prismicio/client": "^7.21.3",
+		"@prismicio/client": "^7.21.8",
 		"@trivago/prettier-plugin-sort-imports": "^6.0.2",
-		"@types/node": "^25.0.9",
-		"@vitest/coverage-v8": "^4.0.17",
-		"nuxt": "^4.2.2",
-		"oxlint": "^1.41.0",
-		"prettier": "^3.8.0",
+		"@types/node": "^25.6.0",
+		"@vitest/coverage-v8": "^4.1.5",
+		"nuxt": "^4.4.4",
+		"oxlint": "^1.62.0",
+		"prettier": "^3.8.3",
 		"prettier-plugin-jsdoc": "^1.8.0",
-		"typescript": "^5.9.3",
-		"vitest": "^4.0.17",
-		"vue-tsc": "^3.2.2"
+		"typescript": "^6.0.3",
+		"vitest": "^4.1.5",
+		"vue-tsc": "^3.2.7"
 	},
 	"peerDependencies": {
-		"@prismicio/client": "^7"
+		"@prismicio/client": "^7.21.8"
 	},
 	"engines": {
 		"node": ">=20.0.0"

package/src/module.ts

@@ -1,4 +1,4 @@
-import { existsSync } from "node:fs"
+import { existsSync, readFileSync } from "node:fs"
 import { readFile } from "node:fs/promises"
 import { join } from "node:path"
 
@@ -13,7 +13,7 @@ import {
 	getNuxtVersion,
 	useLogger,
 } from "@nuxt/kit"
-import type { ClientConfig } from "@prismicio/client"
+import type { ClientConfig, Route } from "@prismicio/client"
 import { defu } from "defu"
 import { addDependency } from "nypm"
 import { readPackage } from "pkg-types"
@@ -108,9 +108,9 @@ export type PrismicModuleOptions = {
 	 * Controls which auto-imports are added by the module.
 	 *
 	 * - `"all"` will add all imports.
-	 * - `["vue"]` will add `@nuxtjs/prismic` and `@prismicio/vue` imports.
-	 * - `["javascript"]` will add `@prismicio/client` imports.
-	 * - `["content"]` will add the `Content` type import.
+	 * - `"vue"` will add `@nuxtjs/prismic` and `@prismicio/vue` imports.
+	 * - `"javascript"` will add `@prismicio/client` imports.
+	 * - `"content"` will add the `Content` type import.
 	 * - `false` will not add any import.
 	 *
 	 * @defaultValue `["vue"]`
@@ -148,6 +148,7 @@ declare module "@nuxt/schema" {
 }
 
 const logger = useLogger("nuxt:prismic")
+const PRISMIC_CONFIG_FILENAME = "prismic.config.json"
 
 async function addPrismicClient() {
 	try {
@@ -220,10 +221,11 @@ export default defineNuxtModule<PrismicModuleOptions>({
 		const resolver = createResolver(import.meta.url)
 
 		const moduleOptions: PrismicModuleOptions = defu(
-			nuxt.options.runtimeConfig.public?.prismic,
+			nuxt.options.runtimeConfig.public?.prismic as PrismicModuleOptions,
 			options,
 		)
 
+		loadPrismicConfig()
 		exposeRuntimeConfig()
 		transpileDependencies()
 		const ok = proxyUserFiles()
@@ -233,10 +235,37 @@ export default defineNuxtModule<PrismicModuleOptions>({
 		addPreviewRoute()
 		extendESLintConfig()
 
+		function loadPrismicConfig() {
+			const prismicConfigPath = join(nuxt.options.rootDir, PRISMIC_CONFIG_FILENAME)
+			const prismicConfig = readPrismicConfig(prismicConfigPath)
+
+			const configKeys: string[] = []
+			if (!moduleOptions.endpoint && prismicConfig.repositoryName) {
+				moduleOptions.endpoint = prismicConfig.repositoryName
+				configKeys.push("repository name")
+			}
+			if (!moduleOptions.clientConfig?.routes && prismicConfig.routes) {
+				moduleOptions.clientConfig!.routes = prismicConfig.routes
+				configKeys.push("routes")
+			}
+
+			if (configKeys.length > 0) {
+				nuxt.options.watch.push(prismicConfigPath)
+				nuxt.hook("builder:watch", async (_, path) => {
+					if (path.replace(/\\/g, "/") === prismicConfigPath.replace(/\\/g, "/")) {
+						logger.info(`${PRISMIC_CONFIG_FILENAME} updated`)
+						await nuxt.callHook("restart")
+					}
+				})
+
+				logger.info(`Loaded ${configKeys.join(" and ")} from \`${PRISMIC_CONFIG_FILENAME}\``)
+			}
+		}
+
 		function exposeRuntimeConfig() {
 			nuxt.options.runtimeConfig.public ||=
 				{} as typeof nuxt.options.runtimeConfig.public
-			nuxt.options.runtimeConfig.public.prismic = moduleOptions
+			(nuxt.options.runtimeConfig.public.prismic as PrismicModuleOptions) = moduleOptions
 		}
 
 		function transpileDependencies() {
@@ -510,3 +539,38 @@ function fileExists(path?: string, extensions = ["js", "ts"]): string | null {
 
 	return extension ? `${path}.${extension}` : null
 }
+
+type PrismicConfig = {
+	repositoryName?: string
+	routes?: Route[]
+}
+
+function readPrismicConfig(
+	configPath: string,
+): PrismicConfig {
+	if (!existsSync(configPath)) {
+		return {}
+	}
+
+	try {
+		const contents = readFileSync(configPath, "utf-8")
+		const rawConfig = JSON.parse(contents) as unknown
+
+		if (!rawConfig || typeof rawConfig !== "object" || Array.isArray(rawConfig)) {
+			return {}
+		}
+
+		const config: PrismicConfig = {}
+		if ("repositoryName" in rawConfig && typeof rawConfig.repositoryName === "string") {
+			config.repositoryName = rawConfig.repositoryName
+		}
+
+		if ("routes" in rawConfig && Array.isArray(rawConfig.routes)) {
+			config.routes = rawConfig.routes
+		}
+
+		return config
+	} catch {
+		return {}
+	}
+}