@anyreplay/browser 0.1.1 → 0.1.3

package/dist/index.d.cts

@@ -5,8 +5,42 @@ interface AnyReplayOptions {
     ingestUrl?: string;
     /** Fraction of visitors recorded, 0–1. Decided once per visitor, not per page. */
     sampleRate?: number;
-    /** Mask every text input. Leaving this on is the supported configuration. */
+    /**
+     * Mask the value of every form control.
+     *
+     * Off by default: a recording shows what a visitor typed into inputs,
+     * textareas and rich-text editors, because a replay of a form nobody could
+     * finish is worth watching only if you can see what they were trying to put
+     * in it. Turn this on for a site whose forms carry anything you would not
+     * want a teammate to read, and mark individual fields with the `maskClass`
+     * when it is only some of them.
+     *
+     * Some fields are masked whatever this says, in every mode: passwords,
+     * one-time codes, payment fields (card number, CVV, expiry, IBAN, routing
+     * number, sort code), anything inside an element with the mask class, and any
+     * value that looks like a card number. Email and telephone fields are not on
+     * that list — they are ordinary fields, recorded by default and masked by this
+     * option. See `isSensitiveField` in `masking.ts` for the exact list.
+     */
     maskAllInputs?: boolean;
+    /**
+     * Mask everything a person types, wherever they type it.
+     *
+     * `maskAllInputs` covers form controls. This covers those *and* the other
+     * place a person can type — an element with `contenteditable`, which is what
+     * a rich-text editor, a comment box or a chat composer is made of. Their text
+     * is not an input value but ordinary page text, so input masking does not
+     * reach it. With this on, the text of every editable region is replaced with
+     * asterisks in the first snapshot and in every change after it.
+     *
+     * The stricter of the two options, and a superset of it: `maskAllTyping: true`
+     * masks form fields too, whatever `maskAllInputs` says. It is separate
+     * because masking an editable region masks *all* of its text, including
+     * whatever the page put there before anyone typed — a loaded document, a
+     * quoted message — which is a bigger thing to ask for than hiding field
+     * values.
+     */
+    maskAllTyping?: boolean;
     /** Elements with this class have their text masked. */
     maskClass?: string;
     /** Elements with this class are not recorded at all. */
@@ -40,14 +74,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 +234,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 +272,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

@@ -5,8 +5,42 @@ interface AnyReplayOptions {
     ingestUrl?: string;
     /** Fraction of visitors recorded, 0–1. Decided once per visitor, not per page. */
     sampleRate?: number;
-    /** Mask every text input. Leaving this on is the supported configuration. */
+    /**
+     * Mask the value of every form control.
+     *
+     * Off by default: a recording shows what a visitor typed into inputs,
+     * textareas and rich-text editors, because a replay of a form nobody could
+     * finish is worth watching only if you can see what they were trying to put
+     * in it. Turn this on for a site whose forms carry anything you would not
+     * want a teammate to read, and mark individual fields with the `maskClass`
+     * when it is only some of them.
+     *
+     * Some fields are masked whatever this says, in every mode: passwords,
+     * one-time codes, payment fields (card number, CVV, expiry, IBAN, routing
+     * number, sort code), anything inside an element with the mask class, and any
+     * value that looks like a card number. Email and telephone fields are not on
+     * that list — they are ordinary fields, recorded by default and masked by this
+     * option. See `isSensitiveField` in `masking.ts` for the exact list.
+     */
     maskAllInputs?: boolean;
+    /**
+     * Mask everything a person types, wherever they type it.
+     *
+     * `maskAllInputs` covers form controls. This covers those *and* the other
+     * place a person can type — an element with `contenteditable`, which is what
+     * a rich-text editor, a comment box or a chat composer is made of. Their text
+     * is not an input value but ordinary page text, so input masking does not
+     * reach it. With this on, the text of every editable region is replaced with
+     * asterisks in the first snapshot and in every change after it.
+     *
+     * The stricter of the two options, and a superset of it: `maskAllTyping: true`
+     * masks form fields too, whatever `maskAllInputs` says. It is separate
+     * because masking an editable region masks *all* of its text, including
+     * whatever the page put there before anyone typed — a loaded document, a
+     * quoted message — which is a bigger thing to ask for than hiding field
+     * values.
+     */
+    maskAllTyping?: boolean;
     /** Elements with this class have their text masked. */
     maskClass?: string;
     /** Elements with this class are not recorded at all. */
@@ -40,14 +74,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 +234,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 +272,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 };