@atlaskit/collab-provider 8.3.0 → 8.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "8.3.0",
+  "version": "8.5.0",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -23,7 +23,7 @@
   "dependencies": {
     "@atlaskit/analytics-gas-types": "^5.0.10",
     "@atlaskit/analytics-listeners": "^8.5.0",
-    "@atlaskit/editor-common": "^72.5.0",
+    "@atlaskit/editor-common": "^72.7.0",
     "@atlaskit/editor-json-transformer": "^8.8.0",
     "@atlaskit/prosemirror-collab": "^0.1.0",
     "@atlaskit/ufo": "^0.1.4",
@@ -49,9 +49,9 @@
     }
   },
   "devDependencies": {
-    "@atlaskit/adf-schema": "^25.3.0",
+    "@atlaskit/adf-schema": "^25.4.0",
     "@atlaskit/analytics-listeners": "^8.5.0",
-    "@atlaskit/editor-test-helpers": "^18.0.0",
+    "@atlaskit/editor-test-helpers": "^18.2.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

@@ -15,14 +15,14 @@
 <!--SECTION START: Main Entry Types-->
 
 ```ts
+/// <reference types="lodash" />
+
 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';
 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 type { EditorState } from 'prosemirror-state';
 import type { Manager } from 'socket.io-client';
@@ -31,6 +31,9 @@ import type { Step } from 'prosemirror-transform';
 import type { SyncUpErrorFunction } from '@atlaskit/editor-common/types';
 import type { Transaction } from 'prosemirror-state';
 
+// @public (undocumented)
+type AuthCallback = (cb: (data: InitAndAuthData) => void) => void;
+
 // @public (undocumented)
 type BaseEvents = Pick<
   CollabEditProvider<CollabEvents>,
@@ -62,17 +65,37 @@ export interface CollabDisconnectedPayload {
 }
 
 // @public (undocumented)
-export interface CollabErrorPayload {
+export interface CollabEditProvider<
+  Events extends CollabEvents = CollabEvents,
+> {
   // (undocumented)
-  code: string;
+  getFinalAcknowledgedState(): Promise<ResolvedEditorState>;
   // (undocumented)
-  message: string;
+  initialize(getState: () => any, createStep: (json: object) => Step): this;
   // (undocumented)
-  reason?: string;
+  off(evt: keyof Events, handler: (...args: any) => void): this;
+  // (undocumented)
+  on(evt: keyof Events, handler: (...args: any) => void): this;
+  // (undocumented)
+  send(tr: Transaction, oldState: EditorState, newState: EditorState): void;
+  // (undocumented)
+  sendMessage<K extends keyof Events>(
+    data: {
+      type: K;
+    } & Events[K],
+  ): void;
+  // (undocumented)
+  setup(props: {
+    getState: () => EditorState;
+    onSyncUpError?: SyncUpErrorFunction;
+  }): this;
   // (undocumented)
-  status: number;
+  unsubscribeAll(evt: keyof Events): this;
 }
 
+// @public @deprecated (undocumented)
+export type CollabErrorPayload = ProviderError;
+
 // @public (undocumented)
 export interface CollabEvents {
   // (undocumented)
@@ -99,6 +122,16 @@ export interface CollabEvents {
   telepointer: CollabTelepointerPayload;
 }
 
+// @public (undocumented)
+interface CollabEventTelepointerData {
+  // (undocumented)
+  selection: CollabSendableSelection;
+  // (undocumented)
+  sessionId: string;
+  // (undocumented)
+  type: 'telepointer';
+}
+
 // @public (undocumented)
 export interface CollabInitPayload extends CollabEventInitData {
   // (undocumented)
@@ -108,8 +141,6 @@ export interface CollabInitPayload extends CollabEventInitData {
   // (undocumented)
   reserveCursor?: boolean;
   // (undocumented)
-  userId?: string;
-  // (undocumented)
   version: number;
 }
 
@@ -124,17 +155,28 @@ export type CollabMetadataPayload = Metadata_2;
 // @public (undocumented)
 export type CollabPresencePayload = CollabEventPresenceData;
 
+// @public (undocumented)
+export interface CollabSendableSelection {
+  // (undocumented)
+  anchor?: number | string;
+  // (undocumented)
+  head?: number | string;
+  // (undocumented)
+  type: 'nodeSelection' | 'textSelection';
+}
+
 // @public (undocumented)
 export type CollabTelepointerPayload = CollabEventTelepointerData;
 
 // @public (undocumented)
 interface Config {
-  // (undocumented)
   analyticsClient?: AnalyticsWebClient;
   // (undocumented)
+  cacheToken?: boolean;
+  // (undocumented)
   createSocket: (
     path: string,
-    auth?: (cb: (data: object) => void) => void,
+    auth?: AuthCallback | InitAndAuthData,
     productInfo?: ProductInformation,
   ) => Socket;
   // (undocumented)
@@ -144,6 +186,8 @@ interface Config {
     [key: string]: boolean;
   };
   // (undocumented)
+  getAnalyticsWebClient?: Promise<AnalyticsWebClient>;
+  // (undocumented)
   getUser?(userId: string): Promise<
     Pick<CollabParticipant, 'avatar' | 'email' | 'name'> & {
       userId: string;
@@ -153,12 +197,12 @@ interface Config {
   lifecycle?: Lifecycle;
   // (undocumented)
   need404?: boolean;
-  // (undocumented)
   permissionTokenRefresh?: () => Promise<null | string>;
   // (undocumented)
   productInfo?: ProductInformation;
   // (undocumented)
   storage?: Storage_2;
+  throwOnNotConnected?: boolean;
   // (undocumented)
   url: string;
 }
@@ -179,6 +223,22 @@ enum DisconnectReason {
   UNKNOWN_DISCONNECT = 'UNKNOWN_DISCONNECT',
 }
 
+// @public
+type DocumentNotFound = {
+  code: PROVIDER_ERROR_CODE.DOCUMENT_NOT_FOUND;
+  message: string;
+  recoverable: boolean;
+  status?: number;
+};
+
+// @public
+type DocumentNotRestore = {
+  code: PROVIDER_ERROR_CODE.DOCUMENT_RESTORE_ERROR;
+  message: string;
+  recoverable: boolean;
+  status?: number;
+};
+
 // @public (undocumented)
 class Emitter<T = any> {
   protected emit<K extends keyof T>(evt: K, data: T[K]): this;
@@ -190,6 +250,67 @@ class Emitter<T = any> {
 // @public (undocumented)
 type EventHandler = () => void;
 
+// @public
+type FailToSave = {
+  code: PROVIDER_ERROR_CODE.FAIL_TO_SAVE;
+  message: string;
+  recoverable: boolean;
+  status?: number;
+};
+
+// @public (undocumented)
+interface InitAndAuthData {
+  // (undocumented)
+  initialized: boolean;
+  // (undocumented)
+  need404?: boolean;
+  // (undocumented)
+  token?: string;
+}
+
+// @public
+type InitialisationError = {
+  code: PROVIDER_ERROR_CODE.INITIALISATION_ERROR;
+  message: string;
+  recoverable: boolean;
+  status?: number;
+};
+
+// @public
+type InsufficientEditingPermission = {
+  code: PROVIDER_ERROR_CODE.NO_PERMISSION_ERROR;
+  message: string;
+  recoverable: boolean;
+  reason?: string;
+  status?: number;
+};
+
+// @public
+type InternalServiceError = {
+  code: PROVIDER_ERROR_CODE.INTERNAL_SERVICE_ERROR;
+  message: string;
+  recoverable: boolean;
+  reason: string;
+  status?: number;
+};
+
+// @public
+type InvalidProviderConfiguration = {
+  code: PROVIDER_ERROR_CODE.INVALID_PROVIDER_CONFIGURATION;
+  message: string;
+  recoverable: boolean;
+  reason: string;
+  status?: number;
+};
+
+// @public
+type InvalidUserToken = {
+  code: PROVIDER_ERROR_CODE.INVALID_USER_TOKEN;
+  message: string;
+  recoverable: boolean;
+  status?: number;
+};
+
 // @public (undocumented)
 interface Lifecycle {
   // (undocumented)
@@ -199,6 +320,14 @@ interface Lifecycle {
 // @public (undocumented)
 type LifecycleEvents = 'restore' | 'save';
 
+// @public
+type Locked = {
+  code: PROVIDER_ERROR_CODE.LOCKED;
+  message: string;
+  recoverable: boolean;
+  status?: number;
+};
+
 // @public (undocumented)
 type MarkJson = {
   type: string;
@@ -213,6 +342,14 @@ interface Metadata_2 {
   [key: string]: boolean | number | string;
 }
 
+// @public
+type NetworkIssue = {
+  code: PROVIDER_ERROR_CODE.NETWORK_ISSUE;
+  message: string;
+  recoverable: boolean;
+  status?: number;
+};
+
 // @public (undocumented)
 type NodeJson = {
   type: string;
@@ -233,28 +370,23 @@ type ProductInformation = {
 // @public (undocumented)
 export class Provider extends Emitter<CollabEvents> implements BaseEvents {
   constructor(config: Config);
-  // (undocumented)
   destroy(): this;
-  // (undocumented)
+  // @deprecated
   disconnect(): this;
-  // (undocumented)
   getCurrentState: () => Promise<ResolvedEditorState>;
-  // (undocumented)
   getFinalAcknowledgedState: () => Promise<ResolvedEditorState>;
+  // @deprecated
   initialize(getState: () => EditorState): this;
   send(
     _tr: Transaction | null,
     _oldState: EditorState | null,
     newState: EditorState,
   ): void;
-  sendMessage(data: any): void;
-  // (undocumented)
+  sendMessage(data: CollabEventTelepointerData): void;
+  // @deprecated
   setEditorWidth(editorWidth: string, broadcast?: boolean): void;
-  // (undocumented)
   setMetadata(metadata: Metadata_2): void;
-  // (undocumented)
   setTitle(title: string, broadcast?: boolean): void;
-  // (undocumented)
   setup({
     getState,
     onSyncUpError,
@@ -262,9 +394,47 @@ export class Provider extends Emitter<CollabEvents> implements BaseEvents {
     getState: () => EditorState;
     onSyncUpError?: SyncUpErrorFunction;
   }): this;
+  // @deprecated
   unsubscribeAll(): this;
 }
 
+// @public (undocumented)
+export enum PROVIDER_ERROR_CODE {
+  // (undocumented)
+  DOCUMENT_NOT_FOUND = 'DOCUMENT_NOT_FOUND',
+  // (undocumented)
+  DOCUMENT_RESTORE_ERROR = 'DOCUMENT_RESTORE_ERROR',
+  // (undocumented)
+  FAIL_TO_SAVE = 'FAIL_TO_SAVE',
+  // (undocumented)
+  INITIALISATION_ERROR = 'INITIALISATION_ERROR',
+  // (undocumented)
+  INTERNAL_SERVICE_ERROR = 'INTERNAL_SERVICE_ERROR',
+  // (undocumented)
+  INVALID_PROVIDER_CONFIGURATION = 'INVALID_PROVIDER_CONFIGURATION',
+  // (undocumented)
+  INVALID_USER_TOKEN = 'INVALID_USER_TOKEN',
+  // (undocumented)
+  LOCKED = 'LOCKED',
+  // (undocumented)
+  NETWORK_ISSUE = 'NETWORK_ISSUE',
+  // (undocumented)
+  NO_PERMISSION_ERROR = 'NO_PERMISSION_ERROR',
+}
+
+// @public
+export type ProviderError =
+  | DocumentNotFound
+  | DocumentNotRestore
+  | FailToSave
+  | InitialisationError
+  | InsufficientEditingPermission
+  | InternalServiceError
+  | InvalidProviderConfiguration
+  | InvalidUserToken
+  | Locked
+  | NetworkIssue;
+
 // @public (undocumented)
 interface SimpleEventEmitter {
   // (undocumented)
@@ -294,14 +464,14 @@ export interface Socket extends SimpleEventEmitter {
 
 // @public (undocumented)
 type StepJson = {
+  stepType?: string;
   from?: number;
   to?: number;
-  stepType?: string;
+  slice?: SliceJson;
   clientId: number | string;
   userId: string;
   createdAt?: number;
   structure?: boolean;
-  slice?: SliceJson;
 };
 
 // @public (undocumented)

package/dist/cjs/error-code-mapper.js

@@ -1,88 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.errorCodeMapper = exports.ErrorCodeMapper = void 0;
-var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
-var ErrorCodeMapper = {
-  noPermissionError: {
-    code: 'NO_PERMISSION_ERROR',
-    message: 'User does not have permissions to access this document'
-  },
-  documentNotFound: {
-    code: 'DOCUMENT_NOT_FOUND',
-    message: 'The requested document is not found'
-  },
-  hasToLogin: {
-    code: 'HAS_TO_LOGIN',
-    message: 'The user needs to login'
-  },
-  catchupFail: {
-    code: 'CATCHUP_FAILED',
-    message: 'Cannot fetch catchup from collab service'
-  },
-  serviceUnvailable: {
-    code: 'SERVICE_UNAVAILABLE',
-    message: 'Service is not available'
-  },
-  failToSave: {
-    code: 'FAIL_TO_SAVE',
-    message: 'Collab service is not able to save changes'
-  },
-  restoreError: {
-    code: 'DOCUMENT_RESTORE_ERROR',
-    message: 'Collab service unable to restore document'
-  },
-  internalError: {
-    code: 'INTERNAL_SERVICE_ERROR',
-    message: 'Collab service has experienced an internal server error'
-  }
-};
-exports.ErrorCodeMapper = ErrorCodeMapper;
-var errorCodeMapper = function errorCodeMapper(error) {
-  var _error$data;
-  switch ((_error$data = error.data) === null || _error$data === void 0 ? void 0 : _error$data.code) {
-    case 'INSUFFICIENT_EDITING_PERMISSION':
-      return {
-        status: 403,
-        code: ErrorCodeMapper.noPermissionError.code,
-        message: ErrorCodeMapper.noPermissionError.message,
-        reason:
-        // Typescript magic so it detects the union type
-        (0, _typeof2.default)(error.data.meta) === 'object' ? error.data.meta.reason : undefined
-      };
-    case 'DOCUMENT_NOT_FOUND':
-      return {
-        status: 404,
-        code: ErrorCodeMapper.documentNotFound.code,
-        message: ErrorCodeMapper.documentNotFound.message
-      };
-    case 'FAILED_ON_S3':
-    case 'DYNAMO_ERROR':
-      return {
-        status: 500,
-        code: ErrorCodeMapper.failToSave.code,
-        message: ErrorCodeMapper.failToSave.message
-      };
-    case 'DOCUMENT_RESTORE_ERROR':
-      return {
-        status: 500,
-        code: ErrorCodeMapper.restoreError.code,
-        message: ErrorCodeMapper.restoreError.message
-      };
-    // Temporarily re-added so we don't emit errors to Confluence by default as they will disconnect the collab provider
-    case 'CATCHUP_FAILED':
-    case 'GET_QUERY_TIME_OUT':
-    case 'INIT_DATA_LOAD_FAILED':
-      return {
-        status: 500,
-        code: ErrorCodeMapper.internalError.code,
-        message: ErrorCodeMapper.internalError.message
-      };
-    default:
-      break;
-  }
-};
-exports.errorCodeMapper = errorCodeMapper;

package/dist/es2019/error-code-mapper.js

@@ -1,78 +0,0 @@
-export const ErrorCodeMapper = {
-  noPermissionError: {
-    code: 'NO_PERMISSION_ERROR',
-    message: 'User does not have permissions to access this document'
-  },
-  documentNotFound: {
-    code: 'DOCUMENT_NOT_FOUND',
-    message: 'The requested document is not found'
-  },
-  hasToLogin: {
-    code: 'HAS_TO_LOGIN',
-    message: 'The user needs to login'
-  },
-  catchupFail: {
-    code: 'CATCHUP_FAILED',
-    message: 'Cannot fetch catchup from collab service'
-  },
-  serviceUnvailable: {
-    code: 'SERVICE_UNAVAILABLE',
-    message: 'Service is not available'
-  },
-  failToSave: {
-    code: 'FAIL_TO_SAVE',
-    message: 'Collab service is not able to save changes'
-  },
-  restoreError: {
-    code: 'DOCUMENT_RESTORE_ERROR',
-    message: 'Collab service unable to restore document'
-  },
-  internalError: {
-    code: 'INTERNAL_SERVICE_ERROR',
-    message: 'Collab service has experienced an internal server error'
-  }
-};
-export const errorCodeMapper = error => {
-  var _error$data;
-  switch ((_error$data = error.data) === null || _error$data === void 0 ? void 0 : _error$data.code) {
-    case 'INSUFFICIENT_EDITING_PERMISSION':
-      return {
-        status: 403,
-        code: ErrorCodeMapper.noPermissionError.code,
-        message: ErrorCodeMapper.noPermissionError.message,
-        reason:
-        // Typescript magic so it detects the union type
-        typeof error.data.meta === 'object' ? error.data.meta.reason : undefined
-      };
-    case 'DOCUMENT_NOT_FOUND':
-      return {
-        status: 404,
-        code: ErrorCodeMapper.documentNotFound.code,
-        message: ErrorCodeMapper.documentNotFound.message
-      };
-    case 'FAILED_ON_S3':
-    case 'DYNAMO_ERROR':
-      return {
-        status: 500,
-        code: ErrorCodeMapper.failToSave.code,
-        message: ErrorCodeMapper.failToSave.message
-      };
-    case 'DOCUMENT_RESTORE_ERROR':
-      return {
-        status: 500,
-        code: ErrorCodeMapper.restoreError.code,
-        message: ErrorCodeMapper.restoreError.message
-      };
-    // Temporarily re-added so we don't emit errors to Confluence by default as they will disconnect the collab provider
-    case 'CATCHUP_FAILED':
-    case 'GET_QUERY_TIME_OUT':
-    case 'INIT_DATA_LOAD_FAILED':
-      return {
-        status: 500,
-        code: ErrorCodeMapper.internalError.code,
-        message: ErrorCodeMapper.internalError.message
-      };
-    default:
-      break;
-  }
-};

package/dist/esm/error-code-mapper.js

@@ -1,79 +0,0 @@
-import _typeof from "@babel/runtime/helpers/typeof";
-export var ErrorCodeMapper = {
-  noPermissionError: {
-    code: 'NO_PERMISSION_ERROR',
-    message: 'User does not have permissions to access this document'
-  },
-  documentNotFound: {
-    code: 'DOCUMENT_NOT_FOUND',
-    message: 'The requested document is not found'
-  },
-  hasToLogin: {
-    code: 'HAS_TO_LOGIN',
-    message: 'The user needs to login'
-  },
-  catchupFail: {
-    code: 'CATCHUP_FAILED',
-    message: 'Cannot fetch catchup from collab service'
-  },
-  serviceUnvailable: {
-    code: 'SERVICE_UNAVAILABLE',
-    message: 'Service is not available'
-  },
-  failToSave: {
-    code: 'FAIL_TO_SAVE',
-    message: 'Collab service is not able to save changes'
-  },
-  restoreError: {
-    code: 'DOCUMENT_RESTORE_ERROR',
-    message: 'Collab service unable to restore document'
-  },
-  internalError: {
-    code: 'INTERNAL_SERVICE_ERROR',
-    message: 'Collab service has experienced an internal server error'
-  }
-};
-export var errorCodeMapper = function errorCodeMapper(error) {
-  var _error$data;
-  switch ((_error$data = error.data) === null || _error$data === void 0 ? void 0 : _error$data.code) {
-    case 'INSUFFICIENT_EDITING_PERMISSION':
-      return {
-        status: 403,
-        code: ErrorCodeMapper.noPermissionError.code,
-        message: ErrorCodeMapper.noPermissionError.message,
-        reason:
-        // Typescript magic so it detects the union type
-        _typeof(error.data.meta) === 'object' ? error.data.meta.reason : undefined
-      };
-    case 'DOCUMENT_NOT_FOUND':
-      return {
-        status: 404,
-        code: ErrorCodeMapper.documentNotFound.code,
-        message: ErrorCodeMapper.documentNotFound.message
-      };
-    case 'FAILED_ON_S3':
-    case 'DYNAMO_ERROR':
-      return {
-        status: 500,
-        code: ErrorCodeMapper.failToSave.code,
-        message: ErrorCodeMapper.failToSave.message
-      };
-    case 'DOCUMENT_RESTORE_ERROR':
-      return {
-        status: 500,
-        code: ErrorCodeMapper.restoreError.code,
-        message: ErrorCodeMapper.restoreError.message
-      };
-    // Temporarily re-added so we don't emit errors to Confluence by default as they will disconnect the collab provider
-    case 'CATCHUP_FAILED':
-    case 'GET_QUERY_TIME_OUT':
-    case 'INIT_DATA_LOAD_FAILED':
-      return {
-        status: 500,
-        code: ErrorCodeMapper.internalError.code,
-        message: ErrorCodeMapper.internalError.message
-      };
-    default:
-      break;
-  }
-};

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

@@ -1,36 +0,0 @@
-import type { CollabErrorPayload, ErrorPayload } from './types';
-export declare const ErrorCodeMapper: {
-    noPermissionError: {
-        code: string;
-        message: string;
-    };
-    documentNotFound: {
-        code: string;
-        message: string;
-    };
-    hasToLogin: {
-        code: string;
-        message: string;
-    };
-    catchupFail: {
-        code: string;
-        message: string;
-    };
-    serviceUnvailable: {
-        code: string;
-        message: string;
-    };
-    failToSave: {
-        code: string;
-        message: string;
-    };
-    restoreError: {
-        code: string;
-        message: string;
-    };
-    internalError: {
-        code: string;
-        message: string;
-    };
-};
-export declare const errorCodeMapper: (error: ErrorPayload) => CollabErrorPayload | undefined;

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

@@ -1,5 +0,0 @@
-import type { CollabEventTelepointerData } from '@atlaskit/editor-common/collab';
-import { AcknowledgementPayload, StepJson } from '../types';
-import { ParticipantsMap } from './index';
-export declare const telepointersFromStep: (participants: ParticipantsMap, step: StepJson) => CollabEventTelepointerData | undefined;
-export declare const telepointerCallback: (documentAri: string) => (response: AcknowledgementPayload) => void;

package/error-code-mapper/package.json

@@ -1,15 +0,0 @@
-{
-  "name": "@atlaskit/collab-provider/error-code-mapper",
-  "main": "../dist/cjs/error-code-mapper.js",
-  "module": "../dist/esm/error-code-mapper.js",
-  "module:es2019": "../dist/es2019/error-code-mapper.js",
-  "sideEffects": false,
-  "types": "../dist/types/error-code-mapper.d.ts",
-  "typesVersions": {
-    ">=4.0 <4.5": {
-      "*": [
-        "../dist/types-ts4.0/error-code-mapper.d.ts"
-      ]
-    }
-  }
-}