@atlaskit/collab-provider 7.4.3 → 7.4.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/collab-provider
 
+## 7.4.4
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 7.4.3
 
 ### Patch Changes

package/dist/cjs/provider/index.js

@@ -11,10 +11,10 @@ var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/sli
 
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
 
-var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
-
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));

package/dist/cjs/version.json

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

package/dist/es2019/version.json

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

package/dist/esm/channel.js

@@ -1,4 +1,3 @@
-import _regeneratorRuntime from "@babel/runtime/regenerator";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
@@ -7,6 +6,7 @@ import _inherits from "@babel/runtime/helpers/inherits";
 import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
 import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
 
 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; }
 

package/dist/esm/provider/catchup.js

@@ -1,5 +1,5 @@
-import _regeneratorRuntime from "@babel/runtime/regenerator";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
 
 function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
 

package/dist/esm/provider/index.js

@@ -1,7 +1,6 @@
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
 import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
-import _regeneratorRuntime from "@babel/runtime/regenerator";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
@@ -12,6 +11,7 @@ import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstruct
 import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 var _excluded = ["type"];
+import _regeneratorRuntime from "@babel/runtime/regenerator";
 
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
 

package/dist/esm/version.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "7.4.3",
+  "version": "7.4.4",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -22,8 +22,8 @@
   },
   "dependencies": {
     "@atlaskit/analytics-gas-types": "5.0.7",
-    "@atlaskit/analytics-listeners": "^8.2.0",
-    "@atlaskit/editor-common": "^68.0.0",
+    "@atlaskit/analytics-listeners": "^8.3.0",
+    "@atlaskit/editor-common": "^69.0.0",
     "@atlaskit/editor-json-transformer": "^8.7.0",
     "@atlaskit/util-service-support": "^6.1.0",
     "@babel/runtime": "^7.0.0",
@@ -44,7 +44,7 @@
     }
   },
   "devDependencies": {
-    "@atlaskit/editor-test-helpers": "^17.0.0",
+    "@atlaskit/editor-test-helpers": "^17.1.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@types/prosemirror-collab": "^1.1.1",
     "@types/prosemirror-model": "^1.11.0",

package/report.api.md

@@ -0,0 +1,289 @@
+## API Report File for "@atlaskit/collab-provider"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
+import { CollabEditProvider } 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';
+import type { CollabEventRemoteData } from '@atlaskit/editor-common/collab';
+import type { CollabEventTelepointerData } from '@atlaskit/editor-common/collab';
+import type { CollabParticipant } from '@atlaskit/editor-common/collab';
+import { EditorState } from 'prosemirror-state';
+import type { Manager } from 'socket.io-client';
+import { ResolvedEditorState } from '@atlaskit/editor-common/collab';
+import type { Step } from 'prosemirror-transform';
+import { SyncUpErrorFunction } from '@atlaskit/editor-common/types';
+import { Transaction } from 'prosemirror-state';
+
+declare type BaseEvents = Pick<
+  CollabEditProvider<CollabEvents>,
+  'setup' | 'send' | 'sendMessage'
+>;
+
+export declare type CollabConnectedPayload = CollabEventConnectionData;
+
+export declare interface CollabDataPayload extends CollabEventRemoteData {
+  version: number;
+  json: StepJson[];
+  userIds: string[];
+}
+
+export declare interface CollabDisconnectedPayload {
+  reason: DisconnectReason;
+  sid: string;
+}
+
+export declare interface CollabErrorPayload {
+  status: number;
+  code: string;
+  message: string;
+}
+
+export declare interface CollabEvents {
+  'metadata:changed': CollabMetadataPayload;
+  init: CollabInitPayload;
+  connected: CollabConnectedPayload;
+  disconnected: CollabDisconnectedPayload;
+  data: CollabDataPayload;
+  telepointer: CollabTelepointerPayload;
+  presence: CollabPresencePayload;
+  'local-steps': CollabLocalStepsPayload;
+  error: CollabErrorPayload;
+  entity: any;
+}
+
+export declare interface CollabInitPayload extends CollabEventInitData {
+  doc: any;
+  version: number;
+  userId?: string;
+  metadata?: Metadata_2;
+}
+
+export declare type CollabLocalStepsPayload = {
+  steps: Step[];
+};
+
+export declare type CollabMetadataPayload = Metadata_2;
+
+export declare type CollabPresencePayload = CollabEventPresenceData;
+
+export declare type CollabTelepointerPayload = CollabEventTelepointerData;
+
+declare interface Config {
+  url: string;
+  documentAri: string;
+  lifecycle?: Lifecycle;
+  storage?: Storage_2;
+  need404?: boolean;
+  createSocket(
+    path: string,
+    auth?: (cb: (data: object) => void) => void,
+  ): Socket;
+  analyticsClient?: AnalyticsWebClient;
+  getUser?(
+    userId: string,
+  ): Promise<
+    Pick<CollabParticipant, 'avatar' | 'email' | 'name'> & {
+      userId: string;
+    }
+  >;
+  permissionTokenRefresh?: () => Promise<string>;
+}
+
+declare enum DisconnectReason {
+  CLIENT_DISCONNECT = 'CLIENT_DISCONNECT',
+  SERVER_DISCONNECT = 'SERVER_DISCONNECT',
+  SOCKET_CLOSED = 'SOCKET_CLOSED',
+  SOCKET_ERROR = 'SOCKET_ERROR',
+  SOCKET_TIMEOUT = 'SOCKET_TIMEOUT',
+  UNKNOWN_DISCONNECT = 'UNKNOWN_DISCONNECT',
+}
+
+declare class Emitter<T = any> {
+  private eventEmitter;
+  /**
+   * Emit events to subscribers
+   */
+  protected emit<K extends keyof T>(evt: K, data: T[K]): this;
+  /**
+   * Subscribe to events emitted by this provider
+   */
+  on<K extends keyof T>(evt: K, handler: (args: T[K]) => void): this;
+  /**
+   * Unsubscribe from events emitted by this provider
+   */
+  off<K extends keyof T>(evt: K, handler: (args: T[K]) => void): this;
+  /**
+   * Unsubscribe from all events emitted by this provider.
+   */
+  unsubscribeAll<K extends keyof T>(evt?: K): this;
+}
+
+declare type EventHandler = () => void;
+
+declare interface Lifecycle {
+  on(event: LifecycleEvents, handler: EventHandler): void;
+}
+
+declare type LifecycleEvents = 'save' | 'restore';
+
+declare interface Metadata_2 {
+  [key: string]: string | number | boolean;
+}
+
+export declare class Provider
+  extends Emitter<CollabEvents>
+  implements BaseEvents {
+  private participants;
+  private channel;
+  private config;
+  private getState;
+  private metadata;
+  private stepRejectCounter;
+  private analyticsClient?;
+  private isChannelInitialized;
+  private onSyncUpError?;
+  private sessionId?;
+  private clientId?;
+  private userId?;
+  private participantUpdateTimeout?;
+  private presenceUpdateTimeout?;
+  private disconnectedAt?;
+  constructor(config: Config);
+  private initializeChannel;
+  /**
+   * Called by collab plugin in editor when it's ready to
+   * initialize a collab session.
+   */
+  initialize(getState: () => EditorState): this;
+  setup({
+    getState,
+    onSyncUpError,
+  }: {
+    getState: () => EditorState;
+    onSyncUpError?: SyncUpErrorFunction;
+  }): this;
+  /**
+   * We can use this function to throttle/delay
+   * Any send steps operation
+   *
+   * The getState function will return the current EditorState
+   * from the EditorView.
+   */
+  private sendStepsFromCurrentState;
+  /**
+   * Send steps from transaction to other participants
+   */
+  send(
+    _tr: Transaction | null,
+    _oldState: EditorState | null,
+    newState: EditorState,
+  ): void;
+  /**
+   * Called when we receive steps from the service
+   */
+  private onStepsAdded;
+  private throttledCatchup;
+  private fitlerQueue;
+  private updateDocumentWithMetadata;
+  private applyLocalsteps;
+  private getCurrentPmVersion;
+  private getUnconfirmedSteps;
+  /**
+   * Called when:
+   *   * session established(offline -> online)
+   *   * try to accept steps but version is behind.
+   */
+  private catchup;
+  private onErrorHandled;
+  private pauseQueue?;
+  private queue;
+  private queueSteps;
+  private processQueue;
+  private processSteps;
+  /**
+   * Send messages, such as telepointers, to other participants.
+   */
+  sendMessage(data: any): void;
+  private sendPresence;
+  /**
+   * Called when a participant joins the session.
+   *
+   * We keep track of participants internally in this class, and emit the `presence` event to update
+   * the active avatars in the editor.
+   * This method will be triggered from backend to notify all participants to exchange presence
+   *
+   */
+  private onPresenceJoined;
+  private onPresence;
+  /**
+   * Called when a metadata is changed.
+   *
+   */
+  private onMetadataChanged;
+  /**
+   * Called when a participant leaves the session.
+   *
+   * We emit the `presence` event to update the active avatars in the editor.
+   */
+  private onParticipantLeft;
+  /**
+   * Called when we receive an update event from another participant.
+   */
+  private onParticipantUpdated;
+  /**
+   * Called when we receive a telepointer update from another
+   * participant.
+   */
+  private onParticipantTelepointer;
+  private updateParticipant;
+  /**
+   * Keep list of participants up to date. Filter out inactive users etc.
+   */
+  private updateParticipants;
+  private emitTelepointersFromSteps;
+  private disconnectedReasonMapper;
+  private onDisconnected;
+  destroy(): this;
+  disconnect(): this;
+  setTitle(title: string, broadcast?: boolean): void;
+  setEditorWidth(editorWidth: string, broadcast?: boolean): void;
+  setMetadata(metadata: Metadata_2): void;
+  getFinalAcknowledgedState: () => Promise<ResolvedEditorState>;
+  /**
+   * Unsubscribe from all events emitted by this provider.
+   */
+  unsubscribeAll(): this;
+}
+
+declare interface SimpleEventEmitter {
+  on(event: string, fn: Function): SimpleEventEmitter;
+}
+
+export declare interface Socket extends SimpleEventEmitter {
+  id: string;
+  connect(): Socket;
+  emit(event: string, ...args: any[]): Socket;
+  close(): Socket;
+  io?: Manager;
+}
+
+declare type StepJson = {
+  from?: number;
+  to?: number;
+  stepType?: string;
+  clientId: string;
+  userId: string;
+};
+
+declare interface Storage_2 {
+  get(key: string): Promise<string>;
+  set(key: string, value: string): Promise<void>;
+  delete(key: string): Promise<void>;
+}
+
+export {};
+```