@atlaskit/collab-provider 8.1.0 → 8.2.0

package/dist/esm/socket-io-provider.js

@@ -1,18 +1,15 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
-
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-
 import { Provider } from './provider';
 import { io } from 'socket.io-client';
 import { getProduct, getSubProduct } from './helpers/utils';
 import { SOCKET_IO_OPTIONS } from './config';
 export function createSocketIOSocket(url, auth, productInfo) {
   var _URL = new URL(url),
-      pathname = _URL.pathname; // to limit the reconnection flooding towards collab service, here we set the reconnectionDelayMax to 128s.
-
+    pathname = _URL.pathname;
 
+  // to limit the reconnection flooding towards collab service, here we set the reconnectionDelayMax to 128s.
   return io(url, {
     reconnectionDelayMax: SOCKET_IO_OPTIONS.RECONNECTION_DELAY_MAX,
     reconnectionDelay: SOCKET_IO_OPTIONS.RECONNECTION_DELAY,

package/dist/esm/types.js

@@ -1,6 +1,6 @@
 // Channel
-export var AcknowledgementResponseTypes;
 
+export var AcknowledgementResponseTypes;
 (function (AcknowledgementResponseTypes) {
   AcknowledgementResponseTypes["SUCCESS"] = "SUCCESS";
   AcknowledgementResponseTypes["ERROR"] = "ERROR";

package/dist/esm/version-wrapper.js

@@ -1,5 +1,5 @@
 export var name = "@atlaskit/collab-provider";
-export var version = "8.1.0";
+export var version = "8.2.0";
 export var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "8.1.0",
+	"version": "8.2.0",
 	"sideEffects": false
 }

package/dist/types/channel.d.ts

@@ -15,6 +15,7 @@ export declare class Channel extends Emitter<ChannelEvent> {
      * Connect to collab service using websockets
      */
     connect(): void;
+    private onConnectError;
     private onConnect;
     private onReceiveData;
     fetchCatchup(fromVersion: number): Promise<CatchupResponse>;

package/dist/types/error-code-mapper.d.ts

@@ -29,4 +29,4 @@ export declare const ErrorCodeMapper: {
         message: string;
     };
 };
-export declare const errorCodeMapper: (error: ErrorPayload) => CollabErrorPayload | undefined;
+export declare const errorCodeMapper: (error: ErrorPayload) => CollabErrorPayload;

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

@@ -1,4 +1,4 @@
-import { ErrorPayload } from '../types';
+import { CollabErrorPayload, ErrorPayload } from '../types';
 export declare const EVENT_SUBJECT = "collab";
 export declare enum COLLAB_SERVICE {
     NCS = "ncs",
@@ -12,7 +12,9 @@ export declare enum EVENT_ACTION {
     CONVERT_PM_TO_ADF = "convertPMToADF",
     UPDATE_PARTICIPANTS = "updateParticipants",
     COMMIT_UNCONFIRMED_STEPS = "commitUnconfirmedSteps",
-    REINITIALISE_DOCUMENT = "reinitialiseDocument"
+    REINITIALISE_DOCUMENT = "reinitialiseDocument",
+    INIT_PROVIDER = "initProvider",
+    ERROR = "error"
 }
 export declare enum EVENT_STATUS {
     SUCCESS = "SUCCESS",
@@ -45,6 +47,17 @@ declare type AddStepsFailureAnalyticsEvent = {
         error: ErrorPayload;
     };
 };
+declare type ErrorAnalyticsEvent = {
+    eventAction: EVENT_ACTION.ERROR;
+    attributes: {
+        attemptedAction?: EVENT_ACTION;
+        documentAri: string;
+        mappedError?: CollabErrorPayload;
+    };
+    nonPrivacySafeAttributes: {
+        error: ErrorPayload;
+    };
+};
 export declare type AnalyticsEvent = {
     eventAction: EVENT_ACTION.CONNECTION | EVENT_ACTION.CATCHUP | EVENT_ACTION.DOCUMENT_INIT | EVENT_ACTION.CONVERT_PM_TO_ADF | EVENT_ACTION.UPDATE_PARTICIPANTS | EVENT_ACTION.COMMIT_UNCONFIRMED_STEPS | EVENT_ACTION.REINITIALISE_DOCUMENT;
     attributes: {
@@ -58,7 +71,7 @@ export declare type AnalyticsEvent = {
         requiredPageRecovery?: boolean;
         ttlEnabled?: boolean;
     };
-} | AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent;
+} | AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ErrorAnalyticsEvent;
 export declare const ACK_MAX_TRY = 30;
 export declare const CONFLUENCE = "confluence";
 export {};

package/dist/types/types.d.ts

@@ -1,6 +1,6 @@
 import type { Transaction } from 'prosemirror-state';
 import type { Step } from 'prosemirror-transform';
-import type { CollabParticipant, CollabEventTelepointerData, CollabEventConnectionData, CollabEventInitData, CollabEventRemoteData, CollabEventPresenceData } from '@atlaskit/editor-common/collab';
+import type { CollabParticipant, CollabEventTelepointerData, CollabEventConnectionData, CollabEventInitData, CollabEventRemoteData, CollabEventPresenceData, CollabEventConnectingData } from '@atlaskit/editor-common/collab';
 import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
 import type { Manager } from 'socket.io-client';
 import type { DisconnectReason } from './disconnected-reason-mapper';
@@ -42,6 +42,7 @@ export interface Lifecycle {
     on(event: LifecycleEvents, handler: EventHandler): void;
 }
 export declare type CollabConnectedPayload = CollabEventConnectionData;
+export declare type CollabConnectingPayload = CollabEventConnectingData;
 export interface CollabDisconnectedPayload {
     reason: DisconnectReason;
     sid: string;
@@ -81,6 +82,7 @@ export interface CollabEvents {
     'local-steps': CollabLocalStepsPayload;
     error: CollabErrorPayload;
     entity: any;
+    connecting: CollabConnectingPayload;
 }
 export interface Metadata {
     [key: string]: string | number | boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "8.1.0",
+  "version": "8.2.0",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -21,9 +21,9 @@
     "releaseModel": "scheduled"
   },
   "dependencies": {
-    "@atlaskit/analytics-gas-types": "5.0.9",
+    "@atlaskit/analytics-gas-types": "5.0.10",
     "@atlaskit/analytics-listeners": "^8.5.0",
-    "@atlaskit/editor-common": "^72.2.0",
+    "@atlaskit/editor-common": "^72.4.0",
     "@atlaskit/editor-json-transformer": "^8.8.0",
     "@atlaskit/prosemirror-collab": "^0.1.0",
     "@atlaskit/ufo": "^0.1.4",
@@ -40,14 +40,16 @@
     },
     "@repo/internal": {
       "deprecation": "no-deprecated-imports",
-      "theming": "tokens",
+      "design-tokens": [
+        "color"
+      ],
       "styling": [
         "emotion"
       ]
     }
   },
   "devDependencies": {
-    "@atlaskit/adf-schema": "^25.1.0",
+    "@atlaskit/adf-schema": "^25.2.0",
     "@atlaskit/analytics-gas-types": "^5.0.9",
     "@atlaskit/analytics-listeners": "^8.5.0",
     "@atlaskit/editor-test-helpers": "^18.0.0",

package/report.api.md

@@ -17,6 +17,7 @@
 ```ts
 import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
 import type { CollabEditProvider } from '@atlaskit/editor-common/collab';
+import type { CollabEventConnectingData } from '@atlaskit/editor-common/collab';
 import type { CollabEventConnectionData } from '@atlaskit/editor-common/collab';
 import type { CollabEventInitData } from '@atlaskit/editor-common/collab';
 import type { CollabEventPresenceData } from '@atlaskit/editor-common/collab';
@@ -39,6 +40,9 @@ type BaseEvents = Pick<
 // @public (undocumented)
 export type CollabConnectedPayload = CollabEventConnectionData;
 
+// @public (undocumented)
+type CollabConnectingPayload = CollabEventConnectingData;
+
 // @public (undocumented)
 export interface CollabDataPayload extends CollabEventRemoteData {
   // (undocumented)
@@ -78,6 +82,8 @@ export interface CollabEvents {
   // (undocumented)
   connected: CollabConnectedPayload;
   // (undocumented)
+  connecting: CollabConnectingPayload;
+  // (undocumented)
   data: CollabDataPayload;
   // (undocumented)
   disconnected: CollabDisconnectedPayload;