pgp-sdk 0.1.0 → 0.1.1

package/README.md

@@ -4,7 +4,9 @@ Isomorphic (Node.js + browser) event ingestion SDK for the PGP platform.
 
 ## Install
 
-Copy/`npm pack` from this directory (internal package, not on npm).
+```bash
+npm i pgp-sdk
+```
 
 ## Node.js
 
@@ -22,10 +24,20 @@ await pgp.close(); // flush on shutdown
 
 ## Browser
 
+With a bundler (vite/webpack), identical to Node:
+
+```ts
+import { PgpClient } from "pgp-sdk";
+const pgp = new PgpClient({ apiKey: "pgp_..." });
+pgp.capture("page_view");
+```
+
+No bundler — script tag via CDN, exposes a `PgpSDK` global:
+
 ```html
-<script type="module">
-  import { PgpClient } from "./node_modules/pgp-sdk/dist/index.js";
-  const pgp = new PgpClient({ apiKey: "pgp_..." });
+<script src="https://unpkg.com/pgp-sdk/dist/index.global.js"></script>
+<script>
+  const pgp = new PgpSDK.PgpClient({ apiKey: "pgp_..." });
   pgp.capture("page_view");
 </script>
 ```

package/dist/index.global.js

@@ -0,0 +1,131 @@
+"use strict";
+var PgpSDK = (() => {
+  var __defProp = Object.defineProperty;
+  var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+  var __getOwnPropNames = Object.getOwnPropertyNames;
+  var __hasOwnProp = Object.prototype.hasOwnProperty;
+  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, {
+    PgpClient: () => PgpClient,
+    createClient: () => createClient,
+    default: () => index_default
+  });
+  var ANON_KEY = "pgp_anon_id";
+  function uuid() {
+    return typeof crypto !== "undefined" && "randomUUID" in crypto ? crypto.randomUUID() : `${Date.now().toString(36)}-${Math.random().toString(36).slice(2)}`;
+  }
+  function anonId() {
+    try {
+      let id = localStorage.getItem(ANON_KEY);
+      if (!id) {
+        id = uuid();
+        localStorage.setItem(ANON_KEY, id);
+      }
+      return id;
+    } catch {
+      return uuid();
+    }
+  }
+  var PgpClient = class {
+    #opts;
+    #fetch;
+    #queue = [];
+    #flushing = Promise.resolve();
+    #userId;
+    #timer;
+    #onHide;
+    constructor(opts) {
+      if (!opts.apiKey) throw new Error("pgp: apiKey is required");
+      this.#opts = {
+        apiKey: opts.apiKey,
+        baseUrl: (opts.baseUrl ?? "https://pgp.int.wepromotion.cn").replace(/\/$/, ""),
+        flushAt: opts.flushAt ?? 20,
+        flushInterval: opts.flushInterval ?? 5e3
+      };
+      this.#fetch = opts.fetchFn ?? fetch.bind(globalThis);
+      this.#userId = opts.userId ?? anonId();
+      if (typeof document !== "undefined") {
+        this.#onHide = () => {
+          if (this.#queue.length) void this.#flush(true);
+        };
+        document.addEventListener("visibilitychange", this.#onHide);
+        window.addEventListener("pagehide", this.#onHide);
+      }
+    }
+    /** Track the logged-in user (switches future events to this id). */
+    setUserId(userId) {
+      this.#userId = userId;
+    }
+    /** Queue an event. Flushing happens automatically. */
+    capture(name, properties) {
+      if (!this.#userId) {
+        console.error(`pgp: dropping event "${name}" \u2014 no user id`);
+        return;
+      }
+      this.#queue.push({ user_id: this.#userId, name, properties });
+      if (!this.#timer) {
+        this.#timer = setInterval(() => void this.flush(), this.#opts.flushInterval);
+        this.#timer.unref?.();
+      }
+      if (this.#queue.length >= this.#opts.flushAt) void this.flush();
+    }
+    /** Flush now. Concurrent calls share one request. Never throws. */
+    flush() {
+      return this.#flushing = this.#flushing.then(() => this.#flush(false));
+    }
+    /** Flush and stop timers/listeners. Call on shutdown. */
+    async close() {
+      if (this.#timer) clearInterval(this.#timer);
+      if (this.#onHide) {
+        document.removeEventListener("visibilitychange", this.#onHide);
+        window.removeEventListener("pagehide", this.#onHide);
+      }
+      await this.flush();
+    }
+    async #flush(keepalive) {
+      if (!this.#queue.length) return;
+      const events = this.#queue;
+      this.#queue = [];
+      try {
+        const res = await this.#fetch(`${this.#opts.baseUrl}/api/events/batch`, {
+          method: "POST",
+          headers: {
+            "content-type": "application/json",
+            authorization: `Bearer ${this.#opts.apiKey}`
+          },
+          body: JSON.stringify({ events }),
+          keepalive
+          // lets the request survive page unload
+        });
+        if (!res.ok) throw new Error(`pgp: flush failed with HTTP ${res.status}`);
+        if (!this.#queue.length && this.#timer) {
+          clearInterval(this.#timer);
+          this.#timer = void 0;
+        }
+      } catch (err) {
+        this.#queue = events.concat(this.#queue);
+        console.error(err instanceof Error ? err.message : err);
+      }
+    }
+  };
+  function createClient(opts) {
+    return new PgpClient(opts);
+  }
+  var index_default = { createClient, PgpClient };
+  return __toCommonJS(index_exports);
+})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pgp-sdk",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Isomorphic (Node.js + browser) event ingestion SDK for the PGP platform",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -15,7 +15,7 @@
   },
   "files": ["dist"],
   "scripts": {
-    "build": "tsup src/index.ts --format esm,cjs --dts --clean",
+    "build": "tsup src/index.ts --format esm,cjs,iife --global-name PgpSDK --dts --clean",
     "test": "node --test 'test/*.test.ts'",
     "prepublishOnly": "npm test && npm run build"
   },