iris-recorder 0.3.0 → 0.4.0

package/dist/index.d.ts

@@ -1,3 +1,12 @@
+/**
+ * App-supplied user identity: string values, or nested objects of the same
+ * shape. Deliberately small — the SDK enforces depth/key/size budgets before
+ * anything leaves the page.
+ */
+type IrisUser = {
+    [key: string]: string | IrisUser;
+};
+
 interface TrackOptions {
     /** per-session budget of tracked events — a loop can't flood the session (default 500) */
     maxEvents?: number;
@@ -55,7 +64,10 @@ interface RecordConfig {
     projectKey: string;
     /** build identifier, used to match source maps. Pass your git SHA. */
     release?: string;
-    /** app-supplied user identity for this session */
+    /** app-supplied user identity for this session — a small object of string
+        (or nested) values, e.g. `{ id: 'staff-042', name: 'Daisy', station: { till: 'till-3' } }` */
+    user?: IrisUser;
+    /** legacy string form of `user` — still supported; same as `user: { id: … }` */
     userId?: string;
     replay?: boolean;
     errors?: boolean;
@@ -81,8 +93,9 @@ interface IrisHandle {
     stop: () => void;
     /** Force an immediate flush. */
     flush: () => void;
-    /** Attach the signed-in user to this session (applies from the next flush). */
-    identify: (userId: string) => void;
+    /** Attach the signed-in user to this session (applies from the next flush).
+        Takes a small user object — or a plain string id, the legacy form. */
+    identify: (user: string | IrisUser) => void;
     /**
      * Record an app-defined business event, e.g.
      * `iris.track('receipt_printed', { total: 42.5 })`. Props are masked with
@@ -100,4 +113,4 @@ interface IrisHandle {
  */
 declare function record(config: RecordConfig): IrisHandle;
 
-export { type ConsoleOptions, type IrisHandle, type NetworkOptions, type RecordConfig, type TrackOptions, record };
+export { type ConsoleOptions, type IrisHandle, type IrisUser, type NetworkOptions, type RecordConfig, type TrackOptions, record };