@atlaskit/collab-provider 9.18.0 → 9.18.2

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

@@ -1,7 +1,7 @@
 import type { Step } from '@atlaskit/editor-prosemirror/transform';
 import type { AnalyticsWebClient } from '@atlaskit/analytics-listeners';
 import type { Manager } from 'socket.io-client';
-import type { InternalError } from './errors/error-types';
+import type { InternalError } from './errors/internal-errors';
 import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
 import type { GetUserType } from './participants/participants-helper';
 import type AnalyticsHelper from './analytics/analytics-helper';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/collab-provider",
-  "version": "9.18.0",
+  "version": "9.18.2",
   "description": "A provider for collaborative editing.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -62,7 +62,7 @@
     }
   },
   "devDependencies": {
-    "@atlaskit/adf-schema": "^34.0.1",
+    "@atlaskit/adf-schema": "^35.0.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "typescript": "~4.9.5"
   },

package/dist/es2019/errors/error-types.js

@@ -1,165 +0,0 @@
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
-// Internal error codes (generated by collab provider)
-
-export let INTERNAL_ERROR_CODE = /*#__PURE__*/function (INTERNAL_ERROR_CODE) {
-  INTERNAL_ERROR_CODE["TOKEN_PERMISSION_ERROR"] = "TOKEN_PERMISSION_ERROR";
-  INTERNAL_ERROR_CODE["RECONNECTION_NETWORK_ISSUE"] = "RECONNECTION_NETWORK_ISSUE";
-  INTERNAL_ERROR_CODE["CONNECTION_ERROR"] = "CONNECTION_ERROR";
-  INTERNAL_ERROR_CODE["RECONNECTION_ERROR"] = "RECONNECTION_ERROR";
-  INTERNAL_ERROR_CODE["DOCUMENT_NOT_FOUND"] = "DOCUMENT_NOT_FOUND";
-  INTERNAL_ERROR_CODE["CATCHUP_FAILED"] = "CATCHUP_FAILED";
-  INTERNAL_ERROR_CODE["DOCUMENT_RESTORE_ERROR"] = "DOCUMENT_RESTORE_ERROR";
-  INTERNAL_ERROR_CODE["ADD_STEPS_ERROR"] = "ADD_STEPS_ERROR";
-  INTERNAL_ERROR_CODE["DOCUMENT_UPDATE_ERROR"] = "DOCUMENT_UPDATE_ERROR";
-  return INTERNAL_ERROR_CODE;
-}({});
-
-// NCS error coded (generated by NCS)
-export let NCS_ERROR_CODE = /*#__PURE__*/function (NCS_ERROR_CODE) {
-  NCS_ERROR_CODE["HEAD_VERSION_UPDATE_FAILED"] = "HEAD_VERSION_UPDATE_FAILED";
-  NCS_ERROR_CODE["VERSION_NUMBER_ALREADY_EXISTS"] = "VERSION_NUMBER_ALREADY_EXISTS";
-  NCS_ERROR_CODE["INSUFFICIENT_EDITING_PERMISSION"] = "INSUFFICIENT_EDITING_PERMISSION";
-  NCS_ERROR_CODE["FORBIDDEN_USER_TOKEN"] = "FORBIDDEN_USER_TOKEN";
-  NCS_ERROR_CODE["DOCUMENT_NOT_FOUND"] = "DOCUMENT_NOT_FOUND";
-  NCS_ERROR_CODE["INIT_DATA_LOAD_FAILED"] = "INIT_DATA_LOAD_FAILED";
-  NCS_ERROR_CODE["ERROR_MAPPING_ERROR"] = "ERROR_MAPPING_ERROR";
-  NCS_ERROR_CODE["NAMESPACE_INVALID"] = "NAMESPACE_INVALID";
-  NCS_ERROR_CODE["NAMESPACE_NOT_FOUND"] = "NAMESPACE_NOT_FOUND";
-  NCS_ERROR_CODE["TENANT_INSTANCE_MAINTENANCE"] = "TENANT_INSTANCE_MAINTENANCE";
-  NCS_ERROR_CODE["LOCKED_DOCUMENT"] = "LOCKED_DOCUMENT";
-  NCS_ERROR_CODE["EMPTY_BROADCAST"] = "EMPTY_BROADCAST";
-  NCS_ERROR_CODE["DYNAMO_ERROR"] = "DYNAMO_ERROR";
-  NCS_ERROR_CODE["INVALID_ACTIVATION_ID"] = "INVALID_ACTIVATION_ID";
-  NCS_ERROR_CODE["INVALID_DOCUMENT_ARI"] = "INVALID_DOCUMENT_ARI";
-  NCS_ERROR_CODE["INVALID_CLOUD_ID"] = "INVALID_CLOUD_ID";
-  NCS_ERROR_CODE["RATE_LIMIT_ERROR"] = "RATE_LIMIT_ERROR";
-  return NCS_ERROR_CODE;
-}({});
-
-// TODO: Import emitted error codes from NCS
-
-// NCS Errors
-// - Step rejection errors
-// - Permission errors
-// - Page missing / TTL errors
-// - Server errors
-// - Less common back-end errors
-// Provider Errors
-// Channel Errors
-/**
- * When we try to apply state updates to the editor, if that fails to apply the user can enter an invalid state where no
- * changes can be saved to NCS.
- */
-/**
- * The client is trying to send too many messages or messages that are too large. This not expected to be a standard
- * operating condition and should only ever indicate a frontend bug.
- */
-/**
- * A union of all possible internal errors, that are mapped to another error if being emitted to the editor.
- */
-/*
- * This is what a generic ProviderError type would look like:
- * type ProviderError = {
- *   // Unique code, identifies the specific emitted error
- *   // Also exposed as a PROVIDER_ERROR_CODE enum to allow subscribers to use them
- *   code: PROVIDER_ERROR_CODE;
- *   // Informative message describing what went wrong
- *   message: string;
- *   // Flag indicating whether an error is recoverable or not
- *   // used by consumers to disable the provider and show an error message
- *   recoverable: boolean;
- *   // A reason code used to give more detail about why a certain error was thrown
- *   reason?: string;
- * }
- */
-// Custom Errors
-export class CustomError extends Error {
-  constructor(message, error, extraEventAttributes) {
-    super(message);
-    _defineProperty(this, "getExtraErrorEventAttributes", () => this.extraEventAttributes);
-    if (typeof (error === null || error === void 0 ? void 0 : error.message) === 'string') {
-      this.message = error.message;
-    }
-    if (extraEventAttributes) {
-      this.extraEventAttributes = extraEventAttributes;
-    }
-  }
-  toJSON() {
-    return {
-      name: this.name,
-      message: this.message
-    };
-  }
-}
-export class NotConnectedError extends CustomError {
-  constructor(...args) {
-    super(...args);
-    _defineProperty(this, "name", 'NotConnectedError');
-  }
-}
-export class NotInitializedError extends CustomError {
-  constructor(...args) {
-    super(...args);
-    _defineProperty(this, "name", 'NotInitializedError');
-  }
-}
-export class ProviderInitialisationError extends CustomError {
-  constructor(...args) {
-    super(...args);
-    _defineProperty(this, "name", 'ProviderInitialisationError');
-  }
-}
-export class SendTransactionError extends CustomError {
-  constructor(...args) {
-    super(...args);
-    _defineProperty(this, "name", 'SendTransactionError');
-  }
-}
-export class DestroyError extends CustomError {
-  constructor(...args) {
-    super(...args);
-    _defineProperty(this, "name", 'DestroyError');
-  }
-}
-export class SetTitleError extends CustomError {
-  constructor(...args) {
-    super(...args);
-    _defineProperty(this, "name", 'SetTitleError');
-  }
-}
-export class SetEditorWidthError extends CustomError {
-  constructor(...args) {
-    super(...args);
-    _defineProperty(this, "name", 'SetEditorWidthError');
-  }
-}
-export class SetMetadataError extends CustomError {
-  constructor(...args) {
-    super(...args);
-    _defineProperty(this, "name", 'SetMetadataError');
-  }
-}
-export class GetCurrentStateError extends CustomError {
-  constructor(...args) {
-    super(...args);
-    _defineProperty(this, "name", 'GetCurrentStateError');
-  }
-}
-export class GetFinalAcknowledgedStateError extends CustomError {
-  constructor(...args) {
-    super(...args);
-    _defineProperty(this, "name", 'GetFinalAcknowledgedStateError');
-  }
-}
-export class UpdateDocumentError extends CustomError {
-  constructor(message, extraAttributes) {
-    super(message, undefined, extraAttributes);
-    _defineProperty(this, "name", 'UpdateDocumentError');
-  }
-}
-export class CantSyncUpError extends CustomError {
-  constructor(message, extraAttributes) {
-    super(message, undefined, extraAttributes);
-    _defineProperty(this, "name", 'CantSyncUpError');
-  }
-}

package/dist/types/errors/error-types.d.ts

@@ -1,315 +0,0 @@
-import { CantSyncUpErrorAttributes, DocumentUpdateErrorAttributes } from '../helpers/const';
-export declare enum INTERNAL_ERROR_CODE {
-    TOKEN_PERMISSION_ERROR = "TOKEN_PERMISSION_ERROR",
-    RECONNECTION_NETWORK_ISSUE = "RECONNECTION_NETWORK_ISSUE",
-    CONNECTION_ERROR = "CONNECTION_ERROR",
-    RECONNECTION_ERROR = "RECONNECTION_ERROR",
-    DOCUMENT_NOT_FOUND = "DOCUMENT_NOT_FOUND",
-    CATCHUP_FAILED = "CATCHUP_FAILED",
-    DOCUMENT_RESTORE_ERROR = "DOCUMENT_RESTORE_ERROR",
-    ADD_STEPS_ERROR = "ADD_STEPS_ERROR",
-    DOCUMENT_UPDATE_ERROR = "DOCUMENT_UPDATE_ERROR"
-}
-export declare enum NCS_ERROR_CODE {
-    HEAD_VERSION_UPDATE_FAILED = "HEAD_VERSION_UPDATE_FAILED",
-    VERSION_NUMBER_ALREADY_EXISTS = "VERSION_NUMBER_ALREADY_EXISTS",
-    INSUFFICIENT_EDITING_PERMISSION = "INSUFFICIENT_EDITING_PERMISSION",
-    FORBIDDEN_USER_TOKEN = "FORBIDDEN_USER_TOKEN",
-    DOCUMENT_NOT_FOUND = "DOCUMENT_NOT_FOUND",
-    INIT_DATA_LOAD_FAILED = "INIT_DATA_LOAD_FAILED",
-    ERROR_MAPPING_ERROR = "ERROR_MAPPING_ERROR",
-    NAMESPACE_INVALID = "NAMESPACE_INVALID",
-    NAMESPACE_NOT_FOUND = "NAMESPACE_NOT_FOUND",
-    TENANT_INSTANCE_MAINTENANCE = "TENANT_INSTANCE_MAINTENANCE",
-    LOCKED_DOCUMENT = "LOCKED_DOCUMENT",
-    EMPTY_BROADCAST = "EMPTY_BROADCAST",
-    DYNAMO_ERROR = "DYNAMO_ERROR",
-    INVALID_ACTIVATION_ID = "INVALID_ACTIVATION_ID",
-    INVALID_DOCUMENT_ARI = "INVALID_DOCUMENT_ARI",
-    INVALID_CLOUD_ID = "INVALID_CLOUD_ID",
-    RATE_LIMIT_ERROR = "RATE_LIMIT_ERROR"
-}
-type HeadVersionUpdateFailedError = {
-    message: string;
-    data: {
-        code: NCS_ERROR_CODE.HEAD_VERSION_UPDATE_FAILED;
-        meta: {
-            currentVersion: any;
-            incomingVersion: number;
-        };
-        status: number;
-    };
-};
-type VersionAlreadyPresentInDynamoError = {
-    message: string;
-    data: {
-        code: NCS_ERROR_CODE.VERSION_NUMBER_ALREADY_EXISTS;
-        meta: string;
-        status: number;
-    };
-};
-type InsufficientEditingPermissionError = {
-    message: string;
-    data: {
-        code: NCS_ERROR_CODE.INSUFFICIENT_EDITING_PERMISSION;
-        meta: {
-            description: string;
-            reason?: string;
-        };
-        status: number;
-    };
-};
-type ForbiddenUserTokenError = {
-    message: string;
-    data: {
-        code: NCS_ERROR_CODE.FORBIDDEN_USER_TOKEN;
-        meta: string;
-        status: number;
-    };
-};
-type NCSDocumentNotFoundError = {
-    message: string;
-    data: {
-        code: NCS_ERROR_CODE.DOCUMENT_NOT_FOUND;
-        status: number;
-    };
-};
-type FailedToLoadInitDataError = {
-    message: string;
-    data: {
-        code: NCS_ERROR_CODE.INIT_DATA_LOAD_FAILED;
-        status: number;
-    };
-};
-type ErrorMappingError = {
-    message: string;
-    data: {
-        code: NCS_ERROR_CODE.ERROR_MAPPING_ERROR;
-        status: number;
-    };
-};
-type InvalidNamespaceDefinedError = {
-    message: string;
-    data: {
-        code: NCS_ERROR_CODE.NAMESPACE_INVALID;
-        meta: string;
-        status: number;
-    };
-};
-type SocketNamespaceNotFoundError = {
-    message: string;
-    data: {
-        code: NCS_ERROR_CODE.NAMESPACE_NOT_FOUND;
-        meta: string;
-        status: number;
-    };
-};
-type TenantInstanceMaintenanceError = {
-    message: string;
-    data: {
-        code: NCS_ERROR_CODE.TENANT_INSTANCE_MAINTENANCE;
-        meta: {
-            description: string;
-            reason: string;
-        };
-        status: number;
-    };
-};
-type NamespaceLockedError = {
-    message: string;
-    data: {
-        code: NCS_ERROR_CODE.LOCKED_DOCUMENT;
-        meta: string;
-        status: number;
-    };
-};
-type EmptyBroadcastError = {
-    message: string;
-    data: {
-        code: NCS_ERROR_CODE.EMPTY_BROADCAST;
-        meta: string;
-        status: number;
-    };
-};
-type DynamoError = {
-    message: string;
-    data: {
-        code: NCS_ERROR_CODE.DYNAMO_ERROR;
-        meta: string;
-        status: number;
-    };
-};
-type InvalidActivationIdError = {
-    message: string;
-    data: {
-        code: NCS_ERROR_CODE.INVALID_ACTIVATION_ID;
-        meta: string;
-        status: number;
-    };
-};
-type InvalidDocumentAriError = {
-    message: string;
-    data: {
-        code: NCS_ERROR_CODE.INVALID_DOCUMENT_ARI;
-        meta: string;
-        status: number;
-    };
-};
-type InvalidCloudIdError = {
-    message: string;
-    data: {
-        code: NCS_ERROR_CODE.INVALID_CLOUD_ID;
-        meta: string;
-        status: number;
-    };
-};
-type NCSErrors = HeadVersionUpdateFailedError | VersionAlreadyPresentInDynamoError | InsufficientEditingPermissionError | ForbiddenUserTokenError | NCSDocumentNotFoundError | FailedToLoadInitDataError | ErrorMappingError | InvalidNamespaceDefinedError | SocketNamespaceNotFoundError | TenantInstanceMaintenanceError | NamespaceLockedError | EmptyBroadcastError | DynamoError | InvalidActivationIdError | InvalidDocumentAriError | InvalidCloudIdError | InternalDocumentUpdateFailure;
-type DocumentRecoveryError = {
-    message: string;
-    data: {
-        code: INTERNAL_ERROR_CODE.DOCUMENT_RESTORE_ERROR;
-        status: number;
-    };
-};
-type AddStepsError = {
-    message: string;
-    data: {
-        code: INTERNAL_ERROR_CODE.ADD_STEPS_ERROR;
-        status: number;
-    };
-};
-export type CatchUpFailedError = {
-    message: string;
-    data: {
-        code: INTERNAL_ERROR_CODE.CATCHUP_FAILED;
-        status: number;
-    };
-};
-export type TokenPermissionError = {
-    message: string;
-    data: {
-        code: INTERNAL_ERROR_CODE.TOKEN_PERMISSION_ERROR;
-        status: number;
-        meta: {
-            originalError?: unknown;
-            reason?: string;
-        };
-    };
-};
-export type ReconnectionError = {
-    message: string;
-    data: {
-        code: INTERNAL_ERROR_CODE.RECONNECTION_ERROR;
-        status: number;
-    };
-};
-export type ConnectionError = {
-    message: string;
-    data: {
-        code: INTERNAL_ERROR_CODE.CONNECTION_ERROR;
-    };
-};
-export type ReconnectionNetworkError = {
-    message: string;
-    data: {
-        code: INTERNAL_ERROR_CODE.RECONNECTION_NETWORK_ISSUE;
-    };
-};
-export type DocumentNotFoundError = {
-    message: string;
-    data: {
-        code: INTERNAL_ERROR_CODE.DOCUMENT_NOT_FOUND;
-        status: number;
-    };
-};
-/**
- * When we try to apply state updates to the editor, if that fails to apply the user can enter an invalid state where no
- * changes can be saved to NCS.
- */
-export type InternalDocumentUpdateFailure = {
-    message: 'The provider failed to apply changes to the editor';
-    data: {
-        code: INTERNAL_ERROR_CODE.DOCUMENT_UPDATE_ERROR;
-        meta: {
-            newVersion?: number;
-            editorVersion?: number;
-        };
-        status: 500;
-    };
-};
-/**
- * The client is trying to send too many messages or messages that are too large. This not expected to be a standard
- * operating condition and should only ever indicate a frontend bug.
- */
-export type RateLimitError = {
-    message: string;
-    data: {
-        code: NCS_ERROR_CODE.RATE_LIMIT_ERROR;
-        meta: {
-            rateLimitType: number;
-            maxStepSize: number;
-            stepSizeCounter: number;
-            stepCounter: number;
-        };
-        status: 500;
-    };
-};
-/**
- * A union of all possible internal errors, that are mapped to another error if being emitted to the editor.
- */
-export type InternalError = NCSErrors | DocumentRecoveryError | AddStepsError | CatchUpFailedError | TokenPermissionError | ReconnectionError | ConnectionError | ReconnectionNetworkError | DocumentNotFoundError | InternalDocumentUpdateFailure | RateLimitError;
-type ValidEventAttributeType = boolean | string | number;
-export declare class CustomError extends Error {
-    extraEventAttributes?: {
-        [key: string]: ValidEventAttributeType;
-    };
-    constructor(message: string, error?: unknown, extraEventAttributes?: {
-        [key: string]: ValidEventAttributeType;
-    });
-    toJSON(): {
-        name: string;
-        message: string;
-    };
-    getExtraErrorEventAttributes: () => {
-        [key: string]: ValidEventAttributeType;
-    } | undefined;
-}
-export declare class NotConnectedError extends CustomError {
-    name: string;
-}
-export declare class NotInitializedError extends CustomError {
-    name: string;
-}
-export declare class ProviderInitialisationError extends CustomError {
-    name: string;
-}
-export declare class SendTransactionError extends CustomError {
-    name: string;
-}
-export declare class DestroyError extends CustomError {
-    name: string;
-}
-export declare class SetTitleError extends CustomError {
-    name: string;
-}
-export declare class SetEditorWidthError extends CustomError {
-    name: string;
-}
-export declare class SetMetadataError extends CustomError {
-    name: string;
-}
-export declare class GetCurrentStateError extends CustomError {
-    name: string;
-}
-export declare class GetFinalAcknowledgedStateError extends CustomError {
-    name: string;
-}
-export declare class UpdateDocumentError extends CustomError {
-    name: string;
-    constructor(message: string, extraAttributes: DocumentUpdateErrorAttributes);
-}
-export declare class CantSyncUpError extends CustomError {
-    name: string;
-    constructor(message: string, extraAttributes: CantSyncUpErrorAttributes);
-}
-export {};