@anyreplay/browser 0.1.0 → 0.1.2

package/dist/index.d.cts

@@ -40,14 +40,15 @@ declare class ConfigError extends Error {
 declare function resolveOptions(input: AnyReplayOptions): ResolvedOptions;
 
 type RecorderStatus = 'idle' | 'awaiting-consent' | 'recording' | 'sampled-out' | 'stopped';
+interface IdentifyTraits {
+    userId?: string;
+    email?: string;
+}
 interface RecorderHandle {
     status: () => RecorderStatus;
     sessionId: () => string | null;
     consent: (granted: boolean) => void;
-    identify: (traits: {
-        userId?: string;
-        email?: string;
-    }) => void;
+    identify: (traits: IdentifyTraits) => void;
     /**
      * Tags this moment of the recording so it shows on the player's timeline.
      *
@@ -199,6 +200,18 @@ interface Identity {
  * id resets after a period of inactivity.
  */
 declare function resolveIdentity(local: Storage, session: Storage, now?: number): Identity;
+/**
+ * Removes everything the recorder has stored in this browser.
+ *
+ * Called when consent is refused. A refusal has to undo an earlier acceptance,
+ * not merely stop the current page: the visitor id written last week is
+ * exactly what the visitor is now saying no to, and leaving it in place would
+ * make "we store nothing without consent" untrue for as long as it sat there.
+ * The cool-down goes too — it is a fact about a session that no longer exists.
+ * Removing a key that is not there creates nothing, so this is safe to call
+ * before anything was ever written.
+ */
+declare function forgetVisitor(local: Storage, session: Storage): void;
 
 /**
  * Custom events: the moments a page tags with `track()`.
@@ -225,4 +238,4 @@ interface TrackPayload {
  */
 declare function validateTrack(name: unknown, properties: unknown): TrackPayload | string;
 
-export { type AnyReplayOptions, ConfigError, DEFAULTS, EVENT_NAME_PATTERN, MAX_PROPERTIES_BYTES, NAVIGATE_TAG, type RecordedEvent, type RecorderHandle, type RecorderStatus, type ResolvedOptions, type SessionMeta, TRACK_TAG, type TrackPayload, Transport, createRecorder, hashToUnitInterval, isSampledIn, resolveIdentity, resolveOptions, safeStorage, uuidv4, validateTrack };
+export { type AnyReplayOptions, ConfigError, DEFAULTS, EVENT_NAME_PATTERN, MAX_PROPERTIES_BYTES, NAVIGATE_TAG, type RecordedEvent, type RecorderHandle, type RecorderStatus, type ResolvedOptions, type SessionMeta, TRACK_TAG, type TrackPayload, Transport, createRecorder, forgetVisitor, hashToUnitInterval, isSampledIn, resolveIdentity, resolveOptions, safeStorage, uuidv4, validateTrack };

package/dist/index.d.ts

@@ -40,14 +40,15 @@ declare class ConfigError extends Error {
 declare function resolveOptions(input: AnyReplayOptions): ResolvedOptions;
 
 type RecorderStatus = 'idle' | 'awaiting-consent' | 'recording' | 'sampled-out' | 'stopped';
+interface IdentifyTraits {
+    userId?: string;
+    email?: string;
+}
 interface RecorderHandle {
     status: () => RecorderStatus;
     sessionId: () => string | null;
     consent: (granted: boolean) => void;
-    identify: (traits: {
-        userId?: string;
-        email?: string;
-    }) => void;
+    identify: (traits: IdentifyTraits) => void;
     /**
      * Tags this moment of the recording so it shows on the player's timeline.
      *
@@ -199,6 +200,18 @@ interface Identity {
  * id resets after a period of inactivity.
  */
 declare function resolveIdentity(local: Storage, session: Storage, now?: number): Identity;
+/**
+ * Removes everything the recorder has stored in this browser.
+ *
+ * Called when consent is refused. A refusal has to undo an earlier acceptance,
+ * not merely stop the current page: the visitor id written last week is
+ * exactly what the visitor is now saying no to, and leaving it in place would
+ * make "we store nothing without consent" untrue for as long as it sat there.
+ * The cool-down goes too — it is a fact about a session that no longer exists.
+ * Removing a key that is not there creates nothing, so this is safe to call
+ * before anything was ever written.
+ */
+declare function forgetVisitor(local: Storage, session: Storage): void;
 
 /**
  * Custom events: the moments a page tags with `track()`.
@@ -225,4 +238,4 @@ interface TrackPayload {
  */
 declare function validateTrack(name: unknown, properties: unknown): TrackPayload | string;
 
-export { type AnyReplayOptions, ConfigError, DEFAULTS, EVENT_NAME_PATTERN, MAX_PROPERTIES_BYTES, NAVIGATE_TAG, type RecordedEvent, type RecorderHandle, type RecorderStatus, type ResolvedOptions, type SessionMeta, TRACK_TAG, type TrackPayload, Transport, createRecorder, hashToUnitInterval, isSampledIn, resolveIdentity, resolveOptions, safeStorage, uuidv4, validateTrack };
+export { type AnyReplayOptions, ConfigError, DEFAULTS, EVENT_NAME_PATTERN, MAX_PROPERTIES_BYTES, NAVIGATE_TAG, type RecordedEvent, type RecorderHandle, type RecorderStatus, type ResolvedOptions, type SessionMeta, TRACK_TAG, type TrackPayload, Transport, createRecorder, forgetVisitor, hashToUnitInterval, isSampledIn, resolveIdentity, resolveOptions, safeStorage, uuidv4, validateTrack };