@atlaskit/collab-provider 7.4.2 → 7.4.3

package/dist/types/analytics/index.d.ts

@@ -1,9 +1,5 @@
 import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
 import { GasPurePayload } from '@atlaskit/analytics-gas-types';
-import { ErrorPayload } from '../types';
-export declare const buildAnalyticsPayload: (subject: string, payload?: any) => GasPurePayload;
-export declare const fireAnalyticsEvent: (analyticsClient?: AnalyticsWebClient | undefined, analyticsEvent?: GasPurePayload | undefined) => void;
-export declare const triggerAnalyticsForStepsAddedSuccessfully: (analyticsClient?: AnalyticsWebClient | undefined) => void;
-export declare const triggerAnalyticsForStepsRejected: (analyticsClient?: AnalyticsWebClient | undefined, error?: ErrorPayload | undefined) => void;
-export declare const triggerAnalyticsForCatchupFailed: (analyticsClient?: AnalyticsWebClient | undefined, error?: ErrorPayload | undefined) => void;
-export declare const triggerAnalyticsForCatchupSuccessfulWithLatency: (analyticsClient?: AnalyticsWebClient | undefined, latency?: number | undefined) => void;
+import { AnalyticsEvent } from '../helpers/const';
+export declare const fireAnalyticsEvent: (analyticsClient?: AnalyticsWebClient | undefined, payload?: GasPurePayload | undefined) => void;
+export declare const triggerCollabAnalyticsEvent: (analyticsEvent: AnalyticsEvent, analyticsClient?: AnalyticsWebClient | undefined) => void;

package/dist/types/analytics/performance.d.ts

@@ -1,5 +1,8 @@
-declare type MeasureName = 'callingCatchupApi';
+declare type MeasureName = 'callingCatchupApi' | 'socketConnect' | 'documentInit';
 export declare function startMeasure(measureName: MeasureName): void;
-export declare function stopMeasure(measureName: MeasureName, onMeasureComplete?: (duration: number, startTime: number) => void): void;
+export declare function stopMeasure(measureName: MeasureName, onMeasureComplete?: (duration: number, startTime: number) => void): {
+    duration: number;
+    startTime: number;
+} | undefined;
 export declare function clearMeasure(measureName: string): void;
 export {};

package/dist/types/helpers/const.d.ts

@@ -1,6 +1,23 @@
-export declare const STEPS_ADDED = "collabStepsAddedSuccess";
-export declare const STEPS_REJECTED = "collabStepsAddedRejected";
+import { ErrorPayload } from '../types';
 export declare const ATTRIBUTES_PACKAGE = "collabProvider";
-export declare const CATCHUP_SUCCESS = "collabCatchupSuccess";
-export declare const CATCHUP_FAILURE = "collabCatchupFailure";
+export declare const EVENT_SUBJECT = "collab";
+export declare enum EVENT_ACTION {
+    CONNECTION = "connection",
+    CATCHUP = "catchup",
+    DOCUMENT_INIT = "documentInit",
+    ADD_STEPS = "addSteps"
+}
+export declare enum EVENT_STATUS {
+    SUCCESS = "SUCCESS",
+    FAILURE = "FAILURE"
+}
+export declare type AnalyticsEvent = {
+    eventAction: EVENT_ACTION;
+    attributes: {
+        eventStatus: EVENT_STATUS;
+        meetsSLO?: boolean;
+        latency?: number;
+        error?: ErrorPayload;
+    };
+};
 export declare const ACK_MAX_TRY = 10;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "7.4.2",
+  "version": "7.4.3",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"