nuxt-error-tracker 0.1.4 → 0.1.6

package/README.md

@@ -23,6 +23,32 @@ npm i nuxt-error-tracker
 # or: bun add nuxt-error-tracker
 ```
 
+## Getting your keys
+
+The module needs two values — an **ingest endpoint** and a **public key**. Both
+come from your Observer dashboard. Everything after step 4 is what you paste into
+the app; from then on your errors show up in the same dashboard.
+
+1. Open the dashboard at `https://<your-observer-host>/dashboard`.
+2. **Create account** — enter an email and a password (min 8 chars), submit. You
+   stay signed in via a secure cookie.
+3. Click **New project**, give it a name (e.g. `my-app`), and optionally list the
+   origins your site runs on (comma-separated, e.g. `https://my-app.com,
+   http://localhost:3000`). Empty = accept any origin. This is the server-side
+   allowlist — requests from other origins are rejected.
+4. The project now shows a **public key** (`pk_…`) and a ready-made
+   `nuxt.config` snippet. Use **Copy key** / **Copy config**.
+5. The **endpoint** is your host + `/v1/ingest`, i.e.
+   `https://<your-observer-host>/v1/ingest`.
+
+Then configure the package ([Setup](#setup)) and deploy. Captured errors appear
+under that project in the dashboard — open **Logs** on the project to browse
+them, with stack traces, recent occurrences and the breadcrumb trail.
+
+> Origins matter: if you set an allowlist, it must include every origin your app
+> is served from (prod domains **and** `http://localhost:3000` for local dev),
+> or the browser's requests get a 401.
+
 ## Setup
 
 Add the module and point it at your ingest endpoint with your project's public
@@ -102,7 +128,7 @@ const { $trackError, $addBreadcrumb } = useNuxtApp()
 
 // Report a handled error yourself
 try {
-  await risky()
+  await mayFail()
 } catch (e) {
   $trackError(e)
 }
@@ -116,6 +142,10 @@ $addBreadcrumb({
 })
 ```
 
+Both helpers are always callable. Real capture happens **client-side only**; on
+the server (SSR — e.g. top-level `<script setup>`) they are safe no-ops, so
+calling them never throws.
+
 ## What gets sent
 
 Per error: `message`, `stack`, `source` (`vue` | `window` | `promise` |

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-error-tracker",
   "configKey": "errorTracker",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "builder": {
     "@nuxt/module-builder": "0.8.4",
     "unbuild": "2.0.0"

package/dist/module.mjs

@@ -1,4 +1,4 @@
-import { defineNuxtModule, extendViteConfig, createResolver, addPlugin } from '@nuxt/kit';
+import { defineNuxtModule, createResolver, addPlugin } from '@nuxt/kit';
 
 function posInt(value, fallback) {
   const n = Number(value);
@@ -37,14 +37,11 @@ const module = defineNuxtModule({
       // Server DTO caps at 50 breadcrumbs — stay at or below.
       maxBreadcrumbs: Math.min(posInt(options.maxBreadcrumbs, 30), 50)
     };
-    extendViteConfig((config) => {
-      config.optimizeDeps ||= {};
-      config.optimizeDeps.include ||= [];
-      if (!config.optimizeDeps.include.includes("protobufjs")) {
-        config.optimizeDeps.include.push("protobufjs");
-      }
-    });
     const resolver = createResolver(import.meta.url);
+    addPlugin({
+      src: resolver.resolve("./runtime/plugin.server"),
+      mode: "server"
+    });
     addPlugin({
       src: resolver.resolve("./runtime/plugin.client"),
       mode: "client"

package/dist/runtime/ingest.codec.js

@@ -1,37 +1,24 @@
-import protobuf from "protobufjs";
-const INGEST_PROTO = `
-syntax = "proto3";
-message Breadcrumb {
-  string type = 1;
-  string category = 2;
-  string message = 3;
-  string level = 4;
-  string timestamp = 5;
-  string data = 6;
-}
-message Error {
-  string message = 1;
-  string stack = 2;
-  string source = 3;
-  string url = 4;
-  string route = 5;
-  string userId = 6;
-  string appVersion = 7;
-  string device = 8;
-  string occurredAt = 9;
-  repeated Breadcrumb breadcrumbs = 10;
+const textEncoder = new TextEncoder();
+function pushVarint(out, value) {
+  let v = value >>> 0;
+  while (v > 127) {
+    out.push(v & 127 | 128);
+    v >>>= 7;
+  }
+  out.push(v);
 }
-message Meta {
-  string device = 1;
-  string userId = 2;
-  string appVersion = 3;
+function pushLenField(out, fieldNo, bytes) {
+  pushVarint(out, fieldNo << 3 | 2);
+  pushVarint(out, bytes.length);
+  for (let i = 0; i < bytes.length; i++) out.push(bytes[i]);
 }
-message Batch {
-  Meta meta = 1;
-  repeated Error errors = 2;
+function pushString(out, fieldNo, value) {
+  if (!value) return;
+  const encoded = textEncoder.encode(value);
+  pushVarint(out, fieldNo << 3 | 2);
+  pushVarint(out, encoded.length);
+  for (let i = 0; i < encoded.length; i++) out.push(encoded[i]);
 }
-`;
-const Batch = protobuf.parse(INGEST_PROTO).root.lookupType("Batch");
 function jsonStr(v) {
   if (v === void 0 || v === null) return "";
   try {
@@ -40,31 +27,38 @@ function jsonStr(v) {
     return "";
   }
 }
+function encodeBreadcrumb(c) {
+  const out = [];
+  pushString(out, 1, c.type ?? "");
+  pushString(out, 2, c.category ?? "");
+  pushString(out, 3, c.message ?? "");
+  pushString(out, 4, c.level ?? "");
+  pushString(out, 5, c.timestamp ?? "");
+  pushString(out, 6, jsonStr(c.data));
+  return out;
+}
+function encodeError(e) {
+  const out = [];
+  pushString(out, 1, e.message);
+  pushString(out, 2, e.stack);
+  pushString(out, 3, e.source);
+  pushString(out, 4, e.url);
+  pushString(out, 5, e.route);
+  pushString(out, 9, e.occurredAt);
+  for (const c of e.breadcrumbs ?? []) {
+    pushLenField(out, 10, encodeBreadcrumb(c));
+  }
+  return out;
+}
 export function encodeBatch(body) {
-  const message = {
-    meta: {
-      device: jsonStr(body.meta.device),
-      userId: body.meta.userId ?? "",
-      appVersion: body.meta.appVersion ?? ""
-    },
-    errors: body.errors.map((e) => ({
-      message: e.message,
-      stack: e.stack,
-      source: e.source,
-      url: e.url,
-      route: e.route,
-      appVersion: "",
-      device: "",
-      occurredAt: e.occurredAt,
-      breadcrumbs: (e.breadcrumbs ?? []).map((c) => ({
-        type: c.type ?? "",
-        category: c.category ?? "",
-        message: c.message ?? "",
-        level: c.level ?? "",
-        timestamp: c.timestamp ?? "",
-        data: jsonStr(c.data)
-      }))
-    }))
-  };
-  return Batch.encode(Batch.fromObject(message)).finish();
+  const out = [];
+  const meta = [];
+  pushString(meta, 1, jsonStr(body.meta.device));
+  pushString(meta, 2, body.meta.userId ?? "");
+  pushString(meta, 3, body.meta.appVersion ?? "");
+  pushLenField(out, 1, meta);
+  for (const e of body.errors) {
+    pushLenField(out, 2, encodeError(e));
+  }
+  return new Uint8Array(out);
 }

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

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

package/dist/runtime/plugin.server.js

@@ -0,0 +1,9 @@
+import { defineNuxtPlugin } from "#imports";
+export default defineNuxtPlugin(() => ({
+  provide: {
+    trackError: (_err) => {
+    },
+    addBreadcrumb: (_c) => {
+    }
+  }
+}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-error-tracker",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "type": "module",
   "exports": {
     ".": {
@@ -19,9 +19,6 @@
     "build": "nuxt-module-build build",
     "prepublishOnly": "nuxt-module-build build"
   },
-  "dependencies": {
-    "protobufjs": "^8.6.6"
-  },
   "peerDependencies": {
     "@nuxt/kit": "^3.14.0 || ^4.0.0"
   },