locallytics 0.1.9 → 0.2.0

package/dist/adapters/drizzle.d.mts

@@ -0,0 +1,25 @@
+/**
+* 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>;
+};
+interface DatabaseAdapter {
+	initialize?(): Promise<void> | void;
+	insertEvent(event: Omit<LocallyticsEvent, "id">): Promise<LocallyticsEvent>;
+	findEvents(): Promise<LocallyticsEvent[]>;
+}
+type DrizzleAdapterConfig = {
+	provider: "sqlite" | "pg" | "mysql";
+};
+/**
+* TODO: Drizzle adapter is planned for a future release.
+*/
+declare function drizzleAdapter(_db: unknown, _config: DrizzleAdapterConfig): DatabaseAdapter;
+export { drizzleAdapter, DrizzleAdapterConfig };

package/dist/adapters/drizzle.d.ts

@@ -0,0 +1,25 @@
+/**
+* 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>;
+};
+interface DatabaseAdapter {
+	initialize?(): Promise<void> | void;
+	insertEvent(event: Omit<LocallyticsEvent, "id">): Promise<LocallyticsEvent>;
+	findEvents(): Promise<LocallyticsEvent[]>;
+}
+type DrizzleAdapterConfig = {
+	provider: "sqlite" | "pg" | "mysql";
+};
+/**
+* TODO: Drizzle adapter is planned for a future release.
+*/
+declare function drizzleAdapter(_db: unknown, _config: DrizzleAdapterConfig): DatabaseAdapter;
+export { drizzleAdapter, DrizzleAdapterConfig };

package/dist/adapters/drizzle.js

@@ -0,0 +1,38 @@
+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/adapters/drizzle.ts
+var exports_drizzle = {};
+__export(exports_drizzle, {
+  drizzleAdapter: () => drizzleAdapter
+});
+module.exports = __toCommonJS(exports_drizzle);
+function drizzleAdapter(_db, _config) {
+  throw new Error("TODO: drizzleAdapter is not implemented yet. This is intentionally deferred in ideals.md.");
+}

package/dist/adapters/drizzle.mjs

@@ -0,0 +1,7 @@
+// src/adapters/drizzle.ts
+function drizzleAdapter(_db, _config) {
+  throw new Error("TODO: drizzleAdapter is not implemented yet. This is intentionally deferred in ideals.md.");
+}
+export {
+  drizzleAdapter
+};

package/dist/adapters/prisma.d.mts

@@ -0,0 +1,25 @@
+/**
+* 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>;
+};
+interface DatabaseAdapter {
+	initialize?(): Promise<void> | void;
+	insertEvent(event: Omit<LocallyticsEvent, "id">): Promise<LocallyticsEvent>;
+	findEvents(): Promise<LocallyticsEvent[]>;
+}
+type PrismaAdapterConfig = {
+	provider: "sqlite" | "postgres" | "mysql";
+};
+/**
+* TODO: Prisma adapter is planned for a future release.
+*/
+declare function prismaAdapter(_prisma: unknown, _config: PrismaAdapterConfig): DatabaseAdapter;
+export { prismaAdapter, PrismaAdapterConfig };

package/dist/adapters/prisma.d.ts

@@ -0,0 +1,25 @@
+/**
+* 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>;
+};
+interface DatabaseAdapter {
+	initialize?(): Promise<void> | void;
+	insertEvent(event: Omit<LocallyticsEvent, "id">): Promise<LocallyticsEvent>;
+	findEvents(): Promise<LocallyticsEvent[]>;
+}
+type PrismaAdapterConfig = {
+	provider: "sqlite" | "postgres" | "mysql";
+};
+/**
+* TODO: Prisma adapter is planned for a future release.
+*/
+declare function prismaAdapter(_prisma: unknown, _config: PrismaAdapterConfig): DatabaseAdapter;
+export { prismaAdapter, PrismaAdapterConfig };

package/dist/adapters/prisma.js

@@ -0,0 +1,38 @@
+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/adapters/prisma.ts
+var exports_prisma = {};
+__export(exports_prisma, {
+  prismaAdapter: () => prismaAdapter
+});
+module.exports = __toCommonJS(exports_prisma);
+function prismaAdapter(_prisma, _config) {
+  throw new Error("TODO: prismaAdapter is not implemented yet. This is intentionally deferred in ideals.md.");
+}

package/dist/adapters/prisma.mjs

@@ -0,0 +1,7 @@
+// src/adapters/prisma.ts
+function prismaAdapter(_prisma, _config) {
+  throw new Error("TODO: prismaAdapter is not implemented yet. This is intentionally deferred in ideals.md.");
+}
+export {
+  prismaAdapter
+};

package/dist/adapters.d.mts

@@ -0,0 +1,7 @@
+/**
+* Adapter roadmap.
+*
+* Per ideals.md, ORM adapters are intentionally TODO for now.
+*/
+declare const adapterTodoList: readonly ["prismaAdapter (TODO)", "drizzleAdapter (TODO)"];
+export { adapterTodoList };

package/dist/adapters.d.ts

@@ -0,0 +1,7 @@
+/**
+* Adapter roadmap.
+*
+* Per ideals.md, ORM adapters are intentionally TODO for now.
+*/
+declare const adapterTodoList: readonly ["prismaAdapter (TODO)", "drizzleAdapter (TODO)"];
+export { adapterTodoList };

package/dist/adapters.js

@@ -0,0 +1,39 @@
+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/adapters.ts
+var exports_adapters = {};
+__export(exports_adapters, {
+  adapterTodoList: () => adapterTodoList
+});
+module.exports = __toCommonJS(exports_adapters);
+var adapterTodoList = [
+  "prismaAdapter (TODO)",
+  "drizzleAdapter (TODO)"
+];

package/dist/adapters.mjs

@@ -0,0 +1,8 @@
+// src/adapters.ts
+var adapterTodoList = [
+  "prismaAdapter (TODO)",
+  "drizzleAdapter (TODO)"
+];
+export {
+  adapterTodoList
+};

package/dist/browser.d.mts

@@ -0,0 +1,41 @@
+/**
+* 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;
+}
+/**
+* Track a page view.
+*/
+declare function trackPageView2(locallytics: Locallytics, route?: string): Promise<void>;
+/**
+* Automatically track clicks.
+*/
+declare function bindClickTracking(locallytics: Locallytics, target?: Window | Document): () => void;
+/**
+* Automatically track page views on SPA navigation.
+*/
+declare function bindPageViewTracking(locallytics: Locallytics): () => void;
+export { trackPageView2 as trackPageView, bindPageViewTracking, bindClickTracking };

package/dist/browser.d.ts

@@ -0,0 +1,41 @@
+/**
+* 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;
+}
+/**
+* Track a page view.
+*/
+declare function trackPageView2(locallytics: Locallytics, route?: string): Promise<void>;
+/**
+* Automatically track clicks.
+*/
+declare function bindClickTracking(locallytics: Locallytics, target?: Window | Document): () => void;
+/**
+* Automatically track page views on SPA navigation.
+*/
+declare function bindPageViewTracking(locallytics: Locallytics): () => void;
+export { trackPageView2 as trackPageView, bindPageViewTracking, bindClickTracking };

package/dist/browser.js

@@ -0,0 +1,79 @@
+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;
+  };
+}

package/dist/browser.mjs

@@ -0,0 +1,10 @@
+import {
+  bindClickTracking,
+  bindPageViewTracking,
+  trackPageView
+} from "./shared/chunk-8tbv1rg5.js";
+export {
+  trackPageView,
+  bindPageViewTracking,
+  bindClickTracking
+};

package/dist/index.d.mts

@@ -0,0 +1,59 @@
+/**
+* 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>;
+};
+interface DatabaseAdapter {
+	initialize?(): Promise<void> | void;
+	insertEvent(event: Omit<LocallyticsEvent, "id">): Promise<LocallyticsEvent>;
+	findEvents(): Promise<LocallyticsEvent[]>;
+}
+type PostgresLikeDatabase = {
+	query: (sql: string, params?: unknown[]) => Promise<{
+		rows: Record<string, unknown>[];
+	}>;
+};
+type MysqlLikeDatabase = {
+	execute: (sql: string, params?: unknown[]) => Promise<[unknown, unknown]>;
+};
+type SqliteLikeStatement = {
+	run: (...params: unknown[]) => {
+		lastInsertRowid?: number | bigint;
+	};
+	all: (...params: unknown[]) => Record<string, unknown>[];
+	get?: (...params: unknown[]) => Record<string, unknown> | undefined;
+};
+type SqliteLikeDatabase = {
+	prepare: (sql: string) => SqliteLikeStatement;
+};
+type SupportedDatabase = DatabaseAdapter | PostgresLikeDatabase | MysqlLikeDatabase | SqliteLikeDatabase;
+type LocallyticsConfig = {
+	database: SupportedDatabase;
+	sessionTracking?: boolean;
+	userId?: string;
+};
+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;
+}
+declare function createLocallytics(config: LocallyticsConfig): Locallytics;
+export { createLocallytics, SupportedDatabase, SqliteLikeStatement, SqliteLikeDatabase, QueryResult, PostgresLikeDatabase, MysqlLikeDatabase, LocallyticsEvent, LocallyticsConfig, Locallytics, DatabaseAdapter, ClientQueryResult };

package/dist/index.d.ts

@@ -1,6 +1,59 @@
-export { LocallyticsGrabber } from "./client/LocallyticsGrabber.js";
-export { createDatabase } from "./db/factory.js";
-export { LocallyticsData, locallytics } from "./server/index.js";
-export type { AnalyticsDataOptions, AnalyticsDB, AnalyticsResult, DailyStats, DateRange, LocallyticsConfig, PageStats, PageviewEvent, } from "./types/index.js";
-export { LocallyticsError } from "./types/index.js";
-//# sourceMappingURL=index.d.ts.map
+/**
+* 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>;
+};
+interface DatabaseAdapter {
+	initialize?(): Promise<void> | void;
+	insertEvent(event: Omit<LocallyticsEvent, "id">): Promise<LocallyticsEvent>;
+	findEvents(): Promise<LocallyticsEvent[]>;
+}
+type PostgresLikeDatabase = {
+	query: (sql: string, params?: unknown[]) => Promise<{
+		rows: Record<string, unknown>[];
+	}>;
+};
+type MysqlLikeDatabase = {
+	execute: (sql: string, params?: unknown[]) => Promise<[unknown, unknown]>;
+};
+type SqliteLikeStatement = {
+	run: (...params: unknown[]) => {
+		lastInsertRowid?: number | bigint;
+	};
+	all: (...params: unknown[]) => Record<string, unknown>[];
+	get?: (...params: unknown[]) => Record<string, unknown> | undefined;
+};
+type SqliteLikeDatabase = {
+	prepare: (sql: string) => SqliteLikeStatement;
+};
+type SupportedDatabase = DatabaseAdapter | PostgresLikeDatabase | MysqlLikeDatabase | SqliteLikeDatabase;
+type LocallyticsConfig = {
+	database: SupportedDatabase;
+	sessionTracking?: boolean;
+	userId?: string;
+};
+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;
+}
+declare function createLocallytics(config: LocallyticsConfig): Locallytics;
+export { createLocallytics, SupportedDatabase, SqliteLikeStatement, SqliteLikeDatabase, QueryResult, PostgresLikeDatabase, MysqlLikeDatabase, LocallyticsEvent, LocallyticsConfig, Locallytics, DatabaseAdapter, ClientQueryResult };