Revert "temp revert rrweb-io#81"

This reverts commit 835161c.

src/index.ts

@@ -1,4 +1,4 @@
-import record from './record';
+import record, { addCustomEvent } from './record';
 import { Replayer } from './replay';
 import { mirror } from './utils';
 
@@ -8,4 +8,4 @@ export {
  MouseInteractions,
  ReplayerEvents,
 } from './types';
-export { record, Replayer, mirror };
+export { record, addCustomEvent, Replayer, mirror };

src/record/index.ts

@@ -25,6 +25,21 @@ function wrapEvent(e: event): eventWithTime {
 
 let wrappedEmit!: (e: eventWithTime, isCheckout?: boolean) => void;
 
+export function addCustomEvent<T>(tag: string, payload: T) {
+ if (!wrappedEmit) {
+ throw new Error('please add custom event after start recording');
+ }
+ wrappedEmit(
+ wrapEvent({
+ type: EventType.Custom,
+ data: {
+ tag,
+ payload,
+ },
+ }),
+ );
+}
+
 function record(options: recordOptions = {}): listenerHandler | undefined {
  const {
  emit,

test/record.test.ts

@@ -23,6 +23,7 @@ interface ISuite extends Suite {
 interface IWindow extends Window {
  rrweb: {
  record: (options: recordOptions) => listenerHandler | undefined;
+ addCustomEvent<T>(tag: string, payload: T): void;
  };
  emit: (e: eventWithTime) => undefined;
 }
@@ -180,4 +181,19 @@ describe('record', function(this: ISuite) {
  await this.page.waitFor(50);
  assertSnapshot(this.events, __filename, 'async-checkout');
  });
+
+ it('can add custom event', async () => {
+ await this.page.evaluate(() => {
+ const { record, addCustomEvent } = (window as IWindow).rrweb;
+ record({
+ emit: (window as IWindow).emit,
+ });
+ addCustomEvent<number>('tag1', 1);
+ addCustomEvent<{ a: string }>('tag2', {
+ a: 'b',
+ });
+ });
+ await this.page.waitFor(50);
+ assertSnapshot(this.events, __filename, 'custom-event');
+ });
 });

typings/index.d.ts

@@ -1,5 +1,5 @@
-import record from './record';
+import record, { addCustomEvent } from './record';
 import { Replayer } from './replay';
 import { mirror } from './utils';
 export { EventType, IncrementalSource, MouseInteractions, ReplayerEvents, } from './types';
-export { record, Replayer, mirror };
+export { record, addCustomEvent, Replayer, mirror };

typings/record/index.d.ts

@@ -1,3 +1,4 @@
 import { recordOptions, listenerHandler } from '../types';
+export declare function addCustomEvent<T>(tag: string, payload: T): void;
 declare function record(options?: recordOptions): listenerHandler | undefined;
 export default record;