@pulseboard/react-native 0.2.1 → 0.2.3

package/dist/index.d.mts

@@ -55,7 +55,10 @@ type PulseEvent = {
     context?: EnrichedContext;
 };
 type SDKConfig = {
-    apiKey: string;
+    apiKey?: string;
+    organisation?: string;
+    product?: string;
+    project?: string;
     environment: Environment;
     debug?: boolean;
     autoCapture?: boolean;
@@ -69,6 +72,27 @@ type TrackOptions = {
 type CaptureErrorOptions = {
     payload?: Record<string, unknown>;
 };
+type LogLevel = "debug" | "info" | "warn" | "error";
+type LogEntry = {
+    apiKey: string;
+    level: LogLevel;
+    message: string;
+    meta?: Record<string, unknown>;
+    sessionId?: string;
+    appVersion?: string;
+    timestamp: string;
+};
+type LogOptions = {
+    meta?: Record<string, unknown>;
+};
+type FeedbackType = "bug" | "feature" | "general";
+type FeedbackOptions = {
+    type?: FeedbackType;
+    meta?: Record<string, unknown>;
+    userEmail?: string;
+    userName?: string;
+    screenshot?: string;
+};
 
 declare class PulseBoardSDK {
     private config;
@@ -79,24 +103,36 @@ declare class PulseBoardSDK {
     private flushTimer;
     private initialized;
     private readonly PULSEBOARD_API;
+    private logQueue;
+    private logFlushTimer;
+    private originalConsole;
+    private consoleCapturing;
+    private get apiKey();
     init(config: SDKConfig): void;
+    private resolveApiKey;
+    private completeInit;
     getContext(): Promise<EnrichedContext>;
     identify(user: UserContext): void;
     clearUser(): void;
     track(name: string, options?: TrackOptions): void;
     metric(name: string, value: number, options?: TrackOptions): void;
     captureError(error: Error, options?: CaptureErrorOptions): void;
+    log(level: LogLevel, message: string, options?: LogOptions): void;
+    captureConsole(): void;
+    releaseConsole(): void;
+    flushLogs(): Promise<void>;
     startSession(): void;
     endSession(duration?: number): void;
     trackScreen(screenName: string, loadTime?: number): void;
     trackApiCall(endpoint: string, httpMethod: string, statusCode: number, duration: number, payloadSize?: number): void;
     trackCrash(error: Error, isFatal?: boolean): void;
+    feedback(message: string, options?: FeedbackOptions): void;
     flush(): Promise<void>;
     destroy(): void;
     private buildAndEnqueue;
     private assertInitialized;
-    private log;
+    private debugLog;
 }
 declare const PulseBoard: PulseBoardSDK;
 
-export { type AppContext, type CaptureErrorOptions, type DeviceContext, type EnrichedContext, type EventType, type NetworkContext, PulseBoard, type PulseEvent, type SDKConfig, type SessionContext, type TrackOptions, type UserContext };
+export { type AppContext, type CaptureErrorOptions, type DeviceContext, type EnrichedContext, type EventType, type LogEntry, type LogLevel, type LogOptions, type NetworkContext, PulseBoard, type PulseEvent, type SDKConfig, type SessionContext, type TrackOptions, type UserContext };

package/dist/index.d.ts

@@ -55,7 +55,10 @@ type PulseEvent = {
     context?: EnrichedContext;
 };
 type SDKConfig = {
-    apiKey: string;
+    apiKey?: string;
+    organisation?: string;
+    product?: string;
+    project?: string;
     environment: Environment;
     debug?: boolean;
     autoCapture?: boolean;
@@ -69,6 +72,27 @@ type TrackOptions = {
 type CaptureErrorOptions = {
     payload?: Record<string, unknown>;
 };
+type LogLevel = "debug" | "info" | "warn" | "error";
+type LogEntry = {
+    apiKey: string;
+    level: LogLevel;
+    message: string;
+    meta?: Record<string, unknown>;
+    sessionId?: string;
+    appVersion?: string;
+    timestamp: string;
+};
+type LogOptions = {
+    meta?: Record<string, unknown>;
+};
+type FeedbackType = "bug" | "feature" | "general";
+type FeedbackOptions = {
+    type?: FeedbackType;
+    meta?: Record<string, unknown>;
+    userEmail?: string;
+    userName?: string;
+    screenshot?: string;
+};
 
 declare class PulseBoardSDK {
     private config;
@@ -79,24 +103,36 @@ declare class PulseBoardSDK {
     private flushTimer;
     private initialized;
     private readonly PULSEBOARD_API;
+    private logQueue;
+    private logFlushTimer;
+    private originalConsole;
+    private consoleCapturing;
+    private get apiKey();
     init(config: SDKConfig): void;
+    private resolveApiKey;
+    private completeInit;
     getContext(): Promise<EnrichedContext>;
     identify(user: UserContext): void;
     clearUser(): void;
     track(name: string, options?: TrackOptions): void;
     metric(name: string, value: number, options?: TrackOptions): void;
     captureError(error: Error, options?: CaptureErrorOptions): void;
+    log(level: LogLevel, message: string, options?: LogOptions): void;
+    captureConsole(): void;
+    releaseConsole(): void;
+    flushLogs(): Promise<void>;
     startSession(): void;
     endSession(duration?: number): void;
     trackScreen(screenName: string, loadTime?: number): void;
     trackApiCall(endpoint: string, httpMethod: string, statusCode: number, duration: number, payloadSize?: number): void;
     trackCrash(error: Error, isFatal?: boolean): void;
+    feedback(message: string, options?: FeedbackOptions): void;
     flush(): Promise<void>;
     destroy(): void;
     private buildAndEnqueue;
     private assertInitialized;
-    private log;
+    private debugLog;
 }
 declare const PulseBoard: PulseBoardSDK;
 
-export { type AppContext, type CaptureErrorOptions, type DeviceContext, type EnrichedContext, type EventType, type NetworkContext, PulseBoard, type PulseEvent, type SDKConfig, type SessionContext, type TrackOptions, type UserContext };
+export { type AppContext, type CaptureErrorOptions, type DeviceContext, type EnrichedContext, type EventType, type LogEntry, type LogLevel, type LogOptions, type NetworkContext, PulseBoard, type PulseEvent, type SDKConfig, type SessionContext, type TrackOptions, type UserContext };

package/dist/index.js

@@ -1,6 +1,11 @@
 'use strict';
 
 var reactNative = require('react-native');
+var AsyncStorage = require('@react-native-async-storage/async-storage');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var AsyncStorage__default = /*#__PURE__*/_interopDefault(AsyncStorage);
 
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __commonJS = (cb, mod) => function __require() {
@@ -378,6 +383,60 @@ var PulseBoardClient = class {
       return false;
     }
   }
+  // ─── Log Entry ─────────────────────────────────────────────
+  async sendLog(entry) {
+    try {
+      const response = await fetch(`${this.host}/logs`, {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify(entry)
+      });
+      if (!response.ok) {
+        this.log(`Failed to send log: ${response.status}`);
+        return false;
+      }
+      return true;
+    } catch (err) {
+      this.log(`Network error sending log: ${err}`);
+      return false;
+    }
+  }
+  async sendLogBatch(apiKey, logs) {
+    try {
+      const response = await fetch(`${this.host}/logs/batch`, {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify({ apiKey, logs })
+      });
+      if (!response.ok) {
+        this.log(`Failed to send log batch: ${response.status}`);
+        return false;
+      }
+      return true;
+    } catch (err) {
+      this.log(`Network error sending log batch: ${err}`);
+      return false;
+    }
+  }
+  // ─── Feedback ─────────────────────────────────────────────────────
+  async sendFeedback(payload) {
+    try {
+      const response = await fetch(`${this.host}/feedback`, {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify(payload)
+      });
+      if (!response.ok) {
+        this.log(`Failed to send feedback: ${response.status}`);
+        return false;
+      }
+      this.log("Feedback sent");
+      return true;
+    } catch (err) {
+      this.log(`Network error sending feedback: ${err}`);
+      return false;
+    }
+  }
   // ─── Private ──────────────────────────────────────────────────────
   chunk(arr, size) {
     return Array.from(
@@ -493,30 +552,63 @@ var ContextCollector = class {
     };
   }
 };
-
-// src/queue.ts
+var QUEUE_KEY = "@pulseboard/event_queue";
+var MAX_QUEUE_SIZE = 100;
 var EventQueue = class {
-  constructor(maxSize = 100) {
-    this.queue = [];
+  constructor(maxSize = MAX_QUEUE_SIZE) {
+    this.memoryQueue = [];
+    this._hydrated = false;
     this.maxSize = maxSize;
+    this.hydrate();
+  }
+  // ─── Hydrate from storage on init ─────────────────────────────────
+  async hydrate() {
+    try {
+      const raw = await AsyncStorage__default.default.getItem(QUEUE_KEY);
+      if (raw) {
+        const stored = JSON.parse(raw);
+        this.memoryQueue = stored.slice(0, this.maxSize);
+      }
+    } catch {
+    } finally {
+      this._hydrated = true;
+    }
+  }
+  // ─── Persist to storage ────────────────────────────────────────────
+  async persist() {
+    try {
+      await AsyncStorage__default.default.setItem(QUEUE_KEY, JSON.stringify(this.memoryQueue));
+    } catch {
+    }
   }
+  // ─── Public API ────────────────────────────────────────────────────
   enqueue(event) {
-    if (this.queue.length >= this.maxSize) {
-      this.queue.shift();
+    if (this.memoryQueue.length >= this.maxSize) {
+      this.memoryQueue.shift();
     }
-    this.queue.push(event);
+    this.memoryQueue.push(event);
+    this.persist();
   }
   dequeue(count) {
-    return this.queue.splice(0, count);
+    const batch = this.memoryQueue.splice(0, count);
+    this.persist();
+    return batch;
   }
   get size() {
-    return this.queue.length;
+    return this.memoryQueue.length;
   }
   get isEmpty() {
-    return this.queue.length === 0;
+    return this.memoryQueue.length === 0;
+  }
+  get hydrated() {
+    return this._hydrated;
   }
-  clear() {
-    this.queue = [];
+  async clear() {
+    this.memoryQueue = [];
+    try {
+      await AsyncStorage__default.default.removeItem(QUEUE_KEY);
+    } catch {
+    }
   }
 };
 
@@ -531,25 +623,70 @@ var PulseBoardSDK = class {
     this.flushTimer = null;
     this.initialized = false;
     this.PULSEBOARD_API = "https://pulseboard-production.up.railway.app/";
+    // ─── Log queue ────────────────────────────────────────────────────
+    this.logQueue = [];
+    this.logFlushTimer = null;
+    this.originalConsole = {};
+    this.consoleCapturing = false;
+  }
+  get apiKey() {
+    return this.config?.apiKey ?? "";
   }
   // ─── Public API ───────────────────────────────────────────────────
   init(config) {
     if (this.initialized) {
-      this.log("SDK already initialized \u2014 skipping");
+      this.debugLog("SDK already initialized \u2014 skipping");
       return;
     }
+    const hasDirectKey = !!config.apiKey;
+    const hasIdentifiers = !!(config.organisation && config.product && config.project);
+    if (!hasDirectKey && !hasIdentifiers) {
+      throw new Error(
+        "[PulseBoard] init() requires either apiKey or (organisation + product + project)"
+      );
+    }
     this.config = {
       autoCapture: true,
       debug: false,
       flushInterval: 5e3,
       maxQueueSize: 100,
-      ...config
+      ...config,
+      apiKey: config.apiKey ?? ""
+      // resolved below if using identifiers
     };
     this.client = new PulseBoardClient(this.PULSEBOARD_API, this.config.debug);
     this.queue = new EventQueue(this.config.maxQueueSize);
     this.contextCollector = new ContextCollector({
       environment: config.environment
     });
+    if (!hasDirectKey && hasIdentifiers) {
+      this.resolveApiKey(
+        config.organisation,
+        config.product,
+        config.project
+      );
+    } else {
+      this.completeInit();
+    }
+  }
+  async resolveApiKey(organisation, product, project) {
+    try {
+      const response = await fetch(
+        `${this.PULSEBOARD_API}sdk/resolve?organisation=${encodeURIComponent(organisation)}&product=${encodeURIComponent(product)}&project=${encodeURIComponent(project)}`
+      );
+      if (!response.ok) {
+        throw new Error(
+          `[PulseBoard] Could not resolve project. Check your organisation, product and project values.`
+        );
+      }
+      const data = await response.json();
+      this.config.apiKey = data.data.apiKey;
+      this.completeInit();
+    } catch (err) {
+      console.error("[PulseBoard] Failed to resolve API key:", err);
+    }
+  }
+  completeInit() {
     this.flushTimer = setInterval(
       () => this.flush(),
       this.config.flushInterval
@@ -561,7 +698,7 @@ var PulseBoardSDK = class {
       this.autoCapture.attach();
     }
     this.initialized = true;
-    this.log(`Initialized \u2014 host: ${this.PULSEBOARD_API}`);
+    this.debugLog(`Initialized \u2014 host: ${this.PULSEBOARD_API}`);
   }
   async getContext() {
     this.assertInitialized("getContext");
@@ -570,7 +707,7 @@ var PulseBoardSDK = class {
   identify(user) {
     this.assertInitialized("identify");
     this.contextCollector.identify(user);
-    this.log(`User identified: ${JSON.stringify(user)}`);
+    this.debugLog(`User identified: ${JSON.stringify(user)}`);
   }
   clearUser() {
     this.assertInitialized("clearUser");
@@ -602,26 +739,87 @@ var PulseBoardSDK = class {
       ...options.payload
     });
   }
+  // ─── Logging API ──────────────────────────────────────────────────
+  log(level, message, options = {}) {
+    this.assertInitialized("log");
+    this.contextCollector.collect().then((context) => {
+      this.logQueue.push({
+        level,
+        message,
+        meta: options.meta,
+        sessionId: context.session.sessionId,
+        appVersion: context.device.appVersion,
+        timestamp: (/* @__PURE__ */ new Date()).toISOString()
+      });
+      if (level === "error") this.flushLogs();
+    }).catch(() => {
+    });
+  }
+  captureConsole() {
+    this.assertInitialized("captureConsole");
+    if (this.consoleCapturing) return;
+    this.originalConsole = {
+      log: console.log,
+      warn: console.warn,
+      error: console.error,
+      debug: console.debug
+    };
+    console.log = (...args) => {
+      this.originalConsole.log?.(...args);
+      this.log("info", args.map(String).join(" "));
+    };
+    console.warn = (...args) => {
+      this.originalConsole.warn?.(...args);
+      this.log("warn", args.map(String).join(" "));
+    };
+    console.error = (...args) => {
+      this.originalConsole.error?.(...args);
+      this.log("error", args.map(String).join(" "));
+    };
+    console.debug = (...args) => {
+      this.originalConsole.debug?.(...args);
+      this.log("debug", args.map(String).join(" "));
+    };
+    this.logFlushTimer = setInterval(() => this.flushLogs(), 1e4);
+    this.consoleCapturing = true;
+    this.debugLog("Console capture enabled");
+  }
+  releaseConsole() {
+    if (!this.consoleCapturing) return;
+    if (this.originalConsole.log) console.log = this.originalConsole.log;
+    if (this.originalConsole.warn) console.warn = this.originalConsole.warn;
+    if (this.originalConsole.error) console.error = this.originalConsole.error;
+    if (this.originalConsole.debug) console.debug = this.originalConsole.debug;
+    if (this.logFlushTimer) {
+      clearInterval(this.logFlushTimer);
+      this.logFlushTimer = null;
+    }
+    this.originalConsole = {};
+    this.consoleCapturing = false;
+  }
+  async flushLogs() {
+    if (!this.client || !this.config || this.logQueue.length === 0) return;
+    const batch = this.logQueue.splice(0, this.logQueue.length);
+    await this.client.sendLogBatch(this.apiKey, batch);
+  }
   // ─── Analytics API ────────────────────────────────────────────────
   startSession() {
     this.assertInitialized("startSession");
     this.contextCollector.collect().then((context) => {
       this.client.sendAnalytics("session", {
-        apiKey: this.config.apiKey,
+        apiKey: this.apiKey,
         sessionId: context.session.sessionId,
         startedAt: context.session.startedAt,
         context
       });
-      this.log(`Session started: ${context.session.sessionId}`);
-    }).catch((err) => {
-      this.log(`Failed to start session: ${err}`);
-    });
+      this.debugLog(`Session started: ${context.session.sessionId}`);
+    }).catch((err) => this.debugLog(`Failed to start session: ${err}`));
   }
   endSession(duration) {
     this.assertInitialized("endSession");
     this.contextCollector.collect().then((context) => {
       this.client.sendAnalytics("session", {
-        apiKey: this.config.apiKey,
+        apiKey: this.apiKey,
         sessionId: context.session.sessionId,
         startedAt: context.session.startedAt,
         endedAt: (/* @__PURE__ */ new Date()).toISOString(),
@@ -629,31 +827,27 @@ var PulseBoardSDK = class {
         context
       });
       this.flush();
-      this.log(`Session ended: ${context.session.sessionId}`);
-    }).catch((err) => {
-      this.log(`Failed to end session: ${err}`);
-    });
+      this.debugLog(`Session ended: ${context.session.sessionId}`);
+    }).catch((err) => this.debugLog(`Failed to end session: ${err}`));
   }
   trackScreen(screenName, loadTime) {
     this.assertInitialized("trackScreen");
     this.contextCollector.collect().then((context) => {
       this.client.sendAnalytics("screen-view", {
-        apiKey: this.config.apiKey,
+        apiKey: this.apiKey,
         screenName,
         loadTime,
         sessionId: context.session.sessionId,
         context
       });
-      this.log(`Screen tracked: ${screenName}`);
-    }).catch((err) => {
-      this.log(`Failed to track screen: ${err}`);
-    });
+      this.debugLog(`Screen tracked: ${screenName}`);
+    }).catch((err) => this.debugLog(`Failed to track screen: ${err}`));
   }
   trackApiCall(endpoint, httpMethod, statusCode, duration, payloadSize) {
     this.assertInitialized("trackApiCall");
     this.contextCollector.collect().then((context) => {
       this.client.sendAnalytics("api-call", {
-        apiKey: this.config.apiKey,
+        apiKey: this.apiKey,
         endpoint,
         httpMethod,
         statusCode,
@@ -662,16 +856,16 @@ var PulseBoardSDK = class {
         sessionId: context.session.sessionId,
         context
       });
-      this.log(`API call tracked: ${httpMethod} ${endpoint} ${statusCode}`);
-    }).catch((err) => {
-      this.log(`Failed to track API call: ${err}`);
-    });
+      this.debugLog(
+        `API call tracked: ${httpMethod} ${endpoint} ${statusCode}`
+      );
+    }).catch((err) => this.debugLog(`Failed to track API call: ${err}`));
   }
   trackCrash(error, isFatal = false) {
     this.assertInitialized("trackCrash");
     this.contextCollector.collect().then((context) => {
       this.client.sendAnalytics("crash", {
-        apiKey: this.config.apiKey,
+        apiKey: this.apiKey,
         errorName: error.name,
         errorMessage: error.message,
         stackTrace: error.stack ?? "",
@@ -679,17 +873,46 @@ var PulseBoardSDK = class {
         sessionId: context.session.sessionId,
         context
       });
-      this.log(`Crash tracked: ${error.name} \u2014 fatal: ${isFatal}`);
-    }).catch((err) => {
-      this.log(`Failed to track crash: ${err}`);
-    });
+      this.debugLog(`Crash tracked: ${error.name} \u2014 fatal: ${isFatal}`);
+    }).catch((err) => this.debugLog(`Failed to track crash: ${err}`));
   }
-  // ─── Flush & Destroy ─────────────────────────────────────────────
+  feedback(message, options = {}) {
+    this.assertInitialized("feedback");
+    this.contextCollector.collect().then((context) => {
+      this.client.sendFeedback({
+        apiKey: this.apiKey,
+        type: options.type ?? "general",
+        message,
+        meta: options.meta,
+        userEmail: options.userEmail,
+        userName: options.userName,
+        screenshot: options.screenshot,
+        sessionId: context.session.sessionId,
+        appVersion: context.device.appVersion
+      });
+      this.debugLog(`Feedback sent: ${options.type ?? "general"}`);
+    }).catch((err) => this.debugLog(`Failed to send feedback: ${err}`));
+  }
+  // ─── Flush & Destroy ──────────────────────────────────────────────
   async flush() {
-    if (!this.queue || this.queue.isEmpty) return;
-    if (!this.client) return;
+    if (!this.queue || !this.client) return;
+    if (!this.queue.hydrated) {
+      await new Promise((resolve) => {
+        const interval = setInterval(() => {
+          if (this.queue?.hydrated) {
+            clearInterval(interval);
+            resolve();
+          }
+        }, 50);
+        setTimeout(() => {
+          clearInterval(interval);
+          resolve();
+        }, 500);
+      });
+    }
+    if (this.queue.isEmpty) return;
     const events = this.queue.dequeue(10);
-    this.log(`Flushing ${events.length} event(s)`);
+    this.debugLog(`Flushing ${events.length} event(s)`);
     await this.client.sendBatch(events);
   }
   destroy() {
@@ -697,20 +920,22 @@ var PulseBoardSDK = class {
       clearInterval(this.flushTimer);
       this.flushTimer = null;
     }
+    this.releaseConsole();
     this.autoCapture?.detach();
     this.queue?.clear();
+    this.logQueue = [];
     this.initialized = false;
     this.config = null;
     this.client = null;
     this.queue = null;
     this.contextCollector = null;
-    this.log("SDK destroyed");
+    this.debugLog("SDK destroyed");
   }
-  // ─── Private ─────────────────────────────────────────────────────
+  // ─── Private ──────────────────────────────────────────────────────
   buildAndEnqueue(type, name, payload, timestamp) {
     this.contextCollector.collect().then((context) => {
       const event = {
-        apiKey: this.config.apiKey,
+        apiKey: this.apiKey,
         type,
         name,
         payload,
@@ -718,20 +943,16 @@ var PulseBoardSDK = class {
         context
       };
       this.queue.enqueue(event);
-      this.log(`Queued: ${type} \u2014 ${name}`);
-      if (type === "error") {
-        this.flush();
-      }
-    }).catch((err) => {
-      this.log(`Failed to collect context: ${err}`);
-    });
+      this.debugLog(`Queued: ${type} \u2014 ${name}`);
+      if (type === "error") this.flush();
+    }).catch((err) => this.debugLog(`Failed to collect context: ${err}`));
   }
   assertInitialized(method) {
     if (!this.initialized) {
       throw new Error(`PulseBoard.${method}() called before PulseBoard.init()`);
     }
   }
-  log(message) {
+  debugLog(message) {
     if (this.config?.debug) {
       console.log(`[PulseBoard] ${message}`);
     }