@atsignal/browser 0.1.1 → 0.2.0

package/README.md

@@ -14,12 +14,15 @@ pnpm add @atsignal/browser
 import signal from "@atsignal/browser";
 
 await signal.init("your-api-key", {
+  endpoint: "https://your-collector.example.com/track",
   persistQueue: false,
 });
 
 await signal.track("PageView");
 ```
 
+Set `endpoint` to your real collector URL. The SDK default, `https://api.example.com/track`, is a placeholder used for docs/tests and will not send events anywhere useful by itself.
+
 Optional browser plugins are published as separate packages. For example, install `@atsignal/browser-plugin-enrich-context` and import it before using `signal.plugins.enrichContext()`.
 
 More SDK details live in the monorepo root README.

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { ClientPlugin, KeyValueStorage, SignalClient, ClientConfig, Transport, QueueStorageInput } from '@atsignal/js-core';
+import { ClientPlugin, KeyValueStorage, SignalClient, ClientConfig, QueueStorageInput } from '@atsignal/js-core';
 export { ClientPlugin } from '@atsignal/js-core';
 
 type BrowserPluginFactory = (...args: unknown[]) => ClientPlugin;
@@ -28,7 +28,6 @@ declare class BrowserLocalStorage implements KeyValueStorage {
 }
 
 interface SignalBrowserOptions extends Omit<ClientConfig, "storage"> {
-    transport?: Transport;
     storage?: {
         identity?: KeyValueStorage;
         queue?: QueueStorageInput;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ClientPlugin, KeyValueStorage, SignalClient, ClientConfig, Transport, QueueStorageInput } from '@atsignal/js-core';
+import { ClientPlugin, KeyValueStorage, SignalClient, ClientConfig, QueueStorageInput } from '@atsignal/js-core';
 export { ClientPlugin } from '@atsignal/js-core';
 
 type BrowserPluginFactory = (...args: unknown[]) => ClientPlugin;
@@ -28,7 +28,6 @@ declare class BrowserLocalStorage implements KeyValueStorage {
 }
 
 interface SignalBrowserOptions extends Omit<ClientConfig, "storage"> {
-    transport?: Transport;
     storage?: {
         identity?: KeyValueStorage;
         queue?: QueueStorageInput;

package/dist/signal.global.js

@@ -158,21 +158,18 @@ var __signalBundle = (() => {
     }
   };
   function resolveTimerApi() {
-    const maybeSetTimeout = globalThis.setTimeout;
-    const maybeClearTimeout = globalThis.clearTimeout;
+    const timers = globalThis;
+    const maybeSetTimeout = timers == null ? void 0 : timers.setTimeout;
+    const maybeClearTimeout = timers == null ? void 0 : timers.clearTimeout;
     if (typeof maybeSetTimeout !== "function" || typeof maybeClearTimeout !== "function") {
       return null;
     }
     return {
-      setTimeout: maybeSetTimeout,
-      clearTimeout: maybeClearTimeout
+      setTimeout: maybeSetTimeout.bind(timers),
+      clearTimeout: maybeClearTimeout.bind(timers)
     };
   }
-  function scheduleTask(callback, delayMs) {
-    const timers = resolveTimerApi();
-    if (!timers) {
-      return null;
-    }
+  function scheduleTask(callback, delayMs, timers) {
     const handle = timers.setTimeout(callback, delayMs);
     return {
       cancel: () => {
@@ -180,14 +177,10 @@ var __signalBundle = (() => {
       }
     };
   }
-  function createTimeoutController(timeoutMs, createTimeoutValue) {
+  function createTimeoutController(timeoutMs, createTimeoutValue, timers) {
     if (typeof timeoutMs !== "number" || timeoutMs <= 0) {
       return null;
     }
-    const timers = resolveTimerApi();
-    if (!timers) {
-      return null;
-    }
     let handle;
     const timeout = new Promise((resolve) => {
       handle = timers.setTimeout(() => resolve(createTimeoutValue()), timeoutMs);
@@ -200,11 +193,12 @@ var __signalBundle = (() => {
     };
   }
   function resolveGlobalFetch() {
-    const candidate = globalThis.fetch;
+    const globalObject2 = globalThis;
+    const candidate = globalObject2.fetch;
     if (typeof candidate !== "function") {
       return null;
     }
-    return candidate;
+    return candidate.bind(globalObject2);
   }
   function encodeRequestBody(request) {
     const parts = [
@@ -234,20 +228,29 @@ var __signalBundle = (() => {
     constructor(options = {}) {
       var _a, _b, _c;
       const fetchImpl = (_a = options.fetch) != null ? _a : resolveGlobalFetch();
+      const timers = resolveTimerApi();
       if (!fetchImpl) {
         throw new Error("No fetch implementation found for FetchTransport");
       }
+      if (!timers) {
+        throw new Error("No timer implementation found for FetchTransport");
+      }
       this._fetch = fetchImpl;
       this._keepalive = (_b = options.keepalive) != null ? _b : false;
       this._headers = (_c = options.headers) != null ? _c : {};
+      this._timers = timers;
     }
     async send(request) {
-      const timer = createTimeoutController(request.timeoutMs, () => ({
-        ok: false,
-        retryable: true,
-        status: 0,
-        error: new Error("Request timed out")
-      }));
+      const timer = createTimeoutController(
+        request.timeoutMs,
+        () => ({
+          ok: false,
+          retryable: true,
+          status: 0,
+          error: new Error("Request timed out")
+        }),
+        this._timers
+      );
       const requestPromise = this._fetch(request.endpoint, {
         method: "POST",
         headers: {
@@ -395,7 +398,7 @@ var __signalBundle = (() => {
     if (!apiKey) {
       throw new Error("Signal client requires apiKey");
     }
-    const persistQueue = (_a = config.persistQueue) != null ? _a : true;
+    const persistQueue = (_a = config.persistQueue) != null ? _a : false;
     const initialIdentityOverrides = {
       userId: resolveInitialUserId(config.userId),
       deviceId: resolveInitialDeviceId(config.deviceId)
@@ -934,7 +937,12 @@ var __signalBundle = (() => {
       }
       this._state = "initializing";
       try {
+        const timers = resolveTimerApi();
+        if (!timers) {
+          throw new Error("Signal client requires a timer implementation");
+        }
         const normalized = normalizeConfig(apiKey, this.resolveInitConfig(options));
+        this._timers = timers;
         this._applyNormalizedConfig(normalized);
         this._ready = this._initialize(normalized.initialIdentityOverrides);
         await this._ready;
@@ -1369,7 +1377,6 @@ var __signalBundle = (() => {
         const dropped = this._enqueue(entry);
         queuedResults.push({
           entry,
-          queuedEvents: this._queue.length,
           request
         });
         if (dropped) {
@@ -1381,11 +1388,10 @@ var __signalBundle = (() => {
       if (droppedIds.length > 0) {
         await this._removeQueueEntries(droppedIds);
       }
-      for (const { entry, queuedEvents, request } of queuedResults) {
+      for (const { entry, request } of queuedResults) {
         await this._hooks.emitEventQueued({
           event: entry.event,
-          options: entry.options,
-          queuedEvents
+          options: entry.options
         });
         if (!request.waitForImmediateFlush) {
           request.completion.resolve(void 0);
@@ -1603,13 +1609,13 @@ var __signalBundle = (() => {
         enqueueAutomaticFlush();
         return;
       }
-      const task = scheduleTask(() => {
-        enqueueAutomaticFlush();
-      }, delayMs);
-      if (!task) {
-        enqueueAutomaticFlush();
-        return;
-      }
+      const task = scheduleTask(
+        () => {
+          enqueueAutomaticFlush();
+        },
+        delayMs,
+        this._timers
+      );
       this._flushTask = task;
     }
     async _performFlush(reason) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atsignal/browser",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Browser SDK for Signal.",
   "license": "MIT",
   "type": "module",
@@ -27,7 +27,7 @@
     "dist"
   ],
   "dependencies": {
-    "@atsignal/js-core": "0.1.1"
+    "@atsignal/js-core": "0.2.0"
   },
   "publishConfig": {
     "access": "public",