locallytics 0.1.8 → 0.2.0

package/dist/react.d.mts

@@ -0,0 +1,48 @@
+/**
+* Locallytics - Analytics built around a database-first API.
+* @packageDocumentation
+*/
+type LocallyticsEvent = {
+	id?: string | number;
+	type: string;
+	timestamp: number;
+	sessionId?: string;
+	userId?: string;
+	metadata?: Record<string, unknown>;
+};
+type ClientQueryResult = {
+	events: LocallyticsEvent[];
+	loading: boolean;
+	error: Error | null;
+	refresh: () => Promise<LocallyticsEvent[]>;
+};
+type QueryResult = ClientQueryResult & PromiseLike<LocallyticsEvent[]>;
+interface Locallytics {
+	track(type: string, metadata?: Record<string, unknown>): Promise<LocallyticsEvent>;
+	trackPageView(route?: string): Promise<LocallyticsEvent>;
+	query(): QueryResult;
+	setUserId(userId: string | undefined): void;
+	getUserId(): string | undefined;
+	getSessionId(): string | undefined;
+	subscribe(listener: () => void): () => void;
+}
+import { ReactElement, ReactNode } from "react";
+type LocallyticsProviderProps = {
+	instance: Locallytics;
+	children: ReactNode;
+};
+/**
+* Client boundary for Locallytics context.
+* Keep this component small so server-rendered children can stay server components.
+*/
+declare function LocallyticsProvider({ instance, children }: LocallyticsProviderProps): ReactElement;
+declare function useLocallytics(): Locallytics;
+type LocallyticsGrabberProps = {
+	trackClicks?: boolean;
+	trackPageViews?: boolean;
+};
+/**
+* Automatically tracks page views and clicks.
+*/
+declare function LocallyticsGrabber({ trackClicks, trackPageViews }?: LocallyticsGrabberProps): null;
+export { useLocallytics, LocallyticsProviderProps, LocallyticsProvider, LocallyticsGrabberProps, LocallyticsGrabber };

package/dist/react.d.ts

@@ -0,0 +1,48 @@
+/**
+* Locallytics - Analytics built around a database-first API.
+* @packageDocumentation
+*/
+type LocallyticsEvent = {
+	id?: string | number;
+	type: string;
+	timestamp: number;
+	sessionId?: string;
+	userId?: string;
+	metadata?: Record<string, unknown>;
+};
+type ClientQueryResult = {
+	events: LocallyticsEvent[];
+	loading: boolean;
+	error: Error | null;
+	refresh: () => Promise<LocallyticsEvent[]>;
+};
+type QueryResult = ClientQueryResult & PromiseLike<LocallyticsEvent[]>;
+interface Locallytics {
+	track(type: string, metadata?: Record<string, unknown>): Promise<LocallyticsEvent>;
+	trackPageView(route?: string): Promise<LocallyticsEvent>;
+	query(): QueryResult;
+	setUserId(userId: string | undefined): void;
+	getUserId(): string | undefined;
+	getSessionId(): string | undefined;
+	subscribe(listener: () => void): () => void;
+}
+import { ReactElement, ReactNode } from "react";
+type LocallyticsProviderProps = {
+	instance: Locallytics;
+	children: ReactNode;
+};
+/**
+* Client boundary for Locallytics context.
+* Keep this component small so server-rendered children can stay server components.
+*/
+declare function LocallyticsProvider({ instance, children }: LocallyticsProviderProps): ReactElement;
+declare function useLocallytics(): Locallytics;
+type LocallyticsGrabberProps = {
+	trackClicks?: boolean;
+	trackPageViews?: boolean;
+};
+/**
+* Automatically tracks page views and clicks.
+*/
+declare function LocallyticsGrabber({ trackClicks, trackPageViews }?: LocallyticsGrabberProps): null;
+export { useLocallytics, LocallyticsProviderProps, LocallyticsProvider, LocallyticsGrabberProps, LocallyticsGrabber };

package/dist/react.js

@@ -0,0 +1,132 @@
+"use client";
+var import_node_module = require("node:module");
+var __defProp = Object.defineProperty;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __moduleCache = /* @__PURE__ */ new WeakMap;
+var __toCommonJS = (from) => {
+  var entry = __moduleCache.get(from), desc;
+  if (entry)
+    return entry;
+  entry = __defProp({}, "__esModule", { value: true });
+  if (from && typeof from === "object" || typeof from === "function")
+    __getOwnPropNames(from).map((key) => !__hasOwnProp.call(entry, key) && __defProp(entry, key, {
+      get: () => from[key],
+      enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+    }));
+  __moduleCache.set(from, entry);
+  return entry;
+};
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, {
+      get: all[name],
+      enumerable: true,
+      configurable: true,
+      set: (newValue) => all[name] = () => newValue
+    });
+};
+
+// src/browser.ts
+var exports_browser = {};
+__export(exports_browser, {
+  trackPageView: () => trackPageView,
+  bindPageViewTracking: () => bindPageViewTracking,
+  bindClickTracking: () => bindClickTracking
+});
+module.exports = __toCommonJS(exports_browser);
+function trackPageView(locallytics, route) {
+  return locallytics.trackPageView(route).then(() => {
+    return;
+  });
+}
+function bindClickTracking(locallytics, target = window) {
+  const handler = (event) => {
+    const element = event.target;
+    locallytics.track("click", {
+      tag: element?.tagName,
+      id: element?.id,
+      classes: element?.className,
+      text: element?.textContent?.trim().slice(0, 100)
+    });
+  };
+  target.addEventListener("click", handler);
+  return () => {
+    target.removeEventListener("click", handler);
+  };
+}
+function bindPageViewTracking(locallytics) {
+  trackPageView(locallytics);
+  const popstateHandler = () => {
+    trackPageView(locallytics);
+  };
+  const originalPushState = history.pushState;
+  const originalReplaceState = history.replaceState;
+  history.pushState = function(...args) {
+    originalPushState.apply(this, args);
+    trackPageView(locallytics);
+  };
+  history.replaceState = function(...args) {
+    originalReplaceState.apply(this, args);
+    trackPageView(locallytics);
+  };
+  window.addEventListener("popstate", popstateHandler);
+  return () => {
+    window.removeEventListener("popstate", popstateHandler);
+    history.pushState = originalPushState;
+    history.replaceState = originalReplaceState;
+  };
+}
+
+// src/react.tsx
+var exports_react = {};
+__export(exports_react, {
+  useLocallytics: () => useLocallytics,
+  LocallyticsProvider: () => LocallyticsProvider,
+  LocallyticsGrabber: () => LocallyticsGrabber
+});
+module.exports = __toCommonJS(exports_react);
+var import_react = require("react");
+
+var LocallyticsContext = import_react.createContext(null);
+function LocallyticsProvider({
+  instance,
+  children
+}) {
+  const [, setVersion] = import_react.useState(0);
+  import_react.useEffect(() => {
+    return instance.subscribe(() => {
+      setVersion((value) => value + 1);
+    });
+  }, [instance]);
+  return import_react.createElement(LocallyticsContext.Provider, { value: instance }, children);
+}
+function useLocallytics() {
+  const instance = import_react.useContext(LocallyticsContext);
+  if (!instance) {
+    throw new Error("useLocallytics must be used within a LocallyticsProvider");
+  }
+  return instance;
+}
+function LocallyticsGrabber({
+  trackClicks = true,
+  trackPageViews = true
+} = {}) {
+  const locallytics = useLocallytics();
+  import_react.useEffect(() => {
+    const cleanups = [];
+    if (trackPageViews) {
+      cleanups.push(bindPageViewTracking(locallytics));
+    }
+    if (trackClicks) {
+      cleanups.push(bindClickTracking(locallytics, window));
+    }
+    return () => {
+      for (const cleanup of cleanups) {
+        cleanup();
+      }
+    };
+  }, [locallytics, trackClicks, trackPageViews]);
+  return null;
+}

package/dist/react.mjs

@@ -0,0 +1,61 @@
+"use client";
+import {
+  bindClickTracking,
+  bindPageViewTracking
+} from "./shared/chunk-8tbv1rg5.js";
+
+// src/react.tsx
+import {
+  createElement,
+  createContext,
+  useContext,
+  useEffect,
+  useState
+} from "react";
+
+var LocallyticsContext = createContext(null);
+function LocallyticsProvider({
+  instance,
+  children
+}) {
+  const [, setVersion] = useState(0);
+  useEffect(() => {
+    return instance.subscribe(() => {
+      setVersion((value) => value + 1);
+    });
+  }, [instance]);
+  return createElement(LocallyticsContext.Provider, { value: instance }, children);
+}
+function useLocallytics() {
+  const instance = useContext(LocallyticsContext);
+  if (!instance) {
+    throw new Error("useLocallytics must be used within a LocallyticsProvider");
+  }
+  return instance;
+}
+function LocallyticsGrabber({
+  trackClicks = true,
+  trackPageViews = true
+} = {}) {
+  const locallytics = useLocallytics();
+  useEffect(() => {
+    const cleanups = [];
+    if (trackPageViews) {
+      cleanups.push(bindPageViewTracking(locallytics));
+    }
+    if (trackClicks) {
+      cleanups.push(bindClickTracking(locallytics, window));
+    }
+    return () => {
+      for (const cleanup of cleanups) {
+        cleanup();
+      }
+    };
+  }, [locallytics, trackClicks, trackPageViews]);
+  return null;
+}
+export {
+  useLocallytics,
+  LocallyticsProvider,
+  LocallyticsGrabber
+};

package/dist/shared/chunk-8tbv1rg5.js

@@ -0,0 +1,45 @@
+// src/browser.ts
+function trackPageView(locallytics, route) {
+  return locallytics.trackPageView(route).then(() => {
+    return;
+  });
+}
+function bindClickTracking(locallytics, target = window) {
+  const handler = (event) => {
+    const element = event.target;
+    locallytics.track("click", {
+      tag: element?.tagName,
+      id: element?.id,
+      classes: element?.className,
+      text: element?.textContent?.trim().slice(0, 100)
+    });
+  };
+  target.addEventListener("click", handler);
+  return () => {
+    target.removeEventListener("click", handler);
+  };
+}
+function bindPageViewTracking(locallytics) {
+  trackPageView(locallytics);
+  const popstateHandler = () => {
+    trackPageView(locallytics);
+  };
+  const originalPushState = history.pushState;
+  const originalReplaceState = history.replaceState;
+  history.pushState = function(...args) {
+    originalPushState.apply(this, args);
+    trackPageView(locallytics);
+  };
+  history.replaceState = function(...args) {
+    originalReplaceState.apply(this, args);
+    trackPageView(locallytics);
+  };
+  window.addEventListener("popstate", popstateHandler);
+  return () => {
+    window.removeEventListener("popstate", popstateHandler);
+    history.pushState = originalPushState;
+    history.replaceState = originalReplaceState;
+  };
+}
+
+export { trackPageView, bindClickTracking, bindPageViewTracking };

package/package.json

@@ -1,70 +1,82 @@
 {
   "name": "locallytics",
-  "version": "0.1.8",
-  "description": "Self-hosted, privacy-first analytics SDK for Next.js",
-  "type": "module",
+  "version": "0.2.0",
+  "description": "Simple analytics that lives with your app.",
+  "keywords": [
+    "analytics",
+    "kysely",
+    "postgres",
+    "sqlite",
+    "mysql",
+    "react",
+    "nextjs"
+  ],
+  "author": "Aidan McAlister",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aidankmcalister/locallytics.git"
+  },
+  "homepage": "https://github.com/aidankmcalister/locallytics#readme",
+  "bugs": {
+    "url": "https://github.com/aidankmcalister/locallytics/issues"
+  },
   "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "default": "./dist/index.js"
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./adapters": {
+      "import": "./dist/adapters.mjs",
+      "require": "./dist/adapters.js",
+      "types": "./dist/adapters.d.ts"
+    },
+    "./adapters/prisma": {
+      "import": "./dist/adapters/prisma.mjs",
+      "require": "./dist/adapters/prisma.js",
+      "types": "./dist/adapters/prisma.d.ts"
     },
-    "./schema.sql": "./src/db/schema.sql",
-    "./schema-sqlite.sql": "./src/db/schema-sqlite.sql",
-    "./schema-mysql.sql": "./src/db/schema-mysql.sql"
+    "./adapters/drizzle": {
+      "import": "./dist/adapters/drizzle.mjs",
+      "require": "./dist/adapters/drizzle.js",
+      "types": "./dist/adapters/drizzle.d.ts"
+    },
+    "./browser": {
+      "import": "./dist/browser.mjs",
+      "require": "./dist/browser.js",
+      "types": "./dist/browser.d.ts"
+    },
+    "./react": {
+      "import": "./dist/react.mjs",
+      "require": "./dist/react.js",
+      "types": "./dist/react.d.ts"
+    }
   },
   "files": [
     "dist",
-    "src/db/schema.sql",
-    "src/db/schema-sqlite.sql",
-    "src/db/schema-mysql.sql"
+    "README.md"
   ],
-  "scripts": {
-    "build": "tsc",
-    "dev": "tsc --watch",
-    "typecheck": "tsc --noEmit",
-    "test": "vitest",
-    "prepublishOnly": "npm run build"
-  },
-  "keywords": [
-    "analytics",
-    "privacy",
-    "nextjs",
-    "postgresql",
-    "mysql",
-    "sqlite",
-    "self-hosted"
-  ],
-  "author": "",
-  "license": "MIT",
-  "dependencies": {
-    "pg": "^8.11.3"
-  },
   "peerDependencies": {
-    "next": ">=13.0.0",
     "react": ">=18.0.0"
   },
   "peerDependenciesMeta": {
-    "better-sqlite3": {
-      "optional": true
-    },
-    "mysql2": {
+    "react": {
       "optional": true
     }
   },
-  "optionalDependencies": {
-    "better-sqlite3": "^11.0.0",
-    "mysql2": "^3.9.0"
+  "scripts": {
+    "build": "bunup",
+    "dev": "bunup --watch",
+    "typecheck": "tsc --noEmit"
   },
   "devDependencies": {
-    "@types/better-sqlite3": "^7.6.8",
-    "@types/node": "^20.10.0",
-    "@types/pg": "^8.10.9",
-    "@types/react": "^18.2.0",
-    "mysql2": "^3.16.1",
-    "typescript": "^5.3.0",
-    "vitest": "^1.1.0"
+    "@types/react": "^19.0.0",
+    "bunup": "^0.16.26",
+    "react": "^19.0.0",
+    "typescript": "^5.9.3"
   }
 }

package/README.md

@@ -1,73 +0,0 @@
-# Locallytics
-
-Self-hosted, privacy-first analytics SDK for Next.js.
-
-## Installation
-
-```bash
-npm install locallytics
-```
-
-## Quick Start
-
-### 1. Setup Database
-
-Use our CLI to set up your PostgreSQL database automatically:
-
-```bash
-npx locallytics-cli migrate
-```
-
-### 2. Add API Route
-
-```typescript
-// app/api/analytics/route.ts
-import { locallytics } from "locallytics";
-
-const analytics = await locallytics({
-  database: process.env.DATABASE_URL!,
-});
-
-export const { GET, POST } = analytics;
-```
-
-### 3. Add Tracker
-
-```tsx
-// app/layout.tsx
-import { LocallyticsGrabber } from "locallytics";
-
-export default function RootLayout({ children }) {
-  return (
-    <html>
-      <body>
-        {children}
-        <LocallyticsGrabber />
-      </body>
-    </html>
-  );
-}
-```
-
-### 4. Fetch Data
-
-```tsx
-// app/page.tsx
-import { LocallyticsData } from "locallytics";
-
-export default async function Home() {
-  const data = await LocallyticsData(); // Simple! No arguments.
-
-  return <pre>{JSON.stringify(data, null, 2)}</pre>;
-}
-```
-
-## Features
-
-- **Privacy**: No cookies, hashed IPs, supports Do Not Track.
-- **Simplicity**: Zero-config data fetching.
-- **Speed**: Lightweight (< 5KB) and fast.
-
-## License
-
-MIT

package/dist/client/LocallyticsGrabber.d.ts

@@ -1,30 +0,0 @@
-interface LocallyticsGrabberProps {
-    /** API endpoint URL (defaults to /api/analytics) */
-    endpoint?: string;
-    /** Interval in ms to batch events before sending (defaults to 30000) */
-    trackInterval?: number;
-}
-/**
- * React component for tracking pageviews
- * Drop this into your layout to automatically track pageviews
- *
- * @example
- * ```tsx
- * // app/layout.tsx
- * import { LocallyticsGrabber } from 'locallytics';
- *
- * export default function RootLayout({ children }) {
- *   return (
- *     <html>
- *       <body>
- *         {children}
- *         <LocallyticsGrabber maxLength={5} trackInterval={5000} />
- *       </body>
- *     </html>
- *   );
- * }
- * ```
- */
-export declare function LocallyticsGrabber({ endpoint, trackInterval, }: LocallyticsGrabberProps): null;
-export {};
-//# sourceMappingURL=LocallyticsGrabber.d.ts.map

package/dist/client/LocallyticsGrabber.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"LocallyticsGrabber.d.ts","sourceRoot":"","sources":["../../src/client/LocallyticsGrabber.tsx"],"names":[],"mappings":"AAKA,UAAU,uBAAuB;IAC/B,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wEAAwE;IACxE,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,kBAAkB,CAAC,EACjC,QAA2B,EAC3B,aAAa,GACd,EAAE,uBAAuB,GAAG,IAAI,CAuDhC"}

package/dist/client/LocallyticsGrabber.js

@@ -1,71 +0,0 @@
-"use client";
-import { useEffect, useRef } from "react";
-import { Tracker } from "./tracker.js";
-/**
- * React component for tracking pageviews
- * Drop this into your layout to automatically track pageviews
- *
- * @example
- * ```tsx
- * // app/layout.tsx
- * import { LocallyticsGrabber } from 'locallytics';
- *
- * export default function RootLayout({ children }) {
- *   return (
- *     <html>
- *       <body>
- *         {children}
- *         <LocallyticsGrabber maxLength={5} trackInterval={5000} />
- *       </body>
- *     </html>
- *   );
- * }
- * ```
- */
-export function LocallyticsGrabber({ endpoint = "/api/analytics", trackInterval, }) {
-    const trackerRef = useRef(null);
-    const lastPathRef = useRef("");
-    useEffect(() => {
-        // Initialize tracker
-        const tracker = new Tracker(endpoint, trackInterval);
-        trackerRef.current = tracker;
-        // Track initial pageview
-        tracker.trackPageview();
-        lastPathRef.current = window.location.pathname;
-        // Handle browser back/forward navigation
-        const handlePopstate = () => {
-            if (window.location.pathname !== lastPathRef.current) {
-                lastPathRef.current = window.location.pathname;
-                tracker.trackPageview();
-            }
-        };
-        window.addEventListener("popstate", handlePopstate);
-        // Handle client-side navigation (Next.js App Router)
-        // Use MutationObserver to detect URL changes
-        let observer = null;
-        const checkForNavigation = () => {
-            if (window.location.pathname !== lastPathRef.current) {
-                lastPathRef.current = window.location.pathname;
-                tracker.trackPageview();
-            }
-        };
-        // Observe changes to the document that might indicate navigation
-        observer = new MutationObserver(() => {
-            // Use requestAnimationFrame to batch checks
-            requestAnimationFrame(checkForNavigation);
-        });
-        observer.observe(document, {
-            subtree: true,
-            childList: true,
-        });
-        // Cleanup
-        return () => {
-            window.removeEventListener("popstate", handlePopstate);
-            observer?.disconnect();
-            tracker.destroy();
-        };
-    }, [endpoint, trackInterval]);
-    // This component renders nothing
-    return null;
-}
-//# sourceMappingURL=LocallyticsGrabber.js.map

package/dist/client/LocallyticsGrabber.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"LocallyticsGrabber.js","sourceRoot":"","sources":["../../src/client/LocallyticsGrabber.tsx"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AASvC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,kBAAkB,CAAC,EACjC,QAAQ,GAAG,gBAAgB,EAC3B,aAAa,GACW;IACxB,MAAM,UAAU,GAAG,MAAM,CAAiB,IAAI,CAAC,CAAC;IAChD,MAAM,WAAW,GAAG,MAAM,CAAS,EAAE,CAAC,CAAC;IAEvC,SAAS,CAAC,GAAG,EAAE;QACb,qBAAqB;QACrB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QACrD,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC;QAE7B,yBAAyB;QACzB,OAAO,CAAC,aAAa,EAAE,CAAC;QACxB,WAAW,CAAC,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAE/C,yCAAyC;QACzC,MAAM,cAAc,GAAG,GAAS,EAAE;YAChC,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,KAAK,WAAW,CAAC,OAAO,EAAE,CAAC;gBACrD,WAAW,CAAC,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBAC/C,OAAO,CAAC,aAAa,EAAE,CAAC;YAC1B,CAAC;QACH,CAAC,CAAC;QAEF,MAAM,CAAC,gBAAgB,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;QAEpD,qDAAqD;QACrD,6CAA6C;QAC7C,IAAI,QAAQ,GAA4B,IAAI,CAAC;QAE7C,MAAM,kBAAkB,GAAG,GAAS,EAAE;YACpC,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,KAAK,WAAW,CAAC,OAAO,EAAE,CAAC;gBACrD,WAAW,CAAC,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBAC/C,OAAO,CAAC,aAAa,EAAE,CAAC;YAC1B,CAAC;QACH,CAAC,CAAC;QAEF,iEAAiE;QACjE,QAAQ,GAAG,IAAI,gBAAgB,CAAC,GAAG,EAAE;YACnC,4CAA4C;YAC5C,qBAAqB,CAAC,kBAAkB,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE;YACzB,OAAO,EAAE,IAAI;YACb,SAAS,EAAE,IAAI;SAChB,CAAC,CAAC;QAEH,UAAU;QACV,OAAO,GAAG,EAAE;YACV,MAAM,CAAC,mBAAmB,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;YACvD,QAAQ,EAAE,UAAU,EAAE,CAAC;YACvB,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC;IAE9B,iCAAiC;IACjC,OAAO,IAAI,CAAC;AACd,CAAC"}