feat!: set default proxy path to _plausible

Author: johannschopplich

README.md

@@ -83,7 +83,7 @@ export default defineNuxtConfig({
 ```
 
 > [!NOTE]
-> When enabled, all Plausible events will be sent to your server first, which then forwards them to Plausible's API. The default proxy endpoint is `/api/__plausible_event__`, but you can customize the path using the `proxyBaseURL` module option.
+> When enabled, all Plausible events will be sent to your server first, which then forwards them to Plausible's API. The default proxy endpoint is `/_plausible`, but you can customize the path using the `proxyBaseEndpoint` module option.
 
 ## Module Options
 
@@ -99,7 +99,7 @@ export default defineNuxtConfig({
 | `autoOutboundTracking` | `boolean`  | `false`                      | Track all outbound link clicks automatically. If enabled, a [MutationObserver](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver) automagically detects link nodes throughout the application and binds `click` events to them. |
 | `logIgnoredEvents`     | `boolean`  | `false`                      | Log events to the console if they are ignored.                                                                                                                                                                                                  |
 | `proxy`                | `boolean`  | `false`                      | Whether to proxy the event endpoint through the current origin.                                                                                                                                                                                 |
-| `proxyBaseURL`         | `string`   | `'/api/__plausible_event__'` | The base URL to proxy the event endpoint through.                                                                                                                                                                                               |
+| `proxyBaseEndpoint`    | `string`   | `'/_plausible'`              | The base endpoint to proxy the Plausible event endpoint through.                                                                                                                                                                                |
 
 ## Composables
 

package.json

@@ -2,7 +2,7 @@
   "name": "@nuxtjs/plausible",
   "type": "module",
   "version": "1.1.1",
-  "packageManager": "pnpm@9.13.2",
+  "packageManager": "pnpm@9.14.2",
   "description": "Natively integrates Plausible Analytics into Nuxt",
   "author": "Johann Schopplich <[email protected]>",
   "license": "MIT",
@@ -41,19 +41,19 @@
     "release": "bumpp"
   },
   "dependencies": {
-    "@barbapapazes/plausible-tracker": "^0.5.3",
-    "@nuxt/kit": "^3.14.159",
+    "@barbapapazes/plausible-tracker": "^0.5.6",
+    "@nuxt/kit": "^3.14.1592",
     "defu": "^6.1.4"
   },
   "devDependencies": {
-    "@nuxt/eslint-config": "^0.7.0",
+    "@nuxt/eslint-config": "^0.7.1",
     "@nuxt/module-builder": "^0.8.4",
-    "@nuxt/schema": "^3.14.159",
-    "@types/node": "^20.17.6",
+    "@nuxt/schema": "^3.14.1592",
+    "@types/node": "^20.17.7",
     "bumpp": "^9.8.1",
     "eslint": "^9.15.0",
-    "eslint-plugin-perfectionist": "^3.9.1",
-    "nuxt": "^3.14.159",
+    "eslint-plugin-perfectionist": "^4.0.3",
+    "nuxt": "^3.14.1592",
     "typescript": "^5.6.3",
     "vue-tsc": "^2.1.10"
   }

playground/app.vue

@@ -35,21 +35,23 @@ function pushRoute() {
   <h3>Configuration</h3>
   <details>
     <summary>Public Runtime Options</summary>
-    <pre>{{ JSON.stringify(plausible, null, 2) }}</pre>
+    <pre>{{ JSON.stringify(plausible, undefined, 2) }}</pre>
   </details>
 
   <h3>Composables</h3>
-  <button @click="trackEvent">
-    useTrackEvent
-  </button>
-  &nbsp;
-  <button @click="trackPageview">
-    useTrackPageview
-  </button>
-  &nbsp;
-  <button @click="pushRoute">
-    navigateTo
-  </button>
+  <p>
+    <button @click="trackEvent">
+      useTrackEvent
+    </button>
+    &nbsp;
+    <button @click="trackPageview">
+      useTrackPageview
+    </button>
+    &nbsp;
+    <button @click="pushRoute">
+      navigateTo
+    </button>
+  </p>
 
   <h3>Links</h3>
   <ul>

playground/nuxt.config.ts

@@ -1,9 +1,13 @@
+import NuxtPlausible from '../src/module'
+
 export default defineNuxtConfig({
-  modules: ['@nuxtjs/plausible'],
+  modules: [NuxtPlausible],
 
   compatibilityDate: '2024-04-03',
 
   plausible: {
+    // Enable tracking events on localhost
+    ignoredHostnames: [],
     autoPageviews: false,
     autoOutboundTracking: false,
     proxy: true,

playground/package.json

@@ -6,8 +6,5 @@
     "dev": "nuxi dev",
     "build": "nuxi build",
     "generate": "nuxi generate"
-  },
-  "dependencies": {
-    "@nuxtjs/plausible": "workspace:"
   }
 }