@atlaskit/collab-provider 16.0.0 → 16.0.2

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/collab-provider
 
+## 16.0.2
+
+### Patch Changes
+
+- [`224048d036344`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/224048d036344) -
+  EDITOR-5683 do not rethrow setMetadataError: Cannot send metadata, currently offline and
+  setMetadataError: Cannot send metadata, not initialized yet as they are intermittent connection
+  errors
+- Updated dependencies
+
+## 16.0.1
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 16.0.0
 
 ### Patch Changes

package/dist/cjs/helpers/utils.js

@@ -32,6 +32,8 @@ var createLogger = exports.createLogger = function createLogger(prefix) {
     }
   );
 };
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 function sleep(ms) {
   return new Promise(function (resolve) {
     setTimeout(resolve, ms);

package/dist/cjs/provider/index.js

@@ -756,6 +756,11 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
       } catch (error) {
         var _this$analyticsHelper13;
         (_this$analyticsHelper13 = this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 || _this$analyticsHelper13.sendErrorEvent(error, 'Error while setting metadata');
+        // Don't re-throw for transient connectivity/initialization errors.
+        // (e.g. socket not yet ready, user momentarily offline)
+        if ((error instanceof _customErrors.NotInitializedError || error instanceof _customErrors.NotConnectedError) && (0, _expValEquals.expValEquals)('platform_editor_ignore_metadata_connection_errors', 'isEnabled', true)) {
+          return;
+        }
         throw new _customErrors.SetMetadataError('Error while setting metadata', error);
       }
     }

package/dist/cjs/version-wrapper.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = exports.nextMajorVersion = exports.name = void 0;
 var name = exports.name = "@atlaskit/collab-provider";
-var version = exports.version = "0.0.0-development";
+var version = exports.version = "16.0.1";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/helpers/utils.js

@@ -12,6 +12,8 @@ export const createLogger = (prefix, color = 'blue') =>
     console.log(`%cCollab-${prefix}: ${msg}`, `color: ${color}; font-weight: bold`, data);
   }
 };
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function sleep(ms) {
   return new Promise(resolve => {
     setTimeout(resolve, ms);

package/dist/es2019/provider/index.js

@@ -8,7 +8,7 @@ import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { createLogger, logObfuscatedSteps } from '../helpers/utils';
 import AnalyticsHelper from '../analytics/analytics-helper';
 import { telepointerCallback } from '../participants/telepointers-helper';
-import { CustomError, DestroyError, GetCurrentStateError, GetFinalAcknowledgedStateError, ProviderInitialisationError, SendTransactionError, SetEditorWidthError, SetMetadataError, SetTitleError } from '../errors/custom-errors';
+import { CustomError, DestroyError, GetCurrentStateError, GetFinalAcknowledgedStateError, NotConnectedError, NotInitializedError, ProviderInitialisationError, SendTransactionError, SetEditorWidthError, SetMetadataError, SetTitleError } from '../errors/custom-errors';
 import { NCS_ERROR_CODE } from '../errors/ncs-errors';
 import { MetadataService } from '../metadata/metadata-service';
 import { DocumentService } from '../document/document-service';
@@ -646,6 +646,11 @@ export class Provider extends Emitter {
     } catch (error) {
       var _this$analyticsHelper15;
       (_this$analyticsHelper15 = this.analyticsHelper) === null || _this$analyticsHelper15 === void 0 ? void 0 : _this$analyticsHelper15.sendErrorEvent(error, 'Error while setting metadata');
+      // Don't re-throw for transient connectivity/initialization errors.
+      // (e.g. socket not yet ready, user momentarily offline)
+      if ((error instanceof NotInitializedError || error instanceof NotConnectedError) && expValEquals('platform_editor_ignore_metadata_connection_errors', 'isEnabled', true)) {
+        return;
+      }
       throw new SetMetadataError('Error while setting metadata', error);
     }
   }

package/dist/es2019/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/collab-provider";
-export const version = "0.0.0-development";
+export const version = "16.0.1";
 export const nextMajorVersion = () => {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/esm/helpers/utils.js

@@ -22,6 +22,8 @@ export var createLogger = function createLogger(prefix) {
     }
   );
 };
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function sleep(ms) {
   return new Promise(function (resolve) {
     setTimeout(resolve, ms);

package/dist/esm/provider/index.js

@@ -21,7 +21,7 @@ import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
 import { createLogger, logObfuscatedSteps } from '../helpers/utils';
 import AnalyticsHelper from '../analytics/analytics-helper';
 import { telepointerCallback } from '../participants/telepointers-helper';
-import { CustomError, DestroyError, GetCurrentStateError, GetFinalAcknowledgedStateError, ProviderInitialisationError, SendTransactionError, SetEditorWidthError, SetMetadataError, SetTitleError } from '../errors/custom-errors';
+import { CustomError, DestroyError, GetCurrentStateError, GetFinalAcknowledgedStateError, NotConnectedError, NotInitializedError, ProviderInitialisationError, SendTransactionError, SetEditorWidthError, SetMetadataError, SetTitleError } from '../errors/custom-errors';
 import { NCS_ERROR_CODE } from '../errors/ncs-errors';
 import { MetadataService } from '../metadata/metadata-service';
 import { DocumentService } from '../document/document-service';
@@ -750,6 +750,11 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       } catch (error) {
         var _this$analyticsHelper13;
         (_this$analyticsHelper13 = this.analyticsHelper) === null || _this$analyticsHelper13 === void 0 || _this$analyticsHelper13.sendErrorEvent(error, 'Error while setting metadata');
+        // Don't re-throw for transient connectivity/initialization errors.
+        // (e.g. socket not yet ready, user momentarily offline)
+        if ((error instanceof NotInitializedError || error instanceof NotConnectedError) && expValEquals('platform_editor_ignore_metadata_connection_errors', 'isEnabled', true)) {
+          return;
+        }
         throw new SetMetadataError('Error while setting metadata', error);
       }
     }

package/dist/esm/version-wrapper.js

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

package/dist/types/document/document-service.d.ts

@@ -11,6 +11,8 @@ import type { InternalError } from '../errors/internal-errors';
 import { type ParticipantsService } from '../participants/participants-service';
 import { type DocumentServiceInterface } from './interface-document-service';
 import type { GetResolvedEditorStateReason } from '@atlaskit/editor-common/types';
+import type { ADFEntity } from '@atlaskit/adf-utils/types';
+import type { DebouncedFunc } from 'lodash';
 /**
  *
  */
@@ -67,7 +69,7 @@ export declare class DocumentService implements DocumentServiceInterface {
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      * @param reason - optional reason to attach.
      */
-    throttledCatchupv2: import("lodash").DebouncedFunc<(reason?: CatchupEventReason, reconnectionMetadata?: ReconnectionMetadata, sessionId?: string) => Promise<void>>;
+    throttledCatchupv2: DebouncedFunc<(reason?: CatchupEventReason, reconnectionMetadata?: ReconnectionMetadata, sessionId?: string) => Promise<void>>;
     /**
      * Called when:
      *   * session established(offline -> online)
@@ -107,7 +109,7 @@ export declare class DocumentService implements DocumentServiceInterface {
                 type: string;
                 contentTypes: string | null;
             };
-            stepContent: import("@atlaskit/adf-utils/types").ADFEntity[] | null;
+            stepContent: ADFEntity[] | null;
             stepPositions: {
                 pos?: number | undefined;
                 insert?: number | undefined;
@@ -128,7 +130,7 @@ export declare class DocumentService implements DocumentServiceInterface {
                 unconfirmedStepAfterRecovery?: boolean;
             } | undefined;
         }[];
-        obfuscatedDoc: string | import("@atlaskit/adf-utils/types").ADFEntity | null | undefined;
+        obfuscatedDoc: string | ADFEntity | null | undefined;
     };
     onRestore: ({ doc, version, metadata, targetClientId, }: CollabInitPayload) => Promise<void>;
     getFinalAcknowledgedState: (reason: GetResolvedEditorStateReason) => Promise<ResolvedEditorState>;

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

@@ -7,7 +7,7 @@ import { type JSONDocNode } from '@atlaskit/editor-json-transformer';
 import { type Node as ProseMirrorNode } from '@atlaskit/editor-prosemirror/model';
 import { CustomError } from '../errors/custom-errors';
 export declare const createLogger: (prefix: string, color?: string) => (msg: string, data?: any) => void;
-export declare function sleep(ms: number): Promise<unknown>;
+export declare function sleep(ms: number): Promise<any>;
 export declare const isAIProviderID: (id: string) => boolean;
 export declare const getProduct: (productInfo?: ProductInformation) => string;
 export declare const getSubProduct: (productInfo?: ProductInformation) => string;

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

@@ -2,7 +2,7 @@ import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/stat
 import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import { Emitter } from '../emitter';
 import type { Config } from '../types';
-import type { CollabEditProvider, CollabEvents, CollabTelepointerPayload, ResolvedEditorState, Metadata, SyncUpErrorFunction, CollabPresenceActivityChangePayload, CollabActivityAIProviderChangedPayload } from '@atlaskit/editor-common/collab';
+import type { CollabEditProvider, CollabEvents, CollabTelepointerPayload, ResolvedEditorState, Metadata, SyncUpErrorFunction, CollabPresenceActivityChangePayload, CollabActivityAIProviderChangedPayload, ProviderParticipant } from '@atlaskit/editor-common/collab';
 import { Api } from '../api/api';
 import { NullApi } from '../api/null-api';
 import type { GetResolvedEditorStateReason } from '@atlaskit/editor-common/types';
@@ -173,11 +173,11 @@ export declare class Provider extends Emitter<CollabEvents> implements CollabEdi
      * Used when the provider is disconnected or destroyed to prevent perpetual timers from continuously running
      */
     private clearTimers;
-    getParticipants: () => import("@atlaskit/editor-common/collab").ProviderParticipant[];
+    getParticipants: () => ProviderParticipant[];
     getUniqueParticipantSize: () => number;
-    getUniqueParticipants: () => import("@atlaskit/editor-common/collab").ProviderParticipant[];
-    getUniqueHydratedParticipants: () => import("@atlaskit/editor-common/collab").ProviderParticipant[];
-    getAIProviderParticipants: () => import("@atlaskit/editor-common/collab").ProviderParticipant[];
+    getUniqueParticipants: () => ProviderParticipant[];
+    getUniqueHydratedParticipants: () => ProviderParticipant[];
+    getAIProviderParticipants: () => ProviderParticipant[];
     fetchMore: (props?: {
         fetchSize?: number;
     }) => Promise<void>;

package/dist/types-ts4.5/document/document-service.d.ts

@@ -11,6 +11,8 @@ import type { InternalError } from '../errors/internal-errors';
 import { type ParticipantsService } from '../participants/participants-service';
 import { type DocumentServiceInterface } from './interface-document-service';
 import type { GetResolvedEditorStateReason } from '@atlaskit/editor-common/types';
+import type { ADFEntity } from '@atlaskit/adf-utils/types';
+import type { DebouncedFunc } from 'lodash';
 /**
  *
  */
@@ -67,7 +69,7 @@ export declare class DocumentService implements DocumentServiceInterface {
      * To prevent calling catchup to often, use lodash throttle to reduce the frequency
      * @param reason - optional reason to attach.
      */
-    throttledCatchupv2: import("lodash").DebouncedFunc<(reason?: CatchupEventReason, reconnectionMetadata?: ReconnectionMetadata, sessionId?: string) => Promise<void>>;
+    throttledCatchupv2: DebouncedFunc<(reason?: CatchupEventReason, reconnectionMetadata?: ReconnectionMetadata, sessionId?: string) => Promise<void>>;
     /**
      * Called when:
      *   * session established(offline -> online)
@@ -107,7 +109,7 @@ export declare class DocumentService implements DocumentServiceInterface {
                 type: string;
                 contentTypes: string | null;
             };
-            stepContent: import("@atlaskit/adf-utils/types").ADFEntity[] | null;
+            stepContent: ADFEntity[] | null;
             stepPositions: {
                 pos?: number | undefined;
                 insert?: number | undefined;
@@ -128,7 +130,7 @@ export declare class DocumentService implements DocumentServiceInterface {
                 unconfirmedStepAfterRecovery?: boolean;
             } | undefined;
         }[];
-        obfuscatedDoc: string | import("@atlaskit/adf-utils/types").ADFEntity | null | undefined;
+        obfuscatedDoc: string | ADFEntity | null | undefined;
     };
     onRestore: ({ doc, version, metadata, targetClientId, }: CollabInitPayload) => Promise<void>;
     getFinalAcknowledgedState: (reason: GetResolvedEditorStateReason) => Promise<ResolvedEditorState>;

package/dist/types-ts4.5/helpers/utils.d.ts

@@ -7,7 +7,7 @@ import { type JSONDocNode } from '@atlaskit/editor-json-transformer';
 import { type Node as ProseMirrorNode } from '@atlaskit/editor-prosemirror/model';
 import { CustomError } from '../errors/custom-errors';
 export declare const createLogger: (prefix: string, color?: string) => (msg: string, data?: any) => void;
-export declare function sleep(ms: number): Promise<unknown>;
+export declare function sleep(ms: number): Promise<any>;
 export declare const isAIProviderID: (id: string) => boolean;
 export declare const getProduct: (productInfo?: ProductInformation) => string;
 export declare const getSubProduct: (productInfo?: ProductInformation) => string;

package/dist/types-ts4.5/provider/index.d.ts

@@ -2,7 +2,7 @@ import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/stat
 import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
 import { Emitter } from '../emitter';
 import type { Config } from '../types';
-import type { CollabEditProvider, CollabEvents, CollabTelepointerPayload, ResolvedEditorState, Metadata, SyncUpErrorFunction, CollabPresenceActivityChangePayload, CollabActivityAIProviderChangedPayload } from '@atlaskit/editor-common/collab';
+import type { CollabEditProvider, CollabEvents, CollabTelepointerPayload, ResolvedEditorState, Metadata, SyncUpErrorFunction, CollabPresenceActivityChangePayload, CollabActivityAIProviderChangedPayload, ProviderParticipant } from '@atlaskit/editor-common/collab';
 import { Api } from '../api/api';
 import { NullApi } from '../api/null-api';
 import type { GetResolvedEditorStateReason } from '@atlaskit/editor-common/types';
@@ -173,11 +173,11 @@ export declare class Provider extends Emitter<CollabEvents> implements CollabEdi
      * Used when the provider is disconnected or destroyed to prevent perpetual timers from continuously running
      */
     private clearTimers;
-    getParticipants: () => import("@atlaskit/editor-common/collab").ProviderParticipant[];
+    getParticipants: () => ProviderParticipant[];
     getUniqueParticipantSize: () => number;
-    getUniqueParticipants: () => import("@atlaskit/editor-common/collab").ProviderParticipant[];
-    getUniqueHydratedParticipants: () => import("@atlaskit/editor-common/collab").ProviderParticipant[];
-    getAIProviderParticipants: () => import("@atlaskit/editor-common/collab").ProviderParticipant[];
+    getUniqueParticipants: () => ProviderParticipant[];
+    getUniqueHydratedParticipants: () => ProviderParticipant[];
+    getAIProviderParticipants: () => ProviderParticipant[];
     fetchMore: (props?: {
         fetchSize?: number;
     }) => Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "16.0.0",
+	"version": "16.0.2",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -37,7 +37,7 @@
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/prosemirror-collab": "^0.22.0",
 		"@atlaskit/react-ufo": "^5.4.0",
-		"@atlaskit/tmp-editor-statsig": "^35.10.0",
+		"@atlaskit/tmp-editor-statsig": "^36.2.0",
 		"@atlaskit/ufo": "^0.4.0",
 		"@atlaskit/util-service-support": "^6.3.0",
 		"@babel/runtime": "^7.0.0",
@@ -73,6 +73,6 @@
 		}
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^112.0.0"
+		"@atlaskit/editor-common": "^112.2.0"
 	}
 }