@atlaskit/collab-provider 9.1.0 → 9.2.1

package/dist/esm/provider/index.js

@@ -23,6 +23,7 @@ import { ParticipantsService } from '../participants/participants-service';
 import { errorCodeMapper } from '../errors/error-code-mapper';
 var logger = createLogger('Provider', 'black');
 var OUT_OF_SYNC_PERIOD = 3 * 1000; // 3 seconds
+var PRELOAD_DRAFT_SYNC_PERIOD = 15 * 1000; // 15 seconds
 
 export var MAX_STEP_REJECTED_ERROR = 15;
 export var Provider = /*#__PURE__*/function (_Emitter) {
@@ -67,20 +68,27 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
           sid: sid,
           initial: !initialized
         });
-        // If initial draft is already present and the channel is initialized,
-        // fire the provider's init event with initial draft document and version
+
+        // Early initialization with initial draft passed via provider
         if (_this.initialDraft && initialized && !_this.isProviderInitialized) {
-          var _this$initialDraft = _this.initialDraft,
-            document = _this$initialDraft.document,
-            version = _this$initialDraft.version,
-            metadata = _this$initialDraft.metadata;
-          // Initial document, version, metadata from initial draft
-          _this.documentService.updateDocument({
-            doc: document,
-            version: version,
-            metadata: metadata
-          });
-          _this.metadataService.updateMetadata(metadata);
+          // Call catchup if the draft has become stale since being passed to provider
+          if (_this.isDraftTimestampStale()) {
+            _this.documentService.throttledCatchup();
+          }
+          // If the initial draft is already up to date, update the document with that of the initial draft
+          else {
+            var _this$initialDraft = _this.initialDraft,
+              document = _this$initialDraft.document,
+              version = _this$initialDraft.version,
+              metadata = _this$initialDraft.metadata;
+            // Initial document, version, metadata from initial draft
+            _this.documentService.updateDocument({
+              doc: document,
+              version: version,
+              metadata: metadata
+            });
+            _this.metadataService.updateMetadata(metadata);
+          }
           _this.isProviderInitialized = true;
         }
         // If already initialized, `connected` means reconnected
@@ -308,6 +316,21 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       }
     }
 
+    /**
+     * Checks the provider's initial draft timestamp to determine if it is stale.
+     * Returns true only if the time elapsed since the draft timestamp is greater than or
+     * equal to a predetermined timeout. Returns false in all other cases.
+     */
+  }, {
+    key: "isDraftTimestampStale",
+    value: function isDraftTimestampStale() {
+      var _this$initialDraft2;
+      if (!((_this$initialDraft2 = this.initialDraft) !== null && _this$initialDraft2 !== void 0 && _this$initialDraft2.timestamp)) {
+        return false;
+      }
+      return Date.now() - this.initialDraft.timestamp >= PRELOAD_DRAFT_SYNC_PERIOD;
+    }
+
     /**
      * Send steps from transaction to NCS (and as a consequence to other participants), called from the collab-edit plugin in the editor
      * @param {Transaction} _tr Deprecated, included to keep API consistent with Synchrony provider

package/dist/esm/version-wrapper.js

@@ -1,5 +1,5 @@
 export var name = "@atlaskit/collab-provider";
-export var version = "9.1.0";
+export var version = "9.2.1";
 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": "9.1.0",
+	"version": "9.2.1",
 	"sideEffects": false
 }

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

@@ -192,7 +192,7 @@ type SendStepsRetryAnalyticsEvent = {
     eventAction: EVENT_ACTION.SEND_STEPS_RETRY;
     attributes: {
         documentAri: string;
-        eventStatus: EVENT_STATUS.SUCCESS;
+        eventStatus: EVENT_STATUS.INFO;
         count: number;
     };
 };
@@ -200,7 +200,7 @@ type CatchupAfterMaxSendStepsRetryAnalyticsEvent = {
     eventAction: EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY;
     attributes: {
         documentAri: string;
-        eventStatus: EVENT_STATUS.SUCCESS;
+        eventStatus: EVENT_STATUS.INFO;
     };
 };
 export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent;

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

@@ -1,5 +1,12 @@
 import type { ProductInformation } from '../types';
+import type { Step as ProseMirrorStep } from 'prosemirror-transform';
 export declare const createLogger: (prefix: string, color?: string) => (msg: string, data?: any) => void;
 export declare function sleep(ms: number): Promise<unknown>;
 export declare const getProduct: (productInfo?: ProductInformation) => string;
 export declare const getSubProduct: (productInfo?: ProductInformation) => string;
+export type UGCFreeStepDetails = {
+    type: string;
+    contentTypes: string;
+    stepSizeInBytes?: number;
+};
+export declare const getStepUGCFreeDetails: (step: ProseMirrorStep) => UGCFreeStepDetails;

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

@@ -59,6 +59,12 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
         onSyncUpError?: SyncUpErrorFunction;
     }): this;
     private checkForCookies;
+    /**
+     * Checks the provider's initial draft timestamp to determine if it is stale.
+     * Returns true only if the time elapsed since the draft timestamp is greater than or
+     * equal to a predetermined timeout. Returns false in all other cases.
+     */
+    private isDraftTimestampStale;
     /**
      * Send steps from transaction to NCS (and as a consequence to other participants), called from the collab-edit plugin in the editor
      * @param {Transaction} _tr Deprecated, included to keep API consistent with Synchrony provider

package/dist/types/types.d.ts

@@ -61,6 +61,7 @@ export interface InitialDraft {
     document: JSONDocNode;
     version: number;
     metadata?: Metadata;
+    timestamp?: number;
 }
 export interface Config {
     url: string;

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

@@ -192,7 +192,7 @@ type SendStepsRetryAnalyticsEvent = {
     eventAction: EVENT_ACTION.SEND_STEPS_RETRY;
     attributes: {
         documentAri: string;
-        eventStatus: EVENT_STATUS.SUCCESS;
+        eventStatus: EVENT_STATUS.INFO;
         count: number;
     };
 };
@@ -200,7 +200,7 @@ type CatchupAfterMaxSendStepsRetryAnalyticsEvent = {
     eventAction: EVENT_ACTION.CATCHUP_AFTER_MAX_SEND_STEPS_RETRY;
     attributes: {
         documentAri: string;
-        eventStatus: EVENT_STATUS.SUCCESS;
+        eventStatus: EVENT_STATUS.INFO;
     };
 };
 export type ActionAnalyticsEvent = AddStepsSuccessAnalyticsEvent | AddStepsFailureAnalyticsEvent | ReInitDocFailAnalyticsEvent | ReInitDocSuccessAnalyticsEvent | ConnectionSuccessAnalyticsEvent | ConnectionFailureAnalyticsEvent | CatchUpSuccessAnalyticsEvent | CatchUpFailureAnalyticsEvent | DocumentInitSuccessAnalyticsEvent | UpdateParticipantsSuccessAnalyticsEvent | CommitUnconfirmedStepsSuccessAnalyticsEvent | CommitUnconfirmedStepsFailureAnalyticsEvent | PublishPageSuccessAnalyticsEvent | PublishPageFailureAnalyticsEvent | GetCurrentStateSuccessAnalyticsEvent | GetCurrentStateFailureAnalyticsEvent | InvalidateTokenAnalyticsEvent | SendStepsRetryAnalyticsEvent | CatchupAfterMaxSendStepsRetryAnalyticsEvent | CatchUpDroppedStepsEvent;

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

@@ -1,5 +1,12 @@
 import type { ProductInformation } from '../types';
+import type { Step as ProseMirrorStep } from 'prosemirror-transform';
 export declare const createLogger: (prefix: string, color?: string) => (msg: string, data?: any) => void;
 export declare function sleep(ms: number): Promise<unknown>;
 export declare const getProduct: (productInfo?: ProductInformation) => string;
 export declare const getSubProduct: (productInfo?: ProductInformation) => string;
+export type UGCFreeStepDetails = {
+    type: string;
+    contentTypes: string;
+    stepSizeInBytes?: number;
+};
+export declare const getStepUGCFreeDetails: (step: ProseMirrorStep) => UGCFreeStepDetails;

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

@@ -59,6 +59,12 @@ export declare class Provider extends Emitter<CollabEvents> implements BaseEvent
         onSyncUpError?: SyncUpErrorFunction;
     }): this;
     private checkForCookies;
+    /**
+     * Checks the provider's initial draft timestamp to determine if it is stale.
+     * Returns true only if the time elapsed since the draft timestamp is greater than or
+     * equal to a predetermined timeout. Returns false in all other cases.
+     */
+    private isDraftTimestampStale;
     /**
      * Send steps from transaction to NCS (and as a consequence to other participants), called from the collab-edit plugin in the editor
      * @param {Transaction} _tr Deprecated, included to keep API consistent with Synchrony provider

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

@@ -61,6 +61,7 @@ export interface InitialDraft {
     document: JSONDocNode;
     version: number;
     metadata?: Metadata;
+    timestamp?: number;
 }
 export interface Config {
     url: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.1.0",
+  "version": "9.2.1",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -25,7 +25,7 @@
   "atlassian": {
     "team": "Editor Services",
     "inPublicMirror": true,
-    "releaseModel": "scheduled"
+    "releaseModel": "continuous"
   },
   "af:exports": {
     ".": "./src/index.ts",
@@ -63,7 +63,7 @@
   "devDependencies": {
     "@atlaskit/adf-schema": "^25.8.0",
     "@atlaskit/analytics-listeners": "^8.7.0",
-    "@atlaskit/editor-test-helpers": "^18.5.0",
+    "@atlaskit/editor-test-helpers": "^18.6.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@types/prosemirror-model": "^1.11.0",
     "@types/prosemirror-state": "^1.2.0",

package/report.api.md

@@ -354,6 +354,8 @@ interface InitialDraft {
   // (undocumented)
   metadata?: Metadata_2;
   // (undocumented)
+  timestamp?: number;
+  // (undocumented)
   version: number;
 }