@nodewrite-labs/analytics-sdk 0.0.0-stage → 0.2.0

package/dist/server/index.d.ts

@@ -0,0 +1,41 @@
+import { c as RequestGeo } from '../options-Dpx2vs4R.js';
+import { AnalyticsServerOptions } from '../index.js';
+import { AnalyticsEventStore } from '../index.js';
+
+/** Reads `country` and `city` from the request object the app passed in. */
+declare function readRequestGeo(request: object): RequestGeo;
+
+type AnalyticsHeaderBag = Headers | Record<string, string | string[] | undefined>;
+
+interface AnalyticsEventRequest {
+    body?: unknown;
+    headers?: AnalyticsHeaderBag;
+    request?: Request;
+    country?: unknown;
+    city?: unknown;
+}
+interface RecordAnalyticsEventDeps {
+    store: AnalyticsEventStore;
+    options: AnalyticsServerOptions;
+    now?: () => string;
+}
+interface RecordAnalyticsEventResult {
+    status: number;
+    body: {
+        id: string;
+    } | null;
+}
+/**
+ * Validates one analytics request and writes it through the store.
+ *
+ * A stored view or click returns status 200 and `{ id }`.
+ * Status 204 and a null body means analytics is disabled, clicks are off, or a duration was recorded.
+ * Status 400 and a null body means the request cannot be stored.
+ * `occurredAt` comes from `deps.now`, otherwise the server clock.
+ * Pass a Fetch `Request`, or `{ body, country, city }`. `request` is read when `body` is omitted.
+ * Country and city are the properties on that object. The JSON body is not a source for them.
+ */
+declare function recordAnalyticsEvent(request: AnalyticsEventRequest | Request, deps: RecordAnalyticsEventDeps): Promise<RecordAnalyticsEventResult>;
+
+export { RequestGeo, readRequestGeo, recordAnalyticsEvent };
+export type { AnalyticsEventRequest, AnalyticsHeaderBag, RecordAnalyticsEventDeps, RecordAnalyticsEventResult };

package/dist/server/index.js

@@ -0,0 +1,9 @@
+import {
+  readRequestGeo,
+  recordAnalyticsEvent
+} from "../chunk-GWOVVKP3.js";
+import "../chunk-F7BY2JQ3.js";
+export {
+  readRequestGeo,
+  recordAnalyticsEvent
+};

package/package.json

@@ -1,6 +1,90 @@
-{
-  "name": "@nodewrite-labs/analytics-sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+{
+  "name": "@nodewrite-labs/analytics-sdk",
+  "version": "0.2.0",
+  "description": "Analytics SDK for page views and named clicks, with Postgres storage and a Payload admin screen.",
+  "publishConfig": {
+    "access": "public"
+  },
+  "packageManager": "pnpm@12.11.2",
+  "engines": {
+    "node": ">=22"
+  },
+  "workspaces": [
+    "playground"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./client": {
+      "types": "./dist/client/index.d.ts",
+      "import": "./dist/client/index.js"
+    },
+    "./server": {
+      "types": "./dist/server/index.d.ts",
+      "import": "./dist/server/index.js"
+    },
+    "./postgres": {
+      "types": "./dist/postgres/index.d.ts",
+      "import": "./dist/postgres/index.js"
+    },
+    "./payload": {
+      "types": "./dist/payload/index.d.ts",
+      "import": "./dist/payload/index.js"
+    },
+    "./payload/admin-view": {
+      "types": "./dist/payload/admin-view.d.ts",
+      "import": "./dist/payload/admin-view.js"
+    },
+    "./payload/nav-link": {
+      "types": "./dist/payload/nav-link.d.ts",
+      "import": "./dist/payload/nav-link.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src/postgres/schema.sql",
+    "README.md"
+  ],
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "build": "tsup"
+  },
+  "peerDependencies": {
+    "@payloadcms/next": "*",
+    "payload": "*",
+    "pg": "*"
+  },
+  "peerDependenciesMeta": {
+    "@payloadcms/next": {
+      "optional": true
+    },
+    "payload": {
+      "optional": true
+    },
+    "pg": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@payloadcms/next": "3.92.0",
+    "@types/node": "^22.20.5",
+    "@types/pg": "^8.23.1",
+    "@types/react": "19.2.14",
+    "esbuild": "^0.28.2",
+    "graphql": "^16.14.2",
+    "jsdom": "^30.1.3",
+    "payload": "3.92.0",
+    "pg": "^8.23.1",
+    "react": "^19.3.1",
+    "tsup": "^9.0.0",
+    "typescript": "6.0.3",
+    "vite": "^8.3.5",
+    "vitest": "^5.0.5"
+  }
+}

package/src/postgres/schema.sql

@@ -0,0 +1,12 @@
+CREATE TABLE IF NOT EXISTS analytics_event (
+  id uuid primary key,
+  kind text not null,
+  path text not null,
+  locale text,
+  occurred_at timestamptz not null,
+  duration_seconds integer,
+  country text,
+  city text,
+  session_id text,
+  event_name text
+);