@summalytics/js 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,58 @@
+# @summalytics/js
+
+Privacy-first analytics SDK for JavaScript and TypeScript. Works in any browser environment — no cookies, no PII.
+
+## Install
+
+```bash
+npm install @summalytics/js
+```
+
+## Usage
+
+```ts
+import { createSummalytics } from '@summalytics/js'
+
+const analytics = createSummalytics({
+  writeKey: 'YOUR_WRITE_KEY',
+  // endpoint defaults to https://summalytics.ai/api/ingest
+})
+
+// Track a custom event
+analytics.track('signup_completed', { value: 1 })
+
+// Track a pageview manually
+analytics.pageview({ path: '/pricing' })
+```
+
+By default, one pageview is fired automatically on `createSummalytics()` in browser environments. Disable it with `autoPageview: false`.
+
+```ts
+const analytics = createSummalytics({
+  writeKey: 'YOUR_WRITE_KEY',
+  autoPageview: false,
+})
+```
+
+## Config
+
+| Option | Type | Default | Description |
+|---|---|---|---|
+| `writeKey` | `string` | required | Your project write key |
+| `endpoint` | `string` | `https://summalytics.ai/api/ingest` | Ingest endpoint |
+| `autoPageview` | `boolean` | `true` | Fire a pageview on init |
+
+## Self-hosting
+
+If you run your own Summalytics instance, pass your endpoint:
+
+```ts
+const analytics = createSummalytics({
+  writeKey: 'YOUR_WRITE_KEY',
+  endpoint: 'https://yourapp.com/api/ingest',
+})
+```
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,113 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  createSummalytics: () => createSummalytics
+});
+module.exports = __toCommonJS(index_exports);
+var DEFAULT_ENDPOINT = "https://summalytics.ai/api/ingest";
+function createSessionId() {
+  if (typeof crypto !== "undefined" && crypto.randomUUID) {
+    return crypto.randomUUID();
+  }
+  return `session_${Math.random().toString(36).slice(2)}`;
+}
+function createRequestId() {
+  if (typeof crypto !== "undefined" && crypto.randomUUID) {
+    return crypto.randomUUID();
+  }
+  return `req_${Math.random().toString(36).slice(2)}`;
+}
+function createSummalytics(config) {
+  var _a;
+  const sessionId = createSessionId();
+  const endpoint = (_a = config.endpoint) != null ? _a : DEFAULT_ENDPOINT;
+  const send = async (payload) => {
+    const body = JSON.stringify(payload);
+    if (typeof navigator !== "undefined" && navigator.sendBeacon) {
+      const beaconUrl = `${endpoint}${endpoint.includes("?") ? "&" : "?"}key=${encodeURIComponent(config.writeKey)}`;
+      const blob = new Blob([body], { type: "application/json" });
+      const accepted = navigator.sendBeacon(beaconUrl, blob);
+      if (accepted) {
+        return;
+      }
+    }
+    await fetch(endpoint, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        "x-summalytics-key": config.writeKey
+      },
+      body,
+      keepalive: true
+    });
+  };
+  const track = async (eventName, payload = {}) => {
+    var _a2, _b;
+    await send({
+      requestId: (_a2 = payload.requestId) != null ? _a2 : createRequestId(),
+      eventName,
+      timestamp: payload.timestamp,
+      path: payload.path,
+      referrer: payload.referrer,
+      sessionId: (_b = payload.sessionId) != null ? _b : sessionId,
+      value: payload.value,
+      properties: payload.properties
+    });
+  };
+  const pageview = async (payload = {}) => {
+    var _a2, _b;
+    const path = (_a2 = payload.path) != null ? _a2 : typeof window !== "undefined" ? window.location.pathname : "/";
+    const referrer = (_b = payload.referrer) != null ? _b : typeof document !== "undefined" ? document.referrer : "";
+    await track("pageview", __spreadProps(__spreadValues({}, payload), {
+      path,
+      referrer
+    }));
+  };
+  if (config.autoPageview !== false && typeof window !== "undefined") {
+    void pageview();
+  }
+  return {
+    track,
+    pageview
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createSummalytics
+});

package/dist/index.d.cts

@@ -0,0 +1,20 @@
+interface SummalyticsConfig {
+    endpoint?: string;
+    writeKey: string;
+    autoPageview?: boolean;
+}
+interface TrackPayload {
+    value?: number;
+    properties?: Record<string, unknown>;
+    timestamp?: string;
+    path?: string;
+    referrer?: string;
+    sessionId?: string;
+    requestId?: string;
+}
+declare function createSummalytics(config: SummalyticsConfig): {
+    track: (eventName: string, payload?: TrackPayload) => Promise<void>;
+    pageview: (payload?: Omit<TrackPayload, "value">) => Promise<void>;
+};
+
+export { type SummalyticsConfig, type TrackPayload, createSummalytics };

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+interface SummalyticsConfig {
+    endpoint?: string;
+    writeKey: string;
+    autoPageview?: boolean;
+}
+interface TrackPayload {
+    value?: number;
+    properties?: Record<string, unknown>;
+    timestamp?: string;
+    path?: string;
+    referrer?: string;
+    sessionId?: string;
+    requestId?: string;
+}
+declare function createSummalytics(config: SummalyticsConfig): {
+    track: (eventName: string, payload?: TrackPayload) => Promise<void>;
+    pageview: (payload?: Omit<TrackPayload, "value">) => Promise<void>;
+};
+
+export { type SummalyticsConfig, type TrackPayload, createSummalytics };

package/dist/index.js

@@ -1,75 +1,91 @@
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+
+// src/index.ts
+var DEFAULT_ENDPOINT = "https://summalytics.ai/api/ingest";
 function createSessionId() {
-  if (typeof crypto !== 'undefined' && crypto.randomUUID) {
-    return crypto.randomUUID()
+  if (typeof crypto !== "undefined" && crypto.randomUUID) {
+    return crypto.randomUUID();
   }
-
-  return `session_${Math.random().toString(36).slice(2)}`
+  return `session_${Math.random().toString(36).slice(2)}`;
 }
-
 function createRequestId() {
-  if (typeof crypto !== 'undefined' && crypto.randomUUID) {
-    return crypto.randomUUID()
+  if (typeof crypto !== "undefined" && crypto.randomUUID) {
+    return crypto.randomUUID();
   }
-
-  return `req_${Math.random().toString(36).slice(2)}`
+  return `req_${Math.random().toString(36).slice(2)}`;
 }
-
-export function createSummalytics(config) {
-  const sessionId = createSessionId()
-
+function createSummalytics(config) {
+  var _a;
+  const sessionId = createSessionId();
+  const endpoint = (_a = config.endpoint) != null ? _a : DEFAULT_ENDPOINT;
   const send = async (payload) => {
-    const body = JSON.stringify(payload)
-
-    if (typeof navigator !== 'undefined' && navigator.sendBeacon) {
-      const beaconUrl = `${config.endpoint}${config.endpoint.includes('?') ? '&' : '?'}key=${encodeURIComponent(config.writeKey)}`
-      const blob = new Blob([body], { type: 'application/json' })
-      const accepted = navigator.sendBeacon(beaconUrl, blob)
+    const body = JSON.stringify(payload);
+    if (typeof navigator !== "undefined" && navigator.sendBeacon) {
+      const beaconUrl = `${endpoint}${endpoint.includes("?") ? "&" : "?"}key=${encodeURIComponent(config.writeKey)}`;
+      const blob = new Blob([body], { type: "application/json" });
+      const accepted = navigator.sendBeacon(beaconUrl, blob);
       if (accepted) {
-        return
+        return;
       }
     }
-
-    await fetch(config.endpoint, {
-      method: 'POST',
+    await fetch(endpoint, {
+      method: "POST",
       headers: {
-        'Content-Type': 'application/json',
-        'x-summalytics-key': config.writeKey,
+        "Content-Type": "application/json",
+        "x-summalytics-key": config.writeKey
       },
       body,
-      keepalive: true,
-    })
-  }
-
+      keepalive: true
+    });
+  };
   const track = async (eventName, payload = {}) => {
+    var _a2, _b;
     await send({
-      requestId: payload.requestId ?? createRequestId(),
+      requestId: (_a2 = payload.requestId) != null ? _a2 : createRequestId(),
       eventName,
       timestamp: payload.timestamp,
       path: payload.path,
       referrer: payload.referrer,
-      sessionId: payload.sessionId ?? sessionId,
+      sessionId: (_b = payload.sessionId) != null ? _b : sessionId,
       value: payload.value,
-      properties: payload.properties,
-    })
-  }
-
+      properties: payload.properties
+    });
+  };
   const pageview = async (payload = {}) => {
-    const path = payload.path ?? (typeof window !== 'undefined' ? window.location.pathname : '/')
-    const referrer = payload.referrer ?? (typeof document !== 'undefined' ? document.referrer : '')
-
-    await track('pageview', {
-      ...payload,
+    var _a2, _b;
+    const path = (_a2 = payload.path) != null ? _a2 : typeof window !== "undefined" ? window.location.pathname : "/";
+    const referrer = (_b = payload.referrer) != null ? _b : typeof document !== "undefined" ? document.referrer : "";
+    await track("pageview", __spreadProps(__spreadValues({}, payload), {
       path,
-      referrer,
-    })
+      referrer
+    }));
+  };
+  if (config.autoPageview !== false && typeof window !== "undefined") {
+    void pageview();
   }
-
-  if (config.autoPageview !== false && typeof window !== 'undefined') {
-    void pageview()
-  }
-
   return {
     track,
-    pageview,
-  }
+    pageview
+  };
 }
+export {
+  createSummalytics
+};

package/package.json

@@ -1,16 +1,28 @@
 {
   "name": "@summalytics/js",
-  "version": "0.1.0",
+  "version": "0.1.1",
+  "description": "Privacy-first analytics SDK for JavaScript and TypeScript",
+  "license": "MIT",
   "type": "module",
-  "main": "dist/index.js",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
   "exports": {
-    ".": "./dist/index.js"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
   },
   "publishConfig": {
     "access": "public"
   },
   "files": [
     "dist",
-    "src"
-  ]
+    "src",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsup"
+  }
 }