@drakkar.software/sunglasses-core 0.2.0 → 0.3.0

package/dist/index.d.mts

@@ -477,6 +477,23 @@ type EventMap = Record<string, Record<string, unknown> | undefined>;
 interface ISunglassesTypedClient<T extends EventMap> extends ISunglassesClient {
     capture<K extends keyof T & string>(eventName: K, ...args: T[K] extends undefined ? [properties?: Record<string, unknown>] : [properties: T[K]]): void;
 }
+/**
+ * Standard properties emitted by error-capturing adapters as `$error` events.
+ * Shared by `@drakkar.software/sunglasses-adapter-sentry`,
+ * `@drakkar.software/sunglasses-adapter-posthog`, and `SunglassesErrorBoundary`.
+ */
+interface ErrorEventProperties {
+    $error_message: string;
+    $error_type: string;
+    /** `true` when caught by an error boundary / try-catch; `false` for unhandled errors. */
+    $error_handled: boolean;
+    /** Sentry-compatible severity level. Usually `'error'`. */
+    $error_level: string;
+    /** Optional stringified stack trace. Disabled by default for privacy. */
+    $error_stack?: string;
+    /** Allows adapter-specific extension properties (e.g. from `beforeCapture`). */
+    [key: string]: unknown;
+}
 interface ScreenTrackingOptions {
     /** Web: listen to history.pushState / replaceState / popstate. Default: true. */
     useHistoryApi?: boolean;
@@ -1090,4 +1107,4 @@ declare function sha256Hex(input: string): Promise<string>;
  */
 declare function nowISO(): string;
 
-export { type CleanupConfig, type ConsentHistoryEntry, ConsentManager, type ConsentState, type ConsentStatus, type EventContext, type EventCountPeriod, EventCounter, type EventMap, EventQueue, type EventType, FrequencyMiddleware, type FrequencyMiddlewareOptions, type HttpAdapterConfig, type IAnalyticsAdapter, type IEventCounter, type IMiddleware, type IStorageAdapter, type ISunglassesClient, type ISunglassesTypedClient, IdentityManager, type IdentityState, LocalEventArchive, type Logger, type MiddlewareNext, MiddlewarePipeline, PiiSanitizer, SamplingMiddleware, type SamplingMiddlewareOptions, type ScreenTrackingOptions, SessionManager, type SessionState, type StarfishAdapterConfig, type SunglassesConfig, SunglassesCore, type SunglassesEvent, TraitManager, type UserDataExport, asTyped, createLogger, generateUUID, nowISO, sha256Hex };
+export { type CleanupConfig, type ConsentHistoryEntry, ConsentManager, type ConsentState, type ConsentStatus, type ErrorEventProperties, type EventContext, type EventCountPeriod, EventCounter, type EventMap, EventQueue, type EventType, FrequencyMiddleware, type FrequencyMiddlewareOptions, type HttpAdapterConfig, type IAnalyticsAdapter, type IEventCounter, type IMiddleware, type IStorageAdapter, type ISunglassesClient, type ISunglassesTypedClient, IdentityManager, type IdentityState, LocalEventArchive, type Logger, type MiddlewareNext, MiddlewarePipeline, PiiSanitizer, SamplingMiddleware, type SamplingMiddlewareOptions, type ScreenTrackingOptions, SessionManager, type SessionState, type StarfishAdapterConfig, type SunglassesConfig, SunglassesCore, type SunglassesEvent, TraitManager, type UserDataExport, asTyped, createLogger, generateUUID, nowISO, sha256Hex };

package/dist/index.d.ts

@@ -477,6 +477,23 @@ type EventMap = Record<string, Record<string, unknown> | undefined>;
 interface ISunglassesTypedClient<T extends EventMap> extends ISunglassesClient {
     capture<K extends keyof T & string>(eventName: K, ...args: T[K] extends undefined ? [properties?: Record<string, unknown>] : [properties: T[K]]): void;
 }
+/**
+ * Standard properties emitted by error-capturing adapters as `$error` events.
+ * Shared by `@drakkar.software/sunglasses-adapter-sentry`,
+ * `@drakkar.software/sunglasses-adapter-posthog`, and `SunglassesErrorBoundary`.
+ */
+interface ErrorEventProperties {
+    $error_message: string;
+    $error_type: string;
+    /** `true` when caught by an error boundary / try-catch; `false` for unhandled errors. */
+    $error_handled: boolean;
+    /** Sentry-compatible severity level. Usually `'error'`. */
+    $error_level: string;
+    /** Optional stringified stack trace. Disabled by default for privacy. */
+    $error_stack?: string;
+    /** Allows adapter-specific extension properties (e.g. from `beforeCapture`). */
+    [key: string]: unknown;
+}
 interface ScreenTrackingOptions {
     /** Web: listen to history.pushState / replaceState / popstate. Default: true. */
     useHistoryApi?: boolean;
@@ -1090,4 +1107,4 @@ declare function sha256Hex(input: string): Promise<string>;
  */
 declare function nowISO(): string;
 
-export { type CleanupConfig, type ConsentHistoryEntry, ConsentManager, type ConsentState, type ConsentStatus, type EventContext, type EventCountPeriod, EventCounter, type EventMap, EventQueue, type EventType, FrequencyMiddleware, type FrequencyMiddlewareOptions, type HttpAdapterConfig, type IAnalyticsAdapter, type IEventCounter, type IMiddleware, type IStorageAdapter, type ISunglassesClient, type ISunglassesTypedClient, IdentityManager, type IdentityState, LocalEventArchive, type Logger, type MiddlewareNext, MiddlewarePipeline, PiiSanitizer, SamplingMiddleware, type SamplingMiddlewareOptions, type ScreenTrackingOptions, SessionManager, type SessionState, type StarfishAdapterConfig, type SunglassesConfig, SunglassesCore, type SunglassesEvent, TraitManager, type UserDataExport, asTyped, createLogger, generateUUID, nowISO, sha256Hex };
+export { type CleanupConfig, type ConsentHistoryEntry, ConsentManager, type ConsentState, type ConsentStatus, type ErrorEventProperties, type EventContext, type EventCountPeriod, EventCounter, type EventMap, EventQueue, type EventType, FrequencyMiddleware, type FrequencyMiddlewareOptions, type HttpAdapterConfig, type IAnalyticsAdapter, type IEventCounter, type IMiddleware, type IStorageAdapter, type ISunglassesClient, type ISunglassesTypedClient, IdentityManager, type IdentityState, LocalEventArchive, type Logger, type MiddlewareNext, MiddlewarePipeline, PiiSanitizer, SamplingMiddleware, type SamplingMiddlewareOptions, type ScreenTrackingOptions, SessionManager, type SessionState, type StarfishAdapterConfig, type SunglassesConfig, SunglassesCore, type SunglassesEvent, TraitManager, type UserDataExport, asTyped, createLogger, generateUUID, nowISO, sha256Hex };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@drakkar.software/sunglasses-core",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Platform-agnostic event tracking engine for SunGlasses",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",