analytics-platform 0.0.0-stage → 0.2.2

package/next.d.ts

@@ -0,0 +1,36 @@
+export interface NextFirewallOptions {
+  siteId: string;
+  /** The site secret (site settings). Keep it in an environment variable. */
+  secret: string;
+  /** The collector's URL. */
+  endpoint: string;
+  /**
+   * How to find the visitor's address. Default on Vercel: "vercel". Self-hosted
+   * Next.js has no connection address in middleware: set the number of proxies
+   * in X-Forwarded-For, "cloudflare", or a function.
+   */
+  trustProxy?: "vercel" | "cloudflare" | number | ((request: Request) => string);
+  /** Overrides the mode set in the dashboard. */
+  mode?: "monitor" | "block";
+  /** Return true to leave a request unchecked. */
+  skip?: (request: Request) => boolean;
+  /** A rate-limit counter shared between instances (e.g. Upstash Redis): returns the hits so far. */
+  counter?: (key: string, ttlSeconds: number) => Promise<number> | number;
+  debug?: boolean;
+}
+
+/** Next.js middleware: returns a Response when blocked, else undefined (the request goes on). */
+export function createNextFirewall(options: NextFirewallOptions):
+  (request: Request, event?: { waitUntil(promise: Promise<unknown>): void }) => Promise<Response | undefined>;
+
+export interface OnRequestErrorOptions {
+  siteId: string;
+  secret: string;
+  endpoint: string;
+  debug?: boolean;
+}
+
+/** For instrumentation.ts: export const onRequestError = createOnRequestError({...}). */
+export function createOnRequestError(options: OnRequestErrorOptions):
+  (error: unknown, request: { path: string; method: string; headers: Record<string, string | string[] | undefined> },
+   context: { routePath?: string; routerKind?: string; routeType?: string }) => Promise<void>;

package/package.json

@@ -1,6 +1,43 @@
 {
   "name": "analytics-platform",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.2",
+  "description": "Firewall, error monitoring and server analytics for your Node server, run from your analytics dashboard.",
+  "author": "steviec87",
+  "license": "MIT",
+  "keywords": [
+    "firewall",
+    "waf",
+    "rate-limit",
+    "error-monitoring",
+    "analytics",
+    "server-monitoring",
+    "express",
+    "nextjs"
+  ],
+  "main": "index.js",
+  "types": "index.d.ts",
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "next.d.ts",
+    "lib/",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    },
+    "./next": {
+      "types": "./next.d.ts",
+      "default": "./lib/next.js"
+    }
+  },
+  "scripts": {
+    "test": "node --test test/*.test.js"
+  }
+}