@atsignal/js-core 0.1.0 → 0.1.2

package/dist/index.cjs

@@ -188,22 +188,16 @@ var SnapshotQueueStorage = class {
 };
 
 // src/timers.ts
-function resolveTimerApi() {
-  const maybeSetTimeout = globalThis.setTimeout;
-  const maybeClearTimeout = globalThis.clearTimeout;
+function resolveTimerApi(timerApi) {
+  const timers = timerApi != null ? timerApi : 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
-  };
+  return 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: () => {
@@ -211,14 +205,10 @@ function scheduleTask(callback, delayMs) {
     }
   };
 }
-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);
@@ -264,7 +254,7 @@ function encodeRequestBody(request) {
   return parts.join("&");
 }
 var FetchTransport = class {
-  constructor(options = {}) {
+  constructor(timers, options = {}) {
     var _a, _b, _c;
     const fetchImpl = (_a = options.fetch) != null ? _a : resolveGlobalFetch();
     if (!fetchImpl) {
@@ -273,14 +263,19 @@ var FetchTransport = class {
     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: {
@@ -316,13 +311,13 @@ var FetchTransport = class {
   }
 };
 function createFetchTransport(options = {}) {
-  return new FetchTransport(options);
+  return (runtime) => new FetchTransport(runtime.timers, options);
 }
 
 // src/client-config.ts
 var DEFAULT_ENDPOINT = "https://api.example.com/track";
-var DEFAULT_FLUSH_INTERVAL_MS = 5e3;
-var DEFAULT_MAX_BATCH_SIZE = 20;
+var DEFAULT_FLUSH_INTERVAL_MS = 1e3;
+var DEFAULT_MAX_BATCH_SIZE = 30;
 var DEFAULT_MAX_QUEUE_SIZE = 1e3;
 var DEFAULT_PART_ID = "";
 var DEFAULT_RETRY_BASE_MS = 500;
@@ -425,7 +420,16 @@ function createQueueStorage(storage) {
   }
   return new SnapshotQueueStorage(storage, QUEUE_STORAGE_KEY);
 }
-function normalizeConfig(apiKey, config) {
+function resolveRuntime(runtime) {
+  const timers = resolveTimerApi(runtime == null ? void 0 : runtime.timers);
+  if (!timers) {
+    throw new Error("Signal client requires a timer implementation");
+  }
+  return {
+    timers
+  };
+}
+function normalizeConfig(apiKey, config, runtime) {
   var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j;
   if (!apiKey) {
     throw new Error("Signal client requires apiKey");
@@ -435,18 +439,19 @@ function normalizeConfig(apiKey, config) {
     userId: resolveInitialUserId(config.userId),
     deviceId: resolveInitialDeviceId(config.deviceId)
   };
+  const transportFactory = (_b = config.transportFactory) != null ? _b : createFetchTransport();
   return {
     apiKey,
     resolvedConfig: {
-      endpoint: (_b = config.endpoint) != null ? _b : DEFAULT_ENDPOINT,
+      endpoint: (_c = config.endpoint) != null ? _c : DEFAULT_ENDPOINT,
       flushIntervalMs: toInteger(config.flushIntervalMs, DEFAULT_FLUSH_INTERVAL_MS),
       maxBatchSize: toInteger(config.maxBatchSize, DEFAULT_MAX_BATCH_SIZE),
       maxQueueSize: toInteger(config.maxQueueSize, DEFAULT_MAX_QUEUE_SIZE),
       retry: {
-        baseMs: toInteger((_c = config.retry) == null ? void 0 : _c.baseMs, DEFAULT_RETRY_BASE_MS),
-        maxMs: toInteger((_d = config.retry) == null ? void 0 : _d.maxMs, DEFAULT_RETRY_MAX_MS),
-        maxAttempts: toInteger((_e = config.retry) == null ? void 0 : _e.maxAttempts, DEFAULT_RETRY_ATTEMPTS),
-        jitter: typeof ((_f = config.retry) == null ? void 0 : _f.jitter) === "number" ? config.retry.jitter : DEFAULT_RETRY_JITTER
+        baseMs: toInteger((_d = config.retry) == null ? void 0 : _d.baseMs, DEFAULT_RETRY_BASE_MS),
+        maxMs: toInteger((_e = config.retry) == null ? void 0 : _e.maxMs, DEFAULT_RETRY_MAX_MS),
+        maxAttempts: toInteger((_f = config.retry) == null ? void 0 : _f.maxAttempts, DEFAULT_RETRY_ATTEMPTS),
+        jitter: typeof ((_g = config.retry) == null ? void 0 : _g.jitter) === "number" ? config.retry.jitter : DEFAULT_RETRY_JITTER
       },
       persistQueue,
       locationFromIp: resolveLocationFromIp(config.locationFromIp),
@@ -456,10 +461,10 @@ function normalizeConfig(apiKey, config) {
       blockedProperties: resolveBlockedProperties(config.blockedProperties)
     },
     storage: {
-      identity: createIdentityStorage((_g = config.storage) == null ? void 0 : _g.identity),
-      queue: persistQueue ? createQueueStorage((_h = config.storage) == null ? void 0 : _h.queue) : NOOP_QUEUE_STORAGE
+      identity: createIdentityStorage((_h = config.storage) == null ? void 0 : _h.identity),
+      queue: persistQueue ? createQueueStorage((_i = config.storage) == null ? void 0 : _i.queue) : NOOP_QUEUE_STORAGE
     },
-    transport: (_i = config.transport) != null ? _i : createFetchTransport(),
+    transport: transportFactory(runtime),
     plugins: (_j = config.plugins) != null ? _j : [],
     initialIdentityOverrides
   };
@@ -983,7 +988,10 @@ var SignalClient = class {
     }
     this._state = "initializing";
     try {
-      const normalized = normalizeConfig(apiKey, this.resolveInitConfig(options));
+      const initConfig = this.resolveInitConfig(options);
+      const runtime = resolveRuntime(initConfig.runtime);
+      const normalized = normalizeConfig(apiKey, initConfig, runtime);
+      this._runtime = runtime;
       this._applyNormalizedConfig(normalized);
       this._ready = this._initialize(normalized.initialIdentityOverrides);
       await this._ready;
@@ -1652,13 +1660,13 @@ var SignalClient = class {
       enqueueAutomaticFlush();
       return;
     }
-    const task = scheduleTask(() => {
-      enqueueAutomaticFlush();
-    }, delayMs);
-    if (!task) {
-      enqueueAutomaticFlush();
-      return;
-    }
+    const task = scheduleTask(
+      () => {
+        enqueueAutomaticFlush();
+      },
+      delayMs,
+      this._runtime.timers
+    );
     this._flushTask = task;
   }
   async _performFlush(reason) {

package/dist/index.d.cts

@@ -95,6 +95,14 @@ interface Transport {
     flush?(): Promise<void>;
     shutdown?(): Promise<void>;
 }
+interface TimerApi {
+    setTimeout(callback: () => void, delayMs: number): unknown;
+    clearTimeout(handle: unknown): void;
+}
+interface ClientRuntime {
+    timers: TimerApi;
+}
+type TransportFactory = (runtime: Readonly<ClientRuntime>) => Transport;
 interface ClientIdentity {
     userId: string | null;
     deviceId: string;
@@ -220,7 +228,15 @@ interface ClientConfig {
     optOut?: boolean;
     version?: string | null;
     endpoint?: string;
+    /**
+     * Automatic flush cadence in milliseconds.
+     * Defaults to `1_000`.
+     */
     flushIntervalMs?: number;
+    /**
+     * Maximum number of events to send in a single request.
+     * Defaults to `30`.
+     */
     maxBatchSize?: number;
     maxQueueSize?: number;
     retry?: RetryConfig;
@@ -238,7 +254,8 @@ interface ClientConfig {
     blockedProperties?: readonly string[];
     plugins?: ClientPlugin[];
     storage?: Partial<ClientStorageConfig>;
-    transport?: Transport;
+    runtime?: Partial<ClientRuntime>;
+    transportFactory?: TransportFactory;
 }
 
 declare class SignalClient<TInitOptions extends object = ClientConfig> {
@@ -246,6 +263,7 @@ declare class SignalClient<TInitOptions extends object = ClientConfig> {
     private _config;
     private _storage;
     private _transport;
+    private _runtime;
     private _hooks;
     private _insertIdGenerator;
     private _pluginRuntime;
@@ -388,6 +406,6 @@ interface FetchTransportOptions {
     keepalive?: boolean;
     headers?: Record<string, string>;
 }
-declare function createFetchTransport(options?: FetchTransportOptions): Transport;
+declare function createFetchTransport(options?: FetchTransportOptions): TransportFactory;
 
-export { type ClientConfig, type ClientHooks, type ClientIdentity, type ClientPlugin, type FlushMode, type FlushReason, HookRegistry, InMemoryStorage, type KeyValueStorage, type PersistedQueueEntry, type PluginSetupContext, type QueueStorage, type QueueStorageInput, type ResolvedClientConfig, type RetryConfig, SignalClient, type TrackOptions, type TrackProperties, type TrackedEvent, type Transport, type TransportEventGroup, type TransportRequest, type TransportResult, createFetchTransport };
+export { type ClientConfig, type ClientHooks, type ClientIdentity, type ClientPlugin, type ClientRuntime, type FlushMode, type FlushReason, HookRegistry, InMemoryStorage, type KeyValueStorage, type PersistedQueueEntry, type PluginSetupContext, type QueueStorage, type QueueStorageInput, type ResolvedClientConfig, type RetryConfig, SignalClient, type TimerApi, type TrackOptions, type TrackProperties, type TrackedEvent, type Transport, type TransportEventGroup, type TransportFactory, type TransportRequest, type TransportResult, createFetchTransport };

package/dist/index.d.ts

@@ -95,6 +95,14 @@ interface Transport {
     flush?(): Promise<void>;
     shutdown?(): Promise<void>;
 }
+interface TimerApi {
+    setTimeout(callback: () => void, delayMs: number): unknown;
+    clearTimeout(handle: unknown): void;
+}
+interface ClientRuntime {
+    timers: TimerApi;
+}
+type TransportFactory = (runtime: Readonly<ClientRuntime>) => Transport;
 interface ClientIdentity {
     userId: string | null;
     deviceId: string;
@@ -220,7 +228,15 @@ interface ClientConfig {
     optOut?: boolean;
     version?: string | null;
     endpoint?: string;
+    /**
+     * Automatic flush cadence in milliseconds.
+     * Defaults to `1_000`.
+     */
     flushIntervalMs?: number;
+    /**
+     * Maximum number of events to send in a single request.
+     * Defaults to `30`.
+     */
     maxBatchSize?: number;
     maxQueueSize?: number;
     retry?: RetryConfig;
@@ -238,7 +254,8 @@ interface ClientConfig {
     blockedProperties?: readonly string[];
     plugins?: ClientPlugin[];
     storage?: Partial<ClientStorageConfig>;
-    transport?: Transport;
+    runtime?: Partial<ClientRuntime>;
+    transportFactory?: TransportFactory;
 }
 
 declare class SignalClient<TInitOptions extends object = ClientConfig> {
@@ -246,6 +263,7 @@ declare class SignalClient<TInitOptions extends object = ClientConfig> {
     private _config;
     private _storage;
     private _transport;
+    private _runtime;
     private _hooks;
     private _insertIdGenerator;
     private _pluginRuntime;
@@ -388,6 +406,6 @@ interface FetchTransportOptions {
     keepalive?: boolean;
     headers?: Record<string, string>;
 }
-declare function createFetchTransport(options?: FetchTransportOptions): Transport;
+declare function createFetchTransport(options?: FetchTransportOptions): TransportFactory;
 
-export { type ClientConfig, type ClientHooks, type ClientIdentity, type ClientPlugin, type FlushMode, type FlushReason, HookRegistry, InMemoryStorage, type KeyValueStorage, type PersistedQueueEntry, type PluginSetupContext, type QueueStorage, type QueueStorageInput, type ResolvedClientConfig, type RetryConfig, SignalClient, type TrackOptions, type TrackProperties, type TrackedEvent, type Transport, type TransportEventGroup, type TransportRequest, type TransportResult, createFetchTransport };
+export { type ClientConfig, type ClientHooks, type ClientIdentity, type ClientPlugin, type ClientRuntime, type FlushMode, type FlushReason, HookRegistry, InMemoryStorage, type KeyValueStorage, type PersistedQueueEntry, type PluginSetupContext, type QueueStorage, type QueueStorageInput, type ResolvedClientConfig, type RetryConfig, SignalClient, type TimerApi, type TrackOptions, type TrackProperties, type TrackedEvent, type Transport, type TransportEventGroup, type TransportFactory, type TransportRequest, type TransportResult, createFetchTransport };

package/dist/index.js

@@ -159,22 +159,16 @@ var SnapshotQueueStorage = class {
 };
 
 // src/timers.ts
-function resolveTimerApi() {
-  const maybeSetTimeout = globalThis.setTimeout;
-  const maybeClearTimeout = globalThis.clearTimeout;
+function resolveTimerApi(timerApi) {
+  const timers = timerApi != null ? timerApi : 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
-  };
+  return 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: () => {
@@ -182,14 +176,10 @@ function scheduleTask(callback, delayMs) {
     }
   };
 }
-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);
@@ -235,7 +225,7 @@ function encodeRequestBody(request) {
   return parts.join("&");
 }
 var FetchTransport = class {
-  constructor(options = {}) {
+  constructor(timers, options = {}) {
     var _a, _b, _c;
     const fetchImpl = (_a = options.fetch) != null ? _a : resolveGlobalFetch();
     if (!fetchImpl) {
@@ -244,14 +234,19 @@ var FetchTransport = class {
     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: {
@@ -287,13 +282,13 @@ var FetchTransport = class {
   }
 };
 function createFetchTransport(options = {}) {
-  return new FetchTransport(options);
+  return (runtime) => new FetchTransport(runtime.timers, options);
 }
 
 // src/client-config.ts
 var DEFAULT_ENDPOINT = "https://api.example.com/track";
-var DEFAULT_FLUSH_INTERVAL_MS = 5e3;
-var DEFAULT_MAX_BATCH_SIZE = 20;
+var DEFAULT_FLUSH_INTERVAL_MS = 1e3;
+var DEFAULT_MAX_BATCH_SIZE = 30;
 var DEFAULT_MAX_QUEUE_SIZE = 1e3;
 var DEFAULT_PART_ID = "";
 var DEFAULT_RETRY_BASE_MS = 500;
@@ -396,7 +391,16 @@ function createQueueStorage(storage) {
   }
   return new SnapshotQueueStorage(storage, QUEUE_STORAGE_KEY);
 }
-function normalizeConfig(apiKey, config) {
+function resolveRuntime(runtime) {
+  const timers = resolveTimerApi(runtime == null ? void 0 : runtime.timers);
+  if (!timers) {
+    throw new Error("Signal client requires a timer implementation");
+  }
+  return {
+    timers
+  };
+}
+function normalizeConfig(apiKey, config, runtime) {
   var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j;
   if (!apiKey) {
     throw new Error("Signal client requires apiKey");
@@ -406,18 +410,19 @@ function normalizeConfig(apiKey, config) {
     userId: resolveInitialUserId(config.userId),
     deviceId: resolveInitialDeviceId(config.deviceId)
   };
+  const transportFactory = (_b = config.transportFactory) != null ? _b : createFetchTransport();
   return {
     apiKey,
     resolvedConfig: {
-      endpoint: (_b = config.endpoint) != null ? _b : DEFAULT_ENDPOINT,
+      endpoint: (_c = config.endpoint) != null ? _c : DEFAULT_ENDPOINT,
       flushIntervalMs: toInteger(config.flushIntervalMs, DEFAULT_FLUSH_INTERVAL_MS),
       maxBatchSize: toInteger(config.maxBatchSize, DEFAULT_MAX_BATCH_SIZE),
       maxQueueSize: toInteger(config.maxQueueSize, DEFAULT_MAX_QUEUE_SIZE),
       retry: {
-        baseMs: toInteger((_c = config.retry) == null ? void 0 : _c.baseMs, DEFAULT_RETRY_BASE_MS),
-        maxMs: toInteger((_d = config.retry) == null ? void 0 : _d.maxMs, DEFAULT_RETRY_MAX_MS),
-        maxAttempts: toInteger((_e = config.retry) == null ? void 0 : _e.maxAttempts, DEFAULT_RETRY_ATTEMPTS),
-        jitter: typeof ((_f = config.retry) == null ? void 0 : _f.jitter) === "number" ? config.retry.jitter : DEFAULT_RETRY_JITTER
+        baseMs: toInteger((_d = config.retry) == null ? void 0 : _d.baseMs, DEFAULT_RETRY_BASE_MS),
+        maxMs: toInteger((_e = config.retry) == null ? void 0 : _e.maxMs, DEFAULT_RETRY_MAX_MS),
+        maxAttempts: toInteger((_f = config.retry) == null ? void 0 : _f.maxAttempts, DEFAULT_RETRY_ATTEMPTS),
+        jitter: typeof ((_g = config.retry) == null ? void 0 : _g.jitter) === "number" ? config.retry.jitter : DEFAULT_RETRY_JITTER
       },
       persistQueue,
       locationFromIp: resolveLocationFromIp(config.locationFromIp),
@@ -427,10 +432,10 @@ function normalizeConfig(apiKey, config) {
       blockedProperties: resolveBlockedProperties(config.blockedProperties)
     },
     storage: {
-      identity: createIdentityStorage((_g = config.storage) == null ? void 0 : _g.identity),
-      queue: persistQueue ? createQueueStorage((_h = config.storage) == null ? void 0 : _h.queue) : NOOP_QUEUE_STORAGE
+      identity: createIdentityStorage((_h = config.storage) == null ? void 0 : _h.identity),
+      queue: persistQueue ? createQueueStorage((_i = config.storage) == null ? void 0 : _i.queue) : NOOP_QUEUE_STORAGE
     },
-    transport: (_i = config.transport) != null ? _i : createFetchTransport(),
+    transport: transportFactory(runtime),
     plugins: (_j = config.plugins) != null ? _j : [],
     initialIdentityOverrides
   };
@@ -954,7 +959,10 @@ var SignalClient = class {
     }
     this._state = "initializing";
     try {
-      const normalized = normalizeConfig(apiKey, this.resolveInitConfig(options));
+      const initConfig = this.resolveInitConfig(options);
+      const runtime = resolveRuntime(initConfig.runtime);
+      const normalized = normalizeConfig(apiKey, initConfig, runtime);
+      this._runtime = runtime;
       this._applyNormalizedConfig(normalized);
       this._ready = this._initialize(normalized.initialIdentityOverrides);
       await this._ready;
@@ -1623,13 +1631,13 @@ var SignalClient = class {
       enqueueAutomaticFlush();
       return;
     }
-    const task = scheduleTask(() => {
-      enqueueAutomaticFlush();
-    }, delayMs);
-    if (!task) {
-      enqueueAutomaticFlush();
-      return;
-    }
+    const task = scheduleTask(
+      () => {
+        enqueueAutomaticFlush();
+      },
+      delayMs,
+      this._runtime.timers
+    );
     this._flushTask = task;
   }
   async _performFlush(reason) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atsignal/js-core",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Shared core module for Signal JavaScript SDKs.",
   "license": "MIT",
   "type": "module",